AWS API Changes

2022/01/27 - Managed Streaming for Kafka - 9 updated api methods

Changes Amazon MSK has updated the CreateCluster and UpdateBrokerStorage API that allows you to specify volume throughput during cluster creation and broker volume updates.

CreateCluster (updated)

Link ¶
Changes (request)

{'BrokerNodeGroupInfo': {'StorageInfo': {'EbsStorageInfo': {'ProvisionedThroughput': {'Enabled': 'boolean',
                                                                                      'VolumeThroughput': 'integer'}}}}}

Creates a new MSK cluster.

See also: AWS API Documentation

Request Syntax

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'
    }
)

type BrokerNodeGroupInfo

dict

param BrokerNodeGroupInfo

[REQUIRED]

Information about the broker nodes in the cluster.

BrokerAZDistribution (string) --

The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
ClientSubnets (list) -- [REQUIRED]

The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.
- (string) --
InstanceType (string) -- [REQUIRED]

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

The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
- (string) --
StorageInfo (dict) --

Contains information about storage volumes attached to MSK broker nodes.
- EbsStorageInfo (dict) --
  
  EBS volume information.
  - ProvisionedThroughput (dict) -- EBS volume provisioned throughput information.
    - Enabled (boolean) -- Provisioned throughput is enabled or not.
    - VolumeThroughput (integer) -- Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
  - VolumeSize (integer) --
    
    The size in GiB of the EBS volume for the data drive on each broker node.
ConnectivityInfo (dict) --

Information about the broker access configuration.
- PublicAccess (dict) --
  
  Public access control for brokers.
  - Type (string) --
    
    The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.

type ClientAuthentication

dict

param ClientAuthentication

Includes all client authentication related information.

Sasl (dict) --

Details for ClientAuthentication using SASL.
- Scram (dict) --
  
  Details for SASL/SCRAM client authentication.
  - Enabled (boolean) --
    
    SASL/SCRAM authentication is enabled or not.
- Iam (dict) --
  
  Indicates whether IAM access control is enabled.
  - Enabled (boolean) --
    
    Indicates whether IAM access control is enabled.
Tls (dict) --

Details for ClientAuthentication using TLS.
- CertificateAuthorityArnList (list) --
  
  List of ACM Certificate Authority ARNs.
  - (string) --
- Enabled (boolean) --
  
  Specifies whether you want to turn on or turn off TLS authentication.
Unauthenticated (dict) --

Contains information about unauthenticated traffic to the cluster.
- Enabled (boolean) --
  
  Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.

type ClusterName

string

param ClusterName

[REQUIRED]

The name of the cluster.

type ConfigurationInfo

dict

param ConfigurationInfo

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

Arn (string) -- [REQUIRED]

ARN of the configuration to use.
Revision (integer) -- [REQUIRED]

The revision of the configuration to use.

type EncryptionInfo

dict

param EncryptionInfo

Includes all encryption-related information.

EncryptionAtRest (dict) --

The data-volume encryption details.
- DataVolumeKMSKeyId (string) -- [REQUIRED]
  
  The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
EncryptionInTransit (dict) --

The details for encryption in transit.
- ClientBroker (string) --
  
  Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
  
  TLS means that client-broker communication is enabled with TLS only.
  
  TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
  
  PLAINTEXT means that client-broker communication is enabled in plaintext only.
  
  The default value is TLS_PLAINTEXT.
- InCluster (boolean) --
  
  When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
  
  The default value is true.

type EnhancedMonitoring

string

param EnhancedMonitoring

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.

type OpenMonitoring

dict

param OpenMonitoring

The settings for open monitoring.

Prometheus (dict) -- [REQUIRED]

Prometheus settings.
- JmxExporter (dict) --
  
  Indicates whether you want to turn on or turn off the JMX Exporter.
  - EnabledInBroker (boolean) -- [REQUIRED]
    
    Indicates whether you want to turn on or turn off the JMX Exporter.
- NodeExporter (dict) --
  
  Indicates whether you want to turn on or turn off the Node Exporter.
  - EnabledInBroker (boolean) -- [REQUIRED]
    
    Indicates whether you want to turn on or turn off the Node Exporter.

type KafkaVersion

string

param KafkaVersion

[REQUIRED]

The version of Apache Kafka.

type LoggingInfo

dict

param LoggingInfo

BrokerLogs (dict) -- [REQUIRED]
- CloudWatchLogs (dict) --
  - Enabled (boolean) -- [REQUIRED]
  - LogGroup (string) --
- Firehose (dict) --
  - DeliveryStream (string) --
  - Enabled (boolean) -- [REQUIRED]
- S3 (dict) --
  - Bucket (string) --
  - Enabled (boolean) -- [REQUIRED]
  - Prefix (string) --

type NumberOfBrokerNodes

integer

param NumberOfBrokerNodes

[REQUIRED]

The number of broker nodes in the cluster.

type Tags

dict

param Tags

Create tags when creating the cluster.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'ClusterArn': 'string',
    'ClusterName': 'string',
    'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING'
}

Response Structure

(dict) --
- ClusterArn (string) --
  
  The Amazon Resource Name (ARN) of the cluster.
- ClusterName (string) --
  
  The name of the MSK cluster.
- State (string) --
  
  The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

CreateClusterV2 (updated)

Link ¶
Changes (request)

{'Provisioned': {'BrokerNodeGroupInfo': {'StorageInfo': {'EbsStorageInfo': {'ProvisionedThroughput': {'Enabled': 'boolean',
                                                                                                      'VolumeThroughput': 'integer'}}}}}}

Creates a new MSK cluster.

See also: AWS API Documentation

Request Syntax

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
    },
    Serverless={
        'VpcConfigs': [
            {
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
        ],
        'ClientAuthentication': {
            'Sasl': {
                'Iam': {
                    'Enabled': True|False
                }
            }
        }
    }
)

type ClusterName

string

param ClusterName

[REQUIRED]

The name of the cluster.

type Tags

dict

param Tags

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

(string) --
- (string) --

type Provisioned

dict

param Provisioned

Information about the provisioned cluster.

BrokerNodeGroupInfo (dict) -- [REQUIRED]

Information about the brokers.
- BrokerAZDistribution (string) --
  
  The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
  
  Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
- ClientSubnets (list) -- [REQUIRED]
  
  The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.
  - (string) --
- InstanceType (string) -- [REQUIRED]
  
  The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
- SecurityGroups (list) --
  
  The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
  - (string) --
- StorageInfo (dict) --
  
  Contains information about storage volumes attached to MSK broker nodes.
  - EbsStorageInfo (dict) --
    
    EBS volume information.
    - ProvisionedThroughput (dict) -- EBS volume provisioned throughput information.
      - Enabled (boolean) -- Provisioned throughput is enabled or not.
      - VolumeThroughput (integer) -- Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
    - VolumeSize (integer) --
      
      The size in GiB of the EBS volume for the data drive on each broker node.
- ConnectivityInfo (dict) --
  
  Information about the broker access configuration.
  - PublicAccess (dict) --
    
    Public access control for brokers.
    - Type (string) --
      
      The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
ClientAuthentication (dict) --

Includes all client authentication information.
- Sasl (dict) --
  
  Details for ClientAuthentication using SASL.
  - Scram (dict) --
    
    Details for SASL/SCRAM client authentication.
    - Enabled (boolean) --
      
      SASL/SCRAM authentication is enabled or not.
  - Iam (dict) --
    
    Indicates whether IAM access control is enabled.
    - Enabled (boolean) --
      
      Indicates whether IAM access control is enabled.
- Tls (dict) --
  
  Details for ClientAuthentication using TLS.
  - CertificateAuthorityArnList (list) --
    
    List of ACM Certificate Authority ARNs.
    - (string) --
  - Enabled (boolean) --
    
    Specifies whether you want to turn on or turn off TLS authentication.
