openapi: 3.0.0 info: version: 2018-11-14 x-release: v4 title: Managed Streaming for Kafka description: |2-

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 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/kafka/ 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) x-hasEquivalentPaths: true paths: "/v1/clusters/{clusterArn}/scram-secrets": post: operationId: BatchAssociateScramSecret description: |2-

Associates one or more Scram Secrets with an Amazon MSK cluster.

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: |2-

The Amazon Resource Name (ARN) of the cluster to be updated.

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - secretArnList properties: secretArnList: description: |2-

List of AWS Secrets Manager secret ARNs.

type: array items: $ref: "#/components/schemas/__string" summary: Amazon MSK Batch Associate Scram Secret x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" patch: operationId: BatchDisassociateScramSecret description: |2-

Disassociates one or more Scram Secrets from an Amazon MSK cluster.

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: |2-

The Amazon Resource Name (ARN) of the cluster to be updated.

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - secretArnList properties: secretArnList: description: |2-

List of AWS Secrets Manager secret ARNs.

type: array items: $ref: "#/components/schemas/__string" summary: Amazon MSK Batch Disassociate Scram Secret x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: ListScramSecrets description: |2-

Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

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: |2-

The arn of the cluster.

schema: type: string - name: maxResults in: query required: false description: |2-

The maxResults of the query.

schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: |2-

The nextToken of the query.

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 /v1/clusters: post: operationId: CreateCluster description: |2-

Creates a new MSK cluster.

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: |2-

Describes the setup to be used for Apache Kafka broker nodes in the cluster.

type: object properties: BrokerAZDistribution: allOf: - $ref: "#/components/schemas/BrokerAZDistribution" - xml: name: brokerAZDistribution description: |2-

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.

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.

ClientSubnets: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: clientSubnets description: |2-

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.

InstanceType: allOf: - $ref: "#/components/schemas/__stringMin5Max32" - xml: name: instanceType description: |2-

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, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

SecurityGroups: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: securityGroups description: |2-

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.

StorageInfo: allOf: - $ref: "#/components/schemas/StorageInfo" - xml: name: storageInfo description: |2-

Contains information about storage volumes attached to MSK broker nodes.

ConnectivityInfo: allOf: - $ref: "#/components/schemas/ConnectivityInfo" - xml: name: connectivityInfo description: |2-

Information about the broker access configuration.

clientAuthentication: description: |2-

Includes all client authentication information.

type: object properties: Sasl: allOf: - $ref: "#/components/schemas/Sasl" - xml: name: sasl description: |2-

Details for ClientAuthentication using SASL.

Tls: allOf: - $ref: "#/components/schemas/Tls" - xml: name: tls description: |2-

Details for ClientAuthentication using TLS.

Unauthenticated: allOf: - $ref: "#/components/schemas/Unauthenticated" - xml: name: unauthenticated description: |2-

Contains information about unauthenticated traffic to the cluster.

clusterName: description: |2-

The name of the cluster.

type: string minLength: 1 maxLength: 64 configurationInfo: description: |2-

Specifies the configuration to use for the brokers.

type: object properties: Arn: allOf: - $ref: "#/components/schemas/__string" - xml: name: arn description: |2-

ARN of the configuration to use.

Revision: allOf: - $ref: "#/components/schemas/__long" - xml: name: revision description: |2-

The revision of the configuration to use.

encryptionInfo: description: |2-

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.

type: object properties: EncryptionAtRest: allOf: - $ref: "#/components/schemas/EncryptionAtRest" - xml: name: encryptionAtRest description: |2-

The data-volume encryption details.

EncryptionInTransit: allOf: - $ref: "#/components/schemas/EncryptionInTransit" - xml: name: encryptionInTransit description: |2-

The details for encryption in transit.

enhancedMonitoring: description: |2-

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 Monitoring.

type: string enum: - DEFAULT - PER_BROKER - PER_TOPIC_PER_BROKER - PER_TOPIC_PER_PARTITION openMonitoring: description: |2-

JMX and Node monitoring for the MSK cluster.

type: object properties: Prometheus: allOf: - $ref: "#/components/schemas/PrometheusInfo" - xml: name: prometheus description: |2-

Prometheus settings.

kafkaVersion: description: |2-

The version of Apache Kafka.

type: string minLength: 1 maxLength: 128 loggingInfo: description: "" type: object properties: BrokerLogs: allOf: - $ref: "#/components/schemas/BrokerLogs" - xml: name: brokerLogs numberOfBrokerNodes: description: |2-

The number of broker nodes in the cluster.

type: integer minimum: 1 maximum: 15 tags: description: |2-

Create tags when creating the cluster.

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 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: ListClusters description: |2-

Returns a list of all the MSK clusters in the current Region.

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: |2-

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.

schema: type: string - name: maxResults in: query required: false description: |2-

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: |2-

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 Clusters x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/clusters: post: operationId: CreateClusterV2 description: |2-

Creates a new MSK cluster.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateClusterV2Response" examples: CreateClusterV2200Example: summary: Default CreateClusterV2 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterName: example-resource State: example-value ClusterType: STANDARD "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: CreateClusterV2480Example: summary: Default CreateClusterV2 480 response x-microcks-default: true value: {} "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: CreateClusterV2481Example: summary: Default CreateClusterV2 481 response x-microcks-default: true value: {} "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: CreateClusterV2482Example: summary: Default CreateClusterV2 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: CreateClusterV2483Example: summary: Default CreateClusterV2 483 response x-microcks-default: true value: {} "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: CreateClusterV2484Example: summary: Default CreateClusterV2 484 response x-microcks-default: true value: {} "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: CreateClusterV2485Example: summary: Default CreateClusterV2 485 response x-microcks-default: true value: {} "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: CreateClusterV2486Example: summary: Default CreateClusterV2 486 response x-microcks-default: true value: {} parameters: [] requestBody: required: true content: application/json: schema: type: object required: - clusterName properties: clusterName: description: |2-

The name of the cluster.

type: string minLength: 1 maxLength: 64 tags: description: |2-

A map of tags that you want the cluster to have.

type: object additionalProperties: $ref: "#/components/schemas/__string" provisioned: description: |2-

Provisioned cluster request.

type: object properties: BrokerNodeGroupInfo: allOf: - $ref: "#/components/schemas/BrokerNodeGroupInfo" - xml: name: brokerNodeGroupInfo description: |2-

Information about the brokers.

ClientAuthentication: allOf: - $ref: "#/components/schemas/ClientAuthentication" - xml: name: clientAuthentication description: |2-

Includes all client authentication information.

ConfigurationInfo: allOf: - $ref: "#/components/schemas/ConfigurationInfo" - xml: name: configurationInfo description: |2-

Represents the configuration that you want Amazon MSK to use for the brokers in a cluster.

EncryptionInfo: allOf: - $ref: "#/components/schemas/EncryptionInfo" - xml: name: encryptionInfo description: |2-

Includes all encryption-related information.

EnhancedMonitoring: allOf: - $ref: "#/components/schemas/EnhancedMonitoring" - xml: name: enhancedMonitoring description: |2-

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

OpenMonitoring: allOf: - $ref: "#/components/schemas/OpenMonitoringInfo" - xml: name: openMonitoring description: |2-

The settings for open monitoring.

KafkaVersion: allOf: - $ref: "#/components/schemas/__stringMin1Max128" - xml: name: kafkaVersion description: |2-

The Apache Kafka version that you want for the cluster.

LoggingInfo: allOf: - $ref: "#/components/schemas/LoggingInfo" - xml: name: loggingInfo description: |2-

Log delivery information for the cluster.

NumberOfBrokerNodes: allOf: - $ref: "#/components/schemas/__integerMin1Max15" - xml: name: numberOfBrokerNodes description: |2-

The number of broker nodes in the cluster.

StorageMode: allOf: - $ref: "#/components/schemas/StorageMode" - xml: name: storageMode description: |2-

This controls storage mode for supported storage tiers.

serverless: description: |2-

Serverless cluster request.

type: object properties: VpcConfigs: allOf: - $ref: "#/components/schemas/__listOfVpcConfig" - xml: name: vpcConfigs description: |2-

The configuration of the Amazon VPCs for the cluster.

ClientAuthentication: allOf: - $ref: "#/components/schemas/ServerlessClientAuthentication" - xml: name: clientAuthentication description: |2-

Includes all client authentication information.

summary: Amazon MSK Create Cluster V2 x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: ListClustersV2 description: |2-

Returns a list of all the MSK clusters in the current Region.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListClustersV2Response" examples: ListClustersV2200Example: summary: Default ListClustersV2 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: ListClustersV2480Example: summary: Default ListClustersV2 480 response x-microcks-default: true value: {} "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: ListClustersV2481Example: summary: Default ListClustersV2 481 response x-microcks-default: true value: {} "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: ListClustersV2482Example: summary: Default ListClustersV2 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: ListClustersV2483Example: summary: Default ListClustersV2 483 response x-microcks-default: true value: {} parameters: - name: clusterNameFilter in: query required: false description: |2-

Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

schema: type: string - name: clusterTypeFilter in: query required: false description: |2-

Specify either PROVISIONED or SERVERLESS.

schema: type: string - name: maxResults in: query required: false description: |2-

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: |2-

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 Clusters V2 x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/configurations: post: operationId: CreateConfiguration description: |2-

Creates a new MSK configuration.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateConfigurationResponse" examples: CreateConfiguration200Example: summary: Default CreateConfiguration 200 response x-microcks-default: true value: Arn: arn:aws:service:us-east-1:123456789012:resource/example CreationTime: example-value LatestRevision: example-value Name: example-resource State: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: CreateConfiguration480Example: summary: Default CreateConfiguration 480 response x-microcks-default: true value: {} "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: CreateConfiguration481Example: summary: Default CreateConfiguration 481 response x-microcks-default: true value: {} "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: CreateConfiguration482Example: summary: Default CreateConfiguration 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: CreateConfiguration483Example: summary: Default CreateConfiguration 483 response x-microcks-default: true value: {} "484": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: CreateConfiguration484Example: summary: Default CreateConfiguration 484 response x-microcks-default: true value: {} "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: CreateConfiguration485Example: summary: Default CreateConfiguration 485 response x-microcks-default: true value: {} "486": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: CreateConfiguration486Example: summary: Default CreateConfiguration 486 response x-microcks-default: true value: {} parameters: [] requestBody: required: true content: application/json: schema: type: object required: - name - serverProperties properties: description: description: |2-

The description of the configuration.

type: string kafkaVersions: description: |2-

The versions of Apache Kafka with which you can use this MSK configuration.

type: array items: $ref: "#/components/schemas/__string" name: description: |2-

The name of the configuration.

type: string serverProperties: description: |2-

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.

type: string summary: Amazon MSK Create Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: ListConfigurations description: |2-

Returns a list of all the MSK configurations in this Region.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListConfigurationsResponse" examples: ListConfigurations200Example: summary: Default ListConfigurations 200 response x-microcks-default: true value: Configurations: example-value NextToken: example-value "480": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: ListConfigurations480Example: summary: Default ListConfigurations 480 response x-microcks-default: true value: {} "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: ListConfigurations481Example: summary: Default ListConfigurations 481 response x-microcks-default: true value: {} "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: ListConfigurations482Example: summary: Default ListConfigurations 482 response x-microcks-default: true value: {} "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: ListConfigurations483Example: summary: Default ListConfigurations 483 response x-microcks-default: true value: {} "484": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: ListConfigurations484Example: summary: Default ListConfigurations 484 response x-microcks-default: true value: {} parameters: - name: maxResults in: query required: false description: |2-

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: |2-

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 Configurations x-microcks-operation: delay: 0 dispatcher: FALLBACK "/v1/clusters/{clusterArn}": delete: operationId: DeleteCluster description: |2-

Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteClusterResponse" examples: DeleteCluster200Example: summary: Default DeleteCluster 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example State: example-value "480": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: DeleteCluster480Example: summary: Default DeleteCluster 480 response x-microcks-default: true value: {} "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: DeleteCluster481Example: summary: Default DeleteCluster 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: DeleteCluster482Example: summary: Default DeleteCluster 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: DeleteCluster483Example: summary: Default DeleteCluster 483 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

