Amazon MSK Configurations API

openapi: 3.1.0
info:
  title: Managed Streaming for Kafka Configurations API
  version: '2018-11-14'
  description: Generated from AWS's published Smithy model for Managed Streaming for Kafka. 8 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://kafka.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /v1/configurations:
    post:
      operationId: CreateConfiguration
      summary: Create Configuration
      description: Creates a new MSK configuration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConfigurationResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConfigurationRequest'
      tags:
      - Configurations
    get:
      operationId: ListConfigurations
      summary: List Configurations
      description: Returns a list of all the MSK configurations in this Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConfigurationsResponse'
        '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'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListConfigurationsRequest'
      tags:
      - Configurations
  /v1/configurations/{Arn}:
    delete:
      operationId: DeleteConfiguration
      summary: Delete Configuration
      description: Deletes an MSK Configuration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteConfigurationResponse'
        '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/DeleteConfigurationRequest'
      tags:
      - Configurations
    get:
      operationId: DescribeConfiguration
      summary: Describe Configuration
      description: Returns a description of this MSK configuration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeConfigurationResponse'
        '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'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeConfigurationRequest'
      tags:
      - Configurations
    put:
      operationId: UpdateConfiguration
      summary: Update Configuration
      description: Updates an MSK configuration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateConfigurationResponse'
        '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'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConfigurationRequest'
      tags:
      - Configurations
  /v1/clusters/{ClusterArn}/configuration:
    put:
      operationId: UpdateClusterConfiguration
      summary: Update Cluster Configuration
      description: Updates the cluster with the configuration that is specified in the request body.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateClusterConfigurationResponse'
        '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'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClusterConfigurationRequest'
      tags:
      - Configurations
  /v1/configurations/{Arn}/revisions/{Revision}:
    get:
      operationId: DescribeConfigurationRevision
      summary: Describe Configuration Revision
      description: Returns a description of this revision of the 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'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeConfigurationRevisionRequest'
      tags:
      - Configurations
  /v1/configurations/{Arn}/revisions:
    get:
      operationId: ListConfigurationRevisions
      summary: List Configuration Revisions
      description: Returns a list of all the MSK configurations in this Region.
      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'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListConfigurationRevisionsRequest'
      tags:
      - Configurations
