Reboot Broker - Amazon Managed Streaming for Apache Kafka

Reboot Broker

URI

/v1/clusters/clusterArn/reboot-broker

HTTP Methods

PUT

Operation ID: RebootBroker

Reboots a broker node for a cluster. You can reboot one broker at a time, in a given cluster whose Amazon Resource Name (ARN) is specified in the request. The ID of the broker to be rebooted should be specified in the request body. To reboot a broker, wait for the cluster to be in the ACTIVE state.

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 RebootBrokerResponse

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

Schemas

Request Bodies

Example PUT

{ "brokerIds": [ "string" ] }

Response Bodies

Example RebootBrokerResponse

{ "clusterArn": "string", "clusterOperationArn": "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.

RebootBrokerRequest

The request body for the RebootBroker action.

Property Type Required Description
brokerIds

Array of type string

True

The list of broker IDs to be rebooted. Note that only one broker ID can be specified.

RebootBrokerResponse

The response body for RebootBroker.

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:

RebootBroker