schema: type: string - name: currentVersion in: query required: false description: |2-

The current version of the MSK cluster.

schema: type: string summary: Amazon MSK Delete Cluster x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: DescribeCluster description: |2-

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeClusterResponse" examples: DescribeCluster200Example: summary: Default DescribeCluster 200 response x-microcks-default: true value: ClusterInfo: example-value "480": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: DescribeCluster480Example: summary: Default DescribeCluster 480 response x-microcks-default: true value: {} "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: DescribeCluster481Example: summary: Default DescribeCluster 481 response x-microcks-default: true value: {} "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: DescribeCluster482Example: summary: Default DescribeCluster 482 response x-microcks-default: true value: {} "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: DescribeCluster483Example: summary: Default DescribeCluster 483 response x-microcks-default: true value: {} "484": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: DescribeCluster484Example: summary: Default DescribeCluster 484 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

schema: type: string summary: Amazon MSK Describe Cluster x-microcks-operation: delay: 0 dispatcher: FALLBACK "/v1/configurations/{arn}": delete: operationId: DeleteConfiguration description: |2-

Deletes an MSK Configuration.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteConfigurationResponse" examples: DeleteConfiguration200Example: summary: Default DeleteConfiguration 200 response x-microcks-default: true value: Arn: arn:aws:service:us-east-1:123456789012:resource/example State: example-value "480": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: DeleteConfiguration480Example: summary: Default DeleteConfiguration 480 response x-microcks-default: true value: {} "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: DeleteConfiguration481Example: summary: Default DeleteConfiguration 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: DeleteConfiguration482Example: summary: Default DeleteConfiguration 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: DeleteConfiguration483Example: summary: Default DeleteConfiguration 483 response x-microcks-default: true value: {} parameters: - name: arn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.

schema: type: string summary: Amazon MSK Delete Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: DescribeConfiguration description: |2-

Returns a description of this MSK configuration.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeConfigurationResponse" examples: DescribeConfiguration200Example: summary: Default DescribeConfiguration 200 response x-microcks-default: true value: Arn: arn:aws:service:us-east-1:123456789012:resource/example CreationTime: example-value Description: Example description KafkaVersions: example-value LatestRevision: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: DescribeConfiguration480Example: summary: Default DescribeConfiguration 480 response x-microcks-default: true value: {} "481": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: DescribeConfiguration481Example: summary: Default DescribeConfiguration 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: DescribeConfiguration482Example: summary: Default DescribeConfiguration 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: DescribeConfiguration483Example: summary: Default DescribeConfiguration 483 response x-microcks-default: true value: {} "484": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: DescribeConfiguration484Example: summary: Default DescribeConfiguration 484 response x-microcks-default: true value: {} "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: DescribeConfiguration485Example: summary: Default DescribeConfiguration 485 response x-microcks-default: true value: {} parameters: - name: arn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

schema: type: string summary: Amazon MSK Describe Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateConfiguration description: |2-

Updates an MSK configuration.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateConfigurationResponse" examples: UpdateConfiguration200Example: summary: Default UpdateConfiguration 200 response x-microcks-default: true value: Arn: arn:aws:service:us-east-1:123456789012:resource/example LatestRevision: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: UpdateConfiguration480Example: summary: Default UpdateConfiguration 480 response x-microcks-default: true value: {} "481": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: UpdateConfiguration481Example: summary: Default UpdateConfiguration 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UpdateConfiguration482Example: summary: Default UpdateConfiguration 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateConfiguration483Example: summary: Default UpdateConfiguration 483 response x-microcks-default: true value: {} "484": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: UpdateConfiguration484Example: summary: Default UpdateConfiguration 484 response x-microcks-default: true value: {} "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: UpdateConfiguration485Example: summary: Default UpdateConfiguration 485 response x-microcks-default: true value: {} parameters: - name: arn in: path required: true description: |2-

The Amazon Resource Name (ARN) of the configuration.

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - serverProperties properties: description: description: |2-

The description of the configuration revision.

type: string serverProperties: description: |2-

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.

type: string summary: Amazon MSK Update Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK "/api/v2/clusters/{clusterArn}": get: operationId: DescribeClusterV2 description: |2-

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeClusterV2Response" examples: DescribeClusterV2200Example: summary: Default DescribeClusterV2 200 response x-microcks-default: true value: ClusterInfo: example-value "480": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: DescribeClusterV2480Example: summary: Default DescribeClusterV2 480 response x-microcks-default: true value: {} "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: DescribeClusterV2481Example: summary: Default DescribeClusterV2 481 response x-microcks-default: true value: {} "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: DescribeClusterV2482Example: summary: Default DescribeClusterV2 482 response x-microcks-default: true value: {} "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: DescribeClusterV2483Example: summary: Default DescribeClusterV2 483 response x-microcks-default: true value: {} "484": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: DescribeClusterV2484Example: summary: Default DescribeClusterV2 484 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

schema: type: string summary: Amazon MSK Describe Cluster V2 x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/operations/{clusterOperationArn}": get: operationId: DescribeClusterOperation description: |2-

Returns a description of the cluster operation specified by the ARN.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeClusterOperationResponse" examples: DescribeClusterOperation200Example: summary: Default DescribeClusterOperation 200 response x-microcks-default: true value: ClusterOperationInfo: example-value "480": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: DescribeClusterOperation480Example: summary: Default DescribeClusterOperation 480 response x-microcks-default: true value: {} "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: DescribeClusterOperation481Example: summary: Default DescribeClusterOperation 481 response x-microcks-default: true value: {} "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: DescribeClusterOperation482Example: summary: Default DescribeClusterOperation 482 response x-microcks-default: true value: {} "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: DescribeClusterOperation483Example: summary: Default DescribeClusterOperation 483 response x-microcks-default: true value: {} "484": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: DescribeClusterOperation484Example: summary: Default DescribeClusterOperation 484 response x-microcks-default: true value: {} parameters: - name: clusterOperationArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.

schema: type: string summary: Amazon MSK Describe Cluster Operation x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/configurations/{arn}/revisions/{revision}": get: operationId: DescribeConfigurationRevision description: |2-

Returns a description of this revision of the configuration.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeConfigurationRevisionResponse" examples: DescribeConfigurationRevision200Example: summary: Default DescribeConfigurationRevision 200 response x-microcks-default: true value: Arn: arn:aws:service:us-east-1:123456789012:resource/example CreationTime: example-value Description: Example description Revision: example-value ServerProperties: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: DescribeConfigurationRevision480Example: summary: Default DescribeConfigurationRevision 480 response x-microcks-default: true value: {} "481": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: DescribeConfigurationRevision481Example: summary: Default DescribeConfigurationRevision 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: DescribeConfigurationRevision482Example: summary: Default DescribeConfigurationRevision 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: DescribeConfigurationRevision483Example: summary: Default DescribeConfigurationRevision 483 response x-microcks-default: true value: {} "484": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: DescribeConfigurationRevision484Example: summary: Default DescribeConfigurationRevision 484 response x-microcks-default: true value: {} "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: DescribeConfigurationRevision485Example: summary: Default DescribeConfigurationRevision 485 response x-microcks-default: true value: {} parameters: - name: arn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

schema: type: string - name: revision in: path required: true description: |2-

A string that uniquely identifies a revision of an MSK configuration.

schema: type: integer summary: Amazon MSK Describe Configuration Revision x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/clusters/{clusterArn}/bootstrap-brokers": get: operationId: GetBootstrapBrokers description: |2-

A list of brokers that a client application can use to bootstrap.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetBootstrapBrokersResponse" examples: GetBootstrapBrokers200Example: summary: Default GetBootstrapBrokers 200 response x-microcks-default: true value: BootstrapBrokerString: example-value BootstrapBrokerStringTls: example-value BootstrapBrokerStringSaslScram: example-value BootstrapBrokerStringSaslIam: example-value BootstrapBrokerStringPublicTls: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: GetBootstrapBrokers480Example: summary: Default GetBootstrapBrokers 480 response x-microcks-default: true value: {} "481": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: GetBootstrapBrokers481Example: summary: Default GetBootstrapBrokers 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: GetBootstrapBrokers482Example: summary: Default GetBootstrapBrokers 482 response x-microcks-default: true value: {} "483": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: GetBootstrapBrokers483Example: summary: Default GetBootstrapBrokers 483 response x-microcks-default: true value: {} "484": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: GetBootstrapBrokers484Example: summary: Default GetBootstrapBrokers 484 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

schema: type: string summary: Amazon MSK Get Bootstrap Brokers x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /v1/compatible-kafka-versions: get: operationId: GetCompatibleKafkaVersions description: |2-

Gets the Apache Kafka versions to which you can update the MSK cluster.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetCompatibleKafkaVersionsResponse" examples: GetCompatibleKafkaVersions200Example: summary: Default GetCompatibleKafkaVersions 200 response x-microcks-default: true value: CompatibleKafkaVersions: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: GetCompatibleKafkaVersions480Example: summary: Default GetCompatibleKafkaVersions 480 response x-microcks-default: true value: {} "481": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: GetCompatibleKafkaVersions481Example: summary: Default GetCompatibleKafkaVersions 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: GetCompatibleKafkaVersions482Example: summary: Default GetCompatibleKafkaVersions 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: GetCompatibleKafkaVersions483Example: summary: Default GetCompatibleKafkaVersions 483 response x-microcks-default: true value: {} "484": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: GetCompatibleKafkaVersions484Example: summary: Default GetCompatibleKafkaVersions 484 response x-microcks-default: true value: {} "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: GetCompatibleKafkaVersions485Example: summary: Default GetCompatibleKafkaVersions 485 response x-microcks-default: true value: {} "486": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: GetCompatibleKafkaVersions486Example: summary: Default GetCompatibleKafkaVersions 486 response x-microcks-default: true value: {} parameters: - name: clusterArn in: query required: false description: |2-

The Amazon Resource Name (ARN) of the cluster check.

schema: type: string summary: Amazon MSK Get Compatible Kafka Versions x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/clusters/{clusterArn}/operations": get: operationId: ListClusterOperations description: |2-

Returns a list of all the operations that have been performed on the specified MSK cluster.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListClusterOperationsResponse" examples: ListClusterOperations200Example: summary: Default ListClusterOperations 200 response x-microcks-default: true value: ClusterOperationInfoList: example-value NextToken: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: ListClusterOperations480Example: summary: Default ListClusterOperations 480 response x-microcks-default: true value: {} "481": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: ListClusterOperations481Example: summary: Default ListClusterOperations 481 response x-microcks-default: true value: {} "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: ListClusterOperations482Example: summary: Default ListClusterOperations 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: ListClusterOperations483Example: summary: Default ListClusterOperations 483 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

schema: type: string - name: maxResults in: query required: false description: |2-

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: |2-

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 Cluster Operations x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/configurations/{arn}/revisions": get: operationId: ListConfigurationRevisions description: |2-

Returns a list of all the MSK configurations in this Region.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListConfigurationRevisionsResponse" examples: ListConfigurationRevisions200Example: summary: Default ListConfigurationRevisions 200 response x-microcks-default: true value: NextToken: example-value Revisions: example-value "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: ListConfigurationRevisions480Example: summary: Default ListConfigurationRevisions 480 response x-microcks-default: true value: {} "481": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: ListConfigurationRevisions481Example: summary: Default ListConfigurationRevisions 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: ListConfigurationRevisions482Example: summary: Default ListConfigurationRevisions 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: ListConfigurationRevisions483Example: summary: Default ListConfigurationRevisions 483 response x-microcks-default: true value: {} "484": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: ListConfigurationRevisions484Example: summary: Default ListConfigurationRevisions 484 response x-microcks-default: true value: {} "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: ListConfigurationRevisions485Example: summary: Default ListConfigurationRevisions 485 response x-microcks-default: true value: {} parameters: - name: arn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

schema: type: string - name: maxResults in: query required: false description: |2-

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: |2-

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 Configuration Revisions x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /v1/kafka-versions: get: operationId: ListKafkaVersions description: |2-

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: |2-

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: |2-

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 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" "/v1/clusters/{clusterArn}/nodes": get: operationId: ListNodes description: |2-

