{ "metadata": { "apiVersion": "2018-11-14", "endpointPrefix": "kafka", "signingName": "kafka", "serviceFullName": "Managed Streaming for Kafka", "serviceAbbreviation": "Kafka", "serviceId": "Kafka", "protocol": "rest-json", "jsonVersion": "1.1", "uid": "kafka-2018-11-14", "signatureVersion": "v4" }, "operations": { "BatchAssociateScramSecret" : { "name" : "BatchAssociateScramSecret", "http" : { "method" : "POST", "requestUri" : "/v1/clusters/{clusterArn}/scram-secrets", "responseCode" : 200 }, "input" : { "shape" : "BatchAssociateScramSecretRequest" }, "output" : { "shape" : "BatchAssociateScramSecretResponse", "documentation": "\n

200 response

\n " }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape" : "UnauthorizedException", "documentation" : "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape" : "InternalServerErrorException", "documentation" : "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape" : "ForbiddenException", "documentation" : "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape" : "NotFoundException", "documentation" : "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape" : "ServiceUnavailableException", "documentation" : "\n

503 response

\n " }, { "shape" : "TooManyRequestsException", "documentation" : "\n

429 response

\n " } ], "documentation" : "\n

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

\n " }, "CreateCluster": { "name": "CreateCluster", "http": { "method": "POST", "requestUri": "/v1/clusters", "responseCode": 200 }, "input": { "shape": "CreateClusterRequest" }, "output": { "shape": "CreateClusterResponse" }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " }, { "shape": "TooManyRequestsException", "documentation": "\n

429 response

\n " }, { "shape": "ConflictException", "documentation": "\n

This cluster name already exists. Retry your request using another name.

\n " } ], "documentation": "\n

Creates a new MSK cluster.

\n " }, "CreateClusterV2": { "name": "CreateClusterV2", "http": { "method": "POST", "requestUri": "/api/v2/clusters", "responseCode": 200 }, "input": { "shape": "CreateClusterV2Request" }, "output": { "shape": "CreateClusterV2Response" }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " }, { "shape": "TooManyRequestsException", "documentation": "\n

429 response

\n " }, { "shape": "ConflictException", "documentation": "\n

This cluster name already exists. Retry your request using another name.

\n " } ], "documentation": "\n

Creates a new MSK cluster.

\n " }, "CreateConfiguration": { "name": "CreateConfiguration", "http": { "method": "POST", "requestUri": "/v1/configurations", "responseCode": 200 }, "input": { "shape": "CreateConfigurationRequest" }, "output": { "shape": "CreateConfigurationResponse", "documentation": "\n

200 response

\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " }, { "shape": "TooManyRequestsException", "documentation": "\n

429 response

\n " }, { "shape": "ConflictException", "documentation": "\n

This cluster name already exists. Retry your request using another name.

\n " } ], "documentation": "\n

Creates a new MSK configuration.

\n " }, "CreateReplicator": { "name": "CreateReplicator", "http": { "method": "POST", "requestUri": "/replication/v1/replicators", "responseCode": 200 }, "input": { "shape": "CreateReplicatorRequest" }, "output": { "shape": "CreateReplicatorResponse", "documentation": "

HTTP Status Code 200: OK.

" }, "errors": [ { "shape": "BadRequestException", "documentation": "

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

" }, { "shape": "UnauthorizedException", "documentation": "

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

" }, { "shape": "InternalServerErrorException", "documentation": "

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

" }, { "shape": "ForbiddenException", "documentation": "

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

" }, { "shape": "NotFoundException", "documentation": "

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

" }, { "shape": "ServiceUnavailableException", "documentation": "

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

" }, { "shape": "TooManyRequestsException", "documentation": "

HTTP Status Code 429: Limit exceeded. Resource limit reached.

" }, { "shape": "ConflictException", "documentation": "

HTTP Status Code 409: Conflict. This replicator name already exists. Retry your request with another name.

" } ], "documentation": "

Creates the replicator.

" }, "CreateVpcConnection": { "name": "CreateVpcConnection", "http": { "method": "POST", "requestUri": "/v1/vpc-connection", "responseCode": 200 }, "input": { "shape": "CreateVpcConnectionRequest" }, "output": { "shape": "CreateVpcConnectionResponse", "documentation": "\n

200 response

\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " }, { "shape": "TooManyRequestsException", "documentation": "\n

429 response

\n " } ], "documentation": "\n

Creates a new MSK VPC connection.

\n " }, "DeleteCluster": { "name": "DeleteCluster", "http": { "method": "DELETE", "requestUri": "/v1/clusters/{clusterArn}", "responseCode": 200 }, "input": { "shape": "DeleteClusterRequest" }, "output": { "shape": "DeleteClusterResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

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

\n " }, "DeleteClusterPolicy": { "name": "DeleteClusterPolicy", "http": { "method": "DELETE", "requestUri": "/v1/clusters/{clusterArn}/policy", "responseCode": 200 }, "input": { "shape": "DeleteClusterPolicyRequest" }, "output": { "shape": "DeleteClusterPolicyResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

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

\n " }, "DeleteConfiguration": { "name": "DeleteConfiguration", "http": { "method": "DELETE", "requestUri": "/v1/configurations/{arn}", "responseCode": 200 }, "input": { "shape": "DeleteConfigurationRequest" }, "output": { "shape": "DeleteConfigurationResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

Deletes an MSK Configuration.

\n " }, "DeleteReplicator": { "name": "DeleteReplicator", "http": { "method": "DELETE", "requestUri": "/replication/v1/replicators/{replicatorArn}", "responseCode": 200 }, "input": { "shape": "DeleteReplicatorRequest" }, "output": { "shape": "DeleteReplicatorResponse", "documentation": "HTTP Status Code 200: OK." }, "errors": [ { "shape": "BadRequestException", "documentation": "

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

" }, { "shape": "UnauthorizedException", "documentation": "

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

" }, { "shape": "InternalServerErrorException", "documentation": "

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

" }, { "shape": "ForbiddenException", "documentation": "

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

" }, { "shape": "NotFoundException", "documentation": "

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

" }, { "shape": "ServiceUnavailableException", "documentation": "

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

" }, { "shape": "TooManyRequestsException", "documentation": "

HTTP Status Code 429: Limit exceeded. Resource limit reached.

" } ], "documentation": "

Deletes a replicator.

" }, "DeleteVpcConnection": { "name": "DeleteVpcConnection", "http": { "method": "DELETE", "requestUri": "/v1/vpc-connection/{arn}", "responseCode": 200 }, "input": { "shape": "DeleteVpcConnectionRequest" }, "output": { "shape": "DeleteVpcConnectionResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

Deletes a MSK VPC connection.

\n " }, "DescribeCluster": { "name": "DescribeCluster", "http": { "method": "GET", "requestUri": "/v1/clusters/{clusterArn}", "responseCode": 200 }, "input": { "shape": "DescribeClusterRequest" }, "output": { "shape": "DescribeClusterResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

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

\n " }, "DescribeClusterV2": { "name": "DescribeClusterV2", "http": { "method": "GET", "requestUri": "/api/v2/clusters/{clusterArn}", "responseCode": 200 }, "input": { "shape": "DescribeClusterV2Request" }, "output": { "shape": "DescribeClusterV2Response", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

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

\n " }, "DescribeClusterOperation": { "name": "DescribeClusterOperation", "http": { "method": "GET", "requestUri": "/v1/operations/{clusterOperationArn}", "responseCode": 200 }, "input": { "shape": "DescribeClusterOperationRequest" }, "output": { "shape": "DescribeClusterOperationResponse", "documentation": "\n

200 response

\n " }, "errors": [ { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

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

\n " }, "DescribeClusterOperationV2" : { "name" : "DescribeClusterOperationV2", "http" : { "method" : "GET", "requestUri" : "/api/v2/operations/{clusterOperationArn}", "responseCode" : 200 }, "input" : { "shape" : "DescribeClusterOperationV2Request" }, "output" : { "shape" : "DescribeClusterOperationV2Response", "documentation" : "\n

HTTP Status Code 200: OK.

" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "\n

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

" }, { "shape" : "UnauthorizedException", "documentation" : "\n

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

" }, { "shape" : "InternalServerErrorException", "documentation" : "\n

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

" }, { "shape" : "ForbiddenException", "documentation" : "\n

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

" }, { "shape" : "NotFoundException", "documentation" : "\n

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

" }, { "shape" : "ServiceUnavailableException", "documentation" : "\n

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

" }, { "shape" : "TooManyRequestsException", "documentation" : "\n

HTTP Status Code 429: Limit exceeded. Resource limit reached.

" } ], "documentation" : "\n

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

\n" }, "DescribeConfiguration": { "name": "DescribeConfiguration", "http": { "method": "GET", "requestUri": "/v1/configurations/{arn}", "responseCode": 200 }, "input": { "shape": "DescribeConfigurationRequest" }, "output": { "shape": "DescribeConfigurationResponse", "documentation": "\n

200 response

\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " } ], "documentation": "\n

Returns a description of this MSK configuration.

\n " }, "DescribeConfigurationRevision": { "name": "DescribeConfigurationRevision", "http": { "method": "GET", "requestUri": "/v1/configurations/{arn}/revisions/{revision}", "responseCode": 200 }, "input": { "shape": "DescribeConfigurationRevisionRequest" }, "output": { "shape": "DescribeConfigurationRevisionResponse", "documentation": "\n

200 response

\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " } ], "documentation": "\n

Returns a description of this revision of the configuration.

\n " }, "DescribeReplicator": { "name": "DescribeReplicator", "http": { "method": "GET", "requestUri": "/replication/v1/replicators/{replicatorArn}", "responseCode": 200 }, "input": { "shape": "DescribeReplicatorRequest" }, "output": { "shape": "DescribeReplicatorResponse", "documentation": "

HTTP Status Code 200: OK." }, "errors": [ { "shape": "BadRequestException", "documentation": "

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

" }, { "shape": "UnauthorizedException", "documentation": "

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

" }, { "shape": "InternalServerErrorException", "documentation": "

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

" }, { "shape": "ForbiddenException", "documentation": "

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

" }, { "shape": "NotFoundException", "documentation": "

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

" }, { "shape": "ServiceUnavailableException", "documentation": "

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

" }, { "shape": "TooManyRequestsException", "documentation": "

HTTP Status Code 429: Limit exceeded. Resource limit reached.

" } ], "documentation": "

Describes a replicator.

" }, "DescribeVpcConnection": { "name": "DescribeVpcConnection", "http": { "method": "GET", "requestUri": "/v1/vpc-connection/{arn}", "responseCode": 200 }, "input": { "shape": "DescribeVpcConnectionRequest" }, "output": { "shape": "DescribeVpcConnectionResponse", "documentation": "\n

200 response

\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " } ], "documentation": "\n

Returns a description of this MSK VPC connection.

\n " }, "BatchDisassociateScramSecret" : { "name" : "BatchDisassociateScramSecret", "http" : { "method" : "PATCH", "requestUri" : "/v1/clusters/{clusterArn}/scram-secrets", "responseCode" : 200 }, "input" : { "shape" : "BatchDisassociateScramSecretRequest" }, "output" : { "shape" : "BatchDisassociateScramSecretResponse", "documentation": "\n

200 response

\n " }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape" : "UnauthorizedException", "documentation" : "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape" : "InternalServerErrorException", "documentation" : "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape" : "ForbiddenException", "documentation" : "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape" : "NotFoundException", "documentation" : "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape" : "ServiceUnavailableException", "documentation" : "\n

503 response

\n " }, { "shape" : "TooManyRequestsException", "documentation" : "\n

429 response

\n " } ], "documentation" : "\n

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

\n " }, "GetBootstrapBrokers": { "name": "GetBootstrapBrokers", "http": { "method": "GET", "requestUri": "/v1/clusters/{clusterArn}/bootstrap-brokers", "responseCode": 200 }, "input": { "shape": "GetBootstrapBrokersRequest" }, "output": { "shape": "GetBootstrapBrokersResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ConflictException", "documentation": "\n

This cluster name already exists. Retry your request using another name.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

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

\n " }, "GetCompatibleKafkaVersions" : { "name" : "GetCompatibleKafkaVersions", "http" : { "method" : "GET", "requestUri" : "/v1/compatible-kafka-versions", "responseCode" : 200 }, "input" : { "shape" : "GetCompatibleKafkaVersionsRequest" }, "output" : { "shape" : "GetCompatibleKafkaVersionsResponse", "documentation": "\n

Successful response.

\n " }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

n " }, { "shape" : "UnauthorizedException", "documentation" : "n

The request is not authorized. The provided credentials couldn't be validated.

n " }, { "shape" : "InternalServerErrorException", "documentation" : "n

There was an unexpected internal server error. Retrying your request might resolve the issue.

n " }, { "shape" : "ForbiddenException", "documentation" : "n

Access forbidden. Check your credentials and then retry your request.

n " }, { "shape" : "NotFoundException", "documentation" : "n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

n " }, { "shape" : "ServiceUnavailableException", "documentation" : "n

503 response

n " }, { "shape" : "TooManyRequestsException", "documentation" : "n

429 response

n " } ], "documentation": "\n

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

\n " }, "GetClusterPolicy": { "name": "GetClusterPolicy", "http": { "method": "GET", "requestUri": "/v1/clusters/{clusterArn}/policy", "responseCode": 200 }, "input": { "shape": "GetClusterPolicyRequest" }, "output": { "shape": "GetClusterPolicyResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

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

\n " }, "ListClusterOperations": { "name": "ListClusterOperations", "http": { "method": "GET", "requestUri": "/v1/clusters/{clusterArn}/operations", "responseCode": 200 }, "input": { "shape": "ListClusterOperationsRequest" }, "output": { "shape": "ListClusterOperationsResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

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

\n " }, "ListClusterOperationsV2" : { "name" : "ListClusterOperationsV2", "http" : { "method" : "GET", "requestUri" : "/api/v2/clusters/{clusterArn}/operations", "responseCode" : 200 }, "input" : { "shape" : "ListClusterOperationsV2Request" }, "output" : { "shape" : "ListClusterOperationsV2Response", "documentation" : "\n

HTTP Status Code 200: OK.

" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "\n

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

" }, { "shape" : "UnauthorizedException", "documentation" : "\n

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

" }, { "shape" : "InternalServerErrorException", "documentation" : "\n

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

" }, { "shape" : "ForbiddenException", "documentation" : "\n

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

" }, { "shape" : "NotFoundException", "documentation" : "\n

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

" }, { "shape" : "ServiceUnavailableException", "documentation" : "\n

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

" }, { "shape" : "TooManyRequestsException", "documentation" : "\n

HTTP Status Code 429: Limit exceeded. Resource limit reached.

" } ], "documentation" : "\n

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

\n " }, "ListClusters": { "name": "ListClusters", "http": { "method": "GET", "requestUri": "/v1/clusters", "responseCode": 200 }, "input": { "shape": "ListClustersRequest" }, "output": { "shape": "ListClustersResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

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

\n " }, "ListClustersV2": { "name": "ListClustersV2", "http": { "method": "GET", "requestUri": "/api/v2/clusters", "responseCode": 200 }, "input": { "shape": "ListClustersV2Request" }, "output": { "shape": "ListClustersV2Response", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

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

\n " }, "ListConfigurationRevisions": { "name": "ListConfigurationRevisions", "http": { "method": "GET", "requestUri": "/v1/configurations/{arn}/revisions", "responseCode": 200 }, "input": { "shape": "ListConfigurationRevisionsRequest" }, "output": { "shape": "ListConfigurationRevisionsResponse", "documentation": "\n

200 response

\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " } ], "documentation": "\n

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

\n " }, "ListConfigurations": { "name": "ListConfigurations", "http": { "method": "GET", "requestUri": "/v1/configurations", "responseCode": 200 }, "input": { "shape": "ListConfigurationsRequest" }, "output": { "shape": "ListConfigurationsResponse", "documentation": "\n

200 response

\n " }, "errors": [ { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

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

\n " }, "ListKafkaVersions": { "name": "ListKafkaVersions", "http": { "method": "GET", "requestUri": "/v1/kafka-versions", "responseCode": 200 }, "input": { "shape": "ListKafkaVersionsRequest" }, "output": { "shape": "ListKafkaVersionsResponse" }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

Returns a list of Apache Kafka versions.

\n " }, "ListNodes": { "name": "ListNodes", "http": { "method": "GET", "requestUri": "/v1/clusters/{clusterArn}/nodes", "responseCode": 200 }, "input": { "shape": "ListNodesRequest" }, "output": { "shape": "ListNodesResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

Returns a list of the broker nodes in the cluster.

\n " }, "ListReplicators": { "name": "ListReplicators", "http": { "method": "GET", "requestUri": "/replication/v1/replicators", "responseCode": 200 }, "input": { "shape": "ListReplicatorsRequest" }, "output": { "shape": "ListReplicatorsResponse", "documentation": "HTTP Status Code 200: OK." }, "errors": [ { "shape": "BadRequestException", "documentation": "

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

" }, { "shape": "UnauthorizedException", "documentation": "

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

" }, { "shape": "InternalServerErrorException", "documentation": "

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

" }, { "shape": "ForbiddenException", "documentation": "

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

" }, { "shape": "NotFoundException", "documentation": "

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

" }, { "shape": "ServiceUnavailableException", "documentation": "

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

" }, { "shape": "TooManyRequestsException", "documentation": "

HTTP Status Code 429: Limit exceeded. Resource limit reached.

" } ], "documentation": "

Lists the replicators.

" }, "ListScramSecrets" : { "name" : "ListScramSecrets", "http" : { "method" : "GET", "requestUri" : "/v1/clusters/{clusterArn}/scram-secrets", "responseCode" : 200 }, "input" : { "shape" : "ListScramSecretsRequest" }, "output" : { "shape" : "ListScramSecretsResponse", "documentation": "\n

200 response

\n " }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape" : "UnauthorizedException", "documentation" : "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape" : "InternalServerErrorException", "documentation" : "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape" : "ForbiddenException", "documentation" : "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape" : "NotFoundException", "documentation" : "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape" : "ServiceUnavailableException", "documentation" : "\n

503 response

\n " }, { "shape" : "TooManyRequestsException", "documentation" : "\n

429 response

\n " } ], "documentation" : "\n

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

\n " }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "GET", "requestUri": "/v1/tags/{resourceArn}", "responseCode": 200 }, "input": { "shape": "ListTagsForResourceRequest" }, "output": { "shape": "ListTagsForResourceResponse", "documentation": "\n

Success response.

\n " }, "errors": [ { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " } ], "documentation": "\n

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

\n " }, "ListClientVpcConnections": { "name": "ListClientVpcConnections", "http": { "method": "GET", "requestUri": "/v1/clusters/{clusterArn}/client-vpc-connections", "responseCode": 200 }, "input": { "shape": "ListClientVpcConnectionsRequest" }, "output": { "shape": "ListClientVpcConnectionsResponse", "documentation": "\n

200 response

\n " }, "errors": [ { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

Returns a list of all the VPC connections in this Region.

\n " }, "ListVpcConnections": { "name": "ListVpcConnections", "http": { "method": "GET", "requestUri": "/v1/vpc-connections", "responseCode": 200 }, "input": { "shape": "ListVpcConnectionsRequest" }, "output": { "shape": "ListVpcConnectionsResponse", "documentation": "\n

200 response

\n " }, "errors": [ { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

Returns a list of all the VPC connections in this Region.

\n " }, "RejectClientVpcConnection": { "name": "RejectClientVpcConnection", "http": { "method": "PUT", "requestUri": "/v1/clusters/{clusterArn}/client-vpc-connection", "responseCode": 200 }, "input": { "shape": "RejectClientVpcConnectionRequest" }, "output": { "shape": "RejectClientVpcConnectionResponse", "documentation": "\n

200 response

\n " }, "errors": [ { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

Returns empty response.

\n " }, "PutClusterPolicy": { "name": "PutClusterPolicy", "http": { "method": "PUT", "requestUri": "/v1/clusters/{clusterArn}/policy", "responseCode": 200 }, "input": { "shape": "PutClusterPolicyRequest" }, "output": { "shape": "PutClusterPolicyResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.

\n " }, "RebootBroker" : { "name" : "RebootBroker", "http" : { "method" : "PUT", "requestUri" : "/v1/clusters/{clusterArn}/reboot-broker", "responseCode" : 200 }, "input" : { "shape" : "RebootBrokerRequest" }, "output" : { "shape" : "RebootBrokerResponse", "documentation": "\n

Successful response.

\n " }, "errors" : [ { "shape" : "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape" : "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape" : "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape" : "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape" : "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape" : "ServiceUnavailableException", "documentation": "\n

503 response

\n " }, { "shape" : "TooManyRequestsException", "documentation" : "\n

429 response

\n " } ], "documentation" : "Reboots brokers." }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/v1/tags/{resourceArn}", "responseCode": 204 }, "input": { "shape": "TagResourceRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " } ], "documentation": "\n

