URI HTTP methods Schemas Properties See also

Clusters clusterArn Rebalancing

URI

/v1/clusters/clusterArn/rebalancing

HTTP methods

PUT

Operation ID: UpdateRebalancing

Use this resource to update the intelligent rebalancing status of an Amazon MSK Provisioned cluster with Express brokers.

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`	`UpdateRebalancingResponse`	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

Use this resource to update the intelligent rebalancing status of an Amazon MSK Provisioned cluster with Express brokers.

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


{
  "currentVersion": "string",
  "rebalancing": {
    "status": enum
  }
}

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.

Rebalancing

Specifies whether or not intelligent rebalancing is turned on for a newly created MSK Provisioned cluster with Express brokers. Intelligent rebalancing performs automatic partition balancing operations when you scale your clusters up or down.

By default, intelligent rebalancing is ACTIVE for all new Express-based clusters.

Property	Type	Required	Description
`status`	RebalancingStatus	True	Intelligent rebalancing status. The default intelligent rebalancing status is `ACTIVE` for all new Express-based clusters.

RebalancingStatus

Intelligent rebalancing status. The default intelligent rebalancing status is ACTIVE for all new Express-based clusters.

PAUSED
ACTIVE

UpdateRebalancingRequest

Updates the intelligent rebalancing status for a new MSK Provisioned cluster with Express brokers.

Property	Type	Required	Description
`currentVersion`	string	True	The current version of the cluster.
`rebalancing`	Rebalancing	True	Specifies if intelligent rebalancing should be turned on for your cluster. The default intelligent rebalancing status is `ACTIVE` for all new MSK Provisioned clusters that you create with Express brokers.

UpdateRebalancingResponse

Provides information about the intelligent rebalancing update for a cluster.

Property	Type	Required	Description
`clusterArn`	string	False	The Amazon Resource Name (ARN) of the cluster whose intelligent rebalancing status you've updated.
`clusterOperationArn`	string	False	The Amazon Resource Name (ARN) of the cluster operation.