Table of Contents
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()delete_cluster()delete_configuration()describe_cluster()describe_cluster_operation()describe_cluster_v2()describe_configuration()describe_configuration_revision()get_bootstrap_brokers()get_compatible_kafka_versions()get_paginator()get_waiter()list_cluster_operations()list_clusters()list_clusters_v2()list_configuration_revisions()list_configurations()list_kafka_versions()list_nodes()list_scram_secrets()list_tags_for_resource()reboot_broker()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_security()update_storage()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',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the cluster to be updated.
[REQUIRED]
List of AWS Secrets Manager secret ARNs.
dict
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.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.ServiceUnavailableExceptionKafka.Client.exceptions.TooManyRequestsExceptionbatch_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',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the cluster to be updated.
[REQUIRED]
List of AWS Secrets Manager secret ARNs.
dict
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.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.ServiceUnavailableExceptionKafka.Client.exceptions.TooManyRequestsExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
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").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
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'
}
}
},
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'
)
[REQUIRED]
Information about the broker nodes in the cluster.
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.
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.
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.
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.
Contains information about storage volumes attached to MSK broker nodes.
EBS volume information.
EBS volume provisioned throughput information.
Provisioned throughput is enabled or not.
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
The size in GiB of the EBS volume for the data drive on each broker node.
Information about the broker access configuration.
Public access control for brokers.
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
Includes all client authentication related information.
Details for ClientAuthentication using SASL.
Details for SASL/SCRAM client authentication.
SASL/SCRAM authentication is enabled or not.
Indicates whether IAM access control is enabled.
Indicates whether IAM access control is enabled.
Details for ClientAuthentication using TLS.
List of ACM Certificate Authority ARNs.
Specifies whether you want to turn on or turn off TLS authentication.
Contains information about unauthenticated traffic to the cluster.
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
[REQUIRED]
The name of the cluster.
Represents the configuration that you want MSK to use for the brokers in a cluster.
ARN of the configuration to use.
The revision of the configuration to use.
Includes all encryption-related information.
The data-volume encryption details.
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.
The details for encryption in transit.
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.
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.
The settings for open monitoring.
Prometheus settings.
Indicates whether you want to turn on or turn off the JMX Exporter.
Indicates whether you want to turn on or turn off the JMX Exporter.
Indicates whether you want to turn on or turn off the Node Exporter.
Indicates whether you want to turn on or turn off the Node Exporter.
[REQUIRED]
The version of Apache Kafka.
[REQUIRED]
The number of broker nodes in the cluster.
Create tags when creating the cluster.
dict
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.BadRequestExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.ServiceUnavailableExceptionKafka.Client.exceptions.TooManyRequestsExceptionKafka.Client.exceptions.ConflictExceptioncreate_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'
}
}
},
'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
}
}
}
}
)
[REQUIRED]
The name of the cluster.
A map of tags that you want the cluster to have.
Information about the provisioned cluster.
Information about the brokers.
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.
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.
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.
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.
Contains information about storage volumes attached to MSK broker nodes.
EBS volume information.
EBS volume provisioned throughput information.
Provisioned throughput is enabled or not.
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
The size in GiB of the EBS volume for the data drive on each broker node.
Information about the broker access configuration.
Public access control for brokers.
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
Includes all client authentication information.
Details for ClientAuthentication using SASL.
Details for SASL/SCRAM client authentication.
SASL/SCRAM authentication is enabled or not.
Indicates whether IAM access control is enabled.
Indicates whether IAM access control is enabled.
Details for ClientAuthentication using TLS.
List of ACM Certificate Authority ARNs.
Specifies whether you want to turn on or turn off TLS authentication.
Contains information about unauthenticated traffic to the cluster.
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
Represents the configuration that you want Amazon MSK to use for the brokers in a cluster.
ARN of the configuration to use.
The revision of the configuration to use.
Includes all encryption-related information.
The data-volume encryption details.
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.
The details for encryption in transit.
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.
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.
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.
The settings for open monitoring.
Prometheus settings.
Indicates whether you want to turn on or turn off the JMX Exporter.
Indicates whether you want to turn on or turn off the JMX Exporter.
Indicates whether you want to turn on or turn off the Node Exporter.
Indicates whether you want to turn on or turn off the Node Exporter.
The Apache Kafka version that you want for the cluster.
Log delivery information for the cluster.
The number of broker nodes in the cluster.
This controls storage mode for supported storage tiers.
Information about the serverless cluster.
The configuration of the Amazon VPCs for the cluster.
The configuration of the Amazon VPCs for the cluster.
The IDs of the subnets associated with the cluster.
The IDs of the security groups associated with the cluster.
Includes all client authentication information.
Details for ClientAuthentication using SASL.
Indicates whether IAM access control is enabled.
Indicates whether IAM access control is enabled.
dict
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.BadRequestExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.ServiceUnavailableExceptionKafka.Client.exceptions.TooManyRequestsExceptionKafka.Client.exceptions.ConflictExceptioncreate_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'
)
The versions of Apache Kafka with which you can use this MSK configuration.
[REQUIRED]
The name of the configuration.
[REQUIRED]
Contents of the server.propertiesfile. 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.propertiescan be in plaintext.
dict
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.BadRequestExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.ServiceUnavailableExceptionKafka.Client.exceptions.TooManyRequestsExceptionKafka.Client.exceptions.ConflictExceptiondelete_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
dict
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.NotFoundExceptionKafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptiondelete_configuration(**kwargs)¶Deletes an MSK Configuration.
See also: AWS API Documentation
Request Syntax
response = client.delete_configuration(
Arn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.
{
'Arn': 'string',
'State': 'ACTIVE'|'DELETING'|'DELETE_FAILED'
}
Response Structure
Successful response.
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
Exceptions
Kafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptiondescribe_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
{
'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'
}
}
},
'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'
}
}
Response Structure
Successful response.
The cluster information.
Arn of active cluster operation.
Information about the broker nodes.
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.
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.
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.
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.
Contains information about storage volumes attached to MSK broker nodes.
EBS volume information.
EBS volume provisioned throughput information.
Provisioned throughput is enabled or not.
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
The size in GiB of the EBS volume for the data drive on each broker node.
Information about the broker access configuration.
Public access control for brokers.
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
Includes all client authentication information.
Details for ClientAuthentication using SASL.
Details for SASL/SCRAM client authentication.
SASL/SCRAM authentication is enabled or not.
Indicates whether IAM access control is enabled.
Indicates whether IAM access control is enabled.
Details for ClientAuthentication using TLS.
List of ACM Certificate Authority ARNs.
Specifies whether you want to turn on or turn off TLS authentication.
Contains information about unauthenticated traffic to the cluster.
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
The name of the cluster.
The time when the cluster was created.
Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.
The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
The revision of the configuration to use. This field isn't visible in this preview release.
The version of Apache Kafka.
The current version of the MSK cluster.
Includes all encryption-related information.
The data-volume encryption details.
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.
The details for encryption in transit.
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.
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.
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 .
Settings for open monitoring using Prometheus.
Prometheus settings.
Indicates whether you want to turn on or turn off the JMX Exporter.
Indicates whether you want to turn on or turn off the JMX Exporter.
Indicates whether you want to turn on or turn off the Node Exporter.
Indicates whether you want to turn on or turn off the Node Exporter.
The number of broker nodes in the cluster.
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
Tags attached to the cluster.
The connection string to use to connect to the Apache ZooKeeper cluster.
The connection string to use to connect to zookeeper cluster on Tls port.
This controls storage mode for supported storage tiers.
Exceptions
Kafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptiondescribe_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.
{
'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'
}
},
'StorageMode': 'LOCAL'|'TIERED'
},
'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'
}
},
'StorageMode': 'LOCAL'|'TIERED'
}
}
}
Response Structure
200 response
Cluster operation information
The ID of the API request that triggered this operation.
ARN of the cluster.
The time that the operation was created.
The time at which the operation finished.
Describes the error if the operation fails.
A number describing the error programmatically.
An optional field to provide more details about the error.
ARN of the cluster operation.
State of the cluster operation.
Steps completed during the operation.
Step taken during a cluster operation.
Information about the step and its status.
The steps current status.
The name of the step.
Type of the cluster operation.
Information about cluster attributes before a cluster is updated.
Specifies the size of the EBS volume and the ID of the associated broker.
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.
The ID of the broker to update.
EBS volume provisioned throughput information.
Provisioned throughput is enabled or not.
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
Size of the EBS volume to update.
Information about the changes in the configuration of the brokers.
ARN of the configuration to use.
The revision of the configuration to use.
The number of broker nodes in the cluster.
Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
The settings for open monitoring.
Prometheus settings.
Indicates whether you want to turn on or turn off the JMX Exporter.
Indicates whether you want to turn on or turn off the JMX Exporter.
Indicates whether you want to turn on or turn off the Node Exporter.
Indicates whether you want to turn on or turn off the Node Exporter.
The Apache Kafka version.
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.
Information about the Amazon MSK broker type.
Includes all client authentication information.
Details for ClientAuthentication using SASL.
Details for SASL/SCRAM client authentication.
SASL/SCRAM authentication is enabled or not.
Indicates whether IAM access control is enabled.
Indicates whether IAM access control is enabled.
Details for ClientAuthentication using TLS.
List of ACM Certificate Authority ARNs.
Specifies whether you want to turn on or turn off TLS authentication.
Contains information about unauthenticated traffic to the cluster.
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
Includes all encryption-related information.
The data-volume encryption details.
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.
The details for encryption in transit.
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.
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.
Information about the broker access configuration.
Public access control for brokers.
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
This controls storage mode for supported storage tiers.
Information about cluster attributes after a cluster is updated.
Specifies the size of the EBS volume and the ID of the associated broker.
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.
The ID of the broker to update.
EBS volume provisioned throughput information.
Provisioned throughput is enabled or not.
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
Size of the EBS volume to update.
Information about the changes in the configuration of the brokers.
ARN of the configuration to use.
The revision of the configuration to use.
The number of broker nodes in the cluster.
Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
The settings for open monitoring.
Prometheus settings.
Indicates whether you want to turn on or turn off the JMX Exporter.
Indicates whether you want to turn on or turn off the JMX Exporter.
Indicates whether you want to turn on or turn off the Node Exporter.
Indicates whether you want to turn on or turn off the Node Exporter.
The Apache Kafka version.
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.
Information about the Amazon MSK broker type.
Includes all client authentication information.
Details for ClientAuthentication using SASL.
Details for SASL/SCRAM client authentication.
SASL/SCRAM authentication is enabled or not.
Indicates whether IAM access control is enabled.
Indicates whether IAM access control is enabled.
Details for ClientAuthentication using TLS.
List of ACM Certificate Authority ARNs.
Specifies whether you want to turn on or turn off TLS authentication.
Contains information about unauthenticated traffic to the cluster.
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
Includes all encryption-related information.
The data-volume encryption details.
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.
The details for encryption in transit.
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.
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.
Information about the broker access configuration.
Public access control for brokers.
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
This controls storage mode for supported storage tiers.
Exceptions
Kafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptiondescribe_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
{
'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'
}
}
},
'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'
},
'Serverless': {
'VpcConfigs': [
{
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
],
'ClientAuthentication': {
'Sasl': {
'Iam': {
'Enabled': True|False
}
}
}
}
}
}
Response Structure
Successful response.
The cluster information.
The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
Cluster Type.
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
The name of the cluster.
The time when the cluster was created.
The current version of the MSK cluster.
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
State Info for the Amazon MSK cluster.
Tags attached to the cluster.
Information about the provisioned cluster.
Information about the brokers.
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.
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.
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.
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.
Contains information about storage volumes attached to MSK broker nodes.
EBS volume information.
EBS volume provisioned throughput information.
Provisioned throughput is enabled or not.
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
The size in GiB of the EBS volume for the data drive on each broker node.
Information about the broker access configuration.
Public access control for brokers.
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
Information about the Apache Kafka version deployed on the brokers.
The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
The revision of the configuration to use. This field isn't visible in this preview release.
The version of Apache Kafka.
Includes all client authentication information.
Details for ClientAuthentication using SASL.
Details for SASL/SCRAM client authentication.
SASL/SCRAM authentication is enabled or not.
Indicates whether IAM access control is enabled.
Indicates whether IAM access control is enabled.
Details for ClientAuthentication using TLS.
List of ACM Certificate Authority ARNs.
Specifies whether you want to turn on or turn off TLS authentication.
Contains information about unauthenticated traffic to the cluster.
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
Includes all encryption-related information.
The data-volume encryption details.
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.
The details for encryption in transit.
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.
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.
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.
The settings for open monitoring.
Prometheus settings.
Indicates whether you want to turn on or turn off the JMX Exporter.
Indicates whether you want to turn on or turn off the JMX Exporter.
Indicates whether you want to turn on or turn off the Node Exporter.
Indicates whether you want to turn on or turn off the Node Exporter.
Log delivery information for the cluster.
The number of broker nodes in the cluster.
The connection string to use to connect to the Apache ZooKeeper cluster.
The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.
This controls storage mode for supported storage tiers.
Information about the serverless cluster.
The configuration of the Amazon VPCs for the cluster.
The configuration of the Amazon VPCs for the cluster.
The IDs of the subnets associated with the cluster.
The IDs of the security groups associated with the cluster.
Includes all client authentication information.
Details for ClientAuthentication using SASL.
Indicates whether IAM access control is enabled.
Indicates whether IAM access control is enabled.
Exceptions
Kafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptiondescribe_configuration(**kwargs)¶Returns a description of this MSK configuration.
See also: AWS API Documentation
Request Syntax
response = client.describe_configuration(
Arn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
{
'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
200 response
The Amazon Resource Name (ARN) of the configuration.
The time when the configuration was created.
The description of the configuration.
The versions of Apache Kafka with which you can use this MSK configuration.
Latest revision of the configuration.
The time when the configuration revision was created.
The description of the configuration revision.
The revision number.
The name of the configuration.
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
Exceptions
Kafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.ServiceUnavailableExceptiondescribe_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
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
[REQUIRED]
A string that uniquely identifies a revision of an MSK configuration.
dict
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.propertiesfile. 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.propertiescan be in plaintext.
Exceptions
Kafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.ServiceUnavailableExceptionget_bootstrap_brokers(**kwargs)¶A list of brokers that a client application can use to bootstrap.
See also: AWS API Documentation
Request Syntax
response = client.get_bootstrap_brokers(
ClusterArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
{
'BootstrapBrokerString': 'string',
'BootstrapBrokerStringTls': 'string',
'BootstrapBrokerStringSaslScram': 'string',
'BootstrapBrokerStringSaslIam': 'string',
'BootstrapBrokerStringPublicTls': 'string',
'BootstrapBrokerStringPublicSaslScram': 'string',
'BootstrapBrokerStringPublicSaslIam': 'string'
}
Response Structure
Successful response.
A string containing one or more hostname:port pairs.
A string containing one or more DNS names (or IP) and TLS port pairs.
A string containing one or more DNS names (or IP) and Sasl Scram port pairs.
A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.
A string containing one or more DNS names (or IP) and TLS port pairs.
A string containing one or more DNS names (or IP) and Sasl Scram port pairs.
A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.
Exceptions
Kafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ConflictExceptionKafka.Client.exceptions.ForbiddenExceptionget_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'
)
{
'CompatibleKafkaVersions': [
{
'SourceVersion': 'string',
'TargetVersions': [
'string',
]
},
]
}
Response Structure
Successful response.
A list of CompatibleKafkaVersion objects.
Contains source Apache Kafka versions and compatible target Apache Kafka versions.
An Apache Kafka version.
A list of Apache Kafka versions.
Exceptions
Kafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.ServiceUnavailableExceptionKafka.Client.exceptions.TooManyRequestsExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
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'
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
dict
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'
}
},
'StorageMode': 'LOCAL'|'TIERED'
},
'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'
}
},
'StorageMode': 'LOCAL'|'TIERED'
}
},
],
'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.
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.
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.
StorageMode (string) --
This controls storage mode for supported storage tiers.
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.
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.
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.
StorageMode (string) --
This controls storage mode for supported storage tiers.
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.BadRequestExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.ForbiddenExceptionlist_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'
)
dict
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'
}
}
},
'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'
},
],
'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.
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.
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.
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.
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) --
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) --
Tags (dict) --
Tags attached to 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 zookeeper cluster on Tls port.
StorageMode (string) --
This controls storage mode for supported storage tiers.
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.BadRequestExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.ForbiddenExceptionlist_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'
)
dict
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'
}
}
},
'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'
},
'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.
Tags (dict) --
Tags attached to the cluster.
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.
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.
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.
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.
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.
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.
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.
SecurityGroupIds (list) --
The IDs of the security groups associated with the cluster.
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.BadRequestExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.ForbiddenExceptionlist_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
dict
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.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.ServiceUnavailableExceptionlist_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'
)
dict
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.
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.ServiceUnavailableExceptionKafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionlist_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'
)
dict
Response Syntax
{
'KafkaVersions': [
{
'Version': 'string',
'Status': 'ACTIVE'|'DEPRECATED'
},
],
'NextToken': 'string'
}
Response Structure
Exceptions
Kafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionlist_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
dict
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',
]
},
'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.
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.
ZookeeperId (float) --
The role-specific ID for Zookeeper.
ZookeeperVersion (string) --
The version of Zookeeper.
Exceptions
Kafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionlist_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'
)
[REQUIRED]
The arn of the cluster.
dict
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.
Exceptions
Kafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.ServiceUnavailableExceptionKafka.Client.exceptions.TooManyRequestsExceptionReturns 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'
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.
{
'Tags': {
'string': 'string'
}
}
Response Structure
Success response.
The key-value pair for the resource tag.
Exceptions
Kafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.InternalServerErrorExceptionreboot_broker(**kwargs)¶Reboots brokers.
See also: AWS API Documentation
Request Syntax
response = client.reboot_broker(
BrokerIds=[
'string',
],
ClusterArn='string'
)
[REQUIRED]
The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.
[REQUIRED]
The Amazon Resource Name (ARN) of the cluster to be updated.
dict
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.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.ServiceUnavailableExceptionKafka.Client.exceptions.TooManyRequestsExceptiontag_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'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.
[REQUIRED]
The key-value pair for the resource tag.
None
Exceptions
Kafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.InternalServerErrorExceptionuntag_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',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.
[REQUIRED]
Tag keys must be unique for a given cluster. In addition, the following restrictions apply:
None
Exceptions
Kafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.InternalServerErrorExceptionupdate_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
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
[REQUIRED]
The version of cluster to update from. A successful operation will then generate a new version.
[REQUIRED]
The number of broker nodes that you want the cluster to have after this operation completes successfully.
dict
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.ServiceUnavailableExceptionKafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionupdate_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
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
[REQUIRED]
The version of cluster to update from. A successful operation will then generate a new version.
[REQUIRED]
Describes the target volume size and the ID of the broker to apply the update to.
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.
The ID of the broker to update.
EBS volume provisioned throughput information.
Provisioned throughput is enabled or not.
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
Size of the EBS volume to update.
dict
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.ServiceUnavailableExceptionKafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionupdate_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
[REQUIRED]
The cluster version that you want to change. After this operation completes successfully, the cluster will have a new version.
[REQUIRED]
The Amazon MSK broker type that you want all of the brokers in this cluster to be.
dict
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.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.ServiceUnavailableExceptionKafka.Client.exceptions.TooManyRequestsExceptionupdate_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
[REQUIRED]
Represents the configuration that you want MSK to use for the brokers in a cluster.
ARN of the configuration to use.
The revision of the configuration to use.
[REQUIRED]
The version of the cluster that needs to be updated.
dict
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.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.ServiceUnavailableExceptionupdate_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'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the cluster to be updated.
The custom configuration that should be applied on the new version of cluster.
ARN of the configuration to use.
The revision of the configuration to use.
[REQUIRED]
Current cluster version.
[REQUIRED]
Target Kafka version.
dict
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.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.ServiceUnavailableExceptionKafka.Client.exceptions.TooManyRequestsExceptionupdate_configuration(**kwargs)¶Updates an MSK configuration.
See also: AWS API Documentation
Request Syntax
response = client.update_configuration(
Arn='string',
Description='string',
ServerProperties=b'bytes'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the configuration.
[REQUIRED]
Contents of the server.propertiesfile. 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.propertiescan be in plaintext.
dict
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.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.ServiceUnavailableExceptionupdate_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'
}
},
CurrentVersion='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the configuration.
[REQUIRED]
Information about the broker access configuration.
Public access control for brokers.
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
[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.
dict
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.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.ServiceUnavailableExceptionupdate_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'
}
}
}
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
[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.
The settings for open monitoring.
Prometheus settings.
Indicates whether you want to turn on or turn off the JMX Exporter.
Indicates whether you want to turn on or turn off the JMX Exporter.
Indicates whether you want to turn on or turn off the Node Exporter.
Indicates whether you want to turn on or turn off the Node Exporter.
dict
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.ServiceUnavailableExceptionKafka.Client.exceptions.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionupdate_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
}
}
)
Includes all client authentication related information.
Details for ClientAuthentication using SASL.
Details for SASL/SCRAM client authentication.
SASL/SCRAM authentication is enabled or not.
Indicates whether IAM access control is enabled.
Indicates whether IAM access control is enabled.
Details for ClientAuthentication using TLS.
List of ACM Certificate Authority ARNs.
Specifies whether you want to turn on or turn off TLS authentication.
Contains information about unauthenticated traffic to the cluster.
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
[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.
Includes all encryption-related information.
The data-volume encryption details.
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.
The details for encryption in transit.
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.
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.
dict
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.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.ServiceUnavailableExceptionKafka.Client.exceptions.TooManyRequestsExceptionupdate_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
)
[REQUIRED]
The Amazon Resource Name (ARN) of the cluster to be updated.
[REQUIRED]
The version of cluster to update from. A successful operation will then generate a new version.
EBS volume provisioned throughput information.
Provisioned throughput is enabled or not.
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
dict
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.BadRequestExceptionKafka.Client.exceptions.UnauthorizedExceptionKafka.Client.exceptions.InternalServerErrorExceptionKafka.Client.exceptions.ForbiddenExceptionKafka.Client.exceptions.NotFoundExceptionKafka.Client.exceptions.ServiceUnavailableExceptionKafka.Client.exceptions.TooManyRequestsExceptionThe available paginators are:
Kafka.Paginator.ListClusterOperationsKafka.Paginator.ListClustersKafka.Paginator.ListClustersV2Kafka.Paginator.ListConfigurationRevisionsKafka.Paginator.ListConfigurationsKafka.Paginator.ListKafkaVersionsKafka.Paginator.ListNodesKafka.Paginator.ListScramSecretsKafka.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'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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'
}
},
'StorageMode': 'LOCAL'|'TIERED'
},
'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'
}
},
'StorageMode': 'LOCAL'|'TIERED'
}
},
],
}
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.
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.
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.
StorageMode (string) --
This controls storage mode for supported storage tiers.
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.
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.
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.
StorageMode (string) --
This controls storage mode for supported storage tiers.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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'
}
}
},
'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'
},
],
}
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.
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.
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.
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.
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) --
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) --
Tags (dict) --
Tags attached to 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 zookeeper cluster on Tls port.
StorageMode (string) --
This controls storage mode for supported storage tiers.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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'
}
}
},
'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'
},
'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.
Tags (dict) --
Tags attached to the cluster.
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.
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.
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.
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.
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.
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.
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.
SecurityGroupIds (list) --
The IDs of the security groups associated with the cluster.
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.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'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'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
200 response
An array of MSK configurations.
Represents an MSK Configuration.
The Amazon Resource Name (ARN) of the configuration.
The time when the configuration was created.
The description of the configuration.
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.
Latest revision of the configuration.
The time when the configuration revision was created.
The description of the configuration revision.
The revision number.
The name of the configuration.
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'KafkaVersions': [
{
'Version': 'string',
'Status': 'ACTIVE'|'DEPRECATED'
},
],
}
Response Structure
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'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'NodeInfoList': [
{
'AddedToClusterTime': 'string',
'BrokerNodeInfo': {
'AttachedENIId': 'string',
'BrokerId': 123.0,
'ClientSubnet': 'string',
'ClientVpcIpAddress': 'string',
'CurrentBrokerSoftwareInfo': {
'ConfigurationArn': 'string',
'ConfigurationRevision': 123,
'KafkaVersion': 'string'
},
'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.
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.
ZookeeperId (float) --
The role-specific ID for Zookeeper.
ZookeeperVersion (string) --
The version of Zookeeper.
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'
}
)
[REQUIRED]
The arn of the cluster.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SecretArnList': [
'string',
]
}
Response Structure
(dict) --
200 response
SecretArnList (list) --
The list of scram secrets associated with the cluster.