Adds tags to the specified MSK resource.

\n " }, "UntagResource": { "name": "UntagResource", "http": { "method": "DELETE", "requestUri": "/v1/tags/{resourceArn}", "responseCode": 204 }, "input": { "shape": "UntagResourceRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " } ], "documentation": "\n

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

\n " }, "UpdateBrokerCount": { "name": "UpdateBrokerCount", "http": { "method": "PUT", "requestUri": "/v1/clusters/{clusterArn}/nodes/count", "responseCode": 200 }, "input": { "shape": "UpdateBrokerCountRequest" }, "output": { "shape": "UpdateBrokerCountResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

Updates the number of broker nodes in the cluster.

\n " }, "UpdateBrokerType": { "name": "UpdateBrokerType", "http": { "method": "PUT", "requestUri": "/v1/clusters/{clusterArn}/nodes/type", "responseCode": 200 }, "input": { "shape": "UpdateBrokerTypeRequest" }, "output": { "shape": "UpdateBrokerTypeResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape" : "BadRequestException", "documentation" : "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape" : "UnauthorizedException", "documentation" : "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape" : "InternalServerErrorException", "documentation" : "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape" : "ForbiddenException", "documentation" : "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape" : "NotFoundException", "documentation" : "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape" : "ServiceUnavailableException", "documentation" : "\n

503 response

\n " }, { "shape" : "TooManyRequestsException", "documentation" : "\n

429 response

\n " } ], "documentation": "\n

Updates EC2 instance type.

\n " }, "UpdateBrokerStorage": { "name": "UpdateBrokerStorage", "http": { "method": "PUT", "requestUri": "/v1/clusters/{clusterArn}/nodes/storage", "responseCode": 200 }, "input": { "shape": "UpdateBrokerStorageRequest" }, "output": { "shape": "UpdateBrokerStorageResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " }, { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation": "\n

Updates the EBS storage associated with MSK brokers.

\n " }, "UpdateConfiguration": { "name": "UpdateConfiguration", "http": { "method": "PUT", "requestUri": "/v1/configurations/{arn}", "responseCode": 200 }, "input": { "shape": "UpdateConfigurationRequest" }, "output": { "shape": "UpdateConfigurationResponse", "documentation": "\n

200 response

\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " } ], "documentation": "\n

Updates an MSK configuration.

\n " }, "UpdateConnectivity" : { "name" : "UpdateConnectivity", "http" : { "method" : "PUT", "requestUri" : "/v1/clusters/{clusterArn}/connectivity", "responseCode" : 200 }, "input" : { "shape" : "UpdateConnectivityRequest" }, "output" : { "shape" : "UpdateConnectivityResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " } ], "documentation" : "\n

Updates the cluster's connectivity configuration.

\n " }, "UpdateClusterConfiguration": { "name": "UpdateClusterConfiguration", "http": { "method": "PUT", "requestUri": "/v1/clusters/{clusterArn}/configuration", "responseCode": 200 }, "input": { "shape": "UpdateClusterConfigurationRequest" }, "output": { "shape": "UpdateClusterConfigurationResponse", "documentation": "\n

Successful response.

\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape": "UnauthorizedException", "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape": "InternalServerErrorException", "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape": "ForbiddenException", "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape": "NotFoundException", "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n

503 response

\n " } ], "documentation": "\n

Updates the cluster with the configuration that is specified in the request body.

\n " }, "UpdateClusterKafkaVersion" : { "name" : "UpdateClusterKafkaVersion", "http" : { "method" : "PUT", "requestUri" : "/v1/clusters/{clusterArn}/version", "responseCode" : 200 }, "input" : { "shape" : "UpdateClusterKafkaVersionRequest" }, "output" : { "shape" : "UpdateClusterKafkaVersionResponse", "documentation" : "\n

Successful response.

\n " }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape" : "UnauthorizedException", "documentation" : "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape" : "InternalServerErrorException", "documentation" : "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape" : "ForbiddenException", "documentation" : "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape" : "NotFoundException", "documentation" : "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape" : "ServiceUnavailableException", "documentation" : "\n

503 response

\n " }, { "shape" : "TooManyRequestsException", "documentation" : "\n

429 response

\n " } ], "documentation": "\n

Updates the Apache Kafka version for the cluster.

\n " }, "UpdateMonitoring" : { "name" : "UpdateMonitoring", "http" : { "method" : "PUT", "requestUri" : "/v1/clusters/{clusterArn}/monitoring", "responseCode" : 200 }, "input" : { "shape" : "UpdateMonitoringRequest" }, "output" : { "shape" : "UpdateMonitoringResponse", "documentation" : "\n

HTTP Status Code 200: OK.

\n " }, "errors" : [ { "shape" : "ServiceUnavailableException", "documentation" : "\n

503 response

\n " }, { "shape" : "BadRequestException", "documentation" : "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape" : "UnauthorizedException", "documentation" : "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape" : "InternalServerErrorException", "documentation" : "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape" : "ForbiddenException", "documentation" : "\n

Access forbidden. Check your credentials and then retry your request.

\n " } ], "documentation" : "\n

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.

\n " }, "UpdateReplicationInfo": { "name": "UpdateReplicationInfo", "http": { "method": "PUT", "requestUri": "/replication/v1/replicators/{replicatorArn}/replication-info", "responseCode": 200 }, "input": { "shape": "UpdateReplicationInfoRequest" }, "output": { "shape": "UpdateReplicationInfoResponse", "documentation": "HTTP Status Code 200: OK." }, "errors": [ { "shape": "BadRequestException", "documentation": "

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

" }, { "shape": "UnauthorizedException", "documentation": "

HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

" }, { "shape": "InternalServerErrorException", "documentation": "

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

" }, { "shape": "ForbiddenException", "documentation": "

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

" }, { "shape": "NotFoundException", "documentation": "

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

" }, { "shape": "ServiceUnavailableException", "documentation": "

HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

" }, { "shape": "TooManyRequestsException", "documentation": "

HTTP Status Code 429: Limit exceeded. Resource limit reached.

" } ], "documentation": "

Updates replication info of a replicator.

