{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.kafka#AmazonMskCluster": { "type": "structure", "members": { "MskClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "mskClusterArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details of an Amazon MSK Cluster.

" } }, "com.amazonaws.kafka#ApacheKafkaCluster": { "type": "structure", "members": { "ApacheKafkaClusterId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The ID of the Apache Kafka cluster.

", "smithy.api#jsonName": "apacheKafkaClusterId", "smithy.api#required": {} } }, "BootstrapBrokerString": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The bootstrap broker string of the Apache Kafka cluster.

", "smithy.api#jsonName": "bootstrapBrokerString", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details of an Apache Kafka Cluster.

" } }, "com.amazonaws.kafka#AssessmentFinding": { "type": "structure", "members": { "Category": { "target": "com.amazonaws.kafka#FindingCategory", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The category of this finding.

", "smithy.api#jsonName": "category", "smithy.api#required": {} } }, "FindingId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

A deterministic content-based identifier for this finding. Generated from hash(category + resource + check_type). The same resource with the same problem always produces the same findingId across assessment runs.

", "smithy.api#jsonName": "findingId", "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Human-readable description of what is wrong, why it matters, and what to do.

", "smithy.api#jsonName": "message", "smithy.api#required": {} } }, "Remediation": { "target": "com.amazonaws.kafka#FindingRemediation", "traits": { "smithy.api#documentation": "

Guidance for resolving this finding. Absent when no specific remediation applies.

", "smithy.api#jsonName": "remediation" } }, "Resource": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The specific resource affected (e.g., topic name). Absent for cluster-level findings.

", "smithy.api#jsonName": "resource" } }, "Severity": { "target": "com.amazonaws.kafka#FindingSeverity", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The severity of this finding.

", "smithy.api#jsonName": "severity", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A single finding from an assessment, describing a specific issue or observation.

" } }, "com.amazonaws.kafka#AssessmentInfo": { "type": "structure", "members": { "AssessmentArn": { "target": "com.amazonaws.kafka#__stringMax2048", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the assessment.

", "smithy.api#jsonName": "assessmentArn" } }, "AssessmentType": { "target": "com.amazonaws.kafka#AssessmentType", "traits": { "smithy.api#documentation": "

The type of assessment.

", "smithy.api#jsonName": "assessmentType" } }, "ClusterArn": { "target": "com.amazonaws.kafka#__stringMax2048", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster that was assessed.

", "smithy.api#jsonName": "clusterArn" } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time when the assessment was created.

", "smithy.api#jsonName": "creationTime" } }, "Status": { "target": "com.amazonaws.kafka#AssessmentStatus", "traits": { "smithy.api#documentation": "

The current status of the assessment.

", "smithy.api#jsonName": "status" } }, "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#documentation": "

The tags attached to the assessment.

", "smithy.api#jsonName": "tags" } } }, "traits": { "smithy.api#documentation": "

Summary information about an assessment, returned by ListAssessments.

" } }, "com.amazonaws.kafka#AssessmentParameters": { "type": "structure", "members": { "TargetInstanceType": { "target": "com.amazonaws.kafka#__stringMax256", "traits": { "smithy.api#documentation": "

The target instance type to assess against (for example, express.m7g.large). Optional: when omitted, the assessment reports a recommended instance type as a CAPACITY finding. Supply it to assess readiness for a specific instance type.

", "smithy.api#jsonName": "targetInstanceType" } } }, "traits": { "smithy.api#documentation": "

Type-specific parameters for the assessment. All fields are optional.

" } }, "com.amazonaws.kafka#AssessmentStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } } }, "traits": { "smithy.api#documentation": "

The lifecycle status of an assessment.

" } }, "com.amazonaws.kafka#AssessmentSummary": { "type": "structure", "members": { "ByCategory": { "target": "com.amazonaws.kafka#__mapOf__integer", "traits": { "smithy.api#documentation": "

Count of findings grouped by category.

", "smithy.api#jsonName": "byCategory" } }, "BySeverity": { "target": "com.amazonaws.kafka#__mapOf__integer", "traits": { "smithy.api#documentation": "

Count of findings grouped by severity.

", "smithy.api#jsonName": "bySeverity" } }, "FindingsCapped": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

True when the assessment detected more findings than it stores. Resolve the reported findings and re-run the assessment to surface the remaining ones.

", "smithy.api#jsonName": "findingsCapped" } }, "HasBlockingFindings": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

True when the assessment detected at least one ERROR-severity finding. ERROR findings block the migration until resolved.

", "smithy.api#jsonName": "hasBlockingFindings" } }, "TotalFindings": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

The total number of findings detected by the assessment, including any findings beyond the stored-findings cap.

", "smithy.api#jsonName": "totalFindings" } } }, "traits": { "smithy.api#documentation": "

Summary of assessment findings broken down by category and severity.

" } }, "com.amazonaws.kafka#AssessmentType": { "type": "enum", "members": { "UPDATE_BROKER_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_BROKER_TYPE" } } }, "traits": { "smithy.api#documentation": "

The type of assessment to perform.

" } }, "com.amazonaws.kafka#AuthorizerLogs": { "type": "structure", "members": { "CloudWatchLogs": { "target": "com.amazonaws.kafka#CloudWatchLogs", "traits": { "smithy.api#documentation": "

Details of the CloudWatch Logs destination for authorizer logs.

", "smithy.api#jsonName": "cloudWatchLogs" } }, "Firehose": { "target": "com.amazonaws.kafka#Firehose", "traits": { "smithy.api#documentation": "

Details of the Kinesis Data Firehose delivery stream that is the destination for authorizer logs.

", "smithy.api#jsonName": "firehose" } }, "S3": { "target": "com.amazonaws.kafka#S3", "traits": { "smithy.api#documentation": "

Details of the Amazon S3 destination for authorizer logs.

", "smithy.api#jsonName": "s3" } } }, "traits": { "smithy.api#documentation": "

The authorizer logs configuration for this MSK cluster.

" } }, "com.amazonaws.kafka#BadRequestException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.kafka#BatchAssociateScramSecret": { "type": "operation", "input": { "target": "com.amazonaws.kafka#BatchAssociateScramSecretRequest" }, "output": { "target": "com.amazonaws.kafka#BatchAssociateScramSecretResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/v1/clusters/{ClusterArn}/scram-secrets", "code": 200 } } }, "com.amazonaws.kafka#BatchAssociateScramSecretRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SecretArnList": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

List of AWS Secrets Manager secret ARNs.

", "smithy.api#jsonName": "secretArnList", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Associates sasl scram secrets to cluster.

", "smithy.api#input": {} } }, "com.amazonaws.kafka#BatchAssociateScramSecretResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "UnprocessedScramSecrets": { "target": "com.amazonaws.kafka#__listOfUnprocessedScramSecret", "traits": { "smithy.api#documentation": "

List of errors when associating secrets to cluster.

", "smithy.api#jsonName": "unprocessedScramSecrets" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#BatchDisassociateScramSecret": { "type": "operation", "input": { "target": "com.amazonaws.kafka#BatchDisassociateScramSecretRequest" }, "output": { "target": "com.amazonaws.kafka#BatchDisassociateScramSecretResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "PATCH", "uri": "/v1/clusters/{ClusterArn}/scram-secrets", "code": 200 } } }, "com.amazonaws.kafka#BatchDisassociateScramSecretRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SecretArnList": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

List of AWS Secrets Manager secret ARNs.

", "smithy.api#jsonName": "secretArnList", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Disassociates sasl scram secrets to cluster.

", "smithy.api#input": {} } }, "com.amazonaws.kafka#BatchDisassociateScramSecretResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "UnprocessedScramSecrets": { "target": "com.amazonaws.kafka#__listOfUnprocessedScramSecret", "traits": { "smithy.api#documentation": "

List of errors when disassociating secrets to cluster.

", "smithy.api#jsonName": "unprocessedScramSecrets" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#BrokerAZDistribution": { "type": "enum", "members": { "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEFAULT" } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.kafka#BrokerCountUpdateInfo": { "type": "structure", "members": { "CreatedBrokerIds": { "target": "com.amazonaws.kafka#__listOf__double", "traits": { "smithy.api#documentation": "

Kafka Broker IDs of brokers being created.

", "smithy.api#jsonName": "createdBrokerIds" } }, "DeletedBrokerIds": { "target": "com.amazonaws.kafka#__listOf__double", "traits": { "smithy.api#documentation": "

Kafka Broker IDs of brokers being deleted.

", "smithy.api#jsonName": "deletedBrokerIds" } } }, "traits": { "smithy.api#documentation": "

Information regarding UpdateBrokerCount.

" } }, "com.amazonaws.kafka#BrokerEBSVolumeInfo": { "type": "structure", "members": { "KafkaBrokerNodeId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The ID of the broker to update.

", "smithy.api#jsonName": "kafkaBrokerNodeId", "smithy.api#required": {} } }, "ProvisionedThroughput": { "target": "com.amazonaws.kafka#ProvisionedThroughput", "traits": { "smithy.api#documentation": "

EBS volume provisioned throughput information.

", "smithy.api#jsonName": "provisionedThroughput" } }, "VolumeSizeGB": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

Size of the EBS volume to update.

", "smithy.api#jsonName": "volumeSizeGB" } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.kafka#BrokerLogs": { "type": "structure", "members": { "CloudWatchLogs": { "target": "com.amazonaws.kafka#CloudWatchLogs", "traits": { "smithy.api#jsonName": "cloudWatchLogs" } }, "Firehose": { "target": "com.amazonaws.kafka#Firehose", "traits": { "smithy.api#jsonName": "firehose" } }, "S3": { "target": "com.amazonaws.kafka#S3", "traits": { "smithy.api#jsonName": "s3" } } } }, "com.amazonaws.kafka#BrokerNodeGroupInfo": { "type": "structure", "members": { "BrokerAZDistribution": { "target": "com.amazonaws.kafka#BrokerAZDistribution", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "brokerAZDistribution" } }, "ClientSubnets": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "clientSubnets", "smithy.api#required": {} } }, "InstanceType": { "target": "com.amazonaws.kafka#__stringMin5Max64", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "instanceType", "smithy.api#required": {} } }, "SecurityGroups": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "securityGroups" } }, "StorageInfo": { "target": "com.amazonaws.kafka#StorageInfo", "traits": { "smithy.api#documentation": "

Contains information about storage volumes attached to MSK broker nodes.

", "smithy.api#jsonName": "storageInfo" } }, "ConnectivityInfo": { "target": "com.amazonaws.kafka#ConnectivityInfo", "traits": { "smithy.api#documentation": "

Information about the broker access configuration.

", "smithy.api#jsonName": "connectivityInfo" } }, "ZoneIds": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "zoneIds" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.kafka#BrokerNodeInfo": { "type": "structure", "members": { "AttachedENIId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The attached elastic network interface of the broker.

", "smithy.api#jsonName": "attachedENIId" } }, "BrokerId": { "target": "com.amazonaws.kafka#__double", "traits": { "smithy.api#documentation": "

The ID of the broker.

", "smithy.api#jsonName": "brokerId" } }, "BrokerNodeType": { "target": "com.amazonaws.kafka#BrokerNodeType", "traits": { "smithy.api#documentation": "

Whether this broker is a Standard broker or an Express broker. While an UpdateBrokerType operation upgrades a cluster in place from Standard brokers to Express brokers, the cluster contains brokers of both types and this field tells them apart.

", "smithy.api#jsonName": "brokerNodeType" } }, "ClientSubnet": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The client subnet to which this broker node belongs.

", "smithy.api#jsonName": "clientSubnet" } }, "ClientVpcIpAddress": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The virtual private cloud (VPC) of the client.

", "smithy.api#jsonName": "clientVpcIpAddress" } }, "CurrentBrokerSoftwareInfo": { "target": "com.amazonaws.kafka#BrokerSoftwareInfo", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "currentBrokerSoftwareInfo" } }, "Endpoints": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

Endpoints for accessing the broker.

", "smithy.api#jsonName": "endpoints" } } }, "traits": { "smithy.api#documentation": "

BrokerNodeInfo

" } }, "com.amazonaws.kafka#BrokerNodeType": { "type": "enum", "members": { "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STANDARD" } }, "EXPRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPRESS" } } }, "traits": { "smithy.api#documentation": "

The broker type of an individual broker node. STANDARD: a Standard broker. EXPRESS: an Express broker. A cluster contains brokers of both types while an UpdateBrokerType operation upgrades it in place from Standard brokers to Express brokers.

" } }, "com.amazonaws.kafka#BrokerSoftwareInfo": { "type": "structure", "members": { "ConfigurationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "configurationArn" } }, "ConfigurationRevision": { "target": "com.amazonaws.kafka#__long", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "configurationRevision" } }, "KafkaVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The version of Apache Kafka.

", "smithy.api#jsonName": "kafkaVersion" } } }, "traits": { "smithy.api#documentation": "

Information about the current software installed on the cluster.

" } }, "com.amazonaws.kafka#BrokerTypeUpgradeInfo": { "type": "structure", "members": { "TopicReassignmentMode": { "target": "com.amazonaws.kafka#TopicReassignmentMode", "traits": { "smithy.api#documentation": "

How topics are reassigned to the Express brokers.

", "smithy.api#jsonName": "topicReassignmentMode" } }, "TopicReassignmentOperationArn": { "target": "com.amazonaws.kafka#__stringMax2048", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic reassignment operation that Amazon MSK started for this upgrade. Present once that reassignment has started. Under MANUAL you start reassignments yourself, so Amazon MSK starts none.

", "smithy.api#jsonName": "topicReassignmentOperationArn" } } }, "traits": { "smithy.api#documentation": "

Information about the topic reassignment of an UpdateBrokerType operation that upgrades a cluster from Standard brokers to Express brokers. Present only on the operation that initiated the upgrade.

" } }, "com.amazonaws.kafka#Catalog": { "type": "structure", "members": { "CatalogArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the federated AWS Glue Data Catalog that projects the S3 Tables bucket. If omitted, MSK derives the catalog ARN from warehouseLocation.

", "smithy.api#jsonName": "catalogArn" } }, "WarehouseLocation": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the S3 Tables bucket that backs the Apache Iceberg warehouse.

", "smithy.api#jsonName": "warehouseLocation" } } }, "traits": { "smithy.api#documentation": "

Configuration of the AWS Glue Data Catalog and S3 Tables warehouse used by the Apache Iceberg destination.

" } }, "com.amazonaws.kafka#ChannelDestinationType": { "type": "enum", "members": { "ICEBERG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ICEBERG" } }, "S3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3" } } }, "traits": { "smithy.api#documentation": "

The type of destination configured for the channel.

" } }, "com.amazonaws.kafka#ChannelInfo": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "channelArn", "smithy.api#required": {} } }, "ChannelName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the channel.

", "smithy.api#jsonName": "channelName", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.kafka#ChannelStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The current lifecycle state of the channel.

", "smithy.api#jsonName": "status", "smithy.api#required": {} } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The time when the channel was created.

", "smithy.api#jsonName": "creationTime", "smithy.api#required": {} } }, "DestinationType": { "target": "com.amazonaws.kafka#ChannelDestinationType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The type of destination configured for the channel.

", "smithy.api#jsonName": "destinationType", "smithy.api#required": {} } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.

", "smithy.api#jsonName": "clusterOperationArn" } } }, "traits": { "smithy.api#documentation": "

Summary information about a channel returned by ListChannels.

" } }, "com.amazonaws.kafka#ChannelLoggingInfo": { "type": "structure", "members": { "CloudWatchLogs": { "target": "com.amazonaws.kafka#CloudWatchLogs", "traits": { "smithy.api#documentation": "

Details of the CloudWatch Logs destination for Channel logs.

", "smithy.api#jsonName": "cloudWatchLogs" } }, "Firehose": { "target": "com.amazonaws.kafka#Firehose", "traits": { "smithy.api#documentation": "

Details of the Kinesis Data Firehose delivery stream that is the destination for Channel logs.

", "smithy.api#jsonName": "firehose" } }, "S3": { "target": "com.amazonaws.kafka#S3", "traits": { "smithy.api#documentation": "

Details of the Amazon S3 destination for Channel logs.

", "smithy.api#jsonName": "s3" } } }, "traits": { "smithy.api#documentation": "

Configuration for the destinations to which the channel publishes operational logs.

" } }, "com.amazonaws.kafka#ChannelStateInfo": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

A short, machine-readable code identifying the failure cause.

", "smithy.api#jsonName": "code" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

A human-readable message describing the failure.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Additional context for the current channel state, populated when the channel is in FAILED.

" } }, "com.amazonaws.kafka#ChannelStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "SUSPENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUSPENDING" } }, "SUSPENDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUSPENDED" } } }, "traits": { "smithy.api#documentation": "

The lifecycle state of a channel.

" } }, "com.amazonaws.kafka#ClientAuthentication": { "type": "structure", "members": { "Sasl": { "target": "com.amazonaws.kafka#Sasl", "traits": { "smithy.api#documentation": "

Details for ClientAuthentication using SASL.

", "smithy.api#jsonName": "sasl" } }, "Tls": { "target": "com.amazonaws.kafka#Tls", "traits": { "smithy.api#documentation": "

Details for ClientAuthentication using TLS.

", "smithy.api#jsonName": "tls" } }, "Unauthenticated": { "target": "com.amazonaws.kafka#Unauthenticated", "traits": { "smithy.api#documentation": "

Contains information about unauthenticated traffic to the cluster.

", "smithy.api#jsonName": "unauthenticated" } } }, "traits": { "smithy.api#documentation": "

Includes all client authentication information.

" } }, "com.amazonaws.kafka#ClientBroker": { "type": "enum", "members": { "TLS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TLS" } }, "TLS_PLAINTEXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TLS_PLAINTEXT" } }, "PLAINTEXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PLAINTEXT" } } }, "traits": { "smithy.api#documentation": "

Client-broker encryption in transit setting.

" } }, "com.amazonaws.kafka#ClientVpcConnection": { "type": "structure", "members": { "Authentication": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Information about the auth scheme of Vpc Connection.

", "smithy.api#jsonName": "authentication" } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

Creation time of the Vpc Connection.

", "smithy.api#jsonName": "creationTime" } }, "State": { "target": "com.amazonaws.kafka#VpcConnectionState", "traits": { "smithy.api#documentation": "

State of the Vpc Connection.

", "smithy.api#jsonName": "state" } }, "VpcConnectionArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The ARN that identifies the Vpc Connection.

", "smithy.api#jsonName": "vpcConnectionArn", "smithy.api#required": {} } }, "Owner": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Owner of the Vpc Connection.

", "smithy.api#jsonName": "owner" } } }, "traits": { "smithy.api#documentation": "

The client VPC connection object.

" } }, "com.amazonaws.kafka#CloudWatchLogs": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#jsonName": "enabled", "smithy.api#required": {} } }, "LogGroup": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#jsonName": "logGroup" } } } }, "com.amazonaws.kafka#Cluster": { "type": "structure", "members": { "ActiveOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "activeOperationArn" } }, "ClusterType": { "target": "com.amazonaws.kafka#ClusterType", "traits": { "smithy.api#documentation": "

Cluster Type.

", "smithy.api#jsonName": "clusterType" } }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterArn" } }, "ClusterName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the cluster.

", "smithy.api#jsonName": "clusterName" } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time when the cluster was created.

", "smithy.api#jsonName": "creationTime" } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The current version of the MSK cluster.

", "smithy.api#jsonName": "currentVersion" } }, "State": { "target": "com.amazonaws.kafka#ClusterState", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "state" } }, "StateInfo": { "target": "com.amazonaws.kafka#StateInfo", "traits": { "smithy.api#documentation": "

State Info for the Amazon MSK cluster.

", "smithy.api#jsonName": "stateInfo" } }, "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#documentation": "

Tags attached to the cluster.

", "smithy.api#jsonName": "tags" } }, "Provisioned": { "target": "com.amazonaws.kafka#Provisioned", "traits": { "smithy.api#documentation": "

Information about the provisioned cluster.

", "smithy.api#jsonName": "provisioned" } }, "Serverless": { "target": "com.amazonaws.kafka#Serverless", "traits": { "smithy.api#documentation": "

Information about the serverless cluster.

", "smithy.api#jsonName": "serverless" } } }, "traits": { "smithy.api#documentation": "

Returns information about a cluster.

" } }, "com.amazonaws.kafka#ClusterConnectivityException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.kafka#ClusterInfo": { "type": "structure", "members": { "ActiveOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Arn of active cluster operation.

", "smithy.api#jsonName": "activeOperationArn" } }, "BrokerNodeGroupInfo": { "target": "com.amazonaws.kafka#BrokerNodeGroupInfo", "traits": { "smithy.api#documentation": "

Information about the broker nodes.

", "smithy.api#jsonName": "brokerNodeGroupInfo" } }, "Rebalancing": { "target": "com.amazonaws.kafka#Rebalancing", "traits": { "smithy.api#documentation": "

Contains information about intelligent rebalancing for new MSK Provisioned clusters with Express brokers. By default, intelligent rebalancing status is ACTIVE.

", "smithy.api#jsonName": "rebalancing" } }, "ClientAuthentication": { "target": "com.amazonaws.kafka#ClientAuthentication", "traits": { "smithy.api#documentation": "

Includes all client authentication information.

", "smithy.api#jsonName": "clientAuthentication" } }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterArn" } }, "ClusterName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the cluster.

", "smithy.api#jsonName": "clusterName" } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time when the cluster was created.

", "smithy.api#jsonName": "creationTime" } }, "CurrentBrokerSoftwareInfo": { "target": "com.amazonaws.kafka#BrokerSoftwareInfo", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "currentBrokerSoftwareInfo" } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The current version of the MSK cluster.

", "smithy.api#jsonName": "currentVersion" } }, "EncryptionInfo": { "target": "com.amazonaws.kafka#EncryptionInfo", "traits": { "smithy.api#documentation": "

Includes all encryption-related information.

", "smithy.api#jsonName": "encryptionInfo" } }, "EnhancedMonitoring": { "target": "com.amazonaws.kafka#EnhancedMonitoring", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "enhancedMonitoring" } }, "OpenMonitoring": { "target": "com.amazonaws.kafka#OpenMonitoring", "traits": { "smithy.api#documentation": "

Settings for open monitoring using Prometheus.

", "smithy.api#jsonName": "openMonitoring" } }, "LoggingInfo": { "target": "com.amazonaws.kafka#LoggingInfo", "traits": { "smithy.api#jsonName": "loggingInfo" } }, "NumberOfBrokerNodes": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

The number of broker nodes in the cluster.

", "smithy.api#jsonName": "numberOfBrokerNodes" } }, "State": { "target": "com.amazonaws.kafka#ClusterState", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "state" } }, "StateInfo": { "target": "com.amazonaws.kafka#StateInfo", "traits": { "smithy.api#jsonName": "stateInfo" } }, "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#documentation": "

Tags attached to the cluster.

", "smithy.api#jsonName": "tags" } }, "ZookeeperConnectString": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "zookeeperConnectString" } }, "ZookeeperConnectStringTls": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "zookeeperConnectStringTls" } }, "StorageMode": { "target": "com.amazonaws.kafka#StorageMode", "traits": { "smithy.api#documentation": "

This controls storage mode for supported storage tiers.

", "smithy.api#jsonName": "storageMode" } }, "CustomerActionStatus": { "target": "com.amazonaws.kafka#CustomerActionStatus", "traits": { "smithy.api#documentation": "

Determines if there is an action required from the customer.

", "smithy.api#jsonName": "customerActionStatus" } } }, "traits": { "smithy.api#documentation": "

Returns information about a cluster.

" } }, "com.amazonaws.kafka#ClusterOperationInfo": { "type": "structure", "members": { "BrokerTypeUpgradeInfo": { "target": "com.amazonaws.kafka#BrokerTypeUpgradeInfo", "traits": { "smithy.api#documentation": "

Topic reassignment details of the UpdateBrokerType operation that started an upgrade from Standard brokers to Express brokers.

", "smithy.api#jsonName": "brokerTypeUpgradeInfo" } }, "ClientRequestId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The ID of the API request that triggered this operation.

", "smithy.api#jsonName": "clientRequestId" } }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

ARN of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time that the operation was created.

", "smithy.api#jsonName": "creationTime" } }, "EndTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time at which the operation finished.

", "smithy.api#jsonName": "endTime" } }, "ErrorInfo": { "target": "com.amazonaws.kafka#ErrorInfo", "traits": { "smithy.api#documentation": "

Describes the error if the operation fails.

", "smithy.api#jsonName": "errorInfo" } }, "OperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

ARN of the cluster operation.

", "smithy.api#jsonName": "operationArn" } }, "OperationState": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

State of the cluster operation.

", "smithy.api#jsonName": "operationState" } }, "OperationSteps": { "target": "com.amazonaws.kafka#__listOfClusterOperationStep", "traits": { "smithy.api#documentation": "

Steps completed during the operation.

", "smithy.api#jsonName": "operationSteps" } }, "OperationType": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Type of the cluster operation.

", "smithy.api#jsonName": "operationType" } }, "SourceClusterInfo": { "target": "com.amazonaws.kafka#MutableClusterInfo", "traits": { "smithy.api#documentation": "

Information about cluster attributes before a cluster is updated.

", "smithy.api#jsonName": "sourceClusterInfo" } }, "TargetClusterInfo": { "target": "com.amazonaws.kafka#MutableClusterInfo", "traits": { "smithy.api#documentation": "

Information about cluster attributes after a cluster is updated.

", "smithy.api#jsonName": "targetClusterInfo" } }, "VpcConnectionInfo": { "target": "com.amazonaws.kafka#VpcConnectionInfo", "traits": { "smithy.api#documentation": "

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

", "smithy.api#jsonName": "vpcConnectionInfo" } } }, "traits": { "smithy.api#documentation": "

Returns information about a cluster operation.

" } }, "com.amazonaws.kafka#ClusterOperationStep": { "type": "structure", "members": { "StepInfo": { "target": "com.amazonaws.kafka#ClusterOperationStepInfo", "traits": { "smithy.api#documentation": "

Information about the step and its status.

", "smithy.api#jsonName": "stepInfo" } }, "StepName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the step.

", "smithy.api#jsonName": "stepName" } } }, "traits": { "smithy.api#documentation": "

Step taken during a cluster operation.

" } }, "com.amazonaws.kafka#ClusterOperationStepInfo": { "type": "structure", "members": { "StepStatus": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The steps current status.

", "smithy.api#jsonName": "stepStatus" } } }, "traits": { "smithy.api#documentation": "

State information about the operation step.

" } }, "com.amazonaws.kafka#ClusterOperationV2": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

ARN of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "ClusterType": { "target": "com.amazonaws.kafka#ClusterType", "traits": { "smithy.api#documentation": "

Type of the backend cluster.

", "smithy.api#jsonName": "clusterType" } }, "StartTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time at which operation was started.

", "smithy.api#jsonName": "startTime" } }, "EndTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time at which the operation finished.

", "smithy.api#jsonName": "endTime" } }, "ErrorInfo": { "target": "com.amazonaws.kafka#ErrorInfo", "traits": { "smithy.api#documentation": "

If cluster operation failed from an error, it describes the error.

", "smithy.api#jsonName": "errorInfo" } }, "OperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

ARN of the cluster operation.

", "smithy.api#jsonName": "operationArn" } }, "OperationState": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

State of the cluster operation.

", "smithy.api#jsonName": "operationState" } }, "OperationType": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Type of the cluster operation.

", "smithy.api#jsonName": "operationType" } }, "Provisioned": { "target": "com.amazonaws.kafka#ClusterOperationV2Provisioned", "traits": { "smithy.api#documentation": "

Properties of a provisioned cluster.

", "smithy.api#jsonName": "provisioned" } }, "Serverless": { "target": "com.amazonaws.kafka#ClusterOperationV2Serverless", "traits": { "smithy.api#documentation": "

Properties of a serverless cluster.

", "smithy.api#jsonName": "serverless" } } }, "traits": { "smithy.api#documentation": "

Returns information about a cluster operation.

" } }, "com.amazonaws.kafka#ClusterOperationV2Provisioned": { "type": "structure", "members": { "BrokerTypeUpgradeInfo": { "target": "com.amazonaws.kafka#BrokerTypeUpgradeInfo", "traits": { "smithy.api#documentation": "

Topic reassignment details of the UpdateBrokerType operation that started an upgrade from Standard brokers to Express brokers.

", "smithy.api#jsonName": "brokerTypeUpgradeInfo" } }, "OperationSteps": { "target": "com.amazonaws.kafka#__listOfClusterOperationStep", "traits": { "smithy.api#documentation": "

Steps completed during the operation.

", "smithy.api#jsonName": "operationSteps" } }, "SourceClusterInfo": { "target": "com.amazonaws.kafka#MutableClusterInfo", "traits": { "smithy.api#documentation": "

Information about cluster attributes before a cluster is updated.

", "smithy.api#jsonName": "sourceClusterInfo" } }, "TargetClusterInfo": { "target": "com.amazonaws.kafka#MutableClusterInfo", "traits": { "smithy.api#documentation": "

Information about cluster attributes after a cluster is updated.

", "smithy.api#jsonName": "targetClusterInfo" } }, "VpcConnectionInfo": { "target": "com.amazonaws.kafka#VpcConnectionInfo", "traits": { "smithy.api#documentation": "

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

", "smithy.api#jsonName": "vpcConnectionInfo" } } }, "traits": { "smithy.api#documentation": "

Returns information about a provisioned cluster operation.

" } }, "com.amazonaws.kafka#ClusterOperationV2Serverless": { "type": "structure", "members": { "SourceClusterInfo": { "target": "com.amazonaws.kafka#ServerlessConnectivityInfo", "traits": { "smithy.api#documentation": "

Describes the cluster's attributes before any updates are applied. For example, networkType, which can be either IPv4 or DUAL.

", "smithy.api#jsonName": "sourceClusterInfo" } }, "TargetClusterInfo": { "target": "com.amazonaws.kafka#ServerlessConnectivityInfo", "traits": { "smithy.api#documentation": "

Describes the cluster's attributes after any updates are applied. For example, networkType, which can be either IPv4 or DUAL.

", "smithy.api#jsonName": "targetClusterInfo" } }, "VpcConnectionInfo": { "target": "com.amazonaws.kafka#VpcConnectionInfoServerless", "traits": { "smithy.api#documentation": "

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

", "smithy.api#jsonName": "vpcConnectionInfo" } } }, "traits": { "smithy.api#documentation": "

Returns information about a serverless cluster operation.

" } }, "com.amazonaws.kafka#ClusterOperationV2Summary": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

ARN of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "ClusterType": { "target": "com.amazonaws.kafka#ClusterType", "traits": { "smithy.api#documentation": "

Type of the backend cluster.

", "smithy.api#jsonName": "clusterType" } }, "StartTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time at which operation was started.

", "smithy.api#jsonName": "startTime" } }, "EndTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time at which the operation finished.

", "smithy.api#jsonName": "endTime" } }, "OperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

ARN of the cluster operation.

", "smithy.api#jsonName": "operationArn" } }, "OperationState": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

State of the cluster operation.

", "smithy.api#jsonName": "operationState" } }, "OperationType": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Type of the cluster operation.

", "smithy.api#jsonName": "operationType" } } }, "traits": { "smithy.api#documentation": "

Returns information about a cluster operation.

" } }, "com.amazonaws.kafka#ClusterState": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "HEALING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HEALING" } }, "MAINTENANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MAINTENANCE" } }, "REBOOTING_BROKER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REBOOTING_BROKER" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } } }, "traits": { "smithy.api#documentation": "

The state of the Apache Kafka cluster.

" } }, "com.amazonaws.kafka#ClusterType": { "type": "enum", "members": { "PROVISIONED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROVISIONED" } }, "SERVERLESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SERVERLESS" } } }, "traits": { "smithy.api#documentation": "

The type of cluster.

" } }, "com.amazonaws.kafka#CompatibleKafkaVersion": { "type": "structure", "members": { "SourceVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

An Apache Kafka version.

", "smithy.api#jsonName": "sourceVersion" } }, "TargetVersions": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

A list of Apache Kafka versions.

", "smithy.api#jsonName": "targetVersions" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.kafka#Configuration": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", "smithy.api#jsonName": "arn", "smithy.api#required": {} } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The time when the configuration was created.

", "smithy.api#jsonName": "creationTime", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The description of the configuration.

", "smithy.api#jsonName": "description", "smithy.api#required": {} } }, "KafkaVersions": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "kafkaVersions", "smithy.api#required": {} } }, "LatestRevision": { "target": "com.amazonaws.kafka#ConfigurationRevision", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Latest revision of the configuration.

", "smithy.api#jsonName": "latestRevision", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the configuration.

", "smithy.api#jsonName": "name", "smithy.api#required": {} } }, "State": { "target": "com.amazonaws.kafka#ConfigurationState", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "state", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Represents an MSK Configuration.

" } }, "com.amazonaws.kafka#ConfigurationInfo": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

ARN of the configuration to use.

", "smithy.api#jsonName": "arn", "smithy.api#required": {} } }, "Revision": { "target": "com.amazonaws.kafka#__long", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The revision of the configuration to use.

", "smithy.api#jsonName": "revision", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies the configuration to use for the brokers.

" } }, "com.amazonaws.kafka#ConfigurationRevision": { "type": "structure", "members": { "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The time when the configuration revision was created.

", "smithy.api#jsonName": "creationTime", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the configuration revision.

", "smithy.api#jsonName": "description" } }, "Revision": { "target": "com.amazonaws.kafka#__long", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The revision number.

", "smithy.api#jsonName": "revision", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes a configuration revision.

" } }, "com.amazonaws.kafka#ConfigurationState": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_FAILED" } } }, "traits": { "smithy.api#documentation": "

The state of a configuration.

" } }, "com.amazonaws.kafka#ConflictException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.kafka#ConnectivityInfo": { "type": "structure", "members": { "PublicAccess": { "target": "com.amazonaws.kafka#PublicAccess", "traits": { "smithy.api#documentation": "

Public access control for brokers.

", "smithy.api#jsonName": "publicAccess" } }, "VpcConnectivity": { "target": "com.amazonaws.kafka#VpcConnectivity", "traits": { "smithy.api#documentation": "

VPC connectivity access control for brokers.

", "smithy.api#jsonName": "vpcConnectivity" } }, "NetworkType": { "target": "com.amazonaws.kafka#NetworkType", "traits": { "smithy.api#documentation": "

The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

By default, a cluster uses the IPv4 network type.

", "smithy.api#jsonName": "networkType" } } }, "traits": { "smithy.api#documentation": "

Information about the broker access configuration.

" } }, "com.amazonaws.kafka#ConsumerGroupOffsetSyncMode": { "type": "enum", "members": { "LEGACY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LEGACY" } }, "ENHANCED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENHANCED" } } }, "traits": { "smithy.api#documentation": "

The consumer group offset synchronization mode. With LEGACY, offsets are synchronized when producers write to the source cluster. With ENHANCED, consumer offsets are synchronized regardless of producer location. ENHANCED requires a corresponding replicator that replicates data from the target cluster to the source cluster.

" } }, "com.amazonaws.kafka#ConsumerGroupReplication": { "type": "structure", "members": { "ConsumerGroupsToExclude": { "target": "com.amazonaws.kafka#__listOf__stringMax256", "traits": { "smithy.api#documentation": "

List of regular expression patterns indicating the consumer groups that should not be replicated.

", "smithy.api#jsonName": "consumerGroupsToExclude" } }, "ConsumerGroupsToReplicate": { "target": "com.amazonaws.kafka#__listOf__stringMax256", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

List of regular expression patterns indicating the consumer groups to copy.

", "smithy.api#jsonName": "consumerGroupsToReplicate", "smithy.api#required": {} } }, "DetectAndCopyNewConsumerGroups": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

Enables synchronization of consumer groups to target cluster.

", "smithy.api#jsonName": "detectAndCopyNewConsumerGroups" } }, "SynchroniseConsumerGroupOffsets": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

", "smithy.api#jsonName": "synchroniseConsumerGroupOffsets" } }, "ConsumerGroupOffsetSyncMode": { "target": "com.amazonaws.kafka#ConsumerGroupOffsetSyncMode", "traits": { "smithy.api#documentation": "

The consumer group offset synchronization mode. With LEGACY, offsets are synchronized when producers write to the source cluster. With ENHANCED, consumer offsets are synchronized regardless of producer location. ENHANCED requires a corresponding replicator that replicates data from the target cluster to the source cluster.

", "smithy.api#jsonName": "consumerGroupOffsetSyncMode" } } }, "traits": { "smithy.api#documentation": "

Details about consumer group replication.

" } }, "com.amazonaws.kafka#ConsumerGroupReplicationUpdate": { "type": "structure", "members": { "ConsumerGroupsToExclude": { "target": "com.amazonaws.kafka#__listOf__stringMax256", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

List of regular expression patterns indicating the consumer groups that should not be replicated.

", "smithy.api#jsonName": "consumerGroupsToExclude", "smithy.api#required": {} } }, "ConsumerGroupsToReplicate": { "target": "com.amazonaws.kafka#__listOf__stringMax256", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

List of regular expression patterns indicating the consumer groups to copy.

", "smithy.api#jsonName": "consumerGroupsToReplicate", "smithy.api#required": {} } }, "DetectAndCopyNewConsumerGroups": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Enables synchronization of consumer groups to target cluster.

", "smithy.api#jsonName": "detectAndCopyNewConsumerGroups", "smithy.api#required": {} } }, "SynchroniseConsumerGroupOffsets": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

", "smithy.api#jsonName": "synchroniseConsumerGroupOffsets", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details about consumer group replication.

" } }, "com.amazonaws.kafka#ControllerMovedException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.kafka#ControllerNodeInfo": { "type": "structure", "members": { "Endpoints": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

Endpoints for accessing the Controller.

", "smithy.api#jsonName": "endpoints" } } }, "traits": { "smithy.api#documentation": "

Controller node information.

" } }, "com.amazonaws.kafka#CreateAssessment": { "type": "operation", "input": { "target": "com.amazonaws.kafka#CreateAssessmentRequest" }, "output": { "target": "com.amazonaws.kafka#CreateAssessmentResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ConflictException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates a new assessment for the specified cluster. Kicks off an asynchronous scan.

", "smithy.api#http": { "method": "POST", "uri": "/v1/clusters/{ClusterArn}/assessments", "code": 200 } } }, "com.amazonaws.kafka#CreateAssessmentRequest": { "type": "structure", "members": { "AssessmentParameters": { "target": "com.amazonaws.kafka#AssessmentParameters", "traits": { "smithy.api#documentation": "

Optional type-specific parameters for the assessment.

", "smithy.api#jsonName": "assessmentParameters" } }, "AssessmentType": { "target": "com.amazonaws.kafka#AssessmentType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The type of assessment to perform.

", "smithy.api#jsonName": "assessmentType", "smithy.api#required": {} } }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#documentation": "

The tags to attach to the assessment.

", "smithy.api#jsonName": "tags" } } }, "traits": { "smithy.api#documentation": "

Creates a new assessment for a cluster. Kicks off an asynchronous scan and returns immediately with an assessment ARN and status.

", "smithy.api#input": {} } }, "com.amazonaws.kafka#CreateAssessmentResponse": { "type": "structure", "members": { "AssessmentArn": { "target": "com.amazonaws.kafka#__stringMax2048", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the assessment.

", "smithy.api#jsonName": "assessmentArn" } }, "AssessmentType": { "target": "com.amazonaws.kafka#AssessmentType", "traits": { "smithy.api#documentation": "

The type of assessment.

", "smithy.api#jsonName": "assessmentType" } }, "ClusterArn": { "target": "com.amazonaws.kafka#__stringMax2048", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster being assessed.

", "smithy.api#jsonName": "clusterArn" } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time when the assessment was created.

", "smithy.api#jsonName": "creationTime" } }, "Status": { "target": "com.amazonaws.kafka#AssessmentStatus", "traits": { "smithy.api#documentation": "

The current status of the assessment.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#documentation": "

Returns information about the created assessment.

", "smithy.api#output": {} } }, "com.amazonaws.kafka#CreateChannel": { "type": "operation", "input": { "target": "com.amazonaws.kafka#CreateChannelRequest" }, "output": { "target": "com.amazonaws.kafka#CreateChannelResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ConflictException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates a Channel that streams records from an Amazon MSK Express cluster topic to Amazon S3 or Apache Iceberg.

", "smithy.api#http": { "method": "POST", "uri": "/v1/clusters/{ClusterArn}/channels", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.kafka#CreateChannelRequest": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the channel. Must be unique within the cluster.

", "smithy.api#jsonName": "channelName", "smithy.api#required": {} } }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "EncryptionConfiguration": { "target": "com.amazonaws.kafka#EncryptionConfiguration", "traits": { "smithy.api#documentation": "

The encryption configuration applied to the channel.

", "smithy.api#jsonName": "encryptionConfiguration" } }, "IcebergDestinationConfiguration": { "target": "com.amazonaws.kafka#IcebergDestinationConfiguration", "traits": { "smithy.api#documentation": "

The Apache Iceberg destination for the channel. Mutually exclusive with s3DestinationConfiguration.

", "smithy.api#jsonName": "icebergDestinationConfiguration" } }, "S3DestinationConfiguration": { "target": "com.amazonaws.kafka#S3DestinationConfiguration", "traits": { "smithy.api#documentation": "

The Amazon S3 destination for the channel. Mutually exclusive with icebergDestinationConfiguration.

", "smithy.api#jsonName": "s3DestinationConfiguration" } }, "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#documentation": "

The tags attached to the channel.

", "smithy.api#jsonName": "tags" } }, "TopicConfigurationList": { "target": "com.amazonaws.kafka#__listOfTopicConfiguration", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The list of topic configurations for the channel. Currently exactly one topic must be specified.

", "smithy.api#jsonName": "topicConfigurationList", "smithy.api#required": {} } }, "LoggingInfo": { "target": "com.amazonaws.kafka#ChannelLoggingInfo", "traits": { "smithy.api#documentation": "

The destinations to which the channel publishes operational logs.

", "smithy.api#jsonName": "loggingInfo" } } }, "traits": { "smithy.api#documentation": "

Creates a Channel that streams records from an Amazon MSK Express cluster topic to Amazon S3 or Apache Iceberg.

", "smithy.api#input": {} } }, "com.amazonaws.kafka#CreateChannelResponse": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "channelArn", "smithy.api#required": {} } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterOperationArn" } } }, "traits": { "smithy.api#documentation": "

Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous create.

", "smithy.api#output": {} } }, "com.amazonaws.kafka#CreateCluster": { "type": "operation", "input": { "target": "com.amazonaws.kafka#CreateClusterRequest" }, "output": { "target": "com.amazonaws.kafka#CreateClusterResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ConflictException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates a new MSK cluster.

", "smithy.api#http": { "method": "POST", "uri": "/v1/clusters", "code": 200 } } }, "com.amazonaws.kafka#CreateClusterRequest": { "type": "structure", "members": { "BrokerNodeGroupInfo": { "target": "com.amazonaws.kafka#BrokerNodeGroupInfo", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Information about the broker nodes in the cluster.

", "smithy.api#jsonName": "brokerNodeGroupInfo", "smithy.api#required": {} } }, "Rebalancing": { "target": "com.amazonaws.kafka#Rebalancing", "traits": { "smithy.api#documentation": "

Specifies if intelligent rebalancing should be turned on for the new MSK Provisioned cluster with Express brokers. By default, intelligent rebalancing status is ACTIVE for all new clusters.

", "smithy.api#jsonName": "rebalancing" } }, "ClientAuthentication": { "target": "com.amazonaws.kafka#ClientAuthentication", "traits": { "smithy.api#documentation": "

Includes all client authentication related information.

", "smithy.api#jsonName": "clientAuthentication" } }, "ClusterName": { "target": "com.amazonaws.kafka#__stringMin1Max64", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the cluster.

", "smithy.api#jsonName": "clusterName", "smithy.api#required": {} } }, "ConfigurationInfo": { "target": "com.amazonaws.kafka#ConfigurationInfo", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "configurationInfo" } }, "EncryptionInfo": { "target": "com.amazonaws.kafka#EncryptionInfo", "traits": { "smithy.api#documentation": "

Includes all encryption-related information.

", "smithy.api#jsonName": "encryptionInfo" } }, "EnhancedMonitoring": { "target": "com.amazonaws.kafka#EnhancedMonitoring", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "enhancedMonitoring" } }, "OpenMonitoring": { "target": "com.amazonaws.kafka#OpenMonitoringInfo", "traits": { "smithy.api#documentation": "

The settings for open monitoring.

", "smithy.api#jsonName": "openMonitoring" } }, "KafkaVersion": { "target": "com.amazonaws.kafka#__stringMin1Max128", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The version of Apache Kafka.

", "smithy.api#jsonName": "kafkaVersion", "smithy.api#required": {} } }, "LoggingInfo": { "target": "com.amazonaws.kafka#LoggingInfo", "traits": { "smithy.api#jsonName": "loggingInfo" } }, "NumberOfBrokerNodes": { "target": "com.amazonaws.kafka#__integerMin1Max15", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The number of broker nodes in the cluster.

", "smithy.api#jsonName": "numberOfBrokerNodes", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#documentation": "

Create tags when creating the cluster.

", "smithy.api#jsonName": "tags" } }, "StorageMode": { "target": "com.amazonaws.kafka#StorageMode", "traits": { "smithy.api#documentation": "

This controls storage mode for supported storage tiers.

", "smithy.api#jsonName": "storageMode" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#CreateClusterResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "ClusterName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the MSK cluster.

", "smithy.api#jsonName": "clusterName" } }, "State": { "target": "com.amazonaws.kafka#ClusterState", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "state" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#CreateClusterV2": { "type": "operation", "input": { "target": "com.amazonaws.kafka#CreateClusterV2Request" }, "output": { "target": "com.amazonaws.kafka#CreateClusterV2Response" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ConflictException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates a new MSK cluster.

", "smithy.api#http": { "method": "POST", "uri": "/api/v2/clusters", "code": 200 } } }, "com.amazonaws.kafka#CreateClusterV2Request": { "type": "structure", "members": { "ClusterName": { "target": "com.amazonaws.kafka#__stringMin1Max64", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the cluster.

", "smithy.api#jsonName": "clusterName", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "tags" } }, "Provisioned": { "target": "com.amazonaws.kafka#ProvisionedRequest", "traits": { "smithy.api#documentation": "

Information about the provisioned cluster.

", "smithy.api#jsonName": "provisioned" } }, "Serverless": { "target": "com.amazonaws.kafka#ServerlessRequest", "traits": { "smithy.api#documentation": "

Information about the serverless cluster.

", "smithy.api#jsonName": "serverless" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#CreateClusterV2Response": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "ClusterName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the MSK cluster.

", "smithy.api#jsonName": "clusterName" } }, "State": { "target": "com.amazonaws.kafka#ClusterState", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "state" } }, "ClusterType": { "target": "com.amazonaws.kafka#ClusterType", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterType" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#CreateConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.kafka#CreateConfigurationRequest" }, "output": { "target": "com.amazonaws.kafka#CreateConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ConflictException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates a new MSK configuration.

", "smithy.api#http": { "method": "POST", "uri": "/v1/configurations", "code": 200 } } }, "com.amazonaws.kafka#CreateConfigurationRequest": { "type": "structure", "members": { "Description": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the configuration.

", "smithy.api#jsonName": "description" } }, "KafkaVersions": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "kafkaVersions" } }, "Name": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the configuration.

", "smithy.api#jsonName": "name", "smithy.api#required": {} } }, "ServerProperties": { "target": "com.amazonaws.kafka#__blob", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "serverProperties", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#CreateConfigurationResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", "smithy.api#jsonName": "arn" } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time when the configuration was created.

", "smithy.api#jsonName": "creationTime" } }, "LatestRevision": { "target": "com.amazonaws.kafka#ConfigurationRevision", "traits": { "smithy.api#documentation": "

Latest revision of the configuration.

", "smithy.api#jsonName": "latestRevision" } }, "Name": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the configuration.

", "smithy.api#jsonName": "name" } }, "State": { "target": "com.amazonaws.kafka#ConfigurationState", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "state" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#CreateReplicator": { "type": "operation", "input": { "target": "com.amazonaws.kafka#CreateReplicatorRequest" }, "output": { "target": "com.amazonaws.kafka#CreateReplicatorResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ConflictException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates the replicator.

", "smithy.api#http": { "method": "POST", "uri": "/replication/v1/replicators", "code": 200 } } }, "com.amazonaws.kafka#CreateReplicatorRequest": { "type": "structure", "members": { "Description": { "target": "com.amazonaws.kafka#__stringMax1024", "traits": { "smithy.api#documentation": "

A summary description of the replicator.

", "smithy.api#jsonName": "description" } }, "KafkaClusters": { "target": "com.amazonaws.kafka#__listOfKafkaCluster", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Kafka Clusters to use in setting up sources / targets for replication.

", "smithy.api#jsonName": "kafkaClusters", "smithy.api#required": {} } }, "ReplicationInfoList": { "target": "com.amazonaws.kafka#__listOfReplicationInfo", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

", "smithy.api#jsonName": "replicationInfoList", "smithy.api#required": {} } }, "ReplicatorName": { "target": "com.amazonaws.kafka#__stringMin1Max128Pattern09AZaZ09AZaZ0", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the replicator. Alpha-numeric characters with '-' are allowed.

", "smithy.api#jsonName": "replicatorName", "smithy.api#required": {} } }, "ServiceExecutionRoleArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#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)

", "smithy.api#jsonName": "serviceExecutionRoleArn", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#documentation": "

List of tags to attach to created Replicator.

", "smithy.api#jsonName": "tags" } }, "LogDelivery": { "target": "com.amazonaws.kafka#LogDelivery", "traits": { "smithy.api#documentation": "

Configuration for delivering replicator logs to customer destinations.

", "smithy.api#jsonName": "logDelivery" } } }, "traits": { "smithy.api#documentation": "

Creates a replicator using the specified configuration.

", "smithy.api#input": {} } }, "com.amazonaws.kafka#CreateReplicatorResponse": { "type": "structure", "members": { "ReplicatorArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicator.

", "smithy.api#jsonName": "replicatorArn" } }, "ReplicatorName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Name of the replicator provided by the customer.

", "smithy.api#jsonName": "replicatorName" } }, "ReplicatorState": { "target": "com.amazonaws.kafka#ReplicatorState", "traits": { "smithy.api#documentation": "

State of the replicator.

", "smithy.api#jsonName": "replicatorState" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#CreateTopic": { "type": "operation", "input": { "target": "com.amazonaws.kafka#CreateTopicRequest" }, "output": { "target": "com.amazonaws.kafka#CreateTopicResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ClusterConnectivityException" }, { "target": "com.amazonaws.kafka#ConflictException" }, { "target": "com.amazonaws.kafka#ControllerMovedException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#GroupSubscribedToTopicException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#KafkaRequestException" }, { "target": "com.amazonaws.kafka#KafkaTimeoutException" }, { "target": "com.amazonaws.kafka#NotControllerException" }, { "target": "com.amazonaws.kafka#ReassignmentInProgressException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#TopicExistsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" }, { "target": "com.amazonaws.kafka#UnknownTopicOrPartitionException" } ], "traits": { "smithy.api#documentation": "

Creates a topic in the specified MSK cluster.

", "smithy.api#http": { "method": "POST", "uri": "/v1/clusters/{ClusterArn}/topics", "code": 200 } } }, "com.amazonaws.kafka#CreateTopicRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TopicName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the topic to create.

", "smithy.api#jsonName": "topicName", "smithy.api#required": {} } }, "PartitionCount": { "target": "com.amazonaws.kafka#__integerMin1", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The number of partitions for the topic.

", "smithy.api#jsonName": "partitionCount", "smithy.api#required": {} } }, "ReplicationFactor": { "target": "com.amazonaws.kafka#__integerMin1", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The replication factor for the topic.

", "smithy.api#jsonName": "replicationFactor", "smithy.api#required": {} } }, "Configs": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Topic configurations encoded as a Base64 string.

", "smithy.api#jsonName": "configs" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#CreateTopicResponse": { "type": "structure", "members": { "TopicArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

", "smithy.api#jsonName": "topicArn" } }, "TopicName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the topic that was created.

", "smithy.api#jsonName": "topicName" } }, "Status": { "target": "com.amazonaws.kafka#TopicState", "traits": { "smithy.api#documentation": "

The status of the topic creation.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#CreateVpcConnection": { "type": "operation", "input": { "target": "com.amazonaws.kafka#CreateVpcConnectionRequest" }, "output": { "target": "com.amazonaws.kafka#CreateVpcConnectionResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates a new MSK VPC connection.

", "smithy.api#http": { "method": "POST", "uri": "/v1/vpc-connection", "code": 200 } } }, "com.amazonaws.kafka#CreateVpcConnectionRequest": { "type": "structure", "members": { "TargetClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The cluster Amazon Resource Name (ARN) for the VPC connection.

", "smithy.api#jsonName": "targetClusterArn", "smithy.api#required": {} } }, "Authentication": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The authentication type of VPC connection.

", "smithy.api#jsonName": "authentication", "smithy.api#required": {} } }, "VpcId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The VPC ID of VPC connection.

", "smithy.api#jsonName": "vpcId", "smithy.api#required": {} } }, "ClientSubnets": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The list of client subnets.

", "smithy.api#jsonName": "clientSubnets", "smithy.api#required": {} } }, "SecurityGroups": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The list of security groups.

", "smithy.api#jsonName": "securityGroups", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#documentation": "

A map of tags for the VPC connection.

", "smithy.api#jsonName": "tags" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#CreateVpcConnectionResponse": { "type": "structure", "members": { "VpcConnectionArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The VPC connection ARN.

", "smithy.api#jsonName": "vpcConnectionArn" } }, "State": { "target": "com.amazonaws.kafka#VpcConnectionState", "traits": { "smithy.api#documentation": "

The State of Vpc Connection.

", "smithy.api#jsonName": "state" } }, "Authentication": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The authentication type of VPC connection.

", "smithy.api#jsonName": "authentication" } }, "VpcId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The VPC ID of the VPC connection.

", "smithy.api#jsonName": "vpcId" } }, "ClientSubnets": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

The list of client subnets.

", "smithy.api#jsonName": "clientSubnets" } }, "SecurityGroups": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

The list of security groups.

", "smithy.api#jsonName": "securityGroups" } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The creation time of VPC connection.

", "smithy.api#jsonName": "creationTime" } }, "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#documentation": "

A map of tags for the VPC connection.

", "smithy.api#jsonName": "tags" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#CustomerActionStatus": { "type": "enum", "members": { "CRITICAL_ACTION_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CRITICAL_ACTION_REQUIRED" } }, "ACTION_RECOMMENDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTION_RECOMMENDED" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } }, "traits": { "smithy.api#documentation": "

A type of an action required from the customer.

" } }, "com.amazonaws.kafka#DeadLetterQueueS3": { "type": "structure", "members": { "BucketArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dead-letter Amazon S3 bucket.

", "smithy.api#jsonName": "bucketArn", "smithy.api#required": {} } }, "ErrorOutputPrefix": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

An optional prefix prepended to every dead-letter Amazon S3 object key.

", "smithy.api#jsonName": "errorOutputPrefix" } }, "ExpectedBucketOwner": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Optional 12-digit AWS account ID expected to own the dead-letter Amazon S3 bucket.

", "smithy.api#jsonName": "expectedBucketOwner" } } }, "traits": { "smithy.api#documentation": "

Configuration of the Amazon S3 bucket where records that fail to deliver are stored.

" } }, "com.amazonaws.kafka#DeleteAssessment": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DeleteAssessmentRequest" }, "output": { "target": "com.amazonaws.kafka#DeleteAssessmentResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ConflictException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes an assessment and its findings. Frees one slot against the cluster's assessment quota.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/clusters/{ClusterArn}/assessments/{AssessmentArn}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.kafka#DeleteAssessmentRequest": { "type": "structure", "members": { "AssessmentArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the assessment to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DeleteAssessmentResponse": { "type": "structure", "members": { "AssessmentArn": { "target": "com.amazonaws.kafka#__stringMax2048", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the assessment being deleted.

", "smithy.api#jsonName": "assessmentArn" } }, "Status": { "target": "com.amazonaws.kafka#AssessmentStatus", "traits": { "smithy.api#documentation": "

The current status of the assessment. Will be DELETING.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#documentation": "

Returns the result of deleting an assessment.

", "smithy.api#output": {} } }, "com.amazonaws.kafka#DeleteChannel": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DeleteChannelRequest" }, "output": { "target": "com.amazonaws.kafka#DeleteChannelResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes the channel specified by channelArn from the cluster specified by clusterArn. The channel transitions through DELETING and is removed when the asynchronous delete completes.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/clusters/{ClusterArn}/channels/{ChannelArn}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.kafka#DeleteChannelRequest": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DeleteChannelResponse": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "channelArn", "smithy.api#required": {} } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterOperationArn" } } }, "traits": { "smithy.api#documentation": "

Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous delete.

", "smithy.api#output": {} } }, "com.amazonaws.kafka#DeleteCluster": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DeleteClusterRequest" }, "output": { "target": "com.amazonaws.kafka#DeleteClusterResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/clusters/{ClusterArn}", "code": 200 } } }, "com.amazonaws.kafka#DeleteClusterPolicy": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DeleteClusterPolicyRequest" }, "output": { "target": "com.amazonaws.kafka#DeleteClusterPolicyResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/clusters/{ClusterArn}/policy", "code": 200 } } }, "com.amazonaws.kafka#DeleteClusterPolicyRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DeleteClusterPolicyResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DeleteClusterRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The current version of the MSK cluster.

", "smithy.api#httpQuery": "currentVersion" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DeleteClusterResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "State": { "target": "com.amazonaws.kafka#ClusterState", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "state" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DeleteConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DeleteConfigurationRequest" }, "output": { "target": "com.amazonaws.kafka#DeleteConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes an MSK Configuration.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/configurations/{Arn}", "code": 200 } } }, "com.amazonaws.kafka#DeleteConfigurationRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DeleteConfigurationResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "arn" } }, "State": { "target": "com.amazonaws.kafka#ConfigurationState", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "state" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DeleteReplicator": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DeleteReplicatorRequest" }, "output": { "target": "com.amazonaws.kafka#DeleteReplicatorResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes a replicator.

", "smithy.api#http": { "method": "DELETE", "uri": "/replication/v1/replicators/{ReplicatorArn}", "code": 200 } } }, "com.amazonaws.kafka#DeleteReplicatorRequest": { "type": "structure", "members": { "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The current version of the replicator.

", "smithy.api#httpQuery": "currentVersion" } }, "ReplicatorArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicator to be deleted.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DeleteReplicatorResponse": { "type": "structure", "members": { "ReplicatorArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicator.

", "smithy.api#jsonName": "replicatorArn" } }, "ReplicatorState": { "target": "com.amazonaws.kafka#ReplicatorState", "traits": { "smithy.api#documentation": "

The state of the replicator.

", "smithy.api#jsonName": "replicatorState" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DeleteTopic": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DeleteTopicRequest" }, "output": { "target": "com.amazonaws.kafka#DeleteTopicResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ClusterConnectivityException" }, { "target": "com.amazonaws.kafka#ControllerMovedException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#GroupSubscribedToTopicException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#KafkaRequestException" }, { "target": "com.amazonaws.kafka#KafkaTimeoutException" }, { "target": "com.amazonaws.kafka#NotControllerException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ReassignmentInProgressException" }, { "target": "com.amazonaws.kafka#UnknownTopicOrPartitionException" } ], "traits": { "smithy.api#documentation": "

Deletes a topic in the specified MSK cluster.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/clusters/{ClusterArn}/topics/{TopicName}", "code": 200 } } }, "com.amazonaws.kafka#DeleteTopicRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TopicName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the topic to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DeleteTopicResponse": { "type": "structure", "members": { "TopicArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

", "smithy.api#jsonName": "topicArn" } }, "TopicName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the topic that was deleted.

", "smithy.api#jsonName": "topicName" } }, "Status": { "target": "com.amazonaws.kafka#TopicState", "traits": { "smithy.api#documentation": "

The status of the topic deletion.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DeleteVpcConnection": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DeleteVpcConnectionRequest" }, "output": { "target": "com.amazonaws.kafka#DeleteVpcConnectionResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes a MSK VPC connection.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/vpc-connection/{Arn}", "code": 200 } } }, "com.amazonaws.kafka#DeleteVpcConnectionRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DeleteVpcConnectionResponse": { "type": "structure", "members": { "VpcConnectionArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "vpcConnectionArn" } }, "State": { "target": "com.amazonaws.kafka#VpcConnectionState", "traits": { "smithy.api#documentation": "

The state of the VPC connection.

", "smithy.api#jsonName": "state" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DescribeAssessment": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DescribeAssessmentRequest" }, "output": { "target": "com.amazonaws.kafka#DescribeAssessmentResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns the status and summary of an assessment.

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/assessments/{AssessmentArn}", "code": 200 } } }, "com.amazonaws.kafka#DescribeAssessmentRequest": { "type": "structure", "members": { "AssessmentArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the assessment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DescribeAssessmentResponse": { "type": "structure", "members": { "AssessmentArn": { "target": "com.amazonaws.kafka#__stringMax2048", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the assessment.

", "smithy.api#jsonName": "assessmentArn" } }, "AssessmentParameters": { "target": "com.amazonaws.kafka#AssessmentParameters", "traits": { "smithy.api#documentation": "

The parameters that were provided when creating the assessment.

", "smithy.api#jsonName": "assessmentParameters" } }, "AssessmentType": { "target": "com.amazonaws.kafka#AssessmentType", "traits": { "smithy.api#documentation": "

The type of assessment.

", "smithy.api#jsonName": "assessmentType" } }, "ClusterArn": { "target": "com.amazonaws.kafka#__stringMax2048", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster that was assessed.

", "smithy.api#jsonName": "clusterArn" } }, "CompletionTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time when the assessment completed. Present only when status is COMPLETE or FAILED.

", "smithy.api#jsonName": "completionTime" } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time when the assessment was created.

", "smithy.api#jsonName": "creationTime" } }, "Status": { "target": "com.amazonaws.kafka#AssessmentStatus", "traits": { "smithy.api#documentation": "

The current status of the assessment.

", "smithy.api#jsonName": "status" } }, "StatusMessage": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Additional information about the current status. Present when status is FAILED.

", "smithy.api#jsonName": "statusMessage" } }, "Summary": { "target": "com.amazonaws.kafka#AssessmentSummary", "traits": { "smithy.api#documentation": "

Summary of findings by category and severity. Present only when status is COMPLETE.

", "smithy.api#jsonName": "summary" } }, "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#documentation": "

The tags attached to the assessment.

", "smithy.api#jsonName": "tags" } } }, "traits": { "smithy.api#documentation": "

Returns the status and summary of an assessment.

", "smithy.api#output": {} } }, "com.amazonaws.kafka#DescribeChannel": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DescribeChannelRequest" }, "output": { "target": "com.amazonaws.kafka#DescribeChannelResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns the current configuration and state of a channel.

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/channels/{ChannelArn}", "code": 200 } } }, "com.amazonaws.kafka#DescribeChannelRequest": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DescribeChannelResponse": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "channelArn", "smithy.api#required": {} } }, "ChannelName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the channel.

", "smithy.api#jsonName": "channelName", "smithy.api#required": {} } }, "EncryptionConfiguration": { "target": "com.amazonaws.kafka#EncryptionConfiguration", "traits": { "smithy.api#documentation": "

The encryption configuration applied to the channel.

", "smithy.api#jsonName": "encryptionConfiguration" } }, "IcebergDestinationConfiguration": { "target": "com.amazonaws.kafka#IcebergDestinationConfiguration", "traits": { "smithy.api#documentation": "

The Apache Iceberg destination for the channel, if configured.

", "smithy.api#jsonName": "icebergDestinationConfiguration" } }, "S3DestinationConfiguration": { "target": "com.amazonaws.kafka#S3DestinationConfiguration", "traits": { "smithy.api#documentation": "

The Amazon S3 destination for the channel, if configured.

", "smithy.api#jsonName": "s3DestinationConfiguration" } }, "Status": { "target": "com.amazonaws.kafka#ChannelStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The current lifecycle state of the channel.

", "smithy.api#jsonName": "status", "smithy.api#required": {} } }, "DestinationType": { "target": "com.amazonaws.kafka#ChannelDestinationType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The type of destination configured for the channel.

", "smithy.api#jsonName": "destinationType", "smithy.api#required": {} } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The time when the channel was created.

", "smithy.api#jsonName": "creationTime", "smithy.api#required": {} } }, "TopicConfigurationList": { "target": "com.amazonaws.kafka#__listOfTopicConfiguration", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The list of topic configurations for the channel.

", "smithy.api#jsonName": "topicConfigurationList", "smithy.api#required": {} } }, "LoggingInfo": { "target": "com.amazonaws.kafka#ChannelLoggingInfo", "traits": { "smithy.api#documentation": "

The destinations to which the channel publishes operational logs.

", "smithy.api#jsonName": "loggingInfo" } }, "StateInfo": { "target": "com.amazonaws.kafka#ChannelStateInfo", "traits": { "smithy.api#documentation": "

Additional context for the current channel state, populated when the channel is in FAILED.

", "smithy.api#jsonName": "stateInfo" } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.

", "smithy.api#jsonName": "clusterOperationArn" } }, "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#documentation": "

The tags attached to the channel.

", "smithy.api#jsonName": "tags" } } }, "traits": { "smithy.api#documentation": "

Contains the current configuration and state of a channel.

", "smithy.api#output": {} } }, "com.amazonaws.kafka#DescribeCluster": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DescribeClusterRequest" }, "output": { "target": "com.amazonaws.kafka#DescribeClusterResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}", "code": 200 } } }, "com.amazonaws.kafka#DescribeClusterOperation": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DescribeClusterOperationRequest" }, "output": { "target": "com.amazonaws.kafka#DescribeClusterOperationResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/v1/operations/{ClusterOperationArn}", "code": 200 } } }, "com.amazonaws.kafka#DescribeClusterOperationRequest": { "type": "structure", "members": { "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DescribeClusterOperationResponse": { "type": "structure", "members": { "ClusterOperationInfo": { "target": "com.amazonaws.kafka#ClusterOperationInfo", "traits": { "smithy.api#documentation": "

Cluster operation information

", "smithy.api#jsonName": "clusterOperationInfo" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DescribeClusterOperationV2": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DescribeClusterOperationV2Request" }, "output": { "target": "com.amazonaws.kafka#DescribeClusterOperationV2Response" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/api/v2/operations/{ClusterOperationArn}", "code": 200 } } }, "com.amazonaws.kafka#DescribeClusterOperationV2Request": { "type": "structure", "members": { "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "ARN of the cluster operation to describe.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DescribeClusterOperationV2Response": { "type": "structure", "members": { "ClusterOperationInfo": { "target": "com.amazonaws.kafka#ClusterOperationV2", "traits": { "smithy.api#documentation": "

Cluster operation information

", "smithy.api#jsonName": "clusterOperationInfo" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DescribeClusterRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DescribeClusterResponse": { "type": "structure", "members": { "ClusterInfo": { "target": "com.amazonaws.kafka#ClusterInfo", "traits": { "smithy.api#documentation": "

The cluster information.

", "smithy.api#jsonName": "clusterInfo" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DescribeClusterV2": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DescribeClusterV2Request" }, "output": { "target": "com.amazonaws.kafka#DescribeClusterV2Response" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/api/v2/clusters/{ClusterArn}", "code": 200 } } }, "com.amazonaws.kafka#DescribeClusterV2Request": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DescribeClusterV2Response": { "type": "structure", "members": { "ClusterInfo": { "target": "com.amazonaws.kafka#Cluster", "traits": { "smithy.api#documentation": "

The cluster information.

", "smithy.api#jsonName": "clusterInfo" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DescribeConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DescribeConfigurationRequest" }, "output": { "target": "com.amazonaws.kafka#DescribeConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns a description of this MSK configuration.

", "smithy.api#http": { "method": "GET", "uri": "/v1/configurations/{Arn}", "code": 200 } } }, "com.amazonaws.kafka#DescribeConfigurationRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DescribeConfigurationResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", "smithy.api#jsonName": "arn" } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time when the configuration was created.

", "smithy.api#jsonName": "creationTime" } }, "Description": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the configuration.

", "smithy.api#jsonName": "description" } }, "KafkaVersions": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "kafkaVersions" } }, "LatestRevision": { "target": "com.amazonaws.kafka#ConfigurationRevision", "traits": { "smithy.api#documentation": "

Latest revision of the configuration.

", "smithy.api#jsonName": "latestRevision" } }, "Name": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the configuration.

", "smithy.api#jsonName": "name" } }, "State": { "target": "com.amazonaws.kafka#ConfigurationState", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "state" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DescribeConfigurationRevision": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DescribeConfigurationRevisionRequest" }, "output": { "target": "com.amazonaws.kafka#DescribeConfigurationRevisionResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns a description of this revision of the configuration.

", "smithy.api#http": { "method": "GET", "uri": "/v1/configurations/{Arn}/revisions/{Revision}", "code": 200 } } }, "com.amazonaws.kafka#DescribeConfigurationRevisionRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Revision": { "target": "com.amazonaws.kafka#__long", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DescribeConfigurationRevisionResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", "smithy.api#jsonName": "arn" } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time when the configuration was created.

", "smithy.api#jsonName": "creationTime" } }, "Description": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the configuration.

", "smithy.api#jsonName": "description" } }, "Revision": { "target": "com.amazonaws.kafka#__long", "traits": { "smithy.api#documentation": "

The revision number.

", "smithy.api#jsonName": "revision" } }, "ServerProperties": { "target": "com.amazonaws.kafka#__blob", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "serverProperties" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DescribeReplicator": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DescribeReplicatorRequest" }, "output": { "target": "com.amazonaws.kafka#DescribeReplicatorResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Describes a replicator.

", "smithy.api#http": { "method": "GET", "uri": "/replication/v1/replicators/{ReplicatorArn}", "code": 200 } } }, "com.amazonaws.kafka#DescribeReplicatorRequest": { "type": "structure", "members": { "ReplicatorArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicator to be described.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DescribeReplicatorResponse": { "type": "structure", "members": { "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time when the replicator was created.

", "smithy.api#jsonName": "creationTime" } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The current version number of the replicator.

", "smithy.api#jsonName": "currentVersion" } }, "IsReplicatorReference": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

Whether this resource is a replicator reference.

", "smithy.api#jsonName": "isReplicatorReference" } }, "KafkaClusters": { "target": "com.amazonaws.kafka#__listOfKafkaClusterDescription", "traits": { "smithy.api#documentation": "

Kafka Clusters used in setting up sources / targets for replication.

", "smithy.api#jsonName": "kafkaClusters" } }, "ReplicationInfoList": { "target": "com.amazonaws.kafka#__listOfReplicationInfoDescription", "traits": { "smithy.api#documentation": "

A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

", "smithy.api#jsonName": "replicationInfoList" } }, "ReplicatorArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicator.

", "smithy.api#jsonName": "replicatorArn" } }, "ReplicatorDescription": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the replicator.

", "smithy.api#jsonName": "replicatorDescription" } }, "ReplicatorName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the replicator.

", "smithy.api#jsonName": "replicatorName" } }, "ReplicatorResourceArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.

", "smithy.api#jsonName": "replicatorResourceArn" } }, "ReplicatorState": { "target": "com.amazonaws.kafka#ReplicatorState", "traits": { "smithy.api#documentation": "

State of the replicator.

", "smithy.api#jsonName": "replicatorState" } }, "ServiceExecutionRoleArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#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)

", "smithy.api#jsonName": "serviceExecutionRoleArn" } }, "StateInfo": { "target": "com.amazonaws.kafka#ReplicationStateInfo", "traits": { "smithy.api#documentation": "

Details about the state of the replicator.

", "smithy.api#jsonName": "stateInfo" } }, "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#documentation": "

List of tags attached to the Replicator.

", "smithy.api#jsonName": "tags" } }, "LogDelivery": { "target": "com.amazonaws.kafka#LogDelivery", "traits": { "smithy.api#documentation": "

Configuration for log delivery.

", "smithy.api#jsonName": "logDelivery" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DescribeTopic": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DescribeTopicRequest" }, "output": { "target": "com.amazonaws.kafka#DescribeTopicResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns topic details of this topic on a MSK cluster.

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/topics/{TopicName}", "code": 200 } } }, "com.amazonaws.kafka#DescribeTopicPartitions": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DescribeTopicPartitionsRequest" }, "output": { "target": "com.amazonaws.kafka#DescribeTopicPartitionsResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns partition details of this topic on a MSK cluster.

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/topics/{TopicName}/partitions", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Partitions", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#DescribeTopicPartitionsRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TopicName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Kafka topic name that uniquely identifies the topic.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DescribeTopicPartitionsResponse": { "type": "structure", "members": { "Partitions": { "target": "com.amazonaws.kafka#__listOfTopicPartitionInfo", "traits": { "smithy.api#documentation": "

The list of partition information for the topic.

", "smithy.api#jsonName": "partitions" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DescribeTopicReassignment": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DescribeTopicReassignmentRequest" }, "output": { "target": "com.amazonaws.kafka#DescribeTopicReassignmentResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns the status and progress of a topic reassignment operation.

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/topic-reassignments/{TopicReassignmentOperationArn}", "code": 200 } } }, "com.amazonaws.kafka#DescribeTopicReassignmentRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TopicReassignmentOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic reassignment operation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DescribeTopicReassignmentResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__stringMax2048", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "CompletedTopics": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

Number of topics fully migrated to the target broker type.

", "smithy.api#jsonName": "completedTopics" } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

When the operation was created.

", "smithy.api#jsonName": "creationTime" } }, "ErrorInfo": { "target": "com.amazonaws.kafka#ErrorInfo", "traits": { "smithy.api#documentation": "

Error details. Present only when status is FAILED.

", "smithy.api#jsonName": "errorInfo" } }, "LastUpdateTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

Last time the status or progress counters were updated.

", "smithy.api#jsonName": "lastUpdateTime" } }, "MigratedPartitions": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

Number of partitions confirmed on the target broker type.

", "smithy.api#jsonName": "migratedPartitions" } }, "Status": { "target": "com.amazonaws.kafka#TopicReassignmentStatus", "traits": { "smithy.api#documentation": "

The current status of the reassignment operation.

", "smithy.api#jsonName": "status" } }, "TargetInstanceType": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The target broker instance type for this reassignment.

", "smithy.api#jsonName": "targetInstanceType" } }, "TopicReassignmentOperationArn": { "target": "com.amazonaws.kafka#__stringMax2048", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic reassignment operation.

", "smithy.api#jsonName": "topicReassignmentOperationArn" } }, "TopicsToExclude": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

The original exclude patterns provided in the request.

", "smithy.api#jsonName": "topicsToExclude" } }, "TopicsToInclude": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

The original include patterns provided in the request.

", "smithy.api#jsonName": "topicsToInclude" } }, "TotalPartitions": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

Total number of partitions across all matched topics.

", "smithy.api#jsonName": "totalPartitions" } }, "TotalTopics": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

Total number of topics matching the selector at resolution time.

", "smithy.api#jsonName": "totalTopics" } } }, "traits": { "smithy.api#documentation": "

Returns the status and progress of a topic reassignment operation.

", "smithy.api#output": {} } }, "com.amazonaws.kafka#DescribeTopicRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TopicName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Kafka topic name that uniquely identifies the topic.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DescribeTopicResponse": { "type": "structure", "members": { "TopicArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

", "smithy.api#jsonName": "topicArn" } }, "TopicName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Kafka topic name of the topic.

", "smithy.api#jsonName": "topicName" } }, "ReplicationFactor": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

The replication factor of the topic.

", "smithy.api#jsonName": "replicationFactor" } }, "PartitionCount": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

The partition count of the topic.

", "smithy.api#jsonName": "partitionCount" } }, "Configs": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Topic configurations encoded as a Base64 string.

", "smithy.api#jsonName": "configs" } }, "Status": { "target": "com.amazonaws.kafka#TopicState", "traits": { "smithy.api#documentation": "

The status of the topic.

", "smithy.api#jsonName": "status" } }, "ReplicaIds": { "target": "com.amazonaws.kafka#__listOf__integer", "traits": { "smithy.api#documentation": "

The broker IDs hosting replicas of this topic's partitions.

", "smithy.api#jsonName": "replicaIds" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DescribeVpcConnection": { "type": "operation", "input": { "target": "com.amazonaws.kafka#DescribeVpcConnectionRequest" }, "output": { "target": "com.amazonaws.kafka#DescribeVpcConnectionResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns a description of this MSK VPC connection.

", "smithy.api#http": { "method": "GET", "uri": "/v1/vpc-connection/{Arn}", "code": 200 } } }, "com.amazonaws.kafka#DescribeVpcConnectionRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#DescribeVpcConnectionResponse": { "type": "structure", "members": { "VpcConnectionArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.

", "smithy.api#jsonName": "vpcConnectionArn" } }, "TargetClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "targetClusterArn" } }, "State": { "target": "com.amazonaws.kafka#VpcConnectionState", "traits": { "smithy.api#documentation": "

The state of VPC connection.

", "smithy.api#jsonName": "state" } }, "Authentication": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The authentication type of VPC connection.

", "smithy.api#jsonName": "authentication" } }, "VpcId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The VPC Id for the VPC connection.

", "smithy.api#jsonName": "vpcId" } }, "Subnets": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

The list of subnets for the VPC connection.

", "smithy.api#jsonName": "subnets" } }, "SecurityGroups": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

The list of security groups for the VPC connection.

", "smithy.api#jsonName": "securityGroups" } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The creation time of the VPC connection.

", "smithy.api#jsonName": "creationTime" } }, "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#documentation": "

A map of tags for the VPC connection.

", "smithy.api#jsonName": "tags" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#DestinationTable": { "type": "structure", "members": { "DestinationDatabaseName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the destination namespace (database) in the AWS Glue Data Catalog.

", "smithy.api#jsonName": "destinationDatabaseName" } }, "DestinationTableName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the destination Apache Iceberg table.

", "smithy.api#jsonName": "destinationTableName" } }, "PartitionSpec": { "target": "com.amazonaws.kafka#PartitionSpec", "traits": { "smithy.api#documentation": "

The partition specification for the destination table.

", "smithy.api#jsonName": "partitionSpec" } } }, "traits": { "smithy.api#documentation": "

Configuration of an Apache Iceberg destination table.

" } }, "com.amazonaws.kafka#EBSStorageInfo": { "type": "structure", "members": { "ProvisionedThroughput": { "target": "com.amazonaws.kafka#ProvisionedThroughput", "traits": { "smithy.api#documentation": "

EBS volume provisioned throughput information.

", "smithy.api#jsonName": "provisionedThroughput" } }, "VolumeSize": { "target": "com.amazonaws.kafka#__integerMin1Max16384", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "volumeSize" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.kafka#EncryptionAtRest": { "type": "structure", "members": { "DataVolumeKMSKeyId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "dataVolumeKMSKeyId", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The data-volume encryption details.

" } }, "com.amazonaws.kafka#EncryptionConfiguration": { "type": "structure", "members": { "KmsKeyArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the data.

", "smithy.api#jsonName": "kmsKeyArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The AWS KMS encryption configuration applied to data at rest.

" } }, "com.amazonaws.kafka#EncryptionInTransit": { "type": "structure", "members": { "ClientBroker": { "target": "com.amazonaws.kafka#ClientBroker", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "clientBroker" } }, "InCluster": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "inCluster" } } }, "traits": { "smithy.api#documentation": "

The settings for encrypting data in transit.

" } }, "com.amazonaws.kafka#EncryptionInfo": { "type": "structure", "members": { "EncryptionAtRest": { "target": "com.amazonaws.kafka#EncryptionAtRest", "traits": { "smithy.api#documentation": "

The data-volume encryption details.

", "smithy.api#jsonName": "encryptionAtRest" } }, "EncryptionInTransit": { "target": "com.amazonaws.kafka#EncryptionInTransit", "traits": { "smithy.api#documentation": "

The details for encryption in transit.

", "smithy.api#jsonName": "encryptionInTransit" } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.kafka#EnhancedMonitoring": { "type": "enum", "members": { "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEFAULT" } }, "PER_BROKER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PER_BROKER" } }, "PER_TOPIC_PER_BROKER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PER_TOPIC_PER_BROKER" } }, "PER_TOPIC_PER_PARTITION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PER_TOPIC_PER_PARTITION" } } }, "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.kafka#ErrorInfo": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

A number describing the error programmatically.

", "smithy.api#jsonName": "errorCode" } }, "ErrorString": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

An optional field to provide more details about the error.

", "smithy.api#jsonName": "errorString" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error state of the cluster.

" } }, "com.amazonaws.kafka#FindingCategory": { "type": "enum", "members": { "INFRASTRUCTURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INFRASTRUCTURE" } }, "BROKER_CONFIGURATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BROKER_CONFIGURATION" } }, "TOPIC_CONFIGURATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TOPIC_CONFIGURATION" } }, "CAPACITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CAPACITY" } }, "HEALTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HEALTH" } } }, "traits": { "smithy.api#documentation": "

The category of an assessment finding.

" } }, "com.amazonaws.kafka#FindingRemediation": { "type": "structure", "members": { "Action": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The recommended action to resolve this finding.

", "smithy.api#jsonName": "action" } }, "DocumentationUrl": { "target": "com.amazonaws.kafka#__stringMax2048", "traits": { "smithy.api#documentation": "

A link to documentation with more detail about this finding and how to resolve it.

", "smithy.api#jsonName": "documentationUrl" } } }, "traits": { "smithy.api#documentation": "

Guidance for resolving a finding.

" } }, "com.amazonaws.kafka#FindingSeverity": { "type": "enum", "members": { "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } }, "WARNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WARNING" } }, "INFO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INFO" } } }, "traits": { "smithy.api#documentation": "

The severity level of an assessment finding.

" } }, "com.amazonaws.kafka#Firehose": { "type": "structure", "members": { "DeliveryStream": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#jsonName": "deliveryStream" } }, "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#jsonName": "enabled", "smithy.api#required": {} } } } }, "com.amazonaws.kafka#ForbiddenException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.kafka#GetBootstrapBrokers": { "type": "operation", "input": { "target": "com.amazonaws.kafka#GetBootstrapBrokersRequest" }, "output": { "target": "com.amazonaws.kafka#GetBootstrapBrokersResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ConflictException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

A list of brokers that a client application can use to bootstrap. This list doesn't necessarily include all of the brokers in the cluster. The following Python 3.6 example shows how you can use the Amazon Resource Name (ARN) of a cluster to get its bootstrap brokers. If you don't know the ARN of your cluster, you can use the ListClusters operation to get the ARNs of all the clusters in this account and Region.

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/bootstrap-brokers", "code": 200 } } }, "com.amazonaws.kafka#GetBootstrapBrokersRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#GetBootstrapBrokersResponse": { "type": "structure", "members": { "BootstrapBrokerString": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

A string containing one or more hostname:port pairs.

", "smithy.api#jsonName": "bootstrapBrokerString" } }, "BootstrapBrokerStringTls": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "bootstrapBrokerStringTls" } }, "BootstrapBrokerStringSaslScram": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "bootstrapBrokerStringSaslScram" } }, "BootstrapBrokerStringSaslIam": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "bootstrapBrokerStringSaslIam" } }, "BootstrapBrokerStringPublicTls": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "bootstrapBrokerStringPublicTls" } }, "BootstrapBrokerStringPublicSaslScram": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "bootstrapBrokerStringPublicSaslScram" } }, "BootstrapBrokerStringPublicSaslIam": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "bootstrapBrokerStringPublicSaslIam" } }, "BootstrapBrokerStringVpcConnectivityTls": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "bootstrapBrokerStringVpcConnectivityTls" } }, "BootstrapBrokerStringVpcConnectivitySaslScram": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

A string containing one or more DNS names (or IP) and SASL/SCRAM port pairs for VPC connectivity.

", "smithy.api#jsonName": "bootstrapBrokerStringVpcConnectivitySaslScram" } }, "BootstrapBrokerStringVpcConnectivitySaslIam": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

A string containing one or more DNS names (or IP) and SASL/IAM port pairs for VPC connectivity.

", "smithy.api#jsonName": "bootstrapBrokerStringVpcConnectivitySaslIam" } }, "BootstrapBrokerStringIpv6": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

A string that contains one or more DNS names (or IP) and port pairs for IPv6 connectivity.

", "smithy.api#jsonName": "bootstrapBrokerStringIpv6" } }, "BootstrapBrokerStringTlsIpv6": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

A string that contains one or more DNS names (or IP) and TLS port pairs for IPv6 connectivity.

", "smithy.api#jsonName": "bootstrapBrokerStringTlsIpv6" } }, "BootstrapBrokerStringSaslScramIpv6": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

A string that contains one or more DNS names (or IP) and SASL SCRAM port pairs for IPv6 connectivity.

", "smithy.api#jsonName": "bootstrapBrokerStringSaslScramIpv6" } }, "BootstrapBrokerStringSaslIamIpv6": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "bootstrapBrokerStringSaslIamIpv6" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#GetClusterPolicy": { "type": "operation", "input": { "target": "com.amazonaws.kafka#GetClusterPolicyRequest" }, "output": { "target": "com.amazonaws.kafka#GetClusterPolicyResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/policy", "code": 200 } } }, "com.amazonaws.kafka#GetClusterPolicyRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#GetClusterPolicyResponse": { "type": "structure", "members": { "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The version of cluster policy.

", "smithy.api#jsonName": "currentVersion" } }, "Policy": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The cluster policy.

", "smithy.api#jsonName": "policy" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#GetCompatibleKafkaVersions": { "type": "operation", "input": { "target": "com.amazonaws.kafka#GetCompatibleKafkaVersionsRequest" }, "output": { "target": "com.amazonaws.kafka#GetCompatibleKafkaVersionsResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/v1/compatible-kafka-versions", "code": 200 } } }, "com.amazonaws.kafka#GetCompatibleKafkaVersionsRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "clusterArn" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#GetCompatibleKafkaVersionsResponse": { "type": "structure", "members": { "CompatibleKafkaVersions": { "target": "com.amazonaws.kafka#__listOfCompatibleKafkaVersion", "traits": { "smithy.api#documentation": "

A list of CompatibleKafkaVersion objects.

", "smithy.api#jsonName": "compatibleKafkaVersions" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#GroupSubscribedToTopicException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.kafka#Iam": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

Indicates whether IAM access control is enabled.

", "smithy.api#jsonName": "enabled" } } }, "traits": { "smithy.api#documentation": "

Details for IAM access control.

" } }, "com.amazonaws.kafka#IcebergCompressionType": { "type": "enum", "members": { "ZSTD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ZSTD" } }, "SNAPPY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SNAPPY" } } }, "traits": { "smithy.api#documentation": "

Compression codec for Iceberg table data files. Defaults to ZSTD.

" } }, "com.amazonaws.kafka#IcebergDestinationConfiguration": { "type": "structure", "members": { "AppendOnly": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Whether the destination is append-only. Must be true; updates and deletes are not supported.

", "smithy.api#jsonName": "appendOnly", "smithy.api#required": {} } }, "Catalog": { "target": "com.amazonaws.kafka#Catalog", "traits": { "smithy.api#documentation": "

The AWS Glue Data Catalog and S3 Tables warehouse used by the destination.

", "smithy.api#jsonName": "catalog" } }, "DataFreshnessInSeconds": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600.

", "smithy.api#jsonName": "dataFreshnessInSeconds" } }, "DeadLetterQueueS3": { "target": "com.amazonaws.kafka#DeadLetterQueueS3", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.

", "smithy.api#jsonName": "deadLetterQueueS3", "smithy.api#required": {} } }, "DestinationTableList": { "target": "com.amazonaws.kafka#__listOfDestinationTable", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The destination Iceberg tables. Currently exactly one table must be specified.

", "smithy.api#jsonName": "destinationTableList", "smithy.api#required": {} } }, "SchemaEvolution": { "target": "com.amazonaws.kafka#SchemaEvolution", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Configuration controlling whether the destination table's schema is evolved to match incoming records.

", "smithy.api#jsonName": "schemaEvolution", "smithy.api#required": {} } }, "ServiceExecutionRoleArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that MSK assumes to access the destination table, the AWS Glue Data Catalog, and the dead-letter Amazon S3 bucket.

", "smithy.api#jsonName": "serviceExecutionRoleArn", "smithy.api#required": {} } }, "TableCreation": { "target": "com.amazonaws.kafka#TableCreation", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Configuration controlling whether MSK creates the destination table if it does not already exist.

", "smithy.api#jsonName": "tableCreation", "smithy.api#required": {} } }, "CompressionType": { "target": "com.amazonaws.kafka#IcebergCompressionType", "traits": { "smithy.api#documentation": "

The compression codec for Iceberg table data files. Defaults to ZSTD.

", "smithy.api#jsonName": "compressionType" } } }, "traits": { "smithy.api#documentation": "

Configuration of an Apache Iceberg destination for a channel.

" } }, "com.amazonaws.kafka#IcebergDestinationUpdate": { "type": "structure", "members": { "DataFreshnessInSeconds": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900.

", "smithy.api#jsonName": "dataFreshnessInSeconds", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Update payload for an Apache Iceberg destination.

" } }, "com.amazonaws.kafka#InternalServerErrorException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.kafka#JmxExporter": { "type": "structure", "members": { "EnabledInBroker": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "enabledInBroker", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.kafka#JmxExporterInfo": { "type": "structure", "members": { "EnabledInBroker": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "enabledInBroker", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.kafka#JwtSigningAlgorithm": { "type": "enum", "members": { "RS256": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RS256" } }, "ES384": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ES384" } } }, "traits": { "smithy.api#documentation": "

The algorithm used to sign the STS JWT assertion.

" } }, "com.amazonaws.kafka#Kafka": { "type": "service", "version": "2018-11-14", "operations": [ { "target": "com.amazonaws.kafka#BatchAssociateScramSecret" }, { "target": "com.amazonaws.kafka#BatchDisassociateScramSecret" }, { "target": "com.amazonaws.kafka#CreateAssessment" }, { "target": "com.amazonaws.kafka#CreateChannel" }, { "target": "com.amazonaws.kafka#CreateCluster" }, { "target": "com.amazonaws.kafka#CreateClusterV2" }, { "target": "com.amazonaws.kafka#CreateConfiguration" }, { "target": "com.amazonaws.kafka#CreateReplicator" }, { "target": "com.amazonaws.kafka#CreateTopic" }, { "target": "com.amazonaws.kafka#CreateVpcConnection" }, { "target": "com.amazonaws.kafka#DeleteAssessment" }, { "target": "com.amazonaws.kafka#DeleteChannel" }, { "target": "com.amazonaws.kafka#DeleteCluster" }, { "target": "com.amazonaws.kafka#DeleteClusterPolicy" }, { "target": "com.amazonaws.kafka#DeleteConfiguration" }, { "target": "com.amazonaws.kafka#DeleteReplicator" }, { "target": "com.amazonaws.kafka#DeleteTopic" }, { "target": "com.amazonaws.kafka#DeleteVpcConnection" }, { "target": "com.amazonaws.kafka#DescribeAssessment" }, { "target": "com.amazonaws.kafka#DescribeChannel" }, { "target": "com.amazonaws.kafka#DescribeCluster" }, { "target": "com.amazonaws.kafka#DescribeClusterOperation" }, { "target": "com.amazonaws.kafka#DescribeClusterOperationV2" }, { "target": "com.amazonaws.kafka#DescribeClusterV2" }, { "target": "com.amazonaws.kafka#DescribeConfiguration" }, { "target": "com.amazonaws.kafka#DescribeConfigurationRevision" }, { "target": "com.amazonaws.kafka#DescribeReplicator" }, { "target": "com.amazonaws.kafka#DescribeTopic" }, { "target": "com.amazonaws.kafka#DescribeTopicPartitions" }, { "target": "com.amazonaws.kafka#DescribeTopicReassignment" }, { "target": "com.amazonaws.kafka#DescribeVpcConnection" }, { "target": "com.amazonaws.kafka#GetBootstrapBrokers" }, { "target": "com.amazonaws.kafka#GetClusterPolicy" }, { "target": "com.amazonaws.kafka#GetCompatibleKafkaVersions" }, { "target": "com.amazonaws.kafka#ListAssessmentFindings" }, { "target": "com.amazonaws.kafka#ListAssessments" }, { "target": "com.amazonaws.kafka#ListChannels" }, { "target": "com.amazonaws.kafka#ListClientVpcConnections" }, { "target": "com.amazonaws.kafka#ListClusterOperations" }, { "target": "com.amazonaws.kafka#ListClusterOperationsV2" }, { "target": "com.amazonaws.kafka#ListClusters" }, { "target": "com.amazonaws.kafka#ListClustersV2" }, { "target": "com.amazonaws.kafka#ListConfigurationRevisions" }, { "target": "com.amazonaws.kafka#ListConfigurations" }, { "target": "com.amazonaws.kafka#ListKafkaVersions" }, { "target": "com.amazonaws.kafka#ListNodes" }, { "target": "com.amazonaws.kafka#ListReplicators" }, { "target": "com.amazonaws.kafka#ListScramSecrets" }, { "target": "com.amazonaws.kafka#ListTagsForResource" }, { "target": "com.amazonaws.kafka#ListTopicReassignments" }, { "target": "com.amazonaws.kafka#ListTopics" }, { "target": "com.amazonaws.kafka#ListVpcConnections" }, { "target": "com.amazonaws.kafka#PutClusterPolicy" }, { "target": "com.amazonaws.kafka#RebootBroker" }, { "target": "com.amazonaws.kafka#RejectClientVpcConnection" }, { "target": "com.amazonaws.kafka#StartTopicReassignment" }, { "target": "com.amazonaws.kafka#StopTopicReassignment" }, { "target": "com.amazonaws.kafka#TagResource" }, { "target": "com.amazonaws.kafka#UntagResource" }, { "target": "com.amazonaws.kafka#UpdateBrokerCount" }, { "target": "com.amazonaws.kafka#UpdateBrokerStorage" }, { "target": "com.amazonaws.kafka#UpdateBrokerType" }, { "target": "com.amazonaws.kafka#UpdateChannel" }, { "target": "com.amazonaws.kafka#UpdateClusterConfiguration" }, { "target": "com.amazonaws.kafka#UpdateClusterKafkaVersion" }, { "target": "com.amazonaws.kafka#UpdateConfiguration" }, { "target": "com.amazonaws.kafka#UpdateConnectivity" }, { "target": "com.amazonaws.kafka#UpdateMonitoring" }, { "target": "com.amazonaws.kafka#UpdateRebalancing" }, { "target": "com.amazonaws.kafka#UpdateReplicationInfo" }, { "target": "com.amazonaws.kafka#UpdateSecurity" }, { "target": "com.amazonaws.kafka#UpdateStorage" }, { "target": "com.amazonaws.kafka#UpdateTopic" } ], "traits": { "aws.api#service": { "sdkId": "Kafka", "arnNamespace": "kafka", "cloudFormationName": "MSK", "cloudTrailEventSource": "kafka.amazonaws.com", "endpointPrefix": "kafka" }, "aws.auth#sigv4": { "name": "kafka" }, "aws.protocols#restJson1": {}, "smithy.api#auth": [ "aws.auth#sigv4" ], "smithy.api#documentation": "

The operations for managing an Amazon MSK cluster.

", "smithy.api#title": "Managed Streaming for Kafka", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-eusc" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://kafka-api.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://kafka-api-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://kafka.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://kafka-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://kafka-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://kafka.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 20, "nodes": "/////wAAAAH/////AAAAAAAAABMAAAADAAAAAQAAAAQF9eENAAAAAgAAAAUF9eENAAAAAwAAAAwAAAAGAAAABAAAAAcF9eEGAAAABQX14QQAAAAIAAAABgX14QQAAAAJAAAABwX14QQAAAAKAAAACAX14QQAAAALAAAACQX14QsF9eEMAAAABAAAAA8AAAANAAAACAX14QYAAAAOAAAACgX14QkF9eEKAAAABQX14QUAAAAQAAAACAX14QQAAAARAAAACQAAABIF9eEIAAAACgX14QcF9eEIAAAAAwX14QEAAAAUAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://kafka-api.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://kafka-api-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://kafka-api.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://kafka-api.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://kafka-api.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://kafka.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-eusc" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://kafka-api.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kafka-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kafka-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kafka.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://kafka.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://kafka-api-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://kafka-api.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://kafka-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://kafka-api.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka-fips.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka-fips.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka-fips.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://kafka-api.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://kafka-api.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kafka.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.kafka#KafkaCluster": { "type": "structure", "members": { "AmazonMskCluster": { "target": "com.amazonaws.kafka#AmazonMskCluster", "traits": { "smithy.api#documentation": "

Details of an Amazon MSK Cluster.

", "smithy.api#jsonName": "amazonMskCluster" } }, "ApacheKafkaCluster": { "target": "com.amazonaws.kafka#ApacheKafkaCluster", "traits": { "smithy.api#documentation": "

Details of an Apache Kafka Cluster.

", "smithy.api#jsonName": "apacheKafkaCluster" } }, "VpcConfig": { "target": "com.amazonaws.kafka#KafkaClusterClientVpcConfig", "traits": { "smithy.api#documentation": "

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

", "smithy.api#jsonName": "vpcConfig" } }, "ClientAuthentication": { "target": "com.amazonaws.kafka#KafkaClusterClientAuthentication", "traits": { "smithy.api#documentation": "

Details of the client authentication used by the Apache Kafka cluster.

", "smithy.api#jsonName": "clientAuthentication" } }, "EncryptionInTransit": { "target": "com.amazonaws.kafka#KafkaClusterEncryptionInTransit", "traits": { "smithy.api#documentation": "

Details of encryption in transit to the Apache Kafka cluster.

", "smithy.api#jsonName": "encryptionInTransit" } } }, "traits": { "smithy.api#documentation": "

Information about Kafka Cluster to be used as source / target for replication.

" } }, "com.amazonaws.kafka#KafkaClusterClientAuthentication": { "type": "structure", "members": { "SaslScram": { "target": "com.amazonaws.kafka#KafkaClusterSaslScramAuthentication", "traits": { "smithy.api#documentation": "

Details for SASL/SCRAM client authentication.

", "smithy.api#jsonName": "saslScram" } }, "MTLS": { "target": "com.amazonaws.kafka#KafkaClusterMTLSAuthentication", "traits": { "smithy.api#documentation": "

Details for mTLS client authentication.

", "smithy.api#jsonName": "mTLS" } }, "SaslOAuthBearer": { "target": "com.amazonaws.kafka#KafkaClusterSaslOAuthBearerAuthentication", "traits": { "smithy.api#documentation": "

Details for SASL/OAUTHBEARER client authentication.

", "smithy.api#jsonName": "saslOAuthBearer" } } }, "traits": { "smithy.api#documentation": "

Details of the client authentication used by the Apache Kafka cluster.

" } }, "com.amazonaws.kafka#KafkaClusterClientVpcConfig": { "type": "structure", "members": { "SecurityGroupIds": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

The security groups to attach to the ENIs for the broker nodes.

", "smithy.api#jsonName": "securityGroupIds" } }, "SubnetIds": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The list of subnets in the client VPC to connect to.

", "smithy.api#jsonName": "subnetIds", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

" } }, "com.amazonaws.kafka#KafkaClusterDescription": { "type": "structure", "members": { "AmazonMskCluster": { "target": "com.amazonaws.kafka#AmazonMskCluster", "traits": { "smithy.api#documentation": "

Details of an Amazon MSK Cluster.

", "smithy.api#jsonName": "amazonMskCluster" } }, "ApacheKafkaCluster": { "target": "com.amazonaws.kafka#ApacheKafkaCluster", "traits": { "smithy.api#documentation": "

Details of an Apache Kafka Cluster.

", "smithy.api#jsonName": "apacheKafkaCluster" } }, "KafkaClusterAlias": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The alias of the Kafka cluster. Used to prefix names of replicated topics.

", "smithy.api#jsonName": "kafkaClusterAlias" } }, "VpcConfig": { "target": "com.amazonaws.kafka#KafkaClusterClientVpcConfig", "traits": { "smithy.api#documentation": "

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

", "smithy.api#jsonName": "vpcConfig" } }, "ClientAuthentication": { "target": "com.amazonaws.kafka#KafkaClusterClientAuthentication", "traits": { "smithy.api#documentation": "

Details of the client authentication used by the Apache Kafka cluster.

", "smithy.api#jsonName": "clientAuthentication" } }, "EncryptionInTransit": { "target": "com.amazonaws.kafka#KafkaClusterEncryptionInTransit", "traits": { "smithy.api#documentation": "

Details of encryption in transit to the Apache Kafka cluster.

", "smithy.api#jsonName": "encryptionInTransit" } } }, "traits": { "smithy.api#documentation": "

Information about Kafka Cluster used as source / target for replication.

" } }, "com.amazonaws.kafka#KafkaClusterEncryptionInTransit": { "type": "structure", "members": { "EncryptionType": { "target": "com.amazonaws.kafka#KafkaClusterEncryptionInTransitType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The type of encryption in transit to the Apache Kafka cluster.

", "smithy.api#jsonName": "encryptionType", "smithy.api#required": {} } }, "RootCaCertificate": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The root CA certificate.

", "smithy.api#jsonName": "rootCaCertificate" } } }, "traits": { "smithy.api#documentation": "

Details of encryption in transit to the Apache Kafka cluster.

" } }, "com.amazonaws.kafka#KafkaClusterEncryptionInTransitType": { "type": "enum", "members": { "TLS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TLS" } } }, "traits": { "smithy.api#documentation": "

The type of encryption in transit to the Apache Kafka cluster.

" } }, "com.amazonaws.kafka#KafkaClusterMTLSAuthentication": { "type": "structure", "members": { "SecretArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Secrets Manager secret.

", "smithy.api#jsonName": "secretArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details for mTLS client authentication.

" } }, "com.amazonaws.kafka#KafkaClusterOAuthClientCredentials": { "type": "structure", "members": { "TokenRequestSecretArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Secrets Manager secret containing the OAuth client credentials.

", "smithy.api#jsonName": "tokenRequestSecretArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details for SASL/OAUTHBEARER using standard client_credentials grant.

" } }, "com.amazonaws.kafka#KafkaClusterOAuthClientCredentialsAssertion": { "type": "structure", "members": { "Audience": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The audience for the JWT client assertion.

", "smithy.api#jsonName": "audience", "smithy.api#required": {} } }, "SigningAlgorithm": { "target": "com.amazonaws.kafka#JwtSigningAlgorithm", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The signing algorithm for the JWT client assertion.

", "smithy.api#jsonName": "signingAlgorithm", "smithy.api#required": {} } }, "TokenRequestSecretArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Secrets Manager secret containing the signing key.

", "smithy.api#jsonName": "tokenRequestSecretArn" } } }, "traits": { "smithy.api#documentation": "

Details for SASL/OAUTHBEARER using client credentials grant with JWT client assertion.

" } }, "com.amazonaws.kafka#KafkaClusterOAuthIamJwtBearer": { "type": "structure", "members": { "Audience": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The audience for the JWT Bearer assertion.

", "smithy.api#jsonName": "audience", "smithy.api#required": {} } }, "SigningAlgorithm": { "target": "com.amazonaws.kafka#JwtSigningAlgorithm", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The signing algorithm for the JWT Bearer assertion.

", "smithy.api#jsonName": "signingAlgorithm", "smithy.api#required": {} } }, "TokenRequestSecretArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Secrets Manager secret containing the signing key.

", "smithy.api#jsonName": "tokenRequestSecretArn" } } }, "traits": { "smithy.api#documentation": "

Details for SASL/OAUTHBEARER using JWT Bearer assertion grant.

" } }, "com.amazonaws.kafka#KafkaClusterSaslOAuthBearerAuthentication": { "type": "structure", "members": { "TokenEndpointUrl": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The HTTPS URL of the OAuth token endpoint that vends OAuth Bearer tokens per RFC 6749.

", "smithy.api#jsonName": "tokenEndpointUrl", "smithy.api#required": {} } }, "ClientCredentials": { "target": "com.amazonaws.kafka#KafkaClusterOAuthClientCredentials", "traits": { "smithy.api#documentation": "

Details for SASL/OAUTHBEARER using standard client_credentials grant.

", "smithy.api#jsonName": "clientCredentials" } }, "IamJwtBearer": { "target": "com.amazonaws.kafka#KafkaClusterOAuthIamJwtBearer", "traits": { "smithy.api#documentation": "

Details for SASL/OAUTHBEARER using JWT Bearer assertion grant (RFC 7523).

", "smithy.api#jsonName": "iamJwtBearer" } }, "ClientCredentialsAssertion": { "target": "com.amazonaws.kafka#KafkaClusterOAuthClientCredentialsAssertion", "traits": { "smithy.api#documentation": "

Details for SASL/OAUTHBEARER using client credentials grant with JWT client assertion.

", "smithy.api#jsonName": "clientCredentialsAssertion" } }, "TokenEndpointAuthenticationMethod": { "target": "com.amazonaws.kafka#TokenEndpointAuthenticationMethod", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

How client credentials are sent to the identity provider. Valid values are POST, BASIC, or NONE.

", "smithy.api#jsonName": "tokenEndpointAuthenticationMethod", "smithy.api#required": {} } }, "Scope": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

OAuth scope to request.

", "smithy.api#jsonName": "scope" } }, "TokenEndpointTlsCertificateArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Secrets Manager ARN containing a custom CA certificate for the identity provider.

", "smithy.api#jsonName": "tokenEndpointTlsCertificateArn" } } }, "traits": { "smithy.api#documentation": "

Details for SASL/OAUTHBEARER client authentication.

" } }, "com.amazonaws.kafka#KafkaClusterSaslScramAuthentication": { "type": "structure", "members": { "Mechanism": { "target": "com.amazonaws.kafka#KafkaClusterSaslScramMechanism", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The SASL/SCRAM authentication mechanism.

", "smithy.api#jsonName": "mechanism", "smithy.api#required": {} } }, "SecretArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Secrets Manager secret.

", "smithy.api#jsonName": "secretArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details for SASL/SCRAM client authentication.

" } }, "com.amazonaws.kafka#KafkaClusterSaslScramMechanism": { "type": "enum", "members": { "SHA256": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHA256" } }, "SHA512": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHA512" } } }, "traits": { "smithy.api#documentation": "

The SASL/SCRAM authentication mechanism.

" } }, "com.amazonaws.kafka#KafkaClusterSummary": { "type": "structure", "members": { "AmazonMskCluster": { "target": "com.amazonaws.kafka#AmazonMskCluster", "traits": { "smithy.api#documentation": "

Details of an Amazon MSK Cluster.

", "smithy.api#jsonName": "amazonMskCluster" } }, "ApacheKafkaCluster": { "target": "com.amazonaws.kafka#ApacheKafkaCluster", "traits": { "smithy.api#documentation": "

Details of an Apache Kafka Cluster.

", "smithy.api#jsonName": "apacheKafkaCluster" } }, "KafkaClusterAlias": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The alias of the Kafka cluster. Used to prefix names of replicated topics.

", "smithy.api#jsonName": "kafkaClusterAlias" } } }, "traits": { "smithy.api#documentation": "

Summarized information about Kafka Cluster used as source / target for replication.

" } }, "com.amazonaws.kafka#KafkaRequestException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.kafka#KafkaTimeoutException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.kafka#KafkaVersion": { "type": "structure", "members": { "Version": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#jsonName": "version" } }, "Status": { "target": "com.amazonaws.kafka#KafkaVersionStatus", "traits": { "smithy.api#jsonName": "status" } } } }, "com.amazonaws.kafka#KafkaVersionStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DEPRECATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPRECATED" } } } }, "com.amazonaws.kafka#ListAssessmentFindings": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListAssessmentFindingsRequest" }, "output": { "target": "com.amazonaws.kafka#ListAssessmentFindingsResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ConflictException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns the findings for a completed assessment. Paginated.

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/assessments/{AssessmentArn}/findings", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Findings", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListAssessmentFindingsRequest": { "type": "structure", "members": { "AssessmentArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the assessment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Category": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Optional filter. Only return findings matching this category.

", "smithy.api#httpQuery": "category" } }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.kafka#__integerMin1Max500", "traits": { "smithy.api#documentation": "

Maximum number of findings to return. Default 100, maximum 500.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

If the response is truncated, it returns a nextToken. Send this in the subsequent request to get the remaining results.

", "smithy.api#httpQuery": "nextToken" } }, "Severity": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Optional filter. Only return findings matching this severity.

", "smithy.api#httpQuery": "severity" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListAssessmentFindingsResponse": { "type": "structure", "members": { "Findings": { "target": "com.amazonaws.kafka#__listOfAssessmentFinding", "traits": { "smithy.api#documentation": "

A list of findings from the assessment.

", "smithy.api#jsonName": "findings" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

If the response is truncated, it returns a nextToken. Send this in the subsequent request to get the remaining results.

", "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#documentation": "

Returns the findings for a completed assessment.

", "smithy.api#output": {} } }, "com.amazonaws.kafka#ListAssessments": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListAssessmentsRequest" }, "output": { "target": "com.amazonaws.kafka#ListAssessmentsResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns a list of assessments for the specified cluster. Optionally filterable by assessment type.

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/assessments", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Assessments", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListAssessmentsRequest": { "type": "structure", "members": { "AssessmentType": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Optional filter. The type of assessment to filter by.

", "smithy.api#httpQuery": "assessmentType" } }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster to list assessments for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

Maximum number of assessments to return. Default 25, maximum 100.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

If the response is truncated, it returns a nextToken. Send this in the subsequent request to get the remaining results.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListAssessmentsResponse": { "type": "structure", "members": { "Assessments": { "target": "com.amazonaws.kafka#__listOfAssessmentInfo", "traits": { "smithy.api#documentation": "

A list of assessment summaries.

", "smithy.api#jsonName": "assessments" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

If the response is truncated, it returns a nextToken. Send this in the subsequent request to get the remaining results.

", "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#documentation": "

Returns a list of assessments.

", "smithy.api#output": {} } }, "com.amazonaws.kafka#ListChannels": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListChannelsRequest" }, "output": { "target": "com.amazonaws.kafka#ListChannelsResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns the list of channels in a cluster.

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/channels", "code": 200 } } }, "com.amazonaws.kafka#ListChannelsRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

Maximum number of channels to return in a single response.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

If the response of ListChannels is truncated, it returns a nextToken in the response. This nextToken should be sent in the subsequent request to ListChannels.

", "smithy.api#httpQuery": "nextToken" } }, "TopicNameFilter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Filters results to channels whose topic name matches the specified value.

", "smithy.api#httpQuery": "topicNameFilter" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListChannelsResponse": { "type": "structure", "members": { "Channels": { "target": "com.amazonaws.kafka#__listOfChannelInfo", "traits": { "smithy.api#documentation": "

The list of channels in the cluster.

", "smithy.api#jsonName": "channels" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

If the response from ListChannels is truncated, this token is included. Send it as the nextToken parameter on a subsequent ListChannels call to retrieve the next page.

", "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#documentation": "

Returns the list of channels in the cluster.

", "smithy.api#output": {} } }, "com.amazonaws.kafka#ListClientVpcConnections": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListClientVpcConnectionsRequest" }, "output": { "target": "com.amazonaws.kafka#ListClientVpcConnectionsResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/client-vpc-connections", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ClientVpcConnections", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListClientVpcConnectionsRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListClientVpcConnectionsResponse": { "type": "structure", "members": { "ClientVpcConnections": { "target": "com.amazonaws.kafka#__listOfClientVpcConnection", "traits": { "smithy.api#documentation": "

List of client VPC connections.

", "smithy.api#jsonName": "clientVpcConnections" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#ListClusterOperations": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListClusterOperationsRequest" }, "output": { "target": "com.amazonaws.kafka#ListClusterOperationsResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/operations", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ClusterOperationInfoList", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListClusterOperationsRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListClusterOperationsResponse": { "type": "structure", "members": { "ClusterOperationInfoList": { "target": "com.amazonaws.kafka#__listOfClusterOperationInfo", "traits": { "smithy.api#documentation": "

An array of cluster operation information objects.

", "smithy.api#jsonName": "clusterOperationInfoList" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#ListClusterOperationsV2": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListClusterOperationsV2Request" }, "output": { "target": "com.amazonaws.kafka#ListClusterOperationsV2Response" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/api/v2/clusters/{ClusterArn}/operations", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ClusterOperationInfoList", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListClusterOperationsV2Request": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "The arn of the cluster whose operations are being requested.", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "The maxResults of the query.", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "The nextToken of the query.", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListClusterOperationsV2Response": { "type": "structure", "members": { "ClusterOperationInfoList": { "target": "com.amazonaws.kafka#__listOfClusterOperationV2Summary", "traits": { "smithy.api#documentation": "

An array of cluster operation information objects.

", "smithy.api#jsonName": "clusterOperationInfoList" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#ListClusters": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListClustersRequest" }, "output": { "target": "com.amazonaws.kafka#ListClustersResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ClusterInfoList", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListClustersRequest": { "type": "structure", "members": { "ClusterNameFilter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "clusterNameFilter" } }, "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListClustersResponse": { "type": "structure", "members": { "ClusterInfoList": { "target": "com.amazonaws.kafka#__listOfClusterInfo", "traits": { "smithy.api#documentation": "

Information on each of the MSK clusters in the response.

", "smithy.api#jsonName": "clusterInfoList" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#ListClustersV2": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListClustersV2Request" }, "output": { "target": "com.amazonaws.kafka#ListClustersV2Response" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/api/v2/clusters", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ClusterInfoList", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListClustersV2Request": { "type": "structure", "members": { "ClusterNameFilter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "clusterNameFilter" } }, "ClusterTypeFilter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Specify either PROVISIONED or SERVERLESS.

", "smithy.api#httpQuery": "clusterTypeFilter" } }, "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListClustersV2Response": { "type": "structure", "members": { "ClusterInfoList": { "target": "com.amazonaws.kafka#__listOfCluster", "traits": { "smithy.api#documentation": "

Information on each of the MSK clusters in the response.

", "smithy.api#jsonName": "clusterInfoList" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#ListConfigurationRevisions": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListConfigurationRevisionsRequest" }, "output": { "target": "com.amazonaws.kafka#ListConfigurationRevisionsResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/v1/configurations/{Arn}/revisions", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Revisions", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListConfigurationRevisionsRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListConfigurationRevisionsResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Paginated results marker.

", "smithy.api#jsonName": "nextToken" } }, "Revisions": { "target": "com.amazonaws.kafka#__listOfConfigurationRevision", "traits": { "smithy.api#documentation": "

List of ConfigurationRevision objects.

", "smithy.api#jsonName": "revisions" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#ListConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListConfigurationsRequest" }, "output": { "target": "com.amazonaws.kafka#ListConfigurationsResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/v1/configurations", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Configurations", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListConfigurationsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListConfigurationsResponse": { "type": "structure", "members": { "Configurations": { "target": "com.amazonaws.kafka#__listOfConfiguration", "traits": { "smithy.api#documentation": "

An array of MSK configurations.

", "smithy.api#jsonName": "configurations" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#ListKafkaVersions": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListKafkaVersionsRequest" }, "output": { "target": "com.amazonaws.kafka#ListKafkaVersionsResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns a list of Apache Kafka versions.

", "smithy.api#http": { "method": "GET", "uri": "/v1/kafka-versions", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "KafkaVersions", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListKafkaVersionsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListKafkaVersionsResponse": { "type": "structure", "members": { "KafkaVersions": { "target": "com.amazonaws.kafka#__listOfKafkaVersion", "traits": { "smithy.api#jsonName": "kafkaVersions" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#ListNodes": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListNodesRequest" }, "output": { "target": "com.amazonaws.kafka#ListNodesResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" } ], "traits": { "smithy.api#documentation": "

Returns a list of the broker nodes in the cluster.

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/nodes", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "NodeInfoList", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListNodesRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListNodesResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "nextToken" } }, "NodeInfoList": { "target": "com.amazonaws.kafka#__listOfNodeInfo", "traits": { "smithy.api#documentation": "

List containing a NodeInfo object.

", "smithy.api#jsonName": "nodeInfoList" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#ListReplicators": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListReplicatorsRequest" }, "output": { "target": "com.amazonaws.kafka#ListReplicatorsResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists the replicators.

", "smithy.api#http": { "method": "GET", "uri": "/replication/v1/replicators", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Replicators", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListReplicatorsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#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.

", "smithy.api#httpQuery": "nextToken" } }, "ReplicatorNameFilter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Returns replicators starting with given name.

", "smithy.api#httpQuery": "replicatorNameFilter" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListReplicatorsResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#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.

", "smithy.api#jsonName": "nextToken" } }, "Replicators": { "target": "com.amazonaws.kafka#__listOfReplicatorSummary", "traits": { "smithy.api#documentation": "

List containing information of each of the replicators in the account.

", "smithy.api#jsonName": "replicators" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#ListScramSecrets": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListScramSecretsRequest" }, "output": { "target": "com.amazonaws.kafka#ListScramSecretsResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/scram-secrets", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "SecretArnList", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListScramSecretsRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The arn of the cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

The maxResults of the query.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The nextToken of the query.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListScramSecretsResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Paginated results marker.

", "smithy.api#jsonName": "nextToken" } }, "SecretArnList": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

The list of scram secrets associated with the cluster.

", "smithy.api#jsonName": "secretArnList" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.kafka#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/v1/tags/{ResourceArn}", "code": 200 } } }, "com.amazonaws.kafka#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#documentation": "

The key-value pair for the resource tag.

", "smithy.api#jsonName": "tags" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#ListTopicReassignments": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListTopicReassignmentsRequest" }, "output": { "target": "com.amazonaws.kafka#ListTopicReassignmentsResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists topic reassignment operations for a cluster.

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/topic-reassignments", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Reassignments", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListTopicReassignmentsRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

Maximum number of reassignment operations to return. Default 50, maximum 100.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

If the response is truncated, it returns a nextToken. Send this in the subsequent request to get the remaining results.

", "smithy.api#httpQuery": "nextToken" } }, "StatusFilter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Optional filter. Only return reassignments matching these statuses.

", "smithy.api#httpQuery": "statusFilter" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListTopicReassignmentsResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

If the response is truncated, it returns a nextToken. Send this in the subsequent request to get the remaining results.

", "smithy.api#jsonName": "nextToken" } }, "Reassignments": { "target": "com.amazonaws.kafka#__listOfTopicReassignmentInfo", "traits": { "smithy.api#documentation": "

A list of topic reassignment operation summaries.

", "smithy.api#jsonName": "reassignments" } } }, "traits": { "smithy.api#documentation": "

Returns a list of topic reassignment operations for a cluster.

", "smithy.api#output": {} } }, "com.amazonaws.kafka#ListTopics": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListTopicsRequest" }, "output": { "target": "com.amazonaws.kafka#ListTopicsResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

List topics in a MSK cluster.

", "smithy.api#http": { "method": "GET", "uri": "/v1/clusters/{ClusterArn}/topics", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Topics", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListTopicsRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } }, "TopicNameFilter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Returns topics starting with given name.

", "smithy.api#httpQuery": "topicNameFilter" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListTopicsResponse": { "type": "structure", "members": { "Topics": { "target": "com.amazonaws.kafka#__listOfTopicInfo", "traits": { "smithy.api#documentation": "

List containing topics info.

", "smithy.api#jsonName": "topics" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#ListVpcConnections": { "type": "operation", "input": { "target": "com.amazonaws.kafka#ListVpcConnectionsRequest" }, "output": { "target": "com.amazonaws.kafka#ListVpcConnectionsResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/v1/vpc-connections", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "VpcConnections", "pageSize": "MaxResults" } } }, "com.amazonaws.kafka#ListVpcConnectionsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.kafka#MaxResults", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#ListVpcConnectionsResponse": { "type": "structure", "members": { "VpcConnections": { "target": "com.amazonaws.kafka#__listOfVpcConnection", "traits": { "smithy.api#documentation": "

List of VPC connections.

", "smithy.api#jsonName": "vpcConnections" } }, "NextToken": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#LogDelivery": { "type": "structure", "members": { "ReplicatorLogDelivery": { "target": "com.amazonaws.kafka#ReplicatorLogDelivery", "traits": { "smithy.api#documentation": "

Configuration for replicator log delivery.

", "smithy.api#jsonName": "replicatorLogDelivery" } } }, "traits": { "smithy.api#documentation": "

Configuration for log delivery to customer destinations.

" } }, "com.amazonaws.kafka#LoggingInfo": { "type": "structure", "members": { "AuthorizerLogs": { "target": "com.amazonaws.kafka#AuthorizerLogs", "traits": { "smithy.api#documentation": "

You can configure your MSK cluster to send authorizer logs to different destination types.

", "smithy.api#jsonName": "authorizerLogs" } }, "BrokerLogs": { "target": "com.amazonaws.kafka#BrokerLogs", "traits": { "smithy.api#clientOptional": {}, "smithy.api#jsonName": "brokerLogs", "smithy.api#required": {} } } } }, "com.amazonaws.kafka#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.kafka#MutableClusterInfo": { "type": "structure", "members": { "BrokerEBSVolumeInfo": { "target": "com.amazonaws.kafka#__listOfBrokerEBSVolumeInfo", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "brokerEBSVolumeInfo" } }, "ConfigurationInfo": { "target": "com.amazonaws.kafka#ConfigurationInfo", "traits": { "smithy.api#documentation": "

Information about the changes in the configuration of the brokers.

", "smithy.api#jsonName": "configurationInfo" } }, "NumberOfBrokerNodes": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

The number of broker nodes in the cluster.

", "smithy.api#jsonName": "numberOfBrokerNodes" } }, "EnhancedMonitoring": { "target": "com.amazonaws.kafka#EnhancedMonitoring", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "enhancedMonitoring" } }, "OpenMonitoring": { "target": "com.amazonaws.kafka#OpenMonitoring", "traits": { "smithy.api#documentation": "

The settings for open monitoring.

", "smithy.api#jsonName": "openMonitoring" } }, "ZookeeperAccess": { "target": "com.amazonaws.kafka#ZookeeperAccess", "traits": { "smithy.api#documentation": "

Access control settings for zookeeper

", "smithy.api#jsonName": "zookeeperAccess" } }, "KafkaVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Apache Kafka version.

", "smithy.api#jsonName": "kafkaVersion" } }, "LoggingInfo": { "target": "com.amazonaws.kafka#LoggingInfo", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "loggingInfo" } }, "InstanceType": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Information about the Amazon MSK broker type.

", "smithy.api#jsonName": "instanceType" } }, "ClientAuthentication": { "target": "com.amazonaws.kafka#ClientAuthentication", "traits": { "smithy.api#documentation": "

Includes all client authentication information.

", "smithy.api#jsonName": "clientAuthentication" } }, "EncryptionInfo": { "target": "com.amazonaws.kafka#EncryptionInfo", "traits": { "smithy.api#documentation": "

Includes all encryption-related information.

", "smithy.api#jsonName": "encryptionInfo" } }, "ConnectivityInfo": { "target": "com.amazonaws.kafka#ConnectivityInfo", "traits": { "smithy.api#documentation": "

Information about the broker access configuration.

", "smithy.api#jsonName": "connectivityInfo" } }, "StorageMode": { "target": "com.amazonaws.kafka#StorageMode", "traits": { "smithy.api#documentation": "

This controls storage mode for supported storage tiers.

", "smithy.api#jsonName": "storageMode" } }, "BrokerCountUpdateInfo": { "target": "com.amazonaws.kafka#BrokerCountUpdateInfo", "traits": { "smithy.api#documentation": "

Describes brokers being changed during a broker count update.

", "smithy.api#jsonName": "brokerCountUpdateInfo" } }, "Rebalancing": { "target": "com.amazonaws.kafka#Rebalancing", "traits": { "smithy.api#documentation": "

Describes the intelligent rebalancing configuration of an MSK Provisioned cluster with Express brokers.

", "smithy.api#jsonName": "rebalancing" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.kafka#NetworkType": { "type": "enum", "members": { "IPV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IPV4" } }, "DUAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DUAL" } } }, "traits": { "smithy.api#documentation": "

The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

By default, a cluster uses the IPv4 network type.

" } }, "com.amazonaws.kafka#NodeExporter": { "type": "structure", "members": { "EnabledInBroker": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "enabledInBroker", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.kafka#NodeExporterInfo": { "type": "structure", "members": { "EnabledInBroker": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "enabledInBroker", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.kafka#NodeInfo": { "type": "structure", "members": { "AddedToClusterTime": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The start time.

", "smithy.api#jsonName": "addedToClusterTime" } }, "BrokerNodeInfo": { "target": "com.amazonaws.kafka#BrokerNodeInfo", "traits": { "smithy.api#documentation": "

The broker node info.

", "smithy.api#jsonName": "brokerNodeInfo" } }, "ControllerNodeInfo": { "target": "com.amazonaws.kafka#ControllerNodeInfo", "traits": { "smithy.api#documentation": "

The ControllerNodeInfo.

", "smithy.api#jsonName": "controllerNodeInfo" } }, "InstanceType": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The instance type.

", "smithy.api#jsonName": "instanceType" } }, "NodeARN": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the node.

", "smithy.api#jsonName": "nodeARN" } }, "NodeType": { "target": "com.amazonaws.kafka#NodeType", "traits": { "smithy.api#documentation": "

The node type.

", "smithy.api#jsonName": "nodeType" } }, "ZookeeperNodeInfo": { "target": "com.amazonaws.kafka#ZookeeperNodeInfo", "traits": { "smithy.api#documentation": "

The ZookeeperNodeInfo.

", "smithy.api#jsonName": "zookeeperNodeInfo" } } }, "traits": { "smithy.api#documentation": "

The node information object.

" } }, "com.amazonaws.kafka#NodeType": { "type": "enum", "members": { "BROKER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BROKER" } } }, "traits": { "smithy.api#documentation": "

The broker or Zookeeper node.

" } }, "com.amazonaws.kafka#NotControllerException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.kafka#NotFoundException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.kafka#OpenMonitoring": { "type": "structure", "members": { "Prometheus": { "target": "com.amazonaws.kafka#Prometheus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Prometheus settings.

", "smithy.api#jsonName": "prometheus", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

JMX and Node monitoring for the MSK cluster.

" } }, "com.amazonaws.kafka#OpenMonitoringInfo": { "type": "structure", "members": { "Prometheus": { "target": "com.amazonaws.kafka#PrometheusInfo", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Prometheus settings.

", "smithy.api#jsonName": "prometheus", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

JMX and Node monitoring for the MSK cluster.

" } }, "com.amazonaws.kafka#PartitionSource": { "type": "structure", "members": { "SourceName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Source name.

", "smithy.api#jsonName": "sourceName" } } }, "traits": { "smithy.api#documentation": "

A source column used by an Apache Iceberg destination table's partition specification.

" } }, "com.amazonaws.kafka#PartitionSpec": { "type": "structure", "members": { "PartitionStrategy": { "target": "com.amazonaws.kafka#PartitionStrategy", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The partitioning strategy applied to records written to the table.

", "smithy.api#jsonName": "partitionStrategy", "smithy.api#required": {} } }, "SourceList": { "target": "com.amazonaws.kafka#__listOfPartitionSource", "traits": { "smithy.api#documentation": "

The source columns used by the partitioning strategy. For TIME_HOUR, must contain exactly one source column whose value is a timestamp.

", "smithy.api#jsonName": "sourceList" } } }, "traits": { "smithy.api#documentation": "

Partition specification for an Apache Iceberg destination table.

" } }, "com.amazonaws.kafka#PartitionStrategy": { "type": "enum", "members": { "TIME_HOUR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIME_HOUR" } } }, "traits": { "smithy.api#documentation": "

The partitioning strategy used to partition records in the destination Apache Iceberg table.

" } }, "com.amazonaws.kafka#Prometheus": { "type": "structure", "members": { "JmxExporter": { "target": "com.amazonaws.kafka#JmxExporter", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "jmxExporter" } }, "NodeExporter": { "target": "com.amazonaws.kafka#NodeExporter", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "nodeExporter" } } }, "traits": { "smithy.api#documentation": "

Prometheus settings.

" } }, "com.amazonaws.kafka#PrometheusInfo": { "type": "structure", "members": { "JmxExporter": { "target": "com.amazonaws.kafka#JmxExporterInfo", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "jmxExporter" } }, "NodeExporter": { "target": "com.amazonaws.kafka#NodeExporterInfo", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "nodeExporter" } } }, "traits": { "smithy.api#documentation": "

Prometheus settings.

" } }, "com.amazonaws.kafka#Provisioned": { "type": "structure", "members": { "BrokerNodeGroupInfo": { "target": "com.amazonaws.kafka#BrokerNodeGroupInfo", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Information about the brokers.

", "smithy.api#jsonName": "brokerNodeGroupInfo", "smithy.api#required": {} } }, "Rebalancing": { "target": "com.amazonaws.kafka#Rebalancing", "traits": { "smithy.api#documentation": "

Specifies whether or not intelligent rebalancing is turned on for a newly created MSK Provisioned cluster with Express brokers. Intelligent rebalancing performs automatic partition balancing operations when you scale your clusters up or down. By default, intelligent rebalancing is ACTIVE for all new Express-based clusters.

", "smithy.api#jsonName": "rebalancing" } }, "CurrentBrokerSoftwareInfo": { "target": "com.amazonaws.kafka#BrokerSoftwareInfo", "traits": { "smithy.api#documentation": "

Information about the Apache Kafka version deployed on the brokers.

", "smithy.api#jsonName": "currentBrokerSoftwareInfo" } }, "ClientAuthentication": { "target": "com.amazonaws.kafka#ClientAuthentication", "traits": { "smithy.api#documentation": "

Includes all client authentication information.

", "smithy.api#jsonName": "clientAuthentication" } }, "EncryptionInfo": { "target": "com.amazonaws.kafka#EncryptionInfo", "traits": { "smithy.api#documentation": "

Includes all encryption-related information.

", "smithy.api#jsonName": "encryptionInfo" } }, "EnhancedMonitoring": { "target": "com.amazonaws.kafka#EnhancedMonitoring", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "enhancedMonitoring" } }, "OpenMonitoring": { "target": "com.amazonaws.kafka#OpenMonitoringInfo", "traits": { "smithy.api#documentation": "

The settings for open monitoring.

", "smithy.api#jsonName": "openMonitoring" } }, "LoggingInfo": { "target": "com.amazonaws.kafka#LoggingInfo", "traits": { "smithy.api#documentation": "

Log delivery information for the cluster.

", "smithy.api#jsonName": "loggingInfo" } }, "NumberOfBrokerNodes": { "target": "com.amazonaws.kafka#__integerMin1Max15", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The number of broker nodes in the cluster.

", "smithy.api#jsonName": "numberOfBrokerNodes", "smithy.api#required": {} } }, "ZookeeperConnectString": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "zookeeperConnectString" } }, "ZookeeperConnectStringTls": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "zookeeperConnectStringTls" } }, "StorageMode": { "target": "com.amazonaws.kafka#StorageMode", "traits": { "smithy.api#documentation": "

This controls storage mode for supported storage tiers.

", "smithy.api#jsonName": "storageMode" } }, "CustomerActionStatus": { "target": "com.amazonaws.kafka#CustomerActionStatus", "traits": { "smithy.api#documentation": "

Determines if there is an action required from the customer.

", "smithy.api#jsonName": "customerActionStatus" } } }, "traits": { "smithy.api#documentation": "

Provisioned cluster.

" } }, "com.amazonaws.kafka#ProvisionedRequest": { "type": "structure", "members": { "BrokerNodeGroupInfo": { "target": "com.amazonaws.kafka#BrokerNodeGroupInfo", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Information about the brokers.

", "smithy.api#jsonName": "brokerNodeGroupInfo", "smithy.api#required": {} } }, "Rebalancing": { "target": "com.amazonaws.kafka#Rebalancing", "traits": { "smithy.api#documentation": "

Specifies if intelligent rebalancing is turned on for your MSK Provisioned cluster with Express brokers. For all new Express-based clusters that you create, intelligent rebalancing is turned on by default.

", "smithy.api#jsonName": "rebalancing" } }, "ClientAuthentication": { "target": "com.amazonaws.kafka#ClientAuthentication", "traits": { "smithy.api#documentation": "

Includes all client authentication information.

", "smithy.api#jsonName": "clientAuthentication" } }, "ConfigurationInfo": { "target": "com.amazonaws.kafka#ConfigurationInfo", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "configurationInfo" } }, "EncryptionInfo": { "target": "com.amazonaws.kafka#EncryptionInfo", "traits": { "smithy.api#documentation": "

Includes all encryption-related information.

", "smithy.api#jsonName": "encryptionInfo" } }, "EnhancedMonitoring": { "target": "com.amazonaws.kafka#EnhancedMonitoring", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "enhancedMonitoring" } }, "OpenMonitoring": { "target": "com.amazonaws.kafka#OpenMonitoringInfo", "traits": { "smithy.api#documentation": "

The settings for open monitoring.

", "smithy.api#jsonName": "openMonitoring" } }, "KafkaVersion": { "target": "com.amazonaws.kafka#__stringMin1Max128", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Apache Kafka version that you want for the cluster.

", "smithy.api#jsonName": "kafkaVersion", "smithy.api#required": {} } }, "LoggingInfo": { "target": "com.amazonaws.kafka#LoggingInfo", "traits": { "smithy.api#documentation": "

Log delivery information for the cluster.

", "smithy.api#jsonName": "loggingInfo" } }, "NumberOfBrokerNodes": { "target": "com.amazonaws.kafka#__integerMin1Max15", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The number of broker nodes in the cluster.

", "smithy.api#jsonName": "numberOfBrokerNodes", "smithy.api#required": {} } }, "StorageMode": { "target": "com.amazonaws.kafka#StorageMode", "traits": { "smithy.api#documentation": "

This controls storage mode for supported storage tiers.

", "smithy.api#jsonName": "storageMode" } } }, "traits": { "smithy.api#documentation": "

Provisioned cluster request.

" } }, "com.amazonaws.kafka#ProvisionedThroughput": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

Provisioned throughput is enabled or not.

", "smithy.api#jsonName": "enabled" } }, "VolumeThroughput": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "volumeThroughput" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.kafka#PublicAccess": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "type" } } }, "traits": { "smithy.api#documentation": "Public access control for brokers." } }, "com.amazonaws.kafka#PutClusterPolicy": { "type": "operation", "input": { "target": "com.amazonaws.kafka#PutClusterPolicyRequest" }, "output": { "target": "com.amazonaws.kafka#PutClusterPolicyResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "PUT", "uri": "/v1/clusters/{ClusterArn}/policy", "code": 200 } } }, "com.amazonaws.kafka#PutClusterPolicyRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The policy version.

", "smithy.api#jsonName": "currentVersion" } }, "Policy": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The policy.

", "smithy.api#jsonName": "policy", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#PutClusterPolicyResponse": { "type": "structure", "members": { "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The policy version.

", "smithy.api#jsonName": "currentVersion" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#ReassignmentInProgressException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.kafka#Rebalancing": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.kafka#RebalancingStatus", "traits": { "smithy.api#documentation": "

Intelligent rebalancing status. The default intelligent rebalancing status is ACTIVE for all new Express-based clusters.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#documentation": "

Specifies whether or not intelligent rebalancing is turned on for a newly created MSK Provisioned cluster with Express brokers. Intelligent rebalancing performs automatic partition balancing operations when you scale your clusters up or down. By default, intelligent rebalancing is ACTIVE for all new Express-based clusters.

" } }, "com.amazonaws.kafka#RebalancingStatus": { "type": "enum", "members": { "PAUSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAUSED" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } } }, "traits": { "smithy.api#documentation": "

Intelligent rebalancing status. The default intelligent rebalancing status is ACTIVE for all new Express-based clusters.

" } }, "com.amazonaws.kafka#RebootBroker": { "type": "operation", "input": { "target": "com.amazonaws.kafka#RebootBrokerRequest" }, "output": { "target": "com.amazonaws.kafka#RebootBrokerResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Reboots brokers.", "smithy.api#http": { "method": "PUT", "uri": "/v1/clusters/{ClusterArn}/reboot-broker", "code": 200 } } }, "com.amazonaws.kafka#RebootBrokerRequest": { "type": "structure", "members": { "BrokerIds": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "brokerIds", "smithy.api#required": {} } }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Reboots a node.", "smithy.api#input": {} } }, "com.amazonaws.kafka#RebootBrokerResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterOperationArn" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#RecordConverter": { "type": "structure", "members": { "ValueConverter": { "target": "com.amazonaws.kafka#ValueConverter", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The deserialization format applied to Apache Kafka record values.

", "smithy.api#jsonName": "valueConverter", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Configuration that controls how Apache Kafka record values are deserialized for the destination.

" } }, "com.amazonaws.kafka#RecordSchema": { "type": "structure", "members": { "GsrArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Glue Schema Registry schema (not registry) used to validate records for the destination Apache Iceberg table.

", "smithy.api#jsonName": "gsrArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Schema configuration that controls how Apache Kafka record values are validated.

" } }, "com.amazonaws.kafka#RejectClientVpcConnection": { "type": "operation", "input": { "target": "com.amazonaws.kafka#RejectClientVpcConnectionRequest" }, "output": { "target": "com.amazonaws.kafka#RejectClientVpcConnectionResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns empty response.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/clusters/{ClusterArn}/client-vpc-connection", "code": 200 } } }, "com.amazonaws.kafka#RejectClientVpcConnectionRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "VpcConnectionArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The VPC connection ARN.

", "smithy.api#jsonName": "vpcConnectionArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#RejectClientVpcConnectionResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#ReplicationInfo": { "type": "structure", "members": { "ConsumerGroupReplication": { "target": "com.amazonaws.kafka#ConsumerGroupReplication", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Configuration relating to consumer group replication.

", "smithy.api#jsonName": "consumerGroupReplication", "smithy.api#required": {} } }, "SourceKafkaClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The ARN of the source Kafka cluster.

", "smithy.api#jsonName": "sourceKafkaClusterArn" } }, "SourceKafkaClusterId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The ID of the source Kafka cluster.

", "smithy.api#jsonName": "sourceKafkaClusterId" } }, "TargetCompressionType": { "target": "com.amazonaws.kafka#TargetCompressionType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The compression type to use when producing records to target cluster.

", "smithy.api#jsonName": "targetCompressionType", "smithy.api#required": {} } }, "TargetKafkaClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The ARN of the target Kafka cluster.

", "smithy.api#jsonName": "targetKafkaClusterArn" } }, "TargetKafkaClusterId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The ID of the target Kafka cluster.

", "smithy.api#jsonName": "targetKafkaClusterId" } }, "TopicReplication": { "target": "com.amazonaws.kafka#TopicReplication", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Configuration relating to topic replication.

", "smithy.api#jsonName": "topicReplication", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies configuration for replication between a source and target Kafka cluster.

" } }, "com.amazonaws.kafka#ReplicationInfoDescription": { "type": "structure", "members": { "ConsumerGroupReplication": { "target": "com.amazonaws.kafka#ConsumerGroupReplication", "traits": { "smithy.api#documentation": "

Configuration relating to consumer group replication.

", "smithy.api#jsonName": "consumerGroupReplication" } }, "SourceKafkaClusterAlias": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The alias of the source Kafka cluster.

", "smithy.api#jsonName": "sourceKafkaClusterAlias" } }, "TargetCompressionType": { "target": "com.amazonaws.kafka#TargetCompressionType", "traits": { "smithy.api#documentation": "

The compression type to use when producing records to target cluster.

", "smithy.api#jsonName": "targetCompressionType" } }, "TargetKafkaClusterAlias": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The alias of the target Kafka cluster.

", "smithy.api#jsonName": "targetKafkaClusterAlias" } }, "TopicReplication": { "target": "com.amazonaws.kafka#TopicReplication", "traits": { "smithy.api#documentation": "

Configuration relating to topic replication.

", "smithy.api#jsonName": "topicReplication" } } }, "traits": { "smithy.api#documentation": "

Specifies configuration for replication between a source and target Kafka cluster (sourceKafkaClusterAlias -> targetKafkaClusterAlias)

" } }, "com.amazonaws.kafka#ReplicationInfoSummary": { "type": "structure", "members": { "SourceKafkaClusterAlias": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The alias of the source Kafka cluster.

", "smithy.api#jsonName": "sourceKafkaClusterAlias" } }, "TargetKafkaClusterAlias": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The alias of the target Kafka cluster.

", "smithy.api#jsonName": "targetKafkaClusterAlias" } } }, "traits": { "smithy.api#documentation": "

Summarized information of replication between clusters.

" } }, "com.amazonaws.kafka#ReplicationStartingPosition": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.kafka#ReplicationStartingPositionType", "traits": { "smithy.api#documentation": "

The type of replication starting position.

", "smithy.api#jsonName": "type" } } }, "traits": { "smithy.api#documentation": "

Configuration for specifying the position in the topics to start replicating from.

" } }, "com.amazonaws.kafka#ReplicationStartingPositionType": { "type": "enum", "members": { "LATEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LATEST" } }, "EARLIEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EARLIEST" } } }, "traits": { "smithy.api#documentation": "

The type of replication starting position.

" } }, "com.amazonaws.kafka#ReplicationStateInfo": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "Code that describes the current state of the replicator.", "smithy.api#jsonName": "code" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "Message that describes the state of the replicator.", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "Details about the state of a replicator" } }, "com.amazonaws.kafka#ReplicationTopicNameConfiguration": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.kafka#ReplicationTopicNameConfigurationType", "traits": { "smithy.api#documentation": "

The type of replicated topic name.

", "smithy.api#jsonName": "type" } } }, "traits": { "smithy.api#documentation": "

Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.

" } }, "com.amazonaws.kafka#ReplicationTopicNameConfigurationType": { "type": "enum", "members": { "PREFIXED_WITH_SOURCE_CLUSTER_ALIAS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PREFIXED_WITH_SOURCE_CLUSTER_ALIAS" } }, "IDENTICAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IDENTICAL" } } }, "traits": { "smithy.api#documentation": "

The type of replicated topic name.

" } }, "com.amazonaws.kafka#ReplicatorCloudWatchLogs": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Whether log delivery to CloudWatch Logs is enabled.

", "smithy.api#jsonName": "enabled", "smithy.api#required": {} } }, "LogGroup": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The CloudWatch log group that is the destination for log delivery.

", "smithy.api#jsonName": "logGroup" } } }, "traits": { "smithy.api#documentation": "

Details about delivering logs to CloudWatch Logs.

" } }, "com.amazonaws.kafka#ReplicatorFirehose": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Whether log delivery to Firehose is enabled.

", "smithy.api#jsonName": "enabled", "smithy.api#required": {} } }, "DeliveryStream": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Firehose delivery stream that is the destination for log delivery.

", "smithy.api#jsonName": "deliveryStream" } } }, "traits": { "smithy.api#documentation": "

Details about delivering logs to Firehose.

" } }, "com.amazonaws.kafka#ReplicatorLogDelivery": { "type": "structure", "members": { "CloudWatchLogs": { "target": "com.amazonaws.kafka#ReplicatorCloudWatchLogs", "traits": { "smithy.api#documentation": "

Configuration for CloudWatch Logs delivery.

", "smithy.api#jsonName": "cloudWatchLogs" } }, "Firehose": { "target": "com.amazonaws.kafka#ReplicatorFirehose", "traits": { "smithy.api#documentation": "

Configuration for Firehose delivery.

", "smithy.api#jsonName": "firehose" } }, "S3": { "target": "com.amazonaws.kafka#ReplicatorS3", "traits": { "smithy.api#documentation": "

Configuration for S3 delivery.

", "smithy.api#jsonName": "s3" } } }, "traits": { "smithy.api#documentation": "

Configuration for replicator log delivery.

" } }, "com.amazonaws.kafka#ReplicatorS3": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Whether log delivery to S3 is enabled.

", "smithy.api#jsonName": "enabled", "smithy.api#required": {} } }, "Bucket": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The S3 bucket that is the destination for log delivery.

", "smithy.api#jsonName": "bucket" } }, "Prefix": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The S3 prefix that is the destination for log delivery.

", "smithy.api#jsonName": "prefix" } } }, "traits": { "smithy.api#documentation": "

Details about delivering logs to S3.

" } }, "com.amazonaws.kafka#ReplicatorState": { "type": "enum", "members": { "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } }, "traits": { "smithy.api#documentation": "

The state of a replicator.

" } }, "com.amazonaws.kafka#ReplicatorSummary": { "type": "structure", "members": { "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time the replicator was created.

", "smithy.api#jsonName": "creationTime" } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The current version of the replicator.

", "smithy.api#jsonName": "currentVersion" } }, "IsReplicatorReference": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

Whether this resource is a replicator reference.

", "smithy.api#jsonName": "isReplicatorReference" } }, "KafkaClustersSummary": { "target": "com.amazonaws.kafka#__listOfKafkaClusterSummary", "traits": { "smithy.api#documentation": "

Kafka Clusters used in setting up sources / targets for replication.

", "smithy.api#jsonName": "kafkaClustersSummary" } }, "ReplicationInfoSummaryList": { "target": "com.amazonaws.kafka#__listOfReplicationInfoSummary", "traits": { "smithy.api#documentation": "

A list of summarized information of replications between clusters.

", "smithy.api#jsonName": "replicationInfoSummaryList" } }, "ReplicatorArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicator.

", "smithy.api#jsonName": "replicatorArn" } }, "ReplicatorName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the replicator.

", "smithy.api#jsonName": "replicatorName" } }, "ReplicatorResourceArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.

", "smithy.api#jsonName": "replicatorResourceArn" } }, "ReplicatorState": { "target": "com.amazonaws.kafka#ReplicatorState", "traits": { "smithy.api#documentation": "

State of the replicator.

", "smithy.api#jsonName": "replicatorState" } } }, "traits": { "smithy.api#documentation": "

Information about a replicator.

" } }, "com.amazonaws.kafka#S3": { "type": "structure", "members": { "Bucket": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#jsonName": "bucket" } }, "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#jsonName": "enabled", "smithy.api#required": {} } }, "Prefix": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#jsonName": "prefix" } } } }, "com.amazonaws.kafka#S3CompressionType": { "type": "enum", "members": { "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } }, "GZIP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GZIP" } }, "ZSTD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ZSTD" } } }, "traits": { "smithy.api#documentation": "

The compression codec applied to delivered Amazon S3 objects.

" } }, "com.amazonaws.kafka#S3DestinationConfiguration": { "type": "structure", "members": { "DataFreshnessInSeconds": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900. Default: 600.

", "smithy.api#jsonName": "dataFreshnessInSeconds" } }, "DeadLetterQueueS3": { "target": "com.amazonaws.kafka#DeadLetterQueueS3", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon S3 bucket and prefix where MSK writes records that fail to deliver.

", "smithy.api#jsonName": "deadLetterQueueS3", "smithy.api#required": {} } }, "ServiceExecutionRoleArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that MSK assumes to write to the destination Amazon S3 bucket and the dead-letter bucket.

", "smithy.api#jsonName": "serviceExecutionRoleArn", "smithy.api#required": {} } }, "Storage": { "target": "com.amazonaws.kafka#S3Storage", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon S3 bucket, prefix, and storage class for delivered records.

", "smithy.api#jsonName": "storage", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Configuration of an Amazon S3 destination for a channel.

" } }, "com.amazonaws.kafka#S3DestinationUpdate": { "type": "structure", "members": { "DataFreshnessInSeconds": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900.

", "smithy.api#jsonName": "dataFreshnessInSeconds", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Update payload for an Amazon S3 destination.

" } }, "com.amazonaws.kafka#S3Storage": { "type": "structure", "members": { "BucketArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination Amazon S3 bucket.

", "smithy.api#jsonName": "bucketArn", "smithy.api#required": {} } }, "CompressionType": { "target": "com.amazonaws.kafka#S3CompressionType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The compression codec applied to delivered Amazon S3 objects.

", "smithy.api#jsonName": "compressionType", "smithy.api#required": {} } }, "OutputPrefix": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

An optional prefix prepended to every Amazon S3 object key written by the channel.

", "smithy.api#jsonName": "outputPrefix" } }, "OutputKeyTemplate": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

An optional template that controls the Amazon S3 object key for each delivered record. Supports the placeholders !{partition-id}, !{sequence-number}, and !{kafka-offset}.

", "smithy.api#jsonName": "outputKeyTemplate" } }, "StorageClass": { "target": "com.amazonaws.kafka#S3StorageClass", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon S3 storage class for delivered objects.

", "smithy.api#jsonName": "storageClass", "smithy.api#required": {} } }, "ExpectedBucketOwner": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Optional 12-digit AWS account ID expected to own the Amazon S3 bucket.

", "smithy.api#jsonName": "expectedBucketOwner" } } }, "traits": { "smithy.api#documentation": "

Storage configuration for an Amazon S3 destination bucket.

" } }, "com.amazonaws.kafka#S3StorageClass": { "type": "enum", "members": { "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STANDARD" } }, "INTELLIGENT_TIERING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTELLIGENT_TIERING" } }, "GLACIER_IR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GLACIER_IR" } } }, "traits": { "smithy.api#documentation": "

The Amazon S3 storage class applied to delivered objects.

" } }, "com.amazonaws.kafka#Sasl": { "type": "structure", "members": { "Scram": { "target": "com.amazonaws.kafka#Scram", "traits": { "smithy.api#documentation": "

Details for SASL/SCRAM client authentication.

", "smithy.api#jsonName": "scram" } }, "Iam": { "target": "com.amazonaws.kafka#Iam", "traits": { "smithy.api#documentation": "

Indicates whether IAM access control is enabled.

", "smithy.api#jsonName": "iam" } } }, "traits": { "smithy.api#documentation": "

Details for client authentication using SASL.

" } }, "com.amazonaws.kafka#SchemaEvolution": { "type": "structure", "members": { "EnableSchemaEvolution": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

Whether to allow MSK to evolve the destination table's schema. Must be false for the current release.

", "smithy.api#jsonName": "enableSchemaEvolution" } } }, "traits": { "smithy.api#documentation": "

Configuration controlling whether the Apache Iceberg destination table's schema is evolved as incoming records change.

" } }, "com.amazonaws.kafka#Scram": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

SASL/SCRAM authentication is enabled or not.

", "smithy.api#jsonName": "enabled" } } }, "traits": { "smithy.api#documentation": "

Details for SASL/SCRAM client authentication.

" } }, "com.amazonaws.kafka#Serverless": { "type": "structure", "members": { "VpcConfigs": { "target": "com.amazonaws.kafka#__listOfVpcConfig", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The configuration of the Amazon VPCs for the cluster.

", "smithy.api#jsonName": "vpcConfigs", "smithy.api#required": {} } }, "ClientAuthentication": { "target": "com.amazonaws.kafka#ServerlessClientAuthentication", "traits": { "smithy.api#documentation": "

Includes all client authentication information.

", "smithy.api#jsonName": "clientAuthentication" } }, "ConnectivityInfo": { "target": "com.amazonaws.kafka#ServerlessConnectivityInfo", "traits": { "smithy.api#documentation": "

Describes the cluster's connectivity information, such as its network type, which is IPv4 or DUAL.

", "smithy.api#jsonName": "connectivityInfo" } } }, "traits": { "smithy.api#documentation": "

Serverless cluster.

" } }, "com.amazonaws.kafka#ServerlessClientAuthentication": { "type": "structure", "members": { "Sasl": { "target": "com.amazonaws.kafka#ServerlessSasl", "traits": { "smithy.api#documentation": "

Details for ClientAuthentication using SASL.

", "smithy.api#jsonName": "sasl" } } }, "traits": { "smithy.api#documentation": "

Includes all client authentication information.

" } }, "com.amazonaws.kafka#ServerlessConnectivityInfo": { "type": "structure", "members": { "NetworkType": { "target": "com.amazonaws.kafka#NetworkType", "traits": { "smithy.api#documentation": "

The network type of the cluster, which is IPv4 or DUAL. The DUAL network type uses both IPv4 and IPv6 addresses for your cluster and its resources.

By default, a cluster uses the IPv4 network type.

", "smithy.api#jsonName": "networkType" } } }, "traits": { "smithy.api#documentation": "

Describes the cluster's connectivity information, such as its network type, which is IPv4 or DUAL.

" } }, "com.amazonaws.kafka#ServerlessRequest": { "type": "structure", "members": { "VpcConfigs": { "target": "com.amazonaws.kafka#__listOfVpcConfig", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The configuration of the Amazon VPCs for the cluster.

", "smithy.api#jsonName": "vpcConfigs", "smithy.api#required": {} } }, "ClientAuthentication": { "target": "com.amazonaws.kafka#ServerlessClientAuthentication", "traits": { "smithy.api#documentation": "

Includes all client authentication information.

", "smithy.api#jsonName": "clientAuthentication" } } }, "traits": { "smithy.api#documentation": "

Serverless cluster request.

" } }, "com.amazonaws.kafka#ServerlessSasl": { "type": "structure", "members": { "Iam": { "target": "com.amazonaws.kafka#Iam", "traits": { "smithy.api#documentation": "

Indicates whether IAM access control is enabled.

", "smithy.api#jsonName": "iam" } } }, "traits": { "smithy.api#documentation": "

Details for client authentication using SASL.

" } }, "com.amazonaws.kafka#ServiceUnavailableException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "server", "smithy.api#httpError": 503 } }, "com.amazonaws.kafka#StartTopicReassignment": { "type": "operation", "input": { "target": "com.amazonaws.kafka#StartTopicReassignmentRequest" }, "output": { "target": "com.amazonaws.kafka#StartTopicReassignmentResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ConflictException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Initiates topic partition reassignment between broker types in a mixed-mode cluster.

", "smithy.api#http": { "method": "POST", "uri": "/v1/clusters/{ClusterArn}/topic-reassignments", "code": 200 } } }, "com.amazonaws.kafka#StartTopicReassignmentRequest": { "type": "structure", "members": { "ClientToken": { "target": "com.amazonaws.kafka#__stringMin1Max64", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request with the same client token within 24 hours, the API returns the original response without creating a duplicate operation.

", "smithy.api#jsonName": "clientToken" } }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TargetInstanceType": { "target": "com.amazonaws.kafka#__stringMin1Max256", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Instance type of the target brokers. Must exist in the cluster. Use Express instance type (e.g., express.m7g.large) for Standard-to-Express migration. Use Standard instance type (e.g., kafka.m7g.large) to move topics back to Standard.

", "smithy.api#jsonName": "targetInstanceType", "smithy.api#required": {} } }, "TopicsToExclude": { "target": "com.amazonaws.kafka#__listOf__stringMin1Max256", "traits": { "smithy.api#documentation": "

Regex patterns for topics to exclude from reassignment. Evaluated after include patterns.

", "smithy.api#jsonName": "topicsToExclude" } }, "TopicsToInclude": { "target": "com.amazonaws.kafka#__listOf__stringMin1Max256", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Regex patterns for topics to reassign. Use ['.*'] for all topics. Max 10 patterns.

", "smithy.api#jsonName": "topicsToInclude", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Initiates topic partition reassignment between broker types in a mixed-mode cluster.

", "smithy.api#input": {} } }, "com.amazonaws.kafka#StartTopicReassignmentResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__stringMax2048", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "Status": { "target": "com.amazonaws.kafka#TopicReassignmentStatus", "traits": { "smithy.api#documentation": "

The current status of the reassignment operation.

", "smithy.api#jsonName": "status" } }, "TopicReassignmentOperationArn": { "target": "com.amazonaws.kafka#__stringMax2048", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic reassignment operation.

", "smithy.api#jsonName": "topicReassignmentOperationArn" } } }, "traits": { "smithy.api#documentation": "

Returns information about the initiated topic reassignment operation.

", "smithy.api#output": {} } }, "com.amazonaws.kafka#StateInfo": { "type": "structure", "members": { "Code": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#jsonName": "code" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#jsonName": "message" } } } }, "com.amazonaws.kafka#StopTopicReassignment": { "type": "operation", "input": { "target": "com.amazonaws.kafka#StopTopicReassignmentRequest" }, "output": { "target": "com.amazonaws.kafka#StopTopicReassignmentResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Stops an active topic reassignment operation.

", "smithy.api#http": { "method": "POST", "uri": "/v1/clusters/{ClusterArn}/topic-reassignments/{TopicReassignmentOperationArn}/stop", "code": 200 } } }, "com.amazonaws.kafka#StopTopicReassignmentRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TopicReassignmentOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic reassignment operation to stop.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#StopTopicReassignmentResponse": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.kafka#TopicReassignmentStatus", "traits": { "smithy.api#documentation": "

The current status of the operation. Will be STOPPING.

", "smithy.api#jsonName": "status" } }, "TopicReassignmentOperationArn": { "target": "com.amazonaws.kafka#__stringMax2048", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic reassignment operation.

", "smithy.api#jsonName": "topicReassignmentOperationArn" } } }, "traits": { "smithy.api#documentation": "

Returns the result of stopping a topic reassignment operation.

", "smithy.api#output": {} } }, "com.amazonaws.kafka#StorageInfo": { "type": "structure", "members": { "EbsStorageInfo": { "target": "com.amazonaws.kafka#EBSStorageInfo", "traits": { "smithy.api#documentation": "

EBS volume information.

", "smithy.api#jsonName": "ebsStorageInfo" } } }, "traits": { "smithy.api#documentation": "

Contains information about storage volumes attached to MSK broker nodes.

" } }, "com.amazonaws.kafka#StorageMode": { "type": "enum", "members": { "LOCAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOCAL" } }, "TIERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIERED" } } }, "traits": { "smithy.api#documentation": "Controls storage mode for various supported storage tiers." } }, "com.amazonaws.kafka#TableCreation": { "type": "structure", "members": { "EnableTableCreation": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

Whether MSK creates the destination table on the customer's behalf. Must be true for the current release.

", "smithy.api#jsonName": "enableTableCreation" } } }, "traits": { "smithy.api#documentation": "

Configuration controlling whether MSK creates the destination Apache Iceberg table if it does not already exist.

" } }, "com.amazonaws.kafka#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.kafka#TagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" } ], "traits": { "smithy.api#documentation": "

Adds tags to the specified MSK resource.

", "smithy.api#http": { "method": "POST", "uri": "/v1/tags/{ResourceArn}", "code": 204 } } }, "com.amazonaws.kafka#TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.kafka#__mapOf__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The key-value pair for the resource tag.

", "smithy.api#jsonName": "tags", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#TargetCompressionType": { "type": "enum", "members": { "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } }, "GZIP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GZIP" } }, "SNAPPY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SNAPPY" } }, "LZ4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LZ4" } }, "ZSTD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ZSTD" } } }, "traits": { "smithy.api#documentation": "

The type of compression to use producing records to the target cluster.

" } }, "com.amazonaws.kafka#Tls": { "type": "structure", "members": { "CertificateAuthorityArnList": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

List of ACM Certificate Authority ARNs.

", "smithy.api#jsonName": "certificateAuthorityArnList" } }, "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "enabled" } } }, "traits": { "smithy.api#documentation": "

Details for client authentication using TLS.

" } }, "com.amazonaws.kafka#TokenEndpointAuthenticationMethod": { "type": "enum", "members": { "POST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POST" } }, "BASIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BASIC" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } }, "traits": { "smithy.api#documentation": "

How client credentials are sent to the identity provider's token endpoint.

" } }, "com.amazonaws.kafka#TooManyRequestsException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.kafka#TopicConfiguration": { "type": "structure", "members": { "RecordConverter": { "target": "com.amazonaws.kafka#RecordConverter", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Configuration that controls how Apache Kafka record values are deserialized for the destination.

", "smithy.api#jsonName": "recordConverter", "smithy.api#required": {} } }, "RecordSchema": { "target": "com.amazonaws.kafka#RecordSchema", "traits": { "smithy.api#documentation": "

The schema used to validate records when the value converter requires one (for example, JSON_SCHEMA_GSR).

", "smithy.api#jsonName": "recordSchema" } }, "TopicArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "topicArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Configuration of an Apache Kafka topic that feeds a channel.

" } }, "com.amazonaws.kafka#TopicExistsException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.kafka#TopicInfo": { "type": "structure", "members": { "TopicArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

", "smithy.api#jsonName": "topicArn" } }, "TopicName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Name for a topic.

", "smithy.api#jsonName": "topicName" } }, "ReplicationFactor": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

Replication factor for a topic.

", "smithy.api#jsonName": "replicationFactor" } }, "PartitionCount": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

Partition count for a topic.

", "smithy.api#jsonName": "partitionCount" } }, "OutOfSyncReplicaCount": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

Number of out-of-sync replicas for a topic.

", "smithy.api#jsonName": "outOfSyncReplicaCount" } }, "ReplicaIds": { "target": "com.amazonaws.kafka#__listOf__integer", "traits": { "smithy.api#documentation": "

The broker IDs hosting replicas of this topic's partitions.

", "smithy.api#jsonName": "replicaIds" } } }, "traits": { "smithy.api#documentation": "

Includes identification info about the topic.

" } }, "com.amazonaws.kafka#TopicPartitionInfo": { "type": "structure", "members": { "Partition": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

The partition ID.

", "smithy.api#jsonName": "partition" } }, "Leader": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

The leader broker ID for the partition.

", "smithy.api#jsonName": "leader" } }, "Replicas": { "target": "com.amazonaws.kafka#__listOf__integer", "traits": { "smithy.api#documentation": "

The list of replica broker IDs for the partition.

", "smithy.api#jsonName": "replicas" } }, "Isr": { "target": "com.amazonaws.kafka#__listOf__integer", "traits": { "smithy.api#documentation": "

The list of in-sync replica broker IDs for the partition.

", "smithy.api#jsonName": "isr" } } }, "traits": { "smithy.api#documentation": "

Contains information about a topic partition.

" } }, "com.amazonaws.kafka#TopicReassignment": { "type": "enum", "members": { "AUTO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUTO" } }, "MANUAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANUAL" } } }, "traits": { "smithy.api#documentation": "

Controls automatic topic reassignment when entering mixed broker mode.

" } }, "com.amazonaws.kafka#TopicReassignmentInfo": { "type": "structure", "members": { "CompletedTopics": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

Number of topics fully migrated.

", "smithy.api#jsonName": "completedTopics" } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

When the operation was created.

", "smithy.api#jsonName": "creationTime" } }, "Status": { "target": "com.amazonaws.kafka#TopicReassignmentStatus", "traits": { "smithy.api#documentation": "

The current status of the reassignment operation.

", "smithy.api#jsonName": "status" } }, "TargetInstanceType": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The target broker instance type for this reassignment.

", "smithy.api#jsonName": "targetInstanceType" } }, "TopicReassignmentOperationArn": { "target": "com.amazonaws.kafka#__stringMax2048", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic reassignment operation.

", "smithy.api#jsonName": "topicReassignmentOperationArn" } }, "TotalTopics": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

Total number of topics matching the selector.

", "smithy.api#jsonName": "totalTopics" } } }, "traits": { "smithy.api#documentation": "

Summary information about a topic reassignment operation.

" } }, "com.amazonaws.kafka#TopicReassignmentMode": { "type": "enum", "members": { "AUTO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUTO" } }, "MANUAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANUAL" } } }, "traits": { "smithy.api#documentation": "

How topics are reassigned to the target broker type after an UpdateBrokerType operation adds brokers of that type. AUTO: Amazon MSK reassigns all topics. MANUAL: you reassign topics with the StartTopicReassignment operation.

" } }, "com.amazonaws.kafka#TopicReassignmentStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "STOPPING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPING" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPED" } } }, "traits": { "smithy.api#documentation": "

The lifecycle status of a topic reassignment operation.

" } }, "com.amazonaws.kafka#TopicReplication": { "type": "structure", "members": { "CopyAccessControlListsForTopics": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.

", "smithy.api#jsonName": "copyAccessControlListsForTopics" } }, "CopyTopicConfigurations": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

Whether to periodically configure remote topics to match their corresponding upstream topics.

", "smithy.api#jsonName": "copyTopicConfigurations" } }, "DetectAndCopyNewTopics": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

Whether to periodically check for new topics and partitions.

", "smithy.api#jsonName": "detectAndCopyNewTopics" } }, "StartingPosition": { "target": "com.amazonaws.kafka#ReplicationStartingPosition", "traits": { "smithy.api#documentation": "

Configuration for specifying the position in the topics to start replicating from.

", "smithy.api#jsonName": "startingPosition" } }, "TopicNameConfiguration": { "target": "com.amazonaws.kafka#ReplicationTopicNameConfiguration", "traits": { "smithy.api#documentation": "

Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.

", "smithy.api#jsonName": "topicNameConfiguration" } }, "TopicsToExclude": { "target": "com.amazonaws.kafka#__listOf__stringMax249", "traits": { "smithy.api#documentation": "

List of regular expression patterns indicating the topics that should not be replicated.

", "smithy.api#jsonName": "topicsToExclude" } }, "TopicsToReplicate": { "target": "com.amazonaws.kafka#__listOf__stringMax249", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

List of regular expression patterns indicating the topics to copy.

", "smithy.api#jsonName": "topicsToReplicate", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details about topic replication.

" } }, "com.amazonaws.kafka#TopicReplicationUpdate": { "type": "structure", "members": { "CopyAccessControlListsForTopics": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.

", "smithy.api#jsonName": "copyAccessControlListsForTopics", "smithy.api#required": {} } }, "CopyTopicConfigurations": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Whether to periodically configure remote topics to match their corresponding upstream topics.

", "smithy.api#jsonName": "copyTopicConfigurations", "smithy.api#required": {} } }, "DetectAndCopyNewTopics": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Whether to periodically check for new topics and partitions.

", "smithy.api#jsonName": "detectAndCopyNewTopics", "smithy.api#required": {} } }, "TopicsToExclude": { "target": "com.amazonaws.kafka#__listOf__stringMax249", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

List of regular expression patterns indicating the topics that should not be replicated.

", "smithy.api#jsonName": "topicsToExclude", "smithy.api#required": {} } }, "TopicsToReplicate": { "target": "com.amazonaws.kafka#__listOf__stringMax249", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

List of regular expression patterns indicating the topics to copy.

", "smithy.api#jsonName": "topicsToReplicate", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details for updating the topic replication of a replicator.

" } }, "com.amazonaws.kafka#TopicState": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } } }, "traits": { "smithy.api#documentation": "

The state of a topic request.

" } }, "com.amazonaws.kafka#Unauthenticated": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "enabled" } } } }, "com.amazonaws.kafka#UnauthorizedException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", "smithy.api#httpError": 401 } }, "com.amazonaws.kafka#UnknownTopicOrPartitionException": { "type": "structure", "members": { "InvalidParameter": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The parameter that caused the error.

", "smithy.api#jsonName": "invalidParameter" } }, "Message": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the error.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

Returns information about an error.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.kafka#UnprocessedScramSecret": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Error code for associate/disassociate failure.

", "smithy.api#jsonName": "errorCode" } }, "ErrorMessage": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Error message for associate/disassociate failure.

", "smithy.api#jsonName": "errorMessage" } }, "SecretArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

AWS Secrets Manager secret ARN.

", "smithy.api#jsonName": "secretArn" } } }, "traits": { "smithy.api#documentation": "

Error info for scram secret associate/disassociate failure.

" } }, "com.amazonaws.kafka#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.kafka#UntagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/tags/{ResourceArn}", "code": 204 } } }, "com.amazonaws.kafka#UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

\n ", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#UpdateBrokerCount": { "type": "operation", "input": { "target": "com.amazonaws.kafka#UpdateBrokerCountRequest" }, "output": { "target": "com.amazonaws.kafka#UpdateBrokerCountResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates the number of broker nodes in the cluster.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/clusters/{ClusterArn}/nodes/count", "code": 200 } } }, "com.amazonaws.kafka#UpdateBrokerCountRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "currentVersion", "smithy.api#required": {} } }, "TargetNumberOfBrokerNodes": { "target": "com.amazonaws.kafka#__integerMin1Max15", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "targetNumberOfBrokerNodes", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#UpdateBrokerCountResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterOperationArn" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#UpdateBrokerStorage": { "type": "operation", "input": { "target": "com.amazonaws.kafka#UpdateBrokerStorageRequest" }, "output": { "target": "com.amazonaws.kafka#UpdateBrokerStorageResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates the EBS storage associated with MSK brokers.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/clusters/{ClusterArn}/nodes/storage", "code": 200 } } }, "com.amazonaws.kafka#UpdateBrokerStorageRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "currentVersion", "smithy.api#required": {} } }, "TargetBrokerEBSVolumeInfo": { "target": "com.amazonaws.kafka#__listOfBrokerEBSVolumeInfo", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "targetBrokerEBSVolumeInfo", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#UpdateBrokerStorageResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterOperationArn" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#UpdateBrokerType": { "type": "operation", "input": { "target": "com.amazonaws.kafka#UpdateBrokerTypeRequest" }, "output": { "target": "com.amazonaws.kafka#UpdateBrokerTypeResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates EC2 instance type.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/clusters/{ClusterArn}/nodes/type", "code": 200 } } }, "com.amazonaws.kafka#UpdateBrokerTypeRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "currentVersion", "smithy.api#required": {} } }, "TargetInstanceType": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The type of Amazon EC2 instances to use for Kafka brokers. For in-place upgrades to Express, use the composite format to initiate mixed mode, the Express instance type to complete the upgrade, or the Standard instance type to rollback.

", "smithy.api#jsonName": "targetInstanceType", "smithy.api#required": {} } }, "TopicReassignment": { "target": "com.amazonaws.kafka#TopicReassignment", "traits": { "smithy.api#documentation": "

Controls automatic topic reassignment when entering mixed broker mode. When set to AUTO, MSK automatically reassigns all topics to the target broker type after adding new brokers. When set to MANUAL (default), customers manage topic reassignment using the StartTopicReassignment API. Only valid when targetInstanceType is a composite mixed-mode value. Must be set to MANUAL before completing the upgrade or rolling back.

", "smithy.api#jsonName": "topicReassignment" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#UpdateBrokerTypeResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterOperationArn" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#UpdateChannel": { "type": "operation", "input": { "target": "com.amazonaws.kafka#UpdateChannelRequest" }, "output": { "target": "com.amazonaws.kafka#UpdateChannelResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates the destination configuration of an existing channel. Exactly one of icebergDestinationUpdate or s3DestinationUpdate must be supplied.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/clusters/{ClusterArn}/channels/{ChannelArn}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.kafka#UpdateChannelRequest": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IcebergDestinationUpdate": { "target": "com.amazonaws.kafka#IcebergDestinationUpdate", "traits": { "smithy.api#documentation": "

Updates fields on an Apache Iceberg destination. Use only when the channel was created with an Iceberg destination.

", "smithy.api#jsonName": "icebergDestinationUpdate" } }, "S3DestinationUpdate": { "target": "com.amazonaws.kafka#S3DestinationUpdate", "traits": { "smithy.api#documentation": "

Updates fields on an Amazon S3 destination. Use only when the channel was created with an Amazon S3 destination.

", "smithy.api#jsonName": "s3DestinationUpdate" } } }, "traits": { "smithy.api#documentation": "

Updates an existing channel's destination configuration. You must update the same destination type the channel was created with; the destination type cannot be changed.

", "smithy.api#input": {} } }, "com.amazonaws.kafka#UpdateChannelResponse": { "type": "structure", "members": { "ChannelArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "channelArn", "smithy.api#required": {} } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterOperationArn" } } }, "traits": { "smithy.api#documentation": "

Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous update.

", "smithy.api#output": {} } }, "com.amazonaws.kafka#UpdateClusterConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.kafka#UpdateClusterConfigurationRequest" }, "output": { "target": "com.amazonaws.kafka#UpdateClusterConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "PUT", "uri": "/v1/clusters/{ClusterArn}/configuration", "code": 200 } } }, "com.amazonaws.kafka#UpdateClusterConfigurationRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ConfigurationInfo": { "target": "com.amazonaws.kafka#ConfigurationInfo", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "configurationInfo", "smithy.api#required": {} } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The version of the cluster that needs to be updated.

", "smithy.api#jsonName": "currentVersion", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#UpdateClusterConfigurationResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterOperationArn" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#UpdateClusterKafkaVersion": { "type": "operation", "input": { "target": "com.amazonaws.kafka#UpdateClusterKafkaVersionRequest" }, "output": { "target": "com.amazonaws.kafka#UpdateClusterKafkaVersionResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates the Apache Kafka version for the cluster.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/clusters/{ClusterArn}/version", "code": 200 } } }, "com.amazonaws.kafka#UpdateClusterKafkaVersionRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ConfigurationInfo": { "target": "com.amazonaws.kafka#ConfigurationInfo", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "configurationInfo" } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Current cluster version.

", "smithy.api#jsonName": "currentVersion", "smithy.api#required": {} } }, "TargetKafkaVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Target Kafka version.

", "smithy.api#jsonName": "targetKafkaVersion", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#UpdateClusterKafkaVersionResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterOperationArn" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#UpdateConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.kafka#UpdateConfigurationRequest" }, "output": { "target": "com.amazonaws.kafka#UpdateConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates an MSK configuration.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/configurations/{Arn}", "code": 200 } } }, "com.amazonaws.kafka#UpdateConfigurationRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The description of the configuration revision.

", "smithy.api#jsonName": "description" } }, "ServerProperties": { "target": "com.amazonaws.kafka#__blob", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "serverProperties", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#UpdateConfigurationResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", "smithy.api#jsonName": "arn" } }, "LatestRevision": { "target": "com.amazonaws.kafka#ConfigurationRevision", "traits": { "smithy.api#documentation": "

Latest revision of the configuration.

", "smithy.api#jsonName": "latestRevision" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#UpdateConnectivity": { "type": "operation", "input": { "target": "com.amazonaws.kafka#UpdateConnectivityRequest" }, "output": { "target": "com.amazonaws.kafka#UpdateConnectivityResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates the cluster's connectivity configuration.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/clusters/{ClusterArn}/connectivity", "code": 200 } } }, "com.amazonaws.kafka#UpdateConnectivityRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ConnectivityInfo": { "target": "com.amazonaws.kafka#ConnectivityInfo", "traits": { "smithy.api#documentation": "

Information about the broker access configuration.

", "smithy.api#jsonName": "connectivityInfo" } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "currentVersion", "smithy.api#required": {} } }, "ZookeeperAccess": { "target": "com.amazonaws.kafka#ZookeeperAccess", "traits": { "smithy.api#documentation": "

Access control settings for zookeeper

", "smithy.api#jsonName": "zookeeperAccess" } } }, "traits": { "smithy.api#documentation": "Request body for UpdateConnectivity.", "smithy.api#input": {} } }, "com.amazonaws.kafka#UpdateConnectivityResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterOperationArn" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#UpdateMonitoring": { "type": "operation", "input": { "target": "com.amazonaws.kafka#UpdateMonitoringRequest" }, "output": { "target": "com.amazonaws.kafka#UpdateMonitoringResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/clusters/{ClusterArn}/monitoring", "code": 200 } } }, "com.amazonaws.kafka#UpdateMonitoringRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "currentVersion", "smithy.api#required": {} } }, "EnhancedMonitoring": { "target": "com.amazonaws.kafka#EnhancedMonitoring", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "enhancedMonitoring" } }, "OpenMonitoring": { "target": "com.amazonaws.kafka#OpenMonitoringInfo", "traits": { "smithy.api#documentation": "

The settings for open monitoring.

", "smithy.api#jsonName": "openMonitoring" } }, "LoggingInfo": { "target": "com.amazonaws.kafka#LoggingInfo", "traits": { "smithy.api#jsonName": "loggingInfo" } } }, "traits": { "smithy.api#documentation": "Request body for UpdateMonitoring.", "smithy.api#input": {} } }, "com.amazonaws.kafka#UpdateMonitoringResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterOperationArn" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#UpdateRebalancing": { "type": "operation", "input": { "target": "com.amazonaws.kafka#UpdateRebalancingRequest" }, "output": { "target": "com.amazonaws.kafka#UpdateRebalancingResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Use this resource to update the intelligent rebalancing status of an Amazon MSK Provisioned cluster with Express brokers.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/clusters/{ClusterArn}/rebalancing", "code": 200 } } }, "com.amazonaws.kafka#UpdateRebalancingRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The current version of the cluster.

", "smithy.api#jsonName": "currentVersion", "smithy.api#required": {} } }, "Rebalancing": { "target": "com.amazonaws.kafka#Rebalancing", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Specifies if intelligent rebalancing should be turned on for your cluster. The default intelligent rebalancing status is ACTIVE for all new MSK Provisioned clusters that you create with Express brokers.

", "smithy.api#jsonName": "rebalancing", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#UpdateRebalancingResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster whose intelligent rebalancing status you've updated.

", "smithy.api#jsonName": "clusterArn" } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterOperationArn" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#UpdateReplicationInfo": { "type": "operation", "input": { "target": "com.amazonaws.kafka#UpdateReplicationInfoRequest" }, "output": { "target": "com.amazonaws.kafka#UpdateReplicationInfoResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates replication info of a replicator.

", "smithy.api#http": { "method": "PUT", "uri": "/replication/v1/replicators/{ReplicatorArn}/replication-info", "code": 200 } } }, "com.amazonaws.kafka#UpdateReplicationInfoRequest": { "type": "structure", "members": { "ConsumerGroupReplication": { "target": "com.amazonaws.kafka#ConsumerGroupReplicationUpdate", "traits": { "smithy.api#documentation": "

Updated consumer group replication information.

", "smithy.api#jsonName": "consumerGroupReplication" } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Current replicator version.

", "smithy.api#jsonName": "currentVersion", "smithy.api#required": {} } }, "ReplicatorArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SourceKafkaClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The ARN of the source Kafka cluster.

", "smithy.api#jsonName": "sourceKafkaClusterArn" } }, "SourceKafkaClusterId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The ID of the source Kafka cluster.

", "smithy.api#jsonName": "sourceKafkaClusterId" } }, "TargetKafkaClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The ARN of the target Kafka cluster.

", "smithy.api#jsonName": "targetKafkaClusterArn" } }, "TargetKafkaClusterId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The ID of the target Kafka cluster.

", "smithy.api#jsonName": "targetKafkaClusterId" } }, "TopicReplication": { "target": "com.amazonaws.kafka#TopicReplicationUpdate", "traits": { "smithy.api#documentation": "

Updated topic replication information.

", "smithy.api#jsonName": "topicReplication" } }, "LogDelivery": { "target": "com.amazonaws.kafka#LogDelivery", "traits": { "smithy.api#documentation": "

Configuration for delivering replicator logs to customer destinations.

", "smithy.api#jsonName": "logDelivery" } } }, "traits": { "smithy.api#documentation": "

Update information relating to replication between a given source and target Kafka cluster.

", "smithy.api#input": {} } }, "com.amazonaws.kafka#UpdateReplicationInfoResponse": { "type": "structure", "members": { "ReplicatorArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicator.

", "smithy.api#jsonName": "replicatorArn" } }, "ReplicatorState": { "target": "com.amazonaws.kafka#ReplicatorState", "traits": { "smithy.api#documentation": "

State of the replicator.

", "smithy.api#jsonName": "replicatorState" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#UpdateSecurity": { "type": "operation", "input": { "target": "com.amazonaws.kafka#UpdateSecurityRequest" }, "output": { "target": "com.amazonaws.kafka#UpdateSecurityResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "PATCH", "uri": "/v1/clusters/{ClusterArn}/security", "code": 200 } } }, "com.amazonaws.kafka#UpdateSecurityRequest": { "type": "structure", "members": { "ClientAuthentication": { "target": "com.amazonaws.kafka#ClientAuthentication", "traits": { "smithy.api#documentation": "

Includes all client authentication related information.

", "smithy.api#jsonName": "clientAuthentication" } }, "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "currentVersion", "smithy.api#required": {} } }, "EncryptionInfo": { "target": "com.amazonaws.kafka#EncryptionInfo", "traits": { "smithy.api#documentation": "

Includes all encryption-related information.

", "smithy.api#jsonName": "encryptionInfo" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#UpdateSecurityResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterOperationArn" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#UpdateStorage": { "type": "operation", "input": { "target": "com.amazonaws.kafka#UpdateStorageRequest" }, "output": { "target": "com.amazonaws.kafka#UpdateStorageResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#TooManyRequestsException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Updates cluster broker volume size (or) sets cluster storage mode to TIERED.", "smithy.api#http": { "method": "PUT", "uri": "/v1/clusters/{ClusterArn}/storage", "code": 200 } } }, "com.amazonaws.kafka#UpdateStorageRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "CurrentVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "currentVersion", "smithy.api#required": {} } }, "ProvisionedThroughput": { "target": "com.amazonaws.kafka#ProvisionedThroughput", "traits": { "smithy.api#documentation": "

EBS volume provisioned throughput information.

", "smithy.api#jsonName": "provisionedThroughput" } }, "StorageMode": { "target": "com.amazonaws.kafka#StorageMode", "traits": { "smithy.api#documentation": "

Controls storage mode for supported storage tiers.

", "smithy.api#jsonName": "storageMode" } }, "VolumeSizeGB": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

size of the EBS volume to update.

", "smithy.api#jsonName": "volumeSizeGB" } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#input": {} } }, "com.amazonaws.kafka#UpdateStorageResponse": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#jsonName": "clusterArn" } }, "ClusterOperationArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clusterOperationArn" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#UpdateTopic": { "type": "operation", "input": { "target": "com.amazonaws.kafka#UpdateTopicRequest" }, "output": { "target": "com.amazonaws.kafka#UpdateTopicResponse" }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" }, { "target": "com.amazonaws.kafka#ClusterConnectivityException" }, { "target": "com.amazonaws.kafka#ControllerMovedException" }, { "target": "com.amazonaws.kafka#ForbiddenException" }, { "target": "com.amazonaws.kafka#GroupSubscribedToTopicException" }, { "target": "com.amazonaws.kafka#InternalServerErrorException" }, { "target": "com.amazonaws.kafka#KafkaRequestException" }, { "target": "com.amazonaws.kafka#KafkaTimeoutException" }, { "target": "com.amazonaws.kafka#NotControllerException" }, { "target": "com.amazonaws.kafka#NotFoundException" }, { "target": "com.amazonaws.kafka#ReassignmentInProgressException" }, { "target": "com.amazonaws.kafka#ServiceUnavailableException" }, { "target": "com.amazonaws.kafka#UnauthorizedException" }, { "target": "com.amazonaws.kafka#UnknownTopicOrPartitionException" } ], "traits": { "smithy.api#documentation": "

Updates the configuration of the specified topic.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/clusters/{ClusterArn}/topics/{TopicName}", "code": 200 } } }, "com.amazonaws.kafka#UpdateTopicRequest": { "type": "structure", "members": { "ClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TopicName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the topic to update configuration for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Configs": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The new topic configurations encoded as a Base64 string.

", "smithy.api#jsonName": "configs" } }, "PartitionCount": { "target": "com.amazonaws.kafka#__integer", "traits": { "smithy.api#documentation": "

The new total number of partitions for the topic.

", "smithy.api#jsonName": "partitionCount" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kafka#UpdateTopicResponse": { "type": "structure", "members": { "TopicArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

", "smithy.api#jsonName": "topicArn" } }, "TopicName": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The name of the topic whose configuration was updated.

", "smithy.api#jsonName": "topicName" } }, "Status": { "target": "com.amazonaws.kafka#TopicState", "traits": { "smithy.api#documentation": "

The status of the topic update.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kafka#UserIdentity": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.kafka#UserIdentityType", "traits": { "smithy.api#documentation": "

The identity type of the requester that calls the API operation.

", "smithy.api#jsonName": "type" } }, "PrincipalId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

A unique identifier for the requester that calls the API operation.

", "smithy.api#jsonName": "principalId" } } }, "traits": { "smithy.api#documentation": "

Description of the requester that calls the API operation.

" } }, "com.amazonaws.kafka#UserIdentityType": { "type": "enum", "members": { "AWSACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWSACCOUNT" } }, "AWSSERVICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWSSERVICE" } } }, "traits": { "smithy.api#documentation": "

The identity type of the requester that calls the API operation.

" } }, "com.amazonaws.kafka#ValueConverter": { "type": "enum", "members": { "BYTE_ARRAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BYTE_ARRAY" } }, "JSON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JSON" } }, "JSON_SCHEMA_GSR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JSON_SCHEMA_GSR" } }, "STRING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STRING" } } }, "traits": { "smithy.api#documentation": "

The deserialization format applied to Apache Kafka record values.

" } }, "com.amazonaws.kafka#VpcConfig": { "type": "structure", "members": { "SubnetIds": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The IDs of the subnets associated with the cluster.

", "smithy.api#jsonName": "subnetIds", "smithy.api#required": {} } }, "SecurityGroupIds": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

The IDs of the security groups associated with the cluster.

", "smithy.api#jsonName": "securityGroupIds" } } }, "traits": { "smithy.api#documentation": "

The configuration of the Amazon VPCs for the cluster.

" } }, "com.amazonaws.kafka#VpcConnection": { "type": "structure", "members": { "VpcConnectionArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The ARN that identifies the Vpc Connection.

", "smithy.api#jsonName": "vpcConnectionArn", "smithy.api#required": {} } }, "TargetClusterArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

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

", "smithy.api#jsonName": "targetClusterArn", "smithy.api#required": {} } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

Creation time of the Vpc Connection.

", "smithy.api#jsonName": "creationTime" } }, "Authentication": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

Information about the auth scheme of Vpc Connection.

", "smithy.api#jsonName": "authentication" } }, "VpcId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The vpcId that belongs to the Vpc Connection.

", "smithy.api#jsonName": "vpcId" } }, "State": { "target": "com.amazonaws.kafka#VpcConnectionState", "traits": { "smithy.api#documentation": "

State of the Vpc Connection.

", "smithy.api#jsonName": "state" } } }, "traits": { "smithy.api#documentation": "

The VPC connection object.

" } }, "com.amazonaws.kafka#VpcConnectionInfo": { "type": "structure", "members": { "VpcConnectionArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

", "smithy.api#jsonName": "vpcConnectionArn" } }, "Owner": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The owner of the VPC Connection.

", "smithy.api#jsonName": "owner" } }, "UserIdentity": { "target": "com.amazonaws.kafka#UserIdentity", "traits": { "smithy.api#documentation": "

Description of the requester that calls the API operation.

", "smithy.api#jsonName": "userIdentity" } }, "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time when Amazon MSK creates the VPC Connnection.

", "smithy.api#jsonName": "creationTime" } } }, "traits": { "smithy.api#documentation": "

Description of the VPC connection.

" } }, "com.amazonaws.kafka#VpcConnectionInfoServerless": { "type": "structure", "members": { "CreationTime": { "target": "com.amazonaws.kafka#__timestampIso8601", "traits": { "smithy.api#documentation": "

The time when Amazon MSK creates the VPC Connnection.

", "smithy.api#jsonName": "creationTime" } }, "Owner": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The owner of the VPC Connection.

", "smithy.api#jsonName": "owner" } }, "UserIdentity": { "target": "com.amazonaws.kafka#UserIdentity", "traits": { "smithy.api#documentation": "

Description of the requester that calls the API operation.

", "smithy.api#jsonName": "userIdentity" } }, "VpcConnectionArn": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

", "smithy.api#jsonName": "vpcConnectionArn" } } }, "traits": { "smithy.api#documentation": "Description of the VPC connection." } }, "com.amazonaws.kafka#VpcConnectionState": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } }, "DEACTIVATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEACTIVATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } }, "REJECTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTING" } } }, "traits": { "smithy.api#documentation": "

The state of a VPC connection.

" } }, "com.amazonaws.kafka#VpcConnectivity": { "type": "structure", "members": { "ClientAuthentication": { "target": "com.amazonaws.kafka#VpcConnectivityClientAuthentication", "traits": { "smithy.api#documentation": "

Includes all client authentication information for VPC connectivity.

", "smithy.api#jsonName": "clientAuthentication" } } }, "traits": { "smithy.api#documentation": "VPC connectivity access control for brokers." } }, "com.amazonaws.kafka#VpcConnectivityClientAuthentication": { "type": "structure", "members": { "Sasl": { "target": "com.amazonaws.kafka#VpcConnectivitySasl", "traits": { "smithy.api#documentation": "

SASL authentication type details for VPC connectivity.

", "smithy.api#jsonName": "sasl" } }, "Tls": { "target": "com.amazonaws.kafka#VpcConnectivityTls", "traits": { "smithy.api#documentation": "

TLS authentication type details for VPC connectivity.

", "smithy.api#jsonName": "tls" } } }, "traits": { "smithy.api#documentation": "

Includes all client authentication information for VPC connectivity.

" } }, "com.amazonaws.kafka#VpcConnectivityIam": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

SASL/IAM authentication is on or off for VPC connectivity.

", "smithy.api#jsonName": "enabled" } } }, "traits": { "smithy.api#documentation": "

Details for IAM access control for VPC connectivity.

" } }, "com.amazonaws.kafka#VpcConnectivitySasl": { "type": "structure", "members": { "Scram": { "target": "com.amazonaws.kafka#VpcConnectivityScram", "traits": { "smithy.api#documentation": "

Details for SASL/SCRAM client authentication for VPC connectivity.

", "smithy.api#jsonName": "scram" } }, "Iam": { "target": "com.amazonaws.kafka#VpcConnectivityIam", "traits": { "smithy.api#documentation": "

Details for SASL/IAM client authentication for VPC connectivity.

", "smithy.api#jsonName": "iam" } } }, "traits": { "smithy.api#documentation": "

Details for SASL client authentication for VPC connectivity.

" } }, "com.amazonaws.kafka#VpcConnectivityScram": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

SASL/SCRAM authentication is on or off for VPC connectivity.

", "smithy.api#jsonName": "enabled" } } }, "traits": { "smithy.api#documentation": "

Details for SASL/SCRAM client authentication for VPC connectivity.

" } }, "com.amazonaws.kafka#VpcConnectivityTls": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

TLS authentication is on or off for VPC connectivity.

", "smithy.api#jsonName": "enabled" } } }, "traits": { "smithy.api#documentation": "

Details for TLS client authentication for VPC connectivity.

" } }, "com.amazonaws.kafka#ZookeeperAccess": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { "smithy.api#documentation": "

Zookeeper Access was on or off for the cluster

", "smithy.api#jsonName": "enabled" } } }, "traits": { "smithy.api#documentation": "

Access control settings for zookeeper

" } }, "com.amazonaws.kafka#ZookeeperNodeInfo": { "type": "structure", "members": { "AttachedENIId": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The attached elastic network interface of the broker.

", "smithy.api#jsonName": "attachedENIId" } }, "ClientVpcIpAddress": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

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

", "smithy.api#jsonName": "clientVpcIpAddress" } }, "Endpoints": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { "smithy.api#documentation": "

Endpoints for accessing the ZooKeeper.

", "smithy.api#jsonName": "endpoints" } }, "ZookeeperId": { "target": "com.amazonaws.kafka#__double", "traits": { "smithy.api#documentation": "

The role-specific ID for Zookeeper.

", "smithy.api#jsonName": "zookeeperId" } }, "ZookeeperVersion": { "target": "com.amazonaws.kafka#__string", "traits": { "smithy.api#documentation": "

The version of Zookeeper.

", "smithy.api#jsonName": "zookeeperVersion" } } }, "traits": { "smithy.api#documentation": "

Zookeeper node information.

" } }, "com.amazonaws.kafka#__blob": { "type": "blob" }, "com.amazonaws.kafka#__boolean": { "type": "boolean" }, "com.amazonaws.kafka#__double": { "type": "double" }, "com.amazonaws.kafka#__integer": { "type": "integer" }, "com.amazonaws.kafka#__integerMin1": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.kafka#__integerMin1Max15": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 15 } } }, "com.amazonaws.kafka#__integerMin1Max16384": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 16384 } } }, "com.amazonaws.kafka#__integerMin1Max500": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 500 } } }, "com.amazonaws.kafka#__listOfAssessmentFinding": { "type": "list", "member": { "target": "com.amazonaws.kafka#AssessmentFinding" } }, "com.amazonaws.kafka#__listOfAssessmentInfo": { "type": "list", "member": { "target": "com.amazonaws.kafka#AssessmentInfo" } }, "com.amazonaws.kafka#__listOfBrokerEBSVolumeInfo": { "type": "list", "member": { "target": "com.amazonaws.kafka#BrokerEBSVolumeInfo" } }, "com.amazonaws.kafka#__listOfChannelInfo": { "type": "list", "member": { "target": "com.amazonaws.kafka#ChannelInfo" } }, "com.amazonaws.kafka#__listOfClientVpcConnection": { "type": "list", "member": { "target": "com.amazonaws.kafka#ClientVpcConnection" } }, "com.amazonaws.kafka#__listOfCluster": { "type": "list", "member": { "target": "com.amazonaws.kafka#Cluster" } }, "com.amazonaws.kafka#__listOfClusterInfo": { "type": "list", "member": { "target": "com.amazonaws.kafka#ClusterInfo" } }, "com.amazonaws.kafka#__listOfClusterOperationInfo": { "type": "list", "member": { "target": "com.amazonaws.kafka#ClusterOperationInfo" } }, "com.amazonaws.kafka#__listOfClusterOperationStep": { "type": "list", "member": { "target": "com.amazonaws.kafka#ClusterOperationStep" } }, "com.amazonaws.kafka#__listOfClusterOperationV2Summary": { "type": "list", "member": { "target": "com.amazonaws.kafka#ClusterOperationV2Summary" } }, "com.amazonaws.kafka#__listOfCompatibleKafkaVersion": { "type": "list", "member": { "target": "com.amazonaws.kafka#CompatibleKafkaVersion" } }, "com.amazonaws.kafka#__listOfConfiguration": { "type": "list", "member": { "target": "com.amazonaws.kafka#Configuration" } }, "com.amazonaws.kafka#__listOfConfigurationRevision": { "type": "list", "member": { "target": "com.amazonaws.kafka#ConfigurationRevision" } }, "com.amazonaws.kafka#__listOfDestinationTable": { "type": "list", "member": { "target": "com.amazonaws.kafka#DestinationTable" } }, "com.amazonaws.kafka#__listOfKafkaCluster": { "type": "list", "member": { "target": "com.amazonaws.kafka#KafkaCluster" } }, "com.amazonaws.kafka#__listOfKafkaClusterDescription": { "type": "list", "member": { "target": "com.amazonaws.kafka#KafkaClusterDescription" } }, "com.amazonaws.kafka#__listOfKafkaClusterSummary": { "type": "list", "member": { "target": "com.amazonaws.kafka#KafkaClusterSummary" } }, "com.amazonaws.kafka#__listOfKafkaVersion": { "type": "list", "member": { "target": "com.amazonaws.kafka#KafkaVersion" } }, "com.amazonaws.kafka#__listOfNodeInfo": { "type": "list", "member": { "target": "com.amazonaws.kafka#NodeInfo" } }, "com.amazonaws.kafka#__listOfPartitionSource": { "type": "list", "member": { "target": "com.amazonaws.kafka#PartitionSource" } }, "com.amazonaws.kafka#__listOfReplicationInfo": { "type": "list", "member": { "target": "com.amazonaws.kafka#ReplicationInfo" } }, "com.amazonaws.kafka#__listOfReplicationInfoDescription": { "type": "list", "member": { "target": "com.amazonaws.kafka#ReplicationInfoDescription" } }, "com.amazonaws.kafka#__listOfReplicationInfoSummary": { "type": "list", "member": { "target": "com.amazonaws.kafka#ReplicationInfoSummary" } }, "com.amazonaws.kafka#__listOfReplicatorSummary": { "type": "list", "member": { "target": "com.amazonaws.kafka#ReplicatorSummary" } }, "com.amazonaws.kafka#__listOfTopicConfiguration": { "type": "list", "member": { "target": "com.amazonaws.kafka#TopicConfiguration" } }, "com.amazonaws.kafka#__listOfTopicInfo": { "type": "list", "member": { "target": "com.amazonaws.kafka#TopicInfo" } }, "com.amazonaws.kafka#__listOfTopicPartitionInfo": { "type": "list", "member": { "target": "com.amazonaws.kafka#TopicPartitionInfo" } }, "com.amazonaws.kafka#__listOfTopicReassignmentInfo": { "type": "list", "member": { "target": "com.amazonaws.kafka#TopicReassignmentInfo" } }, "com.amazonaws.kafka#__listOfUnprocessedScramSecret": { "type": "list", "member": { "target": "com.amazonaws.kafka#UnprocessedScramSecret" } }, "com.amazonaws.kafka#__listOfVpcConfig": { "type": "list", "member": { "target": "com.amazonaws.kafka#VpcConfig" } }, "com.amazonaws.kafka#__listOfVpcConnection": { "type": "list", "member": { "target": "com.amazonaws.kafka#VpcConnection" } }, "com.amazonaws.kafka#__listOf__double": { "type": "list", "member": { "target": "com.amazonaws.kafka#__double" } }, "com.amazonaws.kafka#__listOf__integer": { "type": "list", "member": { "target": "com.amazonaws.kafka#__integer" } }, "com.amazonaws.kafka#__listOf__string": { "type": "list", "member": { "target": "com.amazonaws.kafka#__string" } }, "com.amazonaws.kafka#__listOf__stringMax249": { "type": "list", "member": { "target": "com.amazonaws.kafka#__stringMax249" } }, "com.amazonaws.kafka#__listOf__stringMax256": { "type": "list", "member": { "target": "com.amazonaws.kafka#__stringMax256" } }, "com.amazonaws.kafka#__listOf__stringMin1Max256": { "type": "list", "member": { "target": "com.amazonaws.kafka#__stringMin1Max256" } }, "com.amazonaws.kafka#__long": { "type": "long" }, "com.amazonaws.kafka#__mapOf__integer": { "type": "map", "key": { "target": "com.amazonaws.kafka#__string" }, "value": { "target": "com.amazonaws.kafka#__integer" } }, "com.amazonaws.kafka#__mapOf__string": { "type": "map", "key": { "target": "com.amazonaws.kafka#__string" }, "value": { "target": "com.amazonaws.kafka#__string" } }, "com.amazonaws.kafka#__string": { "type": "string" }, "com.amazonaws.kafka#__stringMax1024": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.kafka#__stringMax2048": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.kafka#__stringMax249": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 249 } } }, "com.amazonaws.kafka#__stringMax256": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.kafka#__stringMin1Max128": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.kafka#__stringMin1Max128Pattern09AZaZ09AZaZ0": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[0-9A-Za-z][0-9A-Za-z-]{0,}$" } }, "com.amazonaws.kafka#__stringMin1Max256": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.kafka#__stringMin1Max64": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.kafka#__stringMin5Max64": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 64 } } }, "com.amazonaws.kafka#__timestampIso8601": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } } } }