KafkaClient

Index > Kafka > KafkaClient

Auto-generated documentation for Kafka type annotations stubs module mypy-boto3-kafka.

KafkaClient

Type annotations and code completion for boto3.client("kafka"). boto3 documentation

Usage example

from boto3.session import Session
from mypy_boto3_kafka.client import KafkaClient

def get_kafka_client() -> KafkaClient:
    return Session().client("kafka")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("kafka").exceptions structure.

Usage example

client = boto3.client("kafka")

try:
    do_something(client)
except (
    client.BadRequestException,
    client.ClientError,
    client.ConflictException,
    client.ForbiddenException,
    client.InternalServerErrorException,
    client.NotFoundException,
    client.ServiceUnavailableException,
    client.TooManyRequestsException,
    client.UnauthorizedException,
) as e:
    print(e)

Type checking example

from mypy_boto3_kafka.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods

batch_associate_scram_secret

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

Type annotations and code completion for boto3.client("kafka").batch_associate_scram_secret method. boto3 documentation

Method definition

def batch_associate_scram_secret(
    self,
    *,
    ClusterArn: str,
    SecretArnList: Sequence[str],
) -> BatchAssociateScramSecretResponseTypeDef:  # (1)
    ...

1. See BatchAssociateScramSecretResponseTypeDef

Usage example with kwargs

kwargs: BatchAssociateScramSecretRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
    "SecretArnList": ...,
}

parent.batch_associate_scram_secret(**kwargs)

1. See BatchAssociateScramSecretRequestRequestTypeDef

batch_disassociate_scram_secret

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

Type annotations and code completion for boto3.client("kafka").batch_disassociate_scram_secret method. boto3 documentation

Method definition

def batch_disassociate_scram_secret(
    self,
    *,
    ClusterArn: str,
    SecretArnList: Sequence[str],
) -> BatchDisassociateScramSecretResponseTypeDef:  # (1)
    ...

1. See BatchDisassociateScramSecretResponseTypeDef

Usage example with kwargs

kwargs: BatchDisassociateScramSecretRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
    "SecretArnList": ...,
}

parent.batch_disassociate_scram_secret(**kwargs)

1. See BatchDisassociateScramSecretRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("kafka").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("kafka").close method. boto3 documentation

Method definition

def close(
    self,
) -> None:
    ...

create_cluster

Creates a new MSK cluster.

Type annotations and code completion for boto3.client("kafka").create_cluster method. boto3 documentation

Method definition

def create_cluster(
    self,
    *,
    BrokerNodeGroupInfo: BrokerNodeGroupInfoTypeDef,  # (1)
    ClusterName: str,
    KafkaVersion: str,
    NumberOfBrokerNodes: int,
    ClientAuthentication: ClientAuthenticationTypeDef = ...,  # (2)
    ConfigurationInfo: ConfigurationInfoTypeDef = ...,  # (3)
    EncryptionInfo: EncryptionInfoTypeDef = ...,  # (4)
    EnhancedMonitoring: EnhancedMonitoringType = ...,  # (5)
    OpenMonitoring: OpenMonitoringInfoTypeDef = ...,  # (6)
    LoggingInfo: LoggingInfoTypeDef = ...,  # (7)
    Tags: Mapping[str, str] = ...,
    StorageMode: StorageModeType = ...,  # (8)
) -> CreateClusterResponseTypeDef:  # (9)
    ...

1. See BrokerNodeGroupInfoTypeDef
2. See ClientAuthenticationTypeDef
3. See ConfigurationInfoTypeDef
4. See EncryptionInfoTypeDef
5. See EnhancedMonitoringType
6. See OpenMonitoringInfoTypeDef
7. See LoggingInfoTypeDef
8. See StorageModeType
9. See CreateClusterResponseTypeDef

Usage example with kwargs

kwargs: CreateClusterRequestRequestTypeDef = {  # (1)
    "BrokerNodeGroupInfo": ...,
    "ClusterName": ...,
    "KafkaVersion": ...,
    "NumberOfBrokerNodes": ...,
}

parent.create_cluster(**kwargs)

1. See CreateClusterRequestRequestTypeDef

create_cluster_v2

Creates a new MSK cluster.

Type annotations and code completion for boto3.client("kafka").create_cluster_v2 method. boto3 documentation

Method definition

def create_cluster_v2(
    self,
    *,
    ClusterName: str,
    Tags: Mapping[str, str] = ...,
    Provisioned: ProvisionedRequestTypeDef = ...,  # (1)
    Serverless: ServerlessRequestTypeDef = ...,  # (2)
) -> CreateClusterV2ResponseTypeDef:  # (3)
    ...

1. See ProvisionedRequestTypeDef
2. See ServerlessRequestTypeDef
3. See CreateClusterV2ResponseTypeDef

Usage example with kwargs

kwargs: CreateClusterV2RequestRequestTypeDef = {  # (1)
    "ClusterName": ...,
}

parent.create_cluster_v2(**kwargs)

1. See CreateClusterV2RequestRequestTypeDef

create_configuration

Creates a new MSK configuration.

Type annotations and code completion for boto3.client("kafka").create_configuration method. boto3 documentation

Method definition

def create_configuration(
    self,
    *,
    Name: str,
    ServerProperties: Union[str, bytes, IO[Any], StreamingBody],
    Description: str = ...,
    KafkaVersions: Sequence[str] = ...,
) -> CreateConfigurationResponseTypeDef:  # (1)
    ...

1. See CreateConfigurationResponseTypeDef

Usage example with kwargs

kwargs: CreateConfigurationRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "ServerProperties": ...,
}

parent.create_configuration(**kwargs)

1. See CreateConfigurationRequestRequestTypeDef

delete_cluster

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

Type annotations and code completion for boto3.client("kafka").delete_cluster method. boto3 documentation

Method definition

def delete_cluster(
    self,
    *,
    ClusterArn: str,
    CurrentVersion: str = ...,
) -> DeleteClusterResponseTypeDef:  # (1)
    ...

1. See DeleteClusterResponseTypeDef

Usage example with kwargs

kwargs: DeleteClusterRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
}

parent.delete_cluster(**kwargs)

1. See DeleteClusterRequestRequestTypeDef

delete_configuration

Deletes an MSK Configuration.

Type annotations and code completion for boto3.client("kafka").delete_configuration method. boto3 documentation

Method definition

def delete_configuration(
    self,
    *,
    Arn: str,
) -> DeleteConfigurationResponseTypeDef:  # (1)
    ...

1. See DeleteConfigurationResponseTypeDef

Usage example with kwargs

kwargs: DeleteConfigurationRequestRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.delete_configuration(**kwargs)

1. See DeleteConfigurationRequestRequestTypeDef

describe_cluster

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

Type annotations and code completion for boto3.client("kafka").describe_cluster method. boto3 documentation

Method definition

def describe_cluster(
    self,
    *,
    ClusterArn: str,
) -> DescribeClusterResponseTypeDef:  # (1)
    ...

1. See DescribeClusterResponseTypeDef

Usage example with kwargs

kwargs: DescribeClusterRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
}

parent.describe_cluster(**kwargs)

1. See DescribeClusterRequestRequestTypeDef

describe_cluster_operation

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

Type annotations and code completion for boto3.client("kafka").describe_cluster_operation method. boto3 documentation

Method definition

def describe_cluster_operation(
    self,
    *,
    ClusterOperationArn: str,
) -> DescribeClusterOperationResponseTypeDef:  # (1)
    ...

1. See DescribeClusterOperationResponseTypeDef

Usage example with kwargs

kwargs: DescribeClusterOperationRequestRequestTypeDef = {  # (1)
    "ClusterOperationArn": ...,
}

parent.describe_cluster_operation(**kwargs)

1. See DescribeClusterOperationRequestRequestTypeDef

describe_cluster_v2

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

Type annotations and code completion for boto3.client("kafka").describe_cluster_v2 method. boto3 documentation

Method definition

def describe_cluster_v2(
    self,
    *,
    ClusterArn: str,
) -> DescribeClusterV2ResponseTypeDef:  # (1)
    ...

1. See DescribeClusterV2ResponseTypeDef

Usage example with kwargs

kwargs: DescribeClusterV2RequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
}

parent.describe_cluster_v2(**kwargs)

1. See DescribeClusterV2RequestRequestTypeDef

describe_configuration

Returns a description of this MSK configuration.

Type annotations and code completion for boto3.client("kafka").describe_configuration method. boto3 documentation

Method definition

def describe_configuration(
    self,
    *,
    Arn: str,
) -> DescribeConfigurationResponseTypeDef:  # (1)
    ...

1. See DescribeConfigurationResponseTypeDef

Usage example with kwargs

kwargs: DescribeConfigurationRequestRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.describe_configuration(**kwargs)

1. See DescribeConfigurationRequestRequestTypeDef

describe_configuration_revision

Returns a description of this revision of the configuration.

Type annotations and code completion for boto3.client("kafka").describe_configuration_revision method. boto3 documentation

Method definition

def describe_configuration_revision(
    self,
    *,
    Arn: str,
    Revision: int,
) -> DescribeConfigurationRevisionResponseTypeDef:  # (1)
    ...

1. See DescribeConfigurationRevisionResponseTypeDef

Usage example with kwargs

kwargs: DescribeConfigurationRevisionRequestRequestTypeDef = {  # (1)
    "Arn": ...,
    "Revision": ...,
}

parent.describe_configuration_revision(**kwargs)

1. See DescribeConfigurationRevisionRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("kafka").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_bootstrap_brokers

A list of brokers that a client application can use to bootstrap.

Type annotations and code completion for boto3.client("kafka").get_bootstrap_brokers method. boto3 documentation

Method definition

def get_bootstrap_brokers(
    self,
    *,
    ClusterArn: str,
) -> GetBootstrapBrokersResponseTypeDef:  # (1)
    ...

1. See GetBootstrapBrokersResponseTypeDef

Usage example with kwargs

kwargs: GetBootstrapBrokersRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
}

parent.get_bootstrap_brokers(**kwargs)

1. See GetBootstrapBrokersRequestRequestTypeDef

get_compatible_kafka_versions

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

Type annotations and code completion for boto3.client("kafka").get_compatible_kafka_versions method. boto3 documentation

Method definition

def get_compatible_kafka_versions(
    self,
    *,
    ClusterArn: str = ...,
) -> GetCompatibleKafkaVersionsResponseTypeDef:  # (1)
    ...

1. See GetCompatibleKafkaVersionsResponseTypeDef

Usage example with kwargs

kwargs: GetCompatibleKafkaVersionsRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
}

parent.get_compatible_kafka_versions(**kwargs)

1. See GetCompatibleKafkaVersionsRequestRequestTypeDef

list_cluster_operations

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

Type annotations and code completion for boto3.client("kafka").list_cluster_operations method. boto3 documentation

Method definition

def list_cluster_operations(
    self,
    *,
    ClusterArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListClusterOperationsResponseTypeDef:  # (1)
    ...

1. See ListClusterOperationsResponseTypeDef

Usage example with kwargs

kwargs: ListClusterOperationsRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
}

parent.list_cluster_operations(**kwargs)

1. See ListClusterOperationsRequestRequestTypeDef

list_clusters

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

Type annotations and code completion for boto3.client("kafka").list_clusters method. boto3 documentation

Method definition

def list_clusters(
    self,
    *,
    ClusterNameFilter: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListClustersResponseTypeDef:  # (1)
    ...

1. See ListClustersResponseTypeDef

Usage example with kwargs

kwargs: ListClustersRequestRequestTypeDef = {  # (1)
    "ClusterNameFilter": ...,
}

parent.list_clusters(**kwargs)

1. See ListClustersRequestRequestTypeDef

list_clusters_v2

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

Type annotations and code completion for boto3.client("kafka").list_clusters_v2 method. boto3 documentation

Method definition

def list_clusters_v2(
    self,
    *,
    ClusterNameFilter: str = ...,
    ClusterTypeFilter: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListClustersV2ResponseTypeDef:  # (1)
    ...

1. See ListClustersV2ResponseTypeDef

Usage example with kwargs

kwargs: ListClustersV2RequestRequestTypeDef = {  # (1)
    "ClusterNameFilter": ...,
}

parent.list_clusters_v2(**kwargs)

1. See ListClustersV2RequestRequestTypeDef

list_configuration_revisions

Returns a list of all the MSK configurations in this Region.

Type annotations and code completion for boto3.client("kafka").list_configuration_revisions method. boto3 documentation

Method definition

def list_configuration_revisions(
    self,
    *,
    Arn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListConfigurationRevisionsResponseTypeDef:  # (1)
    ...

1. See ListConfigurationRevisionsResponseTypeDef

Usage example with kwargs

kwargs: ListConfigurationRevisionsRequestRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.list_configuration_revisions(**kwargs)

1. See ListConfigurationRevisionsRequestRequestTypeDef

list_configurations

Returns a list of all the MSK configurations in this Region.

Type annotations and code completion for boto3.client("kafka").list_configurations method. boto3 documentation

Method definition

def list_configurations(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListConfigurationsResponseTypeDef:  # (1)
    ...

1. See ListConfigurationsResponseTypeDef

Usage example with kwargs

kwargs: ListConfigurationsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_configurations(**kwargs)

1. See ListConfigurationsRequestRequestTypeDef

list_kafka_versions

Returns a list of Apache Kafka versions.

Type annotations and code completion for boto3.client("kafka").list_kafka_versions method. boto3 documentation

Method definition

def list_kafka_versions(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListKafkaVersionsResponseTypeDef:  # (1)
    ...

1. See ListKafkaVersionsResponseTypeDef

Usage example with kwargs

kwargs: ListKafkaVersionsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_kafka_versions(**kwargs)

1. See ListKafkaVersionsRequestRequestTypeDef

list_nodes

Returns a list of the broker nodes in the cluster.

Type annotations and code completion for boto3.client("kafka").list_nodes method. boto3 documentation

Method definition

def list_nodes(
    self,
    *,
    ClusterArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListNodesResponseTypeDef:  # (1)
    ...

1. See ListNodesResponseTypeDef

Usage example with kwargs

kwargs: ListNodesRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
}

parent.list_nodes(**kwargs)

1. See ListNodesRequestRequestTypeDef

list_scram_secrets

Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

Type annotations and code completion for boto3.client("kafka").list_scram_secrets method. boto3 documentation

Method definition

def list_scram_secrets(
    self,
    *,
    ClusterArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListScramSecretsResponseTypeDef:  # (1)
    ...

1. See ListScramSecretsResponseTypeDef

Usage example with kwargs

kwargs: ListScramSecretsRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
}

parent.list_scram_secrets(**kwargs)

1. See ListScramSecretsRequestRequestTypeDef

list_tags_for_resource

Returns a list of the tags associated with the specified resource.

Type annotations and code completion for boto3.client("kafka").list_tags_for_resource method. boto3 documentation

Method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

reboot_broker

Reboots brokers.

Type annotations and code completion for boto3.client("kafka").reboot_broker method. boto3 documentation

Method definition

def reboot_broker(
    self,
    *,
    BrokerIds: Sequence[str],
    ClusterArn: str,
) -> RebootBrokerResponseTypeDef:  # (1)
    ...

1. See RebootBrokerResponseTypeDef

Usage example with kwargs

kwargs: RebootBrokerRequestRequestTypeDef = {  # (1)
    "BrokerIds": ...,
    "ClusterArn": ...,
}

parent.reboot_broker(**kwargs)

1. See RebootBrokerRequestRequestTypeDef

tag_resource

Adds tags to the specified MSK resource.

Type annotations and code completion for boto3.client("kafka").tag_resource method. boto3 documentation

Method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes the tags associated with the keys that are provided in the query.

Type annotations and code completion for boto3.client("kafka").untag_resource method. boto3 documentation

Method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_broker_count

Updates the number of broker nodes in the cluster.

Type annotations and code completion for boto3.client("kafka").update_broker_count method. boto3 documentation

Method definition

def update_broker_count(
    self,
    *,
    ClusterArn: str,
    CurrentVersion: str,
    TargetNumberOfBrokerNodes: int,
) -> UpdateBrokerCountResponseTypeDef:  # (1)
    ...

1. See UpdateBrokerCountResponseTypeDef

Usage example with kwargs

kwargs: UpdateBrokerCountRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
    "CurrentVersion": ...,
    "TargetNumberOfBrokerNodes": ...,
}

parent.update_broker_count(**kwargs)

1. See UpdateBrokerCountRequestRequestTypeDef

update_broker_storage

Updates the EBS storage associated with MSK brokers.

Type annotations and code completion for boto3.client("kafka").update_broker_storage method. boto3 documentation

Method definition

def update_broker_storage(
    self,
    *,
    ClusterArn: str,
    CurrentVersion: str,
    TargetBrokerEBSVolumeInfo: Sequence[BrokerEBSVolumeInfoTypeDef],  # (1)
) -> UpdateBrokerStorageResponseTypeDef:  # (2)
    ...

1. See BrokerEBSVolumeInfoTypeDef
2. See UpdateBrokerStorageResponseTypeDef

Usage example with kwargs

kwargs: UpdateBrokerStorageRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
    "CurrentVersion": ...,
    "TargetBrokerEBSVolumeInfo": ...,
}

parent.update_broker_storage(**kwargs)

1. See UpdateBrokerStorageRequestRequestTypeDef

update_broker_type

Updates EC2 instance type.

Type annotations and code completion for boto3.client("kafka").update_broker_type method. boto3 documentation

Method definition

def update_broker_type(
    self,
    *,
    ClusterArn: str,
    CurrentVersion: str,
    TargetInstanceType: str,
) -> UpdateBrokerTypeResponseTypeDef:  # (1)
    ...

1. See UpdateBrokerTypeResponseTypeDef

Usage example with kwargs

kwargs: UpdateBrokerTypeRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
    "CurrentVersion": ...,
    "TargetInstanceType": ...,
}

parent.update_broker_type(**kwargs)

1. See UpdateBrokerTypeRequestRequestTypeDef

update_cluster_configuration

Updates the cluster with the configuration that is specified in the request body.

Type annotations and code completion for boto3.client("kafka").update_cluster_configuration method. boto3 documentation

Method definition

def update_cluster_configuration(
    self,
    *,
    ClusterArn: str,
    ConfigurationInfo: ConfigurationInfoTypeDef,  # (1)
    CurrentVersion: str,
) -> UpdateClusterConfigurationResponseTypeDef:  # (2)
    ...

1. See ConfigurationInfoTypeDef
2. See UpdateClusterConfigurationResponseTypeDef

Usage example with kwargs

kwargs: UpdateClusterConfigurationRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
    "ConfigurationInfo": ...,
    "CurrentVersion": ...,
}

parent.update_cluster_configuration(**kwargs)

1. See UpdateClusterConfigurationRequestRequestTypeDef

update_cluster_kafka_version

Updates the Apache Kafka version for the cluster.

Type annotations and code completion for boto3.client("kafka").update_cluster_kafka_version method. boto3 documentation

Method definition

def update_cluster_kafka_version(
    self,
    *,
    ClusterArn: str,
    CurrentVersion: str,
    TargetKafkaVersion: str,
    ConfigurationInfo: ConfigurationInfoTypeDef = ...,  # (1)
) -> UpdateClusterKafkaVersionResponseTypeDef:  # (2)
    ...

1. See ConfigurationInfoTypeDef
2. See UpdateClusterKafkaVersionResponseTypeDef

Usage example with kwargs

kwargs: UpdateClusterKafkaVersionRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
    "CurrentVersion": ...,
    "TargetKafkaVersion": ...,
}

