openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Request for Information (RFI) API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Request for Information (RFI)
paths:
  /accounts/{account_identifier}/cloudforce-one/requests:
    post:
      operationId: cloudforce-one-request-list
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-list'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Create response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/cloudforce-one_request-list-item'
                      type: array
          description: List requests response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Requests
      tags:
      - Request for Information (RFI)
      x-api-token-group:
      - Cloudforce One Write
  /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}:
    delete:
      operationId: cloudforce-one-request-delete
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      - in: path
        name: request_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Delete request response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common'
          description: Delete request response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a Request
      tags:
      - Request for Information (RFI)
    get:
      operationId: cloudforce-one-request-get
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      - in: path
        name: request_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Get request response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/cloudforce-one_request-item'
          description: Get request response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get a Request
      tags:
      - Request for Information (RFI)
    put:
      description: Updating a request alters the request in the Cloudforce One queue. This API may be used to update any attributes of the request after the initial submission. Only fields that you choose to update need to be add to the request body.
      operationId: cloudforce-one-request-update
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      - in: path
        name: request_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-edit'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Update request response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/cloudforce-one_request-item'
          description: Update request response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a Request
      tags:
      - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/asset:
    post:
      operationId: cloudforce-one-request-asset-list
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      - in: path
        name: request_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-asset-list'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: List request assets response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/cloudforce-one_request-asset-item'
                      type: array
          description: List request assets response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Request Assets
      tags:
      - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/asset/{asset_identifer}:
    delete:
      operationId: cloudforce-one-request-asset-delete
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      - in: path
        name: request_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_uuid'
      - in: path
        name: asset_identifer
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Delete request asset response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common'
          description: Delete request asset response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a Request Asset
      tags:
      - Request for Information (RFI)
    get:
      operationId: cloudforce-one-request-asset-get
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      - in: path
        name: request_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_uuid'
      - in: path
        name: asset_identifer
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_uuid'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Get request asset response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/cloudforce-one_request-asset-item'
                      type: array
          description: Get request asset response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get a Request Asset
      tags:
      - Request for Information (RFI)
    put:
      operationId: cloudforce-one-request-asset-update
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      - in: path
        name: request_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_uuid'
      - in: path
        name: asset_identifer
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-asset-edit'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Update request asset response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/cloudforce-one_request-asset-item'
          description: Update request asset response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a Request Asset
      tags:
      - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/asset/new:
    post:
      operationId: cloudforce-one-request-asset-new
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      - in: path
        name: request_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_uuid'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-asset-edit'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Create request asset response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/cloudforce-one_request-asset-item'
          description: Create request asset response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a New Request Asset
      tags:
      - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message:
    post:
      operationId: cloudforce-one-request-message-list
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      - in: path
        name: request_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-message-list'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: List request messages response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/cloudforce-one_request-message-item'
                      type: array
          description: List request messages response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Request Messages
      tags:
      - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/{message_identifer}:
    delete:
      operationId: cloudforce-one-request-message-delete
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      - in: path
        name: request_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_uuid'
      - in: path
        name: message_identifer
        required: true
        schema:
          type: integer
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Delete request message response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common'
          description: Delete request message response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a Request Message
      tags:
      - Request for Information (RFI)
    put:
      operationId: cloudforce-one-request-message-update
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      - in: path
        name: request_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_uuid'
      - in: path
        name: message_identifer
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-message-edit'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Update request message response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/cloudforce-one_request-message-item'
          description: Update request message response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a Request Message
      tags:
      - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/new:
    post:
      operationId: cloudforce-one-request-message-new
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      - in: path
        name: request_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_uuid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-message-edit'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Create request message response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/cloudforce-one_request-message-item'
          description: Create request message response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a New Request Message
      tags:
      - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/constants:
    get:
      operationId: cloudforce-one-request-constants
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Get request constants response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/cloudforce-one_request-constants'
          description: Get request constants response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Request Priority, Status, and TLP constants
      tags:
      - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/new:
    post:
      description: Creating a request adds the request into the Cloudforce One queue for analysis. In addition to the content, a short title, type, priority, and releasability should be provided. If one is not provided, a default will be assigned.
      operationId: cloudforce-one-request-new
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudforce-one_request-edit'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Create response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/cloudforce-one_request-item'
          description: Create request response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a New Request
      tags:
      - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/quota:
    get:
      operationId: cloudforce-one-request-quota
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Get request quota response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/cloudforce-one_quota'
          description: Get request quota response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Request Quota
      tags:
      - Request for Information (RFI)
  /accounts/{account_identifier}/cloudforce-one/requests/types:
    get:
      operationId: cloudforce-one-request-types
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/cloudforce-one_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudforce-one_api-response-common-failure'
          description: Get request types response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudforce-one_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/cloudforce-one_request-types'
          description: Get request types response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Request Types
      tags:
      - Request for Information (RFI)
components:
  schemas:
    cloudforce-one_uuid:
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    cloudforce-one_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    cloudforce-one_tlp:
      description: The CISA defined Traffic Light Protocol (TLP)
      enum:
      - clear
      - amber
      - amber-strict
      - green
      - red
      title: TLP
      type: string
    cloudforce-one_request-constants:
      properties:
        priority:
          example:
          - routine
          - high
          - urgent
          items:
            $ref: '#/components/schemas/cloudforce-one_priority'
          type: array
        status:
          example:
          - open
          - accepted
          - reported
          - approved
          - completed
          - declined
          items:
            $ref: '#/components/schemas/cloudforce-one_request-status'
          type: array
        tlp:
          example:
          - clear
          - green
          - amber
          - amber-strict
          - red
          items:
            $ref: '#/components/schemas/cloudforce-one_tlp'
          type: array
      title: Request Constants
      type: object
    cloudforce-one_request-status:
      description: Request Status
      enum:
      - open
      - accepted
      - reported
      - approved
      - completed
      - declined
      title: Request Status
      type: string
    cloudforce-one_time:
      example: '2022-04-01T05:20:00Z'
      format: date-time
      type: string
    cloudforce-one_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/cloudforce-one_messages'
        messages:
          $ref: '#/components/schemas/cloudforce-one_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    cloudforce-one_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    cloudforce-one_request-edit:
      properties:
        content:
          $ref: '#/components/schemas/cloudforce-one_request-content'
        priority:
          description: Priority for analyzing the request
          example: routine
          type: string
        request_type:
          $ref: '#/components/schemas/cloudforce-one_request-type'
        summary:
          $ref: '#/components/schemas/cloudforce-one_request-summary'
        tlp:
          $ref: '#/components/schemas/cloudforce-one_tlp'
      title: Request Editable Parameters
      type: object
    cloudforce-one_request-asset-list:
      properties:
        page:
          description: Page number of results
          type: integer
        per_page:
          description: Number of results per page
          example: 10
          type: integer
      required:
      - page
      - per_page
      title: Request Asset List Parameters
      type: object
    cloudforce-one_quota:
      properties:
        anniversary_date:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_time'
          - description: Anniversary date is when annual quota limit is refresh
          - example: '2022-01-01T00:00:00Z'
        quarter_anniversary_date:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_time'
          - description: Quater anniversary date is when quota limit is refreshed each quarter
          - example: '2022-04-01T00:00:00Z'
        quota:
          description: Tokens for the quarter
          example: 120
          type: integer
        remaining:
          description: Tokens remaining for the quarter
          example: 64
          type: integer
      title: Quota
      type: object
    cloudforce-one_request-asset-edit:
      properties:
        source:
          $ref: '#/components/schemas/cloudforce-one_asset-content'
      title: Request Asset Editable Attributes
      type: object
    cloudforce-one_request-content:
      description: Request content
      example: What regions were most effected by the recent DoS?
      type: string
    cloudforce-one_request-message-item:
      properties:
        author:
          description: Author of message
          example: user@domain.com
          type: string
        content:
          $ref: '#/components/schemas/cloudforce-one_message-content'
        created:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_time'
          - description: Message creation time
          - example: '2022-01-01T00:00:00Z'
        id:
          description: Message ID
          type: integer
        is_follow_on_request:
          description: Whether the message is a follow-on request
          type: boolean
        updated:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_time'
          - description: Message last updated time
          - example: '2022-01-01T00:00:00Z'
      required:
      - id
      - updated
      - content
      - author
      - is_follow_on_request
      title: Request Message Item
      type: object
    cloudforce-one_request-type:
      description: Requested information from request
      example: Victomology
      type: string
    cloudforce-one_request-list-item:
      properties:
        completed:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_time'
          - description: Request completion time
          - example: '2024-01-01T00:00:00Z'
        created:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_time'
          - description: Request creation time
          - example: '2022-04-01T00:00:00Z'
        id:
          $ref: '#/components/schemas/cloudforce-one_uuid'
        message_tokens:
          description: Tokens for the request messages
          example: 16
          type: integer
        priority:
          $ref: '#/components/schemas/cloudforce-one_priority'
        readable_id:
          $ref: '#/components/schemas/cloudforce-one_request-readable-id'
        request:
          $ref: '#/components/schemas/cloudforce-one_request-type'
        status:
          $ref: '#/components/schemas/cloudforce-one_request-status'
        summary:
          $ref: '#/components/schemas/cloudforce-one_request-summary'
        tlp:
          $ref: '#/components/schemas/cloudforce-one_tlp'
        tokens:
          description: Tokens for the request
          type: integer
        updated:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_time'
          - description: Request last updated time
          - example: '2022-04-01T00:00:00Z'
      required:
      - id
      - created
      - updated
      - priority
      - request
      - summary
      - tlp
      title: Request List Item
      type: object
    cloudforce-one_message-content:
      description: Content of message
      example: Can you elaborate on the type of DoS that occurred?
      type: string
    cloudforce-one_request-message-edit:
      properties:
        content:
          $ref: '#/components/schemas/cloudforce-one_message-content'
      title: Request Message Editable Attributes
      type: object
    cloudforce-one_request-list:
      properties:
        completed_after:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_time'
          - description: Retrieve requests completed after this time
          - example: '2022-01-01T00:00:00Z'
        completed_before:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_time'
          - description: Retrieve requests completed before this time
          - example: '2024-01-01T00:00:00Z'
        created_after:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_time'
          - description: Retrieve requests created after this time
          - example: '2022-01-01T00:00:00Z'
        created_before:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_time'
          - description: Retrieve requests created before this time
          - example: '2024-01-01T00:00:00Z'
        page:
          description: Page number of results
          type: integer
        per_page:
          description: Number of results per page
          example: 10
          type: integer
        request_type:
          $ref: '#/components/schemas/cloudforce-one_request-type'
        sort_by:
          description: Field to sort results by
          example: created
          type: string
        sort_order:
          description: Sort order (asc or desc)
          enum:
          - asc
          - desc
          type: string
        status:
          $ref: '#/components/schemas/cloudforce-one_request-status'
      required:
      - page
      - per_page
      title: Request List Parameters
      type: object
    cloudforce-one_request-asset-item:
      properties:
        created:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_time'
          - description: Asset creation time
          - example: '2022-01-01T00:00:00Z'
        description:
          description: Asset description
          example: example description
          type: string
        file_type:
          description: Asset file type
          example: png
          type: string
        id:
          description: Asset ID
          type: integer
        name:
          description: Asset name
          example: example.png
          type: string
      required:
      - id
      - name
      title: Request Asset Item
      type: object
    cloudforce-one_request-summary:
      description: Brief description of the request
      example: DoS attack
      type: string
    cloudforce-one_asset-content:
      description: Asset file to upload
      example: '@/Users/me/test.doc'
      type: string
    cloudforce-one_request-readable-id:
      description: Readable Request ID
      example: RFI-2022-000001
      title: Request Readable ID
      type: string
    cloudforce-one_request-message-list:
      properties:
        after:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_time'
          - description: Retrieve messages created after this time
          - example: '2022-01-01T00:00:00Z'
        before:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_time'
          - description: Retrieve messages created before this time
          - example: '2024-01-01T00:00:00Z'
        page:
          description: Page number of results
          type: integer
        per_page:
          description: Number of results per page
          example: 10
          type: integer
        sort_by:
          description: Field to sort results by
          example: created
          type: string
        sort_order:
          description: Sort order (asc or desc)
          enum:
          - asc
          - desc
          type: string
      required:
      - page
      - per_page
      title: Request Message List Parameters
      type: object
    cloudforce-one_request-types:
      example:
      - Indicators of Compromise
      - Victomology
      items:
        description: Request Types
        type: string
      title: Request Types
      type: array
    cloudforce-one_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/cloudforce-one_messages'
          example: []
        result:
          enum:
          - null
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    cloudforce-one_request-item:
      properties:
        completed:
          $ref: '#/components/schemas/cloudforce-one_time'
        content:
          $ref: '#/components/schemas/cloudforce-one_request-content'
        created:
          $ref: '#/components/schemas/cloudforce-one_time'
        id:
          $ref: '#/components/schemas/cloudforce-one_uuid'
        message_tokens:
          description: Tokens for the request messages
          example: 1
          type: integer
        priority:
          $ref: '#/components/schemas/cloudforce-one_time'
        readable_id:
          $ref: '#/components/schemas/cloudforce-one_request-readable-id'
        request:
          $ref: '#/components/schemas/cloudforce-one_request-type'
        status:
          $ref: '#/components/schemas/cloudforce-one_request-status'
        summary:
          $ref: '#/components/schemas/cloudforce-one_request-summary'
        tlp:
          $ref: '#/components/schemas/cloudforce-one_tlp'
        tokens:
          description: Tokens for the request
          example: 16
          type: integer
        updated:
          $ref: '#/components/schemas/cloudforce-one_time'
      required:
      - id
      - created
      - updated
      - content
      - priority
      - request
      - summary
      - tlp
      title: Request Item
      type: object
    cloudforce-one_priority:
      enum:
      - routine
      - high
      - urgent
      title: Request Priority
      type: string
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true