UpdateStorage - Amazon Managed Streaming for Apache Kafka

UpdateStorage

Updates cluster broker volume size (or) sets cluster storage mode to TIERED.

URI

/v1/clusters/clusterArn/storage

HTTP methods

OPTIONS

Enable CORS by returning the correct headers.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

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

Responses
Status codeResponse modelDescription
200None

Default response for CORS method

PUT

Operation ID: UpdateStorage

Updates cluster broker volume size (or) sets cluster storage mode to TIERED.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

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

Responses
Status codeResponse modelDescription
200 UpdateStorageResponse

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

Schemas

Request bodies

{ "currentVersion": "string", "provisionedThroughput": { "enabled": boolean, "volumeThroughput": integer }, "storageMode": enum, "volumeSizeGB": integer }

Response bodies

{ "clusterArn": "string", "clusterOperationArn": "string" }
{ "invalidParameter": "string", "message": "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.

ProvisionedThroughput

Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.

PropertyTypeRequiredDescription
enabled

boolean

False

Provisioned throughput is enabled or not.

volumeThroughput

integer

False

Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

StorageMode

Controls storage mode for various supported storage tiers.

  • LOCAL

  • TIERED

UpdateStorageRequest

Request object for UpdateStorageApi.

PropertyTypeRequiredDescription
currentVersion

string

True

The version of cluster to update from. A successful operation will then generate a new version.

provisionedThroughput

ProvisionedThroughput

False

EBS volume provisioned throughput information.

storageMode

StorageMode

False

Controls storage mode for supported storage tiers.

volumeSizeGB

integer

False

size of the EBS volume to update.

UpdateStorageResponse

Response body for UpdateStorageResponse Api.

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

UpdateStorage