Returns a list of the broker nodes in the cluster.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListNodesResponse" examples: ListNodes200Example: summary: Default ListNodes 200 response x-microcks-default: true value: NextToken: example-value NodeInfoList: example-value "480": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: ListNodes480Example: summary: Default ListNodes 480 response x-microcks-default: true value: {} "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: ListNodes481Example: summary: Default ListNodes 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: ListNodes482Example: summary: Default ListNodes 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: ListNodes483Example: summary: Default ListNodes 483 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

schema: type: string - name: maxResults in: query required: false description: |2-

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: |2-

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 Nodes x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/tags/{resourceArn}": get: operationId: ListTagsForResource description: |2-

Returns a list of the tags associated with the specified resource.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListTagsForResourceResponse" examples: ListTagsForResource200Example: summary: Default ListTagsForResource 200 response x-microcks-default: true value: Tags: example-value "480": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: ListTagsForResource480Example: summary: Default ListTagsForResource 480 response x-microcks-default: true value: {} "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: ListTagsForResource481Example: summary: Default ListTagsForResource 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: ListTagsForResource482Example: summary: Default ListTagsForResource 482 response x-microcks-default: true value: {} parameters: - name: resourceArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

schema: type: string summary: Amazon MSK List Tags for Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: TagResource description: |2-

Adds tags to the specified MSK resource.

responses: "204": description: Success "480": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: TagResource480Example: summary: Default TagResource 480 response x-microcks-default: true value: {} "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: TagResource481Example: summary: Default TagResource 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: TagResource482Example: summary: Default TagResource 482 response x-microcks-default: true value: {} parameters: - name: resourceArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - tags properties: tags: description: |2-

The key-value pair for the resource tag.

type: object additionalProperties: $ref: "#/components/schemas/__string" summary: Amazon MSK Tag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK "/v1/clusters/{clusterArn}/reboot-broker": put: operationId: RebootBroker description: Reboots brokers. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/RebootBrokerResponse" examples: RebootBroker200Example: summary: Default RebootBroker 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: RebootBroker480Example: summary: Default RebootBroker 480 response x-microcks-default: true value: {} "481": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: RebootBroker481Example: summary: Default RebootBroker 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: RebootBroker482Example: summary: Default RebootBroker 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: RebootBroker483Example: summary: Default RebootBroker 483 response x-microcks-default: true value: {} "484": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: RebootBroker484Example: summary: Default RebootBroker 484 response x-microcks-default: true value: {} "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: RebootBroker485Example: summary: Default RebootBroker 485 response x-microcks-default: true value: {} "486": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: RebootBroker486Example: summary: Default RebootBroker 486 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) of the cluster to be updated.

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - brokerIds properties: brokerIds: description: |2-

The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.

type: array items: $ref: "#/components/schemas/__string" summary: Amazon MSK Reboot Broker x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/tags/{resourceArn}#tagKeys": delete: operationId: UntagResource description: |2-

Removes the tags associated with the keys that are provided in the query.

responses: "204": description: Success "480": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: UntagResource480Example: summary: Default UntagResource 480 response x-microcks-default: true value: {} "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: UntagResource481Example: summary: Default UntagResource 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UntagResource482Example: summary: Default UntagResource 482 response x-microcks-default: true value: {} parameters: - name: resourceArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

schema: type: string - name: tagKeys in: query required: true description: |2-

Tag keys must be unique for a given cluster. In addition, the following restrictions apply:

schema: type: array items: $ref: "#/components/schemas/__string" summary: Amazon MSK Untag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/clusters/{clusterArn}/nodes/count": put: operationId: UpdateBrokerCount description: |2-

Updates the number of broker nodes in the cluster.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateBrokerCountResponse" examples: UpdateBrokerCount200Example: summary: Default UpdateBrokerCount 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example "480": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: UpdateBrokerCount480Example: summary: Default UpdateBrokerCount 480 response x-microcks-default: true value: {} "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: UpdateBrokerCount481Example: summary: Default UpdateBrokerCount 481 response x-microcks-default: true value: {} "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: UpdateBrokerCount482Example: summary: Default UpdateBrokerCount 482 response x-microcks-default: true value: {} "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UpdateBrokerCount483Example: summary: Default UpdateBrokerCount 483 response x-microcks-default: true value: {} "484": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateBrokerCount484Example: summary: Default UpdateBrokerCount 484 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - currentVersion - targetNumberOfBrokerNodes properties: currentVersion: description: |2-

The version of cluster to update from. A successful operation will then generate a new version.

type: string targetNumberOfBrokerNodes: description: |2-

The number of broker nodes that you want the cluster to have after this operation completes successfully.

type: integer minimum: 1 maximum: 15 summary: Amazon MSK Update Broker Count x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/clusters/{clusterArn}/nodes/type": put: operationId: UpdateBrokerType description: |2-

Updates EC2 instance type.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateBrokerTypeResponse" examples: UpdateBrokerType200Example: summary: Default UpdateBrokerType 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: UpdateBrokerType480Example: summary: Default UpdateBrokerType 480 response x-microcks-default: true value: {} "481": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: UpdateBrokerType481Example: summary: Default UpdateBrokerType 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UpdateBrokerType482Example: summary: Default UpdateBrokerType 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateBrokerType483Example: summary: Default UpdateBrokerType 483 response x-microcks-default: true value: {} "484": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: UpdateBrokerType484Example: summary: Default UpdateBrokerType 484 response x-microcks-default: true value: {} "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: UpdateBrokerType485Example: summary: Default UpdateBrokerType 485 response x-microcks-default: true value: {} "486": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UpdateBrokerType486Example: summary: Default UpdateBrokerType 486 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - currentVersion - targetInstanceType properties: currentVersion: description: |2-

The cluster version that you want to change. After this operation completes successfully, the cluster will have a new version.

type: string targetInstanceType: description: |2-

The Amazon MSK broker type that you want all of the brokers in this cluster to be.

type: string summary: Amazon MSK Update Broker Type x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/clusters/{clusterArn}/nodes/storage": put: operationId: UpdateBrokerStorage description: |2-

Updates the EBS storage associated with MSK brokers.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateBrokerStorageResponse" examples: UpdateBrokerStorage200Example: summary: Default UpdateBrokerStorage 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example "480": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: UpdateBrokerStorage480Example: summary: Default UpdateBrokerStorage 480 response x-microcks-default: true value: {} "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: UpdateBrokerStorage481Example: summary: Default UpdateBrokerStorage 481 response x-microcks-default: true value: {} "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: UpdateBrokerStorage482Example: summary: Default UpdateBrokerStorage 482 response x-microcks-default: true value: {} "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UpdateBrokerStorage483Example: summary: Default UpdateBrokerStorage 483 response x-microcks-default: true value: {} "484": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateBrokerStorage484Example: summary: Default UpdateBrokerStorage 484 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - currentVersion - targetBrokerEBSVolumeInfo properties: currentVersion: description: |2-

The version of cluster to update from. A successful operation will then generate a new version.

type: string targetBrokerEBSVolumeInfo: description: |2-

Describes the target volume size and the ID of the broker to apply the update to.

type: array items: $ref: "#/components/schemas/BrokerEBSVolumeInfo" summary: Amazon MSK Update Broker Storage x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/clusters/{clusterArn}/connectivity": put: operationId: UpdateConnectivity description: |2-

Updates the cluster's connectivity configuration.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateConnectivityResponse" examples: UpdateConnectivity200Example: summary: Default UpdateConnectivity 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: UpdateConnectivity480Example: summary: Default UpdateConnectivity 480 response x-microcks-default: true value: {} "481": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: UpdateConnectivity481Example: summary: Default UpdateConnectivity 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UpdateConnectivity482Example: summary: Default UpdateConnectivity 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateConnectivity483Example: summary: Default UpdateConnectivity 483 response x-microcks-default: true value: {} "484": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: UpdateConnectivity484Example: summary: Default UpdateConnectivity 484 response x-microcks-default: true value: {} "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: UpdateConnectivity485Example: summary: Default UpdateConnectivity 485 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) of the configuration.

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - connectivityInfo - currentVersion properties: connectivityInfo: description: |2-

Information about the broker access configuration.

type: object properties: PublicAccess: allOf: - $ref: "#/components/schemas/PublicAccess" - xml: name: publicAccess description: |2-

Public access control for brokers.

currentVersion: description: |2-

The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

type: string summary: Amazon MSK Update Connectivity x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/clusters/{clusterArn}/configuration": put: operationId: UpdateClusterConfiguration description: |2-

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" examples: UpdateClusterConfiguration200Example: summary: Default UpdateClusterConfiguration 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: UpdateClusterConfiguration480Example: summary: Default UpdateClusterConfiguration 480 response x-microcks-default: true value: {} "481": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: UpdateClusterConfiguration481Example: summary: Default UpdateClusterConfiguration 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UpdateClusterConfiguration482Example: summary: Default UpdateClusterConfiguration 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateClusterConfiguration483Example: summary: Default UpdateClusterConfiguration 483 response x-microcks-default: true value: {} "484": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: UpdateClusterConfiguration484Example: summary: Default UpdateClusterConfiguration 484 response x-microcks-default: true value: {} "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: UpdateClusterConfiguration485Example: summary: Default UpdateClusterConfiguration 485 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - configurationInfo - currentVersion properties: configurationInfo: description: |2-

Specifies the configuration to use for the brokers.

type: object properties: Arn: allOf: - $ref: "#/components/schemas/__string" - xml: name: arn description: |2-

ARN of the configuration to use.

Revision: allOf: - $ref: "#/components/schemas/__long" - xml: name: revision description: |2-

The revision of the configuration to use.

currentVersion: description: |2-

The version of the cluster that needs to be updated.

type: string summary: Amazon MSK Update Cluster Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/clusters/{clusterArn}/version": put: operationId: UpdateClusterKafkaVersion description: |2-

Updates the Apache Kafka version for the cluster.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateClusterKafkaVersionResponse" examples: UpdateClusterKafkaVersion200Example: summary: Default UpdateClusterKafkaVersion 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: UpdateClusterKafkaVersion480Example: summary: Default UpdateClusterKafkaVersion 480 response x-microcks-default: true value: {} "481": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: UpdateClusterKafkaVersion481Example: summary: Default UpdateClusterKafkaVersion 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UpdateClusterKafkaVersion482Example: summary: Default UpdateClusterKafkaVersion 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateClusterKafkaVersion483Example: summary: Default UpdateClusterKafkaVersion 483 response x-microcks-default: true value: {} "484": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: UpdateClusterKafkaVersion484Example: summary: Default UpdateClusterKafkaVersion 484 response x-microcks-default: true value: {} "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: UpdateClusterKafkaVersion485Example: summary: Default UpdateClusterKafkaVersion 485 response x-microcks-default: true value: {} "486": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UpdateClusterKafkaVersion486Example: summary: Default UpdateClusterKafkaVersion 486 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) of the cluster to be updated.

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - currentVersion - targetKafkaVersion properties: configurationInfo: description: |2-

Specifies the configuration to use for the brokers.

type: object properties: Arn: allOf: - $ref: "#/components/schemas/__string" - xml: name: arn description: |2-

ARN of the configuration to use.

Revision: allOf: - $ref: "#/components/schemas/__long" - xml: name: revision description: |2-

The revision of the configuration to use.

currentVersion: description: |2-

Current cluster version.

type: string targetKafkaVersion: description: |2-

Target Kafka version.

type: string summary: Amazon MSK Update Cluster Kafka Version x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/clusters/{clusterArn}/monitoring": put: operationId: UpdateMonitoring description: |2-

Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateMonitoringResponse" examples: UpdateMonitoring200Example: summary: Default UpdateMonitoring 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example "480": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: UpdateMonitoring480Example: summary: Default UpdateMonitoring 480 response x-microcks-default: true value: {} "481": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: UpdateMonitoring481Example: summary: Default UpdateMonitoring 481 response x-microcks-default: true value: {} "482": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: UpdateMonitoring482Example: summary: Default UpdateMonitoring 482 response x-microcks-default: true value: {} "483": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UpdateMonitoring483Example: summary: Default UpdateMonitoring 483 response x-microcks-default: true value: {} "484": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateMonitoring484Example: summary: Default UpdateMonitoring 484 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - currentVersion properties: currentVersion: description: |2-

