Cluster Apache Kafka Version - Amazon Managed Streaming for Apache Kafka

Cluster Apache Kafka Version

The Apache Kafka version that is on the cluster.

URI

/v1/clusters/clusterArn/version

HTTP Methods

PUT

Operation ID: UpdateClusterKafkaVersion

Updates the cluster to the specified Apache Kafka version.

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

Example PUT

{ "targetKafkaVersion": "string", "configurationInfo": { "arn": "string", "revision": integer }, "currentVersion": "string" }

Response Bodies

Example UpdateClusterKafkaVersionResponse

{ "clusterArn": "string", "clusterOperationArn": "string" }

Example Error

{ "message": "string", "invalidParameter": "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
message

string

False

The description of the error.

invalidParameter

string

False

The parameter that caused the error.

UpdateClusterKafkaVersionRequest

Request body for UpdateClusterKafkaVersion.

Property Type Required Description
targetKafkaVersion

string

True

Target Kafka version.

configurationInfo

ConfigurationInfo

False

The custom configuration that should be applied on the new version of cluster.

currentVersion

string

True

Current cluster 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.

See Also

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

UpdateClusterKafkaVersion