{ "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": { "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": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n503 response
\n " }, { "shape": "TooManyRequestsException", "documentation": "\n429 response
\n " }, { "shape": "ConflictException", "documentation": "\nThis cluster name already exists. Retry your request using another name.
\n " } ], "documentation": "\nCreates a new MSK cluster.
\n " }, "CreateConfiguration": { "name": "CreateConfiguration", "http": { "method": "POST", "requestUri": "/v1/configurations", "responseCode": 200 }, "input": { "shape": "CreateConfigurationRequest" }, "output": { "shape": "CreateConfigurationResponse", "documentation": "\n200 response
\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n503 response
\n " }, { "shape": "TooManyRequestsException", "documentation": "\n429 response
\n " }, { "shape": "ConflictException", "documentation": "\nThis cluster name already exists. Retry your request using another name.
\n " } ], "documentation": "\nCreates a new MSK configuration.
\n " }, "DeleteCluster": { "name": "DeleteCluster", "http": { "method": "DELETE", "requestUri": "/v1/clusters/{clusterArn}", "responseCode": 200 }, "input": { "shape": "DeleteClusterRequest" }, "output": { "shape": "DeleteClusterResponse", "documentation": "\nSuccessful response.
\n " }, "errors": [ { "shape": "NotFoundException", "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " }, { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " } ], "documentation": "\nDeletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
\n " }, "DescribeCluster": { "name": "DescribeCluster", "http": { "method": "GET", "requestUri": "/v1/clusters/{clusterArn}", "responseCode": 200 }, "input": { "shape": "DescribeClusterRequest" }, "output": { "shape": "DescribeClusterResponse", "documentation": "\nSuccessful response.
\n " }, "errors": [ { "shape": "NotFoundException", "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " }, { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " } ], "documentation": "\nReturns 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": "\n200 response
\n " }, "errors": [ { "shape": "NotFoundException", "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " }, { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " } ], "documentation": "\nReturns 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": "\n200 response
\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " }, { "shape": "NotFoundException", "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n503 response
\n " } ], "documentation": "\nReturns 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": "\n200 response
\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " }, { "shape": "NotFoundException", "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n503 response
\n " } ], "documentation": "\nReturns a description of this revision of the configuration.
\n " }, "GetBootstrapBrokers": { "name": "GetBootstrapBrokers", "http": { "method": "GET", "requestUri": "/v1/clusters/{clusterArn}/bootstrap-brokers", "responseCode": 200 }, "input": { "shape": "GetBootstrapBrokersRequest" }, "output": { "shape": "GetBootstrapBrokersResponse", "documentation": "\nSuccessful response.
\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "ConflictException", "documentation": "\nThis cluster name already exists. Retry your request using another name.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " } ], "documentation": "\nA list of brokers that a client application can use to bootstrap.
\n " }, "ListClusterOperations": { "name": "ListClusterOperations", "http": { "method": "GET", "requestUri": "/v1/clusters/{clusterArn}/operations", "responseCode": 200 }, "input": { "shape": "ListClusterOperationsRequest" }, "output": { "shape": "ListClusterOperationsResponse", "documentation": "\nSuccessful response.
\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " } ], "documentation": "\nReturns 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": "\nSuccessful response.
\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " } ], "documentation": "\nReturns 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": "\n200 response
\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " }, { "shape": "NotFoundException", "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n503 response
\n " } ], "documentation": "\nReturns 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": "\n200 response
\n " }, "errors": [ { "shape": "ServiceUnavailableException", "documentation": "\n503 response
\n " }, { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " } ], "documentation": "\nReturns 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": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " } ], "documentation": "\nReturns a list of Kafka versions.
\n " }, "ListNodes": { "name": "ListNodes", "http": { "method": "GET", "requestUri": "/v1/clusters/{clusterArn}/nodes", "responseCode": 200 }, "input": { "shape": "ListNodesRequest" }, "output": { "shape": "ListNodesResponse", "documentation": "\nSuccessful response.
\n " }, "errors": [ { "shape": "NotFoundException", "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " }, { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " } ], "documentation": "\nReturns a list of the broker nodes in the cluster.
\n " }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "GET", "requestUri": "/v1/tags/{resourceArn}", "responseCode": 200 }, "input": { "shape": "ListTagsForResourceRequest" }, "output": { "shape": "ListTagsForResourceResponse", "documentation": "\nSuccess response.
\n " }, "errors": [ { "shape": "NotFoundException", "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " }, { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " } ], "documentation": "\nReturns a list of the tags associated with the specified resource.
\n " }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/v1/tags/{resourceArn}", "responseCode": 204 }, "input": { "shape": "TagResourceRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " }, { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " } ], "documentation": "\nAdds 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": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " }, { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " } ], "documentation": "\nRemoves 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": "\nSuccessful response.
\n " }, "errors": [ { "shape": "ServiceUnavailableException", "documentation": "\n503 response
\n " }, { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " } ], "documentation": "\nUpdates the number of broker nodes in the cluster.
\n " }, "UpdateBrokerStorage": { "name": "UpdateBrokerStorage", "http": { "method": "PUT", "requestUri": "/v1/clusters/{clusterArn}/nodes/storage", "responseCode": 200 }, "input": { "shape": "UpdateBrokerStorageRequest" }, "output": { "shape": "UpdateBrokerStorageResponse", "documentation": "\nSuccessful response.
\n " }, "errors": [ { "shape": "ServiceUnavailableException", "documentation": "\n503 response
\n " }, { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " } ], "documentation": "\nUpdates the EBS storage associated with MSK brokers.
\n " }, "UpdateClusterConfiguration": { "name": "UpdateClusterConfiguration", "http": { "method": "PUT", "requestUri": "/v1/clusters/{clusterArn}/configuration", "responseCode": 200 }, "input": { "shape": "UpdateClusterConfigurationRequest" }, "output": { "shape": "UpdateClusterConfigurationResponse", "documentation": "\nSuccessful response.
\n " }, "errors": [ { "shape": "BadRequestException", "documentation": "\nThe request isn't valid because the input is incorrect. Correct your input and then submit it again.
\n " }, { "shape": "UnauthorizedException", "documentation": "\nThe request is not authorized. The provided credentials couldn't be validated.
\n " }, { "shape": "InternalServerErrorException", "documentation": "\nThere was an unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape": "ForbiddenException", "documentation": "\nAccess forbidden. Check your credentials and then retry your request.
\n " }, { "shape": "NotFoundException", "documentation": "\nThe resource could not be found due to incorrect input. Correct the input, then retry the request.
\n " }, { "shape": "ServiceUnavailableException", "documentation": "\n503 response
\n " } ], "documentation": "\nUpdates the cluster with the configuration that is specified in the request body.
\n " }, "UpdateMonitoring" : { "name" : "UpdateMonitoring", "http" : { "method" : "PUT", "requestUri" : "/v1/clusters/{clusterArn}/monitoring", "responseCode" : 200 }, "input" : { "shape" : "UpdateMonitoringRequest" }, "output" : { "shape" : "UpdateMonitoringResponse", "documentation" : "\nHTTP Status Code 200: OK.
\n " }, "errors" : [ { "shape" : "ServiceUnavailableException", "documentation" : "\nHTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.
\n " }, { "shape" : "BadRequestException", "documentation" : "\nHTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
\n " }, { "shape" : "UnauthorizedException", "documentation" : "\nHTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
\n " }, { "shape" : "InternalServerErrorException", "documentation" : "\nHTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
\n " }, { "shape" : "ForbiddenException", "documentation" : "\nHTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
\n " } ], "documentation" : "\nUpdates 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 " } }, "shapes": { "BadRequestException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\nThe parameter that caused the error.
\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\nThe description of the error.
\n " } }, "documentation": "\nReturns information about an error.
\n ", "exception": true, "error": { "httpStatusCode": 400 } }, "BrokerAZDistribution": { "type": "string", "documentation": "\nThe 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.
\nAmazon 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": "\nThe ID of the broker to update.
\n " }, "VolumeSizeGB": { "shape": "__integer", "locationName": "volumeSizeGB", "documentation": "\nSize of the EBS volume to update.
\n " } }, "documentation": "\nSpecifies 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": [ "VolumeSizeGB", "KafkaBrokerNodeId" ] }, "BrokerNodeGroupInfo": { "type": "structure", "members": { "BrokerAZDistribution": { "shape": "BrokerAZDistribution", "locationName": "brokerAZDistribution", "documentation": "\nThe 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.
\nAmazon 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": "\nThe 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 be in Availability Zone us-east-1e.
\n " }, "InstanceType": { "shape": "__stringMin5Max32", "locationName": "instanceType", "documentation": "\nThe type of Amazon EC2 instances to use for 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": "\nThe 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": "\nContains information about storage volumes attached to MSK broker nodes.
\n " } }, "documentation": "\nDescribes the setup to be used for Kafka broker nodes in the cluster.
\n ", "required": [ "ClientSubnets", "InstanceType" ] }, "BrokerNodeInfo": { "type": "structure", "members": { "AttachedENIId": { "shape": "__string", "locationName": "attachedENIId", "documentation": "\nThe attached elastic network interface of the broker.
\n " }, "BrokerId": { "shape": "__double", "locationName": "brokerId", "documentation": "\nThe ID of the broker.
\n " }, "ClientSubnet": { "shape": "__string", "locationName": "clientSubnet", "documentation": "\nThe client subnet to which this broker node belongs.
\n " }, "ClientVpcIpAddress": { "shape": "__string", "locationName": "clientVpcIpAddress", "documentation": "\nThe virtual private cloud (VPC) of the client.
\n " }, "CurrentBrokerSoftwareInfo": { "shape": "BrokerSoftwareInfo", "locationName": "currentBrokerSoftwareInfo", "documentation": "\nInformation about the version of software currently deployed on the Kafka brokers in the cluster.
\n " }, "Endpoints": { "shape": "__listOf__string", "locationName": "endpoints", "documentation": "\nEndpoints for accessing the broker.
\n " } }, "documentation": "\nBrokerNodeInfo
\n " }, "BrokerSoftwareInfo": { "type": "structure", "members": { "ConfigurationArn": { "shape": "__string", "locationName": "configurationArn", "documentation": "\nThe 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": "\nThe revision of the configuration to use. This field isn't visible in this preview release.
\n " }, "KafkaVersion": { "shape": "__string", "locationName": "kafkaVersion", "documentation": "\nThe version of Apache Kafka.
\n " } }, "documentation": "\nInformation about the current software installed on the cluster.
\n " }, "ClientAuthentication": { "type": "structure", "members": { "Tls": { "shape": "Tls", "locationName": "tls", "documentation": "\nDetails for ClientAuthentication using TLS.
\n " } }, "documentation": "\nIncludes all client authentication information.
\n " }, "ClientBroker": { "type": "string", "documentation": "\nClient-broker encryption in transit setting.
\n ", "enum": [ "TLS", "TLS_PLAINTEXT", "PLAINTEXT" ] }, "ClusterInfo": { "type": "structure", "members": { "ActiveOperationArn": { "shape": "__string", "locationName": "activeOperationArn", "documentation": "\nArn of active cluster operation.
\n " }, "BrokerNodeGroupInfo": { "shape": "BrokerNodeGroupInfo", "locationName": "brokerNodeGroupInfo", "documentation": "\nInformation about the broker nodes.
\n " }, "ClientAuthentication": { "shape": "ClientAuthentication", "locationName": "clientAuthentication", "documentation": "\nIncludes all client authentication information.
\n " }, "ClusterArn": { "shape": "__string", "locationName": "clusterArn", "documentation": "\nThe Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n " }, "ClusterName": { "shape": "__string", "locationName": "clusterName", "documentation": "\nThe name of the cluster.
\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\nThe time when the cluster was created.
\n " }, "CurrentBrokerSoftwareInfo": { "shape": "BrokerSoftwareInfo", "locationName": "currentBrokerSoftwareInfo", "documentation": "\nInformation about the version of software currently deployed on the Kafka brokers in the cluster.
\n " }, "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation": "\nThe current version of the MSK cluster.
\n " }, "EncryptionInfo": { "shape": "EncryptionInfo", "locationName": "encryptionInfo", "documentation": "\nIncludes all encryption-related information.
\n " }, "EnhancedMonitoring": { "shape": "EnhancedMonitoring", "locationName": "enhancedMonitoring", "documentation": "\nSpecifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.
\n " }, "OpenMonitoring" : { "shape" : "OpenMonitoring", "locationName" : "openMonitoring", "documentation" : "\nSettings for open monitoring using Prometheus.
\n " }, "NumberOfBrokerNodes": { "shape": "__integer", "locationName": "numberOfBrokerNodes", "documentation": "\nThe number of broker nodes in the cluster.
\n " }, "State": { "shape": "ClusterState", "locationName": "state", "documentation": "\nThe state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
\n " }, "StateInfo" : { "shape" : "StateInfo", "locationName" : "stateInfo" }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "\nTags attached to the cluster.
\n " }, "ZookeeperConnectString": { "shape": "__string", "locationName": "zookeeperConnectString", "documentation": "\nThe connection string to use to connect to the Apache ZooKeeper cluster.
\n " } }, "documentation": "\nReturns information about a cluster.
\n " }, "ClusterOperationInfo": { "type": "structure", "members": { "ClientRequestId": { "shape": "__string", "locationName": "clientRequestId", "documentation": "\nThe ID of the API request that triggered this operation.
\n " }, "ClusterArn": { "shape": "__string", "locationName": "clusterArn", "documentation": "\nARN of the cluster.
\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\nThe time that the operation was created.
\n " }, "EndTime": { "shape": "__timestampIso8601", "locationName": "endTime", "documentation": "\nThe time at which the operation finished.
\n " }, "ErrorInfo": { "shape": "ErrorInfo", "locationName": "errorInfo", "documentation": "\nDescribes the error if the operation fails.
\n " }, "OperationArn": { "shape": "__string", "locationName": "operationArn", "documentation": "\nARN of the cluster operation.
\n " }, "OperationState": { "shape": "__string", "locationName": "operationState", "documentation": "\nState of the cluster operation.
\n " }, "OperationType": { "shape": "__string", "locationName": "operationType", "documentation": "\nType of the cluster operation.
\n " }, "SourceClusterInfo": { "shape": "MutableClusterInfo", "locationName": "sourceClusterInfo", "documentation": "\nInformation about cluster attributes before a cluster is updated.
\n " }, "TargetClusterInfo": { "shape": "MutableClusterInfo", "locationName": "targetClusterInfo", "documentation": "\nInformation about cluster attributes after a cluster is updated.
\n " } }, "documentation": "\nReturns information about a cluster operation.
\n " }, "ClusterState": { "type": "string", "documentation": "\nThe state of a Kafka cluster.
\n ", "enum": [ "ACTIVE", "CREATING", "UPDATING", "DELETING", "FAILED" ] }, "Configuration": { "type": "structure", "members": { "Arn": { "shape": "__string", "locationName": "arn", "documentation": "\nThe Amazon Resource Name (ARN) of the configuration.
\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\nThe time when the configuration was created.
\n " }, "Description": { "shape": "__string", "locationName": "description", "documentation": "\nThe description of the configuration.
\n " }, "KafkaVersions": { "shape": "__listOf__string", "locationName": "kafkaVersions", "documentation": "\nAn 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": "\nLatest revision of the configuration.
\n " }, "Name": { "shape": "__string", "locationName": "name", "documentation": "\nThe name of the configuration.
\n " } }, "documentation": "\nRepresents an MSK Configuration.
\n ", "required": [ "Description", "LatestRevision", "CreationTime", "KafkaVersions", "Arn", "Name" ] }, "ConfigurationInfo": { "type": "structure", "members": { "Arn": { "shape": "__string", "locationName": "arn", "documentation": "\nARN of the configuration to use.
\n " }, "Revision": { "shape": "__long", "locationName": "revision", "documentation": "\nThe revision of the configuration to use.
\n " } }, "documentation": "\nSpecifies the configuration to use for the brokers.
\n ", "required": [ "Revision", "Arn" ] }, "ConfigurationRevision": { "type": "structure", "members": { "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\nThe time when the configuration revision was created.
\n " }, "Description": { "shape": "__string", "locationName": "description", "documentation": "\nThe description of the configuration revision.
\n " }, "Revision": { "shape": "__long", "locationName": "revision", "documentation": "\nThe revision number.
\n " } }, "documentation": "\nDescribes a configuration revision.
\n ", "required": [ "Revision", "CreationTime" ] }, "ConflictException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\nThe parameter that caused the error.
\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\nThe description of the error.
\n " } }, "documentation": "\nReturns information about an error.
\n ", "exception": true, "error": { "httpStatusCode": 409 } }, "CreateClusterRequest": { "type": "structure", "members": { "BrokerNodeGroupInfo": { "shape": "BrokerNodeGroupInfo", "locationName": "brokerNodeGroupInfo", "documentation": "\nInformation about the broker nodes in the cluster.
\n " }, "ClientAuthentication": { "shape": "ClientAuthentication", "locationName": "clientAuthentication", "documentation": "\nIncludes all client authentication related information.
\n " }, "ClusterName": { "shape": "__stringMin1Max64", "locationName": "clusterName", "documentation": "\nThe name of the cluster.
\n " }, "ConfigurationInfo": { "shape": "ConfigurationInfo", "locationName": "configurationInfo", "documentation": "\nRepresents the configuration that you want MSK to use for the brokers in a cluster.
\n " }, "EncryptionInfo": { "shape": "EncryptionInfo", "locationName": "encryptionInfo", "documentation": "\nIncludes all encryption-related information.
\n " }, "EnhancedMonitoring": { "shape": "EnhancedMonitoring", "locationName": "enhancedMonitoring", "documentation": "\nSpecifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.
\n " }, "OpenMonitoring" : { "shape" : "OpenMonitoringInfo", "locationName" : "openMonitoring", "documentation" : "\nThe settings for open monitoring.
\n " }, "KafkaVersion": { "shape": "__stringMin1Max128", "locationName": "kafkaVersion", "documentation": "\nThe version of Apache Kafka.
\n " }, "NumberOfBrokerNodes": { "shape": "__integerMin1Max15", "locationName": "numberOfBrokerNodes", "documentation": "\nThe number of broker nodes in the cluster.
\n " }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "\nCreate tags when creating the cluster.
\n " } }, "required": [ "BrokerNodeGroupInfo", "KafkaVersion", "NumberOfBrokerNodes", "ClusterName" ] }, "CreateClusterResponse": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "locationName": "clusterArn", "documentation": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " }, "ClusterName": { "shape": "__string", "locationName": "clusterName", "documentation": "\nThe name of the MSK cluster.
\n " }, "State": { "shape": "ClusterState", "locationName": "state", "documentation": "\nThe state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
\n " } } }, "CreateConfigurationRequest": { "type": "structure", "members": { "Description": { "shape": "__string", "locationName": "description", "documentation": "\nThe description of the configuration.
\n " }, "KafkaVersions": { "shape": "__listOf__string", "locationName": "kafkaVersions", "documentation": "\nThe versions of Apache Kafka with which you can use this MSK configuration.
\n " }, "Name": { "shape": "__string", "locationName": "name", "documentation": "\nThe name of the configuration.
\n " }, "ServerProperties": { "shape": "__blob", "locationName": "serverProperties", "documentation": "\nContents of the
The Amazon Resource Name (ARN) of the configuration.
\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\nThe time when the configuration was created.
\n " }, "LatestRevision": { "shape": "ConfigurationRevision", "locationName": "latestRevision", "documentation": "\nLatest revision of the configuration.
\n " }, "Name": { "shape": "__string", "locationName": "name", "documentation": "\nThe name of the configuration.
\n " } } }, "DeleteClusterRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\nThe Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n " }, "CurrentVersion": { "shape": "__string", "location": "querystring", "locationName": "currentVersion", "documentation": "\nThe current version of the MSK cluster.
\n " } }, "required": [ "ClusterArn" ] }, "DeleteClusterResponse": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "locationName": "clusterArn", "documentation": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " }, "State": { "shape": "ClusterState", "locationName": "state", "documentation": "\nThe state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
\n " } } }, "DescribeClusterOperationRequest": { "type": "structure", "members": { "ClusterOperationArn": { "shape": "__string", "location": "uri", "locationName": "clusterOperationArn", "documentation": "\nThe Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.
\n " } }, "required": [ "ClusterOperationArn" ] }, "DescribeClusterOperationResponse": { "type": "structure", "members": { "ClusterOperationInfo": { "shape": "ClusterOperationInfo", "locationName": "clusterOperationInfo", "documentation": "\nCluster operation information
\n " } } }, "DescribeClusterRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\nThe Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n " } }, "required": [ "ClusterArn" ] }, "DescribeClusterResponse": { "type": "structure", "members": { "ClusterInfo": { "shape": "ClusterInfo", "locationName": "clusterInfo", "documentation": "\nThe cluster information.
\n " } } }, "DescribeConfigurationRequest": { "type": "structure", "members": { "Arn": { "shape": "__string", "location": "uri", "locationName": "arn", "documentation": "\nThe 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": "\nThe Amazon Resource Name (ARN) of the configuration.
\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\nThe time when the configuration was created.
\n " }, "Description": { "shape": "__string", "locationName": "description", "documentation": "\nThe description of the configuration.
\n " }, "KafkaVersions": { "shape": "__listOf__string", "locationName": "kafkaVersions", "documentation": "\nThe versions of Apache Kafka with which you can use this MSK configuration.
\n " }, "LatestRevision": { "shape": "ConfigurationRevision", "locationName": "latestRevision", "documentation": "\nLatest revision of the configuration.
\n " }, "Name": { "shape": "__string", "locationName": "name", "documentation": "\nThe name of the configuration.
\n " } } }, "DescribeConfigurationRevisionRequest": { "type": "structure", "members": { "Arn": { "shape": "__string", "location": "uri", "locationName": "arn", "documentation": "\nThe Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
\n " }, "Revision": { "shape": "__long", "location": "uri", "locationName": "revision", "documentation": "\nA string that uniquely identifies a revision of an MSK configuration.
\n " } }, "required": [ "Revision", "Arn" ] }, "DescribeConfigurationRevisionResponse": { "type": "structure", "members": { "Arn": { "shape": "__string", "locationName": "arn", "documentation": "\nThe Amazon Resource Name (ARN) of the configuration.
\n " }, "CreationTime": { "shape": "__timestampIso8601", "locationName": "creationTime", "documentation": "\nThe time when the configuration was created.
\n " }, "Description": { "shape": "__string", "locationName": "description", "documentation": "\nThe description of the configuration.
\n " }, "Revision": { "shape": "__long", "locationName": "revision", "documentation": "\nThe revision number.
\n " }, "ServerProperties": { "shape": "__blob", "locationName": "serverProperties", "documentation": "\nContents of the
The size in GiB of the EBS volume for the data drive on each broker node.
\n " } }, "documentation": "\nContains information about the EBS storage volumes attached to Kafka broker nodes.
\n " }, "EncryptionAtRest": { "type": "structure", "members": { "DataVolumeKMSKeyId": { "shape": "__string", "locationName": "dataVolumeKMSKeyId", "documentation": "\nThe 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": "\nThe data-volume encryption details.
\n ", "required": [ "DataVolumeKMSKeyId" ] }, "EncryptionInTransit": { "type": "structure", "members": { "ClientBroker": { "shape": "ClientBroker", "locationName": "clientBroker", "documentation": "\nIndicates 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.
\nThe default value is TLS_PLAINTEXT.
\n " }, "InCluster": { "shape": "__boolean", "locationName": "inCluster", "documentation": "\nWhen 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.
\nThe default value is true.
\n " } }, "documentation": "\nThe settings for encrypting data in transit.
\n " }, "EncryptionInfo": { "type": "structure", "members": { "EncryptionAtRest": { "shape": "EncryptionAtRest", "locationName": "encryptionAtRest", "documentation": "\nThe data-volume encryption details.
\n " }, "EncryptionInTransit": { "shape": "EncryptionInTransit", "locationName": "encryptionInTransit", "documentation": "\nThe details for encryption in transit.
\n " } }, "documentation": "\nIncludes 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": "\nSpecifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.
\n ", "enum": [ "DEFAULT", "PER_BROKER", "PER_TOPIC_PER_BROKER" ] }, "Error": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\nThe parameter that caused the error.
\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\nThe description of the error.
\n " } }, "documentation": "\nReturns information about an error.
\n " }, "ErrorInfo": { "type": "structure", "members": { "ErrorCode": { "shape": "__string", "locationName": "errorCode", "documentation": "\nA number describing the error programmatically.
\n " }, "ErrorString": { "shape": "__string", "locationName": "errorString", "documentation": "\nAn optional field to provide more details about the error.
\n " } }, "documentation": "\nReturns information about an error state of the cluster.
\n " }, "ForbiddenException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\nThe parameter that caused the error.
\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\nThe description of the error.
\n " } }, "documentation": "\nReturns information about an error.
\n ", "exception": true, "error": { "httpStatusCode": 403 } }, "GetBootstrapBrokersRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\nThe Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n " } }, "required": [ "ClusterArn" ] }, "GetBootstrapBrokersResponse": { "type": "structure", "members": { "BootstrapBrokerString": { "shape": "__string", "locationName": "bootstrapBrokerString", "documentation": "\nA string containing one or more hostname:port pairs.
\n " }, "BootstrapBrokerStringTls": { "shape": "__string", "locationName": "bootstrapBrokerStringTls", "documentation": "\nA string containing one or more DNS names (or IP) and TLS port pairs.
\n " } } }, "InternalServerErrorException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\nThe parameter that caused the error.
\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\nThe description of the error.
\n " } }, "documentation": "\nReturns information about an error.
\n ", "exception": true, "error": { "httpStatusCode": 500 } }, "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": "\nThe Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n " }, "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "\nThe 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": "\nThe 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" ] }, "ListClusterOperationsResponse": { "type": "structure", "members": { "ClusterOperationInfoList": { "shape": "__listOfClusterOperationInfo", "locationName": "clusterOperationInfoList", "documentation": "\nAn array of cluster operation information objects.
\n " }, "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "\nIf 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 " } } }, "ListClustersRequest": { "type": "structure", "members": { "ClusterNameFilter": { "shape": "__string", "location": "querystring", "locationName": "clusterNameFilter", "documentation": "\nSpecify 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": "\nThe 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": "\nThe 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": "\nInformation on each of the MSK clusters in the response.
\n " }, "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "\nThe 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": "\nThe Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
\n " }, "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "\nThe 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": "\nThe 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": "\nPaginated results marker.
\n " }, "Revisions": { "shape": "__listOfConfigurationRevision", "locationName": "revisions", "documentation": "\nList of ConfigurationRevision objects.
\n " } } }, "ListConfigurationsRequest": { "type": "structure", "members": { "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "\nThe 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": "\nThe 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": "\nAn array of MSK configurations.
\n " }, "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "\nThe 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": "\nThe 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": "\nThe 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": "\nThe Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n " }, "MaxResults": { "shape": "MaxResults", "location": "querystring", "locationName": "maxResults", "documentation": "\nThe 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": "\nThe 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": "\nThe 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": "\nList containing a NodeInfo object.
\n " } } }, "ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "shape": "__string", "location": "uri", "locationName": "resourceArn", "documentation": "\nThe 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": "\nThe key-value pair for the resource tag.
\n " } } }, "MaxResults": { "type": "integer", "min": 1, "max": 100 }, "MutableClusterInfo": { "type": "structure", "members": { "BrokerEBSVolumeInfo": { "shape": "__listOfBrokerEBSVolumeInfo", "locationName": "brokerEBSVolumeInfo", "documentation": "\nSpecifies the size of the EBS volume and the ID of the associated broker.
\n " }, "ConfigurationInfo": { "shape": "ConfigurationInfo", "locationName": "configurationInfo", "documentation": "\nInformation about the changes in the configuration of the brokers.
\n " }, "NumberOfBrokerNodes": { "shape": "__integer", "locationName": "numberOfBrokerNodes", "documentation": "\nThe number of broker nodes in the cluster.
\n " }, "EnhancedMonitoring" : { "shape" : "EnhancedMonitoring", "locationName" : "enhancedMonitoring", "documentation" : "\nSpecifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
\n " }, "OpenMonitoring" : { "shape" : "OpenMonitoring", "locationName" : "openMonitoring", "documentation" : "\nThe settings for open monitoring.
\n " } }, "documentation": "\nInformation about cluster attributes that can be updated via update APIs.
\n " }, "NodeExporter" : { "type" : "structure", "members" : { "EnabledInBroker" : { "shape" : "__boolean", "locationName" : "enabledInBroker", "documentation" : "\nIndicates whether you want to enable or disable the Node Exporter.
\n " } }, "documentation" : "\nIndicates whether you want to enable or disable the Node Exporter.
\n ", "required" : [ "EnabledInBroker" ] }, "NodeExporterInfo" : { "type" : "structure", "members" : { "EnabledInBroker" : { "shape" : "__boolean", "locationName" : "enabledInBroker", "documentation" : "\nIndicates whether you want to enable or disable the Node Exporter.
\n " } }, "documentation" : "\nIndicates whether you want to enable or disable the Node Exporter.
\n ", "required" : [ "EnabledInBroker" ] }, "JmxExporter" : { "type" : "structure", "members" : { "EnabledInBroker" : { "shape" : "__boolean", "locationName" : "enabledInBroker", "documentation" : "\nIndicates whether you want to enable or disable the JMX Exporter.
\n " } }, "documentation" : "\nIndicates whether you want to enable or disable the JMX Exporter.
\n ", "required" : [ "EnabledInBroker" ] }, "JmxExporterInfo" : { "type" : "structure", "members" : { "EnabledInBroker" : { "shape" : "__boolean", "locationName" : "enabledInBroker", "documentation" : "\nIndicates whether you want to enable or disable the JMX Exporter.
\n " } }, "documentation" : "\nIndicates whether you want to enable or disable the JMX Exporter.
\n ", "required" : [ "EnabledInBroker" ] }, "OpenMonitoring" : { "type" : "structure", "members" : { "Prometheus" : { "shape" : "Prometheus", "locationName" : "prometheus", "documentation" : "\nPrometheus settings.
\n " } }, "documentation" : "\nJMX and Node monitoring for the MSK cluster.
\n ", "required" : [ "Prometheus" ] }, "OpenMonitoringInfo" : { "type" : "structure", "members" : { "Prometheus" : { "shape" : "PrometheusInfo", "locationName" : "prometheus", "documentation" : "\nPrometheus settings.
\n " } }, "documentation" : "\nJMX and Node monitoring for the MSK cluster.
\n ", "required" : [ "Prometheus" ] }, "Prometheus" : { "type" : "structure", "members" : { "JmxExporter" : { "shape" : "JmxExporter", "locationName" : "jmxExporter", "documentation" : "\nIndicates whether you want to enable or disable the JMX Exporter.
\n " }, "NodeExporter" : { "shape" : "NodeExporter", "locationName" : "nodeExporter", "documentation" : "\nIndicates whether you want to enable or disable the Node Exporter.
\n " } }, "documentation" : "\nPrometheus settings.
\n " }, "PrometheusInfo" : { "type" : "structure", "members" : { "JmxExporter" : { "shape" : "JmxExporterInfo", "locationName" : "jmxExporter", "documentation" : "\nIndicates whether you want to enable or disable the JMX Exporter.
\n " }, "NodeExporter" : { "shape" : "NodeExporterInfo", "locationName" : "nodeExporter", "documentation" : "\nIndicates whether you want to enable or disable the Node Exporter.
\n " } }, "documentation" : "\nPrometheus settings.
\n " }, "NodeInfo": { "type": "structure", "members": { "AddedToClusterTime": { "shape": "__string", "locationName": "addedToClusterTime", "documentation": "\nThe start time.
\n " }, "BrokerNodeInfo": { "shape": "BrokerNodeInfo", "locationName": "brokerNodeInfo", "documentation": "\nThe broker node info.
\n " }, "InstanceType": { "shape": "__string", "locationName": "instanceType", "documentation": "\nThe instance type.
\n " }, "NodeARN": { "shape": "__string", "locationName": "nodeARN", "documentation": "\nThe Amazon Resource Name (ARN) of the node.
\n " }, "NodeType": { "shape": "NodeType", "locationName": "nodeType", "documentation": "\nThe node type.
\n " }, "ZookeeperNodeInfo": { "shape": "ZookeeperNodeInfo", "locationName": "zookeeperNodeInfo", "documentation": "\nThe ZookeeperNodeInfo.
\n " } }, "documentation": "\nThe node information object.
\n " }, "NodeType": { "type": "string", "documentation": "\nThe broker or Zookeeper node.
\n ", "enum": [ "BROKER" ] }, "NotFoundException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\nThe parameter that caused the error.
\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\nThe description of the error.
\n " } }, "documentation": "\nReturns information about an error.
\n ", "exception": true, "error": { "httpStatusCode": 404 } }, "ServiceUnavailableException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\nThe parameter that caused the error.
\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\nThe description of the error.
\n " } }, "documentation": "\nReturns 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": "\nEBS volume information.
\n " } }, "documentation": "\nContains information about storage volumes attached to MSK broker nodes.
\n " }, "TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "shape": "__string", "location": "uri", "locationName": "resourceArn", "documentation": "\nThe Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.
\n " }, "Tags": { "shape": "__mapOf__string", "locationName": "tags", "documentation": "\nThe key-value pair for the resource tag.
\n " } }, "required": [ "ResourceArn", "Tags" ] }, "Tls": { "type": "structure", "members": { "CertificateAuthorityArnList": { "shape": "__listOf__string", "locationName": "certificateAuthorityArnList", "documentation": "\nList of ACM Certificate Authority ARNs.
\n " } }, "documentation": "\nDetails for client authentication using TLS.
\n " }, "TooManyRequestsException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\nThe parameter that caused the error.
\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\nThe description of the error.
\n " } }, "documentation": "\nReturns information about an error.
\n ", "exception": true, "error": { "httpStatusCode": 429 } }, "UnauthorizedException": { "type": "structure", "members": { "InvalidParameter": { "shape": "__string", "locationName": "invalidParameter", "documentation": "\nThe parameter that caused the error.
\n " }, "Message": { "shape": "__string", "locationName": "message", "documentation": "\nThe description of the error.
\n " } }, "documentation": "\nReturns information about an error.
\n ", "exception": true, "error": { "httpStatusCode": 401 } }, "UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "shape": "__string", "location": "uri", "locationName": "resourceArn", "documentation": "\nThe 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": "\nTag keys must be unique for a given cluster. In addition, the following restrictions apply:
\nEach 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.
\nYou 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.
\nTag keys must be between 1 and 128 Unicode characters in length.
\nTag keys must consist of the following characters: Unicode letters, digits,\n white space, and the following special characters: _ . / = + -\n @.
\nThe Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n " }, "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation": "\nThe version of cluster to update from. A successful operation will then generate a new version.
\n " }, "TargetNumberOfBrokerNodes": { "shape": "__integerMin1Max15", "locationName": "targetNumberOfBrokerNodes", "documentation": "\nThe 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": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " }, "ClusterOperationArn": { "shape": "__string", "locationName": "clusterOperationArn", "documentation": "\nThe Amazon Resource Name (ARN) of the cluster operation.
\n " } } }, "UpdateBrokerStorageRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\nThe Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n " }, "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation": "\nThe version of cluster to update from. A successful operation will then generate a new version.
\n " }, "TargetBrokerEBSVolumeInfo": { "shape": "__listOfBrokerEBSVolumeInfo", "locationName": "targetBrokerEBSVolumeInfo", "documentation": "\nDescribes 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": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " }, "ClusterOperationArn": { "shape": "__string", "locationName": "clusterOperationArn", "documentation": "\nThe Amazon Resource Name (ARN) of the cluster operation.
\n " } } }, "UpdateClusterConfigurationRequest": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "location": "uri", "locationName": "clusterArn", "documentation": "\nThe Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n " }, "ConfigurationInfo": { "shape": "ConfigurationInfo", "locationName": "configurationInfo", "documentation": "\nRepresents the configuration that you want MSK to use for the brokers in a cluster.
\n " }, "CurrentVersion": { "shape": "__string", "locationName": "currentVersion", "documentation": "\nThe version of the cluster that needs to be updated.
\n " } }, "required": [ "ClusterArn", "CurrentVersion", "ConfigurationInfo" ] }, "UpdateClusterConfigurationResponse": { "type": "structure", "members": { "ClusterArn": { "shape": "__string", "locationName": "clusterArn", "documentation": "\nThe Amazon Resource Name (ARN) of the cluster.
\n " }, "ClusterOperationArn": { "shape": "__string", "locationName": "clusterOperationArn", "documentation": "\nThe Amazon Resource Name (ARN) of the cluster operation.
\n " } } }, "UpdateMonitoringRequest" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "location" : "uri", "locationName" : "clusterArn", "documentation" : "\nThe Amazon Resource Name (ARN) that uniquely identifies the cluster.
\n " }, "CurrentVersion" : { "shape" : "__string", "locationName" : "currentVersion", "documentation" : "\nThe 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" : "\nSpecifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
\n " }, "OpenMonitoring" : { "shape" : "OpenMonitoringInfo", "locationName" : "openMonitoring", "documentation" : "\nThe settings for open monitoring.
\n " } }, "documentation" : "Request body for UpdateMonitoring.", "required" : [ "ClusterArn", "CurrentVersion" ] }, "UpdateMonitoringResponse" : { "type" : "structure", "members" : { "ClusterArn" : { "shape" : "__string", "locationName" : "clusterArn", "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster.
\n " }, "ClusterOperationArn" : { "shape" : "__string", "locationName" : "clusterOperationArn", "documentation" : "\nThe Amazon Resource Name (ARN) of the cluster operation.
\n " } } }, "ZookeeperNodeInfo": { "type": "structure", "members": { "AttachedENIId": { "shape": "__string", "locationName": "attachedENIId", "documentation": "\nThe attached elastic network interface of the broker.
\n " }, "ClientVpcIpAddress": { "shape": "__string", "locationName": "clientVpcIpAddress", "documentation": "\nThe virtual private cloud (VPC) IP address of the client.
\n " }, "Endpoints": { "shape": "__listOf__string", "locationName": "endpoints", "documentation": "\nEndpoints for accessing the ZooKeeper.
\n " }, "ZookeeperId": { "shape": "__double", "locationName": "zookeeperId", "documentation": "\nThe role-specific ID for Zookeeper.
\n " }, "ZookeeperVersion": { "shape": "__string", "locationName": "zookeeperVersion", "documentation": "\nThe version of Zookeeper.
\n " } }, "documentation": "\nZookeeper 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" } }, "__listOfClusterOperationInfo": { "type": "list", "member": { "shape": "ClusterOperationInfo" } }, "__listOfConfiguration": { "type": "list", "member": { "shape": "Configuration" } }, "__listOfConfigurationRevision": { "type": "list", "member": { "shape": "ConfigurationRevision" } }, "__listOfKafkaVersion": { "type": "list", "member": { "shape": "KafkaVersion" } }, "__listOfNodeInfo": { "type": "list", "member": { "shape": "NodeInfo" } }, "__listOf__string": { "type": "list", "member": { "shape": "__string" } }, "__long": { "type": "long" }, "__mapOf__string": { "type": "map", "key": { "shape": "__string" }, "value": { "shape": "__string" } }, "__string": { "type": "string" }, "__stringMin1Max128": { "type": "string", "min": 1, "max": 128 }, "__stringMin1Max64": { "type": "string", "min": 1, "max": 64 }, "__stringMin5Max32": { "type": "string", "min": 5, "max": 32 }, "__timestampIso8601": { "type": "timestamp", "timestampFormat": "iso8601" } }, "documentation": "\nThe operations for managing an Amazon MSK cluster.
\n " }