The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

type: string enhancedMonitoring: description: |2-

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 Monitoring.

type: string enum: - DEFAULT - PER_BROKER - PER_TOPIC_PER_BROKER - PER_TOPIC_PER_PARTITION openMonitoring: description: |2-

JMX and Node monitoring for the MSK cluster.

type: object properties: Prometheus: allOf: - $ref: "#/components/schemas/PrometheusInfo" - xml: name: prometheus description: |2-

Prometheus settings.

loggingInfo: description: "" type: object properties: BrokerLogs: allOf: - $ref: "#/components/schemas/BrokerLogs" - xml: name: brokerLogs summary: Amazon MSK Update Monitoring x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/clusters/{clusterArn}/security": patch: operationId: UpdateSecurity description: |2-

Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateSecurityResponse" examples: UpdateSecurity200Example: summary: Default UpdateSecurity 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: UpdateSecurity480Example: summary: Default UpdateSecurity 480 response x-microcks-default: true value: {} "481": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: UpdateSecurity481Example: summary: Default UpdateSecurity 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UpdateSecurity482Example: summary: Default UpdateSecurity 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateSecurity483Example: summary: Default UpdateSecurity 483 response x-microcks-default: true value: {} "484": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: UpdateSecurity484Example: summary: Default UpdateSecurity 484 response x-microcks-default: true value: {} "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: UpdateSecurity485Example: summary: Default UpdateSecurity 485 response x-microcks-default: true value: {} "486": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UpdateSecurity486Example: summary: Default UpdateSecurity 486 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - currentVersion properties: clientAuthentication: description: |2-

Includes all client authentication information.

type: object properties: Sasl: allOf: - $ref: "#/components/schemas/Sasl" - xml: name: sasl description: |2-

Details for ClientAuthentication using SASL.

Tls: allOf: - $ref: "#/components/schemas/Tls" - xml: name: tls description: |2-

Details for ClientAuthentication using TLS.

Unauthenticated: allOf: - $ref: "#/components/schemas/Unauthenticated" - xml: name: unauthenticated description: |2-

Contains information about unauthenticated traffic to the cluster.

currentVersion: description: |2-

The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

type: string encryptionInfo: description: |2-

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.

type: object properties: EncryptionAtRest: allOf: - $ref: "#/components/schemas/EncryptionAtRest" - xml: name: encryptionAtRest description: |2-

The data-volume encryption details.

EncryptionInTransit: allOf: - $ref: "#/components/schemas/EncryptionInTransit" - xml: name: encryptionInTransit description: |2-

The details for encryption in transit.

summary: Amazon MSK Update Security x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" "/v1/clusters/{clusterArn}/storage": put: operationId: UpdateStorage description: Updates cluster broker volume size (or) sets cluster storage mode to TIERED. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateStorageResponse" examples: UpdateStorage200Example: summary: Default UpdateStorage 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example "480": description: BadRequestException content: application/json: schema: $ref: "#/components/schemas/BadRequestException" examples: UpdateStorage480Example: summary: Default UpdateStorage 480 response x-microcks-default: true value: {} "481": description: UnauthorizedException content: application/json: schema: $ref: "#/components/schemas/UnauthorizedException" examples: UpdateStorage481Example: summary: Default UpdateStorage 481 response x-microcks-default: true value: {} "482": description: InternalServerErrorException content: application/json: schema: $ref: "#/components/schemas/InternalServerErrorException" examples: UpdateStorage482Example: summary: Default UpdateStorage 482 response x-microcks-default: true value: {} "483": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateStorage483Example: summary: Default UpdateStorage 483 response x-microcks-default: true value: {} "484": description: NotFoundException content: application/json: schema: $ref: "#/components/schemas/NotFoundException" examples: UpdateStorage484Example: summary: Default UpdateStorage 484 response x-microcks-default: true value: {} "485": description: ServiceUnavailableException content: application/json: schema: $ref: "#/components/schemas/ServiceUnavailableException" examples: UpdateStorage485Example: summary: Default UpdateStorage 485 response x-microcks-default: true value: {} "486": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UpdateStorage486Example: summary: Default UpdateStorage 486 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: |2-

The Amazon Resource Name (ARN) of the cluster to be updated.

schema: type: string requestBody: required: true content: application/json: schema: type: object required: - currentVersion properties: currentVersion: description: |2-

The version of cluster to update from. A successful operation will then generate a new version.

type: string provisionedThroughput: description: |2-

Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.

type: object properties: Enabled: allOf: - $ref: "#/components/schemas/__boolean" - xml: name: enabled description: |2-

Provisioned throughput is enabled or not.

VolumeThroughput: allOf: - $ref: "#/components/schemas/__integer" - xml: name: volumeThroughput description: |2-

Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

storageMode: description: Controls storage mode for various supported storage tiers. type: string enum: - LOCAL - TIERED volumeSizeGB: description: |2-

size of the EBS volume to update.

type: integer summary: Amazon MSK Update Storage x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" components: parameters: 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-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential 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-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders 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 schemas: BatchAssociateScramSecretResponse: type: object properties: ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) of the cluster.

UnprocessedScramSecrets: allOf: - $ref: "#/components/schemas/__listOfUnprocessedScramSecret" - xml: name: unprocessedScramSecrets description: |2-

List of errors when associating secrets to cluster.

__string: type: string BadRequestException: {} UnauthorizedException: {} InternalServerErrorException: {} ForbiddenException: {} NotFoundException: {} ServiceUnavailableException: {} TooManyRequestsException: {} CreateClusterResponse: type: object properties: ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) of the cluster.

ClusterName: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterName description: |2-

The name of the MSK cluster.

State: allOf: - $ref: "#/components/schemas/ClusterState" - xml: name: state description: |2-

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

BrokerAZDistribution: type: string enum: - DEFAULT description: |2-

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.

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.

__listOf__string: type: array items: $ref: "#/components/schemas/__string" __stringMin5Max32: type: string minLength: 5 maxLength: 32 StorageInfo: type: object properties: EbsStorageInfo: allOf: - $ref: "#/components/schemas/EBSStorageInfo" - xml: name: ebsStorageInfo description: |2-

EBS volume information.

description: |2-

Contains information about storage volumes attached to MSK broker nodes.

ConnectivityInfo: type: object properties: PublicAccess: allOf: - $ref: "#/components/schemas/PublicAccess" - xml: name: publicAccess description: |2-

Public access control for brokers.

description: |2-

Information about the broker access configuration.

Sasl: type: object properties: Scram: allOf: - $ref: "#/components/schemas/Scram" - xml: name: scram description: |2-

Details for SASL/SCRAM client authentication.

Iam: allOf: - $ref: "#/components/schemas/Iam" - xml: name: iam description: |2-

Indicates whether IAM access control is enabled.

description: |2-

Details for client authentication using SASL.

Tls: type: object properties: CertificateAuthorityArnList: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: certificateAuthorityArnList description: |2-

List of ACM Certificate Authority ARNs.

Enabled: allOf: - $ref: "#/components/schemas/__boolean" - xml: name: enabled description: |2-

Specifies whether you want to turn on or turn off TLS authentication.

description: |2-

Details for client authentication using TLS.

Unauthenticated: type: object properties: Enabled: allOf: - $ref: "#/components/schemas/__boolean" - xml: name: enabled description: |2-

Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.

__long: type: integer EncryptionAtRest: type: object required: - DataVolumeKMSKeyId properties: DataVolumeKMSKeyId: allOf: - $ref: "#/components/schemas/__string" - xml: name: dataVolumeKMSKeyId description: |2-

The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

description: |2-

The data-volume encryption details.

EncryptionInTransit: type: object properties: ClientBroker: allOf: - $ref: "#/components/schemas/ClientBroker" - xml: name: clientBroker description: |2-

Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.

TLS means that client-broker communication is enabled with TLS only.

TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

PLAINTEXT means that client-broker communication is enabled in plaintext only.

The default value is TLS_PLAINTEXT.

InCluster: allOf: - $ref: "#/components/schemas/__boolean" - xml: name: inCluster description: |2-

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

The default value is true.

description: |2-

The settings for encrypting data in transit.

PrometheusInfo: type: object properties: JmxExporter: allOf: - $ref: "#/components/schemas/JmxExporterInfo" - xml: name: jmxExporter description: |2-

Indicates whether you want to turn on or turn off the JMX Exporter.

NodeExporter: allOf: - $ref: "#/components/schemas/NodeExporterInfo" - xml: name: nodeExporter description: |2-

Indicates whether you want to turn on or turn off the Node Exporter.

description: |2-

Prometheus settings.

BrokerLogs: type: object properties: CloudWatchLogs: allOf: - $ref: "#/components/schemas/CloudWatchLogs" - xml: name: cloudWatchLogs Firehose: allOf: - $ref: "#/components/schemas/Firehose" - xml: name: firehose S3: allOf: - $ref: "#/components/schemas/S3" - xml: name: s3 ConflictException: {} CreateClusterV2Response: type: object properties: ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) of the cluster.

ClusterName: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterName description: |2-

The name of the MSK cluster.

State: allOf: - $ref: "#/components/schemas/ClusterState" - xml: name: state description: |2-

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

ClusterType: allOf: - $ref: "#/components/schemas/ClusterType" - xml: name: clusterType description: |2-

The type of the cluster. The possible states are PROVISIONED or SERVERLESS.

BrokerNodeGroupInfo: type: object required: - ClientSubnets - InstanceType properties: BrokerAZDistribution: allOf: - $ref: "#/components/schemas/BrokerAZDistribution" - xml: name: brokerAZDistribution description: |2-

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.

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.

ClientSubnets: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: clientSubnets description: |2-

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.

InstanceType: allOf: - $ref: "#/components/schemas/__stringMin5Max32" - xml: name: instanceType description: |2-

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, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

SecurityGroups: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: securityGroups description: |2-

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.

StorageInfo: allOf: - $ref: "#/components/schemas/StorageInfo" - xml: name: storageInfo description: |2-

Contains information about storage volumes attached to MSK broker nodes.

ConnectivityInfo: allOf: - $ref: "#/components/schemas/ConnectivityInfo" - xml: name: connectivityInfo description: |2-

Information about the broker access configuration.

description: |2-

Describes the setup to be used for Apache Kafka broker nodes in the cluster.

ClientAuthentication: type: object properties: Sasl: allOf: - $ref: "#/components/schemas/Sasl" - xml: name: sasl description: |2-

Details for ClientAuthentication using SASL.

Tls: allOf: - $ref: "#/components/schemas/Tls" - xml: name: tls description: |2-

Details for ClientAuthentication using TLS.

Unauthenticated: allOf: - $ref: "#/components/schemas/Unauthenticated" - xml: name: unauthenticated description: |2-

Contains information about unauthenticated traffic to the cluster.

description: |2-

Includes all client authentication information.

ConfigurationInfo: type: object required: - Revision - Arn properties: Arn: allOf: - $ref: "#/components/schemas/__string" - xml: name: arn description: |2-

ARN of the configuration to use.

Revision: allOf: - $ref: "#/components/schemas/__long" - xml: name: revision description: |2-

The revision of the configuration to use.

description: |2-

Specifies the configuration to use for the brokers.

EncryptionInfo: type: object properties: EncryptionAtRest: allOf: - $ref: "#/components/schemas/EncryptionAtRest" - xml: name: encryptionAtRest description: |2-

The data-volume encryption details.

EncryptionInTransit: allOf: - $ref: "#/components/schemas/EncryptionInTransit" - xml: name: encryptionInTransit description: |2-

The details for encryption in transit.

description: |2-

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.

EnhancedMonitoring: type: string enum: - DEFAULT - PER_BROKER - PER_TOPIC_PER_BROKER - PER_TOPIC_PER_PARTITION description: |2-

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 Monitoring.

OpenMonitoringInfo: type: object required: - Prometheus properties: Prometheus: allOf: - $ref: "#/components/schemas/PrometheusInfo" - xml: name: prometheus description: |2-

Prometheus settings.

description: |2-

JMX and Node monitoring for the MSK cluster.

__stringMin1Max128: type: string minLength: 1 maxLength: 128 LoggingInfo: type: object required: - BrokerLogs properties: BrokerLogs: allOf: - $ref: "#/components/schemas/BrokerLogs" - xml: name: brokerLogs __integerMin1Max15: type: integer minimum: 1 maximum: 15 StorageMode: type: string enum: - LOCAL - TIERED description: Controls storage mode for various supported storage tiers. __listOfVpcConfig: type: array items: $ref: "#/components/schemas/VpcConfig" ServerlessClientAuthentication: type: object properties: Sasl: allOf: - $ref: "#/components/schemas/ServerlessSasl" - xml: name: sasl description: |2-

Details for ClientAuthentication using SASL.

description: |2-

Includes all client authentication information.

CreateConfigurationResponse: type: object properties: Arn: allOf: - $ref: "#/components/schemas/__string" - xml: name: arn description: |2-

The Amazon Resource Name (ARN) of the configuration.

CreationTime: allOf: - $ref: "#/components/schemas/__timestampIso8601" - xml: name: creationTime description: |2-

The time when the configuration was created.

LatestRevision: allOf: - $ref: "#/components/schemas/ConfigurationRevision" - xml: name: latestRevision description: |2-

Latest revision of the configuration.

Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: |2-

The name of the configuration.

State: allOf: - $ref: "#/components/schemas/ConfigurationState" - xml: name: state description: |2-

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

DeleteClusterResponse: type: object properties: ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) of the cluster.

State: allOf: - $ref: "#/components/schemas/ClusterState" - xml: name: state description: |2-

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

DeleteConfigurationResponse: type: object properties: Arn: allOf: - $ref: "#/components/schemas/__string" - xml: name: arn description: |2-

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.

State: allOf: - $ref: "#/components/schemas/ConfigurationState" - xml: name: state description: |2-

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

DescribeClusterResponse: type: object properties: ClusterInfo: allOf: - $ref: "#/components/schemas/ClusterInfo" - xml: name: clusterInfo description: |2-

The cluster information.

DescribeClusterV2Response: type: object properties: ClusterInfo: allOf: - $ref: "#/components/schemas/Cluster" - xml: name: clusterInfo description: |2-

The cluster information.

DescribeClusterOperationResponse: type: object properties: ClusterOperationInfo: allOf: - $ref: "#/components/schemas/ClusterOperationInfo" - xml: name: clusterOperationInfo description: |2-

Cluster operation information

DescribeConfigurationResponse: type: object properties: Arn: allOf: - $ref: "#/components/schemas/__string" - xml: name: arn description: |2-

The Amazon Resource Name (ARN) of the configuration.

CreationTime: allOf: - $ref: "#/components/schemas/__timestampIso8601" - xml: name: creationTime description: |2-

The time when the configuration was created.

Description: allOf: - $ref: "#/components/schemas/__string" - xml: name: description description: |2-

The description of the configuration.

KafkaVersions: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: kafkaVersions description: |2-

The versions of Apache Kafka with which you can use this MSK configuration.

LatestRevision: allOf: - $ref: "#/components/schemas/ConfigurationRevision" - xml: name: latestRevision description: |2-

Latest revision of the configuration.

Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: |2-

The name of the configuration.

State: allOf: - $ref: "#/components/schemas/ConfigurationState" - xml: name: state description: |2-

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

DescribeConfigurationRevisionResponse: type: object properties: Arn: allOf: - $ref: "#/components/schemas/__string" - xml: name: arn description: |2-

The Amazon Resource Name (ARN) of the configuration.

CreationTime: allOf: - $ref: "#/components/schemas/__timestampIso8601" - xml: name: creationTime description: |2-

The time when the configuration was created.

Description: allOf: - $ref: "#/components/schemas/__string" - xml: name: description description: |2-

The description of the configuration.

Revision: allOf: - $ref: "#/components/schemas/__long" - xml: name: revision description: |2-

The revision number.

ServerProperties: allOf: - $ref: "#/components/schemas/__blob" - xml: name: serverProperties description: |2-

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.

BatchDisassociateScramSecretResponse: type: object properties: ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) of the cluster.

UnprocessedScramSecrets: allOf: - $ref: "#/components/schemas/__listOfUnprocessedScramSecret" - xml: name: unprocessedScramSecrets description: |2-

List of errors when disassociating secrets to cluster.

GetBootstrapBrokersResponse: type: object properties: BootstrapBrokerString: allOf: - $ref: "#/components/schemas/__string" - xml: name: bootstrapBrokerString description: |2-

A string containing one or more hostname:port pairs.

BootstrapBrokerStringTls: allOf: - $ref: "#/components/schemas/__string" - xml: name: bootstrapBrokerStringTls description: |2-

A string containing one or more DNS names (or IP) and TLS port pairs.

BootstrapBrokerStringSaslScram: allOf: - $ref: "#/components/schemas/__string" - xml: name: bootstrapBrokerStringSaslScram description: |2-

A string containing one or more DNS names (or IP) and Sasl Scram port pairs.

BootstrapBrokerStringSaslIam: allOf: - $ref: "#/components/schemas/__string" - xml: name: bootstrapBrokerStringSaslIam description: |2-

A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.

BootstrapBrokerStringPublicTls: allOf: - $ref: "#/components/schemas/__string" - xml: name: bootstrapBrokerStringPublicTls description: |2-

A string containing one or more DNS names (or IP) and TLS port pairs.

BootstrapBrokerStringPublicSaslScram: allOf: - $ref: "#/components/schemas/__string" - xml: name: bootstrapBrokerStringPublicSaslScram description: |2-

A string containing one or more DNS names (or IP) and Sasl Scram port pairs.

BootstrapBrokerStringPublicSaslIam: allOf: - $ref: "#/components/schemas/__string" - xml: name: bootstrapBrokerStringPublicSaslIam description: |2-

A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.

GetCompatibleKafkaVersionsResponse: type: object properties: CompatibleKafkaVersions: allOf: - $ref: "#/components/schemas/__listOfCompatibleKafkaVersion" - xml: name: compatibleKafkaVersions description: |2-

A list of CompatibleKafkaVersion objects.

ListClusterOperationsResponse: type: object properties: ClusterOperationInfoList: allOf: - $ref: "#/components/schemas/__listOfClusterOperationInfo" - xml: name: clusterOperationInfoList description: |2-

An array of cluster operation information objects.

NextToken: allOf: - $ref: "#/components/schemas/__string" - xml: name: nextToken description: |2-

If the response of ListClusterOperations is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClusterOperations.

ListClustersResponse: type: object properties: ClusterInfoList: allOf: - $ref: "#/components/schemas/__listOfClusterInfo" - xml: name: clusterInfoList description: |2-

Information on each of the MSK clusters in the response.

NextToken: allOf: - $ref: "#/components/schemas/__string" - xml: name: nextToken description: |2-

The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.

ListClustersV2Response: type: object properties: ClusterInfoList: allOf: - $ref: "#/components/schemas/__listOfCluster" - xml: name: clusterInfoList description: |2-

Information on each of the MSK clusters in the response.

NextToken: allOf: - $ref: "#/components/schemas/__string" - xml: name: nextToken description: |2-

The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.

ListConfigurationRevisionsResponse: type: object properties: NextToken: allOf: - $ref: "#/components/schemas/__string" - xml: name: nextToken description: |2-

Paginated results marker.

Revisions: allOf: - $ref: "#/components/schemas/__listOfConfigurationRevision" - xml: name: revisions description: |2-

List of ConfigurationRevision objects.

ListConfigurationsResponse: type: object properties: Configurations: allOf: - $ref: "#/components/schemas/__listOfConfiguration" - xml: name: configurations description: |2-

An array of MSK configurations.

NextToken: allOf: - $ref: "#/components/schemas/__string" - xml: name: nextToken description: |2-

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.

ListKafkaVersionsResponse: type: object properties: KafkaVersions: allOf: - $ref: "#/components/schemas/__listOfKafkaVersion" - xml: name: kafkaVersions NextToken: allOf: - $ref: "#/components/schemas/__string" - xml: name: nextToken ListNodesResponse: type: object properties: NextToken: allOf: - $ref: "#/components/schemas/__string" - xml: name: nextToken description: |2-

The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken in the response. To get another batch of nodes, provide this token in your next request.

NodeInfoList: allOf: - $ref: "#/components/schemas/__listOfNodeInfo" - xml: name: nodeInfoList description: |2-

List containing a NodeInfo object.

ListScramSecretsResponse: type: object properties: NextToken: allOf: - $ref: "#/components/schemas/__string" - xml: name: nextToken description: |2-

Paginated results marker.

SecretArnList: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: secretArnList description: |2-

The list of scram secrets associated with the cluster.

ListTagsForResourceResponse: type: object properties: Tags: allOf: - $ref: "#/components/schemas/__mapOf__string" - xml: name: tags description: |2-

The key-value pair for the resource tag.

RebootBrokerResponse: type: object properties: ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterOperationArn description: |2-

The Amazon Resource Name (ARN) of the cluster operation.

UpdateBrokerCountResponse: type: object properties: ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterOperationArn description: |2-

The Amazon Resource Name (ARN) of the cluster operation.

UpdateBrokerTypeResponse: type: object properties: ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterOperationArn description: |2-

The Amazon Resource Name (ARN) of the cluster operation.

UpdateBrokerStorageResponse: type: object properties: ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterOperationArn description: |2-

The Amazon Resource Name (ARN) of the cluster operation.

BrokerEBSVolumeInfo: type: object required: - KafkaBrokerNodeId properties: KafkaBrokerNodeId: allOf: - $ref: "#/components/schemas/__string" - xml: name: kafkaBrokerNodeId description: |2-

The ID of the broker to update.

ProvisionedThroughput: allOf: - $ref: "#/components/schemas/ProvisionedThroughput" - xml: name: provisionedThroughput description: |2-

EBS volume provisioned throughput information.

VolumeSizeGB: allOf: - $ref: "#/components/schemas/__integer" - xml: name: volumeSizeGB description: |2-

Size of the EBS volume to update.

description: |2-

Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.

UpdateConfigurationResponse: type: object properties: Arn: allOf: - $ref: "#/components/schemas/__string" - xml: name: arn description: |2-

The Amazon Resource Name (ARN) of the configuration.

LatestRevision: allOf: - $ref: "#/components/schemas/ConfigurationRevision" - xml: name: latestRevision description: |2-

Latest revision of the configuration.

UpdateConnectivityResponse: type: object properties: ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterOperationArn description: |2-

The Amazon Resource Name (ARN) of the cluster operation.

PublicAccess: type: object properties: Type: allOf: - $ref: "#/components/schemas/__string" - xml: name: type description: |2-

The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.

description: Public access control for brokers. UpdateClusterConfigurationResponse: type: object properties: ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterOperationArn description: |2-

The Amazon Resource Name (ARN) of the cluster operation.

UpdateClusterKafkaVersionResponse: type: object properties: ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterOperationArn description: |2-

The Amazon Resource Name (ARN) of the cluster operation.

UpdateMonitoringResponse: type: object properties: ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterOperationArn description: |2-

The Amazon Resource Name (ARN) of the cluster operation.

UpdateSecurityResponse: type: object properties: ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterOperationArn description: |2-

The Amazon Resource Name (ARN) of the cluster operation.

UpdateStorageResponse: type: object properties: ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterOperationArn description: |2-

The Amazon Resource Name (ARN) of the cluster operation.

__boolean: type: boolean __integer: type: integer BatchAssociateScramSecretRequest: type: object required: - SecretArnList title: BatchAssociateScramSecretRequest properties: SecretArnList: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: secretArnList description: |2-

List of AWS Secrets Manager secret ARNs.

description: |2-

Associates sasl scram secrets to cluster.

__listOfUnprocessedScramSecret: type: array items: $ref: "#/components/schemas/UnprocessedScramSecret" ProvisionedThroughput: type: object properties: Enabled: allOf: - $ref: "#/components/schemas/__boolean" - xml: name: enabled description: |2-

Provisioned throughput is enabled or not.

VolumeThroughput: allOf: - $ref: "#/components/schemas/__integer" - xml: name: volumeThroughput description: |2-

Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

description: |2-

Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.