- Unauthenticated (dict) --
  
  Contains information about unauthenticated traffic to the cluster.
  - Enabled (boolean) --
    
    Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
ConfigurationInfo (dict) --

Represents the configuration that you want Amazon MSK to use for the brokers in a cluster.
- Arn (string) -- [REQUIRED]
  
  ARN of the configuration to use.
- Revision (integer) -- [REQUIRED]
  
  The revision of the configuration to use.
EncryptionInfo (dict) --

Includes all encryption-related information.
- EncryptionAtRest (dict) --
  
  The data-volume encryption details.
  - DataVolumeKMSKeyId (string) -- [REQUIRED]
    
    The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
- EncryptionInTransit (dict) --
  
  The details for encryption in transit.
  - ClientBroker (string) --
    
    Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
    
    TLS means that client-broker communication is enabled with TLS only.
    
    TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    
    PLAINTEXT means that client-broker communication is enabled in plaintext only.
    
    The default value is TLS_PLAINTEXT.
  - InCluster (boolean) --
    
    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
    
    The default value is true.
EnhancedMonitoring (string) --

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
OpenMonitoring (dict) --

The settings for open monitoring.
- Prometheus (dict) -- [REQUIRED]
  
  Prometheus settings.
  - JmxExporter (dict) --
    
    Indicates whether you want to turn on or turn off the JMX Exporter.
    - EnabledInBroker (boolean) -- [REQUIRED]
      
      Indicates whether you want to turn on or turn off the JMX Exporter.
  - NodeExporter (dict) --
    
    Indicates whether you want to turn on or turn off the Node Exporter.
    - EnabledInBroker (boolean) -- [REQUIRED]
      
      Indicates whether you want to turn on or turn off the Node Exporter.
KafkaVersion (string) -- [REQUIRED]

The Apache Kafka version that you want for the cluster.
LoggingInfo (dict) --

Log delivery information for the cluster.
- BrokerLogs (dict) -- [REQUIRED]
  - CloudWatchLogs (dict) --
    - Enabled (boolean) -- [REQUIRED]
    - LogGroup (string) --
  - Firehose (dict) --
    - DeliveryStream (string) --
    - Enabled (boolean) -- [REQUIRED]
  - S3 (dict) --
    - Bucket (string) --
    - Enabled (boolean) -- [REQUIRED]
    - Prefix (string) --
NumberOfBrokerNodes (integer) -- [REQUIRED]

The number of broker nodes in the cluster.

type Serverless

dict

param Serverless

Information about the serverless cluster.

VpcConfigs (list) -- [REQUIRED]

The configuration of the Amazon VPCs for the cluster.
- (dict) --
  
  The configuration of the Amazon VPCs for the cluster.
  - SubnetIds (list) -- [REQUIRED]
    
    The IDs of the subnets associated with the cluster.
    - (string) --
  - SecurityGroupIds (list) --
    
    The IDs of the security groups associated with the cluster.
    - (string) --
ClientAuthentication (dict) --

Includes all client authentication information.
- Sasl (dict) --
  
  Details for ClientAuthentication using SASL.
  - Iam (dict) --
    
    Indicates whether IAM access control is enabled.
    - Enabled (boolean) --
      
      Indicates whether IAM access control is enabled.

rtype

dict

returns

Response Syntax

{
    'ClusterArn': 'string',
    'ClusterName': 'string',
    'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING',
    'ClusterType': 'PROVISIONED'|'SERVERLESS'
}

Response Structure

(dict) --
- ClusterArn (string) --
  
  The Amazon Resource Name (ARN) of the cluster.
- ClusterName (string) --
  
  The name of the MSK cluster.
- State (string) --
  
  The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
- ClusterType (string) --
  
  The type of the cluster. The possible states are PROVISIONED or SERVERLESS.

DescribeCluster (updated)

Link ¶
Changes (response)

{'ClusterInfo': {'BrokerNodeGroupInfo': {'StorageInfo': {'EbsStorageInfo': {'ProvisionedThroughput': {'Enabled': 'boolean',
                                                                                                      'VolumeThroughput': 'integer'}}}}}}

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

See also: AWS API Documentation

Request Syntax

client.describe_cluster(
    ClusterArn='string'
)

type ClusterArn

string

param ClusterArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'ClusterInfo': {
        'ActiveOperationArn': 'string',
        'BrokerNodeGroupInfo': {
            'BrokerAZDistribution': 'DEFAULT',
            'ClientSubnets': [
                'string',
            ],
            'InstanceType': 'string',
            'SecurityGroups': [
                'string',
            ],
            'StorageInfo': {
                'EbsStorageInfo': {
                    'ProvisionedThroughput': {
                        'Enabled': True|False,
                        'VolumeThroughput': 123
                    },
                    'VolumeSize': 123
                }
            },
            'ConnectivityInfo': {
                'PublicAccess': {
                    'Type': 'string'
                }
            }
        },
        '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'
    }
}

Response Structure

(dict) --

Successful response.
- ClusterInfo (dict) --
  
  The cluster information.
  - ActiveOperationArn (string) --
    
    Arn of active cluster operation.
  - BrokerNodeGroupInfo (dict) --
    
    Information about the broker nodes.
    - BrokerAZDistribution (string) --
      
      The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
      
      Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
    - ClientSubnets (list) --
      
      The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.
      - (string) --
    - InstanceType (string) --
      
      The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
    - SecurityGroups (list) --
      
      The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
      - (string) --
    - StorageInfo (dict) --
      
      Contains information about storage volumes attached to MSK broker nodes.
      - EbsStorageInfo (dict) --
        
        EBS volume information.
        
        ProvisionedThroughput (dict) -- EBS volume provisioned throughput information.
        
        Enabled (boolean) -- Provisioned throughput is enabled or not.
        
        VolumeThroughput (integer) -- Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
        
        VolumeSize (integer) --
        
        The size in GiB of the EBS volume for the data drive on each broker node.
    - ConnectivityInfo (dict) --
      
      Information about the broker access configuration.
      - PublicAccess (dict) --
        
        Public access control for brokers.
        
        Type (string) --
        
        The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
  - ClientAuthentication (dict) --
    
    Includes all client authentication information.
    - Sasl (dict) --
      
      Details for ClientAuthentication using SASL.
      - Scram (dict) --
        
        Details for SASL/SCRAM client authentication.
        
        Enabled (boolean) --
        
        SASL/SCRAM authentication is enabled or not.
      - Iam (dict) --
        
        Indicates whether IAM access control is enabled.
        
        Enabled (boolean) --
        
        Indicates whether IAM access control is enabled.
    - Tls (dict) --
      
      Details for ClientAuthentication using TLS.
      - CertificateAuthorityArnList (list) --
        
        List of ACM Certificate Authority ARNs.
        
        (string) --
      - Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off TLS authentication.
    - Unauthenticated (dict) --
      
      Contains information about unauthenticated traffic to the cluster.
      - Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
  - ClusterArn (string) --
    
    The Amazon Resource Name (ARN) that uniquely identifies the cluster.
  - ClusterName (string) --
    
    The name of the cluster.
  - CreationTime (datetime) --
    
    The time when the cluster was created.
  - CurrentBrokerSoftwareInfo (dict) --
    
    Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.
    - ConfigurationArn (string) --
      
      The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
    - ConfigurationRevision (integer) --
      
      The revision of the configuration to use. This field isn't visible in this preview release.
    - KafkaVersion (string) --
      
      The version of Apache Kafka.
  - CurrentVersion (string) --
    
    The current version of the MSK cluster.
  - EncryptionInfo (dict) --
    
    Includes all encryption-related information.
    - EncryptionAtRest (dict) --
      
      The data-volume encryption details.
      - DataVolumeKMSKeyId (string) --
        
        The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
    - EncryptionInTransit (dict) --
      
      The details for encryption in transit.
      - ClientBroker (string) --
        
        Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
        
        TLS means that client-broker communication is enabled with TLS only.
        
        TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
        
        PLAINTEXT means that client-broker communication is enabled in plaintext only.
        
        The default value is TLS_PLAINTEXT.
      - InCluster (boolean) --
        
        When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
        
        The default value is true.
  - EnhancedMonitoring (string) --
    
    Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring .
  - OpenMonitoring (dict) --
    
    Settings for open monitoring using Prometheus.
    - Prometheus (dict) --
      
      Prometheus settings.
      - JmxExporter (dict) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
      - NodeExporter (dict) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
  - LoggingInfo (dict) --
    - BrokerLogs (dict) --
      - CloudWatchLogs (dict) --
        
        Enabled (boolean) --
        
        LogGroup (string) --
      - Firehose (dict) --
        
        DeliveryStream (string) --
        
        Enabled (boolean) --
      - S3 (dict) --
        
        Bucket (string) --
        
        Enabled (boolean) --
        
        Prefix (string) --
  - NumberOfBrokerNodes (integer) --
    
    The number of broker nodes in the cluster.
  - State (string) --
    
    The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
  - StateInfo (dict) --
    - Code (string) --
    - Message (string) --
  - Tags (dict) --
    
    Tags attached to the cluster.
    - (string) --
      - (string) --
  - ZookeeperConnectString (string) --
    
    The connection string to use to connect to the Apache ZooKeeper cluster.
  - ZookeeperConnectStringTls (string) --
    
    The connection string to use to connect to zookeeper cluster on Tls port.

DescribeClusterV2 (updated)

Link ¶
Changes (response)

{'ClusterInfo': {'Provisioned': {'BrokerNodeGroupInfo': {'StorageInfo': {'EbsStorageInfo': {'ProvisionedThroughput': {'Enabled': 'boolean',
                                                                                                                      'VolumeThroughput': 'integer'}}}}}}}

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

See also: AWS API Documentation

Request Syntax

client.describe_cluster_v2(
    ClusterArn='string'
)

type ClusterArn

string

param ClusterArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'ClusterInfo': {
        'ActiveOperationArn': 'string',
        'ClusterType': 'PROVISIONED'|'SERVERLESS',
        'ClusterArn': 'string',
        'ClusterName': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'CurrentVersion': 'string',
        'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING',
        'StateInfo': {
            'Code': 'string',
            'Message': 'string'
        },
        'Tags': {
            'string': 'string'
        },
        'Provisioned': {
            'BrokerNodeGroupInfo': {
                'BrokerAZDistribution': 'DEFAULT',
                'ClientSubnets': [
                    'string',
                ],
                'InstanceType': 'string',
                'SecurityGroups': [
                    'string',
                ],
                'StorageInfo': {
                    'EbsStorageInfo': {
                        'ProvisionedThroughput': {
                            'Enabled': True|False,
                            'VolumeThroughput': 123
                        },
                        'VolumeSize': 123
                    }
                },
                'ConnectivityInfo': {
                    'PublicAccess': {
                        'Type': 'string'
                    }
                }
            },
            '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'
        },
        'Serverless': {
            'VpcConfigs': [
                {
                    'SubnetIds': [
                        'string',
                    ],
                    'SecurityGroupIds': [
                        'string',
                    ]
                },
            ],
            'ClientAuthentication': {
                'Sasl': {
                    'Iam': {
                        'Enabled': True|False
                    }
                }
            }
        }
    }
}

Response Structure

(dict) --

Successful response.
- ClusterInfo (dict) --
  
  The cluster information.
  - ActiveOperationArn (string) --
    
    The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
  - ClusterType (string) --
    
    Cluster Type.
  - ClusterArn (string) --
    
    The Amazon Resource Name (ARN) that uniquely identifies the cluster.
  - ClusterName (string) --
    
    The name of the cluster.
  - CreationTime (datetime) --
    
    The time when the cluster was created.
  - CurrentVersion (string) --
    
    The current version of the MSK cluster.
  - State (string) --
    
    The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
  - StateInfo (dict) --
    
    State Info for the Amazon MSK cluster.
    - Code (string) --
    - Message (string) --
  - Tags (dict) --
    
    Tags attached to the cluster.
    - (string) --
      - (string) --
  - Provisioned (dict) --
    
    Information about the provisioned cluster.
    - BrokerNodeGroupInfo (dict) --
      
      Information about the brokers.
      - BrokerAZDistribution (string) --
        
        The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
        
        Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
      - ClientSubnets (list) --
        
        The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.
        
        (string) --
      - InstanceType (string) --
        
        The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
      - SecurityGroups (list) --
        
        The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
        
        (string) --
      - StorageInfo (dict) --
        
        Contains information about storage volumes attached to MSK broker nodes.
        
        EbsStorageInfo (dict) --
        
        EBS volume information.
        
        ProvisionedThroughput (dict) -- EBS volume provisioned throughput information.
        
        Enabled (boolean) -- Provisioned throughput is enabled or not.
        
        VolumeThroughput (integer) -- Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
        
        VolumeSize (integer) --
        
        The size in GiB of the EBS volume for the data drive on each broker node.
      - ConnectivityInfo (dict) --
        
        Information about the broker access configuration.
        
        PublicAccess (dict) --
        
        Public access control for brokers.
        
        Type (string) --
        
        The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
    - CurrentBrokerSoftwareInfo (dict) --
      
      Information about the Apache Kafka version deployed on the brokers.
      - ConfigurationArn (string) --
        
        The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
      - ConfigurationRevision (integer) --
        
        The revision of the configuration to use. This field isn't visible in this preview release.
      - KafkaVersion (string) --
        
        The version of Apache Kafka.
    - ClientAuthentication (dict) --
      
      Includes all client authentication information.
      - Sasl (dict) --
        
        Details for ClientAuthentication using SASL.
        
        Scram (dict) --
        
        Details for SASL/SCRAM client authentication.
        
        Enabled (boolean) --
        
        SASL/SCRAM authentication is enabled or not.
        
        Iam (dict) --
        
        Indicates whether IAM access control is enabled.
        
        Enabled (boolean) --
        
        Indicates whether IAM access control is enabled.
      - Tls (dict) --
        
        Details for ClientAuthentication using TLS.
        
        CertificateAuthorityArnList (list) --
        
        List of ACM Certificate Authority ARNs.
        
        (string) --
        
        Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off TLS authentication.
      - Unauthenticated (dict) --
        
        Contains information about unauthenticated traffic to the cluster.
        
        Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
    - EncryptionInfo (dict) --
      
      Includes all encryption-related information.
      - EncryptionAtRest (dict) --
        
        The data-volume encryption details.
        
        DataVolumeKMSKeyId (string) --
        
        The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
      - EncryptionInTransit (dict) --
        
        The details for encryption in transit.
        
        ClientBroker (string) --
        
        Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
        
        TLS means that client-broker communication is enabled with TLS only.
        
        TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
        
        PLAINTEXT means that client-broker communication is enabled in plaintext only.
        
        The default value is TLS_PLAINTEXT.
        
        InCluster (boolean) --
        
        When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
        
        The default value is true.
    - EnhancedMonitoring (string) --
      
      Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
    - OpenMonitoring (dict) --
      
      The settings for open monitoring.
      - Prometheus (dict) --
        
        Prometheus settings.
        
        JmxExporter (dict) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
        
        NodeExporter (dict) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
    - LoggingInfo (dict) --
      
      Log delivery information for the cluster.
      - BrokerLogs (dict) --
        
        CloudWatchLogs (dict) --
        
        Enabled (boolean) --
        
        LogGroup (string) --
        
        Firehose (dict) --
        
        DeliveryStream (string) --
        
        Enabled (boolean) --
        
        S3 (dict) --
        
        Bucket (string) --
        
        Enabled (boolean) --
        
        Prefix (string) --
    - NumberOfBrokerNodes (integer) --
      
      The number of broker nodes in the cluster.
    - ZookeeperConnectString (string) --
      
      The connection string to use to connect to the Apache ZooKeeper cluster.
    - ZookeeperConnectStringTls (string) --
      
      The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.
  - Serverless (dict) --
    
    Information about the serverless cluster.
    - VpcConfigs (list) --
      
      The configuration of the Amazon VPCs for the cluster.
      - (dict) --
        
        The configuration of the Amazon VPCs for the cluster.
        
        SubnetIds (list) --
        
        The IDs of the subnets associated with the cluster.
        
        (string) --
        
        SecurityGroupIds (list) --
        
        The IDs of the security groups associated with the cluster.
        
        (string) --
    - ClientAuthentication (dict) --
      
      Includes all client authentication information.
      - Sasl (dict) --
        
        Details for ClientAuthentication using SASL.
        
        Iam (dict) --
        
        Indicates whether IAM access control is enabled.
        
        Enabled (boolean) --
        
        Indicates whether IAM access control is enabled.

