Kafka / Client / get_bootstrap_brokers

get_bootstrap_brokers#

Kafka.Client.get_bootstrap_brokers(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.get_bootstrap_brokers(
    ClusterArn='string'
)
Parameters:

ClusterArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'BootstrapBrokerString': 'string',
    'BootstrapBrokerStringTls': 'string',
    'BootstrapBrokerStringSaslScram': 'string',
    'BootstrapBrokerStringSaslIam': 'string',
    'BootstrapBrokerStringPublicTls': 'string',
    'BootstrapBrokerStringPublicSaslScram': 'string',
    'BootstrapBrokerStringPublicSaslIam': 'string'
}

Response Structure

  • (dict) –

    Successful response.

    • BootstrapBrokerString (string) –

      A string containing one or more hostname:port pairs.

    • BootstrapBrokerStringTls (string) –

      A string containing one or more DNS names (or IP) and TLS port pairs.

    • BootstrapBrokerStringSaslScram (string) –

      A string containing one or more DNS names (or IP) and Sasl Scram port pairs.

    • BootstrapBrokerStringSaslIam (string) –

      A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.

    • BootstrapBrokerStringPublicTls (string) –

      A string containing one or more DNS names (or IP) and TLS port pairs.

    • BootstrapBrokerStringPublicSaslScram (string) –

      A string containing one or more DNS names (or IP) and Sasl Scram port pairs.

    • BootstrapBrokerStringPublicSaslIam (string) –

      A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.

Exceptions

  • Kafka.Client.exceptions.BadRequestException

  • Kafka.Client.exceptions.UnauthorizedException

  • Kafka.Client.exceptions.InternalServerErrorException

  • Kafka.Client.exceptions.ConflictException

  • Kafka.Client.exceptions.ForbiddenException