CloudWatchLogs: type: object required: - Enabled properties: Enabled: allOf: - $ref: "#/components/schemas/__boolean" - xml: name: enabled LogGroup: allOf: - $ref: "#/components/schemas/__string" - xml: name: logGroup Firehose: type: object required: - Enabled properties: DeliveryStream: allOf: - $ref: "#/components/schemas/__string" - xml: name: deliveryStream Enabled: allOf: - $ref: "#/components/schemas/__boolean" - xml: name: enabled S3: type: object required: - Enabled properties: Bucket: allOf: - $ref: "#/components/schemas/__string" - xml: name: bucket Enabled: allOf: - $ref: "#/components/schemas/__boolean" - xml: name: enabled Prefix: allOf: - $ref: "#/components/schemas/__string" - xml: name: prefix __double: type: number format: double BrokerSoftwareInfo: type: object properties: ConfigurationArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: configurationArn description: |2-

The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.

ConfigurationRevision: allOf: - $ref: "#/components/schemas/__long" - xml: name: configurationRevision description: |2-

The revision of the configuration to use. This field isn't visible in this preview release.

KafkaVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: kafkaVersion description: |2-

The version of Apache Kafka.

description: |2-

Information about the current software installed on the cluster.

BrokerNodeInfo: type: object properties: AttachedENIId: allOf: - $ref: "#/components/schemas/__string" - xml: name: attachedENIId description: |2-

The attached elastic network interface of the broker.

BrokerId: allOf: - $ref: "#/components/schemas/__double" - xml: name: brokerId description: |2-

The ID of the broker.

ClientSubnet: allOf: - $ref: "#/components/schemas/__string" - xml: name: clientSubnet description: |2-

The client subnet to which this broker node belongs.

ClientVpcIpAddress: allOf: - $ref: "#/components/schemas/__string" - xml: name: clientVpcIpAddress description: |2-

The virtual private cloud (VPC) of the client.

CurrentBrokerSoftwareInfo: allOf: - $ref: "#/components/schemas/BrokerSoftwareInfo" - xml: name: currentBrokerSoftwareInfo description: |2-

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

Endpoints: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: endpoints description: |2-

Endpoints for accessing the broker.

description: |2-

BrokerNodeInfo

ServerlessSasl: type: object properties: Iam: allOf: - $ref: "#/components/schemas/Iam" - xml: name: iam description: |2-

Indicates whether IAM access control is enabled.

description: |2-

Details for client authentication using SASL.

ClientBroker: type: string enum: - TLS - TLS_PLAINTEXT - PLAINTEXT description: |2-

Client-broker encryption in transit setting.

__timestampIso8601: type: string format: date-time OpenMonitoring: type: object required: - Prometheus properties: Prometheus: allOf: - $ref: "#/components/schemas/Prometheus" - xml: name: prometheus description: |2-

Prometheus settings.

description: |2-

JMX and Node monitoring for the MSK cluster.

ClusterState: type: string enum: - ACTIVE - CREATING - DELETING - FAILED - HEALING - MAINTENANCE - REBOOTING_BROKER - UPDATING description: |2-

The state of the Apache Kafka cluster.

StateInfo: type: object properties: Code: allOf: - $ref: "#/components/schemas/__string" - xml: name: code Message: allOf: - $ref: "#/components/schemas/__string" - xml: name: message __mapOf__string: type: object additionalProperties: $ref: "#/components/schemas/__string" ClusterInfo: type: object properties: ActiveOperationArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: activeOperationArn description: |2-

Arn of active cluster operation.

BrokerNodeGroupInfo: allOf: - $ref: "#/components/schemas/BrokerNodeGroupInfo" - xml: name: brokerNodeGroupInfo description: |2-

Information about the broker nodes.

ClientAuthentication: allOf: - $ref: "#/components/schemas/ClientAuthentication" - xml: name: clientAuthentication description: |2-

Includes all client authentication information.

ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

ClusterName: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterName description: |2-

The name of the cluster.

CreationTime: allOf: - $ref: "#/components/schemas/__timestampIso8601" - xml: name: creationTime description: |2-

The time when the cluster was created.

CurrentBrokerSoftwareInfo: allOf: - $ref: "#/components/schemas/BrokerSoftwareInfo" - xml: name: currentBrokerSoftwareInfo description: |2-

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

CurrentVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: currentVersion description: |2-

The current version of the MSK cluster.

EncryptionInfo: allOf: - $ref: "#/components/schemas/EncryptionInfo" - xml: name: encryptionInfo description: |2-

Includes all encryption-related information.

EnhancedMonitoring: allOf: - $ref: "#/components/schemas/EnhancedMonitoring" - xml: name: enhancedMonitoring description: |2-

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 Monitoring.

OpenMonitoring: allOf: - $ref: "#/components/schemas/OpenMonitoring" - xml: name: openMonitoring description: |2-

Settings for open monitoring using Prometheus.

LoggingInfo: allOf: - $ref: "#/components/schemas/LoggingInfo" - xml: name: loggingInfo NumberOfBrokerNodes: allOf: - $ref: "#/components/schemas/__integer" - xml: name: numberOfBrokerNodes description: |2-

The number of broker nodes in the cluster.

State: allOf: - $ref: "#/components/schemas/ClusterState" - xml: name: state description: |2-

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

StateInfo: allOf: - $ref: "#/components/schemas/StateInfo" - xml: name: stateInfo Tags: allOf: - $ref: "#/components/schemas/__mapOf__string" - xml: name: tags description: |2-

Tags attached to the cluster.

ZookeeperConnectString: allOf: - $ref: "#/components/schemas/__string" - xml: name: zookeeperConnectString description: |2-

The connection string to use to connect to the Apache ZooKeeper cluster.

ZookeeperConnectStringTls: allOf: - $ref: "#/components/schemas/__string" - xml: name: zookeeperConnectStringTls description: |2-

The connection string to use to connect to zookeeper cluster on Tls port.

StorageMode: allOf: - $ref: "#/components/schemas/StorageMode" - xml: name: storageMode description: |2-

This controls storage mode for supported storage tiers.

description: |2-

Returns information about a cluster.

ClusterType: type: string enum: - PROVISIONED - SERVERLESS description: |2-

The type of cluster.

Provisioned: type: object required: - BrokerNodeGroupInfo - NumberOfBrokerNodes properties: BrokerNodeGroupInfo: allOf: - $ref: "#/components/schemas/BrokerNodeGroupInfo" - xml: name: brokerNodeGroupInfo description: |2-

Information about the brokers.

CurrentBrokerSoftwareInfo: allOf: - $ref: "#/components/schemas/BrokerSoftwareInfo" - xml: name: currentBrokerSoftwareInfo description: |2-

Information about the Apache Kafka version deployed on the brokers.

ClientAuthentication: allOf: - $ref: "#/components/schemas/ClientAuthentication" - xml: name: clientAuthentication description: |2-

Includes all client authentication information.

EncryptionInfo: allOf: - $ref: "#/components/schemas/EncryptionInfo" - xml: name: encryptionInfo description: |2-

Includes all encryption-related information.

EnhancedMonitoring: allOf: - $ref: "#/components/schemas/EnhancedMonitoring" - xml: name: enhancedMonitoring description: |2-

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

OpenMonitoring: allOf: - $ref: "#/components/schemas/OpenMonitoringInfo" - xml: name: openMonitoring description: |2-

The settings for open monitoring.

LoggingInfo: allOf: - $ref: "#/components/schemas/LoggingInfo" - xml: name: loggingInfo description: |2-

Log delivery information for the cluster.

NumberOfBrokerNodes: allOf: - $ref: "#/components/schemas/__integerMin1Max15" - xml: name: numberOfBrokerNodes description: |2-

The number of broker nodes in the cluster.

ZookeeperConnectString: allOf: - $ref: "#/components/schemas/__string" - xml: name: zookeeperConnectString description: |2-

The connection string to use to connect to the Apache ZooKeeper cluster.

ZookeeperConnectStringTls: allOf: - $ref: "#/components/schemas/__string" - xml: name: zookeeperConnectStringTls description: |2-

The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.

StorageMode: allOf: - $ref: "#/components/schemas/StorageMode" - xml: name: storageMode description: |2-

This controls storage mode for supported storage tiers.

description: |2-

Provisioned cluster.

Serverless: type: object required: - VpcConfigs properties: VpcConfigs: allOf: - $ref: "#/components/schemas/__listOfVpcConfig" - xml: name: vpcConfigs description: |2-

The configuration of the Amazon VPCs for the cluster.

ClientAuthentication: allOf: - $ref: "#/components/schemas/ServerlessClientAuthentication" - xml: name: clientAuthentication description: |2-

Includes all client authentication information.

description: |2-

Serverless cluster.

Cluster: type: object properties: ActiveOperationArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: activeOperationArn description: |2-

The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.

ClusterType: allOf: - $ref: "#/components/schemas/ClusterType" - xml: name: clusterType description: |2-

Cluster Type.

ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

ClusterName: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterName description: |2-

The name of the cluster.

CreationTime: allOf: - $ref: "#/components/schemas/__timestampIso8601" - xml: name: creationTime description: |2-

The time when the cluster was created.

CurrentVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: currentVersion description: |2-

The current version of the MSK cluster.

State: allOf: - $ref: "#/components/schemas/ClusterState" - xml: name: state description: |2-

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

StateInfo: allOf: - $ref: "#/components/schemas/StateInfo" - xml: name: stateInfo description: |2-

State Info for the Amazon MSK cluster.

Tags: allOf: - $ref: "#/components/schemas/__mapOf__string" - xml: name: tags description: |2-

Tags attached to the cluster.

Provisioned: allOf: - $ref: "#/components/schemas/Provisioned" - xml: name: provisioned description: |2-

Information about the provisioned cluster.

Serverless: allOf: - $ref: "#/components/schemas/Serverless" - xml: name: serverless description: |2-

Information about the serverless cluster.

description: |2-

Returns information about a cluster.

ErrorInfo: type: object properties: ErrorCode: allOf: - $ref: "#/components/schemas/__string" - xml: name: errorCode description: |2-

A number describing the error programmatically.

ErrorString: allOf: - $ref: "#/components/schemas/__string" - xml: name: errorString description: |2-

An optional field to provide more details about the error.

description: |2-

Returns information about an error state of the cluster.

__listOfClusterOperationStep: type: array items: $ref: "#/components/schemas/ClusterOperationStep" MutableClusterInfo: type: object properties: BrokerEBSVolumeInfo: allOf: - $ref: "#/components/schemas/__listOfBrokerEBSVolumeInfo" - xml: name: brokerEBSVolumeInfo description: |2-

Specifies the size of the EBS volume and the ID of the associated broker.

ConfigurationInfo: allOf: - $ref: "#/components/schemas/ConfigurationInfo" - xml: name: configurationInfo description: |2-

Information about the changes in the configuration of the brokers.

NumberOfBrokerNodes: allOf: - $ref: "#/components/schemas/__integer" - xml: name: numberOfBrokerNodes description: |2-

The number of broker nodes in the cluster.

EnhancedMonitoring: allOf: - $ref: "#/components/schemas/EnhancedMonitoring" - xml: name: enhancedMonitoring description: |2-

Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

OpenMonitoring: allOf: - $ref: "#/components/schemas/OpenMonitoring" - xml: name: openMonitoring description: |2-

The settings for open monitoring.

KafkaVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: kafkaVersion description: |2-

The Apache Kafka version.

LoggingInfo: allOf: - $ref: "#/components/schemas/LoggingInfo" - xml: name: loggingInfo description: |2-

You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

InstanceType: allOf: - $ref: "#/components/schemas/__stringMin5Max32" - xml: name: instanceType description: |2-

Information about the Amazon MSK broker type.

ClientAuthentication: allOf: - $ref: "#/components/schemas/ClientAuthentication" - xml: name: clientAuthentication description: |2-

Includes all client authentication information.

EncryptionInfo: allOf: - $ref: "#/components/schemas/EncryptionInfo" - xml: name: encryptionInfo description: |2-

Includes all encryption-related information.

ConnectivityInfo: allOf: - $ref: "#/components/schemas/ConnectivityInfo" - xml: name: connectivityInfo description: |2-

