Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1426146126.4 KB

While a cluster's <code>ClusterState</code> value is in the <code>AwaitingQuorum</code> state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.

post/#X-Amz-Target=AWSIESnowballJobManagementService.UpdateCluster

Headers

X-Amz-Target'AWSIESnowballJobManagementService.UpdateCluster' required

Request body

ClusterIdstring required

The cluster ID of the cluster that you want to update, for example <code>CID123e4567-e89b-12d3-a456-426655440000</code>.

RoleARNstring

The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in Identity and Access Management (IAM).

Descriptionstring

The updated description of this cluster.

AddressIdstring

The ID of the updated <a>Address</a> object.

ShippingOption'SECOND_DAY' | 'NEXT_DAY' | 'EXPRESS' | 'STANDARD'

The updated shipping option value of this cluster's <a>ShippingDetails</a> object.

ForwardingAddressIdstring

The updated ID for the forwarding address for a cluster. This field is not supported in most regions.

Response

Success

UpdateClusterResult required