UpdateCluster
While a cluster's ClusterState
value is in the AwaitingQuorum
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.
Request Syntax
{
"AddressId": "string
",
"ClusterId": "string
",
"Description": "string
",
"ForwardingAddressId": "string
",
"Notification": {
"DevicePickupSnsTopicARN": "string
",
"JobStatesToNotify": [ "string
" ],
"NotifyAll": boolean
,
"SnsTopicARN": "string
"
},
"OnDeviceServiceConfiguration": {
"EKSOnDeviceService": {
"EKSAnywhereVersion": "string
",
"KubernetesVersion": "string
"
},
"NFSOnDeviceService": {
"StorageLimit": number
,
"StorageUnit": "string
"
},
"S3OnDeviceService": {
"FaultTolerance": number
,
"ServiceSize": number
,
"StorageLimit": number
,
"StorageUnit": "string
"
},
"TGWOnDeviceService": {
"StorageLimit": number
,
"StorageUnit": "string
"
}
},
"Resources": {
"Ec2AmiResources": [
{
"AmiId": "string
",
"SnowballAmiId": "string
"
}
],
"LambdaResources": [
{
"EventTriggers": [
{
"EventResourceARN": "string
"
}
],
"LambdaArn": "string
"
}
],
"S3Resources": [
{
"BucketArn": "string
",
"KeyRange": {
"BeginMarker": "string
",
"EndMarker": "string
"
},
"TargetOnDeviceServices": [
{
"ServiceName": "string
",
"TransferOption": "string
"
}
]
}
]
},
"RoleARN": "string
",
"ShippingOption": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AddressId
-
The ID of the updated Address object.
Type: String
Length Constraints: Fixed length of 40.
Pattern:
ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
Required: No
- ClusterId
-
The cluster ID of the cluster that you want to update, for example
CID123e4567-e89b-12d3-a456-426655440000
.Type: String
Length Constraints: Fixed length of 39.
Pattern:
CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
Required: Yes
- Description
-
The updated description of this cluster.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*
Required: No
- ForwardingAddressId
-
This field is not supported in your region.
Type: String
Length Constraints: Fixed length of 40.
Pattern:
ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
Required: No
- Notification
-
The new or updated Notification object.
Type: Notification object
Required: No
- OnDeviceServiceConfiguration
-
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family device clusters support Amazon S3 and NFS (Network File System).
Type: OnDeviceServiceConfiguration object
Required: No
- Resources
-
The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
Type: JobResource object
Required: No
- RoleARN
-
The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in AWS Identity and Access Management (IAM).
Type: String
Length Constraints: Maximum length of 255.
Pattern:
arn:aws.*:iam::[0-9]{12}:role/.*
Required: No
- ShippingOption
-
The updated shipping option value of this cluster's ShippingDetails object.
Type: String
Valid Values:
SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD
Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- Ec2RequestFailedException
-
Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
HTTP Status Code: 400
- InvalidInputCombinationException
-
Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateCluster:SnowballType value supports your CreateJob:JobType, and try again.
HTTP Status Code: 400
- InvalidJobStateException
-
The action can't be performed because the job's current state doesn't allow that action to be performed.
HTTP Status Code: 400
- InvalidResourceException
-
The specified resource can't be found. Check the information you provided in your last request, and try again.
HTTP Status Code: 400
- KMSRequestFailedException
-
The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: