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.

Topic Reassignment

URI

/v1/clusters/clusterArn/topic-reassignments/topicReassignmentOperationArn

HTTP methods

GET

Operation ID: DescribeTopicReassignment

Returns the progress of a topic reassignment. The partition counters (migratedPartitions against totalPartitions) advance continuously and are the most responsive signal that a long-running reassignment is making progress; the topic counters (completedTopics against totalTopics) advance only as whole topics finish.

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.

Responses
Status codeResponse modelDescription
200DescribeTopicReassignmentResponse

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", "clusterArn": "string", "targetInstanceType": "string", "topicsToInclude": [ "string" ], "topicsToExclude": [ "string" ], "status": enum, "totalTopics": integer, "completedTopics": integer, "totalPartitions": integer, "migratedPartitions": integer, "errorInfo": { "errorString": "string", "errorCode": "string" }, "creationTime": "string", "lastUpdateTime": "string" }
{ "message": "string", "invalidParameter": "string" }

Properties

DescribeTopicReassignmentResponse

Returns the status and progress of a topic reassignment operation.

PropertyTypeRequiredDescription
clusterArn

string

MaxLength: 2048

False

The Amazon Resource Name (ARN) of the cluster.

completedTopics

integer

False

Number of topics fully migrated to the target broker type.

creationTime

string

False

When the operation was created.

errorInfo

ErrorInfo

False

Error details. Present only when status is FAILED.

lastUpdateTime

string

False

Last time the status or progress counters were updated.

migratedPartitions

integer

False

Number of partitions confirmed on the target broker type.

status

TopicReassignmentStatus

False

The current status of the reassignment operation.

targetInstanceType

string

False

The target broker instance type for this reassignment.

topicReassignmentOperationArn

string

MaxLength: 2048

False

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

topicsToExclude

Array of type string

False

The original exclude patterns provided in the request.

topicsToInclude

Array of type string

False

The original include patterns provided in the request.

totalPartitions

integer

False

Total number of partitions across all matched topics.

totalTopics

integer

False

Total number of topics matching the selector at resolution time.

Error

Returns information about an error.

PropertyTypeRequiredDescription
invalidParameter

string

False

The parameter that caused the error.

message

string

False

The description of the error.

ErrorInfo

Returns information about an error state of the cluster.

PropertyTypeRequiredDescription
errorCode

string

False

A number describing the error programmatically.

errorString

string

False

An optional field to provide more details about the error.

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:

DescribeTopicReassignment