openapi: 3.0.0 info: version: 2018-11-14 x-release: v4 title: Managed Streaming for Kafka Clusters Kafka Versions API description: "\n

The operations for managing an Amazon MSK cluster.

" 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: kafka x-aws-signingName: kafka x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/kafka-2018-11-14.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://kafka.{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 Kafka multi-region endpoint - url: https://kafka.{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 Kafka multi-region endpoint - url: http://kafka.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Kafka endpoint for China (Beijing) and China (Ningxia) - url: https://kafka.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Kafka endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Kafka Versions paths: /v1/kafka-versions: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListKafkaVersions description: "\n

Returns a list of Apache Kafka versions.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListKafkaVersionsResponse' examples: ListKafkaVersions200Example: summary: Default ListKafkaVersions 200 response x-microcks-default: true value: KafkaVersions: example-value NextToken: example-value '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListKafkaVersions480Example: summary: Default ListKafkaVersions 480 response x-microcks-default: true value: {} '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: ListKafkaVersions481Example: summary: Default ListKafkaVersions 481 response x-microcks-default: true value: {} '482': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListKafkaVersions482Example: summary: Default ListKafkaVersions 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: ListKafkaVersions483Example: summary: Default ListKafkaVersions 483 response x-microcks-default: true value: {} parameters: - name: maxResults in: query required: false description: "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

" schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: "\n

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.

" schema: type: string - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon MSK List Kafka Versions x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Kafka Versions components: schemas: ListKafkaVersionsResponse: type: object properties: KafkaVersions: allOf: - $ref: '#/components/schemas/__listOfKafkaVersion' - xml: name: kafkaVersions NextToken: allOf: - $ref: '#/components/schemas/__string' - xml: name: nextToken KafkaVersionStatus: type: string enum: - ACTIVE - DEPRECATED InternalServerErrorException: {} KafkaVersion: type: object properties: Version: allOf: - $ref: '#/components/schemas/__string' - xml: name: version Status: allOf: - $ref: '#/components/schemas/KafkaVersionStatus' - xml: name: status UnauthorizedException: {} BadRequestException: {} __string: type: string ForbiddenException: {} __listOfKafkaVersion: type: array items: $ref: '#/components/schemas/KafkaVersion' parameters: X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false 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/kafka/ x-hasEquivalentPaths: true