KafkaClient#
Auto-generated documentation for Kafka type annotations stubs module types-aiobotocore-kafka.
KafkaClient#
Type annotations and code completion for session.create_client("kafka")
boto3 documentation
KafkaClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_kafka.client import KafkaClient
session = get_session()
async with session.create_client("kafka") as client:
client: KafkaClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("kafka").exceptions
structure.
KafkaClient.exceptions usage example
async with session.create_client("kafka") as client:
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)
KafkaClient usage type checking example
from types_aiobotocore_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 session.create_client("kafka").batch_associate_scram_secret
method.
boto3 documentation
# batch_associate_scram_secret method definition
await def batch_associate_scram_secret(
self,
*,
ClusterArn: str,
SecretArnList: Sequence[str],
) -> BatchAssociateScramSecretResponseTypeDef: # (1)
...
# batch_associate_scram_secret method usage example with argument unpacking
kwargs: BatchAssociateScramSecretRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
"SecretArnList": ...,
}
parent.batch_associate_scram_secret(**kwargs)
batch_disassociate_scram_secret#
Disassociates one or more Scram Secrets from an Amazon MSK cluster.
Type annotations and code completion for session.create_client("kafka").batch_disassociate_scram_secret
method.
boto3 documentation
# batch_disassociate_scram_secret method definition
await def batch_disassociate_scram_secret(
self,
*,
ClusterArn: str,
SecretArnList: Sequence[str],
) -> BatchDisassociateScramSecretResponseTypeDef: # (1)
...
# batch_disassociate_scram_secret method usage example with argument unpacking
kwargs: BatchDisassociateScramSecretRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
"SecretArnList": ...,
}
parent.batch_disassociate_scram_secret(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.create_client("kafka").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.create_client("kafka").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_cluster#
Creates a new MSK cluster.
Type annotations and code completion for session.create_client("kafka").create_cluster
method.
boto3 documentation
# create_cluster method definition
await 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)
...
- See BrokerNodeGroupInfoTypeDef
- See ClientAuthenticationTypeDef
- See ConfigurationInfoTypeDef
- See EncryptionInfoTypeDef
- See EnhancedMonitoringType
- See OpenMonitoringInfoTypeDef
- See LoggingInfoTypeDef
- See StorageModeType
- See CreateClusterResponseTypeDef
# create_cluster method usage example with argument unpacking
kwargs: CreateClusterRequestRequestTypeDef = { # (1)
"BrokerNodeGroupInfo": ...,
"ClusterName": ...,
"KafkaVersion": ...,
"NumberOfBrokerNodes": ...,
}
parent.create_cluster(**kwargs)
create_cluster_v2#
Creates a new MSK cluster.
Type annotations and code completion for session.create_client("kafka").create_cluster_v2
method.
boto3 documentation
# create_cluster_v2 method definition
await def create_cluster_v2(
self,
*,
ClusterName: str,
Tags: Mapping[str, str] = ...,
Provisioned: ProvisionedRequestTypeDef = ..., # (1)
Serverless: ServerlessRequestTypeDef = ..., # (2)
) -> CreateClusterV2ResponseTypeDef: # (3)
...
# create_cluster_v2 method usage example with argument unpacking
kwargs: CreateClusterV2RequestRequestTypeDef = { # (1)
"ClusterName": ...,
}
parent.create_cluster_v2(**kwargs)
create_configuration#
Creates a new MSK configuration.
Type annotations and code completion for session.create_client("kafka").create_configuration
method.
boto3 documentation
# create_configuration method definition
await def create_configuration(
self,
*,
Name: str,
ServerProperties: Union[str, bytes, IO[Any], StreamingBody],
Description: str = ...,
KafkaVersions: Sequence[str] = ...,
) -> CreateConfigurationResponseTypeDef: # (1)
...
# create_configuration method usage example with argument unpacking
kwargs: CreateConfigurationRequestRequestTypeDef = { # (1)
"Name": ...,
"ServerProperties": ...,
}
parent.create_configuration(**kwargs)
create_vpc_connection#
Creates a new MSK VPC connection.
Type annotations and code completion for session.create_client("kafka").create_vpc_connection
method.
boto3 documentation
# create_vpc_connection method definition
await def create_vpc_connection(
self,
*,
TargetClusterArn: str,
Authentication: str,
VpcId: str,
ClientSubnets: Sequence[str],
SecurityGroups: Sequence[str],
Tags: Mapping[str, str] = ...,
) -> CreateVpcConnectionResponseTypeDef: # (1)
...
# create_vpc_connection method usage example with argument unpacking
kwargs: CreateVpcConnectionRequestRequestTypeDef = { # (1)
"TargetClusterArn": ...,
"Authentication": ...,
"VpcId": ...,
"ClientSubnets": ...,
"SecurityGroups": ...,
}
parent.create_vpc_connection(**kwargs)
delete_cluster#
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
Type annotations and code completion for session.create_client("kafka").delete_cluster
method.
boto3 documentation
# delete_cluster method definition
await def delete_cluster(
self,
*,
ClusterArn: str,
CurrentVersion: str = ...,
) -> DeleteClusterResponseTypeDef: # (1)
...
# delete_cluster method usage example with argument unpacking
kwargs: DeleteClusterRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
}
parent.delete_cluster(**kwargs)
delete_cluster_policy#
Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
Type annotations and code completion for session.create_client("kafka").delete_cluster_policy
method.
boto3 documentation
# delete_cluster_policy method definition
await def delete_cluster_policy(
self,
*,
ClusterArn: str,
) -> Dict[str, Any]:
...
# delete_cluster_policy method usage example with argument unpacking
kwargs: DeleteClusterPolicyRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
}
parent.delete_cluster_policy(**kwargs)
delete_configuration#
Deletes an MSK Configuration.
Type annotations and code completion for session.create_client("kafka").delete_configuration
method.
boto3 documentation
# delete_configuration method definition
await def delete_configuration(
self,
*,
Arn: str,
) -> DeleteConfigurationResponseTypeDef: # (1)
...
# delete_configuration method usage example with argument unpacking
kwargs: DeleteConfigurationRequestRequestTypeDef = { # (1)
"Arn": ...,
}
parent.delete_configuration(**kwargs)
delete_vpc_connection#
Deletes a MSK VPC connection.
Type annotations and code completion for session.create_client("kafka").delete_vpc_connection
method.
boto3 documentation
# delete_vpc_connection method definition
await def delete_vpc_connection(
self,
*,
Arn: str,
) -> DeleteVpcConnectionResponseTypeDef: # (1)
...
# delete_vpc_connection method usage example with argument unpacking
kwargs: DeleteVpcConnectionRequestRequestTypeDef = { # (1)
"Arn": ...,
}
parent.delete_vpc_connection(**kwargs)
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 session.create_client("kafka").describe_cluster
method.
boto3 documentation
# describe_cluster method definition
await def describe_cluster(
self,
*,
ClusterArn: str,
) -> DescribeClusterResponseTypeDef: # (1)
...
# describe_cluster method usage example with argument unpacking
kwargs: DescribeClusterRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
}
parent.describe_cluster(**kwargs)
describe_cluster_operation#
Returns a description of the cluster operation specified by the ARN.
Type annotations and code completion for session.create_client("kafka").describe_cluster_operation
method.
boto3 documentation
# describe_cluster_operation method definition
await def describe_cluster_operation(
self,
*,
ClusterOperationArn: str,
) -> DescribeClusterOperationResponseTypeDef: # (1)
...
# describe_cluster_operation method usage example with argument unpacking
kwargs: DescribeClusterOperationRequestRequestTypeDef = { # (1)
"ClusterOperationArn": ...,
}
parent.describe_cluster_operation(**kwargs)
describe_cluster_operation_v2#
Returns a description of the cluster operation specified by the ARN.
Type annotations and code completion for session.create_client("kafka").describe_cluster_operation_v2
method.
boto3 documentation
# describe_cluster_operation_v2 method definition
await def describe_cluster_operation_v2(
self,
*,
ClusterOperationArn: str,
) -> DescribeClusterOperationV2ResponseTypeDef: # (1)
...
# describe_cluster_operation_v2 method usage example with argument unpacking
kwargs: DescribeClusterOperationV2RequestRequestTypeDef = { # (1)
"ClusterOperationArn": ...,
}
parent.describe_cluster_operation_v2(**kwargs)
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 session.create_client("kafka").describe_cluster_v2
method.
boto3 documentation
# describe_cluster_v2 method definition
await def describe_cluster_v2(
self,
*,
ClusterArn: str,
) -> DescribeClusterV2ResponseTypeDef: # (1)
...
# describe_cluster_v2 method usage example with argument unpacking
kwargs: DescribeClusterV2RequestRequestTypeDef = { # (1)
"ClusterArn": ...,
}
parent.describe_cluster_v2(**kwargs)
describe_configuration#
Returns a description of this MSK configuration.
Type annotations and code completion for session.create_client("kafka").describe_configuration
method.
boto3 documentation
# describe_configuration method definition
await def describe_configuration(
self,
*,
Arn: str,
) -> DescribeConfigurationResponseTypeDef: # (1)
...
# describe_configuration method usage example with argument unpacking
kwargs: DescribeConfigurationRequestRequestTypeDef = { # (1)
"Arn": ...,
}
parent.describe_configuration(**kwargs)
describe_configuration_revision#
Returns a description of this revision of the configuration.
Type annotations and code completion for session.create_client("kafka").describe_configuration_revision
method.
boto3 documentation
# describe_configuration_revision method definition
await def describe_configuration_revision(
self,
*,
Arn: str,
Revision: int,
) -> DescribeConfigurationRevisionResponseTypeDef: # (1)
...
# describe_configuration_revision method usage example with argument unpacking
kwargs: DescribeConfigurationRevisionRequestRequestTypeDef = { # (1)
"Arn": ...,
"Revision": ...,
}
parent.describe_configuration_revision(**kwargs)
describe_vpc_connection#
Returns a description of this MSK VPC connection.
Type annotations and code completion for session.create_client("kafka").describe_vpc_connection
method.
boto3 documentation
# describe_vpc_connection method definition
await def describe_vpc_connection(
self,
*,
Arn: str,
) -> DescribeVpcConnectionResponseTypeDef: # (1)
...
# describe_vpc_connection method usage example with argument unpacking
kwargs: DescribeVpcConnectionRequestRequestTypeDef = { # (1)
"Arn": ...,
}
parent.describe_vpc_connection(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("kafka").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("kafka").get_bootstrap_brokers
method.
boto3 documentation
# get_bootstrap_brokers method definition
await def get_bootstrap_brokers(
self,
*,
ClusterArn: str,
) -> GetBootstrapBrokersResponseTypeDef: # (1)
...
# get_bootstrap_brokers method usage example with argument unpacking
kwargs: GetBootstrapBrokersRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
}
parent.get_bootstrap_brokers(**kwargs)
get_cluster_policy#
Get the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
Type annotations and code completion for session.create_client("kafka").get_cluster_policy
method.
boto3 documentation
# get_cluster_policy method definition
await def get_cluster_policy(
self,
*,
ClusterArn: str,
) -> GetClusterPolicyResponseTypeDef: # (1)
...
# get_cluster_policy method usage example with argument unpacking
kwargs: GetClusterPolicyRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
}
parent.get_cluster_policy(**kwargs)
get_compatible_kafka_versions#
Gets the Apache Kafka versions to which you can update the MSK cluster.
Type annotations and code completion for session.create_client("kafka").get_compatible_kafka_versions
method.
boto3 documentation
# get_compatible_kafka_versions method definition
await def get_compatible_kafka_versions(
self,
*,
ClusterArn: str = ...,
) -> GetCompatibleKafkaVersionsResponseTypeDef: # (1)
...
# get_compatible_kafka_versions method usage example with argument unpacking
kwargs: GetCompatibleKafkaVersionsRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
}
parent.get_compatible_kafka_versions(**kwargs)
list_client_vpc_connections#
Returns a list of all the VPC connections in this Region.
Type annotations and code completion for session.create_client("kafka").list_client_vpc_connections
method.
boto3 documentation
# list_client_vpc_connections method definition
await def list_client_vpc_connections(
self,
*,
ClusterArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListClientVpcConnectionsResponseTypeDef: # (1)
...
# list_client_vpc_connections method usage example with argument unpacking
kwargs: ListClientVpcConnectionsRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
}
parent.list_client_vpc_connections(**kwargs)
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 session.create_client("kafka").list_cluster_operations
method.
boto3 documentation
# list_cluster_operations method definition
await def list_cluster_operations(
self,
*,
ClusterArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListClusterOperationsResponseTypeDef: # (1)
...
# list_cluster_operations method usage example with argument unpacking
kwargs: ListClusterOperationsRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
}
parent.list_cluster_operations(**kwargs)
list_cluster_operations_v2#
Returns a list of all the operations that have been performed on the specified MSK cluster.
Type annotations and code completion for session.create_client("kafka").list_cluster_operations_v2
method.
boto3 documentation
# list_cluster_operations_v2 method definition
await def list_cluster_operations_v2(
self,
*,
ClusterArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListClusterOperationsV2ResponseTypeDef: # (1)
...
# list_cluster_operations_v2 method usage example with argument unpacking
kwargs: ListClusterOperationsV2RequestRequestTypeDef = { # (1)
"ClusterArn": ...,
}
parent.list_cluster_operations_v2(**kwargs)
list_clusters#
Returns a list of all the MSK clusters in the current Region.
Type annotations and code completion for session.create_client("kafka").list_clusters
method.
boto3 documentation
# list_clusters method definition
await def list_clusters(
self,
*,
ClusterNameFilter: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListClustersResponseTypeDef: # (1)
...
# list_clusters method usage example with argument unpacking
kwargs: ListClustersRequestRequestTypeDef = { # (1)
"ClusterNameFilter": ...,
}
parent.list_clusters(**kwargs)
list_clusters_v2#
Returns a list of all the MSK clusters in the current Region.
Type annotations and code completion for session.create_client("kafka").list_clusters_v2
method.
boto3 documentation
# list_clusters_v2 method definition
await def list_clusters_v2(
self,
*,
ClusterNameFilter: str = ...,
ClusterTypeFilter: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListClustersV2ResponseTypeDef: # (1)
...
# list_clusters_v2 method usage example with argument unpacking
kwargs: ListClustersV2RequestRequestTypeDef = { # (1)
"ClusterNameFilter": ...,
}
parent.list_clusters_v2(**kwargs)
list_configuration_revisions#
Returns a list of all the MSK configurations in this Region.
Type annotations and code completion for session.create_client("kafka").list_configuration_revisions
method.
boto3 documentation
# list_configuration_revisions method definition
await def list_configuration_revisions(
self,
*,
Arn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListConfigurationRevisionsResponseTypeDef: # (1)
...
# list_configuration_revisions method usage example with argument unpacking
kwargs: ListConfigurationRevisionsRequestRequestTypeDef = { # (1)
"Arn": ...,
}
parent.list_configuration_revisions(**kwargs)
list_configurations#
Returns a list of all the MSK configurations in this Region.
Type annotations and code completion for session.create_client("kafka").list_configurations
method.
boto3 documentation
# list_configurations method definition
await def list_configurations(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListConfigurationsResponseTypeDef: # (1)
...
# list_configurations method usage example with argument unpacking
kwargs: ListConfigurationsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_configurations(**kwargs)
list_kafka_versions#
Returns a list of Apache Kafka versions.
Type annotations and code completion for session.create_client("kafka").list_kafka_versions
method.
boto3 documentation
# list_kafka_versions method definition
await def list_kafka_versions(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListKafkaVersionsResponseTypeDef: # (1)
...
# list_kafka_versions method usage example with argument unpacking
kwargs: ListKafkaVersionsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_kafka_versions(**kwargs)
list_nodes#
Returns a list of the broker nodes in the cluster.
Type annotations and code completion for session.create_client("kafka").list_nodes
method.
boto3 documentation
# list_nodes method definition
await def list_nodes(
self,
*,
ClusterArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListNodesResponseTypeDef: # (1)
...
# list_nodes method usage example with argument unpacking
kwargs: ListNodesRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
}
parent.list_nodes(**kwargs)
list_scram_secrets#
Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
Type annotations and code completion for session.create_client("kafka").list_scram_secrets
method.
boto3 documentation
# list_scram_secrets method definition
await def list_scram_secrets(
self,
*,
ClusterArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListScramSecretsResponseTypeDef: # (1)
...
# list_scram_secrets method usage example with argument unpacking
kwargs: ListScramSecretsRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
}
parent.list_scram_secrets(**kwargs)
list_tags_for_resource#
Returns a list of the tags associated with the specified resource.
Type annotations and code completion for session.create_client("kafka").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_vpc_connections#
Returns a list of all the VPC connections in this Region.
Type annotations and code completion for session.create_client("kafka").list_vpc_connections
method.
boto3 documentation
# list_vpc_connections method definition
await def list_vpc_connections(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListVpcConnectionsResponseTypeDef: # (1)
...
# list_vpc_connections method usage example with argument unpacking
kwargs: ListVpcConnectionsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_vpc_connections(**kwargs)
put_cluster_policy#
Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.
Type annotations and code completion for session.create_client("kafka").put_cluster_policy
method.
boto3 documentation
# put_cluster_policy method definition
await def put_cluster_policy(
self,
*,
ClusterArn: str,
Policy: str,
CurrentVersion: str = ...,
) -> PutClusterPolicyResponseTypeDef: # (1)
...
# put_cluster_policy method usage example with argument unpacking
kwargs: PutClusterPolicyRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
"Policy": ...,
}
parent.put_cluster_policy(**kwargs)
reboot_broker#
Reboots brokers.
Type annotations and code completion for session.create_client("kafka").reboot_broker
method.
boto3 documentation
# reboot_broker method definition
await def reboot_broker(
self,
*,
BrokerIds: Sequence[str],
ClusterArn: str,
) -> RebootBrokerResponseTypeDef: # (1)
...
# reboot_broker method usage example with argument unpacking
kwargs: RebootBrokerRequestRequestTypeDef = { # (1)
"BrokerIds": ...,
"ClusterArn": ...,
}
parent.reboot_broker(**kwargs)
reject_client_vpc_connection#
Returns empty response.
Type annotations and code completion for session.create_client("kafka").reject_client_vpc_connection
method.
boto3 documentation
# reject_client_vpc_connection method definition
await def reject_client_vpc_connection(
self,
*,
ClusterArn: str,
VpcConnectionArn: str,
) -> Dict[str, Any]:
...
# reject_client_vpc_connection method usage example with argument unpacking
kwargs: RejectClientVpcConnectionRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
"VpcConnectionArn": ...,
}
parent.reject_client_vpc_connection(**kwargs)
tag_resource#
Adds tags to the specified MSK resource.
Type annotations and code completion for session.create_client("kafka").tag_resource
method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes the tags associated with the keys that are provided in the query.
Type annotations and code completion for session.create_client("kafka").untag_resource
method.
boto3 documentation
# untag_resource method definition
await def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_broker_count#
Updates the number of broker nodes in the cluster.
Type annotations and code completion for session.create_client("kafka").update_broker_count
method.
boto3 documentation
# update_broker_count method definition
await def update_broker_count(
self,
*,
ClusterArn: str,
CurrentVersion: str,
TargetNumberOfBrokerNodes: int,
) -> UpdateBrokerCountResponseTypeDef: # (1)
...
# update_broker_count method usage example with argument unpacking
kwargs: UpdateBrokerCountRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
"CurrentVersion": ...,
"TargetNumberOfBrokerNodes": ...,
}
parent.update_broker_count(**kwargs)
update_broker_storage#
Updates the EBS storage associated with MSK brokers.
Type annotations and code completion for session.create_client("kafka").update_broker_storage
method.
boto3 documentation
# update_broker_storage method definition
await def update_broker_storage(
self,
*,
ClusterArn: str,
CurrentVersion: str,
TargetBrokerEBSVolumeInfo: Sequence[BrokerEBSVolumeInfoTypeDef], # (1)
) -> UpdateBrokerStorageResponseTypeDef: # (2)
...
# update_broker_storage method usage example with argument unpacking
kwargs: UpdateBrokerStorageRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
"CurrentVersion": ...,
"TargetBrokerEBSVolumeInfo": ...,
}
parent.update_broker_storage(**kwargs)
update_broker_type#
Updates EC2 instance type.
Type annotations and code completion for session.create_client("kafka").update_broker_type
method.
boto3 documentation
# update_broker_type method definition
await def update_broker_type(
self,
*,
ClusterArn: str,
CurrentVersion: str,
TargetInstanceType: str,
) -> UpdateBrokerTypeResponseTypeDef: # (1)
...
# update_broker_type method usage example with argument unpacking
kwargs: UpdateBrokerTypeRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
"CurrentVersion": ...,
"TargetInstanceType": ...,
}
parent.update_broker_type(**kwargs)
update_cluster_configuration#
Updates the cluster with the configuration that is specified in the request body.
Type annotations and code completion for session.create_client("kafka").update_cluster_configuration
method.
boto3 documentation
# update_cluster_configuration method definition
await def update_cluster_configuration(
self,
*,
ClusterArn: str,
ConfigurationInfo: ConfigurationInfoTypeDef, # (1)
CurrentVersion: str,
) -> UpdateClusterConfigurationResponseTypeDef: # (2)
...
# update_cluster_configuration method usage example with argument unpacking
kwargs: UpdateClusterConfigurationRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
"ConfigurationInfo": ...,
"CurrentVersion": ...,
}
parent.update_cluster_configuration(**kwargs)
update_cluster_kafka_version#
Updates the Apache Kafka version for the cluster.
Type annotations and code completion for session.create_client("kafka").update_cluster_kafka_version
method.
boto3 documentation
# update_cluster_kafka_version method definition
await def update_cluster_kafka_version(
self,
*,
ClusterArn: str,
CurrentVersion: str,
TargetKafkaVersion: str,
ConfigurationInfo: ConfigurationInfoTypeDef = ..., # (1)
) -> UpdateClusterKafkaVersionResponseTypeDef: # (2)
...
# update_cluster_kafka_version method usage example with argument unpacking
kwargs: UpdateClusterKafkaVersionRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
"CurrentVersion": ...,
"TargetKafkaVersion": ...,
}
parent.update_cluster_kafka_version(**kwargs)
update_configuration#
Updates an MSK configuration.
Type annotations and code completion for session.create_client("kafka").update_configuration
method.
boto3 documentation
# update_configuration method definition
await def update_configuration(
self,
*,
Arn: str,
ServerProperties: Union[str, bytes, IO[Any], StreamingBody],
Description: str = ...,
) -> UpdateConfigurationResponseTypeDef: # (1)
...
# update_configuration method usage example with argument unpacking
kwargs: UpdateConfigurationRequestRequestTypeDef = { # (1)
"Arn": ...,
"ServerProperties": ...,
}
parent.update_configuration(**kwargs)
update_connectivity#
Updates the cluster's connectivity configuration.
Type annotations and code completion for session.create_client("kafka").update_connectivity
method.
boto3 documentation
# update_connectivity method definition
await def update_connectivity(
self,
*,
ClusterArn: str,
ConnectivityInfo: ConnectivityInfoTypeDef, # (1)
CurrentVersion: str,
) -> UpdateConnectivityResponseTypeDef: # (2)
...
# update_connectivity method usage example with argument unpacking
kwargs: UpdateConnectivityRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
"ConnectivityInfo": ...,
"CurrentVersion": ...,
}
parent.update_connectivity(**kwargs)
update_monitoring#
Updates the monitoring settings for the cluster.
Type annotations and code completion for session.create_client("kafka").update_monitoring
method.
boto3 documentation
# update_monitoring method definition
await def update_monitoring(
self,
*,
ClusterArn: str,
CurrentVersion: str,
EnhancedMonitoring: EnhancedMonitoringType = ..., # (1)
OpenMonitoring: OpenMonitoringInfoTypeDef = ..., # (2)
LoggingInfo: LoggingInfoTypeDef = ..., # (3)
) -> UpdateMonitoringResponseTypeDef: # (4)
...
- See EnhancedMonitoringType
- See OpenMonitoringInfoTypeDef
- See LoggingInfoTypeDef
- See UpdateMonitoringResponseTypeDef
# update_monitoring method usage example with argument unpacking
kwargs: UpdateMonitoringRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
"CurrentVersion": ...,
}
parent.update_monitoring(**kwargs)
update_security#
Updates the security settings for the cluster.
Type annotations and code completion for session.create_client("kafka").update_security
method.
boto3 documentation
# update_security method definition
await def update_security(
self,
*,
ClusterArn: str,
CurrentVersion: str,
ClientAuthentication: ClientAuthenticationTypeDef = ..., # (1)
EncryptionInfo: EncryptionInfoTypeDef = ..., # (2)
) -> UpdateSecurityResponseTypeDef: # (3)
...
# update_security method usage example with argument unpacking
kwargs: UpdateSecurityRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
"CurrentVersion": ...,
}
parent.update_security(**kwargs)
update_storage#
Updates cluster broker volume size (or) sets cluster storage mode to TIERED.
Type annotations and code completion for session.create_client("kafka").update_storage
method.
boto3 documentation
# update_storage method definition
await def update_storage(
self,
*,
ClusterArn: str,
CurrentVersion: str,
ProvisionedThroughput: ProvisionedThroughputTypeDef = ..., # (1)
StorageMode: StorageModeType = ..., # (2)
VolumeSizeGB: int = ...,
) -> UpdateStorageResponseTypeDef: # (3)
...
# update_storage method usage example with argument unpacking
kwargs: UpdateStorageRequestRequestTypeDef = { # (1)
"ClusterArn": ...,
"CurrentVersion": ...,
}
parent.update_storage(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("kafka").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> KafkaClient:
...
__aexit__#
Type annotations and code completion for session.create_client("kafka").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.create_client("kafka").get_paginator
method with overloads.
client.get_paginator("list_client_vpc_connections")
-> ListClientVpcConnectionsPaginatorclient.get_paginator("list_cluster_operations")
-> ListClusterOperationsPaginatorclient.get_paginator("list_cluster_operations_v2")
-> ListClusterOperationsV2Paginatorclient.get_paginator("list_clusters")
-> ListClustersPaginatorclient.get_paginator("list_clusters_v2")
-> ListClustersV2Paginatorclient.get_paginator("list_configuration_revisions")
-> ListConfigurationRevisionsPaginatorclient.get_paginator("list_configurations")
-> ListConfigurationsPaginatorclient.get_paginator("list_kafka_versions")
-> ListKafkaVersionsPaginatorclient.get_paginator("list_nodes")
-> ListNodesPaginatorclient.get_paginator("list_scram_secrets")
-> ListScramSecretsPaginatorclient.get_paginator("list_vpc_connections")
-> ListVpcConnectionsPaginator