Broker Type - Amazon Managed Streaming for Apache Kafka

Broker Type

The type of brokers in the cluster. All of the brokers in a cluster are the same type.

URI

/v1/clusters/clusterArn/nodes/type

HTTP methods

PUT

Operation ID: UpdateBrokerType

For information about this operation, see Updating the broker type in the developer guide.

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 UpdateBrokerTypeResponse

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.

404 Error

The resource could not be found due to incorrect input. Correct the input, then retry the request.

429 Error

429 response

500 Error

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

503 Error

503 response

OPTIONS

Enable CORS by returning the correct headers.

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 None

Default response for CORS method

Schemas

Request bodies

{ "targetInstanceType": "string", "currentVersion": "string" }

Response bodies

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

Properties

Error

Returns information about an error.

Property Type Required Description
invalidParameter

string

False

The parameter that caused the error.

message

string

False

The description of the error.

UpdateBrokerTypeRequest

Request body for UpdateBrokerType.

Property Type Required Description
currentVersion

string

True

Current cluster version.

targetInstanceType

string

True

The type of Amazon EC2 instances to use for Kafka brokers.

UpdateBrokerTypeResponse

Response body for UpdateBrokerType.

Property Type Required Description
clusterArn

string

False

The Amazon Resource Name (ARN) of the cluster.

clusterOperationArn

string

False

The Amazon Resource Name (ARN) of the cluster operation.

See also

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

UpdateBrokerType