" }, "UpdateSecurity" : { "name" : "UpdateSecurity", "http" : { "method" : "PATCH", "requestUri" : "/v1/clusters/{clusterArn}/security", "responseCode" : 200 }, "input" : { "shape" : "UpdateSecurityRequest" }, "output" : { "shape" : "UpdateSecurityResponse" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " }, { "shape" : "UnauthorizedException", "documentation" : "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " }, { "shape" : "InternalServerErrorException", "documentation" : "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " }, { "shape" : "ForbiddenException", "documentation" : "\n

Access forbidden. Check your credentials and then retry your request.

\n " }, { "shape" : "NotFoundException", "documentation" : "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " }, { "shape" : "ServiceUnavailableException", "documentation" : "\n

The service cannot complete the request.

\n " }, { "shape" : "TooManyRequestsException", "documentation" : "\n

The request throughput limit was exceeded.

\n " } ], "documentation" : "\n

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

\n " }, "UpdateStorage" : { "name" : "UpdateStorage", "http" : { "method" : "PUT", "requestUri" : "/v1/clusters/{clusterArn}/storage", "responseCode" : 200 }, "input" : { "shape" : "UpdateStorageRequest" }, "output" : { "shape" : "UpdateStorageResponse", "documentation" : "HTTP Status Code 200: OK." }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." }, { "shape" : "UnauthorizedException", "documentation" : "HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated." }, { "shape" : "InternalServerErrorException", "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." }, { "shape" : "ForbiddenException", "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." }, { "shape" : "NotFoundException", "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." }, { "shape" : "ServiceUnavailableException", "documentation" : "HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue." }, { "shape" : "TooManyRequestsException", "documentation" : "HTTP Status Code 429: Limit exceeded. Resource limit reached." } ], "documentation" : "Updates cluster broker volume size (or) sets cluster storage mode to TIERED." } }, "shapes": { "AmazonMskCluster": { "type": "structure", "members": { "MskClusterArn": { "shape": "__string", "locationName": "mskClusterArn", "documentation": "

The Amazon Resource Name (ARN) of an Amazon MSK cluster.

" } }, "documentation": "

Details of an Amazon MSK Cluster.

", "required": ["MskClusterArn"] }, "BatchAssociateScramSecretRequest" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "location" : "uri", "locationName" : "clusterArn", "documentation" : "\n

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

\n " }, "SecretArnList" : { "shape" : "__listOf__string", "locationName" : "secretArnList", "documentation" : "\n

List of AWS Secrets Manager secret ARNs.

\n " } }, "documentation" : "\n

Associates sasl scram secrets to cluster.

\n ", "required" : [ "ClusterArn", "SecretArnList" ] }, "BatchAssociateScramSecretResponse" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "locationName" : "clusterArn", "documentation" : "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "UnprocessedScramSecrets" : { "shape" : "__listOfUnprocessedScramSecret", "locationName" : "unprocessedScramSecrets", "documentation" : "\n

List of errors when associating secrets to cluster.

\n " } } }, "BadRequestException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\n

The parameter that caused the error.

\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\n

The description of the error.

\n " } }, "documentation": "\n

Returns information about an error.

\n ", "exception": true, "error": { "httpStatusCode": 400 } }, "BrokerAZDistribution": { "type": "string", "documentation": "\n

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.

\n

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

\n ", "enum": [ "DEFAULT" ] }, "BrokerEBSVolumeInfo": { "type": "structure", "members": { "KafkaBrokerNodeId": { "shape": "__string", "locationName": "kafkaBrokerNodeId", "documentation": "\n

The ID of the broker to update.

\n " }, "ProvisionedThroughput" : { "shape" : "ProvisionedThroughput", "locationName" : "provisionedThroughput", "documentation" : "\n

EBS volume provisioned throughput information.

\n " }, "VolumeSizeGB": { "shape": "__integer", "locationName": "volumeSizeGB", "documentation": "\n

Size of the EBS volume to update.

\n " } }, "documentation": "\n

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.

\n ", "required": [ "KafkaBrokerNodeId" ] }, "BrokerLogs": { "type": "structure", "members": { "CloudWatchLogs": { "shape": "CloudWatchLogs", "locationName": "cloudWatchLogs" }, "Firehose": { "shape": "Firehose", "locationName": "firehose" }, "S3": { "shape": "S3", "locationName": "s3" } } }, "BrokerNodeGroupInfo": { "type": "structure", "members": { "BrokerAZDistribution": { "shape": "BrokerAZDistribution", "locationName": "brokerAZDistribution", "documentation": "\n

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.

\n

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

\n " }, "ClientSubnets": { "shape": "__listOf__string", "locationName": "clientSubnets", "documentation": "\n

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.

\n " }, "InstanceType": { "shape": "__stringMin5Max32", "locationName": "instanceType", "documentation": "\n

The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,\nkafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

\n " }, "SecurityGroups": { "shape": "__listOf__string", "locationName": "securityGroups", "documentation": "\n

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.

\n " }, "StorageInfo": { "shape": "StorageInfo", "locationName": "storageInfo", "documentation": "\n

Contains information about storage volumes attached to MSK broker nodes.

\n " }, "ConnectivityInfo" : { "shape" : "ConnectivityInfo", "locationName" : "connectivityInfo", "documentation" : "\n

Information about the broker access configuration.

\n " }, "ZoneIds": { "shape": "__listOf__string", "locationName": "zoneIds", "documentation": "\n

The list of zoneIds for the cluster in the virtual private cloud (VPC).

\n " } }, "documentation": "\n

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

\n ", "required": [ "ClientSubnets", "InstanceType" ] }, "BrokerNodeInfo": { "type": "structure", "members": { "AttachedENIId": { "shape": "__string", "locationName": "attachedENIId", "documentation": "\n

The attached elastic network interface of the broker.

\n " }, "BrokerId": { "shape": "__double", "locationName": "brokerId", "documentation": "\n

The ID of the broker.

\n " }, "ClientSubnet": { "shape": "__string", "locationName": "clientSubnet", "documentation": "\n

The client subnet to which this broker node belongs.

\n " }, "ClientVpcIpAddress": { "shape": "__string", "locationName": "clientVpcIpAddress", "documentation": "\n

The virtual private cloud (VPC) of the client.

\n " }, "CurrentBrokerSoftwareInfo": { "shape": "BrokerSoftwareInfo", "locationName": "currentBrokerSoftwareInfo", "documentation": "\n

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

\n " }, "Endpoints": { "shape": "__listOf__string", "locationName": "endpoints", "documentation": "\n

Endpoints for accessing the broker.

\n " } }, "documentation": "\n

BrokerNodeInfo

\n " }, "BrokerSoftwareInfo": { "type": "structure", "members": { "ConfigurationArn": { "shape": "__string", "locationName": "configurationArn", "documentation": "\n

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

\n " }, "ConfigurationRevision": { "shape": "__long", "locationName": "configurationRevision", "documentation": "\n

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

\n " }, "KafkaVersion": { "shape": "__string", "locationName": "kafkaVersion", "documentation": "\n

The version of Apache Kafka.

\n " } }, "documentation": "\n

Information about the current software installed on the cluster.

\n " }, "ClientAuthentication" : { "type" : "structure", "members" : { "Sasl" : { "shape" : "Sasl", "locationName" : "sasl", "documentation" : "\n

Details for ClientAuthentication using SASL.

\n " }, "Tls": { "shape": "Tls", "locationName": "tls", "documentation": "\n

Details for ClientAuthentication using TLS.

\n " }, "Unauthenticated" : { "shape" : "Unauthenticated", "locationName" : "unauthenticated", "documentation": "\n

Contains information about unauthenticated traffic to the cluster.

\n " } }, "documentation" : "\n

Includes all client authentication information.

\n " }, "VpcConnectivityClientAuthentication" : { "type" : "structure", "members" : { "Sasl" : { "shape" : "VpcConnectivitySasl", "locationName" : "sasl", "documentation" : "\n

SASL authentication type details for VPC connectivity.

\n " }, "Tls": { "shape": "VpcConnectivityTls", "locationName": "tls", "documentation": "\n

TLS authentication type details for VPC connectivity.

\n " } }, "documentation" : "\n

Includes all client authentication information for VPC connectivity.

\n " }, "ServerlessClientAuthentication" : { "type" : "structure", "members" : { "Sasl" : { "shape" : "ServerlessSasl", "locationName" : "sasl", "documentation" : "\n

Details for ClientAuthentication using SASL.

\n " } }, "documentation" : "\n

Includes all client authentication information.

\n " }, "ClientBroker": { "type": "string", "documentation": "\n

Client-broker encryption in transit setting.

\n ", "enum": [ "TLS", "TLS_PLAINTEXT", "PLAINTEXT" ] }, "CloudWatchLogs" : { "type" : "structure", "members" : { "Enabled" : { "shape" : "__boolean", "locationName" : "enabled" }, "LogGroup" : { "shape" : "__string", "locationName" : "logGroup" } }, "required" : [ "Enabled" ] }, "ClusterInfo": { "type": "structure", "members": { "ActiveOperationArn": { "shape": "__string", "locationName": "activeOperationArn", "documentation": "\n

Arn of active cluster operation.

\n " }, "BrokerNodeGroupInfo": { "shape": "BrokerNodeGroupInfo", "locationName": "brokerNodeGroupInfo", "documentation": "\n

Information about the broker nodes.

\n " }, "ClientAuthentication": { "shape": "ClientAuthentication", "locationName": "clientAuthentication", "documentation": "\n

Includes all client authentication information.

\n " }, "ClusterArn": { "shape": "__string", "locationName": "clusterArn", "documentation": "\n

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

\n " }, "ClusterName": { "shape": "__string", "locationName": "clusterName", "documentation": "\n

The name of the cluster.

\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\n

The time when the cluster was created.

\n " }, "CurrentBrokerSoftwareInfo": { "shape": "BrokerSoftwareInfo", "locationName": "currentBrokerSoftwareInfo", "documentation": "\n

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

\n " }, "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation": "\n

The current version of the MSK cluster.

\n " }, "EncryptionInfo": { "shape": "EncryptionInfo", "locationName": "encryptionInfo", "documentation": "\n

Includes all encryption-related information.

\n " }, "EnhancedMonitoring": { "shape": "EnhancedMonitoring", "locationName": "enhancedMonitoring", "documentation": "\n

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.

\n " }, "OpenMonitoring" : { "shape" : "OpenMonitoring", "locationName" : "openMonitoring", "documentation" : "\n

Settings for open monitoring using Prometheus.

\n " }, "LoggingInfo": { "shape": "LoggingInfo", "locationName": "loggingInfo" }, "NumberOfBrokerNodes": { "shape": "__integer", "locationName": "numberOfBrokerNodes", "documentation": "\n

The number of broker nodes in the cluster.

\n " }, "State": { "shape": "ClusterState", "locationName": "state", "documentation": "\n

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

\n " }, "StateInfo" : { "shape" : "StateInfo", "locationName" : "stateInfo" }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "\n

Tags attached to the cluster.

\n " }, "ZookeeperConnectString": { "shape": "__string", "locationName": "zookeeperConnectString", "documentation": "\n

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

\n " }, "ZookeeperConnectStringTls" : { "shape" : "__string", "locationName" : "zookeeperConnectStringTls", "documentation" : "\n

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

\n " }, "StorageMode" : { "shape" : "StorageMode", "locationName" : "storageMode", "documentation" : "\n

This controls storage mode for supported storage tiers.

\n " }, "CustomerActionStatus": { "shape": "CustomerActionStatus", "locationName": "customerActionStatus", "documentation": "\n

Determines if there is an action required from the customer.

\n " } }, "documentation": "\n

Returns information about a cluster.

\n " }, "Cluster": { "type": "structure", "members": { "ActiveOperationArn": { "shape": "__string", "locationName": "activeOperationArn", "documentation": "\n

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

\n " }, "ClusterType": { "shape": "ClusterType", "locationName": "clusterType", "documentation": "\n

Cluster Type.

\n " }, "ClusterArn": { "shape": "__string", "locationName": "clusterArn", "documentation": "\n

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

\n " }, "ClusterName": { "shape": "__string", "locationName": "clusterName", "documentation": "\n

The name of the cluster.

\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\n

The time when the cluster was created.

\n " }, "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation": "\n

The current version of the MSK cluster.

\n " }, "State": { "shape": "ClusterState", "locationName": "state", "documentation": "\n

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

\n " }, "StateInfo" : { "shape" : "StateInfo", "locationName" : "stateInfo", "documentation": "\n

State Info for the Amazon MSK cluster.

\n " }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "\n

Tags attached to the cluster.

\n " }, "Provisioned": { "shape": "Provisioned", "locationName": "provisioned", "documentation": "\n

Information about the provisioned cluster.

\n " }, "Serverless": { "shape": "Serverless", "locationName": "serverless", "documentation": "\n

Information about the serverless cluster.

\n " } }, "documentation": "\n

Returns information about a cluster.

\n " }, "ClusterOperationInfo": { "type": "structure", "members": { "ClientRequestId": { "shape": "__string", "locationName": "clientRequestId", "documentation": "\n

The ID of the API request that triggered this operation.

\n " }, "ClusterArn": { "shape": "__string", "locationName": "clusterArn", "documentation": "\n

ARN of the cluster.

\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\n

The time that the operation was created.

\n " }, "EndTime": { "shape": "__timestampIso8601", "locationName": "endTime", "documentation": "\n

The time at which the operation finished.

\n " }, "ErrorInfo": { "shape": "ErrorInfo", "locationName": "errorInfo", "documentation": "\n

Describes the error if the operation fails.

\n " }, "OperationArn": { "shape": "__string", "locationName": "operationArn", "documentation": "\n

ARN of the cluster operation.

\n " }, "OperationState": { "shape": "__string", "locationName": "operationState", "documentation": "\n

State of the cluster operation.

\n " }, "OperationSteps" : { "shape" : "__listOfClusterOperationStep", "locationName" : "operationSteps", "documentation" : "\n

Steps completed during the operation.

\n " }, "OperationType": { "shape": "__string", "locationName": "operationType", "documentation": "\n

Type of the cluster operation.

\n " }, "SourceClusterInfo": { "shape": "MutableClusterInfo", "locationName": "sourceClusterInfo", "documentation": "\n

Information about cluster attributes before a cluster is updated.

\n " }, "TargetClusterInfo": { "shape": "MutableClusterInfo", "locationName": "targetClusterInfo", "documentation": "\n

Information about cluster attributes after a cluster is updated.

\n " }, "VpcConnectionInfo": { "shape": "VpcConnectionInfo", "locationName": "vpcConnectionInfo", "documentation": "\n

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

\n " } }, "documentation": "\n

Returns information about a cluster operation.

\n " }, "ClusterOperationStep" : { "type" : "structure", "members" : { "StepInfo" : { "shape" : "ClusterOperationStepInfo", "locationName" : "stepInfo", "documentation" : "\n

Information about the step and its status.

\n " }, "StepName" : { "shape" : "__string", "locationName" : "stepName", "documentation" : "\n

The name of the step.

\n " } }, "documentation" : "\n

Step taken during a cluster operation.

\n " }, "ClusterOperationStepInfo" : { "type" : "structure", "members" : { "StepStatus" : { "shape" : "__string", "locationName" : "stepStatus", "documentation" : "\n

The steps current status.

\n " } }, "documentation" : "\n

State information about the operation step.

\n " }, "ClusterState": { "type": "string", "documentation": "\n

The state of the Apache Kafka cluster.

\n ", "enum": [ "ACTIVE", "CREATING", "DELETING", "FAILED", "HEALING", "MAINTENANCE", "REBOOTING_BROKER", "UPDATING" ] }, "ClusterType": { "type": "string", "documentation": "\n

The type of cluster.

\n ", "enum": [ "PROVISIONED", "SERVERLESS" ] }, "ProvisionedRequest": { "type" : "structure", "documentation": "\n

Provisioned cluster request.

\n ", "members" : { "BrokerNodeGroupInfo": { "shape": "BrokerNodeGroupInfo", "locationName": "brokerNodeGroupInfo", "documentation": "\n

Information about the brokers.

\n " }, "ClientAuthentication": { "shape": "ClientAuthentication", "locationName": "clientAuthentication", "documentation": "\n

Includes all client authentication information.

\n " }, "ConfigurationInfo": { "shape": "ConfigurationInfo", "locationName": "configurationInfo", "documentation": "\n

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

\n " }, "EncryptionInfo": { "shape": "EncryptionInfo", "locationName": "encryptionInfo", "documentation": "\n

Includes all encryption-related information.

\n " }, "EnhancedMonitoring": { "shape": "EnhancedMonitoring", "locationName": "enhancedMonitoring", "documentation": "\n

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.

\n " }, "OpenMonitoring" : { "shape" : "OpenMonitoringInfo", "locationName" : "openMonitoring", "documentation" : "\n

The settings for open monitoring.

\n " }, "KafkaVersion": { "shape": "__stringMin1Max128", "locationName": "kafkaVersion", "documentation": "\n

The Apache Kafka version that you want for the cluster.

\n " }, "LoggingInfo": { "shape": "LoggingInfo", "locationName": "loggingInfo", "documentation": "\n

Log delivery information for the cluster.

\n " }, "NumberOfBrokerNodes": { "shape": "__integerMin1Max15", "locationName": "numberOfBrokerNodes", "documentation": "\n

The number of broker nodes in the cluster.

\n " }, "StorageMode" : { "shape" : "StorageMode", "locationName" : "storageMode", "documentation" : "\n

This controls storage mode for supported storage tiers.

\n " } }, "required": [ "BrokerNodeGroupInfo", "KafkaVersion", "NumberOfBrokerNodes" ] }, "Provisioned": { "type" : "structure", "documentation": "\n

Provisioned cluster.

\n ", "members" : { "BrokerNodeGroupInfo": { "shape": "BrokerNodeGroupInfo", "locationName": "brokerNodeGroupInfo", "documentation": "\n

Information about the brokers.

\n " }, "CurrentBrokerSoftwareInfo": { "shape": "BrokerSoftwareInfo", "locationName": "currentBrokerSoftwareInfo", "documentation": "\n

Information about the Apache Kafka version deployed on the brokers.

\n " }, "ClientAuthentication": { "shape": "ClientAuthentication", "locationName": "clientAuthentication", "documentation": "\n

Includes all client authentication information.

\n " }, "EncryptionInfo": { "shape": "EncryptionInfo", "locationName": "encryptionInfo", "documentation": "\n

Includes all encryption-related information.

\n " }, "EnhancedMonitoring": { "shape": "EnhancedMonitoring", "locationName": "enhancedMonitoring", "documentation": "\n

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.

\n " }, "OpenMonitoring" : { "shape" : "OpenMonitoringInfo", "locationName" : "openMonitoring", "documentation" : "\n

The settings for open monitoring.

\n " }, "LoggingInfo": { "shape": "LoggingInfo", "locationName": "loggingInfo", "documentation": "\n

Log delivery information for the cluster.

\n " }, "NumberOfBrokerNodes": { "shape": "__integerMin1Max15", "locationName": "numberOfBrokerNodes", "documentation": "\n

The number of broker nodes in the cluster.

\n " }, "ZookeeperConnectString": { "shape": "__string", "locationName": "zookeeperConnectString", "documentation": "\n

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

\n " }, "ZookeeperConnectStringTls" : { "shape" : "__string", "locationName" : "zookeeperConnectStringTls", "documentation" : "\n

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

\n " }, "StorageMode" : { "shape" : "StorageMode", "locationName" : "storageMode", "documentation" : "\n

This controls storage mode for supported storage tiers.

\n " }, "CustomerActionStatus": { "shape": "CustomerActionStatus", "locationName": "customerActionStatus", "documentation": "\n

Determines if there is an action required from the customer.

\n " } }, "required": [ "BrokerNodeGroupInfo", "NumberOfBrokerNodes" ] }, "VpcConfig": { "type" : "structure", "documentation": "\n

The configuration of the Amazon VPCs for the cluster.

\n ", "members": { "SubnetIds": { "shape": "__listOf__string", "locationName": "subnetIds", "documentation" : "\n

The IDs of the subnets associated with the cluster.

\n " }, "SecurityGroupIds": { "shape": "__listOf__string", "locationName": "securityGroupIds", "documentation" : "\n

The IDs of the security groups associated with the cluster.

\n " } }, "required": [ "SubnetIds" ] }, "ServerlessRequest": { "type" : "structure", "documentation": "\n

Serverless cluster request.

\n ", "members" : { "VpcConfigs": { "shape": "__listOfVpcConfig", "locationName": "vpcConfigs", "documentation": "\n

The configuration of the Amazon VPCs for the cluster.

\n " }, "ClientAuthentication": { "shape": "ServerlessClientAuthentication", "locationName": "clientAuthentication", "documentation": "\n

Includes all client authentication information.

\n " } }, "required": [ "VpcConfigs" ] }, "Serverless": { "type" : "structure", "documentation": "\n

Serverless cluster.

\n ", "members" : { "VpcConfigs": { "shape": "__listOfVpcConfig", "locationName": "vpcConfigs", "documentation": "\n

The configuration of the Amazon VPCs for the cluster.

\n " }, "ClientAuthentication": { "shape": "ServerlessClientAuthentication", "locationName": "clientAuthentication", "documentation": "\n

Includes all client authentication information.

\n " } }, "required": [ "VpcConfigs" ] }, "ClientVpcConnection": { "type": "structure", "documentation": "\n

The client VPC connection object.

\n ", "members": { "Authentication": { "shape": "__string", "locationName": "authentication", "documentation": "\n

Information about the auth scheme of Vpc Connection.

\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\n

Creation time of the Vpc Connection.

\n " }, "State": { "shape": "VpcConnectionState", "locationName": "state", "documentation": "\n

State of the Vpc Connection.

\n " }, "VpcConnectionArn": { "shape": "__string", "locationName": "vpcConnectionArn", "documentation": "\n

The ARN that identifies the Vpc Connection.

\n " }, "Owner": { "shape": "__string", "locationName": "owner", "documentation": "\n

The Owner of the Vpc Connection.

\n " } }, "required": [ "VpcConnectionArn" ] }, "VpcConnection": { "type": "structure", "documentation": "\n

The VPC connection object.

\n ", "members": { "VpcConnectionArn": { "shape": "__string", "locationName": "vpcConnectionArn", "documentation": "\n

The ARN that identifies the Vpc Connection.

\n " }, "TargetClusterArn": { "shape": "__string", "locationName": "targetClusterArn", "documentation": "\n

The ARN that identifies the Cluster which the Vpc Connection belongs to.

\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\n

Creation time of the Vpc Connection.

\n " }, "Authentication": { "shape": "__string", "locationName": "authentication", "documentation": "\n

Information about the auth scheme of Vpc Connection.

\n " }, "VpcId": { "shape": "__string", "locationName": "vpcId", "documentation": "\n

The vpcId that belongs to the Vpc Connection.

\n " }, "State": { "shape": "VpcConnectionState", "locationName": "state", "documentation": "\n

State of the Vpc Connection.

\n " } }, "required": [ "VpcConnectionArn", "TargetClusterArn" ] }, "CompatibleKafkaVersion" : { "type" : "structure", "members" : { "SourceVersion" : { "shape" : "__string", "locationName" : "sourceVersion", "documentation": "\n

An Apache Kafka version.

\n " }, "TargetVersions" : { "shape" : "__listOf__string", "locationName" : "targetVersions", "documentation": "\n

A list of Apache Kafka versions.

\n " } }, "documentation": "\n

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

\n " }, "Configuration": { "type": "structure", "members": { "Arn": { "shape": "__string", "locationName": "arn", "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\n

The time when the configuration was created.

\n " }, "Description": { "shape": "__string", "locationName": "description", "documentation": "\n

The description of the configuration.

\n " }, "KafkaVersions": { "shape": "__listOf__string", "locationName": "kafkaVersions", "documentation": "\n

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.

\n " }, "LatestRevision": { "shape": "ConfigurationRevision", "locationName": "latestRevision", "documentation": "\n

Latest revision of the configuration.

\n " }, "Name": { "shape": "__string", "locationName": "name", "documentation": "\n

The name of the configuration.

\n " }, "State": { "shape": "ConfigurationState", "locationName": "state", "documentation": "\n

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

\n " } }, "documentation": "\n

Represents an MSK Configuration.

\n ", "required": [ "Description", "LatestRevision", "CreationTime", "KafkaVersions", "Arn", "Name", "State" ] }, "ConfigurationInfo": { "type": "structure", "members": { "Arn": { "shape": "__string", "locationName": "arn", "documentation": "\n

ARN of the configuration to use.

\n " }, "Revision": { "shape": "__long", "locationName": "revision", "documentation": "\n

The revision of the configuration to use.

\n " } }, "documentation": "\n

Specifies the configuration to use for the brokers.

\n ", "required": [ "Revision", "Arn" ] }, "ConfigurationRevision": { "type": "structure", "members": { "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\n

The time when the configuration revision was created.

\n " }, "Description": { "shape": "__string", "locationName": "description", "documentation": "\n

The description of the configuration revision.

\n " }, "Revision": { "shape": "__long", "locationName": "revision", "documentation": "\n

The revision number.

\n " } }, "documentation": "\n

Describes a configuration revision.

\n ", "required": [ "Revision", "CreationTime" ] }, "ConfigurationState": { "type": "string", "documentation": "\n

The state of a configuration.

\n ", "enum": [ "ACTIVE", "DELETING", "DELETE_FAILED" ] }, "ConflictException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\n

The parameter that caused the error.

\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\n

The description of the error.

\n " } }, "documentation": "\n

Returns information about an error.

\n ", "exception": true, "error": { "httpStatusCode": 409 } }, "ConnectivityInfo" : { "type": "structure", "members": { "PublicAccess": { "shape": "PublicAccess", "locationName": "publicAccess", "documentation": "\n

Public access control for brokers.

\n " }, "VpcConnectivity": { "shape": "VpcConnectivity", "locationName": "vpcConnectivity", "documentation": "\n

VPC connectivity access control for brokers.

\n " } }, "documentation": "\n

Information about the broker access configuration.

\n " }, "ConsumerGroupReplication": { "type": "structure", "members": { "ConsumerGroupsToExclude": { "shape": "__listOf__stringMax256", "locationName": "consumerGroupsToExclude", "documentation": "

List of regular expression patterns indicating the consumer groups that should not be replicated.

" }, "ConsumerGroupsToReplicate": { "shape": "__listOf__stringMax256", "locationName": "consumerGroupsToReplicate", "documentation": "

List of regular expression patterns indicating the consumer groups to copy.

" }, "DetectAndCopyNewConsumerGroups": { "shape": "__boolean", "locationName": "detectAndCopyNewConsumerGroups", "documentation": "

Enables synchronization of consumer groups to target cluster.

" }, "SynchroniseConsumerGroupOffsets": { "shape": "__boolean", "locationName": "synchroniseConsumerGroupOffsets", "documentation": "

Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

" } }, "documentation": "

Details about consumer group replication.

", "required": ["ConsumerGroupsToReplicate"] }, "ConsumerGroupReplicationUpdate": { "type": "structure", "members": { "ConsumerGroupsToExclude": { "shape": "__listOf__stringMax256", "locationName": "consumerGroupsToExclude", "documentation": "

List of regular expression patterns indicating the consumer groups that should not be replicated.

" }, "ConsumerGroupsToReplicate": { "shape": "__listOf__stringMax256", "locationName": "consumerGroupsToReplicate", "documentation": "

List of regular expression patterns indicating the consumer groups to copy.

" }, "DetectAndCopyNewConsumerGroups": { "shape": "__boolean", "locationName": "detectAndCopyNewConsumerGroups", "documentation": "

Enables synchronization of consumer groups to target cluster.

" }, "SynchroniseConsumerGroupOffsets": { "shape": "__boolean", "locationName": "synchroniseConsumerGroupOffsets", "documentation": "

Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

" } }, "documentation": "

Details about consumer group replication.

", "required": ["ConsumerGroupsToReplicate", "ConsumerGroupsToExclude", "SynchroniseConsumerGroupOffsets", "DetectAndCopyNewConsumerGroups"] }, "CreateClusterV2Request": { "type": "structure", "members": { "ClusterName": { "shape": "__stringMin1Max64", "locationName": "clusterName", "documentation": "\n

The name of the cluster.

\n " }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "\n

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

\n " }, "Provisioned": { "shape": "ProvisionedRequest", "locationName": "provisioned", "documentation": "\n

Information about the provisioned cluster.

\n " }, "Serverless": { "shape": "ServerlessRequest", "locationName": "serverless", "documentation": "\n

Information about the serverless cluster.

\n " } }, "required": [ "ClusterName" ] }, "CreateClusterRequest": { "type": "structure", "members": { "BrokerNodeGroupInfo": { "shape": "BrokerNodeGroupInfo", "locationName": "brokerNodeGroupInfo", "documentation": "\n

Information about the broker nodes in the cluster.

\n " }, "ClientAuthentication": { "shape": "ClientAuthentication", "locationName": "clientAuthentication", "documentation": "\n

Includes all client authentication related information.

\n " }, "ClusterName": { "shape": "__stringMin1Max64", "locationName": "clusterName", "documentation": "\n

The name of the cluster.

\n " }, "ConfigurationInfo": { "shape": "ConfigurationInfo", "locationName": "configurationInfo", "documentation": "\n

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

\n " }, "EncryptionInfo": { "shape": "EncryptionInfo", "locationName": "encryptionInfo", "documentation": "\n

Includes all encryption-related information.

\n " }, "EnhancedMonitoring": { "shape": "EnhancedMonitoring", "locationName": "enhancedMonitoring", "documentation": "\n

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.

\n " }, "OpenMonitoring" : { "shape" : "OpenMonitoringInfo", "locationName" : "openMonitoring", "documentation" : "\n

The settings for open monitoring.

\n " }, "KafkaVersion": { "shape": "__stringMin1Max128", "locationName": "kafkaVersion", "documentation": "\n

The version of Apache Kafka.

\n " }, "LoggingInfo": { "shape": "LoggingInfo", "locationName": "loggingInfo" }, "NumberOfBrokerNodes": { "shape": "__integerMin1Max15", "locationName": "numberOfBrokerNodes", "documentation": "\n

The number of broker nodes in the cluster.

\n " }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "\n

Create tags when creating the cluster.

\n " }, "StorageMode" : { "shape" : "StorageMode", "locationName" : "storageMode", "documentation" : "\n

This controls storage mode for supported storage tiers.

\n " } }, "required": [ "BrokerNodeGroupInfo", "KafkaVersion", "NumberOfBrokerNodes", "ClusterName" ] }, "CreateClusterResponse": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "locationName": "clusterArn", "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "ClusterName": { "shape": "__string", "locationName": "clusterName", "documentation": "\n

The name of the MSK cluster.

\n " }, "State": { "shape": "ClusterState", "locationName": "state", "documentation": "\n

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

\n " } } }, "CreateClusterV2Response": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "locationName": "clusterArn", "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "ClusterName": { "shape": "__string", "locationName": "clusterName", "documentation": "\n

The name of the MSK cluster.

\n " }, "State": { "shape": "ClusterState", "locationName": "state", "documentation": "\n

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

\n " }, "ClusterType": { "shape": "ClusterType", "locationName": "clusterType", "documentation": "\n

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

\n " } } }, "CreateConfigurationRequest": { "type": "structure", "members": { "Description": { "shape": "__string", "locationName": "description", "documentation": "\n

The description of the configuration.

\n " }, "KafkaVersions": { "shape": "__listOf__string", "locationName": "kafkaVersions", "documentation": "\n

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

\n " }, "Name": { "shape": "__string", "locationName": "name", "documentation": "\n

The name of the configuration.

\n " }, "ServerProperties": { "shape": "__blob", "locationName": "serverProperties", "documentation": "\n

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. \n When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

\n " } }, "required": [ "ServerProperties", "Name" ] }, "CreateConfigurationResponse": { "type": "structure", "members": { "Arn": { "shape": "__string", "locationName": "arn", "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\n

The time when the configuration was created.

\n " }, "LatestRevision": { "shape": "ConfigurationRevision", "locationName": "latestRevision", "documentation": "\n

Latest revision of the configuration.

\n " }, "Name": { "shape": "__string", "locationName": "name", "documentation": "\n

The name of the configuration.

\n " }, "State": { "shape": "ConfigurationState", "locationName": "state", "documentation": "\n

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

\n " } } }, "CreateReplicatorRequest": { "type": "structure", "members": { "Description": { "shape": "__stringMax1024", "locationName": "description", "documentation": "

A summary description of the replicator.

" }, "KafkaClusters": { "shape": "__listOfKafkaCluster", "locationName": "kafkaClusters", "documentation": "

Kafka Clusters to use in setting up sources / targets for replication.

" }, "ReplicationInfoList": { "shape": "__listOfReplicationInfo", "locationName": "replicationInfoList", "documentation": "

A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

" }, "ReplicatorName": { "shape": "__stringMin1Max128Pattern09AZaZ09AZaZ0", "locationName": "replicatorName", "documentation": "

The name of the replicator. Alpha-numeric characters with '-' are allowed.

" }, "ServiceExecutionRoleArn": { "shape": "__string", "locationName": "serviceExecutionRoleArn", "documentation": "

The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters)

" }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "

List of tags to attach to created Replicator.

" } }, "documentation": "

Creates a replicator using the specified configuration.

", "required": ["ServiceExecutionRoleArn", "ReplicatorName", "ReplicationInfoList", "KafkaClusters"] }, "CreateReplicatorResponse": { "type": "structure", "members": { "ReplicatorArn": { "shape": "__string", "locationName": "replicatorArn", "documentation": "

The Amazon Resource Name (ARN) of the replicator.

" }, "ReplicatorName": { "shape": "__string", "locationName": "replicatorName", "documentation": "

Name of the replicator provided by the customer.

" }, "ReplicatorState": { "shape": "ReplicatorState", "locationName": "replicatorState", "documentation": "

State of the replicator.

" } } }, "CreateVpcConnectionRequest": { "type": "structure", "members": { "TargetClusterArn": { "shape": "__string", "locationName": "targetClusterArn", "documentation": "\n

The cluster Amazon Resource Name (ARN) for the VPC connection.

\n " }, "Authentication": { "shape": "__string", "locationName": "authentication", "documentation": "\n

The authentication type of VPC connection.

\n " }, "VpcId": { "shape": "__string", "locationName": "vpcId", "documentation": "\n

The VPC ID of VPC connection.

\n " }, "ClientSubnets": { "shape": "__listOf__string", "locationName": "clientSubnets", "documentation": "\n

The list of client subnets.

\n " }, "SecurityGroups": { "shape": "__listOf__string", "locationName": "securityGroups", "documentation": "\n

The list of security groups.

\n " }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "\n

A map of tags for the VPC connection.

\n " } }, "required": [ "TargetClusterArn", "Authentication", "VpcId", "ClientSubnets", "SecurityGroups" ] }, "CreateVpcConnectionResponse": { "type": "structure", "members": { "VpcConnectionArn": { "shape": "__string", "locationName": "vpcConnectionArn", "documentation": "\n

The VPC connection ARN.

\n " }, "State": { "shape": "VpcConnectionState", "locationName": "state", "documentation": "\n

The State of Vpc Connection.

\n " }, "Authentication": { "shape": "__string", "locationName": "authentication", "documentation": "\n

The authentication type of VPC connection.

\n " }, "VpcId": { "shape": "__string", "locationName": "vpcId", "documentation": "\n

The VPC ID of the VPC connection.

\n " }, "ClientSubnets": { "shape": "__listOf__string", "locationName": "clientSubnets", "documentation": "\n

The list of client subnets.

\n " }, "SecurityGroups": { "shape": "__listOf__string", "locationName": "securityGroups", "documentation": "\n

The list of security groups.

\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\n

The creation time of VPC connection.

\n " }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "\n

A map of tags for the VPC connection.

\n " } } }, "ClusterOperationV2" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "locationName" : "clusterArn", "documentation" : "\n

ARN of the cluster.

" }, "ClusterType" : { "shape" : "ClusterType", "locationName" : "clusterType", "documentation" : "\n

Type of the backend cluster.

" }, "StartTime" : { "shape" : "__timestampIso8601", "locationName" : "startTime", "documentation" : "\n

The time at which operation was started.

" }, "EndTime" : { "shape" : "__timestampIso8601", "locationName" : "endTime", "documentation" : "\n

The time at which the operation finished.

" }, "ErrorInfo" : { "shape" : "ErrorInfo", "locationName" : "errorInfo", "documentation" : "\n

If cluster operation failed from an error, it describes the error.

" }, "OperationArn" : { "shape" : "__string", "locationName" : "operationArn", "documentation" : "\n

ARN of the cluster operation.

" }, "OperationState" : { "shape" : "__string", "locationName" : "operationState", "documentation" : "\n

State of the cluster operation.

" }, "OperationType" : { "shape" : "__string", "locationName" : "operationType", "documentation" : "\n

Type of the cluster operation.

" }, "Provisioned" : { "shape" : "ClusterOperationV2Provisioned", "locationName" : "provisioned", "documentation" : "\n

Properties of a provisioned cluster.

" }, "Serverless" : { "shape" : "ClusterOperationV2Serverless", "locationName" : "serverless", "documentation" : "\n

Properties of a serverless cluster.

" } }, "documentation" : "\n

Returns information about a cluster operation.

" }, "ClusterOperationV2Provisioned" : { "type" : "structure", "members" : { "OperationSteps" : { "shape" : "__listOfClusterOperationStep", "locationName" : "operationSteps", "documentation" : "\n

Steps completed during the operation.

" }, "SourceClusterInfo" : { "shape" : "MutableClusterInfo", "locationName" : "sourceClusterInfo", "documentation" : "\n

Information about cluster attributes before a cluster is updated.

" }, "TargetClusterInfo" : { "shape" : "MutableClusterInfo", "locationName" : "targetClusterInfo", "documentation" : "\n

Information about cluster attributes after a cluster is updated.

" }, "VpcConnectionInfo" : { "shape" : "VpcConnectionInfo", "locationName" : "vpcConnectionInfo", "documentation" : "\n

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

" } }, "documentation" : "\n

Returns information about a provisioned cluster operation.

" }, "ClusterOperationV2Serverless" : { "type" : "structure", "members" : { "VpcConnectionInfo" : { "shape" : "VpcConnectionInfoServerless", "locationName" : "vpcConnectionInfo", "documentation" : "\n

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

" } }, "documentation" : "\n

Returns information about a serverless cluster operation.

" }, "ClusterOperationV2Summary" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "locationName" : "clusterArn", "documentation" : "\n

ARN of the cluster.

" }, "ClusterType" : { "shape" : "ClusterType", "locationName" : "clusterType", "documentation" : "\n

Type of the backend cluster.

" }, "StartTime" : { "shape" : "__timestampIso8601", "locationName" : "startTime", "documentation" : "\n

The time at which operation was started.

" }, "EndTime" : { "shape" : "__timestampIso8601", "locationName" : "endTime", "documentation" : "\n

The time at which the operation finished.

" }, "OperationArn" : { "shape" : "__string", "locationName" : "operationArn", "documentation" : "\n

ARN of the cluster operation.

" }, "OperationState" : { "shape" : "__string", "locationName" : "operationState", "documentation" : "\n

State of the cluster operation.

" }, "OperationType" : { "shape" : "__string", "locationName" : "operationType", "documentation" : "\n

Type of the cluster operation.

" } }, "documentation" : "\n

Returns information about a cluster operation.

" }, "CustomerActionStatus": { "type": "string", "documentation": "\n

A type of an action required from the customer.

", "enum": [ "CRITICAL_ACTION_REQUIRED", "ACTION_RECOMMENDED", "NONE" ] }, "DeleteClusterRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\n

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

\n " }, "CurrentVersion": { "shape": "__string", "location": "querystring", "locationName": "currentVersion", "documentation": "\n

The current version of the MSK cluster.

\n " } }, "required": [ "ClusterArn" ] }, "DeleteClusterResponse": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "locationName": "clusterArn", "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "State": { "shape": "ClusterState", "locationName": "state", "documentation": "\n

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

\n " } } }, "DeleteClusterPolicyRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " } }, "required": [ "ClusterArn" ] }, "DeleteClusterPolicyResponse": { "type": "structure", "members": { } }, "DeleteConfigurationRequest": { "type": "structure", "members": { "Arn": { "shape": "__string", "location": "uri", "locationName": "arn", "documentation": "\n

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

\n " } }, "required": [ "Arn" ] }, "DeleteConfigurationResponse": { "type": "structure", "members": { "Arn": { "shape": "__string", "locationName": "arn", "documentation": "\n

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

\n " }, "State": { "shape": "ConfigurationState", "locationName": "state", "documentation": "\n

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

\n " } } }, "DeleteReplicatorRequest": { "type": "structure", "members": { "CurrentVersion": { "shape": "__string", "location": "querystring", "locationName": "currentVersion", "documentation": "

The current version of the replicator.

" }, "ReplicatorArn": { "shape": "__string", "location": "uri", "locationName": "replicatorArn", "documentation": "

The Amazon Resource Name (ARN) of the replicator to be deleted.

" } }, "required": ["ReplicatorArn"] }, "DeleteReplicatorResponse": { "type": "structure", "members": { "ReplicatorArn": { "shape": "__string", "locationName": "replicatorArn", "documentation": "

The Amazon Resource Name (ARN) of the replicator.

" }, "ReplicatorState": { "shape": "ReplicatorState", "locationName": "replicatorState", "documentation": "

The state of the replicator.

" } } }, "DeleteVpcConnectionRequest": { "type": "structure", "members": { "Arn": { "shape": "__string", "location": "uri", "locationName": "arn", "documentation": "\n

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

\n " } }, "required": [ "Arn" ] }, "DeleteVpcConnectionResponse": { "type": "structure", "members": { "VpcConnectionArn": { "shape": "__string", "locationName": "vpcConnectionArn", "documentation": "\n

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

\n " }, "State": { "shape": "VpcConnectionState", "locationName": "state", "documentation": "\n

The state of the VPC connection.

\n " } } }, "DescribeClusterOperationRequest": { "type": "structure", "members": { "ClusterOperationArn": { "shape": "__string", "location": "uri", "locationName": "clusterOperationArn", "documentation": "\n

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

\n " } }, "required": [ "ClusterOperationArn" ] }, "DescribeClusterOperationV2Request" : { "type" : "structure", "members" : { "ClusterOperationArn" : { "shape" : "__string", "location" : "uri", "locationName" : "clusterOperationArn", "documentation" : "ARN of the cluster operation to describe." } }, "required" : [ "ClusterOperationArn" ] }, "DescribeClusterOperationResponse": { "type": "structure", "members": { "ClusterOperationInfo": { "shape": "ClusterOperationInfo", "locationName": "clusterOperationInfo", "documentation": "\n

Cluster operation information

\n " } } }, "DescribeClusterOperationV2Response" : { "type" : "structure", "members" : { "ClusterOperationInfo" : { "shape" : "ClusterOperationV2", "locationName" : "clusterOperationInfo", "documentation" : "\n

Cluster operation information

" } } }, "DescribeClusterRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\n

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

\n " } }, "required": [ "ClusterArn" ] }, "DescribeClusterV2Request": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\n

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

\n " } }, "required": [ "ClusterArn" ] }, "DescribeClusterResponse": { "type": "structure", "members": { "ClusterInfo": { "shape": "ClusterInfo", "locationName": "clusterInfo", "documentation": "\n

The cluster information.

\n " } } }, "DescribeClusterV2Response": { "type": "structure", "members": { "ClusterInfo": { "shape": "Cluster", "locationName": "clusterInfo", "documentation": "\n

The cluster information.

\n " } } }, "DescribeConfigurationRequest": { "type": "structure", "members": { "Arn": { "shape": "__string", "location": "uri", "locationName": "arn", "documentation": "\n

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

\n " } }, "required": [ "Arn" ] }, "DescribeConfigurationResponse": { "type": "structure", "members": { "Arn": { "shape": "__string", "locationName": "arn", "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\n

The time when the configuration was created.

\n " }, "Description": { "shape": "__string", "locationName": "description", "documentation": "\n

The description of the configuration.

\n " }, "KafkaVersions": { "shape": "__listOf__string", "locationName": "kafkaVersions", "documentation": "\n

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

\n " }, "LatestRevision": { "shape": "ConfigurationRevision", "locationName": "latestRevision", "documentation": "\n

Latest revision of the configuration.

\n " }, "Name": { "shape": "__string", "locationName": "name", "documentation": "\n

The name of the configuration.

\n " }, "State": { "shape": "ConfigurationState", "locationName": "state", "documentation": "\n

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

\n " } } }, "DescribeConfigurationRevisionRequest": { "type": "structure", "members": { "Arn": { "shape": "__string", "location": "uri", "locationName": "arn", "documentation": "\n

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

\n " }, "Revision": { "shape": "__long", "location": "uri", "locationName": "revision", "documentation": "\n

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

\n " } }, "required": [ "Revision", "Arn" ] }, "DescribeConfigurationRevisionResponse": { "type": "structure", "members": { "Arn": { "shape": "__string", "locationName": "arn", "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\n

The time when the configuration was created.

\n " }, "Description": { "shape": "__string", "locationName": "description", "documentation": "\n

The description of the configuration.

\n " }, "Revision": { "shape": "__long", "locationName": "revision", "documentation": "\n

The revision number.

\n " }, "ServerProperties": { "shape": "__blob", "locationName": "serverProperties", "documentation": "\n

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. \n When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

\n " } } }, "DescribeVpcConnectionRequest": { "type": "structure", "members": { "Arn": { "shape": "__string", "location": "uri", "locationName": "arn", "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.

\n " } }, "required": [ "Arn" ] }, "DescribeReplicatorRequest": { "type": "structure", "members": { "ReplicatorArn": { "shape": "__string", "location": "uri", "locationName": "replicatorArn", "documentation": "

The Amazon Resource Name (ARN) of the replicator to be described.

" } }, "required": ["ReplicatorArn"] }, "DescribeReplicatorResponse": { "type": "structure", "members": { "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "

The time when the replicator was created.

" }, "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation": "

The current version number of the replicator.

" }, "IsReplicatorReference": { "shape": "__boolean", "locationName": "isReplicatorReference", "documentation": "

Whether this resource is a replicator reference.

" }, "KafkaClusters": { "shape": "__listOfKafkaClusterDescription", "locationName": "kafkaClusters", "documentation": "

Kafka Clusters used in setting up sources / targets for replication.

" }, "ReplicationInfoList": { "shape": "__listOfReplicationInfoDescription", "locationName": "replicationInfoList", "documentation": "

A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

" }, "ReplicatorArn": { "shape": "__string", "locationName": "replicatorArn", "documentation": "

The Amazon Resource Name (ARN) of the replicator.

" }, "ReplicatorDescription": { "shape": "__string", "locationName": "replicatorDescription", "documentation": "

The description of the replicator.

" }, "ReplicatorName": { "shape": "__string", "locationName": "replicatorName", "documentation": "

The name of the replicator.

" }, "ReplicatorResourceArn": { "shape": "__string", "locationName": "replicatorResourceArn", "documentation": "

The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.

" }, "ReplicatorState": { "shape": "ReplicatorState", "locationName": "replicatorState", "documentation": "

State of the replicator.

" }, "ServiceExecutionRoleArn": { "shape": "__string", "locationName": "serviceExecutionRoleArn", "documentation": "

The Amazon Resource Name (ARN) of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters)

" }, "StateInfo": { "shape": "ReplicationStateInfo", "locationName": "stateInfo", "documentation": "

Details about the state of the replicator.

" }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "

List of tags attached to the Replicator.

" } } }, "DescribeVpcConnectionResponse": { "type": "structure", "members": { "VpcConnectionArn": { "shape": "__string", "locationName": "vpcConnectionArn", "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.

\n " }, "TargetClusterArn": { "shape": "__string", "locationName": "targetClusterArn", "documentation": "\n

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

\n " }, "State": { "shape": "VpcConnectionState", "locationName": "state", "documentation": "\n

The state of VPC connection.

\n " }, "Authentication": { "shape": "__string", "locationName": "authentication", "documentation": "\n

The authentication type of VPC connection.

\n " }, "VpcId": { "shape": "__string", "locationName": "vpcId", "documentation": "\n

The VPC Id for the VPC connection.

\n " }, "Subnets": { "shape": "__listOf__string", "locationName": "subnets", "documentation": "\n

The list of subnets for the VPC connection.

\n " }, "SecurityGroups": { "shape": "__listOf__string", "locationName": "securityGroups", "documentation": "\n

The list of security groups for the VPC connection.

\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\n

The creation time of the VPC connection.

\n " }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "\n

A map of tags for the VPC connection.

\n " } } }, "BatchDisassociateScramSecretRequest" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "location" : "uri", "locationName" : "clusterArn", "documentation" : "\n

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

\n " }, "SecretArnList" : { "shape" : "__listOf__string", "locationName" : "secretArnList", "documentation" : "\n

List of AWS Secrets Manager secret ARNs.

\n " } }, "documentation" : "\n

Disassociates sasl scram secrets to cluster.

\n ", "required" : [ "ClusterArn", "SecretArnList" ] }, "BatchDisassociateScramSecretResponse" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "locationName" : "clusterArn", "documentation" : "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "UnprocessedScramSecrets" : { "shape" : "__listOfUnprocessedScramSecret", "locationName" : "unprocessedScramSecrets", "documentation" : "\n

List of errors when disassociating secrets to cluster.

\n " } } }, "EBSStorageInfo": { "type": "structure", "members": { "ProvisionedThroughput" : { "shape" : "ProvisionedThroughput", "locationName" : "provisionedThroughput", "documentation" : "\n

EBS volume provisioned throughput information.

\n " }, "VolumeSize": { "shape": "__integerMin1Max16384", "locationName": "volumeSize", "documentation": "\n

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

\n " } }, "documentation": "\n

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

\n " }, "EncryptionAtRest": { "type": "structure", "members": { "DataVolumeKMSKeyId": { "shape": "__string", "locationName": "dataVolumeKMSKeyId", "documentation": "\n

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.

\n " } }, "documentation": "\n

The data-volume encryption details.

\n ", "required": [ "DataVolumeKMSKeyId" ] }, "EncryptionInTransit": { "type": "structure", "members": { "ClientBroker": { "shape": "ClientBroker", "locationName": "clientBroker", "documentation": "\n

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

\n

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

\n

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

\n

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

\n

The default value is TLS_PLAINTEXT.

\n " }, "InCluster": { "shape": "__boolean", "locationName": "inCluster", "documentation": "\n

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.

\n

The default value is true.

\n " } }, "documentation": "\n

The settings for encrypting data in transit.

\n " }, "EncryptionInfo": { "type": "structure", "members": { "EncryptionAtRest": { "shape": "EncryptionAtRest", "locationName": "encryptionAtRest", "documentation": "\n

The data-volume encryption details.

\n " }, "EncryptionInTransit": { "shape": "EncryptionInTransit", "locationName": "encryptionInTransit", "documentation": "\n

The details for encryption in transit.

\n " } }, "documentation": "\n

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.

\n " }, "EnhancedMonitoring": { "type": "string", "documentation": "\n

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.

\n ", "enum": [ "DEFAULT", "PER_BROKER", "PER_TOPIC_PER_BROKER", "PER_TOPIC_PER_PARTITION" ] }, "Error": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\n

The parameter that caused the error.

\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\n

The description of the error.

\n " } }, "documentation": "\n

Returns information about an error.

\n " }, "ErrorInfo": { "type": "structure", "members": { "ErrorCode": { "shape": "__string", "locationName": "errorCode", "documentation": "\n

A number describing the error programmatically.

\n " }, "ErrorString": { "shape": "__string", "locationName": "errorString", "documentation": "\n

An optional field to provide more details about the error.

\n " } }, "documentation": "\n

Returns information about an error state of the cluster.

\n " }, "Firehose" : { "type" : "structure", "members" : { "DeliveryStream" : { "shape" : "__string", "locationName" : "deliveryStream" }, "Enabled" : { "shape" : "__boolean", "locationName" : "enabled" } }, "required" : [ "Enabled" ] }, "ForbiddenException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\n

The parameter that caused the error.

\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\n

The description of the error.

\n " } }, "documentation": "\n

Returns information about an error.

\n ", "exception": true, "error": { "httpStatusCode": 403 } }, "GetBootstrapBrokersRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\n

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

\n " } }, "required": [ "ClusterArn" ] }, "GetBootstrapBrokersResponse": { "type": "structure", "members": { "BootstrapBrokerString": { "shape": "__string", "locationName": "bootstrapBrokerString", "documentation": "\n

A string containing one or more hostname:port pairs.

\n " }, "BootstrapBrokerStringTls": { "shape": "__string", "locationName": "bootstrapBrokerStringTls", "documentation": "\n

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

\n " }, "BootstrapBrokerStringSaslScram": { "shape": "__string", "locationName": "bootstrapBrokerStringSaslScram", "documentation": "\n

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

\n " }, "BootstrapBrokerStringSaslIam": { "shape": "__string", "locationName": "bootstrapBrokerStringSaslIam", "documentation": "\n

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

\n " }, "BootstrapBrokerStringPublicTls": { "shape": "__string", "locationName": "bootstrapBrokerStringPublicTls", "documentation": "\n

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

\n " }, "BootstrapBrokerStringPublicSaslScram": { "shape": "__string", "locationName": "bootstrapBrokerStringPublicSaslScram", "documentation": "\n

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

\n " }, "BootstrapBrokerStringPublicSaslIam": { "shape": "__string", "locationName": "bootstrapBrokerStringPublicSaslIam", "documentation": "\n

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

\n " }, "BootstrapBrokerStringVpcConnectivityTls": { "shape": "__string", "locationName": "bootstrapBrokerStringVpcConnectivityTls", "documentation": "\n

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

\n " }, "BootstrapBrokerStringVpcConnectivitySaslScram": { "shape": "__string", "locationName": "bootstrapBrokerStringVpcConnectivitySaslScram", "documentation": "\n

A string containing one or more DNS names (or IP) and SASL/SCRAM port pairs for VPC connectivity.

\n " }, "BootstrapBrokerStringVpcConnectivitySaslIam": { "shape": "__string", "locationName": "bootstrapBrokerStringVpcConnectivitySaslIam", "documentation": "\n

A string containing one or more DNS names (or IP) and SASL/IAM port pairs for VPC connectivity.

\n " } } }, "GetCompatibleKafkaVersionsRequest" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "location" : "querystring", "locationName" : "clusterArn", "documentation": "\n

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

\n " } } }, "GetCompatibleKafkaVersionsResponse" : { "type" : "structure", "members" : { "CompatibleKafkaVersions" : { "shape" : "__listOfCompatibleKafkaVersion", "locationName" : "compatibleKafkaVersions", "documentation": "\n

A list of CompatibleKafkaVersion objects.

\n " } } }, "GetClusterPolicyRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " } }, "required": [ "ClusterArn" ] }, "GetClusterPolicyResponse": { "type": "structure", "members": { "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation": "\n

The version of cluster policy.

\n " }, "Policy": { "shape": "__string", "locationName": "policy", "documentation": "\n

The cluster policy.

\n " } } }, "InternalServerErrorException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\n

The parameter that caused the error.

\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\n

The description of the error.

\n " } }, "documentation": "\n

Returns information about an error.

\n ", "exception": true, "error": { "httpStatusCode": 500 } }, "KafkaCluster": { "type": "structure", "members": { "AmazonMskCluster": { "shape": "AmazonMskCluster", "locationName": "amazonMskCluster", "documentation": "

Details of an Amazon MSK Cluster.

" }, "VpcConfig": { "shape": "KafkaClusterClientVpcConfig", "locationName": "vpcConfig", "documentation": "

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

" } }, "documentation": "

Information about Kafka Cluster to be used as source / target for replication.

", "required": ["VpcConfig", "AmazonMskCluster"] }, "KafkaClusterClientVpcConfig" : { "type" : "structure", "members" : { "SecurityGroupIds" : { "shape" : "__listOf__string", "locationName" : "securityGroupIds", "documentation" : "

The security groups to attach to the ENIs for the broker nodes.

" }, "SubnetIds" : { "shape" : "__listOf__string", "locationName" : "subnetIds", "documentation" : "

The list of subnets in the client VPC to connect to.

" } }, "documentation" : "

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

", "required" : [ "SubnetIds" ] }, "KafkaClusterDescription": { "type": "structure", "members": { "AmazonMskCluster": { "shape": "AmazonMskCluster", "locationName": "amazonMskCluster", "documentation": "

Details of an Amazon MSK Cluster.

" }, "KafkaClusterAlias": { "shape": "__string", "locationName": "kafkaClusterAlias", "documentation": "

The alias of the Kafka cluster. Used to prefix names of replicated topics.

" }, "VpcConfig": { "shape": "KafkaClusterClientVpcConfig", "locationName": "vpcConfig", "documentation": "

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

" } }, "documentation": "

Information about Kafka Cluster used as source / target for replication.

" }, "KafkaClusterSummary": { "type": "structure", "members": { "AmazonMskCluster": { "shape": "AmazonMskCluster", "locationName": "amazonMskCluster", "documentation": "

Details of an Amazon MSK Cluster.

" }, "KafkaClusterAlias": { "shape": "__string", "locationName": "kafkaClusterAlias", "documentation": "

The alias of the Kafka cluster. Used to prefix names of replicated topics.

" } }, "documentation": "

Summarized information about Kafka Cluster used as source / target for replication.

" }, "KafkaVersion": { "type": "structure", "members": { "Version": { "shape": "__string", "locationName": "version" }, "Status": { "shape": "KafkaVersionStatus", "locationName": "status" } } }, "KafkaVersionStatus": { "type": "string", "enum": [ "ACTIVE", "DEPRECATED" ] }, "ListClusterOperationsRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\n

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

\n " }, "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "\n

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

\n " }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "\n

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

\n " } }, "required": [ "ClusterArn" ] }, "ListClusterOperationsV2Request" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "location" : "uri", "locationName" : "clusterArn", "documentation" : "The arn of the cluster whose operations are being requested." }, "MaxResults" : { "shape" : "MaxResults", "location" : "querystring", "locationName" : "maxResults", "documentation" : "The maxResults of the query." }, "NextToken" : { "shape" : "__string", "location" : "querystring", "locationName" : "nextToken", "documentation" : "The nextToken of the query." } }, "required" : [ "ClusterArn" ] }, "ListClusterOperationsResponse": { "type": "structure", "members": { "ClusterOperationInfoList": { "shape": "__listOfClusterOperationInfo", "locationName": "clusterOperationInfoList", "documentation": "\n

An array of cluster operation information objects.

\n " }, "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "\n

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.

\n " } } }, "ListClusterOperationsV2Response" : { "type" : "structure", "members" : { "ClusterOperationInfoList" : { "shape" : "__listOfClusterOperationV2Summary", "locationName" : "clusterOperationInfoList", "documentation" : "\n

An array of cluster operation information objects.

" }, "NextToken" : { "shape" : "__string", "locationName" : "nextToken", "documentation" : "\n

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

" } } }, "ListClustersRequest": { "type": "structure", "members": { "ClusterNameFilter": { "shape": "__string", "location": "querystring", "locationName": "clusterNameFilter", "documentation": "\n

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.

\n " }, "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "\n

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

\n " }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "\n

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

\n " } } }, "ListClustersV2Request": { "type": "structure", "members": { "ClusterNameFilter": { "shape": "__string", "location": "querystring", "locationName": "clusterNameFilter", "documentation": "\n

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.

\n " }, "ClusterTypeFilter": { "shape": "__string", "location": "querystring", "locationName": "clusterTypeFilter", "documentation": "\n

Specify either PROVISIONED or SERVERLESS.

\n " }, "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "\n

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

\n " }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "\n

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

\n " } } }, "ListClustersResponse": { "type": "structure", "members": { "ClusterInfoList": { "shape": "__listOfClusterInfo", "locationName": "clusterInfoList", "documentation": "\n

Information on each of the MSK clusters in the response.

\n " }, "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "\n

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

\n " } } }, "ListClustersV2Response": { "type": "structure", "members": { "ClusterInfoList": { "shape": "__listOfCluster", "locationName": "clusterInfoList", "documentation": "\n

Information on each of the MSK clusters in the response.

\n " }, "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "\n

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

\n " } } }, "ListConfigurationRevisionsRequest": { "type": "structure", "members": { "Arn": { "shape": "__string", "location": "uri", "locationName": "arn", "documentation": "\n

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

\n " }, "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "\n

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

\n " }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "\n

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

\n " } }, "required": [ "Arn" ] }, "ListConfigurationRevisionsResponse": { "type": "structure", "members": { "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "\n

Paginated results marker.

\n " }, "Revisions": { "shape": "__listOfConfigurationRevision", "locationName": "revisions", "documentation": "\n

List of ConfigurationRevision objects.

\n " } } }, "ListConfigurationsRequest": { "type": "structure", "members": { "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "\n

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

\n " }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "\n

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

\n " } } }, "ListConfigurationsResponse": { "type": "structure", "members": { "Configurations": { "shape": "__listOfConfiguration", "locationName": "configurations", "documentation": "\n

An array of MSK configurations.

\n " }, "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "\n

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

\n " } } }, "ListKafkaVersionsRequest": { "type": "structure", "members": { "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "\n

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

" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "\n

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

" } } }, "ListKafkaVersionsResponse": { "type": "structure", "members": { "KafkaVersions": { "shape": "__listOfKafkaVersion", "locationName": "kafkaVersions" }, "NextToken": { "shape": "__string", "locationName": "nextToken" } } }, "ListNodesRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\n

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

\n " }, "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "\n

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

\n " }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "\n

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

\n " } }, "required": [ "ClusterArn" ] }, "ListNodesResponse": { "type": "structure", "members": { "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "\n

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

\n " }, "NodeInfoList": { "shape": "__listOfNodeInfo", "locationName": "nodeInfoList", "documentation": "\n

List containing a NodeInfo object.

\n " } } }, "ListReplicatorsRequest": { "type": "structure", "members": { "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "

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

" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "

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

" }, "ReplicatorNameFilter": { "shape": "__string", "location": "querystring", "locationName": "replicatorNameFilter", "documentation": "

Returns replicators starting with given name.

" } } }, "ListReplicatorsResponse": { "type": "structure", "members": { "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "

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

" }, "Replicators": { "shape": "__listOfReplicatorSummary", "locationName": "replicators", "documentation": "

List containing information of each of the replicators in the account.

" } } }, "ListScramSecretsRequest" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "location" : "uri", "locationName" : "clusterArn", "documentation" : "\n

The arn of the cluster.

\n " }, "MaxResults" : { "shape" : "MaxResults", "location" : "querystring", "locationName" : "maxResults", "documentation" : "\n

The maxResults of the query.

\n " }, "NextToken" : { "shape" : "__string", "location" : "querystring", "locationName" : "nextToken", "documentation" : "\n

The nextToken of the query.

\n " } }, "required" : [ "ClusterArn" ] }, "ListScramSecretsResponse" : { "type" : "structure", "members" : { "NextToken" : { "shape" : "__string", "locationName" : "nextToken", "documentation" : "\n

Paginated results marker.

\n " }, "SecretArnList" : { "shape" : "__listOf__string", "locationName" : "secretArnList", "documentation" : "\n

The list of scram secrets associated with the cluster.

\n " } } }, "ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "shape": "__string", "location": "uri", "locationName": "resourceArn", "documentation": "\n

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

\n " } }, "required": [ "ResourceArn" ] }, "ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "\n

The key-value pair for the resource tag.

\n " } } }, "ListClientVpcConnectionsRequest": { "type": "structure", "members": { "ClusterArn" : { "shape" : "__string", "location" : "uri", "locationName" : "clusterArn", "documentation" : "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "\n

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

\n " }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "\n

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

\n " } }, "required": [ "ClusterArn" ] }, "ListClientVpcConnectionsResponse": { "type": "structure", "members": { "ClientVpcConnections" : { "shape" : "__listOfClientVpcConnection", "locationName" : "clientVpcConnections", "documentation": "\n

List of client VPC connections.

\n " }, "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "\n

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

\n " } } }, "ListVpcConnectionsRequest": { "type": "structure", "members": { "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "\n

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

\n " }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "\n

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

\n " } } }, "ListVpcConnectionsResponse": { "type": "structure", "members": { "VpcConnections" : { "shape" : "__listOfVpcConnection", "locationName" : "vpcConnections", "documentation": "\n

List of VPC connections.

\n " }, "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "\n

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

\n " } } }, "RejectClientVpcConnectionRequest" : { "type" : "structure", "members" : { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation" : "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "VpcConnectionArn": { "shape": "__string", "locationName": "vpcConnectionArn", "documentation": "\n

The VPC connection ARN.

\n " } }, "required" : [ "VpcConnectionArn", "ClusterArn" ] }, "RejectClientVpcConnectionResponse" : { "type": "structure", "members": { } }, "MaxResults": { "type": "integer", "min": 1, "max": 100 }, "LoggingInfo": { "type": "structure", "members": { "BrokerLogs": { "shape": "BrokerLogs", "locationName": "brokerLogs" } }, "required": [ "BrokerLogs" ] }, "MutableClusterInfo": { "type": "structure", "members": { "BrokerEBSVolumeInfo": { "shape": "__listOfBrokerEBSVolumeInfo", "locationName": "brokerEBSVolumeInfo", "documentation": "\n

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

\n " }, "ConfigurationInfo": { "shape": "ConfigurationInfo", "locationName": "configurationInfo", "documentation": "\n

Information about the changes in the configuration of the brokers.

\n " }, "NumberOfBrokerNodes": { "shape": "__integer", "locationName": "numberOfBrokerNodes", "documentation": "\n

The number of broker nodes in the cluster.

\n " }, "EnhancedMonitoring" : { "shape" : "EnhancedMonitoring", "locationName" : "enhancedMonitoring", "documentation" : "\n

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

\n " }, "OpenMonitoring" : { "shape" : "OpenMonitoring", "locationName" : "openMonitoring", "documentation" : "\n

The settings for open monitoring.

\n " }, "KafkaVersion" : { "shape" : "__string", "locationName" : "kafkaVersion", "documentation" : "\n

The Apache Kafka version.

\n " }, "LoggingInfo": { "shape": "LoggingInfo", "locationName": "loggingInfo", "documentation" : "\n

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.

\n " }, "InstanceType": { "shape" : "__stringMin5Max32", "locationName" : "instanceType", "documentation" : "\n

Information about the Amazon MSK broker type.

\n " }, "ClientAuthentication" : { "shape" : "ClientAuthentication", "locationName" : "clientAuthentication", "documentation": "\n

Includes all client authentication information.

\n " }, "EncryptionInfo" : { "shape" : "EncryptionInfo", "locationName" : "encryptionInfo", "documentation": "\n

Includes all encryption-related information.

\n " }, "ConnectivityInfo" : { "shape" : "ConnectivityInfo", "locationName" : "connectivityInfo", "documentation" : "\n

Information about the broker access configuration.

\n " }, "StorageMode" : { "shape" : "StorageMode", "locationName" : "storageMode", "documentation" : "\n

This controls storage mode for supported storage tiers.

\n " } }, "documentation": "\n

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

\n " }, "NodeExporter" : { "type" : "structure", "members" : { "EnabledInBroker" : { "shape" : "__boolean", "locationName" : "enabledInBroker", "documentation" : "\n

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

\n " } }, "documentation" : "\n

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

\n ", "required" : [ "EnabledInBroker" ] }, "NodeExporterInfo" : { "type" : "structure", "members" : { "EnabledInBroker" : { "shape" : "__boolean", "locationName" : "enabledInBroker", "documentation" : "\n

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

\n " } }, "documentation" : "\n

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

\n ", "required" : [ "EnabledInBroker" ] }, "JmxExporter" : { "type" : "structure", "members" : { "EnabledInBroker" : { "shape" : "__boolean", "locationName" : "enabledInBroker", "documentation" : "\n

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

\n " } }, "documentation" : "\n

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

\n ", "required" : [ "EnabledInBroker" ] }, "JmxExporterInfo" : { "type" : "structure", "members" : { "EnabledInBroker" : { "shape" : "__boolean", "locationName" : "enabledInBroker", "documentation" : "\n

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

\n " } }, "documentation" : "\n

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

\n ", "required" : [ "EnabledInBroker" ] }, "OpenMonitoring" : { "type" : "structure", "members" : { "Prometheus" : { "shape" : "Prometheus", "locationName" : "prometheus", "documentation" : "\n

Prometheus settings.

\n " } }, "documentation" : "\n

JMX and Node monitoring for the MSK cluster.

\n ", "required" : [ "Prometheus" ] }, "OpenMonitoringInfo" : { "type" : "structure", "members" : { "Prometheus" : { "shape" : "PrometheusInfo", "locationName" : "prometheus", "documentation" : "\n

Prometheus settings.

\n " } }, "documentation" : "\n

JMX and Node monitoring for the MSK cluster.

\n ", "required" : [ "Prometheus" ] }, "Prometheus" : { "type" : "structure", "members" : { "JmxExporter" : { "shape" : "JmxExporter", "locationName" : "jmxExporter", "documentation" : "\n

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

\n " }, "NodeExporter" : { "shape" : "NodeExporter", "locationName" : "nodeExporter", "documentation" : "\n

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

\n " } }, "documentation" : "\n

Prometheus settings.

\n " }, "PrometheusInfo" : { "type" : "structure", "members" : { "JmxExporter" : { "shape" : "JmxExporterInfo", "locationName" : "jmxExporter", "documentation" : "\n

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

\n " }, "NodeExporter" : { "shape" : "NodeExporterInfo", "locationName" : "nodeExporter", "documentation" : "\n

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

\n " } }, "documentation" : "\n

Prometheus settings.

\n " }, "ProvisionedThroughput" : { "type" : "structure", "members" : { "Enabled" : { "shape" : "__boolean", "locationName" : "enabled", "documentation" : "\n

Provisioned throughput is enabled or not.

\n " }, "VolumeThroughput" : { "shape" : "__integer", "locationName" : "volumeThroughput", "documentation" : "\n

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

\n " } }, "documentation" : "\n

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

\n " }, "PublicAccess" : { "type" : "structure", "members" : { "Type" : { "shape" : "__string", "locationName" : "type", "documentation" : "\n

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

\n " } }, "documentation" : "Public access control for brokers." }, "PutClusterPolicyRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation" : "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation" : "\n

The policy version.

\n " }, "Policy": { "shape": "__string", "locationName": "policy", "documentation" : "\n

The policy.

\n " } }, "required": [ "ClusterArn", "Policy" ] }, "PutClusterPolicyResponse": { "type": "structure", "members": { "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation" : "\n

The policy version.

\n " } } }, "RebootBrokerRequest" : { "type" : "structure", "members" : { "BrokerIds" : { "shape" : "__listOf__string", "locationName" : "brokerIds", "documentation" : "\n

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

\n " }, "ClusterArn" : { "shape" : "__string", "location" : "uri", "locationName" : "clusterArn", "documentation" : "\n

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

\n " } }, "documentation" : "Reboots a node.", "required" : [ "ClusterArn", "BrokerIds" ] }, "RebootBrokerResponse" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "locationName" : "clusterArn", "documentation" : "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "ClusterOperationArn" : { "shape" : "__string", "locationName" : "clusterOperationArn", "documentation" : "\n

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

\n " } } }, "S3" : { "type" : "structure", "members" : { "Bucket" : { "shape" : "__string", "locationName" : "bucket" }, "Enabled" : { "shape" : "__boolean", "locationName" : "enabled" }, "Prefix" : { "shape" : "__string", "locationName" : "prefix" } }, "required" : [ "Enabled" ] }, "ServerlessSasl" : { "type" : "structure", "members" : { "Iam" : { "shape" : "Iam", "locationName" : "iam", "documentation" : "\n

Indicates whether IAM access control is enabled.

\n " } }, "documentation" : "\n

Details for client authentication using SASL.

\n " }, "Sasl" : { "type" : "structure", "members" : { "Scram" : { "shape" : "Scram", "locationName" : "scram", "documentation" : "\n

Details for SASL/SCRAM client authentication.

\n " }, "Iam" : { "shape" : "Iam", "locationName" : "iam", "documentation" : "\n

Indicates whether IAM access control is enabled.

\n " } }, "documentation" : "\n

Details for client authentication using SASL.

\n " }, "VpcConnectivitySasl" : { "type" : "structure", "members" : { "Scram" : { "shape" : "VpcConnectivityScram", "locationName" : "scram", "documentation" : "\n

Details for SASL/SCRAM client authentication for VPC connectivity.

\n " }, "Iam" : { "shape" : "VpcConnectivityIam", "locationName" : "iam", "documentation" : "\n

Details for SASL/IAM client authentication for VPC connectivity.

\n " } }, "documentation" : "\n

Details for SASL client authentication for VPC connectivity.

\n " }, "Scram" : { "type" : "structure", "members" : { "Enabled" : { "shape" : "__boolean", "locationName" : "enabled", "documentation" : "\n

SASL/SCRAM authentication is enabled or not.

\n " } }, "documentation" : "\n

Details for SASL/SCRAM client authentication.

\n " }, "VpcConnectivityScram" : { "type" : "structure", "members" : { "Enabled" : { "shape" : "__boolean", "locationName" : "enabled", "documentation" : "\n

SASL/SCRAM authentication is on or off for VPC connectivity.

\n " } }, "documentation" : "\n

Details for SASL/SCRAM client authentication for VPC connectivity.

\n " }, "Iam" : { "type" : "structure", "members" : { "Enabled" : { "shape" : "__boolean", "locationName" : "enabled", "documentation" : "\n

Indicates whether IAM access control is enabled.

\n " } }, "documentation" : "\n

Details for IAM access control.

\n " }, "VpcConnectivityIam" : { "type" : "structure", "members" : { "Enabled" : { "shape" : "__boolean", "locationName" : "enabled", "documentation" : "\n

SASL/IAM authentication is on or off for VPC connectivity.

\n " } }, "documentation" : "\n

Details for IAM access control for VPC connectivity.

\n " }, "NodeInfo": { "type": "structure", "members": { "AddedToClusterTime": { "shape": "__string", "locationName": "addedToClusterTime", "documentation": "\n

The start time.

\n " }, "BrokerNodeInfo": { "shape": "BrokerNodeInfo", "locationName": "brokerNodeInfo", "documentation": "\n

The broker node info.

\n " }, "InstanceType": { "shape": "__string", "locationName": "instanceType", "documentation": "\n

The instance type.

\n " }, "NodeARN": { "shape": "__string", "locationName": "nodeARN", "documentation": "\n

The Amazon Resource Name (ARN) of the node.

\n " }, "NodeType": { "shape": "NodeType", "locationName": "nodeType", "documentation": "\n

The node type.

\n " }, "ZookeeperNodeInfo": { "shape": "ZookeeperNodeInfo", "locationName": "zookeeperNodeInfo", "documentation": "\n

The ZookeeperNodeInfo.

\n " } }, "documentation": "\n

The node information object.

\n " }, "NodeType": { "type": "string", "documentation": "\n

The broker or Zookeeper node.

\n ", "enum": [ "BROKER" ] }, "NotFoundException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\n

The parameter that caused the error.

\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\n

The description of the error.

\n " } }, "documentation": "\n

Returns information about an error.

\n ", "exception": true, "error": { "httpStatusCode": 404 } }, "ReplicationInfo": { "type": "structure", "members": { "ConsumerGroupReplication": { "shape": "ConsumerGroupReplication", "locationName": "consumerGroupReplication", "documentation": "

Configuration relating to consumer group replication.

" }, "SourceKafkaClusterArn": { "shape": "__string", "locationName": "sourceKafkaClusterArn", "documentation": "

The ARN of the source Kafka cluster.

" }, "TargetCompressionType": { "shape": "TargetCompressionType", "locationName": "targetCompressionType", "documentation": "

The compression type to use when producing records to target cluster.

" }, "TargetKafkaClusterArn": { "shape": "__string", "locationName": "targetKafkaClusterArn", "documentation": "

The ARN of the target Kafka cluster.

" }, "TopicReplication": { "shape": "TopicReplication", "locationName": "topicReplication", "documentation": "

Configuration relating to topic replication.

" } }, "documentation": "

Specifies configuration for replication between a source and target Kafka cluster.

", "required": ["TargetCompressionType", "TopicReplication", "ConsumerGroupReplication", "SourceKafkaClusterArn", "TargetKafkaClusterArn"] }, "ReplicationInfoDescription": { "type": "structure", "members": { "ConsumerGroupReplication": { "shape": "ConsumerGroupReplication", "locationName": "consumerGroupReplication", "documentation": "

Configuration relating to consumer group replication.

" }, "SourceKafkaClusterAlias": { "shape": "__string", "locationName": "sourceKafkaClusterAlias", "documentation": "

The alias of the source Kafka cluster.

" }, "TargetCompressionType": { "shape": "TargetCompressionType", "locationName": "targetCompressionType", "documentation": "

The compression type to use when producing records to target cluster.

" }, "TargetKafkaClusterAlias": { "shape": "__string", "locationName": "targetKafkaClusterAlias", "documentation": "

The alias of the target Kafka cluster.

" }, "TopicReplication": { "shape": "TopicReplication", "locationName": "topicReplication", "documentation": "

Configuration relating to topic replication.

" } }, "documentation": "

Specifies configuration for replication between a source and target Kafka cluster (sourceKafkaClusterAlias -> targetKafkaClusterAlias)

" }, "ReplicationInfoSummary": { "type": "structure", "members": { "SourceKafkaClusterAlias": { "shape": "__string", "locationName": "sourceKafkaClusterAlias", "documentation": "

The alias of the source Kafka cluster.

" }, "TargetKafkaClusterAlias": { "shape": "__string", "locationName": "targetKafkaClusterAlias", "documentation": "

The alias of the target Kafka cluster.

" } }, "documentation": "

Summarized information of replication between clusters.

" }, "ReplicationStateInfo" : { "type" : "structure", "members" : { "Code" : { "shape" : "__string", "locationName" : "code", "documentation" : "Code that describes the current state of the replicator." }, "Message" : { "shape" : "__string", "locationName" : "message", "documentation" : "Message that describes the state of the replicator." } }, "documentation" : "Details about the state of a replicator" }, "ReplicatorState": { "type": "string", "documentation": "

The state of a replicator.

", "enum": ["RUNNING", "CREATING", "UPDATING", "DELETING", "FAILED"] }, "ReplicatorSummary": { "type": "structure", "members": { "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "

The time the replicator was created.

" }, "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation": "

The current version of the replicator.

" }, "IsReplicatorReference": { "shape": "__boolean", "locationName": "isReplicatorReference", "documentation": "

Whether this resource is a replicator reference.

" }, "KafkaClustersSummary": { "shape": "__listOfKafkaClusterSummary", "locationName": "kafkaClustersSummary", "documentation": "

Kafka Clusters used in setting up sources / targets for replication.

" }, "ReplicationInfoSummaryList": { "shape": "__listOfReplicationInfoSummary", "locationName": "replicationInfoSummaryList", "documentation": "

A list of summarized information of replications between clusters.

" }, "ReplicatorArn": { "shape": "__string", "locationName": "replicatorArn", "documentation": "

The Amazon Resource Name (ARN) of the replicator.

" }, "ReplicatorName": { "shape": "__string", "locationName": "replicatorName", "documentation": "

The name of the replicator.

" }, "ReplicatorResourceArn": { "shape": "__string", "locationName": "replicatorResourceArn", "documentation": "

The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.

" }, "ReplicatorState": { "shape": "ReplicatorState", "locationName": "replicatorState", "documentation": "

State of the replicator.

" } }, "documentation": "

Information about a replicator.

" }, "ServiceUnavailableException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\n

The parameter that caused the error.

\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\n

The description of the error.

\n " } }, "documentation": "\n

Returns information about an error.

\n ", "exception": true, "error": { "httpStatusCode": 503 } }, "StateInfo" : { "type" : "structure", "members" : { "Code" : { "shape" : "__string", "locationName" : "code" }, "Message" : { "shape" : "__string", "locationName" : "message" } } }, "StorageInfo": { "type": "structure", "members": { "EbsStorageInfo": { "shape": "EBSStorageInfo", "locationName": "ebsStorageInfo", "documentation": "\n

EBS volume information.

\n " } }, "documentation": "\n

Contains information about storage volumes attached to MSK broker nodes.

\n " }, "StorageMode" : { "type" : "string", "documentation" : "Controls storage mode for various supported storage tiers.", "enum" : [ "LOCAL", "TIERED" ] }, "TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "shape": "__string", "location": "uri", "locationName": "resourceArn", "documentation": "\n

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

\n " }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "\n

The key-value pair for the resource tag.

\n " } }, "required": [ "ResourceArn", "Tags" ] }, "TargetCompressionType": { "type": "string", "documentation": "

The type of compression to use producing records to the target cluster.

", "enum": ["NONE", "GZIP", "SNAPPY", "LZ4", "ZSTD"] }, "Tls": { "type": "structure", "members": { "CertificateAuthorityArnList": { "shape": "__listOf__string", "locationName": "certificateAuthorityArnList", "documentation": "\n

List of ACM Certificate Authority ARNs.

\n " }, "Enabled" : { "shape" : "__boolean", "locationName" : "enabled", "documentation" : "\n

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

\n " } }, "documentation": "\n

Details for client authentication using TLS.

\n " }, "VpcConnectivityTls": { "type": "structure", "members": { "Enabled" : { "shape" : "__boolean", "locationName" : "enabled", "documentation" : "\n

TLS authentication is on or off for VPC connectivity.

\n " } }, "documentation": "\n

Details for TLS client authentication for VPC connectivity.

\n " }, "TooManyRequestsException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\n

The parameter that caused the error.

\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\n

The description of the error.

\n " } }, "documentation": "\n

Returns information about an error.

\n ", "exception": true, "error": { "httpStatusCode": 429 } }, "TopicReplication": { "type": "structure", "members": { "CopyAccessControlListsForTopics": { "shape": "__boolean", "locationName": "copyAccessControlListsForTopics", "documentation": "

Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.

" }, "CopyTopicConfigurations": { "shape": "__boolean", "locationName": "copyTopicConfigurations", "documentation": "

Whether to periodically configure remote topics to match their corresponding upstream topics.

" }, "DetectAndCopyNewTopics": { "shape": "__boolean", "locationName": "detectAndCopyNewTopics", "documentation": "

Whether to periodically check for new topics and partitions.

" }, "TopicsToExclude": { "shape": "__listOf__stringMax249", "locationName": "topicsToExclude", "documentation": "

List of regular expression patterns indicating the topics that should not be replicated.

" }, "TopicsToReplicate": { "shape": "__listOf__stringMax249", "locationName": "topicsToReplicate", "documentation": "

List of regular expression patterns indicating the topics to copy.

" } }, "documentation": "

Details about topic replication.

", "required": ["TopicsToReplicate"] }, "TopicReplicationUpdate": { "type": "structure", "members": { "CopyAccessControlListsForTopics": { "shape": "__boolean", "locationName": "copyAccessControlListsForTopics", "documentation": "

Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.

" }, "CopyTopicConfigurations": { "shape": "__boolean", "locationName": "copyTopicConfigurations", "documentation": "

Whether to periodically configure remote topics to match their corresponding upstream topics.

" }, "DetectAndCopyNewTopics": { "shape": "__boolean", "locationName": "detectAndCopyNewTopics", "documentation": "

Whether to periodically check for new topics and partitions.

" }, "TopicsToExclude": { "shape": "__listOf__stringMax249", "locationName": "topicsToExclude", "documentation": "

List of regular expression patterns indicating the topics that should not be replicated.

" }, "TopicsToReplicate": { "shape": "__listOf__stringMax249", "locationName": "topicsToReplicate", "documentation": "

List of regular expression patterns indicating the topics to copy.

" } }, "documentation": "

Details for updating the topic replication of a replicator.

", "required": ["TopicsToReplicate", "TopicsToExclude", "CopyTopicConfigurations", "DetectAndCopyNewTopics", "CopyAccessControlListsForTopics"] }, "Unauthenticated" : { "type" : "structure", "members" : { "Enabled" : { "shape" : "__boolean", "locationName" : "enabled", "documentation" : "\n

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

\n " } } }, "UnauthorizedException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\n

The parameter that caused the error.

\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\n

The description of the error.

\n " } }, "documentation": "\n

Returns information about an error.

\n ", "exception": true, "error": { "httpStatusCode": 401 } }, "UnprocessedScramSecret" : { "type" : "structure", "members" : { "ErrorCode" : { "shape" : "__string", "locationName" : "errorCode", "documentation" : "\n

Error code for associate/disassociate failure.

\n " }, "ErrorMessage" : { "shape" : "__string", "locationName" : "errorMessage", "documentation" : "\n

Error message for associate/disassociate failure.

\n " }, "SecretArn" : { "shape" : "__string", "locationName" : "secretArn", "documentation" : "\n

AWS Secrets Manager secret ARN.

\n " } }, "documentation" : "\n

Error info for scram secret associate/disassociate failure.

\n " }, "UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "shape": "__string", "location": "uri", "locationName": "resourceArn", "documentation": "\n

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

\n " }, "TagKeys": { "shape": "__listOf__string", "location": "querystring", "locationName": "tagKeys", "documentation": "\n

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

\n

\n
- \n

  Each tag key must be unique. If you add a tag with a key that's already in\n use, your new tag overwrites the existing key-value pair.

  \n
\n
- \n

  You can't start a tag key with aws: because this prefix is reserved for use\n by AWS. AWS creates tags that begin with this prefix on your behalf, but\n you can't edit or delete them.

  \n
\n
- \n

  Tag keys must be between 1 and 128 Unicode characters in length.

  \n
\n
- \n

  Tag keys must consist of the following characters: Unicode letters, digits,\n white space, and the following special characters: _ . / = + -\n @.

  \n
\n

\n " } }, "required": [ "TagKeys", "ResourceArn" ] }, "UpdateBrokerCountRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\n

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

\n " }, "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation": "\n

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

\n " }, "TargetNumberOfBrokerNodes": { "shape": "__integerMin1Max15", "locationName": "targetNumberOfBrokerNodes", "documentation": "\n

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

\n " } }, "required": [ "ClusterArn", "CurrentVersion", "TargetNumberOfBrokerNodes" ] }, "UpdateBrokerCountResponse": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "locationName": "clusterArn", "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "ClusterOperationArn": { "shape": "__string", "locationName": "clusterOperationArn", "documentation": "\n

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

\n " } } }, "UpdateBrokerTypeRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\n

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

\n " }, "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation": "\n

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

\n " }, "TargetInstanceType": { "shape": "__string", "locationName": "targetInstanceType", "documentation": "\n

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

\n " } }, "required": [ "ClusterArn", "CurrentVersion", "TargetInstanceType" ] }, "UpdateBrokerTypeResponse": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "locationName": "clusterArn", "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "ClusterOperationArn": { "shape": "__string", "locationName": "clusterOperationArn", "documentation": "\n

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

\n " } } }, "UpdateBrokerStorageRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\n

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

\n " }, "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation": "\n

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

\n " }, "TargetBrokerEBSVolumeInfo": { "shape": "__listOfBrokerEBSVolumeInfo", "locationName": "targetBrokerEBSVolumeInfo", "documentation": "\n

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

\n " } }, "required": [ "ClusterArn", "TargetBrokerEBSVolumeInfo", "CurrentVersion" ] }, "UpdateBrokerStorageResponse": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "locationName": "clusterArn", "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "ClusterOperationArn": { "shape": "__string", "locationName": "clusterOperationArn", "documentation": "\n

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

\n " } } }, "UpdateClusterConfigurationRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\n

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

\n " }, "ConfigurationInfo": { "shape": "ConfigurationInfo", "locationName": "configurationInfo", "documentation": "\n

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

\n " }, "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation": "\n

The version of the cluster that needs to be updated.

\n " } }, "required": [ "ClusterArn", "CurrentVersion", "ConfigurationInfo" ] }, "UpdateClusterConfigurationResponse": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "locationName": "clusterArn", "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "ClusterOperationArn": { "shape": "__string", "locationName": "clusterOperationArn", "documentation": "\n

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

\n " } } }, "UpdateClusterKafkaVersionRequest" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "location" : "uri", "locationName" : "clusterArn", "documentation" : "\n

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

\n " }, "ConfigurationInfo" : { "shape" : "ConfigurationInfo", "locationName" : "configurationInfo", "documentation": "\n

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

\n " }, "CurrentVersion" : { "shape" : "__string", "locationName" : "currentVersion", "documentation": "\n

Current cluster version.

\n " }, "TargetKafkaVersion" : { "shape" : "__string", "locationName" : "targetKafkaVersion" ,"documentation": "\n

Target Kafka version.

\n " } }, "required" : [ "ClusterArn", "TargetKafkaVersion", "CurrentVersion" ] }, "UpdateClusterKafkaVersionResponse" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "locationName" : "clusterArn", "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "ClusterOperationArn" : { "shape" : "__string", "locationName" : "clusterOperationArn", "documentation": "\n

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

\n " } } }, "UpdateMonitoringRequest" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "location" : "uri", "locationName" : "clusterArn", "documentation" : "\n

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

\n " }, "CurrentVersion" : { "shape" : "__string", "locationName" : "currentVersion", "documentation" : "\n

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.

\n " }, "EnhancedMonitoring" : { "shape" : "EnhancedMonitoring", "locationName" : "enhancedMonitoring", "documentation" : "\n

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

\n " }, "OpenMonitoring" : { "shape" : "OpenMonitoringInfo", "locationName" : "openMonitoring", "documentation" : "\n

The settings for open monitoring.

\n " }, "LoggingInfo": { "shape": "LoggingInfo", "locationName": "loggingInfo" } }, "documentation" : "Request body for UpdateMonitoring.", "required" : [ "ClusterArn", "CurrentVersion" ] }, "UpdateMonitoringResponse" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "locationName" : "clusterArn", "documentation" : "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "ClusterOperationArn" : { "shape" : "__string", "locationName" : "clusterOperationArn", "documentation" : "\n

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

\n " } } }, "UpdateReplicationInfoRequest": { "type": "structure", "members": { "ConsumerGroupReplication": { "shape": "ConsumerGroupReplicationUpdate", "locationName": "consumerGroupReplication", "documentation": "

Updated consumer group replication information.

" }, "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation": "

Current replicator version.

" }, "ReplicatorArn": { "shape": "__string", "location": "uri", "locationName": "replicatorArn", "documentation": "

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

" }, "SourceKafkaClusterArn": { "shape": "__string", "locationName": "sourceKafkaClusterArn", "documentation": "

The ARN of the source Kafka cluster.

" }, "TargetKafkaClusterArn": { "shape": "__string", "locationName": "targetKafkaClusterArn", "documentation": "

The ARN of the target Kafka cluster.

" }, "TopicReplication": { "shape": "TopicReplicationUpdate", "locationName": "topicReplication", "documentation": "

Updated topic replication information.

" } }, "documentation": "

Update information relating to replication between a given source and target Kafka cluster.

", "required": ["ReplicatorArn", "SourceKafkaClusterArn", "CurrentVersion", "TargetKafkaClusterArn"] }, "UpdateReplicationInfoResponse": { "type": "structure", "members": { "ReplicatorArn": { "shape": "__string", "locationName": "replicatorArn", "documentation": "

The Amazon Resource Name (ARN) of the replicator.

" }, "ReplicatorState": { "shape": "ReplicatorState", "locationName": "replicatorState", "documentation": "

State of the replicator.

" } } }, "UpdateSecurityRequest" : { "type" : "structure", "members" : { "ClientAuthentication" : { "shape" : "ClientAuthentication", "locationName" : "clientAuthentication", "documentation" : "\n

Includes all client authentication related information.

\n " }, "ClusterArn" : { "shape" : "__string", "location" : "uri", "locationName" : "clusterArn", "documentation" : "\n

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

\n " }, "CurrentVersion" : { "shape" : "__string", "locationName" : "currentVersion", "documentation" : "\n

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.

\n " }, "EncryptionInfo" : { "shape" : "EncryptionInfo", "locationName" : "encryptionInfo", "documentation" : "\n

Includes all encryption-related information.

\n " } }, "required" : [ "ClusterArn", "CurrentVersion" ] }, "UpdateSecurityResponse" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "locationName" : "clusterArn", "documentation" : "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "ClusterOperationArn" : { "shape" : "__string", "locationName" : "clusterOperationArn", "documentation" : "\n

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

\n " } } }, "UpdateStorageRequest" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "location" : "uri", "locationName" : "clusterArn", "documentation" : "\n

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

\n " }, "CurrentVersion" : { "shape" : "__string", "locationName" : "currentVersion", "documentation" : "\n

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

\n " }, "ProvisionedThroughput" : { "shape" : "ProvisionedThroughput", "locationName" : "provisionedThroughput", "documentation" : "\n

EBS volume provisioned throughput information.

\n " }, "StorageMode" : { "shape" : "StorageMode", "locationName" : "storageMode", "documentation" : "\n

Controls storage mode for supported storage tiers.

\n " }, "VolumeSizeGB" : { "shape" : "__integer", "locationName" : "volumeSizeGB", "documentation" : "\n

size of the EBS volume to update.

\n " } }, "documentation" : "\n

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

\n ", "required" : [ "ClusterArn", "CurrentVersion" ] }, "UpdateStorageResponse" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "locationName" : "clusterArn", "documentation" : "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "ClusterOperationArn" : { "shape" : "__string", "locationName" : "clusterOperationArn", "documentation" : "\n

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

\n " } } }, "UpdateConfigurationRequest": { "type": "structure", "members": { "Arn": { "shape": "__string", "location" : "uri", "locationName": "arn", "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " }, "Description": { "shape": "__string", "locationName": "description", "documentation": "\n

The description of the configuration revision.

\n " }, "ServerProperties": { "shape": "__blob", "locationName": "serverProperties", "documentation": "\n

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. \n When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

\n " } }, "required": [ "Arn", "ServerProperties" ] }, "UpdateConfigurationResponse": { "type": "structure", "members": { "Arn": { "shape": "__string", "locationName": "arn", "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " }, "LatestRevision": { "shape": "ConfigurationRevision", "locationName": "latestRevision", "documentation": "\n

Latest revision of the configuration.

\n " } } }, "UpdateConnectivityRequest" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "location" : "uri", "locationName" : "clusterArn", "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " }, "ConnectivityInfo" : { "shape" : "ConnectivityInfo", "locationName" : "connectivityInfo", "documentation" : "\n

Information about the broker access configuration.

\n " }, "CurrentVersion" : { "shape" : "__string", "locationName" : "currentVersion", "documentation" : "\n

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.

\n " } }, "documentation" : "Request body for UpdateConnectivity.", "required" : [ "ClusterArn", "ConnectivityInfo", "CurrentVersion" ] }, "UpdateConnectivityResponse" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "locationName" : "clusterArn", "documentation" : "\n

The Amazon Resource Name (ARN) of the cluster.

\n " }, "ClusterOperationArn" : { "shape" : "__string", "locationName" : "clusterOperationArn", "documentation" : "\n

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

\n " } } }, "UserIdentity": { "type": "structure", "members": { "Type": { "shape": "UserIdentityType", "locationName": "type", "documentation" : "\n

The identity type of the requester that calls the API operation.

\n " }, "PrincipalId": { "shape": "__string", "locationName": "principalId", "documentation" : "\n

A unique identifier for the requester that calls the API operation.

\n " } }, "documentation" : "\n

Description of the requester that calls the API operation.

\n " }, "UserIdentityType": { "type": "string", "documentation": "\n

The identity type of the requester that calls the API operation.

\n ", "enum": [ "AWSACCOUNT", "AWSSERVICE" ] }, "VpcConnectionInfo": { "type": "structure", "members": { "VpcConnectionArn": { "shape": "__string", "locationName": "vpcConnectionArn", "documentation" : "\n

The Amazon Resource Name (ARN) of the VPC connection.

\n " }, "Owner": { "shape": "__string", "locationName": "owner", "documentation" : "\n

The owner of the VPC Connection.

\n " }, "UserIdentity": { "shape": "UserIdentity", "locationName": "userIdentity", "documentation" : "\n

Description of the requester that calls the API operation.

\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation" : "\n

The time when Amazon MSK creates the VPC Connnection.

\n " } }, "documentation": "\n

Description of the VPC connection.

\n " }, "VpcConnectionInfoServerless" : { "type" : "structure", "members" : { "CreationTime" : { "shape" : "__timestampIso8601", "locationName" : "creationTime", "documentation" : "\n

The time when Amazon MSK creates the VPC Connnection.

" }, "Owner" : { "shape" : "__string", "locationName" : "owner", "documentation" : "\n

The owner of the VPC Connection.

" }, "UserIdentity" : { "shape" : "UserIdentity", "locationName" : "userIdentity", "documentation" : "\n

Description of the requester that calls the API operation.

" }, "VpcConnectionArn" : { "shape" : "__string", "locationName" : "vpcConnectionArn", "documentation" : "\n

The Amazon Resource Name (ARN) of the VPC connection.

" } }, "documentation" : "Description of the VPC connection." }, "VpcConnectionState": { "type": "string", "documentation": "\n

The state of a VPC connection.

\n ", "enum": [ "CREATING", "AVAILABLE", "INACTIVE", "DEACTIVATING", "DELETING", "FAILED", "REJECTED", "REJECTING" ] }, "VpcConnectivity" : { "type" : "structure", "members" : { "ClientAuthentication": { "shape": "VpcConnectivityClientAuthentication", "locationName": "clientAuthentication", "documentation": "\n

Includes all client authentication information for VPC connectivity.

\n " } }, "documentation" : "VPC connectivity access control for brokers." }, "ZookeeperNodeInfo": { "type": "structure", "members": { "AttachedENIId": { "shape": "__string", "locationName": "attachedENIId", "documentation": "\n

The attached elastic network interface of the broker.

\n " }, "ClientVpcIpAddress": { "shape": "__string", "locationName": "clientVpcIpAddress", "documentation": "\n

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

\n " }, "Endpoints": { "shape": "__listOf__string", "locationName": "endpoints", "documentation": "\n

Endpoints for accessing the ZooKeeper.

\n " }, "ZookeeperId": { "shape": "__double", "locationName": "zookeeperId", "documentation": "\n

The role-specific ID for Zookeeper.

\n " }, "ZookeeperVersion": { "shape": "__string", "locationName": "zookeeperVersion", "documentation": "\n

The version of Zookeeper.

\n " } }, "documentation": "\n

Zookeeper node information.

\n " }, "__boolean": { "type": "boolean" }, "__blob": { "type": "blob" }, "__double": { "type": "double" }, "__integer": { "type": "integer" }, "__integerMin1Max15": { "type": "integer", "min": 1, "max": 15 }, "__integerMin1Max16384": { "type": "integer", "min": 1, "max": 16384 }, "__listOfBrokerEBSVolumeInfo": { "type": "list", "member": { "shape": "BrokerEBSVolumeInfo" } }, "__listOfClusterInfo": { "type": "list", "member": { "shape": "ClusterInfo" } }, "__listOfCluster": { "type": "list", "member": { "shape": "Cluster" } }, "__listOfClusterOperationInfo": { "type": "list", "member": { "shape": "ClusterOperationInfo" } }, "__listOfClusterOperationV2Summary" : { "type" : "list", "member" : { "shape" : "ClusterOperationV2Summary" } }, "__listOfClusterOperationStep" : { "type" : "list", "member" : { "shape" : "ClusterOperationStep" } }, "__listOfCompatibleKafkaVersion" : { "type" : "list", "member" : { "shape" : "CompatibleKafkaVersion" } }, "__listOfVpcConfig" : { "type" : "list", "member" : { "shape" : "VpcConfig" } }, "__listOfConfiguration": { "type": "list", "member": { "shape": "Configuration" } }, "__listOfConfigurationRevision": { "type": "list", "member": { "shape": "ConfigurationRevision" } }, "__listOfKafkaVersion": { "type": "list", "member": { "shape": "KafkaVersion" } }, "__listOfKafkaCluster": { "type": "list", "member": { "shape": "KafkaCluster" } }, "__listOfKafkaClusterDescription": { "type": "list", "member": { "shape": "KafkaClusterDescription" } }, "__listOfKafkaClusterSummary": { "type": "list", "member": { "shape": "KafkaClusterSummary" } }, "__listOfNodeInfo": { "type": "list", "member": { "shape": "NodeInfo" } }, "__listOfClientVpcConnection": { "type": "list", "member": { "shape": "ClientVpcConnection" } }, "__listOfReplicationInfo": { "type": "list", "member": { "shape": "ReplicationInfo" } }, "__listOfReplicationInfoDescription": { "type": "list", "member": { "shape": "ReplicationInfoDescription" } }, "__listOfReplicationInfoSummary": { "type": "list", "member": { "shape": "ReplicationInfoSummary" } }, "__listOfReplicatorSummary": { "type": "list", "member": { "shape": "ReplicatorSummary" } }, "__listOfVpcConnection": { "type": "list", "member": { "shape": "VpcConnection" } }, "__listOfUnprocessedScramSecret" : { "type" : "list", "member" : { "shape" : "UnprocessedScramSecret" } }, "__listOf__string": { "type": "list", "member": { "shape": "__string" } }, "__long": { "type": "long" }, "__mapOf__string": { "type": "map", "key": { "shape": "__string" }, "value": { "shape": "__string" } }, "__listOf__stringMax249": { "type": "list", "member": { "shape": "__stringMax249" } }, "__listOf__stringMax256": { "type": "list", "member": { "shape": "__stringMax256" } }, "__string": { "type": "string" }, "__stringMax1024": { "type": "string", "max": 1024 }, "__stringMax249": { "type": "string", "max": 249 }, "__stringMax256": { "type": "string", "max": 256 }, "__stringMin1Max128": { "type": "string", "min": 1, "max": 128 }, "__stringMin1Max64": { "type": "string", "min": 1, "max": 64 }, "__stringMin5Max32": { "type": "string", "min": 5, "max": 32 }, "__stringMin1Max128Pattern09AZaZ09AZaZ0": { "type": "string", "min": 1, "max": 128, "pattern": "^[0-9A-Za-z][0-9A-Za-z-]{0,}$" }, "__timestampIso8601": { "type": "timestamp", "timestampFormat": "iso8601" }, "__timestampUnix": { "type": "timestamp", "timestampFormat": "unixTimestamp" } }, "documentation": "\n

The operations for managing an Amazon MSK cluster.

\n "