Information about the broker access configuration.

StorageMode: allOf: - $ref: "#/components/schemas/StorageMode" - xml: name: storageMode description: |2-

This controls storage mode for supported storage tiers.

description: |2-

Information about cluster attributes that can be updated via update APIs.

ClusterOperationInfo: type: object properties: ClientRequestId: allOf: - $ref: "#/components/schemas/__string" - xml: name: clientRequestId description: |2-

The ID of the API request that triggered this operation.

ClusterArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: clusterArn description: |2-

ARN of the cluster.

CreationTime: allOf: - $ref: "#/components/schemas/__timestampIso8601" - xml: name: creationTime description: |2-

The time that the operation was created.

EndTime: allOf: - $ref: "#/components/schemas/__timestampIso8601" - xml: name: endTime description: |2-

The time at which the operation finished.

ErrorInfo: allOf: - $ref: "#/components/schemas/ErrorInfo" - xml: name: errorInfo description: |2-

Describes the error if the operation fails.

OperationArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: operationArn description: |2-

ARN of the cluster operation.

OperationState: allOf: - $ref: "#/components/schemas/__string" - xml: name: operationState description: |2-

State of the cluster operation.

OperationSteps: allOf: - $ref: "#/components/schemas/__listOfClusterOperationStep" - xml: name: operationSteps description: |2-

Steps completed during the operation.

OperationType: allOf: - $ref: "#/components/schemas/__string" - xml: name: operationType description: |2-

Type of the cluster operation.

SourceClusterInfo: allOf: - $ref: "#/components/schemas/MutableClusterInfo" - xml: name: sourceClusterInfo description: |2-

Information about cluster attributes before a cluster is updated.

TargetClusterInfo: allOf: - $ref: "#/components/schemas/MutableClusterInfo" - xml: name: targetClusterInfo description: |2-

Information about cluster attributes after a cluster is updated.

description: |2-

Returns information about a cluster operation.

ClusterOperationStepInfo: type: object properties: StepStatus: allOf: - $ref: "#/components/schemas/__string" - xml: name: stepStatus description: |2-

The steps current status.

description: |2-

State information about the operation step.

ClusterOperationStep: type: object properties: StepInfo: allOf: - $ref: "#/components/schemas/ClusterOperationStepInfo" - xml: name: stepInfo description: |2-

Information about the step and its status.

StepName: allOf: - $ref: "#/components/schemas/__string" - xml: name: stepName description: |2-

The name of the step.

description: |2-

Step taken during a cluster operation.

ProvisionedRequest: type: object required: - BrokerNodeGroupInfo - KafkaVersion - NumberOfBrokerNodes properties: BrokerNodeGroupInfo: allOf: - $ref: "#/components/schemas/BrokerNodeGroupInfo" - xml: name: brokerNodeGroupInfo description: |2-

Information about the brokers.

ClientAuthentication: allOf: - $ref: "#/components/schemas/ClientAuthentication" - xml: name: clientAuthentication description: |2-

Includes all client authentication information.

ConfigurationInfo: allOf: - $ref: "#/components/schemas/ConfigurationInfo" - xml: name: configurationInfo description: |2-

Represents the configuration that you want Amazon MSK to use for the brokers in a cluster.

EncryptionInfo: allOf: - $ref: "#/components/schemas/EncryptionInfo" - xml: name: encryptionInfo description: |2-

Includes all encryption-related information.

EnhancedMonitoring: allOf: - $ref: "#/components/schemas/EnhancedMonitoring" - xml: name: enhancedMonitoring description: |2-

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

OpenMonitoring: allOf: - $ref: "#/components/schemas/OpenMonitoringInfo" - xml: name: openMonitoring description: |2-

The settings for open monitoring.

KafkaVersion: allOf: - $ref: "#/components/schemas/__stringMin1Max128" - xml: name: kafkaVersion description: |2-

The Apache Kafka version that you want for the cluster.

LoggingInfo: allOf: - $ref: "#/components/schemas/LoggingInfo" - xml: name: loggingInfo description: |2-

Log delivery information for the cluster.

NumberOfBrokerNodes: allOf: - $ref: "#/components/schemas/__integerMin1Max15" - xml: name: numberOfBrokerNodes description: |2-

The number of broker nodes in the cluster.

StorageMode: allOf: - $ref: "#/components/schemas/StorageMode" - xml: name: storageMode description: |2-

This controls storage mode for supported storage tiers.

description: |2-

Provisioned cluster request.

VpcConfig: type: object required: - SubnetIds properties: SubnetIds: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: subnetIds description: |2-

The IDs of the subnets associated with the cluster.

SecurityGroupIds: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: securityGroupIds description: |2-

The IDs of the security groups associated with the cluster.

description: |2-

The configuration of the Amazon VPCs for the cluster.

ServerlessRequest: type: object required: - VpcConfigs properties: VpcConfigs: allOf: - $ref: "#/components/schemas/__listOfVpcConfig" - xml: name: vpcConfigs description: |2-

The configuration of the Amazon VPCs for the cluster.

ClientAuthentication: allOf: - $ref: "#/components/schemas/ServerlessClientAuthentication" - xml: name: clientAuthentication description: |2-

Includes all client authentication information.

description: |2-

Serverless cluster request.

CompatibleKafkaVersion: type: object properties: SourceVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: sourceVersion description: |2-

An Apache Kafka version.

TargetVersions: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: targetVersions description: |2-

A list of Apache Kafka versions.

description: |2-

Contains source Apache Kafka versions and compatible target Apache Kafka versions.

ConfigurationRevision: type: object required: - Revision - CreationTime properties: CreationTime: allOf: - $ref: "#/components/schemas/__timestampIso8601" - xml: name: creationTime description: |2-

The time when the configuration revision was created.

Description: allOf: - $ref: "#/components/schemas/__string" - xml: name: description description: |2-

The description of the configuration revision.

Revision: allOf: - $ref: "#/components/schemas/__long" - xml: name: revision description: |2-

The revision number.

description: |2-

Describes a configuration revision.

ConfigurationState: type: string enum: - ACTIVE - DELETING - DELETE_FAILED description: |2-

The state of a configuration.

Configuration: type: object required: - Description - LatestRevision - CreationTime - KafkaVersions - Arn - Name - State properties: Arn: allOf: - $ref: "#/components/schemas/__string" - xml: name: arn description: |2-

The Amazon Resource Name (ARN) of the configuration.

CreationTime: allOf: - $ref: "#/components/schemas/__timestampIso8601" - xml: name: creationTime description: |2-

The time when the configuration was created.

Description: allOf: - $ref: "#/components/schemas/__string" - xml: name: description description: |2-

The description of the configuration.

KafkaVersions: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: kafkaVersions description: |2-

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: allOf: - $ref: "#/components/schemas/ConfigurationRevision" - xml: name: latestRevision description: |2-

Latest revision of the configuration.

Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: |2-

The name of the configuration.

State: allOf: - $ref: "#/components/schemas/ConfigurationState" - xml: name: state description: |2-

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

description: |2-

Represents an MSK Configuration.

__stringMin1Max64: type: string minLength: 1 maxLength: 64 CreateClusterV2Request: type: object required: - ClusterName title: CreateClusterV2Request properties: ClusterName: allOf: - $ref: "#/components/schemas/__stringMin1Max64" - xml: name: clusterName description: |2-

The name of the cluster.

Tags: allOf: - $ref: "#/components/schemas/__mapOf__string" - xml: name: tags description: |2-

A map of tags that you want the cluster to have.

Provisioned: allOf: - $ref: "#/components/schemas/ProvisionedRequest" - xml: name: provisioned description: |2-

Information about the provisioned cluster.

Serverless: allOf: - $ref: "#/components/schemas/ServerlessRequest" - xml: name: serverless description: |2-

Information about the serverless cluster.

CreateClusterRequest: type: object required: - BrokerNodeGroupInfo - KafkaVersion - NumberOfBrokerNodes - ClusterName title: CreateClusterRequest properties: BrokerNodeGroupInfo: allOf: - $ref: "#/components/schemas/BrokerNodeGroupInfo" - xml: name: brokerNodeGroupInfo description: |2-

Information about the broker nodes in the cluster.

ClientAuthentication: allOf: - $ref: "#/components/schemas/ClientAuthentication" - xml: name: clientAuthentication description: |2-

Includes all client authentication related information.

ClusterName: allOf: - $ref: "#/components/schemas/__stringMin1Max64" - xml: name: clusterName description: |2-

The name of the cluster.

ConfigurationInfo: allOf: - $ref: "#/components/schemas/ConfigurationInfo" - xml: name: configurationInfo description: |2-

Represents the configuration that you want MSK to use for the brokers in a cluster.

EncryptionInfo: allOf: - $ref: "#/components/schemas/EncryptionInfo" - xml: name: encryptionInfo description: |2-

Includes all encryption-related information.

EnhancedMonitoring: allOf: - $ref: "#/components/schemas/EnhancedMonitoring" - xml: name: enhancedMonitoring description: |2-

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

OpenMonitoring: allOf: - $ref: "#/components/schemas/OpenMonitoringInfo" - xml: name: openMonitoring description: |2-

The settings for open monitoring.

KafkaVersion: allOf: - $ref: "#/components/schemas/__stringMin1Max128" - xml: name: kafkaVersion description: |2-

The version of Apache Kafka.

LoggingInfo: allOf: - $ref: "#/components/schemas/LoggingInfo" - xml: name: loggingInfo NumberOfBrokerNodes: allOf: - $ref: "#/components/schemas/__integerMin1Max15" - xml: name: numberOfBrokerNodes description: |2-

The number of broker nodes in the cluster.

Tags: allOf: - $ref: "#/components/schemas/__mapOf__string" - xml: name: tags description: |2-

Create tags when creating the cluster.

StorageMode: allOf: - $ref: "#/components/schemas/StorageMode" - xml: name: storageMode description: |2-

This controls storage mode for supported storage tiers.

__blob: type: string CreateConfigurationRequest: type: object required: - ServerProperties - Name title: CreateConfigurationRequest properties: Description: allOf: - $ref: "#/components/schemas/__string" - xml: name: description description: |2-

The description of the configuration.

KafkaVersions: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: kafkaVersions description: |2-

The versions of Apache Kafka with which you can use this MSK configuration.

Name: allOf: - $ref: "#/components/schemas/__string" - xml: name: name description: |2-

The name of the configuration.

ServerProperties: allOf: - $ref: "#/components/schemas/__blob" - xml: name: serverProperties description: |2-

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.

DeleteClusterRequest: type: object title: DeleteClusterRequest properties: {} DeleteConfigurationRequest: type: object title: DeleteConfigurationRequest properties: {} DescribeClusterOperationRequest: type: object title: DescribeClusterOperationRequest properties: {} DescribeClusterRequest: type: object title: DescribeClusterRequest properties: {} DescribeClusterV2Request: type: object title: DescribeClusterV2Request properties: {} DescribeConfigurationRequest: type: object title: DescribeConfigurationRequest properties: {} DescribeConfigurationRevisionRequest: type: object title: DescribeConfigurationRevisionRequest properties: {} BatchDisassociateScramSecretRequest: type: object required: - SecretArnList title: BatchDisassociateScramSecretRequest properties: SecretArnList: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: secretArnList description: |2-

List of AWS Secrets Manager secret ARNs.

description: |2-

Disassociates sasl scram secrets to cluster.

__integerMin1Max16384: type: integer minimum: 1 maximum: 16384 EBSStorageInfo: type: object properties: ProvisionedThroughput: allOf: - $ref: "#/components/schemas/ProvisionedThroughput" - xml: name: provisionedThroughput description: |2-

EBS volume provisioned throughput information.

VolumeSize: allOf: - $ref: "#/components/schemas/__integerMin1Max16384" - xml: name: volumeSize description: |2-

The size in GiB of the EBS volume for the data drive on each broker node.

description: |2-

Contains information about the EBS storage volumes attached to Apache Kafka broker nodes.

