openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Queue 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: Queue
paths:
  /accounts/{account_id}/queues:
    get:
      description: Returns the queues owned by an account.
      operationId: queue-v2-list-queues
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      errors: {}
                  - properties:
                      messages: {}
                  - properties:
                      result_info:
                        properties:
                          count:
                            example: 1
                          page:
                            example: 1
                          per_page:
                            example: 100
                          total_count:
                            example: 1
                          total_pages:
                            example: 1
                        type: object
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/mq_queue'
                        type: array
                    required:
                    - queue_id
                    - queue_name
                    - created_on
                    - modified_on
                    - producers_total_count
                    - producers
                    - consumers_total_count
                    - consumers
                    type: object
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: List Queues response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    errors: {}
                - properties:
                    messages: {}
                - properties:
                    result_info:
                      properties:
                        count:
                          example: 1
                        page:
                          example: 1
                        per_page:
                          example: 100
                        total_count:
                          example: 1
                        total_pages:
                          example: 1
                      type: object
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/mq_queue'
                      type: array
                  required:
                  - queue_id
                  - queue_name
                  - created_on
                  - modified_on
                  - producers_total_count
                  - producers
                  - consumers_total_count
                  - consumers
                  type: object
          description: List Queues response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List Queues
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Queues Read
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.list
    post:
      description: Creates a new queue.
      operationId: queue-v2-create-queue
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              example:
                queue_name: example-queue
              properties:
                queue_name:
                  type: string
              required:
              - queue_name
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/mq_queue_created'
                        type: object
                    required:
                    - queue_id
                    - queue_name
                    - created_on
                    - modified_on
                    type: object
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Create Queue response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/mq_queue_created'
                      type: object
                  required:
                  - queue_id
                  - queue_name
                  - created_on
                  - modified_on
                  type: object
          description: Create Queue response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Create Queue
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.create
  /accounts/{account_id}/queues/{queue_id}:
    delete:
      description: Deletes a queue.
      operationId: queue-v2-delete-queue
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result: {}
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Delete Queue response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result: {}
          description: Delete Queue response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete Queue
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.delete
    get:
      description: Get information about a specific queue.
      operationId: queue-v2-queue-details
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/mq_queue'
                        type: object
                    required:
                    - queue_id
                    - queue_name
                    - created_on
                    - modified_on
                    type: object
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Queue Details response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/mq_queue'
                      type: object
                  required:
                  - queue_id
                  - queue_name
                  - created_on
                  - modified_on
                  type: object
          description: Queue Details response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Queue Details
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Queues Read
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.read
    put:
      description: Updates a queue.
      operationId: queue-v2-update-queue
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              example:
                queue_name: renamed-example-queue
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/mq_queue_updated'
                        type: object
                    required:
                    - queue_id
                    - queue_name
                    - created_on
                    - modified_on
                    type: object
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Update Queue response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/mq_queue_updated'
                      type: object
                  required:
                  - queue_id
                  - queue_name
                  - created_on
                  - modified_on
                  type: object
          description: Update Queue response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Update Queue
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.update
  /accounts/{account_id}/queues/{queue_id}/consumers:
    get:
      description: Returns the consumers for a queue.
      operationId: queue-v2-list-queue-consumers
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      errors: {}
                  - properties:
                      messages: {}
                  - properties:
                      result_info:
                        properties:
                          count:
                            example: 1
                          page:
                            example: 1
                          per_page:
                            example: 100
                          total_count:
                            example: 1
                          total_pages:
                            example: 1
                        type: object
                  - properties:
                      result:
                        items:
                          $ref: '#/components/schemas/mq_consumer'
                        type: array
                    required:
                    - queue_name
                    - created_on
                    - settings
                    type: object
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: List Queue Consumers response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    errors: {}
                - properties:
                    messages: {}
                - properties:
                    result_info:
                      properties:
                        count:
                          example: 1
                        page:
                          example: 1
                        per_page:
                          example: 100
                        total_count:
                          example: 1
                        total_pages:
                          example: 1
                      type: object
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/mq_consumer'
                      type: array
                  required:
                  - queue_name
                  - created_on
                  - settings
                  type: object
          description: List Queue Consumers response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List Queue Consumers
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Queues Read
      - Workers Scripts Write
      - Workers Scripts Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.list
    post:
      description: Creates a new consumer for a queue.
      operationId: queue-v2-create-queue-consumer
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              example:
                dead_letter_queue: example-dlq
                environment: production
                script_name: example-consumer
                settings:
                  batch_size: 10
                  max_retries: 3
                  max_wait_time_ms: 5000
                type: worker
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/mq_consumer_created'
                        type: object
                    required:
                    - queue_name
                    - script_name
                    - settings
                    - dead_letter_queue
                    - created_on
                    type: object
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Create Queue Consumer response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/mq_consumer_created'
                      type: object
                  required:
                  - queue_name
                  - script_name
                  - settings
                  - dead_letter_queue
                  - created_on
                  type: object
          description: Create Queue Consumer response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Create Queue Consumer
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.create
  /accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}:
    delete:
      description: Deletes the consumer for a queue.
      operationId: queue-v2-delete-queue-consumer
      parameters:
      - in: path
        name: consumer_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result: {}
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Delete Queue Consumer response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result: {}
          description: Delete Queue Consumer response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete Queue Consumer
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.delete
    put:
      description: Updates the consumer for a queue, or creates one if it does not exist.
      operationId: queue-v2-update-queue-consumer
      parameters:
      - in: path
        name: consumer_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              example:
                dead_letter_queue: updated-example-dlq
                environment: production
                script_name: example-consumer
                settings:
                  batch_size: 100
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/mq_consumer_updated'
                        type: object
                    required:
                    - queue_name
                    - script_name
                    - settings
                    - dead_letter_queue
                    - created_on
                    type: object
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Update Queue Consumer response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/mq_consumer_updated'
                      type: object
                  required:
                  - queue_name
                  - script_name
                  - settings
                  - dead_letter_queue
                  - created_on
                  type: object
          description: Update Queue Consumer response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Update Queue Consumer
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.update
  /accounts/{account_id}/queues/{queue_id}/messages/ack:
    post:
      description: Acknowledge + Retry messages from a Queue.
      operationId: queue-v2-messages-ack
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                acks:
                  items:
                    properties:
                      lease_id:
                        description: Lease ID for a message to acknowledge.
                        example: eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0
                        type: string
                    type: object
                  type: array
                retries:
                  items:
                    properties:
                      delay_seconds:
                        description: The number of seconds to delay before making the message available for another attempt.
                        example: 10
                        type: number
                      lease_id:
                        description: Lease ID for a message to retry.
                        example: eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0
                        type: string
                    type: object
                  type: array
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result: {}
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Acknoweldge Queue Messages response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result:
                      properties:
                        ackCount:
                          description: The number of messages that were succesfully acknowledged.
                          example: 5
                          type: number
                        retryCount:
                          description: The number of messages that were succesfully retried.
                          example: 5
                          type: number
                        warnings:
                          items:
                            type: string
                          type: array
                      type: object
          description: Acknoweldge Queue Messages response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Acknowledge + Retry Queue Messages
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.update
  /accounts/{account_id}/queues/{queue_id}/messages/pull:
    post:
      description: Pull a batch of messages from a Queue.
      operationId: queue-v2-messages-pull
      parameters:
      - in: path
        name: queue_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/mq_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                batch_size:
                  $ref: '#/components/schemas/mq_batch_size'
                visibility_timeout:
                  $ref: '#/components/schemas/mq_visibility_timeout'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/mq_api-response-collection'
                  - properties:
                      result: {}
                - $ref: '#/components/schemas/mq_api-response-common-failure'
          description: Pull Queue Messages response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mq_api-response-collection'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/mq_queue_message'
                      type: array
          description: Pull Queue Messages response.
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Pull Queue Messages
      tags:
      - Queue
      x-api-token-group:
      - Queues Write
      - Workers Scripts Write
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.edge.worker.queue.update
components:
  schemas:
    mq_queue_created:
      properties:
        created_on:
          readOnly: true
          type: string
        modified_on:
          readOnly: true
          type: string
        queue_id:
          readOnly: true
          type: string
        queue_name:
          $ref: '#/components/schemas/mq_name'
      type: object
    mq_queue_updated:
      properties:
        created_on:
          readOnly: true
          type: string
        modified_on:
          readOnly: true
          type: string
        queue_id:
          readOnly: true
          type: string
        queue_name:
          $ref: '#/components/schemas/mq_renamed_name'
      type: object
    mq_queue_message:
      properties:
        attempts:
          example: 1
          readOnly: true
          type: number
        body:
          example: hello world
          readOnly: true
          type: string
        id:
          example: b01b5594f784d0165c2985833f5660dd
          readOnly: true
          type: string
        lease_id:
          $ref: '#/components/schemas/mq_lease_id'
        metadata:
          example:
            CF-Content-Type: text
            CF-sourceMessageSource: dash
          readOnly: true
          type: object
        timestamp_ms:
          example: 1710950954154.0
          readOnly: true
          type: number
      type: object
    mq_visibility_timeout:
      description: The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.
      example: 6000
      type: number
    mq_consumer_updated:
      properties:
        created_on:
          readOnly: true
          type: string
        dead_letter_queue:
          example: updated-example-dlq
        environment:
          readOnly: true
          type: string
        queue_name:
          readOnly: true
          type: string
        script_name:
          readOnly: true
          type: string
        settings:
          properties:
            batch_size:
              example: 100
              type: number
            max_retries:
              $ref: '#/components/schemas/mq_max_retries'
            max_wait_time_ms:
              $ref: '#/components/schemas/mq_max_wait_time_ms'
          type: object
      type: object
    mq_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/mq_messages'
        messages:
          $ref: '#/components/schemas/mq_messages'
        result:
          anyOf:
          - type: object
          - items: {}
            type: array
          - type: string
        success:
          description: Whether the API call was successful.
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    mq_lease_id:
      example: eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0
      readOnly: true
      type: string
    mq_queue:
      properties:
        consumers:
          items:
            $ref: '#/components/schemas/mq_consumer'
          readOnly: true
          type: array
        consumers_total_count:
          readOnly: true
          type: number
        created_on:
          readOnly: true
          type: string
        modified_on:
          readOnly: true
          type: string
        producers:
          items:
            $ref: '#/components/schemas/mq_producer'
          readOnly: true
          type: array
        producers_total_count:
          readOnly: true
          type: number
        queue_id:
          readOnly: true
          type: string
        queue_name:
          $ref: '#/components/schemas/mq_name'
      type: object
    mq_name:
      example: example-queue
      type: string
    mq_consumer:
      properties:
        created_on:
          readOnly: true
          type: string
        environment:
          readOnly: true
          type: string
        queue_name:
          readOnly: true
          type: string
        service:
          readOnly: true
          type: string
        settings:
          properties:
            batch_size:
              $ref: '#/components/schemas/mq_batch_size'
            max_retries:
              $ref: '#/components/schemas/mq_max_retries'
            max_wait_time_ms:
              $ref: '#/components/schemas/mq_max_wait_time_ms'
          type: object
      type: object
    mq_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    mq_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/mq_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/mq_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
    mq_identifier:
      description: Identifier.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    mq_max_retries:
      description: The maximum number of retries
      example: 3
      type: number
    mq_dlq_name:
      description: The name of the dead letter queue.
      example: example-dlq
      type: string
    mq_batch_size:
      description: The maximum number of messages to include in a batch.
      example: 50
      type: number
    mq_result_info:
      properties:
        count:
          description: Total number of results for the requested service.
          example: 1
          type: number
        page:
          description: Current page within paginated list of results.
          example: 1
          type: number
        per_page:
          description: Number of results per page of results.
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters.
          example: 2000
          type: number
      type: object
    mq_renamed_name:
      example: renamed-example-queue
      type: string
    mq_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/mq_api-response-common'
      - properties:
          result:
            items: {}
            nullable: true
            type: array
          result_info:
            $ref: '#/components/schemas/mq_result_info'
      type: object
    mq_producer:
      properties:
        environment:
          readOnly: true
          type: string
        service:
          readOnly: true
          type: string
      type: object
    mq_max_wait_time_ms:
      example: 5000
      type: number
    mq_consumer_created:
      properties:
        created_on:
          readOnly: true
          type: string
        dead_letter_queue:
          $ref: '#/components/schemas/mq_dlq_name'
        environment:
          readOnly: true
          type: string
        queue_name:
          readOnly: true
          type: string
        script_name:
          readOnly: true
          type: string
        settings:
          properties:
            batch_size:
              $ref: '#/components/schemas/mq_batch_size'
            max_retries:
              $ref: '#/components/schemas/mq_max_retries'
            max_wait_time_ms:
              $ref: '#/components/schemas/mq_max_wait_time_ms'
          type: object
      type: object
  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