Stop Topic Reassignment
URI
/v1/clusters/clusterArn/topic-reassignments/topicReassignmentOperationArn/stop
HTTP methods
POST
Operation ID: StopTopicReassignment
Stops an active topic reassignment. The operation returns STOPPING
immediately and the reassignment reaches STOPPED once the partitions that
were in flight have reverted.
Only the in-flight batch is reverted. Partitions that already finished moving stay on
the target brokers. To move them back, start a new reassignment whose
targetInstanceType names the brokers you want them on.
A reassignment that has already reached a terminal status cannot be stopped.
| Name | Type | Required | Description |
|---|---|---|---|
clusterArn | String | True | The Amazon Resource Name (ARN) that uniquely identifies the cluster. |
topicReassignmentOperationArn | String | True | The Amazon Resource Name (ARN) of the topic reassignment operation to stop. |
| Status code | Response model | Description |
|---|---|---|
200 | StopTopicReassignmentResponse | 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 correct headers
| Name | Type | Required | Description |
|---|---|---|---|
clusterArn | String | True | The Amazon Resource Name (ARN) that uniquely identifies the cluster. |
topicReassignmentOperationArn | String | True |
| Status code | Response model | Description |
|---|---|---|
200 | None | Default response for CORS method |
Schemas
Response bodies
{ "topicReassignmentOperationArn": "string", "status": enum }
{ "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. |
StopTopicReassignmentResponse
Returns the result of stopping a topic reassignment operation.
| Property | Type | Required | Description |
|---|---|---|---|
status | False | The current status of the operation. Will be STOPPING. | |
topicReassignmentOperationArn | string MaxLength: 2048 | False | The Amazon Resource Name (ARN) of the topic reassignment operation. |
TopicReassignmentStatus
The lifecycle status of a topic reassignment. A reassignment that is
PENDING has been recorded but has not started moving partitions yet, and one
that is IN_PROGRESS is moving them. STOPPING means that
StopTopicReassignment was called and the in-flight partitions are reverting.
A reassignment is COMPLETE when every selected topic is on the target broker
type, STOPPED when it stopped at your request, in which case the partitions
that had already moved remain on the target broker type, and FAILED when it
stopped on an error that errorInfo explains.
PENDINGIN_PROGRESSSTOPPINGCOMPLETEFAILEDSTOPPED
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: