Amazon Managed Streaming for Apache Kafka
Amazon MSK API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

BootstrapBrokers

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

URI

/v1/clusters/clusterArn/bootstrap-brokers

HTTP Methods

GET

Operation ID: GetBootstrapBrokers

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

Path Parameters

Name Type Required Description
clusterArn String True

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

Responses

Status Code Response Model Description
200 GetBootstrapBrokersResponse

Successful response.

400 Error

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

401 Error

The request is not authorized. The provided credentials couldn't be validated.

403 Error

Access forbidden. Check your credentials and then retry your request.

409 Error

This cluster name already exists. Retry your request using another name.

500 Error

There was an unexpected internal server error. Retrying your request might resolve the issue.

Schemas

Response Bodies

Example GetBootstrapBrokersResponse

{ "bootstrapBrokerString": "string", "bootstrapBrokerStringTls": "string" }

Example Error

{ "message": "string", "invalidParameter": "string" }

Properties

Error

Returns information about an error.

Property Type Required Description
message

string

False

The description of the error.

invalidParameter

string

False

The parameter that caused the error.

GetBootstrapBrokersResponse

Returns a string containing one or more hostname:port pairs.

Property Type Required Description
bootstrapBrokerString

string

False

A string containing one or more hostname:port pairs.

bootstrapBrokerStringTls

string

False

A string containing one or more DNS names (or IP) and TLS port pairs. The following is an example.

{ "BootstrapBrokerStringTls": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094" }

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetBootstrapBrokers