Cluster Apache Kafka Version
The Apache Kafka version that is on the cluster.
URI
/v1/clusters/
clusterArn
/version
HTTP methods
OPTIONS
Enable CORS by returning the correct headers.
Name | Type | Required | Description |
---|---|---|---|
clusterArn | String | True | The Amazon Resource Name (ARN) that uniquely identifies the cluster. |
Status code | Response model | Description |
---|---|---|
200 | None | Default response for CORS method |
PUT
Operation ID: UpdateClusterKafkaVersion
Updates the cluster to the specified Apache Kafka version. Before you invoke this operation, ensure that the number of partitions per broker on your MSK cluster is under the limits described in Number of partitions per broker
Name | Type | Required | Description |
---|---|---|---|
clusterArn | String | True | The Amazon Resource Name (ARN) that uniquely identifies the cluster. |
Status code | Response model | Description |
---|---|---|
200 |
UpdateClusterKafkaVersionResponse | 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
{ "configurationInfo": { "arn": "string", "revision": integer }, "currentVersion": "string", "targetKafkaVersion": "string" }
Response bodies
{ "clusterArn": "string", "clusterOperationArn": "string" }
{ "invalidParameter": "string", "message": "string" }
Properties
ConfigurationInfo
Specifies the configuration to use for the brokers.
Property | Type | Required | Description |
---|---|---|---|
arn | string | True | ARN of the configuration to use. |
revision | integer Format: int64 Minimum: 1 | True | The revision of the configuration to use. |
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. |
UpdateClusterKafkaVersionRequest
Request body for UpdateClusterKafkaVersion.
Property | Type | Required | Description |
---|---|---|---|
configurationInfo | False | The custom configuration that should be applied on the new version of cluster. | |
currentVersion | string | True | Current cluster version. |
targetKafkaVersion | string | True | Target Apache Kafka version. |
UpdateClusterKafkaVersionResponse
Response body for UpdateClusterKafkaVersion.
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. |