Stop Topic Reassignment - Amazon Managed Streaming for Apache Kafka
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

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.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

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

topicReassignmentOperationArnStringTrue

The Amazon Resource Name (ARN) of the topic reassignment operation to stop.

Responses
Status codeResponse modelDescription
200StopTopicReassignmentResponse

Successful response.

400Error

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

401Error

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

403Error

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

404Error

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

429Error

429 response

500Error

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

503Error

503 response

OPTIONS

Enable CORS by returning correct headers

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

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

topicReassignmentOperationArnStringTrue
Responses
Status codeResponse modelDescription
200None

Default response for CORS method

Schemas

Response bodies

{ "topicReassignmentOperationArn": "string", "status": enum }
{ "message": "string", "invalidParameter": "string" }

Properties

Error

Returns information about an error.

PropertyTypeRequiredDescription
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.

PropertyTypeRequiredDescription
status

TopicReassignmentStatus

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.

  • PENDING

  • IN_PROGRESS

  • STOPPING

  • COMPLETE

  • FAILED

  • STOPPED

See also

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

StopTopicReassignment