DescribeClusterOperation (updated)

Link ¶
Changes (response)

{'ClusterOperationInfo': {'SourceClusterInfo': {'BrokerEBSVolumeInfo': {'ProvisionedThroughput': {'Enabled': 'boolean',
                                                                                                  'VolumeThroughput': 'integer'}}},
                          'TargetClusterInfo': {'BrokerEBSVolumeInfo': {'ProvisionedThroughput': {'Enabled': 'boolean',
                                                                                                  'VolumeThroughput': 'integer'}}}}}

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

See also: AWS API Documentation

Request Syntax

client.describe_cluster_operation(
    ClusterOperationArn='string'
)

type ClusterOperationArn

string

param ClusterOperationArn

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'ClusterOperationInfo': {
        'ClientRequestId': 'string',
        'ClusterArn': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'ErrorInfo': {
            'ErrorCode': 'string',
            'ErrorString': 'string'
        },
        'OperationArn': 'string',
        'OperationState': 'string',
        'OperationSteps': [
            {
                'StepInfo': {
                    'StepStatus': 'string'
                },
                'StepName': 'string'
            },
        ],
        'OperationType': 'string',
        'SourceClusterInfo': {
            'BrokerEBSVolumeInfo': [
                {
                    'KafkaBrokerNodeId': 'string',
                    'ProvisionedThroughput': {
                        'Enabled': True|False,
                        'VolumeThroughput': 123
                    },
                    'VolumeSizeGB': 123
                },
            ],
            'ConfigurationInfo': {
                'Arn': 'string',
                'Revision': 123
            },
            'NumberOfBrokerNodes': 123,
            'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
            'OpenMonitoring': {
                'Prometheus': {
                    'JmxExporter': {
                        'EnabledInBroker': True|False
                    },
                    'NodeExporter': {
                        'EnabledInBroker': True|False
                    }
                }
            },
            'KafkaVersion': 'string',
            'LoggingInfo': {
                'BrokerLogs': {
                    'CloudWatchLogs': {
                        'Enabled': True|False,
                        'LogGroup': 'string'
                    },
                    'Firehose': {
                        'DeliveryStream': 'string',
                        'Enabled': True|False
                    },
                    'S3': {
                        'Bucket': 'string',
                        'Enabled': True|False,
                        'Prefix': 'string'
                    }
                }
            },
            'InstanceType': 'string',
            'ClientAuthentication': {
                'Sasl': {
                    'Scram': {
                        'Enabled': True|False
                    },
                    'Iam': {
                        'Enabled': True|False
                    }
                },
                'Tls': {
                    'CertificateAuthorityArnList': [
                        'string',
                    ],
                    'Enabled': True|False
                },
                'Unauthenticated': {
                    'Enabled': True|False
                }
            },
            'EncryptionInfo': {
                'EncryptionAtRest': {
                    'DataVolumeKMSKeyId': 'string'
                },
                'EncryptionInTransit': {
                    'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
                    'InCluster': True|False
                }
            },
            'ConnectivityInfo': {
                'PublicAccess': {
                    'Type': 'string'
                }
            }
        },
        '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'
                }
            }
        }
    }
}

Response Structure

(dict) --

200 response
- ClusterOperationInfo (dict) --
  
  Cluster operation information
  - ClientRequestId (string) --
    
    The ID of the API request that triggered this operation.
  - ClusterArn (string) --
    
    ARN of the cluster.
  - CreationTime (datetime) --
    
    The time that the operation was created.
  - EndTime (datetime) --
    
    The time at which the operation finished.
  - ErrorInfo (dict) --
    
    Describes the error if the operation fails.
    - ErrorCode (string) --
      
      A number describing the error programmatically.
    - ErrorString (string) --
      
      An optional field to provide more details about the error.
  - OperationArn (string) --
    
    ARN of the cluster operation.
  - OperationState (string) --
    
    State of the cluster operation.
  - OperationSteps (list) --
    
    Steps completed during the operation.
    - (dict) --
      
      Step taken during a cluster operation.
      - StepInfo (dict) --
        
        Information about the step and its status.
        
        StepStatus (string) --
        
        The steps current status.
      - StepName (string) --
        
        The name of the step.
  - OperationType (string) --
    
    Type of the cluster operation.
  - SourceClusterInfo (dict) --
    
    Information about cluster attributes before a cluster is updated.
    - BrokerEBSVolumeInfo (list) --
      
      Specifies the size of the EBS volume and the ID of the associated broker.
      - (dict) --
        
        Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.
        
        KafkaBrokerNodeId (string) --
        
        The ID of the broker to update.
        
        ProvisionedThroughput (dict) -- EBS volume provisioned throughput information.
        
        Enabled (boolean) -- Provisioned throughput is enabled or not.
        
        VolumeThroughput (integer) -- Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
        
        VolumeSizeGB (integer) --
        
        Size of the EBS volume to update.
    - ConfigurationInfo (dict) --
      
      Information about the changes in the configuration of the brokers.
      - Arn (string) --
        
        ARN of the configuration to use.
      - Revision (integer) --
        
        The revision of the configuration to use.
    - NumberOfBrokerNodes (integer) --
      
      The number of broker nodes in the cluster.
    - EnhancedMonitoring (string) --
      
      Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
    - OpenMonitoring (dict) --
      
      The settings for open monitoring.
      - Prometheus (dict) --
        
        Prometheus settings.
        
        JmxExporter (dict) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
        
        NodeExporter (dict) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
    - KafkaVersion (string) --
      
      The Apache Kafka version.
    - LoggingInfo (dict) --
      
      You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
      - BrokerLogs (dict) --
        
        CloudWatchLogs (dict) --
        
        Enabled (boolean) --
        
        LogGroup (string) --
        
        Firehose (dict) --
        
        DeliveryStream (string) --
        
        Enabled (boolean) --
        
        S3 (dict) --
        
        Bucket (string) --
        
        Enabled (boolean) --
        
        Prefix (string) --
    - InstanceType (string) --
      
      Information about the Amazon MSK broker type.
    - ClientAuthentication (dict) --
      
      Includes all client authentication information.
      - Sasl (dict) --
        
        Details for ClientAuthentication using SASL.
        
        Scram (dict) --
        
        Details for SASL/SCRAM client authentication.
        
        Enabled (boolean) --
        
        SASL/SCRAM authentication is enabled or not.
        
        Iam (dict) --
        
        Indicates whether IAM access control is enabled.
        
        Enabled (boolean) --
        
        Indicates whether IAM access control is enabled.
      - Tls (dict) --
        
        Details for ClientAuthentication using TLS.
        
        CertificateAuthorityArnList (list) --
        
        List of ACM Certificate Authority ARNs.
        
        (string) --
        
        Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off TLS authentication.
      - Unauthenticated (dict) --
        
        Contains information about unauthenticated traffic to the cluster.
        
        Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
    - EncryptionInfo (dict) --
      
      Includes all encryption-related information.
      - EncryptionAtRest (dict) --
        
        The data-volume encryption details.
        
        DataVolumeKMSKeyId (string) --
        
        The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
      - EncryptionInTransit (dict) --
        
        The details for encryption in transit.
        
        ClientBroker (string) --
        
        Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
        
        TLS means that client-broker communication is enabled with TLS only.
        
        TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
        
        PLAINTEXT means that client-broker communication is enabled in plaintext only.
        
        The default value is TLS_PLAINTEXT.
        
        InCluster (boolean) --
        
        When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
        
        The default value is true.
    - ConnectivityInfo (dict) --
      
      Information about the broker access configuration.
      - PublicAccess (dict) --
        
        Public access control for brokers.
        
        Type (string) --
        
        The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
  - TargetClusterInfo (dict) --
    
    Information about cluster attributes after a cluster is updated.
    - BrokerEBSVolumeInfo (list) --
      
      Specifies the size of the EBS volume and the ID of the associated broker.
      - (dict) --
        
        Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.
        
        KafkaBrokerNodeId (string) --
        
        The ID of the broker to update.
        
        ProvisionedThroughput (dict) -- EBS volume provisioned throughput information.
        
        Enabled (boolean) -- Provisioned throughput is enabled or not.
        
        VolumeThroughput (integer) -- Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
        
        VolumeSizeGB (integer) --
        
        Size of the EBS volume to update.
    - ConfigurationInfo (dict) --
      
      Information about the changes in the configuration of the brokers.
      - Arn (string) --
        
        ARN of the configuration to use.
      - Revision (integer) --
        
        The revision of the configuration to use.
    - NumberOfBrokerNodes (integer) --
      
      The number of broker nodes in the cluster.
    - EnhancedMonitoring (string) --
      
      Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
    - OpenMonitoring (dict) --
      
      The settings for open monitoring.
      - Prometheus (dict) --
        
        Prometheus settings.
        
        JmxExporter (dict) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
        
        NodeExporter (dict) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
    - KafkaVersion (string) --
      
      The Apache Kafka version.
    - LoggingInfo (dict) --
      
      You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
      - BrokerLogs (dict) --
        
        CloudWatchLogs (dict) --
        
        Enabled (boolean) --
        
        LogGroup (string) --
        
        Firehose (dict) --
        
        DeliveryStream (string) --
        
        Enabled (boolean) --
        
        S3 (dict) --
        
        Bucket (string) --
        
        Enabled (boolean) --
        
        Prefix (string) --
    - InstanceType (string) --
      
      Information about the Amazon MSK broker type.
    - ClientAuthentication (dict) --
      
      Includes all client authentication information.
      - Sasl (dict) --
        
        Details for ClientAuthentication using SASL.
        
        Scram (dict) --
        
        Details for SASL/SCRAM client authentication.
        
        Enabled (boolean) --
        
        SASL/SCRAM authentication is enabled or not.
        
        Iam (dict) --
        
        Indicates whether IAM access control is enabled.
        
        Enabled (boolean) --
        
        Indicates whether IAM access control is enabled.
      - Tls (dict) --
        
        Details for ClientAuthentication using TLS.
        
        CertificateAuthorityArnList (list) --
        
        List of ACM Certificate Authority ARNs.
        
        (string) --
        
        Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off TLS authentication.
      - Unauthenticated (dict) --
        
        Contains information about unauthenticated traffic to the cluster.
        
        Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
    - EncryptionInfo (dict) --
      
      Includes all encryption-related information.
      - EncryptionAtRest (dict) --
        
        The data-volume encryption details.
        
        DataVolumeKMSKeyId (string) --
        
        The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
      - EncryptionInTransit (dict) --
        
        The details for encryption in transit.
        
        ClientBroker (string) --
        
        Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
        
        TLS means that client-broker communication is enabled with TLS only.
        
        TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
        
        PLAINTEXT means that client-broker communication is enabled in plaintext only.
        
        The default value is TLS_PLAINTEXT.
        
        InCluster (boolean) --
        
        When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
        
        The default value is true.
    - ConnectivityInfo (dict) --
      
      Information about the broker access configuration.
      - PublicAccess (dict) --
        
        Public access control for brokers.
        
        Type (string) --
        
        The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.

ListClusterOperations (updated)

Link ¶
Changes (response)

{'ClusterOperationInfoList': {'SourceClusterInfo': {'BrokerEBSVolumeInfo': {'ProvisionedThroughput': {'Enabled': 'boolean',
                                                                                                      'VolumeThroughput': 'integer'}}},
                              'TargetClusterInfo': {'BrokerEBSVolumeInfo': {'ProvisionedThroughput': {'Enabled': 'boolean',
                                                                                                      'VolumeThroughput': 'integer'}}}}}

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

See also: AWS API Documentation

Request Syntax

client.list_cluster_operations(
    ClusterArn='string',
    MaxResults=123,
    NextToken='string'
)

type ClusterArn

string

param ClusterArn

[REQUIRED]

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

type MaxResults

integer

param MaxResults

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

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'ClusterOperationInfoList': [
        {
            'ClientRequestId': 'string',
            'ClusterArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'ErrorInfo': {
                'ErrorCode': 'string',
                'ErrorString': 'string'
            },
            'OperationArn': 'string',
            'OperationState': 'string',
            'OperationSteps': [
                {
                    'StepInfo': {
                        'StepStatus': 'string'
                    },
                    'StepName': 'string'
                },
            ],
            'OperationType': 'string',
            'SourceClusterInfo': {
                'BrokerEBSVolumeInfo': [
                    {
                        'KafkaBrokerNodeId': 'string',
                        'ProvisionedThroughput': {
                            'Enabled': True|False,
                            'VolumeThroughput': 123
                        },
                        'VolumeSizeGB': 123
                    },
                ],
                'ConfigurationInfo': {
                    'Arn': 'string',
                    'Revision': 123
                },
                'NumberOfBrokerNodes': 123,
                'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
                'OpenMonitoring': {
                    'Prometheus': {
                        'JmxExporter': {
                            'EnabledInBroker': True|False
                        },
                        'NodeExporter': {
                            'EnabledInBroker': True|False
                        }
                    }
                },
                'KafkaVersion': 'string',
                'LoggingInfo': {
                    'BrokerLogs': {
                        'CloudWatchLogs': {
                            'Enabled': True|False,
                            'LogGroup': 'string'
                        },
                        'Firehose': {
                            'DeliveryStream': 'string',
                            'Enabled': True|False
                        },
                        'S3': {
                            'Bucket': 'string',
                            'Enabled': True|False,
                            'Prefix': 'string'
                        }
                    }
                },
                'InstanceType': 'string',
                'ClientAuthentication': {
                    'Sasl': {
                        'Scram': {
                            'Enabled': True|False
                        },
                        'Iam': {
                            'Enabled': True|False
                        }
                    },
                    'Tls': {
                        'CertificateAuthorityArnList': [
                            'string',
                        ],
                        'Enabled': True|False
                    },
                    'Unauthenticated': {
                        'Enabled': True|False
                    }
                },
                'EncryptionInfo': {
                    'EncryptionAtRest': {
                        'DataVolumeKMSKeyId': 'string'
                    },
                    'EncryptionInTransit': {
                        'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
                        'InCluster': True|False
                    }
                },
                'ConnectivityInfo': {
                    'PublicAccess': {
                        'Type': 'string'
                    }
                }
            },
            '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'
                    }
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Successful response.
- ClusterOperationInfoList (list) --
  
  An array of cluster operation information objects.
  - (dict) --
    
    Returns information about a cluster operation.
    - ClientRequestId (string) --
      
      The ID of the API request that triggered this operation.
    - ClusterArn (string) --
      
      ARN of the cluster.
    - CreationTime (datetime) --
      
      The time that the operation was created.
    - EndTime (datetime) --
      
      The time at which the operation finished.
    - ErrorInfo (dict) --
      
      Describes the error if the operation fails.
      - ErrorCode (string) --
        
        A number describing the error programmatically.
      - ErrorString (string) --
        
        An optional field to provide more details about the error.
    - OperationArn (string) --
      
      ARN of the cluster operation.
    - OperationState (string) --
      
      State of the cluster operation.
    - OperationSteps (list) --
      
      Steps completed during the operation.
      - (dict) --
        
        Step taken during a cluster operation.
        
        StepInfo (dict) --
        
        Information about the step and its status.
        
        StepStatus (string) --
        
        The steps current status.
        
        StepName (string) --
        
        The name of the step.
    - OperationType (string) --
      
      Type of the cluster operation.
    - SourceClusterInfo (dict) --
      
      Information about cluster attributes before a cluster is updated.
      - BrokerEBSVolumeInfo (list) --
        
        Specifies the size of the EBS volume and the ID of the associated broker.
        
        (dict) --
        
        Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.
        
        KafkaBrokerNodeId (string) --
        
        The ID of the broker to update.
        
        ProvisionedThroughput (dict) -- EBS volume provisioned throughput information.
        
        Enabled (boolean) -- Provisioned throughput is enabled or not.
        
        VolumeThroughput (integer) -- Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
        
        VolumeSizeGB (integer) --
        
        Size of the EBS volume to update.
      - ConfigurationInfo (dict) --
        
        Information about the changes in the configuration of the brokers.
        
        Arn (string) --
        
        ARN of the configuration to use.
        
        Revision (integer) --
        
        The revision of the configuration to use.
      - NumberOfBrokerNodes (integer) --
        
        The number of broker nodes in the cluster.
      - EnhancedMonitoring (string) --
        
        Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
      - OpenMonitoring (dict) --
        
        The settings for open monitoring.
        
        Prometheus (dict) --
        
        Prometheus settings.
        
        JmxExporter (dict) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
        
        NodeExporter (dict) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
      - KafkaVersion (string) --
        
        The Apache Kafka version.
      - LoggingInfo (dict) --
        
        You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
        
        BrokerLogs (dict) --
        
        CloudWatchLogs (dict) --
        
        Enabled (boolean) --
        
        LogGroup (string) --
        
        Firehose (dict) --
        
        DeliveryStream (string) --
        
        Enabled (boolean) --
        
        S3 (dict) --
        
        Bucket (string) --
        
        Enabled (boolean) --
        
        Prefix (string) --
      - InstanceType (string) --
        
        Information about the Amazon MSK broker type.
      - ClientAuthentication (dict) --
        
        Includes all client authentication information.
        
        Sasl (dict) --
        
        Details for ClientAuthentication using SASL.
        
        Scram (dict) --
        
        Details for SASL/SCRAM client authentication.
        
        Enabled (boolean) --
        
        SASL/SCRAM authentication is enabled or not.
        
        Iam (dict) --
        
        Indicates whether IAM access control is enabled.
        
        Enabled (boolean) --
        
        Indicates whether IAM access control is enabled.
        
        Tls (dict) --
        
        Details for ClientAuthentication using TLS.
        
        CertificateAuthorityArnList (list) --
        
        List of ACM Certificate Authority ARNs.
        
        (string) --
        
        Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off TLS authentication.
        
        Unauthenticated (dict) --
        
        Contains information about unauthenticated traffic to the cluster.
        
        Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
      - EncryptionInfo (dict) --
        
        Includes all encryption-related information.
        
        EncryptionAtRest (dict) --
        
        The data-volume encryption details.
        
        DataVolumeKMSKeyId (string) --
        
        The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
        
        EncryptionInTransit (dict) --
        
        The details for encryption in transit.
        
        ClientBroker (string) --
        
        Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
        
        TLS means that client-broker communication is enabled with TLS only.
        
        TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
        
        PLAINTEXT means that client-broker communication is enabled in plaintext only.
        
        The default value is TLS_PLAINTEXT.
        
        InCluster (boolean) --
        
        When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
        
        The default value is true.
      - ConnectivityInfo (dict) --
        
        Information about the broker access configuration.
        
        PublicAccess (dict) --
        
        Public access control for brokers.
        
        Type (string) --
        
        The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
    - TargetClusterInfo (dict) --
      
      Information about cluster attributes after a cluster is updated.
      - BrokerEBSVolumeInfo (list) --
        
        Specifies the size of the EBS volume and the ID of the associated broker.
        
        (dict) --
        
        Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.
        
        KafkaBrokerNodeId (string) --
        
        The ID of the broker to update.
        
        ProvisionedThroughput (dict) -- EBS volume provisioned throughput information.
        
        Enabled (boolean) -- Provisioned throughput is enabled or not.
        
        VolumeThroughput (integer) -- Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
        
        VolumeSizeGB (integer) --
        
        Size of the EBS volume to update.
      - ConfigurationInfo (dict) --
        
        Information about the changes in the configuration of the brokers.
        
        Arn (string) --
        
        ARN of the configuration to use.
        
        Revision (integer) --
        
        The revision of the configuration to use.
      - NumberOfBrokerNodes (integer) --
        
        The number of broker nodes in the cluster.
      - EnhancedMonitoring (string) --
        
        Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
      - OpenMonitoring (dict) --
        
        The settings for open monitoring.
        
        Prometheus (dict) --
        
        Prometheus settings.
        
        JmxExporter (dict) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
        
        NodeExporter (dict) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
      - KafkaVersion (string) --
        
        The Apache Kafka version.
      - LoggingInfo (dict) --
        
        You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
        
        BrokerLogs (dict) --
        
        CloudWatchLogs (dict) --
        
        Enabled (boolean) --
        
        LogGroup (string) --
        
        Firehose (dict) --
        
        DeliveryStream (string) --
        
        Enabled (boolean) --
        
        S3 (dict) --
        
        Bucket (string) --
        
        Enabled (boolean) --
        
        Prefix (string) --
      - InstanceType (string) --
        
        Information about the Amazon MSK broker type.
      - ClientAuthentication (dict) --
        
        Includes all client authentication information.
        
        Sasl (dict) --
        
        Details for ClientAuthentication using SASL.
        
        Scram (dict) --
        
        Details for SASL/SCRAM client authentication.
        
        Enabled (boolean) --
        
        SASL/SCRAM authentication is enabled or not.
        
        Iam (dict) --
        
        Indicates whether IAM access control is enabled.
        
        Enabled (boolean) --
        
        Indicates whether IAM access control is enabled.
        
        Tls (dict) --
        
        Details for ClientAuthentication using TLS.
        
        CertificateAuthorityArnList (list) --
        
        List of ACM Certificate Authority ARNs.
        
        (string) --
        
        Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off TLS authentication.
        
        Unauthenticated (dict) --
        
        Contains information about unauthenticated traffic to the cluster.
        
        Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
      - EncryptionInfo (dict) --
        
        Includes all encryption-related information.
        
        EncryptionAtRest (dict) --
        
        The data-volume encryption details.
        
        DataVolumeKMSKeyId (string) --
        
        The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
        
        EncryptionInTransit (dict) --
        
        The details for encryption in transit.
        
        ClientBroker (string) --
        
        Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
        
        TLS means that client-broker communication is enabled with TLS only.
        
        TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
        
        PLAINTEXT means that client-broker communication is enabled in plaintext only.
        
        The default value is TLS_PLAINTEXT.
        
        InCluster (boolean) --
        
        When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
        
        The default value is true.
      - ConnectivityInfo (dict) --
        
        Information about the broker access configuration.
        
        PublicAccess (dict) --
        
        Public access control for brokers.
        
        Type (string) --
        
        The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
- 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.

ListClusters (updated)

Link ¶
Changes (response)

{'ClusterInfoList': {'BrokerNodeGroupInfo': {'StorageInfo': {'EbsStorageInfo': {'ProvisionedThroughput': {'Enabled': 'boolean',
                                                                                                          'VolumeThroughput': 'integer'}}}}}}

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

See also: AWS API Documentation

Request Syntax

client.list_clusters(
    ClusterNameFilter='string',
    MaxResults=123,
    NextToken='string'
)

type ClusterNameFilter

string

param ClusterNameFilter

Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

type MaxResults

integer

param MaxResults

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

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'ClusterInfoList': [
        {
            'ActiveOperationArn': 'string',
            'BrokerNodeGroupInfo': {
                'BrokerAZDistribution': 'DEFAULT',
                'ClientSubnets': [
                    'string',
                ],
                'InstanceType': 'string',
                'SecurityGroups': [
                    'string',
                ],
                'StorageInfo': {
                    'EbsStorageInfo': {
                        'ProvisionedThroughput': {
                            'Enabled': True|False,
                            'VolumeThroughput': 123
                        },
                        'VolumeSize': 123
                    }
                },
                'ConnectivityInfo': {
                    'PublicAccess': {
                        'Type': 'string'
                    }
                }
            },
            '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'
        },
    ],
    '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 be in Availability Zone us-east-1e.
        
        (string) --
      - InstanceType (string) --
        
        The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
      - SecurityGroups (list) --
        
        The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
        
        (string) --
      - StorageInfo (dict) --
        
        Contains information about storage volumes attached to MSK broker nodes.
        
        EbsStorageInfo (dict) --
        
        EBS volume information.
        
        ProvisionedThroughput (dict) -- EBS volume provisioned throughput information.
        
        Enabled (boolean) -- Provisioned throughput is enabled or not.
        
        VolumeThroughput (integer) -- Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
        
        VolumeSize (integer) --
        
        The size in GiB of the EBS volume for the data drive on each broker node.
      - ConnectivityInfo (dict) --
        
        Information about the broker access configuration.
        
        PublicAccess (dict) --
        
        Public access control for brokers.
        
        Type (string) --
        
        The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
    - ClientAuthentication (dict) --
      
      Includes all client authentication information.
      - Sasl (dict) --
        
        Details for ClientAuthentication using SASL.
        
        Scram (dict) --
        
        Details for SASL/SCRAM client authentication.
        
        Enabled (boolean) --
        
        SASL/SCRAM authentication is enabled or not.
        
        Iam (dict) --
        
        Indicates whether IAM access control is enabled.
        
        Enabled (boolean) --
        
        Indicates whether IAM access control is enabled.
      - Tls (dict) --
        
        Details for ClientAuthentication using TLS.
        
        CertificateAuthorityArnList (list) --
        
        List of ACM Certificate Authority ARNs.
        
        (string) --
        
        Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off TLS authentication.
      - Unauthenticated (dict) --
        
        Contains information about unauthenticated traffic to the cluster.
        
        Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
    - ClusterArn (string) --
      
      The Amazon Resource Name (ARN) that uniquely identifies the cluster.
    - ClusterName (string) --
      
      The name of the cluster.
    - CreationTime (datetime) --
      
      The time when the cluster was created.
    - CurrentBrokerSoftwareInfo (dict) --
      
      Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.
      - ConfigurationArn (string) --
        
        The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
      - ConfigurationRevision (integer) --
        
        The revision of the configuration to use. This field isn't visible in this preview release.
      - KafkaVersion (string) --
        
        The version of Apache Kafka.
    - CurrentVersion (string) --
      
      The current version of the MSK cluster.
    - EncryptionInfo (dict) --
      
      Includes all encryption-related information.
      - EncryptionAtRest (dict) --
        
        The data-volume encryption details.
        
        DataVolumeKMSKeyId (string) --
        
        The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
      - EncryptionInTransit (dict) --
        
        The details for encryption in transit.
        
        ClientBroker (string) --
        
        Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
        
        TLS means that client-broker communication is enabled with TLS only.
        
        TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
        
        PLAINTEXT means that client-broker communication is enabled in plaintext only.
        
        The default value is TLS_PLAINTEXT.
        
        InCluster (boolean) --
        
        When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
        
        The default value is true.
    - EnhancedMonitoring (string) --
      
      Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring .
    - OpenMonitoring (dict) --
      
      Settings for open monitoring using Prometheus.
      - Prometheus (dict) --
        
        Prometheus settings.
        
        JmxExporter (dict) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
        
        NodeExporter (dict) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
    - LoggingInfo (dict) --
      - BrokerLogs (dict) --
        
        CloudWatchLogs (dict) --
        
        Enabled (boolean) --
        
        LogGroup (string) --
        
        Firehose (dict) --
        
        DeliveryStream (string) --
        
        Enabled (boolean) --
        
        S3 (dict) --
        
        Bucket (string) --
        
        Enabled (boolean) --
        
        Prefix (string) --
    - NumberOfBrokerNodes (integer) --
      
      The number of broker nodes in the cluster.
    - State (string) --
      
      The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
    - StateInfo (dict) --
      - Code (string) --
      - Message (string) --
    - Tags (dict) --
      
      Tags attached to the cluster.
      - (string) --
        
        (string) --
    - ZookeeperConnectString (string) --
      
      The connection string to use to connect to the Apache ZooKeeper cluster.
    - ZookeeperConnectStringTls (string) --
      
      The connection string to use to connect to zookeeper cluster on Tls port.
- 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.

ListClustersV2 (updated)

Link ¶
Changes (response)

{'ClusterInfoList': {'Provisioned': {'BrokerNodeGroupInfo': {'StorageInfo': {'EbsStorageInfo': {'ProvisionedThroughput': {'Enabled': 'boolean',
                                                                                                                          'VolumeThroughput': 'integer'}}}}}}}

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

See also: AWS API Documentation

Request Syntax

client.list_clusters_v2(
    ClusterNameFilter='string',
    ClusterTypeFilter='string',
    MaxResults=123,
    NextToken='string'
)

type ClusterNameFilter

string

param ClusterNameFilter

Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

type ClusterTypeFilter

string

param ClusterTypeFilter

Specify either PROVISIONED or SERVERLESS.

type MaxResults

integer