components:
  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: kafka
  schemas:
    BadRequestException:
      type: object
      properties:
        InvalidParameter:
          type: string
          description: The parameter that caused the error.
        Message:
          type: string
          description: The description of the error.
    Configuration:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the configuration.
        CreationTime:
          type: string
          format: date-time
          description: The time when the configuration was created.
        Description:
          type: string
          description: The description of the configuration.
        KafkaVersions:
          type: array
          items:
            type: string
          description: An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use
            this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this
            array.
        LatestRevision:
          $ref: '#/components/schemas/ConfigurationRevision'
        Name:
          type: string
          description: The name of the configuration.
        State:
          type: string
          enum:
          - ACTIVE
          - DELETING
          - DELETE_FAILED
          description: The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
      required:
      - Arn
      - CreationTime
      - Description
      - KafkaVersions
      - LatestRevision
      - Name
      - State
    ConfigurationInfo:
      type: object
      properties:
        Arn:
          type: string
          description: ARN of the configuration to use.
        Revision:
          type: integer
          description: The revision of the configuration to use.
      required:
      - Arn
      - Revision
    ConfigurationRevision:
      type: object
      properties:
        CreationTime:
          type: string
          format: date-time
          description: The time when the configuration revision was created.
        Description:
          type: string
          description: The description of the configuration revision.
        Revision:
          type: integer
          description: The revision number.
      required:
      - CreationTime
      - Revision
    ConflictException:
      type: object
      properties:
        InvalidParameter:
          type: string
          description: The parameter that caused the error.
        Message:
          type: string
          description: The description of the error.
    CreateConfigurationRequest:
      type: object
      properties:
        Description:
          type: string
          description: The description of the configuration.
        KafkaVersions:
          type: array
          items:
            type: string
          description: The versions of Apache Kafka with which you can use this MSK configuration.
        Name:
          type: string
          description: The name of the configuration.
        ServerProperties:
          type: string
          format: byte
          description: Contents of the server.properties file. When using the API, you must ensure that the contents of the
            file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties
            can be in plaintext.
      required:
      - Name
      - ServerProperties
    CreateConfigurationResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the configuration.
        CreationTime:
          type: string
          format: date-time
          description: The time when the configuration was created.
        LatestRevision:
          $ref: '#/components/schemas/ConfigurationRevision'
        Name:
          type: string
          description: The name of the configuration.
        State:
          type: string
          enum:
          - ACTIVE
          - DELETING
          - DELETE_FAILED
          description: The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
    DeleteConfigurationRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.
      required:
      - Arn
    DeleteConfigurationResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.
        State:
          type: string
          enum:
          - ACTIVE
          - DELETING
          - DELETE_FAILED
          description: The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
    DescribeConfigurationRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
      required:
      - Arn
    DescribeConfigurationResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the configuration.
        CreationTime:
          type: string
          format: date-time
          description: The time when the configuration was created.
        Description:
          type: string
          description: The description of the configuration.
        KafkaVersions:
          type: array
          items:
            type: string
          description: The versions of Apache Kafka with which you can use this MSK configuration.
        LatestRevision:
          $ref: '#/components/schemas/ConfigurationRevision'
        Name:
          type: string
          description: The name of the configuration.
        State:
          type: string
          enum:
          - ACTIVE
          - DELETING
          - DELETE_FAILED
          description: The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
    DescribeConfigurationRevisionRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
        Revision:
          type: integer
          description: A string that uniquely identifies a revision of an MSK configuration.
      required:
      - Arn
      - Revision
    DescribeConfigurationRevisionResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the configuration.
        CreationTime:
          type: string
          format: date-time
          description: The time when the configuration was created.
        Description:
          type: string
          description: The description of the configuration.
        Revision:
          type: integer
          description: The revision number.
        ServerProperties:
          type: string
          format: byte
          description: Contents of the server.properties file. When using the API, you must ensure that the contents of the
            file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties
            can be in plaintext.
    ForbiddenException:
      type: object
      properties:
        InvalidParameter:
          type: string
          description: The parameter that caused the error.
        Message:
          type: string
          description: The description of the error.
    InternalServerErrorException:
      type: object
      properties:
        InvalidParameter:
          type: string
          description: The parameter that caused the error.
        Message:
          type: string
          description: The description of the error.
    ListConfigurationRevisionsRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
        MaxResults:
          type: integer
          description: The maximum number of results to return in the response. If there are more results, the response includes
            a NextToken parameter.
        NextToken:
          type: string
          description: The paginated results marker. When the result of the operation is truncated, the call returns NextToken
            in the response. To get the next batch, provide this token in your next request.
      required:
      - Arn
    ListConfigurationRevisionsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: Paginated results marker.
        Revisions:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationRevision'
          description: List of ConfigurationRevision objects.
    ListConfigurationsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of results to return in the response. If there are more results, the response includes
            a NextToken parameter.
        NextToken:
          type: string
          description: The paginated results marker. When the result of the operation is truncated, the call returns NextToken
            in the response. To get the next batch, provide this token in your next request.
    ListConfigurationsResponse:
      type: object
      properties:
        Configurations:
          type: array
          items:
            $ref: '#/components/schemas/Configuration'
          description: An array of MSK configurations.
        NextToken:
          type: string
          description: The paginated results marker. When the result of a ListConfigurations operation is truncated, the call
            returns NextToken in the response. To get another batch of configurations, provide this token in your next request.
    NotFoundException:
      type: object
      properties:
        InvalidParameter:
          type: string
          description: The parameter that caused the error.
        Message:
          type: string
          description: The description of the error.
    ServiceUnavailableException:
      type: object
      properties:
        InvalidParameter:
          type: string
          description: The parameter that caused the error.
        Message:
          type: string
          description: The description of the error.
    TooManyRequestsException:
      type: object
      properties:
        InvalidParameter:
          type: string
          description: The parameter that caused the error.
        Message:
          type: string
          description: The description of the error.
    UnauthorizedException:
      type: object
      properties:
        InvalidParameter:
          type: string
          description: The parameter that caused the error.
        Message:
          type: string
          description: The description of the error.
    UpdateClusterConfigurationRequest:
      type: object
      properties:
        ClusterArn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies the cluster.
        ConfigurationInfo:
          $ref: '#/components/schemas/ConfigurationInfo'
        CurrentVersion:
          type: string
          description: The version of the cluster that needs to be updated.
      required:
      - ClusterArn
      - ConfigurationInfo
      - CurrentVersion
    UpdateClusterConfigurationResponse:
      type: object
      properties:
        ClusterArn:
          type: string
          description: The Amazon Resource Name (ARN) of the cluster.
        ClusterOperationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the cluster operation.
    UpdateConfigurationRequest:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the configuration.
        Description:
          type: string
          description: The description of the configuration revision.
        ServerProperties:
          type: string
          format: byte
          description: Contents of the server.properties file. When using the API, you must ensure that the contents of the
            file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties
            can be in plaintext.
      required:
      - Arn
      - ServerProperties
    UpdateConfigurationResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the configuration.
        LatestRevision:
          $ref: '#/components/schemas/ConfigurationRevision'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/kafka/service/2018-11-14/kafka-2018-11-14.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)