find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-mq:amazon-mq-operations-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AmazonMQ Operations API
  version: '2017-11-27'
  description: Generated from AWS's published Smithy model for AmazonMQ. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://mq.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Operations
paths:
  /v1/configurations/{ConfigurationId}/revisions/{ConfigurationRevision}:
    get:
      operationId: DescribeConfigurationRevision
      summary: Describe Configuration Revision
      description: Returns the specified configuration revision for the specified configuration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeConfigurationRevisionResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeConfigurationRevisionRequest'
      tags:
      - Operations
  /v1/configurations/{ConfigurationId}/revisions:
    get:
      operationId: ListConfigurationRevisions
      summary: List Configuration Revisions
      description: Returns a list of all revisions for the specified configuration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConfigurationRevisionsResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListConfigurationRevisionsRequest'
      tags:
      - Operations
  /v1/brokers/{BrokerId}/shared-resources:
    get:
      operationId: DescribeSharedResources
      summary: Describe Shared Resources
      description: Returns the resources shared to a broker.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeSharedResourcesResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeSharedResourcesRequest'
      tags:
      - Operations
  /v1/brokers/{BrokerId}/promote:
    post:
      operationId: Promote
      summary: Promote
      description: Promotes a data replication replica broker to the primary broker role.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromoteResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromoteRequest'
      tags:
      - Operations
  /v1/brokers/{BrokerId}/reboot:
    post:
      operationId: RebootBroker
      summary: Reboot Broker
      description: 'Reboots a broker. Note: This API is asynchronous.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RebootBrokerResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RebootBrokerRequest'
      tags:
      - Operations
components:
  schemas:
    DescribeSharedResourcesResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
        SharedResources:
          type: array
          items:
            $ref: '#/components/schemas/SharedResource'
          description: A list of resources shared to the broker.
    ListConfigurationRevisionsRequest:
      type: object
      properties:
        ConfigurationId:
          type: string
          description: The unique ID that Amazon MQ generates for the configuration.
        MaxResults:
          type: integer
          description: The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
        NextToken:
          type: string
          description: The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
      required:
      - ConfigurationId
    BadRequestException:
      type: object
      properties:
        ErrorAttribute:
          type: string
          description: The attribute which caused the error.
        Message:
          type: string
          description: The explanation of the error.
        ResourceShareErrors:
          type: array
          items:
            $ref: '#/components/schemas/ResourceShareError'
          description: The list of resource share errors.
    SharedResourceError:
      type: object
      properties:
        Code:
          type: string
          enum:
          - QUOTA_EXCEEDED
          - SHARE_NOT_FOUND
          - INVITE_FAILED
          - SETUP_INCOMPLETE
          - INTERNAL_ERROR
          - AZ_MISMATCH
          - RESOURCE_CONFIGURATION_NOT_FOUND
          description: The error code associated with the error.
        Message:
          type: string
          description: The error message.
      required:
      - Code
      - Message
    ListConfigurationRevisionsResponse:
      type: object
      properties:
        ConfigurationId:
          type: string
          description: The unique ID that Amazon MQ generates for the configuration.
        MaxResults:
          type: integer
          description: The maximum number of configuration revisions that can be returned per page (20 by default). This value must be an integer from 5 to 100.
        NextToken:
          type: string
          description: The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
        Revisions:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationRevision'
          description: The list of all revisions for the specified configuration.
    DescribeConfigurationRevisionRequest:
      type: object
      properties:
        ConfigurationId:
          type: string
          description: The unique ID that Amazon MQ generates for the configuration.
        ConfigurationRevision:
          type: string
          description: The revision of the configuration.
      required:
      - ConfigurationId
      - ConfigurationRevision
    InternalServerErrorException:
      type: object
      properties:
        ErrorAttribute:
          type: string
          description: The attribute which caused the error.
        Message:
          type: string
          description: The explanation of the error.
        ResourceShareErrors:
          type: array
          items:
            $ref: '#/components/schemas/ResourceShareError'
          description: The list of resource share errors.
    DescribeConfigurationRevisionResponse:
      type: object
      properties:
        ConfigurationId:
          type: string
          description: Required. The unique ID that Amazon MQ generates for the configuration.
        Created:
          type: string
          format: date-time
          description: Required. The date and time of the configuration.
        Data:
          type: string
          description: 'Amazon MQ for ActiveMQ: the base64-encoded XML configuration. Amazon MQ for RabbitMQ: base64-encoded Cuttlefish.'
        Description:
          type: string
          description: The description of the configuration.
    DescribeSharedResourcesRequest:
      type: object
      properties:
        BrokerId:
          type: string
          description: The unique ID that Amazon MQ generates for the broker.
        MaxResults:
          type: integer
          description: The maximum number of resources that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
        NextToken:
          type: string
          description: The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
      required:
      - BrokerId
    ForbiddenException:
      type: object
      properties:
        ErrorAttribute:
          type: string
          description: The attribute which caused the error.
        Message:
          type: string
          description: The explanation of the error.
        ResourceShareErrors:
          type: array
          items:
            $ref: '#/components/schemas/ResourceShareError'
          description: The list of resource share errors.
    PromoteRequest:
      type: object
      properties:
        BrokerId:
          type: string
          description: The unique ID that Amazon MQ generates for the broker.
        Mode:
          type: string
          enum:
          - SWITCHOVER
          - FAILOVER
          description: 'The Promote mode requested. Note: Valid values for the parameter are SWITCHOVER, FAILOVER.'
      required:
      - BrokerId
      - Mode
    ResourceShareError:
      type: object
      properties:
        ErrorCode:
          type: string
          description: The error code of the resource share.
        ResourceShareArn:
          type: string
          description: The ARN of the resource share.
        Status:
          type: string
          description: The status of the resource share.
    PromoteResponse:
      type: object
      properties:
        BrokerId:
          type: string
          description: The unique ID that Amazon MQ generates for the broker.
    NotFoundException:
      type: object
      properties:
        ErrorAttribute:
          type: string
          description: The attribute which caused the error.
        Message:
          type: string
          description: The explanation of the error.
        ResourceShareErrors:
          type: array
          items:
            $ref: '#/components/schemas/ResourceShareError'
          description: The list of resource share errors.
    SharedResource:
      type: object
      properties:
        DnsNames:
          type: array
          items:
            type: string
          description: The DNS names accessible by the broker.
        Error:
          $ref: '#/components/schemas/SharedResourceError'
        ResourceArn:
          type: string
          description: The ARN of the shared resource.
        ResourceShareArns:
          type: array
          items:
            type: string
          description: The resource share ARNs to which the resource belongs.
        Status:
          type: string
          enum:
          - AVAILABLE
          - SETUP_IN_PROGRESS
          - DELETION_IN_PROGRESS
          - PENDING_CREATE
          - PENDING_DELETE
          - ERROR
          description: The status of the shared resource.
        Type:
          type: string
          enum:
          - RESOURCE_SHARE
          - RESOURCE
          description: The type of shared resource.
      required:
      - ResourceArn
      - Status
      - Type
    ConfigurationRevision:
      type: object
      properties:
        Created:
          type: string
          format: date-time
          description: Required. The date and time of the configuration revision.
        Description:
          type: string
          description: The description of the configuration revision.
        Revision:
          type: integer
          description: Required. The revision number of the configuration.
      required:
      - Created
      - Revision
    RebootBrokerResponse:
      type: object
      properties: {}
    RebootBrokerRequest:
      type: object
      properties:
        BrokerId:
          type: string
          description: The unique ID that Amazon MQ generates for the broker.
      required:
      - BrokerId
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: mq
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/mq/service/2017-11-27/mq-2017-11-27.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)