parent.update_cluster_kafka_version(**kwargs)

1. See UpdateClusterKafkaVersionRequestRequestTypeDef

update_configuration

Updates an MSK configuration.

Type annotations and code completion for boto3.client("kafka").update_configuration method. boto3 documentation

Method definition

def update_configuration(
    self,
    *,
    Arn: str,
    ServerProperties: Union[str, bytes, IO[Any], StreamingBody],
    Description: str = ...,
) -> UpdateConfigurationResponseTypeDef:  # (1)
    ...

1. See UpdateConfigurationResponseTypeDef

Usage example with kwargs

kwargs: UpdateConfigurationRequestRequestTypeDef = {  # (1)
    "Arn": ...,
    "ServerProperties": ...,
}

parent.update_configuration(**kwargs)

1. See UpdateConfigurationRequestRequestTypeDef

update_connectivity

Updates the cluster's connectivity configuration.

Type annotations and code completion for boto3.client("kafka").update_connectivity method. boto3 documentation

Method definition

def update_connectivity(
    self,
    *,
    ClusterArn: str,
    ConnectivityInfo: ConnectivityInfoTypeDef,  # (1)
    CurrentVersion: str,
) -> UpdateConnectivityResponseTypeDef:  # (2)
    ...

1. See ConnectivityInfoTypeDef
2. See UpdateConnectivityResponseTypeDef