GetBootstrapBrokersRequest: type: object title: GetBootstrapBrokersRequest properties: {} GetCompatibleKafkaVersionsRequest: type: object title: GetCompatibleKafkaVersionsRequest properties: {} __listOfCompatibleKafkaVersion: type: array items: $ref: "#/components/schemas/CompatibleKafkaVersion" KafkaVersionStatus: type: string enum: - ACTIVE - DEPRECATED KafkaVersion: type: object properties: Version: allOf: - $ref: "#/components/schemas/__string" - xml: name: version Status: allOf: - $ref: "#/components/schemas/KafkaVersionStatus" - xml: name: status MaxResults: type: integer minimum: 1 maximum: 100 ListClusterOperationsRequest: type: object title: ListClusterOperationsRequest properties: {} __listOfClusterOperationInfo: type: array items: $ref: "#/components/schemas/ClusterOperationInfo" ListClustersRequest: type: object title: ListClustersRequest properties: {} ListClustersV2Request: type: object title: ListClustersV2Request properties: {} __listOfClusterInfo: type: array items: $ref: "#/components/schemas/ClusterInfo" __listOfCluster: type: array items: $ref: "#/components/schemas/Cluster" ListConfigurationRevisionsRequest: type: object title: ListConfigurationRevisionsRequest properties: {} __listOfConfigurationRevision: type: array items: $ref: "#/components/schemas/ConfigurationRevision" ListConfigurationsRequest: type: object title: ListConfigurationsRequest properties: {} __listOfConfiguration: type: array items: $ref: "#/components/schemas/Configuration" ListKafkaVersionsRequest: type: object title: ListKafkaVersionsRequest properties: {} __listOfKafkaVersion: type: array items: $ref: "#/components/schemas/KafkaVersion" ListNodesRequest: type: object title: ListNodesRequest properties: {} __listOfNodeInfo: type: array items: $ref: "#/components/schemas/NodeInfo" ListScramSecretsRequest: type: object title: ListScramSecretsRequest properties: {} ListTagsForResourceRequest: type: object title: ListTagsForResourceRequest properties: {} __listOfBrokerEBSVolumeInfo: type: array items: $ref: "#/components/schemas/BrokerEBSVolumeInfo" NodeExporter: type: object required: - EnabledInBroker properties: EnabledInBroker: allOf: - $ref: "#/components/schemas/__boolean" - xml: name: enabledInBroker description: |2-

Indicates whether you want to turn on or turn off the Node Exporter.

description: |2-

Indicates whether you want to turn on or turn off the Node Exporter.

NodeExporterInfo: type: object required: - EnabledInBroker properties: EnabledInBroker: allOf: - $ref: "#/components/schemas/__boolean" - xml: name: enabledInBroker description: |2-

Indicates whether you want to turn on or turn off the Node Exporter.

description: |2-

Indicates whether you want to turn on or turn off the Node Exporter.

JmxExporter: type: object required: - EnabledInBroker properties: EnabledInBroker: allOf: - $ref: "#/components/schemas/__boolean" - xml: name: enabledInBroker description: |2-

Indicates whether you want to turn on or turn off the JMX Exporter.

description: |2-

Indicates whether you want to turn on or turn off the JMX Exporter.

JmxExporterInfo: type: object required: - EnabledInBroker properties: EnabledInBroker: allOf: - $ref: "#/components/schemas/__boolean" - xml: name: enabledInBroker description: |2-

Indicates whether you want to turn on or turn off the JMX Exporter.

description: |2-

Indicates whether you want to turn on or turn off the JMX Exporter.

Prometheus: type: object properties: JmxExporter: allOf: - $ref: "#/components/schemas/JmxExporter" - xml: name: jmxExporter description: |2-

Indicates whether you want to turn on or turn off the JMX Exporter.

NodeExporter: allOf: - $ref: "#/components/schemas/NodeExporter" - xml: name: nodeExporter description: |2-

Indicates whether you want to turn on or turn off the Node Exporter.

description: |2-

Prometheus settings.

RebootBrokerRequest: type: object required: - BrokerIds title: RebootBrokerRequest properties: BrokerIds: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: brokerIds description: |2-

The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.

description: Reboots a node. Iam: type: object properties: Enabled: allOf: - $ref: "#/components/schemas/__boolean" - xml: name: enabled description: |2-

Indicates whether IAM access control is enabled.

description: |2-

Details for IAM access control.

Scram: type: object properties: Enabled: allOf: - $ref: "#/components/schemas/__boolean" - xml: name: enabled description: |2-

SASL/SCRAM authentication is enabled or not.

description: |2-

Details for SASL/SCRAM client authentication.

NodeType: type: string enum: - BROKER description: |2-

The broker or Zookeeper node.

ZookeeperNodeInfo: type: object properties: AttachedENIId: allOf: - $ref: "#/components/schemas/__string" - xml: name: attachedENIId description: |2-

The attached elastic network interface of the broker.

ClientVpcIpAddress: allOf: - $ref: "#/components/schemas/__string" - xml: name: clientVpcIpAddress description: |2-

The virtual private cloud (VPC) IP address of the client.

Endpoints: allOf: - $ref: "#/components/schemas/__listOf__string" - xml: name: endpoints description: |2-

Endpoints for accessing the ZooKeeper.

ZookeeperId: allOf: - $ref: "#/components/schemas/__double" - xml: name: zookeeperId description: |2-

The role-specific ID for Zookeeper.

ZookeeperVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: zookeeperVersion description: |2-

The version of Zookeeper.

description: |2-

Zookeeper node information.

NodeInfo: type: object properties: AddedToClusterTime: allOf: - $ref: "#/components/schemas/__string" - xml: name: addedToClusterTime description: |2-

The start time.

BrokerNodeInfo: allOf: - $ref: "#/components/schemas/BrokerNodeInfo" - xml: name: brokerNodeInfo description: |2-

The broker node info.

InstanceType: allOf: - $ref: "#/components/schemas/__string" - xml: name: instanceType description: |2-

The instance type.

NodeARN: allOf: - $ref: "#/components/schemas/__string" - xml: name: nodeARN description: |2-

The Amazon Resource Name (ARN) of the node.

NodeType: allOf: - $ref: "#/components/schemas/NodeType" - xml: name: nodeType description: |2-

The node type.

ZookeeperNodeInfo: allOf: - $ref: "#/components/schemas/ZookeeperNodeInfo" - xml: name: zookeeperNodeInfo description: |2-

The ZookeeperNodeInfo.

description: |2-

The node information object.

TagResourceRequest: type: object required: - Tags title: TagResourceRequest properties: Tags: allOf: - $ref: "#/components/schemas/__mapOf__string" - xml: name: tags description: |2-

The key-value pair for the resource tag.

UnprocessedScramSecret: type: object properties: ErrorCode: allOf: - $ref: "#/components/schemas/__string" - xml: name: errorCode description: |2-

Error code for associate/disassociate failure.

ErrorMessage: allOf: - $ref: "#/components/schemas/__string" - xml: name: errorMessage description: |2-

Error message for associate/disassociate failure.

SecretArn: allOf: - $ref: "#/components/schemas/__string" - xml: name: secretArn description: |2-

AWS Secrets Manager secret ARN.

description: |2-

Error info for scram secret associate/disassociate failure.

UntagResourceRequest: type: object title: UntagResourceRequest properties: {} UpdateBrokerCountRequest: type: object required: - CurrentVersion - TargetNumberOfBrokerNodes title: UpdateBrokerCountRequest properties: CurrentVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: currentVersion description: |2-

The version of cluster to update from. A successful operation will then generate a new version.

TargetNumberOfBrokerNodes: allOf: - $ref: "#/components/schemas/__integerMin1Max15" - xml: name: targetNumberOfBrokerNodes description: |2-

The number of broker nodes that you want the cluster to have after this operation completes successfully.

UpdateBrokerTypeRequest: type: object required: - CurrentVersion - TargetInstanceType title: UpdateBrokerTypeRequest properties: CurrentVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: currentVersion description: |2-

The cluster version that you want to change. After this operation completes successfully, the cluster will have a new version.

TargetInstanceType: allOf: - $ref: "#/components/schemas/__string" - xml: name: targetInstanceType description: |2-

The Amazon MSK broker type that you want all of the brokers in this cluster to be.

UpdateBrokerStorageRequest: type: object required: - TargetBrokerEBSVolumeInfo - CurrentVersion title: UpdateBrokerStorageRequest properties: CurrentVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: currentVersion description: |2-

The version of cluster to update from. A successful operation will then generate a new version.

TargetBrokerEBSVolumeInfo: allOf: - $ref: "#/components/schemas/__listOfBrokerEBSVolumeInfo" - xml: name: targetBrokerEBSVolumeInfo description: |2-

Describes the target volume size and the ID of the broker to apply the update to.

UpdateClusterConfigurationRequest: type: object required: - CurrentVersion - ConfigurationInfo title: UpdateClusterConfigurationRequest properties: ConfigurationInfo: allOf: - $ref: "#/components/schemas/ConfigurationInfo" - xml: name: configurationInfo description: |2-

Represents the configuration that you want MSK to use for the brokers in a cluster.

CurrentVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: currentVersion description: |2-

The version of the cluster that needs to be updated.

UpdateClusterKafkaVersionRequest: type: object required: - TargetKafkaVersion - CurrentVersion title: UpdateClusterKafkaVersionRequest properties: ConfigurationInfo: allOf: - $ref: "#/components/schemas/ConfigurationInfo" - xml: name: configurationInfo description: |2-

The custom configuration that should be applied on the new version of cluster.

CurrentVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: currentVersion description: |2-

Current cluster version.

TargetKafkaVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: targetKafkaVersion description: |2-

Target Kafka version.

UpdateMonitoringRequest: type: object required: - CurrentVersion title: UpdateMonitoringRequest properties: CurrentVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: currentVersion description: |2-

The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

EnhancedMonitoring: allOf: - $ref: "#/components/schemas/EnhancedMonitoring" - xml: name: enhancedMonitoring description: |2-

Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

OpenMonitoring: allOf: - $ref: "#/components/schemas/OpenMonitoringInfo" - xml: name: openMonitoring description: |2-

The settings for open monitoring.

LoggingInfo: allOf: - $ref: "#/components/schemas/LoggingInfo" - xml: name: loggingInfo description: Request body for UpdateMonitoring. UpdateSecurityRequest: type: object required: - CurrentVersion title: UpdateSecurityRequest properties: ClientAuthentication: allOf: - $ref: "#/components/schemas/ClientAuthentication" - xml: name: clientAuthentication description: |2-

Includes all client authentication related information.

CurrentVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: currentVersion description: |2-

The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

EncryptionInfo: allOf: - $ref: "#/components/schemas/EncryptionInfo" - xml: name: encryptionInfo description: |2-

Includes all encryption-related information.

UpdateStorageRequest: type: object required: - CurrentVersion title: UpdateStorageRequest properties: CurrentVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: currentVersion description: |2-

The version of cluster to update from. A successful operation will then generate a new version.

ProvisionedThroughput: allOf: - $ref: "#/components/schemas/ProvisionedThroughput" - xml: name: provisionedThroughput description: |2-

EBS volume provisioned throughput information.

StorageMode: allOf: - $ref: "#/components/schemas/StorageMode" - xml: name: storageMode description: |2-

Controls storage mode for supported storage tiers.

VolumeSizeGB: allOf: - $ref: "#/components/schemas/__integer" - xml: name: volumeSizeGB description: |2-

size of the EBS volume to update.

description: |2-

Request object for UpdateStorage api. Its used to update the storage attributes for the cluster.

UpdateConfigurationRequest: type: object required: - ServerProperties title: UpdateConfigurationRequest properties: Description: allOf: - $ref: "#/components/schemas/__string" - xml: name: description description: |2-

The description of the configuration revision.

ServerProperties: allOf: - $ref: "#/components/schemas/__blob" - xml: name: serverProperties description: |2-

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.

UpdateConnectivityRequest: type: object required: - ConnectivityInfo - CurrentVersion title: UpdateConnectivityRequest properties: ConnectivityInfo: allOf: - $ref: "#/components/schemas/ConnectivityInfo" - xml: name: connectivityInfo description: |2-

Information about the broker access configuration.

CurrentVersion: allOf: - $ref: "#/components/schemas/__string" - xml: name: currentVersion description: |2-

The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

description: Request body for UpdateConnectivity. security: - hmac: []