Kafka ***** Client ====== class Kafka.Client A low-level client representing Managed Streaming for Kafka The operations for managing an Amazon MSK cluster. import boto3 client = boto3.client('kafka') These are the available methods: * batch_associate_scram_secret * batch_disassociate_scram_secret * can_paginate * close * create_cluster * create_cluster_v2 * create_configuration * create_replicator * create_vpc_connection * delete_cluster * delete_cluster_policy * delete_configuration * delete_replicator * delete_vpc_connection * describe_cluster * describe_cluster_operation * describe_cluster_operation_v2 * describe_cluster_v2 * describe_configuration * describe_configuration_revision * describe_replicator * describe_vpc_connection * get_bootstrap_brokers * get_cluster_policy * get_compatible_kafka_versions * get_paginator * get_waiter * list_client_vpc_connections * list_cluster_operations * list_cluster_operations_v2 * list_clusters * list_clusters_v2 * list_configuration_revisions * list_configurations * list_kafka_versions * list_nodes * list_replicators * list_scram_secrets * list_tags_for_resource * list_vpc_connections * put_cluster_policy * reboot_broker * reject_client_vpc_connection * tag_resource * untag_resource * update_broker_count * update_broker_storage * update_broker_type * update_cluster_configuration * update_cluster_kafka_version * update_configuration * update_connectivity * update_monitoring * update_replication_info * update_security * update_storage Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListClientVpcConnections * ListClusterOperations * ListClusterOperationsV2 * ListClusters * ListClustersV2 * ListConfigurationRevisions * ListConfigurations * ListKafkaVersions * ListNodes * ListReplicators * ListScramSecrets * ListVpcConnections Kafka / Paginator / ListNodes ListNodes ********* class Kafka.Paginator.ListNodes paginator = client.get_paginator('list_nodes') paginate(**kwargs) Creates an iterator that will paginate through responses from "Kafka.Client.list_nodes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClusterArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'NodeInfoList': [ { 'AddedToClusterTime': 'string', 'BrokerNodeInfo': { 'AttachedENIId': 'string', 'BrokerId': 123.0, 'ClientSubnet': 'string', 'ClientVpcIpAddress': 'string', 'CurrentBrokerSoftwareInfo': { 'ConfigurationArn': 'string', 'ConfigurationRevision': 123, 'KafkaVersion': 'string' }, 'Endpoints': [ 'string', ] }, 'ControllerNodeInfo': { 'Endpoints': [ 'string', ] }, 'InstanceType': 'string', 'NodeARN': 'string', 'NodeType': 'BROKER', 'ZookeeperNodeInfo': { 'AttachedENIId': 'string', 'ClientVpcIpAddress': 'string', 'Endpoints': [ 'string', ], 'ZookeeperId': 123.0, 'ZookeeperVersion': 'string' } }, ] } **Response Structure** * *(dict) --* Successful response. * **NodeInfoList** *(list) --* List containing a NodeInfo object. * *(dict) --* The node information object. * **AddedToClusterTime** *(string) --* The start time. * **BrokerNodeInfo** *(dict) --* The broker node info. * **AttachedENIId** *(string) --* The attached elastic network interface of the broker. * **BrokerId** *(float) --* The ID of the broker. * **ClientSubnet** *(string) --* The client subnet to which this broker node belongs. * **ClientVpcIpAddress** *(string) --* The virtual private cloud (VPC) of the client. * **CurrentBrokerSoftwareInfo** *(dict) --* Information about the version of software currently deployed on the Apache Kafka brokers in the cluster. * **ConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release. * **ConfigurationRevision** *(integer) --* The revision of the configuration to use. This field isn't visible in this preview release. * **KafkaVersion** *(string) --* The version of Apache Kafka. * **Endpoints** *(list) --* Endpoints for accessing the broker. * *(string) --* * **ControllerNodeInfo** *(dict) --* The ControllerNodeInfo. * **Endpoints** *(list) --* Endpoints for accessing the Controller. * *(string) --* * **InstanceType** *(string) --* The instance type. * **NodeARN** *(string) --* The Amazon Resource Name (ARN) of the node. * **NodeType** *(string) --* The node type. * **ZookeeperNodeInfo** *(dict) --* The ZookeeperNodeInfo. * **AttachedENIId** *(string) --* The attached elastic network interface of the broker. * **ClientVpcIpAddress** *(string) --* The virtual private cloud (VPC) IP address of the client. * **Endpoints** *(list) --* Endpoints for accessing the ZooKeeper. * *(string) --* * **ZookeeperId** *(float) --* The role-specific ID for Zookeeper. * **ZookeeperVersion** *(string) --* The version of Zookeeper. Kafka / Paginator / ListClientVpcConnections ListClientVpcConnections ************************ class Kafka.Paginator.ListClientVpcConnections paginator = client.get_paginator('list_client_vpc_connections') paginate(**kwargs) Creates an iterator that will paginate through responses from "Kafka.Client.list_client_vpc_connections()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClusterArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the cluster. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ClientVpcConnections': [ { 'Authentication': 'string', 'CreationTime': datetime(2015, 1, 1), 'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING', 'VpcConnectionArn': 'string', 'Owner': 'string' }, ], } **Response Structure** * *(dict) --* 200 response * **ClientVpcConnections** *(list) --* List of client VPC connections. * *(dict) --* The client VPC connection object. * **Authentication** *(string) --* Information about the auth scheme of Vpc Connection. * **CreationTime** *(datetime) --* Creation time of the Vpc Connection. * **State** *(string) --* State of the Vpc Connection. * **VpcConnectionArn** *(string) --* The ARN that identifies the Vpc Connection. * **Owner** *(string) --* The Owner of the Vpc Connection. Kafka / Paginator / ListKafkaVersions ListKafkaVersions ***************** class Kafka.Paginator.ListKafkaVersions paginator = client.get_paginator('list_kafka_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Kafka.Client.list_kafka_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'KafkaVersions': [ { 'Version': 'string', 'Status': 'ACTIVE'|'DEPRECATED' }, ], } **Response Structure** * *(dict) --* * **KafkaVersions** *(list) --* * *(dict) --* * **Version** *(string) --* * **Status** *(string) --* Kafka / Paginator / ListReplicators ListReplicators *************** class Kafka.Paginator.ListReplicators paginator = client.get_paginator('list_replicators') paginate(**kwargs) Creates an iterator that will paginate through responses from "Kafka.Client.list_replicators()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ReplicatorNameFilter='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ReplicatorNameFilter** (*string*) -- Returns replicators starting with given name. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Replicators': [ { 'CreationTime': datetime(2015, 1, 1), 'CurrentVersion': 'string', 'IsReplicatorReference': True|False, 'KafkaClustersSummary': [ { 'AmazonMskCluster': { 'MskClusterArn': 'string' }, 'KafkaClusterAlias': 'string' }, ], 'ReplicationInfoSummaryList': [ { 'SourceKafkaClusterAlias': 'string', 'TargetKafkaClusterAlias': 'string' }, ], 'ReplicatorArn': 'string', 'ReplicatorName': 'string', 'ReplicatorResourceArn': 'string', 'ReplicatorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED' }, ] } **Response Structure** * *(dict) --* HTTP Status Code 200: OK. * **Replicators** *(list) --* List containing information of each of the replicators in the account. * *(dict) --* Information about a replicator. * **CreationTime** *(datetime) --* The time the replicator was created. * **CurrentVersion** *(string) --* The current version of the replicator. * **IsReplicatorReference** *(boolean) --* Whether this resource is a replicator reference. * **KafkaClustersSummary** *(list) --* Kafka Clusters used in setting up sources / targets for replication. * *(dict) --* Summarized information about Kafka Cluster used as source / target for replication. * **AmazonMskCluster** *(dict) --* Details of an Amazon MSK Cluster. * **MskClusterArn** *(string) --* The Amazon Resource Name (ARN) of an Amazon MSK cluster. * **KafkaClusterAlias** *(string) --* The alias of the Kafka cluster. Used to prefix names of replicated topics. * **ReplicationInfoSummaryList** *(list) --* A list of summarized information of replications between clusters. * *(dict) --* Summarized information of replication between clusters. * **SourceKafkaClusterAlias** *(string) --* The alias of the source Kafka cluster. * **TargetKafkaClusterAlias** *(string) --* The alias of the target Kafka cluster. * **ReplicatorArn** *(string) --* The Amazon Resource Name (ARN) of the replicator. * **ReplicatorName** *(string) --* The name of the replicator. * **ReplicatorResourceArn** *(string) --* The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created. * **ReplicatorState** *(string) --* State of the replicator. Kafka / Paginator / ListClusterOperationsV2 ListClusterOperationsV2 *********************** class Kafka.Paginator.ListClusterOperationsV2 paginator = client.get_paginator('list_cluster_operations_v2') paginate(**kwargs) Creates an iterator that will paginate through responses from "Kafka.Client.list_cluster_operations_v2()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClusterArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The arn of the cluster whose operations are being requested. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ClusterOperationInfoList': [ { 'ClusterArn': 'string', 'ClusterType': 'PROVISIONED'|'SERVERLESS', 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'OperationArn': 'string', 'OperationState': 'string', 'OperationType': 'string' }, ], } **Response Structure** * *(dict) --* HTTP Status Code 200: OK. * **ClusterOperationInfoList** *(list) --* An array of cluster operation information objects. * *(dict) --* Returns information about a cluster operation. * **ClusterArn** *(string) --* ARN of the cluster. * **ClusterType** *(string) --* Type of the backend cluster. * **StartTime** *(datetime) --* The time at which operation was started. * **EndTime** *(datetime) --* The time at which the operation finished. * **OperationArn** *(string) --* ARN of the cluster operation. * **OperationState** *(string) --* State of the cluster operation. * **OperationType** *(string) --* Type of the cluster operation. Kafka / Paginator / ListConfigurationRevisions ListConfigurationRevisions ************************** class Kafka.Paginator.ListConfigurationRevisions paginator = client.get_paginator('list_configuration_revisions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Kafka.Client.list_configuration_revisions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Arn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Revisions': [ { 'CreationTime': datetime(2015, 1, 1), 'Description': 'string', 'Revision': 123 }, ] } **Response Structure** * *(dict) --* 200 response * **Revisions** *(list) --* List of ConfigurationRevision objects. * *(dict) --* Describes a configuration revision. * **CreationTime** *(datetime) --* The time when the configuration revision was created. * **Description** *(string) --* The description of the configuration revision. * **Revision** *(integer) --* The revision number. Kafka / Paginator / ListClustersV2 ListClustersV2 ************** class Kafka.Paginator.ListClustersV2 paginator = client.get_paginator('list_clusters_v2') paginate(**kwargs) Creates an iterator that will paginate through responses from "Kafka.Client.list_clusters_v2()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClusterNameFilter='string', ClusterTypeFilter='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClusterNameFilter** (*string*) -- 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. * **ClusterTypeFilter** (*string*) -- Specify either PROVISIONED or SERVERLESS. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ClusterInfoList': [ { 'ActiveOperationArn': 'string', 'ClusterType': 'PROVISIONED'|'SERVERLESS', 'ClusterArn': 'string', 'ClusterName': 'string', 'CreationTime': datetime(2015, 1, 1), 'CurrentVersion': 'string', 'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING', 'StateInfo': { 'Code': 'string', 'Message': 'string' }, 'Tags': { 'string': 'string' }, 'Provisioned': { 'BrokerNodeGroupInfo': { 'BrokerAZDistribution': 'DEFAULT', 'ClientSubnets': [ 'string', ], 'InstanceType': 'string', 'SecurityGroups': [ 'string', ], 'StorageInfo': { 'EbsStorageInfo': { 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSize': 123 } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'ZoneIds': [ 'string', ] }, 'CurrentBrokerSoftwareInfo': { 'ConfigurationArn': 'string', 'ConfigurationRevision': 123, 'KafkaVersion': 'string' }, 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, 'EncryptionInfo': { 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, 'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', 'OpenMonitoring': { 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, 'LoggingInfo': { 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, 'NumberOfBrokerNodes': 123, 'ZookeeperConnectString': 'string', 'ZookeeperConnectStringTls': 'string', 'StorageMode': 'LOCAL'|'TIERED', 'CustomerActionStatus': 'CRITICAL_ACTION_REQUIRED'|'ACTION_RECOMMENDED'|'NONE' }, 'Serverless': { 'VpcConfigs': [ { 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ] }, ], 'ClientAuthentication': { 'Sasl': { 'Iam': { 'Enabled': True|False } } } } }, ], } **Response Structure** * *(dict) --* Successful response. * **ClusterInfoList** *(list) --* Information on each of the MSK clusters in the response. * *(dict) --* Returns information about a cluster. * **ActiveOperationArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies a cluster operation. * **ClusterType** *(string) --* Cluster Type. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **ClusterName** *(string) --* The name of the cluster. * **CreationTime** *(datetime) --* The time when the cluster was created. * **CurrentVersion** *(string) --* The current version of the MSK cluster. * **State** *(string) --* The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING. * **StateInfo** *(dict) --* State Info for the Amazon MSK cluster. * **Code** *(string) --* * **Message** *(string) --* * **Tags** *(dict) --* Tags attached to the cluster. * *(string) --* * *(string) --* * **Provisioned** *(dict) --* Information about the provisioned cluster. * **BrokerNodeGroupInfo** *(dict) --* Information about the brokers. * **BrokerAZDistribution** *(string) --* The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed. Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster. * **ClientSubnets** *(list) --* 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. * *(string) --* * **InstanceType** *(string) --* The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge. * **SecurityGroups** *(list) --* 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. * *(string) --* * **StorageInfo** *(dict) --* Contains information about storage volumes attached to MSK broker nodes. * **EbsStorageInfo** *(dict) --* EBS volume information. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSize** *(integer) --* The size in GiB of the EBS volume for the data drive on each broker node. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **ZoneIds** *(list) --* The list of zoneIds for the cluster in the virtual private cloud (VPC). * *(string) --* * **CurrentBrokerSoftwareInfo** *(dict) --* Information about the Apache Kafka version deployed on the brokers. * **ConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release. * **ConfigurationRevision** *(integer) --* The revision of the configuration to use. This field isn't visible in this preview release. * **KafkaVersion** *(string) --* The version of Apache Kafka. * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **EncryptionInfo** *(dict) --* Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS- encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **EnhancedMonitoring** *(string) --* Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. * **OpenMonitoring** *(dict) --* The settings for open monitoring. * **Prometheus** *(dict) --* Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the Node Exporter. * **LoggingInfo** *(dict) --* Log delivery information for the cluster. * **BrokerLogs** *(dict) --* * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* * **Prefix** *(string) --* * **NumberOfBrokerNodes** *(integer) --* The number of broker nodes in the cluster. * **ZookeeperConnectString** *(string) --* The connection string to use to connect to the Apache ZooKeeper cluster. * **ZookeeperConnectStringTls** *(string) --* The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port. * **StorageMode** *(string) --* This controls storage mode for supported storage tiers. * **CustomerActionStatus** *(string) --* Determines if there is an action required from the customer. * **Serverless** *(dict) --* Information about the serverless cluster. * **VpcConfigs** *(list) --* The configuration of the Amazon VPCs for the cluster. * *(dict) --* The configuration of the Amazon VPCs for the cluster. * **SubnetIds** *(list) --* The IDs of the subnets associated with the cluster. * *(string) --* * **SecurityGroupIds** *(list) --* The IDs of the security groups associated with the cluster. * *(string) --* * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. Kafka / Paginator / ListConfigurations ListConfigurations ****************** class Kafka.Paginator.ListConfigurations paginator = client.get_paginator('list_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from "Kafka.Client.list_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Configurations': [ { 'Arn': 'string', 'CreationTime': datetime(2015, 1, 1), 'Description': 'string', 'KafkaVersions': [ 'string', ], 'LatestRevision': { 'CreationTime': datetime(2015, 1, 1), 'Description': 'string', 'Revision': 123 }, 'Name': 'string', 'State': 'ACTIVE'|'DELETING'|'DELETE_FAILED' }, ], } **Response Structure** * *(dict) --* 200 response * **Configurations** *(list) --* An array of MSK configurations. * *(dict) --* Represents an MSK Configuration. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the configuration. * **CreationTime** *(datetime) --* The time when the configuration was created. * **Description** *(string) --* The description of the configuration. * **KafkaVersions** *(list) --* 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. * *(string) --* * **LatestRevision** *(dict) --* Latest revision of the configuration. * **CreationTime** *(datetime) --* The time when the configuration revision was created. * **Description** *(string) --* The description of the configuration revision. * **Revision** *(integer) --* The revision number. * **Name** *(string) --* The name of the configuration. * **State** *(string) --* The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED. Kafka / Paginator / ListClusterOperations ListClusterOperations ********************* class Kafka.Paginator.ListClusterOperations paginator = client.get_paginator('list_cluster_operations') paginate(**kwargs) Creates an iterator that will paginate through responses from "Kafka.Client.list_cluster_operations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClusterArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ClusterOperationInfoList': [ { 'ClientRequestId': 'string', 'ClusterArn': 'string', 'CreationTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'ErrorInfo': { 'ErrorCode': 'string', 'ErrorString': 'string' }, 'OperationArn': 'string', 'OperationState': 'string', 'OperationSteps': [ { 'StepInfo': { 'StepStatus': 'string' }, 'StepName': 'string' }, ], 'OperationType': 'string', 'SourceClusterInfo': { 'BrokerEBSVolumeInfo': [ { 'KafkaBrokerNodeId': 'string', 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSizeGB': 123 }, ], 'ConfigurationInfo': { 'Arn': 'string', 'Revision': 123 }, 'NumberOfBrokerNodes': 123, 'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', 'OpenMonitoring': { 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, 'KafkaVersion': 'string', 'LoggingInfo': { 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, 'InstanceType': 'string', 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, 'EncryptionInfo': { 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'StorageMode': 'LOCAL'|'TIERED', 'BrokerCountUpdateInfo': { 'CreatedBrokerIds': [ 123.0, ], 'DeletedBrokerIds': [ 123.0, ] } }, 'TargetClusterInfo': { 'BrokerEBSVolumeInfo': [ { 'KafkaBrokerNodeId': 'string', 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSizeGB': 123 }, ], 'ConfigurationInfo': { 'Arn': 'string', 'Revision': 123 }, 'NumberOfBrokerNodes': 123, 'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', 'OpenMonitoring': { 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, 'KafkaVersion': 'string', 'LoggingInfo': { 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, 'InstanceType': 'string', 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, 'EncryptionInfo': { 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'StorageMode': 'LOCAL'|'TIERED', 'BrokerCountUpdateInfo': { 'CreatedBrokerIds': [ 123.0, ], 'DeletedBrokerIds': [ 123.0, ] } }, 'VpcConnectionInfo': { 'VpcConnectionArn': 'string', 'Owner': 'string', 'UserIdentity': { 'Type': 'AWSACCOUNT'|'AWSSERVICE', 'PrincipalId': 'string' }, 'CreationTime': datetime(2015, 1, 1) } }, ], } **Response Structure** * *(dict) --* Successful response. * **ClusterOperationInfoList** *(list) --* An array of cluster operation information objects. * *(dict) --* Returns information about a cluster operation. * **ClientRequestId** *(string) --* The ID of the API request that triggered this operation. * **ClusterArn** *(string) --* ARN of the cluster. * **CreationTime** *(datetime) --* The time that the operation was created. * **EndTime** *(datetime) --* The time at which the operation finished. * **ErrorInfo** *(dict) --* Describes the error if the operation fails. * **ErrorCode** *(string) --* A number describing the error programmatically. * **ErrorString** *(string) --* An optional field to provide more details about the error. * **OperationArn** *(string) --* ARN of the cluster operation. * **OperationState** *(string) --* State of the cluster operation. * **OperationSteps** *(list) --* Steps completed during the operation. * *(dict) --* Step taken during a cluster operation. * **StepInfo** *(dict) --* Information about the step and its status. * **StepStatus** *(string) --* The steps current status. * **StepName** *(string) --* The name of the step. * **OperationType** *(string) --* Type of the cluster operation. * **SourceClusterInfo** *(dict) --* Information about cluster attributes before a cluster is updated. * **BrokerEBSVolumeInfo** *(list) --* Specifies the size of the EBS volume and the ID of the associated broker. * *(dict) --* 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. * **KafkaBrokerNodeId** *(string) --* The ID of the broker to update. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSizeGB** *(integer) --* Size of the EBS volume to update. * **ConfigurationInfo** *(dict) --* Information about the changes in the configuration of the brokers. * **Arn** *(string) --* ARN of the configuration to use. * **Revision** *(integer) --* The revision of the configuration to use. * **NumberOfBrokerNodes** *(integer) --* The number of broker nodes in the cluster. * **EnhancedMonitoring** *(string) --* Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster. * **OpenMonitoring** *(dict) --* The settings for open monitoring. * **Prometheus** *(dict) --* Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the Node Exporter. * **KafkaVersion** *(string) --* The Apache Kafka version. * **LoggingInfo** *(dict) --* 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. * **BrokerLogs** *(dict) --* * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* * **Prefix** *(string) --* * **InstanceType** *(string) --* Information about the Amazon MSK broker type. * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **EncryptionInfo** *(dict) --* Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS- encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **StorageMode** *(string) --* This controls storage mode for supported storage tiers. * **BrokerCountUpdateInfo** *(dict) --* Describes brokers being changed during a broker count update. * **CreatedBrokerIds** *(list) --* Kafka Broker IDs of brokers being created. * *(float) --* * **DeletedBrokerIds** *(list) --* Kafka Broker IDs of brokers being deleted. * *(float) --* * **TargetClusterInfo** *(dict) --* Information about cluster attributes after a cluster is updated. * **BrokerEBSVolumeInfo** *(list) --* Specifies the size of the EBS volume and the ID of the associated broker. * *(dict) --* 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. * **KafkaBrokerNodeId** *(string) --* The ID of the broker to update. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSizeGB** *(integer) --* Size of the EBS volume to update. * **ConfigurationInfo** *(dict) --* Information about the changes in the configuration of the brokers. * **Arn** *(string) --* ARN of the configuration to use. * **Revision** *(integer) --* The revision of the configuration to use. * **NumberOfBrokerNodes** *(integer) --* The number of broker nodes in the cluster. * **EnhancedMonitoring** *(string) --* Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster. * **OpenMonitoring** *(dict) --* The settings for open monitoring. * **Prometheus** *(dict) --* Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the Node Exporter. * **KafkaVersion** *(string) --* The Apache Kafka version. * **LoggingInfo** *(dict) --* 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. * **BrokerLogs** *(dict) --* * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* * **Prefix** *(string) --* * **InstanceType** *(string) --* Information about the Amazon MSK broker type. * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **EncryptionInfo** *(dict) --* Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS- encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **StorageMode** *(string) --* This controls storage mode for supported storage tiers. * **BrokerCountUpdateInfo** *(dict) --* Describes brokers being changed during a broker count update. * **CreatedBrokerIds** *(list) --* Kafka Broker IDs of brokers being created. * *(float) --* * **DeletedBrokerIds** *(list) --* Kafka Broker IDs of brokers being deleted. * *(float) --* * **VpcConnectionInfo** *(dict) --* Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) of the VPC connection. * **Owner** *(string) --* The owner of the VPC Connection. * **UserIdentity** *(dict) --* Description of the requester that calls the API operation. * **Type** *(string) --* The identity type of the requester that calls the API operation. * **PrincipalId** *(string) --* A unique identifier for the requester that calls the API operation. * **CreationTime** *(datetime) --* The time when Amazon MSK creates the VPC Connnection. Kafka / Paginator / ListVpcConnections ListVpcConnections ****************** class Kafka.Paginator.ListVpcConnections paginator = client.get_paginator('list_vpc_connections') paginate(**kwargs) Creates an iterator that will paginate through responses from "Kafka.Client.list_vpc_connections()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'VpcConnections': [ { 'VpcConnectionArn': 'string', 'TargetClusterArn': 'string', 'CreationTime': datetime(2015, 1, 1), 'Authentication': 'string', 'VpcId': 'string', 'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING' }, ], } **Response Structure** * *(dict) --* 200 response * **VpcConnections** *(list) --* List of VPC connections. * *(dict) --* The VPC connection object. * **VpcConnectionArn** *(string) --* The ARN that identifies the Vpc Connection. * **TargetClusterArn** *(string) --* The ARN that identifies the Cluster which the Vpc Connection belongs to. * **CreationTime** *(datetime) --* Creation time of the Vpc Connection. * **Authentication** *(string) --* Information about the auth scheme of Vpc Connection. * **VpcId** *(string) --* The vpcId that belongs to the Vpc Connection. * **State** *(string) --* State of the Vpc Connection. Kafka / Paginator / ListClusters ListClusters ************ class Kafka.Paginator.ListClusters paginator = client.get_paginator('list_clusters') paginate(**kwargs) Creates an iterator that will paginate through responses from "Kafka.Client.list_clusters()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClusterNameFilter='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClusterNameFilter** (*string*) -- 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. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ClusterInfoList': [ { 'ActiveOperationArn': 'string', 'BrokerNodeGroupInfo': { 'BrokerAZDistribution': 'DEFAULT', 'ClientSubnets': [ 'string', ], 'InstanceType': 'string', 'SecurityGroups': [ 'string', ], 'StorageInfo': { 'EbsStorageInfo': { 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSize': 123 } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'ZoneIds': [ 'string', ] }, 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, 'ClusterArn': 'string', 'ClusterName': 'string', 'CreationTime': datetime(2015, 1, 1), 'CurrentBrokerSoftwareInfo': { 'ConfigurationArn': 'string', 'ConfigurationRevision': 123, 'KafkaVersion': 'string' }, 'CurrentVersion': 'string', 'EncryptionInfo': { 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, 'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', 'OpenMonitoring': { 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, 'LoggingInfo': { 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, 'NumberOfBrokerNodes': 123, 'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING', 'StateInfo': { 'Code': 'string', 'Message': 'string' }, 'Tags': { 'string': 'string' }, 'ZookeeperConnectString': 'string', 'ZookeeperConnectStringTls': 'string', 'StorageMode': 'LOCAL'|'TIERED', 'CustomerActionStatus': 'CRITICAL_ACTION_REQUIRED'|'ACTION_RECOMMENDED'|'NONE' }, ], } **Response Structure** * *(dict) --* Successful response. * **ClusterInfoList** *(list) --* Information on each of the MSK clusters in the response. * *(dict) --* Returns information about a cluster. * **ActiveOperationArn** *(string) --* Arn of active cluster operation. * **BrokerNodeGroupInfo** *(dict) --* Information about the broker nodes. * **BrokerAZDistribution** *(string) --* The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed. Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster. * **ClientSubnets** *(list) --* 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. * *(string) --* * **InstanceType** *(string) --* The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge. * **SecurityGroups** *(list) --* 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. * *(string) --* * **StorageInfo** *(dict) --* Contains information about storage volumes attached to MSK broker nodes. * **EbsStorageInfo** *(dict) --* EBS volume information. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSize** *(integer) --* The size in GiB of the EBS volume for the data drive on each broker node. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **ZoneIds** *(list) --* The list of zoneIds for the cluster in the virtual private cloud (VPC). * *(string) --* * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **ClusterName** *(string) --* The name of the cluster. * **CreationTime** *(datetime) --* The time when the cluster was created. * **CurrentBrokerSoftwareInfo** *(dict) --* Information about the version of software currently deployed on the Apache Kafka brokers in the cluster. * **ConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release. * **ConfigurationRevision** *(integer) --* The revision of the configuration to use. This field isn't visible in this preview release. * **KafkaVersion** *(string) --* The version of Apache Kafka. * **CurrentVersion** *(string) --* The current version of the MSK cluster. * **EncryptionInfo** *(dict) --* Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **EnhancedMonitoring** *(string) --* Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring. * **OpenMonitoring** *(dict) --* Settings for open monitoring using Prometheus. * **Prometheus** *(dict) --* Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the Node Exporter. * **LoggingInfo** *(dict) --* * **BrokerLogs** *(dict) --* * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* * **Prefix** *(string) --* * **NumberOfBrokerNodes** *(integer) --* The number of broker nodes in the cluster. * **State** *(string) --* The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING. * **StateInfo** *(dict) --* * **Code** *(string) --* * **Message** *(string) --* * **Tags** *(dict) --* Tags attached to the cluster. * *(string) --* * *(string) --* * **ZookeeperConnectString** *(string) --* The connection string to use to connect to the Apache ZooKeeper cluster. * **ZookeeperConnectStringTls** *(string) --* The connection string to use to connect to zookeeper cluster on Tls port. * **StorageMode** *(string) --* This controls storage mode for supported storage tiers. * **CustomerActionStatus** *(string) --* Determines if there is an action required from the customer. Kafka / Paginator / ListScramSecrets ListScramSecrets **************** class Kafka.Paginator.ListScramSecrets paginator = client.get_paginator('list_scram_secrets') paginate(**kwargs) Creates an iterator that will paginate through responses from "Kafka.Client.list_scram_secrets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClusterArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The arn of the cluster. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SecretArnList': [ 'string', ] } **Response Structure** * *(dict) --* 200 response * **SecretArnList** *(list) --* The list of scram secrets associated with the cluster. * *(string) --* Kafka / Client / get_paginator get_paginator ************* Kafka.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. Kafka / Client / create_cluster create_cluster ************** Kafka.Client.create_cluster(**kwargs) Creates a new MSK cluster. See also: AWS API Documentation **Request Syntax** response = client.create_cluster( BrokerNodeGroupInfo={ 'BrokerAZDistribution': 'DEFAULT', 'ClientSubnets': [ 'string', ], 'InstanceType': 'string', 'SecurityGroups': [ 'string', ], 'StorageInfo': { 'EbsStorageInfo': { 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSize': 123 } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'ZoneIds': [ 'string', ] }, ClientAuthentication={ 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, ClusterName='string', ConfigurationInfo={ 'Arn': 'string', 'Revision': 123 }, EncryptionInfo={ 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, EnhancedMonitoring='DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', OpenMonitoring={ 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, KafkaVersion='string', LoggingInfo={ 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, NumberOfBrokerNodes=123, Tags={ 'string': 'string' }, StorageMode='LOCAL'|'TIERED' ) Parameters: * **BrokerNodeGroupInfo** (*dict*) -- **[REQUIRED]** Information about the broker nodes in the cluster. * **BrokerAZDistribution** *(string) --* The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed. Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster. * **ClientSubnets** *(list) --* **[REQUIRED]** 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. * *(string) --* * **InstanceType** *(string) --* **[REQUIRED]** The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge. * **SecurityGroups** *(list) --* 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. * *(string) --* * **StorageInfo** *(dict) --* Contains information about storage volumes attached to MSK broker nodes. * **EbsStorageInfo** *(dict) --* EBS volume information. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSize** *(integer) --* The size in GiB of the EBS volume for the data drive on each broker node. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **ZoneIds** *(list) --* The list of zoneIds for the cluster in the virtual private cloud (VPC). * *(string) --* * **ClientAuthentication** (*dict*) -- Includes all client authentication related information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **ClusterName** (*string*) -- **[REQUIRED]** The name of the cluster. * **ConfigurationInfo** (*dict*) -- Represents the configuration that you want MSK to use for the brokers in a cluster. * **Arn** *(string) --* **[REQUIRED]** ARN of the configuration to use. * **Revision** *(integer) --* **[REQUIRED]** The revision of the configuration to use. * **EncryptionInfo** (*dict*) -- Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* **[REQUIRED]** 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **EnhancedMonitoring** (*string*) -- Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. * **OpenMonitoring** (*dict*) -- The settings for open monitoring. * **Prometheus** *(dict) --* **[REQUIRED]** Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* **[REQUIRED]** Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* **[REQUIRED]** Indicates whether you want to turn on or turn off the Node Exporter. * **KafkaVersion** (*string*) -- **[REQUIRED]** The version of Apache Kafka. * **LoggingInfo** (*dict*) -- * **BrokerLogs** *(dict) --* **[REQUIRED]** * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* **[REQUIRED]** * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* **[REQUIRED]** * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* **[REQUIRED]** * **Prefix** *(string) --* * **NumberOfBrokerNodes** (*integer*) -- **[REQUIRED]** The number of broker nodes in the cluster. * **Tags** (*dict*) -- Create tags when creating the cluster. * *(string) --* * *(string) --* * **StorageMode** (*string*) -- This controls storage mode for supported storage tiers. Return type: dict Returns: **Response Syntax** { 'ClusterArn': 'string', 'ClusterName': 'string', 'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING' } **Response Structure** * *(dict) --* * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) of the cluster. * **ClusterName** *(string) --* The name of the MSK cluster. * **State** *(string) --* The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" * "Kafka.Client.exceptions.ConflictException" Kafka / Client / batch_disassociate_scram_secret batch_disassociate_scram_secret ******************************* Kafka.Client.batch_disassociate_scram_secret(**kwargs) Disassociates one or more Scram Secrets from an Amazon MSK cluster. See also: AWS API Documentation **Request Syntax** response = client.batch_disassociate_scram_secret( ClusterArn='string', SecretArnList=[ 'string', ] ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the cluster to be updated. * **SecretArnList** (*list*) -- **[REQUIRED]** List of AWS Secrets Manager secret ARNs. * *(string) --* Return type: dict Returns: **Response Syntax** { 'ClusterArn': 'string', 'UnprocessedScramSecrets': [ { 'ErrorCode': 'string', 'ErrorMessage': 'string', 'SecretArn': 'string' }, ] } **Response Structure** * *(dict) --* 200 response * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) of the cluster. * **UnprocessedScramSecrets** *(list) --* List of errors when disassociating secrets to cluster. * *(dict) --* Error info for scram secret associate/disassociate failure. * **ErrorCode** *(string) --* Error code for associate/disassociate failure. * **ErrorMessage** *(string) --* Error message for associate/disassociate failure. * **SecretArn** *(string) --* AWS Secrets Manager secret ARN. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / put_cluster_policy put_cluster_policy ****************** Kafka.Client.put_cluster_policy(**kwargs) Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request. See also: AWS API Documentation **Request Syntax** response = client.put_cluster_policy( ClusterArn='string', CurrentVersion='string', Policy='string' ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the cluster. * **CurrentVersion** (*string*) -- The policy version. * **Policy** (*string*) -- **[REQUIRED]** The policy. Return type: dict Returns: **Response Syntax** { 'CurrentVersion': 'string' } **Response Structure** * *(dict) --* Successful response. * **CurrentVersion** *(string) --* The policy version. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / list_nodes list_nodes ********** Kafka.Client.list_nodes(**kwargs) Returns a list of the broker nodes in the cluster. See also: AWS API Documentation **Request Syntax** response = client.list_nodes( ClusterArn='string', MaxResults=123, NextToken='string' ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **MaxResults** (*integer*) -- The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'NodeInfoList': [ { 'AddedToClusterTime': 'string', 'BrokerNodeInfo': { 'AttachedENIId': 'string', 'BrokerId': 123.0, 'ClientSubnet': 'string', 'ClientVpcIpAddress': 'string', 'CurrentBrokerSoftwareInfo': { 'ConfigurationArn': 'string', 'ConfigurationRevision': 123, 'KafkaVersion': 'string' }, 'Endpoints': [ 'string', ] }, 'ControllerNodeInfo': { 'Endpoints': [ 'string', ] }, 'InstanceType': 'string', 'NodeARN': 'string', 'NodeType': 'BROKER', 'ZookeeperNodeInfo': { 'AttachedENIId': 'string', 'ClientVpcIpAddress': 'string', 'Endpoints': [ 'string', ], 'ZookeeperId': 123.0, 'ZookeeperVersion': 'string' } }, ] } **Response Structure** * *(dict) --* Successful response. * **NextToken** *(string) --* The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken in the response. To get another batch of nodes, provide this token in your next request. * **NodeInfoList** *(list) --* List containing a NodeInfo object. * *(dict) --* The node information object. * **AddedToClusterTime** *(string) --* The start time. * **BrokerNodeInfo** *(dict) --* The broker node info. * **AttachedENIId** *(string) --* The attached elastic network interface of the broker. * **BrokerId** *(float) --* The ID of the broker. * **ClientSubnet** *(string) --* The client subnet to which this broker node belongs. * **ClientVpcIpAddress** *(string) --* The virtual private cloud (VPC) of the client. * **CurrentBrokerSoftwareInfo** *(dict) --* Information about the version of software currently deployed on the Apache Kafka brokers in the cluster. * **ConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release. * **ConfigurationRevision** *(integer) --* The revision of the configuration to use. This field isn't visible in this preview release. * **KafkaVersion** *(string) --* The version of Apache Kafka. * **Endpoints** *(list) --* Endpoints for accessing the broker. * *(string) --* * **ControllerNodeInfo** *(dict) --* The ControllerNodeInfo. * **Endpoints** *(list) --* Endpoints for accessing the Controller. * *(string) --* * **InstanceType** *(string) --* The instance type. * **NodeARN** *(string) --* The Amazon Resource Name (ARN) of the node. * **NodeType** *(string) --* The node type. * **ZookeeperNodeInfo** *(dict) --* The ZookeeperNodeInfo. * **AttachedENIId** *(string) --* The attached elastic network interface of the broker. * **ClientVpcIpAddress** *(string) --* The virtual private cloud (VPC) IP address of the client. * **Endpoints** *(list) --* Endpoints for accessing the ZooKeeper. * *(string) --* * **ZookeeperId** *(float) --* The role-specific ID for Zookeeper. * **ZookeeperVersion** *(string) --* The version of Zookeeper. **Exceptions** * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / delete_configuration delete_configuration ******************** Kafka.Client.delete_configuration(**kwargs) Deletes an MSK Configuration. See also: AWS API Documentation **Request Syntax** response = client.delete_configuration( Arn='string' ) Parameters: **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'State': 'ACTIVE'|'DELETING'|'DELETE_FAILED' } **Response Structure** * *(dict) --* Successful response. * **Arn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration. * **State** *(string) --* The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED. **Exceptions** * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / update_cluster_kafka_version update_cluster_kafka_version **************************** Kafka.Client.update_cluster_kafka_version(**kwargs) Updates the Apache Kafka version for the cluster. See also: AWS API Documentation **Request Syntax** response = client.update_cluster_kafka_version( ClusterArn='string', ConfigurationInfo={ 'Arn': 'string', 'Revision': 123 }, CurrentVersion='string', TargetKafkaVersion='string' ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the cluster to be updated. * **ConfigurationInfo** (*dict*) -- The custom configuration that should be applied on the new version of cluster. * **Arn** *(string) --* **[REQUIRED]** ARN of the configuration to use. * **Revision** *(integer) --* **[REQUIRED]** The revision of the configuration to use. * **CurrentVersion** (*string*) -- **[REQUIRED]** Current cluster version. * **TargetKafkaVersion** (*string*) -- **[REQUIRED]** Target Kafka version. Return type: dict Returns: **Response Syntax** { 'ClusterArn': 'string', 'ClusterOperationArn': 'string' } **Response Structure** * *(dict) --* Successful response. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) of the cluster. * **ClusterOperationArn** *(string) --* The Amazon Resource Name (ARN) of the cluster operation. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / list_cluster_operations_v2 list_cluster_operations_v2 ************************** Kafka.Client.list_cluster_operations_v2(**kwargs) Returns a list of all the operations that have been performed on the specified MSK cluster. See also: AWS API Documentation **Request Syntax** response = client.list_cluster_operations_v2( ClusterArn='string', MaxResults=123, NextToken='string' ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The arn of the cluster whose operations are being requested. * **MaxResults** (*integer*) -- The maxResults of the query. * **NextToken** (*string*) -- The nextToken of the query. Return type: dict Returns: **Response Syntax** { 'ClusterOperationInfoList': [ { 'ClusterArn': 'string', 'ClusterType': 'PROVISIONED'|'SERVERLESS', 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'OperationArn': 'string', 'OperationState': 'string', 'OperationType': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* HTTP Status Code 200: OK. * **ClusterOperationInfoList** *(list) --* An array of cluster operation information objects. * *(dict) --* Returns information about a cluster operation. * **ClusterArn** *(string) --* ARN of the cluster. * **ClusterType** *(string) --* Type of the backend cluster. * **StartTime** *(datetime) --* The time at which operation was started. * **EndTime** *(datetime) --* The time at which the operation finished. * **OperationArn** *(string) --* ARN of the cluster operation. * **OperationState** *(string) --* State of the cluster operation. * **OperationType** *(string) --* Type of the cluster operation. * **NextToken** *(string) --* 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. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / update_replication_info update_replication_info *********************** Kafka.Client.update_replication_info(**kwargs) Updates replication info of a replicator. See also: AWS API Documentation **Request Syntax** response = client.update_replication_info( ConsumerGroupReplication={ 'ConsumerGroupsToExclude': [ 'string', ], 'ConsumerGroupsToReplicate': [ 'string', ], 'DetectAndCopyNewConsumerGroups': True|False, 'SynchroniseConsumerGroupOffsets': True|False }, CurrentVersion='string', ReplicatorArn='string', SourceKafkaClusterArn='string', TargetKafkaClusterArn='string', TopicReplication={ 'CopyAccessControlListsForTopics': True|False, 'CopyTopicConfigurations': True|False, 'DetectAndCopyNewTopics': True|False, 'TopicsToExclude': [ 'string', ], 'TopicsToReplicate': [ 'string', ] } ) Parameters: * **ConsumerGroupReplication** (*dict*) -- Updated consumer group replication information. * **ConsumerGroupsToExclude** *(list) --* **[REQUIRED]** List of regular expression patterns indicating the consumer groups that should not be replicated. * *(string) --* * **ConsumerGroupsToReplicate** *(list) --* **[REQUIRED]** List of regular expression patterns indicating the consumer groups to copy. * *(string) --* * **DetectAndCopyNewConsumerGroups** *(boolean) --* **[REQUIRED]** Enables synchronization of consumer groups to target cluster. * **SynchroniseConsumerGroupOffsets** *(boolean) --* **[REQUIRED]** Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets. * **CurrentVersion** (*string*) -- **[REQUIRED]** Current replicator version. * **ReplicatorArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the replicator to be updated. * **SourceKafkaClusterArn** (*string*) -- **[REQUIRED]** The ARN of the source Kafka cluster. * **TargetKafkaClusterArn** (*string*) -- **[REQUIRED]** The ARN of the target Kafka cluster. * **TopicReplication** (*dict*) -- Updated topic replication information. * **CopyAccessControlListsForTopics** *(boolean) --* **[REQUIRED]** Whether to periodically configure remote topic ACLs to match their corresponding upstream topics. * **CopyTopicConfigurations** *(boolean) --* **[REQUIRED]** Whether to periodically configure remote topics to match their corresponding upstream topics. * **DetectAndCopyNewTopics** *(boolean) --* **[REQUIRED]** Whether to periodically check for new topics and partitions. * **TopicsToExclude** *(list) --* **[REQUIRED]** List of regular expression patterns indicating the topics that should not be replicated. * *(string) --* * **TopicsToReplicate** *(list) --* **[REQUIRED]** List of regular expression patterns indicating the topics to copy. * *(string) --* Return type: dict Returns: **Response Syntax** { 'ReplicatorArn': 'string', 'ReplicatorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED' } **Response Structure** * *(dict) --* HTTP Status Code 200: OK. * **ReplicatorArn** *(string) --* The Amazon Resource Name (ARN) of the replicator. * **ReplicatorState** *(string) --* State of the replicator. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / delete_cluster delete_cluster ************** Kafka.Client.delete_cluster(**kwargs) Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request. See also: AWS API Documentation **Request Syntax** response = client.delete_cluster( ClusterArn='string', CurrentVersion='string' ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **CurrentVersion** (*string*) -- The current version of the MSK cluster. Return type: dict Returns: **Response Syntax** { 'ClusterArn': 'string', 'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING' } **Response Structure** * *(dict) --* Successful response. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) of the cluster. * **State** *(string) --* The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING. **Exceptions** * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / can_paginate can_paginate ************ Kafka.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. Kafka / Client / list_configuration_revisions list_configuration_revisions **************************** Kafka.Client.list_configuration_revisions(**kwargs) Returns a list of all the MSK configurations in this Region. See also: AWS API Documentation **Request Syntax** response = client.list_configuration_revisions( Arn='string', MaxResults=123, NextToken='string' ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions. * **MaxResults** (*integer*) -- The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Revisions': [ { 'CreationTime': datetime(2015, 1, 1), 'Description': 'string', 'Revision': 123 }, ] } **Response Structure** * *(dict) --* 200 response * **NextToken** *(string) --* Paginated results marker. * **Revisions** *(list) --* List of ConfigurationRevision objects. * *(dict) --* Describes a configuration revision. * **CreationTime** *(datetime) --* The time when the configuration revision was created. * **Description** *(string) --* The description of the configuration revision. * **Revision** *(integer) --* The revision number. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" Kafka / Client / delete_cluster_policy delete_cluster_policy ********************* Kafka.Client.delete_cluster_policy(**kwargs) Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request. See also: AWS API Documentation **Request Syntax** response = client.delete_cluster_policy( ClusterArn='string' ) Parameters: **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the cluster. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* Successful response. **Exceptions** * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / list_configurations list_configurations ******************* Kafka.Client.list_configurations(**kwargs) Returns a list of all the MSK configurations in this Region. See also: AWS API Documentation **Request Syntax** response = client.list_configurations( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'Configurations': [ { 'Arn': 'string', 'CreationTime': datetime(2015, 1, 1), 'Description': 'string', 'KafkaVersions': [ 'string', ], 'LatestRevision': { 'CreationTime': datetime(2015, 1, 1), 'Description': 'string', 'Revision': 123 }, 'Name': 'string', 'State': 'ACTIVE'|'DELETING'|'DELETE_FAILED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* 200 response * **Configurations** *(list) --* An array of MSK configurations. * *(dict) --* Represents an MSK Configuration. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the configuration. * **CreationTime** *(datetime) --* The time when the configuration was created. * **Description** *(string) --* The description of the configuration. * **KafkaVersions** *(list) --* 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. * *(string) --* * **LatestRevision** *(dict) --* Latest revision of the configuration. * **CreationTime** *(datetime) --* The time when the configuration revision was created. * **Description** *(string) --* The description of the configuration revision. * **Revision** *(integer) --* The revision number. * **Name** *(string) --* The name of the configuration. * **State** *(string) --* The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED. * **NextToken** *(string) --* The paginated results marker. When the result of a ListConfigurations operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request. **Exceptions** * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / reject_client_vpc_connection reject_client_vpc_connection **************************** Kafka.Client.reject_client_vpc_connection(**kwargs) Returns empty response. See also: AWS API Documentation **Request Syntax** response = client.reject_client_vpc_connection( ClusterArn='string', VpcConnectionArn='string' ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the cluster. * **VpcConnectionArn** (*string*) -- **[REQUIRED]** The VPC connection ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* 200 response **Exceptions** * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / update_broker_storage update_broker_storage ********************* Kafka.Client.update_broker_storage(**kwargs) Updates the EBS storage associated with MSK brokers. See also: AWS API Documentation **Request Syntax** response = client.update_broker_storage( ClusterArn='string', CurrentVersion='string', TargetBrokerEBSVolumeInfo=[ { 'KafkaBrokerNodeId': 'string', 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSizeGB': 123 }, ] ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **CurrentVersion** (*string*) -- **[REQUIRED]** The version of cluster to update from. A successful operation will then generate a new version. * **TargetBrokerEBSVolumeInfo** (*list*) -- **[REQUIRED]** Describes the target volume size and the ID of the broker to apply the update to. * *(dict) --* 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. * **KafkaBrokerNodeId** *(string) --* **[REQUIRED]** The ID of the broker to update. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSizeGB** *(integer) --* Size of the EBS volume to update. Return type: dict Returns: **Response Syntax** { 'ClusterArn': 'string', 'ClusterOperationArn': 'string' } **Response Structure** * *(dict) --* Successful response. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) of the cluster. * **ClusterOperationArn** *(string) --* The Amazon Resource Name (ARN) of the cluster operation. **Exceptions** * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / update_broker_type update_broker_type ****************** Kafka.Client.update_broker_type(**kwargs) Updates EC2 instance type. See also: AWS API Documentation **Request Syntax** response = client.update_broker_type( ClusterArn='string', CurrentVersion='string', TargetInstanceType='string' ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **CurrentVersion** (*string*) -- **[REQUIRED]** The cluster version that you want to change. After this operation completes successfully, the cluster will have a new version. * **TargetInstanceType** (*string*) -- **[REQUIRED]** The Amazon MSK broker type that you want all of the brokers in this cluster to be. Return type: dict Returns: **Response Syntax** { 'ClusterArn': 'string', 'ClusterOperationArn': 'string' } **Response Structure** * *(dict) --* Successful response. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) of the cluster. * **ClusterOperationArn** *(string) --* The Amazon Resource Name (ARN) of the cluster operation. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / update_configuration update_configuration ******************** Kafka.Client.update_configuration(**kwargs) Updates an MSK configuration. See also: AWS API Documentation **Request Syntax** response = client.update_configuration( Arn='string', Description='string', ServerProperties=b'bytes' ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the configuration. * **Description** (*string*) -- The description of the configuration revision. * **ServerProperties** (*bytes*) -- **[REQUIRED]** Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'LatestRevision': { 'CreationTime': datetime(2015, 1, 1), 'Description': 'string', 'Revision': 123 } } **Response Structure** * *(dict) --* 200 response * **Arn** *(string) --* The Amazon Resource Name (ARN) of the configuration. * **LatestRevision** *(dict) --* Latest revision of the configuration. * **CreationTime** *(datetime) --* The time when the configuration revision was created. * **Description** *(string) --* The description of the configuration revision. * **Revision** *(integer) --* The revision number. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" Kafka / Client / reboot_broker reboot_broker ************* Kafka.Client.reboot_broker(**kwargs) Reboots brokers. See also: AWS API Documentation **Request Syntax** response = client.reboot_broker( BrokerIds=[ 'string', ], ClusterArn='string' ) Parameters: * **BrokerIds** (*list*) -- **[REQUIRED]** The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time. * *(string) --* * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the cluster to be updated. Return type: dict Returns: **Response Syntax** { 'ClusterArn': 'string', 'ClusterOperationArn': 'string' } **Response Structure** * *(dict) --* Successful response. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) of the cluster. * **ClusterOperationArn** *(string) --* The Amazon Resource Name (ARN) of the cluster operation. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / list_tags_for_resource list_tags_for_resource ********************** Kafka.Client.list_tags_for_resource(**kwargs) Returns a list of the tags associated with the specified resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags. Return type: dict Returns: **Response Syntax** { 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* Success response. * **Tags** *(dict) --* The key-value pair for the resource tag. * *(string) --* * *(string) --* **Exceptions** * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" Kafka / Client / untag_resource untag_resource ************** Kafka.Client.untag_resource(**kwargs) Removes the tags associated with the keys that are provided in the query. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceArn='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags. * **TagKeys** (*list*) -- **[REQUIRED]** Tag keys must be unique for a given cluster. In addition, the following restrictions apply: * Each tag key must be unique. If you add a tag with a key that's already in use, your new tag overwrites the existing key-value pair. * You can't start a tag key with aws: because this prefix is reserved for use by AWS. AWS creates tags that begin with this prefix on your behalf, but you can't edit or delete them. * Tag keys must be between 1 and 128 Unicode characters in length. * Tag keys must consist of the following characters: Unicode letters, digits, white space, and the following special characters: _ . / = + - @. * *(string) --* Returns: None **Exceptions** * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" Kafka / Client / get_waiter get_waiter ********** Kafka.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" Kafka / Client / create_replicator create_replicator ***************** Kafka.Client.create_replicator(**kwargs) Creates the replicator. See also: AWS API Documentation **Request Syntax** response = client.create_replicator( Description='string', KafkaClusters=[ { 'AmazonMskCluster': { 'MskClusterArn': 'string' }, 'VpcConfig': { 'SecurityGroupIds': [ 'string', ], 'SubnetIds': [ 'string', ] } }, ], ReplicationInfoList=[ { 'ConsumerGroupReplication': { 'ConsumerGroupsToExclude': [ 'string', ], 'ConsumerGroupsToReplicate': [ 'string', ], 'DetectAndCopyNewConsumerGroups': True|False, 'SynchroniseConsumerGroupOffsets': True|False }, 'SourceKafkaClusterArn': 'string', 'TargetCompressionType': 'NONE'|'GZIP'|'SNAPPY'|'LZ4'|'ZSTD', 'TargetKafkaClusterArn': 'string', 'TopicReplication': { 'CopyAccessControlListsForTopics': True|False, 'CopyTopicConfigurations': True|False, 'DetectAndCopyNewTopics': True|False, 'StartingPosition': { 'Type': 'LATEST'|'EARLIEST' }, 'TopicNameConfiguration': { 'Type': 'PREFIXED_WITH_SOURCE_CLUSTER_ALIAS'|'IDENTICAL' }, 'TopicsToExclude': [ 'string', ], 'TopicsToReplicate': [ 'string', ] } }, ], ReplicatorName='string', ServiceExecutionRoleArn='string', Tags={ 'string': 'string' } ) Parameters: * **Description** (*string*) -- A summary description of the replicator. * **KafkaClusters** (*list*) -- **[REQUIRED]** Kafka Clusters to use in setting up sources / targets for replication. * *(dict) --* Information about Kafka Cluster to be used as source / target for replication. * **AmazonMskCluster** *(dict) --* **[REQUIRED]** Details of an Amazon MSK Cluster. * **MskClusterArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Amazon MSK cluster. * **VpcConfig** *(dict) --* **[REQUIRED]** Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster. * **SecurityGroupIds** *(list) --* The security groups to attach to the ENIs for the broker nodes. * *(string) --* * **SubnetIds** *(list) --* **[REQUIRED]** The list of subnets in the client VPC to connect to. * *(string) --* * **ReplicationInfoList** (*list*) -- **[REQUIRED]** A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow. * *(dict) --* Specifies configuration for replication between a source and target Kafka cluster. * **ConsumerGroupReplication** *(dict) --* **[REQUIRED]** Configuration relating to consumer group replication. * **ConsumerGroupsToExclude** *(list) --* List of regular expression patterns indicating the consumer groups that should not be replicated. * *(string) --* * **ConsumerGroupsToReplicate** *(list) --* **[REQUIRED]** List of regular expression patterns indicating the consumer groups to copy. * *(string) --* * **DetectAndCopyNewConsumerGroups** *(boolean) --* Enables synchronization of consumer groups to target cluster. * **SynchroniseConsumerGroupOffsets** *(boolean) --* Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets. * **SourceKafkaClusterArn** *(string) --* **[REQUIRED]** The ARN of the source Kafka cluster. * **TargetCompressionType** *(string) --* **[REQUIRED]** The compression type to use when producing records to target cluster. * **TargetKafkaClusterArn** *(string) --* **[REQUIRED]** The ARN of the target Kafka cluster. * **TopicReplication** *(dict) --* **[REQUIRED]** Configuration relating to topic replication. * **CopyAccessControlListsForTopics** *(boolean) --* Whether to periodically configure remote topic ACLs to match their corresponding upstream topics. * **CopyTopicConfigurations** *(boolean) --* Whether to periodically configure remote topics to match their corresponding upstream topics. * **DetectAndCopyNewTopics** *(boolean) --* Whether to periodically check for new topics and partitions. * **StartingPosition** *(dict) --* Configuration for specifying the position in the topics to start replicating from. * **Type** *(string) --* The type of replication starting position. * **TopicNameConfiguration** *(dict) --* Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias. * **Type** *(string) --* The type of replicated topic name. * **TopicsToExclude** *(list) --* List of regular expression patterns indicating the topics that should not be replicated. * *(string) --* * **TopicsToReplicate** *(list) --* **[REQUIRED]** List of regular expression patterns indicating the topics to copy. * *(string) --* * **ReplicatorName** (*string*) -- **[REQUIRED]** The name of the replicator. Alpha-numeric characters with '-' are allowed. * **ServiceExecutionRoleArn** (*string*) -- **[REQUIRED]** The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters) * **Tags** (*dict*) -- List of tags to attach to created Replicator. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'ReplicatorArn': 'string', 'ReplicatorName': 'string', 'ReplicatorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED' } **Response Structure** * *(dict) --* HTTP Status Code 200: OK. * **ReplicatorArn** *(string) --* The Amazon Resource Name (ARN) of the replicator. * **ReplicatorName** *(string) --* Name of the replicator provided by the customer. * **ReplicatorState** *(string) --* State of the replicator. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" * "Kafka.Client.exceptions.ConflictException" Kafka / Client / update_broker_count update_broker_count ******************* Kafka.Client.update_broker_count(**kwargs) Updates the number of broker nodes in the cluster. See also: AWS API Documentation **Request Syntax** response = client.update_broker_count( ClusterArn='string', CurrentVersion='string', TargetNumberOfBrokerNodes=123 ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **CurrentVersion** (*string*) -- **[REQUIRED]** The version of cluster to update from. A successful operation will then generate a new version. * **TargetNumberOfBrokerNodes** (*integer*) -- **[REQUIRED]** The number of broker nodes that you want the cluster to have after this operation completes successfully. Return type: dict Returns: **Response Syntax** { 'ClusterArn': 'string', 'ClusterOperationArn': 'string' } **Response Structure** * *(dict) --* Successful response. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) of the cluster. * **ClusterOperationArn** *(string) --* The Amazon Resource Name (ARN) of the cluster operation. **Exceptions** * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / describe_cluster_v2 describe_cluster_v2 ******************* Kafka.Client.describe_cluster_v2(**kwargs) Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request. See also: AWS API Documentation **Request Syntax** response = client.describe_cluster_v2( ClusterArn='string' ) Parameters: **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the cluster. Return type: dict Returns: **Response Syntax** { 'ClusterInfo': { 'ActiveOperationArn': 'string', 'ClusterType': 'PROVISIONED'|'SERVERLESS', 'ClusterArn': 'string', 'ClusterName': 'string', 'CreationTime': datetime(2015, 1, 1), 'CurrentVersion': 'string', 'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING', 'StateInfo': { 'Code': 'string', 'Message': 'string' }, 'Tags': { 'string': 'string' }, 'Provisioned': { 'BrokerNodeGroupInfo': { 'BrokerAZDistribution': 'DEFAULT', 'ClientSubnets': [ 'string', ], 'InstanceType': 'string', 'SecurityGroups': [ 'string', ], 'StorageInfo': { 'EbsStorageInfo': { 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSize': 123 } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'ZoneIds': [ 'string', ] }, 'CurrentBrokerSoftwareInfo': { 'ConfigurationArn': 'string', 'ConfigurationRevision': 123, 'KafkaVersion': 'string' }, 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, 'EncryptionInfo': { 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, 'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', 'OpenMonitoring': { 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, 'LoggingInfo': { 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, 'NumberOfBrokerNodes': 123, 'ZookeeperConnectString': 'string', 'ZookeeperConnectStringTls': 'string', 'StorageMode': 'LOCAL'|'TIERED', 'CustomerActionStatus': 'CRITICAL_ACTION_REQUIRED'|'ACTION_RECOMMENDED'|'NONE' }, 'Serverless': { 'VpcConfigs': [ { 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ] }, ], 'ClientAuthentication': { 'Sasl': { 'Iam': { 'Enabled': True|False } } } } } } **Response Structure** * *(dict) --* Successful response. * **ClusterInfo** *(dict) --* The cluster information. * **ActiveOperationArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies a cluster operation. * **ClusterType** *(string) --* Cluster Type. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **ClusterName** *(string) --* The name of the cluster. * **CreationTime** *(datetime) --* The time when the cluster was created. * **CurrentVersion** *(string) --* The current version of the MSK cluster. * **State** *(string) --* The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING. * **StateInfo** *(dict) --* State Info for the Amazon MSK cluster. * **Code** *(string) --* * **Message** *(string) --* * **Tags** *(dict) --* Tags attached to the cluster. * *(string) --* * *(string) --* * **Provisioned** *(dict) --* Information about the provisioned cluster. * **BrokerNodeGroupInfo** *(dict) --* Information about the brokers. * **BrokerAZDistribution** *(string) --* The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed. Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster. * **ClientSubnets** *(list) --* 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. * *(string) --* * **InstanceType** *(string) --* The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge. * **SecurityGroups** *(list) --* 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. * *(string) --* * **StorageInfo** *(dict) --* Contains information about storage volumes attached to MSK broker nodes. * **EbsStorageInfo** *(dict) --* EBS volume information. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSize** *(integer) --* The size in GiB of the EBS volume for the data drive on each broker node. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **ZoneIds** *(list) --* The list of zoneIds for the cluster in the virtual private cloud (VPC). * *(string) --* * **CurrentBrokerSoftwareInfo** *(dict) --* Information about the Apache Kafka version deployed on the brokers. * **ConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release. * **ConfigurationRevision** *(integer) --* The revision of the configuration to use. This field isn't visible in this preview release. * **KafkaVersion** *(string) --* The version of Apache Kafka. * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **EncryptionInfo** *(dict) --* Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **EnhancedMonitoring** *(string) --* Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. * **OpenMonitoring** *(dict) --* The settings for open monitoring. * **Prometheus** *(dict) --* Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the Node Exporter. * **LoggingInfo** *(dict) --* Log delivery information for the cluster. * **BrokerLogs** *(dict) --* * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* * **Prefix** *(string) --* * **NumberOfBrokerNodes** *(integer) --* The number of broker nodes in the cluster. * **ZookeeperConnectString** *(string) --* The connection string to use to connect to the Apache ZooKeeper cluster. * **ZookeeperConnectStringTls** *(string) --* The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port. * **StorageMode** *(string) --* This controls storage mode for supported storage tiers. * **CustomerActionStatus** *(string) --* Determines if there is an action required from the customer. * **Serverless** *(dict) --* Information about the serverless cluster. * **VpcConfigs** *(list) --* The configuration of the Amazon VPCs for the cluster. * *(dict) --* The configuration of the Amazon VPCs for the cluster. * **SubnetIds** *(list) --* The IDs of the subnets associated with the cluster. * *(string) --* * **SecurityGroupIds** *(list) --* The IDs of the security groups associated with the cluster. * *(string) --* * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. **Exceptions** * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / list_replicators list_replicators **************** Kafka.Client.list_replicators(**kwargs) Lists the replicators. See also: AWS API Documentation **Request Syntax** response = client.list_replicators( MaxResults=123, NextToken='string', ReplicatorNameFilter='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter. * **NextToken** (*string*) -- If the response of ListReplicators is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListReplicators. * **ReplicatorNameFilter** (*string*) -- Returns replicators starting with given name. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Replicators': [ { 'CreationTime': datetime(2015, 1, 1), 'CurrentVersion': 'string', 'IsReplicatorReference': True|False, 'KafkaClustersSummary': [ { 'AmazonMskCluster': { 'MskClusterArn': 'string' }, 'KafkaClusterAlias': 'string' }, ], 'ReplicationInfoSummaryList': [ { 'SourceKafkaClusterAlias': 'string', 'TargetKafkaClusterAlias': 'string' }, ], 'ReplicatorArn': 'string', 'ReplicatorName': 'string', 'ReplicatorResourceArn': 'string', 'ReplicatorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED' }, ] } **Response Structure** * *(dict) --* HTTP Status Code 200: OK. * **NextToken** *(string) --* If the response of ListReplicators is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListReplicators. * **Replicators** *(list) --* List containing information of each of the replicators in the account. * *(dict) --* Information about a replicator. * **CreationTime** *(datetime) --* The time the replicator was created. * **CurrentVersion** *(string) --* The current version of the replicator. * **IsReplicatorReference** *(boolean) --* Whether this resource is a replicator reference. * **KafkaClustersSummary** *(list) --* Kafka Clusters used in setting up sources / targets for replication. * *(dict) --* Summarized information about Kafka Cluster used as source / target for replication. * **AmazonMskCluster** *(dict) --* Details of an Amazon MSK Cluster. * **MskClusterArn** *(string) --* The Amazon Resource Name (ARN) of an Amazon MSK cluster. * **KafkaClusterAlias** *(string) --* The alias of the Kafka cluster. Used to prefix names of replicated topics. * **ReplicationInfoSummaryList** *(list) --* A list of summarized information of replications between clusters. * *(dict) --* Summarized information of replication between clusters. * **SourceKafkaClusterAlias** *(string) --* The alias of the source Kafka cluster. * **TargetKafkaClusterAlias** *(string) --* The alias of the target Kafka cluster. * **ReplicatorArn** *(string) --* The Amazon Resource Name (ARN) of the replicator. * **ReplicatorName** *(string) --* The name of the replicator. * **ReplicatorResourceArn** *(string) --* The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created. * **ReplicatorState** *(string) --* State of the replicator. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / list_client_vpc_connections list_client_vpc_connections *************************** Kafka.Client.list_client_vpc_connections(**kwargs) Returns a list of all the VPC connections in this Region. See also: AWS API Documentation **Request Syntax** response = client.list_client_vpc_connections( ClusterArn='string', MaxResults=123, NextToken='string' ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the cluster. * **MaxResults** (*integer*) -- The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'ClientVpcConnections': [ { 'Authentication': 'string', 'CreationTime': datetime(2015, 1, 1), 'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING', 'VpcConnectionArn': 'string', 'Owner': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* 200 response * **ClientVpcConnections** *(list) --* List of client VPC connections. * *(dict) --* The client VPC connection object. * **Authentication** *(string) --* Information about the auth scheme of Vpc Connection. * **CreationTime** *(datetime) --* Creation time of the Vpc Connection. * **State** *(string) --* State of the Vpc Connection. * **VpcConnectionArn** *(string) --* The ARN that identifies the Vpc Connection. * **Owner** *(string) --* The Owner of the Vpc Connection. * **NextToken** *(string) --* The paginated results marker. When the result of a ListClientVpcConnections operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request. **Exceptions** * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / get_compatible_kafka_versions get_compatible_kafka_versions ***************************** Kafka.Client.get_compatible_kafka_versions(**kwargs) Gets the Apache Kafka versions to which you can update the MSK cluster. See also: AWS API Documentation **Request Syntax** response = client.get_compatible_kafka_versions( ClusterArn='string' ) Parameters: **ClusterArn** (*string*) -- The Amazon Resource Name (ARN) of the cluster check. Return type: dict Returns: **Response Syntax** { 'CompatibleKafkaVersions': [ { 'SourceVersion': 'string', 'TargetVersions': [ 'string', ] }, ] } **Response Structure** * *(dict) --* Successful response. * **CompatibleKafkaVersions** *(list) --* A list of CompatibleKafkaVersion objects. * *(dict) --* Contains source Apache Kafka versions and compatible target Apache Kafka versions. * **SourceVersion** *(string) --* An Apache Kafka version. * **TargetVersions** *(list) --* A list of Apache Kafka versions. * *(string) --* **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / describe_vpc_connection describe_vpc_connection *********************** Kafka.Client.describe_vpc_connection(**kwargs) Returns a description of this MSK VPC connection. See also: AWS API Documentation **Request Syntax** response = client.describe_vpc_connection( Arn='string' ) Parameters: **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection. Return type: dict Returns: **Response Syntax** { 'VpcConnectionArn': 'string', 'TargetClusterArn': 'string', 'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING', 'Authentication': 'string', 'VpcId': 'string', 'Subnets': [ 'string', ], 'SecurityGroups': [ 'string', ], 'CreationTime': datetime(2015, 1, 1), 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* 200 response * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection. * **TargetClusterArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies an MSK cluster. * **State** *(string) --* The state of VPC connection. * **Authentication** *(string) --* The authentication type of VPC connection. * **VpcId** *(string) --* The VPC Id for the VPC connection. * **Subnets** *(list) --* The list of subnets for the VPC connection. * *(string) --* * **SecurityGroups** *(list) --* The list of security groups for the VPC connection. * *(string) --* * **CreationTime** *(datetime) --* The creation time of the VPC connection. * **Tags** *(dict) --* A map of tags for the VPC connection. * *(string) --* * *(string) --* **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" Kafka / Client / delete_replicator delete_replicator ***************** Kafka.Client.delete_replicator(**kwargs) Deletes a replicator. See also: AWS API Documentation **Request Syntax** response = client.delete_replicator( CurrentVersion='string', ReplicatorArn='string' ) Parameters: * **CurrentVersion** (*string*) -- The current version of the replicator. * **ReplicatorArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the replicator to be deleted. Return type: dict Returns: **Response Syntax** { 'ReplicatorArn': 'string', 'ReplicatorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED' } **Response Structure** * *(dict) --* HTTP Status Code 200: OK. * **ReplicatorArn** *(string) --* The Amazon Resource Name (ARN) of the replicator. * **ReplicatorState** *(string) --* The state of the replicator. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / update_monitoring update_monitoring ***************** Kafka.Client.update_monitoring(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.update_monitoring( ClusterArn='string', CurrentVersion='string', EnhancedMonitoring='DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', OpenMonitoring={ 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, LoggingInfo={ 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } } ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **CurrentVersion** (*string*) -- **[REQUIRED]** The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version. * **EnhancedMonitoring** (*string*) -- Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster. * **OpenMonitoring** (*dict*) -- The settings for open monitoring. * **Prometheus** *(dict) --* **[REQUIRED]** Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* **[REQUIRED]** Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* **[REQUIRED]** Indicates whether you want to turn on or turn off the Node Exporter. * **LoggingInfo** (*dict*) -- * **BrokerLogs** *(dict) --* **[REQUIRED]** * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* **[REQUIRED]** * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* **[REQUIRED]** * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* **[REQUIRED]** * **Prefix** *(string) --* Return type: dict Returns: **Response Syntax** { 'ClusterArn': 'string', 'ClusterOperationArn': 'string' } **Response Structure** * *(dict) --* HTTP Status Code 200: OK. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) of the cluster. * **ClusterOperationArn** *(string) --* The Amazon Resource Name (ARN) of the cluster operation. **Exceptions** * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / batch_associate_scram_secret batch_associate_scram_secret **************************** Kafka.Client.batch_associate_scram_secret(**kwargs) Associates one or more Scram Secrets with an Amazon MSK cluster. See also: AWS API Documentation **Request Syntax** response = client.batch_associate_scram_secret( ClusterArn='string', SecretArnList=[ 'string', ] ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the cluster to be updated. * **SecretArnList** (*list*) -- **[REQUIRED]** List of AWS Secrets Manager secret ARNs. * *(string) --* Return type: dict Returns: **Response Syntax** { 'ClusterArn': 'string', 'UnprocessedScramSecrets': [ { 'ErrorCode': 'string', 'ErrorMessage': 'string', 'SecretArn': 'string' }, ] } **Response Structure** * *(dict) --* 200 response * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) of the cluster. * **UnprocessedScramSecrets** *(list) --* List of errors when associating secrets to cluster. * *(dict) --* Error info for scram secret associate/disassociate failure. * **ErrorCode** *(string) --* Error code for associate/disassociate failure. * **ErrorMessage** *(string) --* Error message for associate/disassociate failure. * **SecretArn** *(string) --* AWS Secrets Manager secret ARN. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / list_cluster_operations list_cluster_operations *********************** Kafka.Client.list_cluster_operations(**kwargs) Returns a list of all the operations that have been performed on the specified MSK cluster. See also: AWS API Documentation **Request Syntax** response = client.list_cluster_operations( ClusterArn='string', MaxResults=123, NextToken='string' ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **MaxResults** (*integer*) -- The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'ClusterOperationInfoList': [ { 'ClientRequestId': 'string', 'ClusterArn': 'string', 'CreationTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'ErrorInfo': { 'ErrorCode': 'string', 'ErrorString': 'string' }, 'OperationArn': 'string', 'OperationState': 'string', 'OperationSteps': [ { 'StepInfo': { 'StepStatus': 'string' }, 'StepName': 'string' }, ], 'OperationType': 'string', 'SourceClusterInfo': { 'BrokerEBSVolumeInfo': [ { 'KafkaBrokerNodeId': 'string', 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSizeGB': 123 }, ], 'ConfigurationInfo': { 'Arn': 'string', 'Revision': 123 }, 'NumberOfBrokerNodes': 123, 'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', 'OpenMonitoring': { 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, 'KafkaVersion': 'string', 'LoggingInfo': { 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, 'InstanceType': 'string', 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, 'EncryptionInfo': { 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'StorageMode': 'LOCAL'|'TIERED', 'BrokerCountUpdateInfo': { 'CreatedBrokerIds': [ 123.0, ], 'DeletedBrokerIds': [ 123.0, ] } }, 'TargetClusterInfo': { 'BrokerEBSVolumeInfo': [ { 'KafkaBrokerNodeId': 'string', 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSizeGB': 123 }, ], 'ConfigurationInfo': { 'Arn': 'string', 'Revision': 123 }, 'NumberOfBrokerNodes': 123, 'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', 'OpenMonitoring': { 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, 'KafkaVersion': 'string', 'LoggingInfo': { 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, 'InstanceType': 'string', 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, 'EncryptionInfo': { 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'StorageMode': 'LOCAL'|'TIERED', 'BrokerCountUpdateInfo': { 'CreatedBrokerIds': [ 123.0, ], 'DeletedBrokerIds': [ 123.0, ] } }, 'VpcConnectionInfo': { 'VpcConnectionArn': 'string', 'Owner': 'string', 'UserIdentity': { 'Type': 'AWSACCOUNT'|'AWSSERVICE', 'PrincipalId': 'string' }, 'CreationTime': datetime(2015, 1, 1) } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Successful response. * **ClusterOperationInfoList** *(list) --* An array of cluster operation information objects. * *(dict) --* Returns information about a cluster operation. * **ClientRequestId** *(string) --* The ID of the API request that triggered this operation. * **ClusterArn** *(string) --* ARN of the cluster. * **CreationTime** *(datetime) --* The time that the operation was created. * **EndTime** *(datetime) --* The time at which the operation finished. * **ErrorInfo** *(dict) --* Describes the error if the operation fails. * **ErrorCode** *(string) --* A number describing the error programmatically. * **ErrorString** *(string) --* An optional field to provide more details about the error. * **OperationArn** *(string) --* ARN of the cluster operation. * **OperationState** *(string) --* State of the cluster operation. * **OperationSteps** *(list) --* Steps completed during the operation. * *(dict) --* Step taken during a cluster operation. * **StepInfo** *(dict) --* Information about the step and its status. * **StepStatus** *(string) --* The steps current status. * **StepName** *(string) --* The name of the step. * **OperationType** *(string) --* Type of the cluster operation. * **SourceClusterInfo** *(dict) --* Information about cluster attributes before a cluster is updated. * **BrokerEBSVolumeInfo** *(list) --* Specifies the size of the EBS volume and the ID of the associated broker. * *(dict) --* 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. * **KafkaBrokerNodeId** *(string) --* The ID of the broker to update. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSizeGB** *(integer) --* Size of the EBS volume to update. * **ConfigurationInfo** *(dict) --* Information about the changes in the configuration of the brokers. * **Arn** *(string) --* ARN of the configuration to use. * **Revision** *(integer) --* The revision of the configuration to use. * **NumberOfBrokerNodes** *(integer) --* The number of broker nodes in the cluster. * **EnhancedMonitoring** *(string) --* Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster. * **OpenMonitoring** *(dict) --* The settings for open monitoring. * **Prometheus** *(dict) --* Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the Node Exporter. * **KafkaVersion** *(string) --* The Apache Kafka version. * **LoggingInfo** *(dict) --* 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. * **BrokerLogs** *(dict) --* * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* * **Prefix** *(string) --* * **InstanceType** *(string) --* Information about the Amazon MSK broker type. * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **EncryptionInfo** *(dict) --* Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **StorageMode** *(string) --* This controls storage mode for supported storage tiers. * **BrokerCountUpdateInfo** *(dict) --* Describes brokers being changed during a broker count update. * **CreatedBrokerIds** *(list) --* Kafka Broker IDs of brokers being created. * *(float) --* * **DeletedBrokerIds** *(list) --* Kafka Broker IDs of brokers being deleted. * *(float) --* * **TargetClusterInfo** *(dict) --* Information about cluster attributes after a cluster is updated. * **BrokerEBSVolumeInfo** *(list) --* Specifies the size of the EBS volume and the ID of the associated broker. * *(dict) --* 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. * **KafkaBrokerNodeId** *(string) --* The ID of the broker to update. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSizeGB** *(integer) --* Size of the EBS volume to update. * **ConfigurationInfo** *(dict) --* Information about the changes in the configuration of the brokers. * **Arn** *(string) --* ARN of the configuration to use. * **Revision** *(integer) --* The revision of the configuration to use. * **NumberOfBrokerNodes** *(integer) --* The number of broker nodes in the cluster. * **EnhancedMonitoring** *(string) --* Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster. * **OpenMonitoring** *(dict) --* The settings for open monitoring. * **Prometheus** *(dict) --* Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the Node Exporter. * **KafkaVersion** *(string) --* The Apache Kafka version. * **LoggingInfo** *(dict) --* 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. * **BrokerLogs** *(dict) --* * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* * **Prefix** *(string) --* * **InstanceType** *(string) --* Information about the Amazon MSK broker type. * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **EncryptionInfo** *(dict) --* Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **StorageMode** *(string) --* This controls storage mode for supported storage tiers. * **BrokerCountUpdateInfo** *(dict) --* Describes brokers being changed during a broker count update. * **CreatedBrokerIds** *(list) --* Kafka Broker IDs of brokers being created. * *(float) --* * **DeletedBrokerIds** *(list) --* Kafka Broker IDs of brokers being deleted. * *(float) --* * **VpcConnectionInfo** *(dict) --* Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) of the VPC connection. * **Owner** *(string) --* The owner of the VPC Connection. * **UserIdentity** *(dict) --* Description of the requester that calls the API operation. * **Type** *(string) --* The identity type of the requester that calls the API operation. * **PrincipalId** *(string) --* A unique identifier for the requester that calls the API operation. * **CreationTime** *(datetime) --* The time when Amazon MSK creates the VPC Connnection. * **NextToken** *(string) --* 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. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / update_connectivity update_connectivity ******************* Kafka.Client.update_connectivity(**kwargs) Updates the cluster's connectivity configuration. See also: AWS API Documentation **Request Syntax** response = client.update_connectivity( ClusterArn='string', ConnectivityInfo={ 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, CurrentVersion='string' ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the configuration. * **ConnectivityInfo** (*dict*) -- **[REQUIRED]** Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **CurrentVersion** (*string*) -- **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** { 'ClusterArn': 'string', 'ClusterOperationArn': 'string' } **Response Structure** * *(dict) --* Successful response. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) of the cluster. * **ClusterOperationArn** *(string) --* The Amazon Resource Name (ARN) of the cluster operation. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" Kafka / Client / create_configuration create_configuration ******************** Kafka.Client.create_configuration(**kwargs) Creates a new MSK configuration. See also: AWS API Documentation **Request Syntax** response = client.create_configuration( Description='string', KafkaVersions=[ 'string', ], Name='string', ServerProperties=b'bytes' ) Parameters: * **Description** (*string*) -- The description of the configuration. * **KafkaVersions** (*list*) -- The versions of Apache Kafka with which you can use this MSK configuration. * *(string) --* * **Name** (*string*) -- **[REQUIRED]** The name of the configuration. * **ServerProperties** (*bytes*) -- **[REQUIRED]** Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'CreationTime': datetime(2015, 1, 1), 'LatestRevision': { 'CreationTime': datetime(2015, 1, 1), 'Description': 'string', 'Revision': 123 }, 'Name': 'string', 'State': 'ACTIVE'|'DELETING'|'DELETE_FAILED' } **Response Structure** * *(dict) --* 200 response * **Arn** *(string) --* The Amazon Resource Name (ARN) of the configuration. * **CreationTime** *(datetime) --* The time when the configuration was created. * **LatestRevision** *(dict) --* Latest revision of the configuration. * **CreationTime** *(datetime) --* The time when the configuration revision was created. * **Description** *(string) --* The description of the configuration revision. * **Revision** *(integer) --* The revision number. * **Name** *(string) --* The name of the configuration. * **State** *(string) --* The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" * "Kafka.Client.exceptions.ConflictException" Kafka / Client / close close ***** Kafka.Client.close() Closes underlying endpoint connections. Kafka / Client / update_security update_security *************** Kafka.Client.update_security(**kwargs) Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters. See also: AWS API Documentation **Request Syntax** response = client.update_security( ClientAuthentication={ 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, ClusterArn='string', CurrentVersion='string', EncryptionInfo={ 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } } ) Parameters: * **ClientAuthentication** (*dict*) -- Includes all client authentication related information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **CurrentVersion** (*string*) -- **[REQUIRED]** The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version. * **EncryptionInfo** (*dict*) -- Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* **[REQUIRED]** 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. Return type: dict Returns: **Response Syntax** { 'ClusterArn': 'string', 'ClusterOperationArn': 'string' } **Response Structure** * *(dict) --* * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) of the cluster. * **ClusterOperationArn** *(string) --* The Amazon Resource Name (ARN) of the cluster operation. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / list_kafka_versions list_kafka_versions ******************* Kafka.Client.list_kafka_versions(**kwargs) Returns a list of Apache Kafka versions. See also: AWS API Documentation **Request Syntax** response = client.list_kafka_versions( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'KafkaVersions': [ { 'Version': 'string', 'Status': 'ACTIVE'|'DEPRECATED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **KafkaVersions** *(list) --* * *(dict) --* * **Version** *(string) --* * **Status** *(string) --* * **NextToken** *(string) --* **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / list_clusters_v2 list_clusters_v2 **************** Kafka.Client.list_clusters_v2(**kwargs) Returns a list of all the MSK clusters in the current Region. See also: AWS API Documentation **Request Syntax** response = client.list_clusters_v2( ClusterNameFilter='string', ClusterTypeFilter='string', MaxResults=123, NextToken='string' ) Parameters: * **ClusterNameFilter** (*string*) -- 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. * **ClusterTypeFilter** (*string*) -- Specify either PROVISIONED or SERVERLESS. * **MaxResults** (*integer*) -- The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'ClusterInfoList': [ { 'ActiveOperationArn': 'string', 'ClusterType': 'PROVISIONED'|'SERVERLESS', 'ClusterArn': 'string', 'ClusterName': 'string', 'CreationTime': datetime(2015, 1, 1), 'CurrentVersion': 'string', 'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING', 'StateInfo': { 'Code': 'string', 'Message': 'string' }, 'Tags': { 'string': 'string' }, 'Provisioned': { 'BrokerNodeGroupInfo': { 'BrokerAZDistribution': 'DEFAULT', 'ClientSubnets': [ 'string', ], 'InstanceType': 'string', 'SecurityGroups': [ 'string', ], 'StorageInfo': { 'EbsStorageInfo': { 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSize': 123 } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'ZoneIds': [ 'string', ] }, 'CurrentBrokerSoftwareInfo': { 'ConfigurationArn': 'string', 'ConfigurationRevision': 123, 'KafkaVersion': 'string' }, 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, 'EncryptionInfo': { 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, 'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', 'OpenMonitoring': { 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, 'LoggingInfo': { 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, 'NumberOfBrokerNodes': 123, 'ZookeeperConnectString': 'string', 'ZookeeperConnectStringTls': 'string', 'StorageMode': 'LOCAL'|'TIERED', 'CustomerActionStatus': 'CRITICAL_ACTION_REQUIRED'|'ACTION_RECOMMENDED'|'NONE' }, 'Serverless': { 'VpcConfigs': [ { 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ] }, ], 'ClientAuthentication': { 'Sasl': { 'Iam': { 'Enabled': True|False } } } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Successful response. * **ClusterInfoList** *(list) --* Information on each of the MSK clusters in the response. * *(dict) --* Returns information about a cluster. * **ActiveOperationArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies a cluster operation. * **ClusterType** *(string) --* Cluster Type. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **ClusterName** *(string) --* The name of the cluster. * **CreationTime** *(datetime) --* The time when the cluster was created. * **CurrentVersion** *(string) --* The current version of the MSK cluster. * **State** *(string) --* The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING. * **StateInfo** *(dict) --* State Info for the Amazon MSK cluster. * **Code** *(string) --* * **Message** *(string) --* * **Tags** *(dict) --* Tags attached to the cluster. * *(string) --* * *(string) --* * **Provisioned** *(dict) --* Information about the provisioned cluster. * **BrokerNodeGroupInfo** *(dict) --* Information about the brokers. * **BrokerAZDistribution** *(string) --* The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed. Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster. * **ClientSubnets** *(list) --* 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. * *(string) --* * **InstanceType** *(string) --* The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge. * **SecurityGroups** *(list) --* 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. * *(string) --* * **StorageInfo** *(dict) --* Contains information about storage volumes attached to MSK broker nodes. * **EbsStorageInfo** *(dict) --* EBS volume information. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSize** *(integer) --* The size in GiB of the EBS volume for the data drive on each broker node. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **ZoneIds** *(list) --* The list of zoneIds for the cluster in the virtual private cloud (VPC). * *(string) --* * **CurrentBrokerSoftwareInfo** *(dict) --* Information about the Apache Kafka version deployed on the brokers. * **ConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release. * **ConfigurationRevision** *(integer) --* The revision of the configuration to use. This field isn't visible in this preview release. * **KafkaVersion** *(string) --* The version of Apache Kafka. * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **EncryptionInfo** *(dict) --* Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **EnhancedMonitoring** *(string) --* Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. * **OpenMonitoring** *(dict) --* The settings for open monitoring. * **Prometheus** *(dict) --* Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the Node Exporter. * **LoggingInfo** *(dict) --* Log delivery information for the cluster. * **BrokerLogs** *(dict) --* * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* * **Prefix** *(string) --* * **NumberOfBrokerNodes** *(integer) --* The number of broker nodes in the cluster. * **ZookeeperConnectString** *(string) --* The connection string to use to connect to the Apache ZooKeeper cluster. * **ZookeeperConnectStringTls** *(string) --* The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port. * **StorageMode** *(string) --* This controls storage mode for supported storage tiers. * **CustomerActionStatus** *(string) --* Determines if there is an action required from the customer. * **Serverless** *(dict) --* Information about the serverless cluster. * **VpcConfigs** *(list) --* The configuration of the Amazon VPCs for the cluster. * *(dict) --* The configuration of the Amazon VPCs for the cluster. * **SubnetIds** *(list) --* The IDs of the subnets associated with the cluster. * *(string) --* * **SecurityGroupIds** *(list) --* The IDs of the security groups associated with the cluster. * *(string) --* * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **NextToken** *(string) --* The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / describe_cluster_operation_v2 describe_cluster_operation_v2 ***************************** Kafka.Client.describe_cluster_operation_v2(**kwargs) Returns a description of the cluster operation specified by the ARN. See also: AWS API Documentation **Request Syntax** response = client.describe_cluster_operation_v2( ClusterOperationArn='string' ) Parameters: **ClusterOperationArn** (*string*) -- **[REQUIRED]** ARN of the cluster operation to describe. Return type: dict Returns: **Response Syntax** { 'ClusterOperationInfo': { 'ClusterArn': 'string', 'ClusterType': 'PROVISIONED'|'SERVERLESS', 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'ErrorInfo': { 'ErrorCode': 'string', 'ErrorString': 'string' }, 'OperationArn': 'string', 'OperationState': 'string', 'OperationType': 'string', 'Provisioned': { 'OperationSteps': [ { 'StepInfo': { 'StepStatus': 'string' }, 'StepName': 'string' }, ], 'SourceClusterInfo': { 'BrokerEBSVolumeInfo': [ { 'KafkaBrokerNodeId': 'string', 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSizeGB': 123 }, ], 'ConfigurationInfo': { 'Arn': 'string', 'Revision': 123 }, 'NumberOfBrokerNodes': 123, 'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', 'OpenMonitoring': { 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, 'KafkaVersion': 'string', 'LoggingInfo': { 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, 'InstanceType': 'string', 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, 'EncryptionInfo': { 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'StorageMode': 'LOCAL'|'TIERED', 'BrokerCountUpdateInfo': { 'CreatedBrokerIds': [ 123.0, ], 'DeletedBrokerIds': [ 123.0, ] } }, 'TargetClusterInfo': { 'BrokerEBSVolumeInfo': [ { 'KafkaBrokerNodeId': 'string', 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSizeGB': 123 }, ], 'ConfigurationInfo': { 'Arn': 'string', 'Revision': 123 }, 'NumberOfBrokerNodes': 123, 'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', 'OpenMonitoring': { 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, 'KafkaVersion': 'string', 'LoggingInfo': { 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, 'InstanceType': 'string', 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, 'EncryptionInfo': { 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'StorageMode': 'LOCAL'|'TIERED', 'BrokerCountUpdateInfo': { 'CreatedBrokerIds': [ 123.0, ], 'DeletedBrokerIds': [ 123.0, ] } }, 'VpcConnectionInfo': { 'VpcConnectionArn': 'string', 'Owner': 'string', 'UserIdentity': { 'Type': 'AWSACCOUNT'|'AWSSERVICE', 'PrincipalId': 'string' }, 'CreationTime': datetime(2015, 1, 1) } }, 'Serverless': { 'VpcConnectionInfo': { 'CreationTime': datetime(2015, 1, 1), 'Owner': 'string', 'UserIdentity': { 'Type': 'AWSACCOUNT'|'AWSSERVICE', 'PrincipalId': 'string' }, 'VpcConnectionArn': 'string' } } } } **Response Structure** * *(dict) --* HTTP Status Code 200: OK. * **ClusterOperationInfo** *(dict) --* Cluster operation information * **ClusterArn** *(string) --* ARN of the cluster. * **ClusterType** *(string) --* Type of the backend cluster. * **StartTime** *(datetime) --* The time at which operation was started. * **EndTime** *(datetime) --* The time at which the operation finished. * **ErrorInfo** *(dict) --* If cluster operation failed from an error, it describes the error. * **ErrorCode** *(string) --* A number describing the error programmatically. * **ErrorString** *(string) --* An optional field to provide more details about the error. * **OperationArn** *(string) --* ARN of the cluster operation. * **OperationState** *(string) --* State of the cluster operation. * **OperationType** *(string) --* Type of the cluster operation. * **Provisioned** *(dict) --* Properties of a provisioned cluster. * **OperationSteps** *(list) --* Steps completed during the operation. * *(dict) --* Step taken during a cluster operation. * **StepInfo** *(dict) --* Information about the step and its status. * **StepStatus** *(string) --* The steps current status. * **StepName** *(string) --* The name of the step. * **SourceClusterInfo** *(dict) --* Information about cluster attributes before a cluster is updated. * **BrokerEBSVolumeInfo** *(list) --* Specifies the size of the EBS volume and the ID of the associated broker. * *(dict) --* 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. * **KafkaBrokerNodeId** *(string) --* The ID of the broker to update. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSizeGB** *(integer) --* Size of the EBS volume to update. * **ConfigurationInfo** *(dict) --* Information about the changes in the configuration of the brokers. * **Arn** *(string) --* ARN of the configuration to use. * **Revision** *(integer) --* The revision of the configuration to use. * **NumberOfBrokerNodes** *(integer) --* The number of broker nodes in the cluster. * **EnhancedMonitoring** *(string) --* Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster. * **OpenMonitoring** *(dict) --* The settings for open monitoring. * **Prometheus** *(dict) --* Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the Node Exporter. * **KafkaVersion** *(string) --* The Apache Kafka version. * **LoggingInfo** *(dict) --* 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. * **BrokerLogs** *(dict) --* * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* * **Prefix** *(string) --* * **InstanceType** *(string) --* Information about the Amazon MSK broker type. * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **EncryptionInfo** *(dict) --* Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **StorageMode** *(string) --* This controls storage mode for supported storage tiers. * **BrokerCountUpdateInfo** *(dict) --* Describes brokers being changed during a broker count update. * **CreatedBrokerIds** *(list) --* Kafka Broker IDs of brokers being created. * *(float) --* * **DeletedBrokerIds** *(list) --* Kafka Broker IDs of brokers being deleted. * *(float) --* * **TargetClusterInfo** *(dict) --* Information about cluster attributes after a cluster is updated. * **BrokerEBSVolumeInfo** *(list) --* Specifies the size of the EBS volume and the ID of the associated broker. * *(dict) --* 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. * **KafkaBrokerNodeId** *(string) --* The ID of the broker to update. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSizeGB** *(integer) --* Size of the EBS volume to update. * **ConfigurationInfo** *(dict) --* Information about the changes in the configuration of the brokers. * **Arn** *(string) --* ARN of the configuration to use. * **Revision** *(integer) --* The revision of the configuration to use. * **NumberOfBrokerNodes** *(integer) --* The number of broker nodes in the cluster. * **EnhancedMonitoring** *(string) --* Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster. * **OpenMonitoring** *(dict) --* The settings for open monitoring. * **Prometheus** *(dict) --* Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the Node Exporter. * **KafkaVersion** *(string) --* The Apache Kafka version. * **LoggingInfo** *(dict) --* 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. * **BrokerLogs** *(dict) --* * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* * **Prefix** *(string) --* * **InstanceType** *(string) --* Information about the Amazon MSK broker type. * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **EncryptionInfo** *(dict) --* Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **StorageMode** *(string) --* This controls storage mode for supported storage tiers. * **BrokerCountUpdateInfo** *(dict) --* Describes brokers being changed during a broker count update. * **CreatedBrokerIds** *(list) --* Kafka Broker IDs of brokers being created. * *(float) --* * **DeletedBrokerIds** *(list) --* Kafka Broker IDs of brokers being deleted. * *(float) --* * **VpcConnectionInfo** *(dict) --* Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) of the VPC connection. * **Owner** *(string) --* The owner of the VPC Connection. * **UserIdentity** *(dict) --* Description of the requester that calls the API operation. * **Type** *(string) --* The identity type of the requester that calls the API operation. * **PrincipalId** *(string) --* A unique identifier for the requester that calls the API operation. * **CreationTime** *(datetime) --* The time when Amazon MSK creates the VPC Connnection. * **Serverless** *(dict) --* Properties of a serverless cluster. * **VpcConnectionInfo** *(dict) --* Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations. * **CreationTime** *(datetime) --* The time when Amazon MSK creates the VPC Connnection. * **Owner** *(string) --* The owner of the VPC Connection. * **UserIdentity** *(dict) --* Description of the requester that calls the API operation. * **Type** *(string) --* The identity type of the requester that calls the API operation. * **PrincipalId** *(string) --* A unique identifier for the requester that calls the API operation. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) of the VPC connection. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / describe_cluster_operation describe_cluster_operation ************************** Kafka.Client.describe_cluster_operation(**kwargs) Returns a description of the cluster operation specified by the ARN. See also: AWS API Documentation **Request Syntax** response = client.describe_cluster_operation( ClusterOperationArn='string' ) Parameters: **ClusterOperationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation. Return type: dict Returns: **Response Syntax** { 'ClusterOperationInfo': { 'ClientRequestId': 'string', 'ClusterArn': 'string', 'CreationTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'ErrorInfo': { 'ErrorCode': 'string', 'ErrorString': 'string' }, 'OperationArn': 'string', 'OperationState': 'string', 'OperationSteps': [ { 'StepInfo': { 'StepStatus': 'string' }, 'StepName': 'string' }, ], 'OperationType': 'string', 'SourceClusterInfo': { 'BrokerEBSVolumeInfo': [ { 'KafkaBrokerNodeId': 'string', 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSizeGB': 123 }, ], 'ConfigurationInfo': { 'Arn': 'string', 'Revision': 123 }, 'NumberOfBrokerNodes': 123, 'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', 'OpenMonitoring': { 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, 'KafkaVersion': 'string', 'LoggingInfo': { 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, 'InstanceType': 'string', 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, 'EncryptionInfo': { 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'StorageMode': 'LOCAL'|'TIERED', 'BrokerCountUpdateInfo': { 'CreatedBrokerIds': [ 123.0, ], 'DeletedBrokerIds': [ 123.0, ] } }, 'TargetClusterInfo': { 'BrokerEBSVolumeInfo': [ { 'KafkaBrokerNodeId': 'string', 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSizeGB': 123 }, ], 'ConfigurationInfo': { 'Arn': 'string', 'Revision': 123 }, 'NumberOfBrokerNodes': 123, 'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', 'OpenMonitoring': { 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, 'KafkaVersion': 'string', 'LoggingInfo': { 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, 'InstanceType': 'string', 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, 'EncryptionInfo': { 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'StorageMode': 'LOCAL'|'TIERED', 'BrokerCountUpdateInfo': { 'CreatedBrokerIds': [ 123.0, ], 'DeletedBrokerIds': [ 123.0, ] } }, 'VpcConnectionInfo': { 'VpcConnectionArn': 'string', 'Owner': 'string', 'UserIdentity': { 'Type': 'AWSACCOUNT'|'AWSSERVICE', 'PrincipalId': 'string' }, 'CreationTime': datetime(2015, 1, 1) } } } **Response Structure** * *(dict) --* 200 response * **ClusterOperationInfo** *(dict) --* Cluster operation information * **ClientRequestId** *(string) --* The ID of the API request that triggered this operation. * **ClusterArn** *(string) --* ARN of the cluster. * **CreationTime** *(datetime) --* The time that the operation was created. * **EndTime** *(datetime) --* The time at which the operation finished. * **ErrorInfo** *(dict) --* Describes the error if the operation fails. * **ErrorCode** *(string) --* A number describing the error programmatically. * **ErrorString** *(string) --* An optional field to provide more details about the error. * **OperationArn** *(string) --* ARN of the cluster operation. * **OperationState** *(string) --* State of the cluster operation. * **OperationSteps** *(list) --* Steps completed during the operation. * *(dict) --* Step taken during a cluster operation. * **StepInfo** *(dict) --* Information about the step and its status. * **StepStatus** *(string) --* The steps current status. * **StepName** *(string) --* The name of the step. * **OperationType** *(string) --* Type of the cluster operation. * **SourceClusterInfo** *(dict) --* Information about cluster attributes before a cluster is updated. * **BrokerEBSVolumeInfo** *(list) --* Specifies the size of the EBS volume and the ID of the associated broker. * *(dict) --* 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. * **KafkaBrokerNodeId** *(string) --* The ID of the broker to update. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSizeGB** *(integer) --* Size of the EBS volume to update. * **ConfigurationInfo** *(dict) --* Information about the changes in the configuration of the brokers. * **Arn** *(string) --* ARN of the configuration to use. * **Revision** *(integer) --* The revision of the configuration to use. * **NumberOfBrokerNodes** *(integer) --* The number of broker nodes in the cluster. * **EnhancedMonitoring** *(string) --* Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster. * **OpenMonitoring** *(dict) --* The settings for open monitoring. * **Prometheus** *(dict) --* Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the Node Exporter. * **KafkaVersion** *(string) --* The Apache Kafka version. * **LoggingInfo** *(dict) --* 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. * **BrokerLogs** *(dict) --* * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* * **Prefix** *(string) --* * **InstanceType** *(string) --* Information about the Amazon MSK broker type. * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **EncryptionInfo** *(dict) --* Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **StorageMode** *(string) --* This controls storage mode for supported storage tiers. * **BrokerCountUpdateInfo** *(dict) --* Describes brokers being changed during a broker count update. * **CreatedBrokerIds** *(list) --* Kafka Broker IDs of brokers being created. * *(float) --* * **DeletedBrokerIds** *(list) --* Kafka Broker IDs of brokers being deleted. * *(float) --* * **TargetClusterInfo** *(dict) --* Information about cluster attributes after a cluster is updated. * **BrokerEBSVolumeInfo** *(list) --* Specifies the size of the EBS volume and the ID of the associated broker. * *(dict) --* 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. * **KafkaBrokerNodeId** *(string) --* The ID of the broker to update. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSizeGB** *(integer) --* Size of the EBS volume to update. * **ConfigurationInfo** *(dict) --* Information about the changes in the configuration of the brokers. * **Arn** *(string) --* ARN of the configuration to use. * **Revision** *(integer) --* The revision of the configuration to use. * **NumberOfBrokerNodes** *(integer) --* The number of broker nodes in the cluster. * **EnhancedMonitoring** *(string) --* Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster. * **OpenMonitoring** *(dict) --* The settings for open monitoring. * **Prometheus** *(dict) --* Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the Node Exporter. * **KafkaVersion** *(string) --* The Apache Kafka version. * **LoggingInfo** *(dict) --* 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. * **BrokerLogs** *(dict) --* * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* * **Prefix** *(string) --* * **InstanceType** *(string) --* Information about the Amazon MSK broker type. * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **EncryptionInfo** *(dict) --* Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **StorageMode** *(string) --* This controls storage mode for supported storage tiers. * **BrokerCountUpdateInfo** *(dict) --* Describes brokers being changed during a broker count update. * **CreatedBrokerIds** *(list) --* Kafka Broker IDs of brokers being created. * *(float) --* * **DeletedBrokerIds** *(list) --* Kafka Broker IDs of brokers being deleted. * *(float) --* * **VpcConnectionInfo** *(dict) --* Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) of the VPC connection. * **Owner** *(string) --* The owner of the VPC Connection. * **UserIdentity** *(dict) --* Description of the requester that calls the API operation. * **Type** *(string) --* The identity type of the requester that calls the API operation. * **PrincipalId** *(string) --* A unique identifier for the requester that calls the API operation. * **CreationTime** *(datetime) --* The time when Amazon MSK creates the VPC Connnection. **Exceptions** * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / update_cluster_configuration update_cluster_configuration **************************** Kafka.Client.update_cluster_configuration(**kwargs) Updates the cluster with the configuration that is specified in the request body. See also: AWS API Documentation **Request Syntax** response = client.update_cluster_configuration( ClusterArn='string', ConfigurationInfo={ 'Arn': 'string', 'Revision': 123 }, CurrentVersion='string' ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **ConfigurationInfo** (*dict*) -- **[REQUIRED]** Represents the configuration that you want MSK to use for the brokers in a cluster. * **Arn** *(string) --* **[REQUIRED]** ARN of the configuration to use. * **Revision** *(integer) --* **[REQUIRED]** The revision of the configuration to use. * **CurrentVersion** (*string*) -- **[REQUIRED]** The version of the cluster that needs to be updated. Return type: dict Returns: **Response Syntax** { 'ClusterArn': 'string', 'ClusterOperationArn': 'string' } **Response Structure** * *(dict) --* Successful response. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) of the cluster. * **ClusterOperationArn** *(string) --* The Amazon Resource Name (ARN) of the cluster operation. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" Kafka / Client / update_storage update_storage ************** Kafka.Client.update_storage(**kwargs) Updates cluster broker volume size (or) sets cluster storage mode to TIERED. See also: AWS API Documentation **Request Syntax** response = client.update_storage( ClusterArn='string', CurrentVersion='string', ProvisionedThroughput={ 'Enabled': True|False, 'VolumeThroughput': 123 }, StorageMode='LOCAL'|'TIERED', VolumeSizeGB=123 ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the cluster to be updated. * **CurrentVersion** (*string*) -- **[REQUIRED]** The version of cluster to update from. A successful operation will then generate a new version. * **ProvisionedThroughput** (*dict*) -- EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **StorageMode** (*string*) -- Controls storage mode for supported storage tiers. * **VolumeSizeGB** (*integer*) -- size of the EBS volume to update. Return type: dict Returns: **Response Syntax** { 'ClusterArn': 'string', 'ClusterOperationArn': 'string' } **Response Structure** * *(dict) --* HTTP Status Code 200: OK. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) of the cluster. * **ClusterOperationArn** *(string) --* The Amazon Resource Name (ARN) of the cluster operation. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / list_scram_secrets list_scram_secrets ****************** Kafka.Client.list_scram_secrets(**kwargs) Returns a list of the Scram Secrets associated with an Amazon MSK cluster. See also: AWS API Documentation **Request Syntax** response = client.list_scram_secrets( ClusterArn='string', MaxResults=123, NextToken='string' ) Parameters: * **ClusterArn** (*string*) -- **[REQUIRED]** The arn of the cluster. * **MaxResults** (*integer*) -- The maxResults of the query. * **NextToken** (*string*) -- The nextToken of the query. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'SecretArnList': [ 'string', ] } **Response Structure** * *(dict) --* 200 response * **NextToken** *(string) --* Paginated results marker. * **SecretArnList** *(list) --* The list of scram secrets associated with the cluster. * *(string) --* **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / get_cluster_policy get_cluster_policy ****************** Kafka.Client.get_cluster_policy(**kwargs) Get the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request. See also: AWS API Documentation **Request Syntax** response = client.get_cluster_policy( ClusterArn='string' ) Parameters: **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the cluster. Return type: dict Returns: **Response Syntax** { 'CurrentVersion': 'string', 'Policy': 'string' } **Response Structure** * *(dict) --* Successful response. * **CurrentVersion** *(string) --* The version of cluster policy. * **Policy** *(string) --* The cluster policy. **Exceptions** * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / tag_resource tag_resource ************ Kafka.Client.tag_resource(**kwargs) Adds tags to the specified MSK resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceArn='string', Tags={ 'string': 'string' } ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags. * **Tags** (*dict*) -- **[REQUIRED]** The key-value pair for the resource tag. * *(string) --* * *(string) --* Returns: None **Exceptions** * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" Kafka / Client / describe_replicator describe_replicator ******************* Kafka.Client.describe_replicator(**kwargs) Describes a replicator. See also: AWS API Documentation **Request Syntax** response = client.describe_replicator( ReplicatorArn='string' ) Parameters: **ReplicatorArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the replicator to be described. Return type: dict Returns: **Response Syntax** { 'CreationTime': datetime(2015, 1, 1), 'CurrentVersion': 'string', 'IsReplicatorReference': True|False, 'KafkaClusters': [ { 'AmazonMskCluster': { 'MskClusterArn': 'string' }, 'KafkaClusterAlias': 'string', 'VpcConfig': { 'SecurityGroupIds': [ 'string', ], 'SubnetIds': [ 'string', ] } }, ], 'ReplicationInfoList': [ { 'ConsumerGroupReplication': { 'ConsumerGroupsToExclude': [ 'string', ], 'ConsumerGroupsToReplicate': [ 'string', ], 'DetectAndCopyNewConsumerGroups': True|False, 'SynchroniseConsumerGroupOffsets': True|False }, 'SourceKafkaClusterAlias': 'string', 'TargetCompressionType': 'NONE'|'GZIP'|'SNAPPY'|'LZ4'|'ZSTD', 'TargetKafkaClusterAlias': 'string', 'TopicReplication': { 'CopyAccessControlListsForTopics': True|False, 'CopyTopicConfigurations': True|False, 'DetectAndCopyNewTopics': True|False, 'StartingPosition': { 'Type': 'LATEST'|'EARLIEST' }, 'TopicNameConfiguration': { 'Type': 'PREFIXED_WITH_SOURCE_CLUSTER_ALIAS'|'IDENTICAL' }, 'TopicsToExclude': [ 'string', ], 'TopicsToReplicate': [ 'string', ] } }, ], 'ReplicatorArn': 'string', 'ReplicatorDescription': 'string', 'ReplicatorName': 'string', 'ReplicatorResourceArn': 'string', 'ReplicatorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED', 'ServiceExecutionRoleArn': 'string', 'StateInfo': { 'Code': 'string', 'Message': 'string' }, 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* HTTP Status Code 200: OK. * **CreationTime** *(datetime) --* The time when the replicator was created. * **CurrentVersion** *(string) --* The current version number of the replicator. * **IsReplicatorReference** *(boolean) --* Whether this resource is a replicator reference. * **KafkaClusters** *(list) --* Kafka Clusters used in setting up sources / targets for replication. * *(dict) --* Information about Kafka Cluster used as source / target for replication. * **AmazonMskCluster** *(dict) --* Details of an Amazon MSK Cluster. * **MskClusterArn** *(string) --* The Amazon Resource Name (ARN) of an Amazon MSK cluster. * **KafkaClusterAlias** *(string) --* The alias of the Kafka cluster. Used to prefix names of replicated topics. * **VpcConfig** *(dict) --* Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster. * **SecurityGroupIds** *(list) --* The security groups to attach to the ENIs for the broker nodes. * *(string) --* * **SubnetIds** *(list) --* The list of subnets in the client VPC to connect to. * *(string) --* * **ReplicationInfoList** *(list) --* A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow. * *(dict) --* Specifies configuration for replication between a source and target Kafka cluster (sourceKafkaClusterAlias -> targetKafkaClusterAlias) * **ConsumerGroupReplication** *(dict) --* Configuration relating to consumer group replication. * **ConsumerGroupsToExclude** *(list) --* List of regular expression patterns indicating the consumer groups that should not be replicated. * *(string) --* * **ConsumerGroupsToReplicate** *(list) --* List of regular expression patterns indicating the consumer groups to copy. * *(string) --* * **DetectAndCopyNewConsumerGroups** *(boolean) --* Enables synchronization of consumer groups to target cluster. * **SynchroniseConsumerGroupOffsets** *(boolean) --* Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets. * **SourceKafkaClusterAlias** *(string) --* The alias of the source Kafka cluster. * **TargetCompressionType** *(string) --* The compression type to use when producing records to target cluster. * **TargetKafkaClusterAlias** *(string) --* The alias of the target Kafka cluster. * **TopicReplication** *(dict) --* Configuration relating to topic replication. * **CopyAccessControlListsForTopics** *(boolean) --* Whether to periodically configure remote topic ACLs to match their corresponding upstream topics. * **CopyTopicConfigurations** *(boolean) --* Whether to periodically configure remote topics to match their corresponding upstream topics. * **DetectAndCopyNewTopics** *(boolean) --* Whether to periodically check for new topics and partitions. * **StartingPosition** *(dict) --* Configuration for specifying the position in the topics to start replicating from. * **Type** *(string) --* The type of replication starting position. * **TopicNameConfiguration** *(dict) --* Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias. * **Type** *(string) --* The type of replicated topic name. * **TopicsToExclude** *(list) --* List of regular expression patterns indicating the topics that should not be replicated. * *(string) --* * **TopicsToReplicate** *(list) --* List of regular expression patterns indicating the topics to copy. * *(string) --* * **ReplicatorArn** *(string) --* The Amazon Resource Name (ARN) of the replicator. * **ReplicatorDescription** *(string) --* The description of the replicator. * **ReplicatorName** *(string) --* The name of the replicator. * **ReplicatorResourceArn** *(string) --* The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created. * **ReplicatorState** *(string) --* State of the replicator. * **ServiceExecutionRoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters) * **StateInfo** *(dict) --* Details about the state of the replicator. * **Code** *(string) --* Code that describes the current state of the replicator. * **Message** *(string) --* Message that describes the state of the replicator. * **Tags** *(dict) --* List of tags attached to the Replicator. * *(string) --* * *(string) --* **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / describe_cluster describe_cluster **************** Kafka.Client.describe_cluster(**kwargs) Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request. See also: AWS API Documentation **Request Syntax** response = client.describe_cluster( ClusterArn='string' ) Parameters: **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the cluster. Return type: dict Returns: **Response Syntax** { 'ClusterInfo': { 'ActiveOperationArn': 'string', 'BrokerNodeGroupInfo': { 'BrokerAZDistribution': 'DEFAULT', 'ClientSubnets': [ 'string', ], 'InstanceType': 'string', 'SecurityGroups': [ 'string', ], 'StorageInfo': { 'EbsStorageInfo': { 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSize': 123 } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'ZoneIds': [ 'string', ] }, 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, 'ClusterArn': 'string', 'ClusterName': 'string', 'CreationTime': datetime(2015, 1, 1), 'CurrentBrokerSoftwareInfo': { 'ConfigurationArn': 'string', 'ConfigurationRevision': 123, 'KafkaVersion': 'string' }, 'CurrentVersion': 'string', 'EncryptionInfo': { 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, 'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', 'OpenMonitoring': { 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, 'LoggingInfo': { 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, 'NumberOfBrokerNodes': 123, 'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING', 'StateInfo': { 'Code': 'string', 'Message': 'string' }, 'Tags': { 'string': 'string' }, 'ZookeeperConnectString': 'string', 'ZookeeperConnectStringTls': 'string', 'StorageMode': 'LOCAL'|'TIERED', 'CustomerActionStatus': 'CRITICAL_ACTION_REQUIRED'|'ACTION_RECOMMENDED'|'NONE' } } **Response Structure** * *(dict) --* Successful response. * **ClusterInfo** *(dict) --* The cluster information. * **ActiveOperationArn** *(string) --* Arn of active cluster operation. * **BrokerNodeGroupInfo** *(dict) --* Information about the broker nodes. * **BrokerAZDistribution** *(string) --* The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed. Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster. * **ClientSubnets** *(list) --* 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. * *(string) --* * **InstanceType** *(string) --* The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge. * **SecurityGroups** *(list) --* 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. * *(string) --* * **StorageInfo** *(dict) --* Contains information about storage volumes attached to MSK broker nodes. * **EbsStorageInfo** *(dict) --* EBS volume information. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSize** *(integer) --* The size in GiB of the EBS volume for the data drive on each broker node. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **ZoneIds** *(list) --* The list of zoneIds for the cluster in the virtual private cloud (VPC). * *(string) --* * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **ClusterName** *(string) --* The name of the cluster. * **CreationTime** *(datetime) --* The time when the cluster was created. * **CurrentBrokerSoftwareInfo** *(dict) --* Information about the version of software currently deployed on the Apache Kafka brokers in the cluster. * **ConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release. * **ConfigurationRevision** *(integer) --* The revision of the configuration to use. This field isn't visible in this preview release. * **KafkaVersion** *(string) --* The version of Apache Kafka. * **CurrentVersion** *(string) --* The current version of the MSK cluster. * **EncryptionInfo** *(dict) --* Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **EnhancedMonitoring** *(string) --* Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring. * **OpenMonitoring** *(dict) --* Settings for open monitoring using Prometheus. * **Prometheus** *(dict) --* Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the Node Exporter. * **LoggingInfo** *(dict) --* * **BrokerLogs** *(dict) --* * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* * **Prefix** *(string) --* * **NumberOfBrokerNodes** *(integer) --* The number of broker nodes in the cluster. * **State** *(string) --* The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING. * **StateInfo** *(dict) --* * **Code** *(string) --* * **Message** *(string) --* * **Tags** *(dict) --* Tags attached to the cluster. * *(string) --* * *(string) --* * **ZookeeperConnectString** *(string) --* The connection string to use to connect to the Apache ZooKeeper cluster. * **ZookeeperConnectStringTls** *(string) --* The connection string to use to connect to zookeeper cluster on Tls port. * **StorageMode** *(string) --* This controls storage mode for supported storage tiers. * **CustomerActionStatus** *(string) --* Determines if there is an action required from the customer. **Exceptions** * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / get_bootstrap_brokers get_bootstrap_brokers ********************* Kafka.Client.get_bootstrap_brokers(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.get_bootstrap_brokers( ClusterArn='string' ) Parameters: **ClusterArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies the cluster. Return type: dict Returns: **Response Syntax** { 'BootstrapBrokerString': 'string', 'BootstrapBrokerStringTls': 'string', 'BootstrapBrokerStringSaslScram': 'string', 'BootstrapBrokerStringSaslIam': 'string', 'BootstrapBrokerStringPublicTls': 'string', 'BootstrapBrokerStringPublicSaslScram': 'string', 'BootstrapBrokerStringPublicSaslIam': 'string', 'BootstrapBrokerStringVpcConnectivityTls': 'string', 'BootstrapBrokerStringVpcConnectivitySaslScram': 'string', 'BootstrapBrokerStringVpcConnectivitySaslIam': 'string' } **Response Structure** * *(dict) --* Successful response. * **BootstrapBrokerString** *(string) --* A string containing one or more hostname:port pairs. * **BootstrapBrokerStringTls** *(string) --* A string containing one or more DNS names (or IP) and TLS port pairs. * **BootstrapBrokerStringSaslScram** *(string) --* A string containing one or more DNS names (or IP) and Sasl Scram port pairs. * **BootstrapBrokerStringSaslIam** *(string) --* A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs. * **BootstrapBrokerStringPublicTls** *(string) --* A string containing one or more DNS names (or IP) and TLS port pairs. * **BootstrapBrokerStringPublicSaslScram** *(string) --* A string containing one or more DNS names (or IP) and Sasl Scram port pairs. * **BootstrapBrokerStringPublicSaslIam** *(string) --* A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs. * **BootstrapBrokerStringVpcConnectivityTls** *(string) --* A string containing one or more DNS names (or IP) and TLS port pairs for VPC connectivity. * **BootstrapBrokerStringVpcConnectivitySaslScram** *(string) --* A string containing one or more DNS names (or IP) and SASL/SCRAM port pairs for VPC connectivity. * **BootstrapBrokerStringVpcConnectivitySaslIam** *(string) --* A string containing one or more DNS names (or IP) and SASL/IAM port pairs for VPC connectivity. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ConflictException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / create_cluster_v2 create_cluster_v2 ***************** Kafka.Client.create_cluster_v2(**kwargs) Creates a new MSK cluster. See also: AWS API Documentation **Request Syntax** response = client.create_cluster_v2( ClusterName='string', Tags={ 'string': 'string' }, Provisioned={ 'BrokerNodeGroupInfo': { 'BrokerAZDistribution': 'DEFAULT', 'ClientSubnets': [ 'string', ], 'InstanceType': 'string', 'SecurityGroups': [ 'string', ], 'StorageInfo': { 'EbsStorageInfo': { 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSize': 123 } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'ZoneIds': [ 'string', ] }, 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, 'ConfigurationInfo': { 'Arn': 'string', 'Revision': 123 }, 'EncryptionInfo': { 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, 'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', 'OpenMonitoring': { 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, 'KafkaVersion': 'string', 'LoggingInfo': { 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, 'NumberOfBrokerNodes': 123, 'StorageMode': 'LOCAL'|'TIERED' }, Serverless={ 'VpcConfigs': [ { 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ] }, ], 'ClientAuthentication': { 'Sasl': { 'Iam': { 'Enabled': True|False } } } } ) Parameters: * **ClusterName** (*string*) -- **[REQUIRED]** The name of the cluster. * **Tags** (*dict*) -- A map of tags that you want the cluster to have. * *(string) --* * *(string) --* * **Provisioned** (*dict*) -- Information about the provisioned cluster. * **BrokerNodeGroupInfo** *(dict) --* **[REQUIRED]** Information about the brokers. * **BrokerAZDistribution** *(string) --* The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed. Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster. * **ClientSubnets** *(list) --* **[REQUIRED]** 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. * *(string) --* * **InstanceType** *(string) --* **[REQUIRED]** The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge. * **SecurityGroups** *(list) --* 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. * *(string) --* * **StorageInfo** *(dict) --* Contains information about storage volumes attached to MSK broker nodes. * **EbsStorageInfo** *(dict) --* EBS volume information. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSize** *(integer) --* The size in GiB of the EBS volume for the data drive on each broker node. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **ZoneIds** *(list) --* The list of zoneIds for the cluster in the virtual private cloud (VPC). * *(string) --* * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **ConfigurationInfo** *(dict) --* Represents the configuration that you want Amazon MSK to use for the brokers in a cluster. * **Arn** *(string) --* **[REQUIRED]** ARN of the configuration to use. * **Revision** *(integer) --* **[REQUIRED]** The revision of the configuration to use. * **EncryptionInfo** *(dict) --* Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* **[REQUIRED]** 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **EnhancedMonitoring** *(string) --* Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. * **OpenMonitoring** *(dict) --* The settings for open monitoring. * **Prometheus** *(dict) --* **[REQUIRED]** Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* **[REQUIRED]** Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* **[REQUIRED]** Indicates whether you want to turn on or turn off the Node Exporter. * **KafkaVersion** *(string) --* **[REQUIRED]** The Apache Kafka version that you want for the cluster. * **LoggingInfo** *(dict) --* Log delivery information for the cluster. * **BrokerLogs** *(dict) --* **[REQUIRED]** * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* **[REQUIRED]** * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* **[REQUIRED]** * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* **[REQUIRED]** * **Prefix** *(string) --* * **NumberOfBrokerNodes** *(integer) --* **[REQUIRED]** The number of broker nodes in the cluster. * **StorageMode** *(string) --* This controls storage mode for supported storage tiers. * **Serverless** (*dict*) -- Information about the serverless cluster. * **VpcConfigs** *(list) --* **[REQUIRED]** The configuration of the Amazon VPCs for the cluster. * *(dict) --* The configuration of the Amazon VPCs for the cluster. * **SubnetIds** *(list) --* **[REQUIRED]** The IDs of the subnets associated with the cluster. * *(string) --* * **SecurityGroupIds** *(list) --* The IDs of the security groups associated with the cluster. * *(string) --* * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. Return type: dict Returns: **Response Syntax** { 'ClusterArn': 'string', 'ClusterName': 'string', 'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING', 'ClusterType': 'PROVISIONED'|'SERVERLESS' } **Response Structure** * *(dict) --* * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) of the cluster. * **ClusterName** *(string) --* The name of the MSK cluster. * **State** *(string) --* The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING. * **ClusterType** *(string) --* The type of the cluster. The possible states are PROVISIONED or SERVERLESS. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" * "Kafka.Client.exceptions.ConflictException" Kafka / Client / list_vpc_connections list_vpc_connections ******************** Kafka.Client.list_vpc_connections(**kwargs) Returns a list of all the VPC connections in this Region. See also: AWS API Documentation **Request Syntax** response = client.list_vpc_connections( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'VpcConnections': [ { 'VpcConnectionArn': 'string', 'TargetClusterArn': 'string', 'CreationTime': datetime(2015, 1, 1), 'Authentication': 'string', 'VpcId': 'string', 'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* 200 response * **VpcConnections** *(list) --* List of VPC connections. * *(dict) --* The VPC connection object. * **VpcConnectionArn** *(string) --* The ARN that identifies the Vpc Connection. * **TargetClusterArn** *(string) --* The ARN that identifies the Cluster which the Vpc Connection belongs to. * **CreationTime** *(datetime) --* Creation time of the Vpc Connection. * **Authentication** *(string) --* Information about the auth scheme of Vpc Connection. * **VpcId** *(string) --* The vpcId that belongs to the Vpc Connection. * **State** *(string) --* State of the Vpc Connection. * **NextToken** *(string) --* The paginated results marker. When the result of a ListClientVpcConnections operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request. **Exceptions** * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / delete_vpc_connection delete_vpc_connection ********************* Kafka.Client.delete_vpc_connection(**kwargs) Deletes a MSK VPC connection. See also: AWS API Documentation **Request Syntax** response = client.delete_vpc_connection( Arn='string' ) Parameters: **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies an MSK VPC connection. Return type: dict Returns: **Response Syntax** { 'VpcConnectionArn': 'string', 'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING' } **Response Structure** * *(dict) --* Successful response. * **VpcConnectionArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies an MSK VPC connection. * **State** *(string) --* The state of the VPC connection. **Exceptions** * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" Kafka / Client / describe_configuration describe_configuration ********************** Kafka.Client.describe_configuration(**kwargs) Returns a description of this MSK configuration. See also: AWS API Documentation **Request Syntax** response = client.describe_configuration( Arn='string' ) Parameters: **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'CreationTime': datetime(2015, 1, 1), 'Description': 'string', 'KafkaVersions': [ 'string', ], 'LatestRevision': { 'CreationTime': datetime(2015, 1, 1), 'Description': 'string', 'Revision': 123 }, 'Name': 'string', 'State': 'ACTIVE'|'DELETING'|'DELETE_FAILED' } **Response Structure** * *(dict) --* 200 response * **Arn** *(string) --* The Amazon Resource Name (ARN) of the configuration. * **CreationTime** *(datetime) --* The time when the configuration was created. * **Description** *(string) --* The description of the configuration. * **KafkaVersions** *(list) --* The versions of Apache Kafka with which you can use this MSK configuration. * *(string) --* * **LatestRevision** *(dict) --* Latest revision of the configuration. * **CreationTime** *(datetime) --* The time when the configuration revision was created. * **Description** *(string) --* The description of the configuration revision. * **Revision** *(integer) --* The revision number. * **Name** *(string) --* The name of the configuration. * **State** *(string) --* The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" Kafka / Client / describe_configuration_revision describe_configuration_revision ******************************* Kafka.Client.describe_configuration_revision(**kwargs) Returns a description of this revision of the configuration. See also: AWS API Documentation **Request Syntax** response = client.describe_configuration_revision( Arn='string', Revision=123 ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions. * **Revision** (*integer*) -- **[REQUIRED]** A string that uniquely identifies a revision of an MSK configuration. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'CreationTime': datetime(2015, 1, 1), 'Description': 'string', 'Revision': 123, 'ServerProperties': b'bytes' } **Response Structure** * *(dict) --* 200 response * **Arn** *(string) --* The Amazon Resource Name (ARN) of the configuration. * **CreationTime** *(datetime) --* The time when the configuration was created. * **Description** *(string) --* The description of the configuration. * **Revision** *(integer) --* The revision number. * **ServerProperties** *(bytes) --* Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.NotFoundException" * "Kafka.Client.exceptions.ServiceUnavailableException" Kafka / Client / create_vpc_connection create_vpc_connection ********************* Kafka.Client.create_vpc_connection(**kwargs) Creates a new MSK VPC connection. See also: AWS API Documentation **Request Syntax** response = client.create_vpc_connection( TargetClusterArn='string', Authentication='string', VpcId='string', ClientSubnets=[ 'string', ], SecurityGroups=[ 'string', ], Tags={ 'string': 'string' } ) Parameters: * **TargetClusterArn** (*string*) -- **[REQUIRED]** The cluster Amazon Resource Name (ARN) for the VPC connection. * **Authentication** (*string*) -- **[REQUIRED]** The authentication type of VPC connection. * **VpcId** (*string*) -- **[REQUIRED]** The VPC ID of VPC connection. * **ClientSubnets** (*list*) -- **[REQUIRED]** The list of client subnets. * *(string) --* * **SecurityGroups** (*list*) -- **[REQUIRED]** The list of security groups. * *(string) --* * **Tags** (*dict*) -- A map of tags for the VPC connection. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'VpcConnectionArn': 'string', 'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING', 'Authentication': 'string', 'VpcId': 'string', 'ClientSubnets': [ 'string', ], 'SecurityGroups': [ 'string', ], 'CreationTime': datetime(2015, 1, 1), 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* 200 response * **VpcConnectionArn** *(string) --* The VPC connection ARN. * **State** *(string) --* The State of Vpc Connection. * **Authentication** *(string) --* The authentication type of VPC connection. * **VpcId** *(string) --* The VPC ID of the VPC connection. * **ClientSubnets** *(list) --* The list of client subnets. * *(string) --* * **SecurityGroups** *(list) --* The list of security groups. * *(string) --* * **CreationTime** *(datetime) --* The creation time of VPC connection. * **Tags** *(dict) --* A map of tags for the VPC connection. * *(string) --* * *(string) --* **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.ForbiddenException" * "Kafka.Client.exceptions.ServiceUnavailableException" * "Kafka.Client.exceptions.TooManyRequestsException" Kafka / Client / list_clusters list_clusters ************* Kafka.Client.list_clusters(**kwargs) Returns a list of all the MSK clusters in the current Region. See also: AWS API Documentation **Request Syntax** response = client.list_clusters( ClusterNameFilter='string', MaxResults=123, NextToken='string' ) Parameters: * **ClusterNameFilter** (*string*) -- 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. * **MaxResults** (*integer*) -- The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter. * **NextToken** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'ClusterInfoList': [ { 'ActiveOperationArn': 'string', 'BrokerNodeGroupInfo': { 'BrokerAZDistribution': 'DEFAULT', 'ClientSubnets': [ 'string', ], 'InstanceType': 'string', 'SecurityGroups': [ 'string', ], 'StorageInfo': { 'EbsStorageInfo': { 'ProvisionedThroughput': { 'Enabled': True|False, 'VolumeThroughput': 123 }, 'VolumeSize': 123 } }, 'ConnectivityInfo': { 'PublicAccess': { 'Type': 'string' }, 'VpcConnectivity': { 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'Enabled': True|False } } } }, 'ZoneIds': [ 'string', ] }, 'ClientAuthentication': { 'Sasl': { 'Scram': { 'Enabled': True|False }, 'Iam': { 'Enabled': True|False } }, 'Tls': { 'CertificateAuthorityArnList': [ 'string', ], 'Enabled': True|False }, 'Unauthenticated': { 'Enabled': True|False } }, 'ClusterArn': 'string', 'ClusterName': 'string', 'CreationTime': datetime(2015, 1, 1), 'CurrentBrokerSoftwareInfo': { 'ConfigurationArn': 'string', 'ConfigurationRevision': 123, 'KafkaVersion': 'string' }, 'CurrentVersion': 'string', 'EncryptionInfo': { 'EncryptionAtRest': { 'DataVolumeKMSKeyId': 'string' }, 'EncryptionInTransit': { 'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT', 'InCluster': True|False } }, 'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION', 'OpenMonitoring': { 'Prometheus': { 'JmxExporter': { 'EnabledInBroker': True|False }, 'NodeExporter': { 'EnabledInBroker': True|False } } }, 'LoggingInfo': { 'BrokerLogs': { 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'Firehose': { 'DeliveryStream': 'string', 'Enabled': True|False }, 'S3': { 'Bucket': 'string', 'Enabled': True|False, 'Prefix': 'string' } } }, 'NumberOfBrokerNodes': 123, 'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING', 'StateInfo': { 'Code': 'string', 'Message': 'string' }, 'Tags': { 'string': 'string' }, 'ZookeeperConnectString': 'string', 'ZookeeperConnectStringTls': 'string', 'StorageMode': 'LOCAL'|'TIERED', 'CustomerActionStatus': 'CRITICAL_ACTION_REQUIRED'|'ACTION_RECOMMENDED'|'NONE' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Successful response. * **ClusterInfoList** *(list) --* Information on each of the MSK clusters in the response. * *(dict) --* Returns information about a cluster. * **ActiveOperationArn** *(string) --* Arn of active cluster operation. * **BrokerNodeGroupInfo** *(dict) --* Information about the broker nodes. * **BrokerAZDistribution** *(string) --* The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed. Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster. * **ClientSubnets** *(list) --* 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. * *(string) --* * **InstanceType** *(string) --* The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge. * **SecurityGroups** *(list) --* 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. * *(string) --* * **StorageInfo** *(dict) --* Contains information about storage volumes attached to MSK broker nodes. * **EbsStorageInfo** *(dict) --* EBS volume information. * **ProvisionedThroughput** *(dict) --* EBS volume provisioned throughput information. * **Enabled** *(boolean) --* Provisioned throughput is enabled or not. * **VolumeThroughput** *(integer) --* Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second. * **VolumeSize** *(integer) --* The size in GiB of the EBS volume for the data drive on each broker node. * **ConnectivityInfo** *(dict) --* Information about the broker access configuration. * **PublicAccess** *(dict) --* Public access control for brokers. * **Type** *(string) --* The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on. * **VpcConnectivity** *(dict) --* VPC connectivity access control for brokers. * **ClientAuthentication** *(dict) --* Includes all client authentication information for VPC connectivity. * **Sasl** *(dict) --* SASL authentication type details for VPC connectivity. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/SCRAM authentication is on or off for VPC connectivity. * **Iam** *(dict) --* Details for SASL/IAM client authentication for VPC connectivity. * **Enabled** *(boolean) --* SASL/IAM authentication is on or off for VPC connectivity. * **Tls** *(dict) --* TLS authentication type details for VPC connectivity. * **Enabled** *(boolean) --* TLS authentication is on or off for VPC connectivity. * **ZoneIds** *(list) --* The list of zoneIds for the cluster in the virtual private cloud (VPC). * *(string) --* * **ClientAuthentication** *(dict) --* Includes all client authentication information. * **Sasl** *(dict) --* Details for ClientAuthentication using SASL. * **Scram** *(dict) --* Details for SASL/SCRAM client authentication. * **Enabled** *(boolean) --* SASL/SCRAM authentication is enabled or not. * **Iam** *(dict) --* Indicates whether IAM access control is enabled. * **Enabled** *(boolean) --* Indicates whether IAM access control is enabled. * **Tls** *(dict) --* Details for ClientAuthentication using TLS. * **CertificateAuthorityArnList** *(list) --* List of ACM Certificate Authority ARNs. * *(string) --* * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off TLS authentication. * **Unauthenticated** *(dict) --* Contains information about unauthenticated traffic to the cluster. * **Enabled** *(boolean) --* Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster. * **ClusterArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies the cluster. * **ClusterName** *(string) --* The name of the cluster. * **CreationTime** *(datetime) --* The time when the cluster was created. * **CurrentBrokerSoftwareInfo** *(dict) --* Information about the version of software currently deployed on the Apache Kafka brokers in the cluster. * **ConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release. * **ConfigurationRevision** *(integer) --* The revision of the configuration to use. This field isn't visible in this preview release. * **KafkaVersion** *(string) --* The version of Apache Kafka. * **CurrentVersion** *(string) --* The current version of the MSK cluster. * **EncryptionInfo** *(dict) --* Includes all encryption-related information. * **EncryptionAtRest** *(dict) --* The data-volume encryption details. * **DataVolumeKMSKeyId** *(string) --* 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. * **EncryptionInTransit** *(dict) --* The details for encryption in transit. * **ClientBroker** *(string) --* Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only. The default value is TLS_PLAINTEXT. * **InCluster** *(boolean) --* When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true. * **EnhancedMonitoring** *(string) --* Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring. * **OpenMonitoring** *(dict) --* Settings for open monitoring using Prometheus. * **Prometheus** *(dict) --* Prometheus settings. * **JmxExporter** *(dict) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the JMX Exporter. * **NodeExporter** *(dict) --* Indicates whether you want to turn on or turn off the Node Exporter. * **EnabledInBroker** *(boolean) --* Indicates whether you want to turn on or turn off the Node Exporter. * **LoggingInfo** *(dict) --* * **BrokerLogs** *(dict) --* * **CloudWatchLogs** *(dict) --* * **Enabled** *(boolean) --* * **LogGroup** *(string) --* * **Firehose** *(dict) --* * **DeliveryStream** *(string) --* * **Enabled** *(boolean) --* * **S3** *(dict) --* * **Bucket** *(string) --* * **Enabled** *(boolean) --* * **Prefix** *(string) --* * **NumberOfBrokerNodes** *(integer) --* The number of broker nodes in the cluster. * **State** *(string) --* The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING. * **StateInfo** *(dict) --* * **Code** *(string) --* * **Message** *(string) --* * **Tags** *(dict) --* Tags attached to the cluster. * *(string) --* * *(string) --* * **ZookeeperConnectString** *(string) --* The connection string to use to connect to the Apache ZooKeeper cluster. * **ZookeeperConnectStringTls** *(string) --* The connection string to use to connect to zookeeper cluster on Tls port. * **StorageMode** *(string) --* This controls storage mode for supported storage tiers. * **CustomerActionStatus** *(string) --* Determines if there is an action required from the customer. * **NextToken** *(string) --* The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request. **Exceptions** * "Kafka.Client.exceptions.BadRequestException" * "Kafka.Client.exceptions.InternalServerErrorException" * "Kafka.Client.exceptions.UnauthorizedException" * "Kafka.Client.exceptions.ForbiddenException"