Usage example with kwargs

kwargs: UpdateConnectivityRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
    "ConnectivityInfo": ...,
    "CurrentVersion": ...,
}

parent.update_connectivity(**kwargs)

1. See UpdateConnectivityRequestRequestTypeDef

update_monitoring

Updates the monitoring settings for the cluster.

Type annotations and code completion for boto3.client("kafka").update_monitoring method. boto3 documentation

Method definition

def update_monitoring(
    self,
    *,
    ClusterArn: str,
    CurrentVersion: str,
    EnhancedMonitoring: EnhancedMonitoringType = ...,  # (1)
    OpenMonitoring: OpenMonitoringInfoTypeDef = ...,  # (2)
    LoggingInfo: LoggingInfoTypeDef = ...,  # (3)
) -> UpdateMonitoringResponseTypeDef:  # (4)
    ...

1. See EnhancedMonitoringType
2. See OpenMonitoringInfoTypeDef
3. See LoggingInfoTypeDef
4. See UpdateMonitoringResponseTypeDef

Usage example with kwargs

kwargs: UpdateMonitoringRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
    "CurrentVersion": ...,
}

parent.update_monitoring(**kwargs)

1. See UpdateMonitoringRequestRequestTypeDef

update_security

Updates the security settings for the cluster.

Type annotations and code completion for boto3.client("kafka").update_security method. boto3 documentation

Method definition

def update_security(
    self,
    *,
    ClusterArn: str,
    CurrentVersion: str,
    ClientAuthentication: ClientAuthenticationTypeDef = ...,  # (1)
    EncryptionInfo: EncryptionInfoTypeDef = ...,  # (2)
) -> UpdateSecurityResponseTypeDef:  # (3)
    ...

1. See ClientAuthenticationTypeDef
2. See EncryptionInfoTypeDef
3. See UpdateSecurityResponseTypeDef

Usage example with kwargs

kwargs: UpdateSecurityRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
    "CurrentVersion": ...,
}

parent.update_security(**kwargs)

1. See UpdateSecurityRequestRequestTypeDef

update_storage

Updates cluster broker volume size (or) sets cluster storage mode to TIERED.

Type annotations and code completion for boto3.client("kafka").update_storage method. boto3 documentation

Method definition

def update_storage(
    self,
    *,
    ClusterArn: str,
    CurrentVersion: str,
    ProvisionedThroughput: ProvisionedThroughputTypeDef = ...,  # (1)
    StorageMode: StorageModeType = ...,  # (2)
    VolumeSizeGB: int = ...,
) -> UpdateStorageResponseTypeDef:  # (3)
    ...

1. See ProvisionedThroughputTypeDef
2. See StorageModeType
3. See UpdateStorageResponseTypeDef

Usage example with kwargs

kwargs: UpdateStorageRequestRequestTypeDef = {  # (1)
    "ClusterArn": ...,
    "CurrentVersion": ...,
}

parent.update_storage(**kwargs)

1. See UpdateStorageRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("kafka").get_paginator method with overloads.

• client.get_paginator("list_cluster_operations") -> ListClusterOperationsPaginator
• client.get_paginator("list_clusters") -> ListClustersPaginator
• client.get_paginator("list_clusters_v2") -> ListClustersV2Paginator
• client.get_paginator("list_configuration_revisions") -> ListConfigurationRevisionsPaginator
• client.get_paginator("list_configurations") -> ListConfigurationsPaginator
• client.get_paginator("list_kafka_versions") -> ListKafkaVersionsPaginator
• client.get_paginator("list_nodes") -> ListNodesPaginator
• client.get_paginator("list_scram_secrets") -> ListScramSecretsPaginator