param MaxResults

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

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'ClusterInfoList': [
        {
            'ActiveOperationArn': 'string',
            'ClusterType': 'PROVISIONED'|'SERVERLESS',
            'ClusterArn': 'string',
            'ClusterName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'CurrentVersion': 'string',
            'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING',
            'StateInfo': {
                'Code': 'string',
                'Message': 'string'
            },
            'Tags': {
                'string': 'string'
            },
            'Provisioned': {
                'BrokerNodeGroupInfo': {
                    'BrokerAZDistribution': 'DEFAULT',
                    'ClientSubnets': [
                        'string',
                    ],
                    'InstanceType': 'string',
                    'SecurityGroups': [
                        'string',
                    ],
                    'StorageInfo': {
                        'EbsStorageInfo': {
                            'ProvisionedThroughput': {
                                'Enabled': True|False,
                                'VolumeThroughput': 123
                            },
                            'VolumeSize': 123
                        }
                    },
                    'ConnectivityInfo': {
                        'PublicAccess': {
                            'Type': 'string'
                        }
                    }
                },
                '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'
            },
            'Serverless': {
                'VpcConfigs': [
                    {
                        'SubnetIds': [
                            'string',
                        ],
                        'SecurityGroupIds': [
                            'string',
                        ]
                    },
                ],
                'ClientAuthentication': {
                    'Sasl': {
                        'Iam': {
                            'Enabled': True|False
                        }
                    }
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Successful response.
- ClusterInfoList (list) --
  
  Information on each of the MSK clusters in the response.
  - (dict) --
    
    Returns information about a cluster.
    - ActiveOperationArn (string) --
      
      The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
    - ClusterType (string) --
      
      Cluster Type.
    - ClusterArn (string) --
      
      The Amazon Resource Name (ARN) that uniquely identifies the cluster.
    - ClusterName (string) --
      
      The name of the cluster.
    - CreationTime (datetime) --
      
      The time when the cluster was created.
    - CurrentVersion (string) --
      
      The current version of the MSK cluster.
    - State (string) --
      
      The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
    - StateInfo (dict) --
      
      State Info for the Amazon MSK cluster.
      - Code (string) --
      - Message (string) --
    - Tags (dict) --
      
      Tags attached to the cluster.
      - (string) --
        
        (string) --
    - Provisioned (dict) --
      
      Information about the provisioned cluster.
      - BrokerNodeGroupInfo (dict) --
        
        Information about the brokers.
        
        BrokerAZDistribution (string) --
        
        The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
        
        Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
        
        ClientSubnets (list) --
        
        The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.
        
        (string) --
        
        InstanceType (string) --
        
        The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
        
        SecurityGroups (list) --
        
        The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
        
        (string) --
        
        StorageInfo (dict) --
        
        Contains information about storage volumes attached to MSK broker nodes.
        
        EbsStorageInfo (dict) --
        
        EBS volume information.
        
        ProvisionedThroughput (dict) -- EBS volume provisioned throughput information.
        
        Enabled (boolean) -- Provisioned throughput is enabled or not.
        
        VolumeThroughput (integer) -- Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
        
        VolumeSize (integer) --
        
        The size in GiB of the EBS volume for the data drive on each broker node.
        
        ConnectivityInfo (dict) --
        
        Information about the broker access configuration.
        
        PublicAccess (dict) --
        
        Public access control for brokers.
        
        Type (string) --
        
        The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
      - CurrentBrokerSoftwareInfo (dict) --
        
        Information about the Apache Kafka version deployed on the brokers.
        
        ConfigurationArn (string) --
        
        The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
        
        ConfigurationRevision (integer) --
        
        The revision of the configuration to use. This field isn't visible in this preview release.
        
        KafkaVersion (string) --
        
        The version of Apache Kafka.
      - ClientAuthentication (dict) --
        
        Includes all client authentication information.
        
        Sasl (dict) --
        
        Details for ClientAuthentication using SASL.
        
        Scram (dict) --
        
        Details for SASL/SCRAM client authentication.
        
        Enabled (boolean) --
        
        SASL/SCRAM authentication is enabled or not.
        
        Iam (dict) --
        
        Indicates whether IAM access control is enabled.
        
        Enabled (boolean) --
        
        Indicates whether IAM access control is enabled.
        
        Tls (dict) --
        
        Details for ClientAuthentication using TLS.
        
        CertificateAuthorityArnList (list) --
        
        List of ACM Certificate Authority ARNs.
        
        (string) --
        
        Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off TLS authentication.
        
        Unauthenticated (dict) --
        
        Contains information about unauthenticated traffic to the cluster.
        
        Enabled (boolean) --
        
        Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
      - EncryptionInfo (dict) --
        
        Includes all encryption-related information.
        
        EncryptionAtRest (dict) --
        
        The data-volume encryption details.
        
        DataVolumeKMSKeyId (string) --
        
        The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
        
        EncryptionInTransit (dict) --
        
        The details for encryption in transit.
        
        ClientBroker (string) --
        
        Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
        
        TLS means that client-broker communication is enabled with TLS only.
        
        TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
        
        PLAINTEXT means that client-broker communication is enabled in plaintext only.
        
        The default value is TLS_PLAINTEXT.
        
        InCluster (boolean) --
        
        When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
        
        The default value is true.
      - EnhancedMonitoring (string) --
        
        Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
      - OpenMonitoring (dict) --
        
        The settings for open monitoring.
        
        Prometheus (dict) --
        
        Prometheus settings.
        
        JmxExporter (dict) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the JMX Exporter.
        
        NodeExporter (dict) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
        
        EnabledInBroker (boolean) --
        
        Indicates whether you want to turn on or turn off the Node Exporter.
      - LoggingInfo (dict) --
        
        Log delivery information for the cluster.
        
        BrokerLogs (dict) --
        
        CloudWatchLogs (dict) --
        
        Enabled (boolean) --
        
        LogGroup (string) --
        
        Firehose (dict) --
        
        DeliveryStream (string) --
        
        Enabled (boolean) --
        
        S3 (dict) --
        
        Bucket (string) --
        
        Enabled (boolean) --
        
        Prefix (string) --
      - NumberOfBrokerNodes (integer) --
        
        The number of broker nodes in the cluster.
      - ZookeeperConnectString (string) --
        
        The connection string to use to connect to the Apache ZooKeeper cluster.
      - ZookeeperConnectStringTls (string) --
        
        The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.
    - Serverless (dict) --
      
      Information about the serverless cluster.
      - VpcConfigs (list) --
        
        The configuration of the Amazon VPCs for the cluster.
        
        (dict) --
        
        The configuration of the Amazon VPCs for the cluster.
        
        SubnetIds (list) --
        
        The IDs of the subnets associated with the cluster.
        
        (string) --
        
        SecurityGroupIds (list) --
        
        The IDs of the security groups associated with the cluster.
        
        (string) --
      - ClientAuthentication (dict) --
        
        Includes all client authentication information.
        
        Sasl (dict) --
        
        Details for ClientAuthentication using SASL.
        
        Iam (dict) --
        
        Indicates whether IAM access control is enabled.
        
        Enabled (boolean) --
        
        Indicates whether IAM access control is enabled.
- NextToken (string) --
  
  The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.

UpdateBrokerStorage (updated)

Link ¶
Changes (request)

{'TargetBrokerEBSVolumeInfo': {'ProvisionedThroughput': {'Enabled': 'boolean',
                                                         'VolumeThroughput': 'integer'}}}

Updates the EBS storage associated with MSK brokers.

See also: AWS API Documentation

Request Syntax

client.update_broker_storage(
    ClusterArn='string',
    CurrentVersion='string',
    TargetBrokerEBSVolumeInfo=[
        {
            'KafkaBrokerNodeId': 'string',
            'ProvisionedThroughput': {
                'Enabled': True|False,
                'VolumeThroughput': 123
            },
            'VolumeSizeGB': 123
        },
    ]
)

type ClusterArn

string

param ClusterArn

[REQUIRED]

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

type CurrentVersion

string

param CurrentVersion

[REQUIRED]

The version of cluster to update from. A successful operation will then generate a new version.

type TargetBrokerEBSVolumeInfo

list

param TargetBrokerEBSVolumeInfo

[REQUIRED]

Describes the target volume size and the ID of the broker to apply the update to.

(dict) --

Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.
- KafkaBrokerNodeId (string) -- [REQUIRED]
  
  The ID of the broker to update.
- ProvisionedThroughput (dict) -- EBS volume provisioned throughput information.
  - Enabled (boolean) -- Provisioned throughput is enabled or not.
  - VolumeThroughput (integer) -- Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
- VolumeSizeGB (integer) --
  
  Size of the EBS volume to update.

rtype

dict

returns

Response Syntax

{
    'ClusterArn': 'string',
    'ClusterOperationArn': 'string'
}

Response Structure

(dict) --

Successful response.
- ClusterArn (string) --
  
  The Amazon Resource Name (ARN) of the cluster.
- ClusterOperationArn (string) --
  
  The Amazon Resource Name (ARN) of the cluster operation.