Amazon MSK Clusters API
The Clusters API from Amazon MSK — 18 operation(s) for clusters.
Documentation
Documentation
https://docs.aws.amazon.com/msk/
GettingStarted
https://aws.amazon.com/msk/getting-started/
OpenAPI Specification
openapi: 3.0.0
info:
version: 2018-11-14
x-release: v4
title: Managed Streaming for Kafka Clusters API
description: "\n <p>The operations for managing an Amazon MSK cluster.</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: 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: Clusters
paths:
/v1/clusters/{clusterArn}/scram-secrets:
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'
post:
operationId: BatchAssociateScramSecret
description: "\n <p>Associates one or more Scram Secrets with an Amazon MSK cluster.</p>"
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchAssociateScramSecretResponse'
examples:
BatchAssociateScramSecret200Example:
summary: Default BatchAssociateScramSecret 200 response
x-microcks-default: true
value:
ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example
UnprocessedScramSecrets: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
BatchAssociateScramSecret480Example:
summary: Default BatchAssociateScramSecret 480 response
x-microcks-default: true
value: {}
'481':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
examples:
BatchAssociateScramSecret481Example:
summary: Default BatchAssociateScramSecret 481 response
x-microcks-default: true
value: {}
'482':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
BatchAssociateScramSecret482Example:
summary: Default BatchAssociateScramSecret 482 response
x-microcks-default: true
value: {}
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
BatchAssociateScramSecret483Example:
summary: Default BatchAssociateScramSecret 483 response
x-microcks-default: true
value: {}
'484':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
BatchAssociateScramSecret484Example:
summary: Default BatchAssociateScramSecret 484 response
x-microcks-default: true
value: {}
'485':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
BatchAssociateScramSecret485Example:
summary: Default BatchAssociateScramSecret 485 response
x-microcks-default: true
value: {}
'486':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
BatchAssociateScramSecret486Example:
summary: Default BatchAssociateScramSecret 486 response
x-microcks-default: true
value: {}
parameters:
- name: clusterArn
in: path
required: true
description: "\n <p>The Amazon Resource Name (ARN) of the cluster to be updated.</p>"
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- secretArnList
properties:
secretArnList:
description: "\n <p>List of AWS Secrets Manager secret ARNs.</p>"
type: array
items:
$ref: '#/components/schemas/__string'
summary: Amazon MSK Batch Associate Scram Secret
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Clusters
patch:
operationId: BatchDisassociateScramSecret
description: "\n <p>Disassociates one or more Scram Secrets from an Amazon MSK cluster.</p>"
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDisassociateScramSecretResponse'
examples:
BatchDisassociateScramSecret200Example:
summary: Default BatchDisassociateScramSecret 200 response
x-microcks-default: true
value:
ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example
UnprocessedScramSecrets: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
BatchDisassociateScramSecret480Example:
summary: Default BatchDisassociateScramSecret 480 response
x-microcks-default: true
value: {}
'481':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
examples:
BatchDisassociateScramSecret481Example:
summary: Default BatchDisassociateScramSecret 481 response
x-microcks-default: true
value: {}
'482':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
BatchDisassociateScramSecret482Example:
summary: Default BatchDisassociateScramSecret 482 response
x-microcks-default: true
value: {}
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
BatchDisassociateScramSecret483Example:
summary: Default BatchDisassociateScramSecret 483 response
x-microcks-default: true
value: {}
'484':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
BatchDisassociateScramSecret484Example:
summary: Default BatchDisassociateScramSecret 484 response
x-microcks-default: true
value: {}
'485':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
BatchDisassociateScramSecret485Example:
summary: Default BatchDisassociateScramSecret 485 response
x-microcks-default: true
value: {}
'486':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
BatchDisassociateScramSecret486Example:
summary: Default BatchDisassociateScramSecret 486 response
x-microcks-default: true
value: {}
parameters:
- name: clusterArn
in: path
required: true
description: "\n <p>The Amazon Resource Name (ARN) of the cluster to be updated.</p>"
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- secretArnList
properties:
secretArnList:
description: "\n <p>List of AWS Secrets Manager secret ARNs.</p>"
type: array
items:
$ref: '#/components/schemas/__string'
summary: Amazon MSK Batch Disassociate Scram Secret
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Clusters
get:
operationId: ListScramSecrets
description: "\n <p>Returns a list of the Scram Secrets associated with an Amazon MSK cluster.</p>"
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListScramSecretsResponse'
examples:
ListScramSecrets200Example:
summary: Default ListScramSecrets 200 response
x-microcks-default: true
value:
NextToken: example-value
SecretArnList: arn:aws:service:us-east-1:123456789012:resource/example
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
ListScramSecrets480Example:
summary: Default ListScramSecrets 480 response
x-microcks-default: true
value: {}
'481':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
examples:
ListScramSecrets481Example:
summary: Default ListScramSecrets 481 response
x-microcks-default: true
value: {}
'482':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
ListScramSecrets482Example:
summary: Default ListScramSecrets 482 response
x-microcks-default: true
value: {}
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
ListScramSecrets483Example:
summary: Default ListScramSecrets 483 response
x-microcks-default: true
value: {}
'484':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
ListScramSecrets484Example:
summary: Default ListScramSecrets 484 response
x-microcks-default: true
value: {}
'485':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
ListScramSecrets485Example:
summary: Default ListScramSecrets 485 response
x-microcks-default: true
value: {}
'486':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
ListScramSecrets486Example:
summary: Default ListScramSecrets 486 response
x-microcks-default: true
value: {}
parameters:
- name: clusterArn
in: path
required: true
description: "\n <p>The arn of the cluster.</p>"
schema:
type: string
- name: maxResults
in: query
required: false
description: "\n <p>The maxResults of the query.</p>"
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: "\n <p>The nextToken of the query.</p>"
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 Scram Secrets
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Clusters
/v1/clusters:
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'
post:
operationId: CreateCluster
description: "\n <p>Creates a new MSK cluster.</p>"
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateClusterResponse'
examples:
CreateCluster200Example:
summary: Default CreateCluster 200 response
x-microcks-default: true
value:
ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example
ClusterName: example-resource
State: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
CreateCluster480Example:
summary: Default CreateCluster 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
CreateCluster481Example:
summary: Default CreateCluster 481 response
x-microcks-default: true
value: {}
'482':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
examples:
CreateCluster482Example:
summary: Default CreateCluster 482 response
x-microcks-default: true
value: {}
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
CreateCluster483Example:
summary: Default CreateCluster 483 response
x-microcks-default: true
value: {}
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
CreateCluster484Example:
summary: Default CreateCluster 484 response
x-microcks-default: true
value: {}
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
CreateCluster485Example:
summary: Default CreateCluster 485 response
x-microcks-default: true
value: {}
'486':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
CreateCluster486Example:
summary: Default CreateCluster 486 response
x-microcks-default: true
value: {}
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- brokerNodeGroupInfo
- clusterName
- kafkaVersion
- numberOfBrokerNodes
properties:
brokerNodeGroupInfo:
description: "\n <p>Describes the setup to be used for Apache Kafka broker nodes in the cluster.</p>"
type: object
properties:
BrokerAZDistribution:
allOf:
- $ref: '#/components/schemas/BrokerAZDistribution'
- xml:
name: brokerAZDistribution
description: "\n <p>The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.</p>\n <p>Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.</p>"
ClientSubnets:
allOf:
- $ref: '#/components/schemas/__listOf__string'
- xml:
name: clientSubnets
description: "\n <p>The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't occupy the Availability Zone with ID use use1-az3.</p>"
InstanceType:
allOf:
- $ref: '#/components/schemas/__stringMin5Max32'
- xml:
name: instanceType
description: "\n <p>The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,\nkafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.</p>"
SecurityGroups:
allOf:
- $ref: '#/components/schemas/__listOf__string'
- xml:
name: securityGroups
description: "\n <p>The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.</p>"
StorageInfo:
allOf:
- $ref: '#/components/schemas/StorageInfo'
- xml:
name: storageInfo
description: "\n <p>Contains information about storage volumes attached to MSK broker nodes.</p>"
ConnectivityInfo:
allOf:
- $ref: '#/components/schemas/ConnectivityInfo'
- xml:
name: connectivityInfo
description: "\n <p>Information about the broker access configuration.</p>"
clientAuthentication:
description: "\n <p>Includes all client authentication information.</p>"
type: object
properties:
Sasl:
allOf:
- $ref: '#/components/schemas/Sasl'
- xml:
name: sasl
description: "\n <p>Details for ClientAuthentication using SASL.</p>"
Tls:
allOf:
- $ref: '#/components/schemas/Tls'
- xml:
name: tls
description: "\n <p>Details for ClientAuthentication using TLS.</p>"
Unauthenticated:
allOf:
- $ref: '#/components/schemas/Unauthenticated'
- xml:
name: unauthenticated
description: "\n <p>Contains information about unauthenticated traffic to the cluster.</p>"
clusterName:
description: "\n <p>The name of the cluster.</p>"
type: string
minLength: 1
maxLength: 64
configurationInfo:
description: "\n <p>Specifies the configuration to use for the brokers.</p>"
type: object
properties:
Arn:
allOf:
- $ref: '#/components/schemas/__string'
- xml:
name: arn
description: "\n <p>ARN of the configuration to use.</p>"
Revision:
allOf:
- $ref: '#/components/schemas/__long'
- xml:
name: revision
description: "\n <p>The revision of the configuration to use.</p>"
encryptionInfo:
description: "\n <p>Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.</p>"
type: object
properties:
EncryptionAtRest:
allOf:
- $ref: '#/components/schemas/EncryptionAtRest'
- xml:
name: encryptionAtRest
description: "\n <p>The data-volume encryption details.</p>"
EncryptionInTransit:
allOf:
- $ref: '#/components/schemas/EncryptionInTransit'
- xml:
name: encryptionInTransit
description: "\n <p>The details for encryption in transit.</p>"
enhancedMonitoring:
description: "\n <p>Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see <a href=\"https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html\">Monitoring</a>.</p>"
type: string
enum:
- DEFAULT
- PER_BROKER
- PER_TOPIC_PER_BROKER
- PER_TOPIC_PER_PARTITION
openMonitoring:
description: "\n <p>JMX and Node monitoring for the MSK cluster.</p>"
type: object
properties:
Prometheus:
allOf:
- $ref: '#/components/schemas/PrometheusInfo'
- xml:
name: prometheus
description: "\n <p>Prometheus settings.</p>"
kafkaVersion:
description: "\n <p>The version of Apache Kafka.</p>"
type: string
minLength: 1
maxLength: 128
loggingInfo:
description: ''
type: object
properties:
BrokerLogs:
allOf:
- $ref: '#/components/schemas/BrokerLogs'
- xml:
name: brokerLogs
numberOfBrokerNodes:
description: "\n <p>The number of broker nodes in the cluster.</p>"
type: integer
minimum: 1
maximum: 15
tags:
description: "\n <p>Create tags when creating the cluster.</p>"
type: object
additionalProperties:
$ref: '#/components/schemas/__string'
storageMode:
description: Controls storage mode for various supported storage tiers.
type: string
enum:
- LOCAL
- TIERED
summary: Amazon MSK Create Cluster
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Clusters
get:
operationId: ListClusters
description: "\n <p>Returns a list of all the MSK clusters in the current Region.</p>"
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListClustersResponse'
examples:
ListClusters200Example:
summary: Default ListClusters 200 response
x-microcks-default: true
value:
ClusterInfoList: example-value
NextToken: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
ListClusters480Example:
summary: Default ListClusters 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
ListClusters481Example:
summary: Default ListClusters 481 response
x-microcks-default: true
value: {}
'482':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
examples:
ListClusters482Example:
summary: Default ListClusters 482 response
x-microcks-default: true
value: {}
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
ListClusters483Example:
summary: Default ListClusters 483 response
x-microcks-default: true
value: {}
parameters:
- name: clusterNameFilter
in: query
required: false
description: "\n <p>Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.</p>"
schema:
type: string
- name: maxResults
in: query
required: false
description: "\n <p>The maximum number of results to return in the response. If there are more results, the respon
# --- truncated at 32 KB (183 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-msk/refs/heads/main/openapi/amazon-msk-clusters-api-openapi.yml