Menu
AWS Snowball
API Reference

CreateCluster

Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.

Request Syntax

{
   "AddressId": "string",
   "Description": "string",
   "ForwardingAddressId": "string",
   "JobType": "string",
   "KmsKeyARN": "string",
   "Notification": { 
      "JobStatesToNotify": [ "string" ],
      "NotifyAll": boolean,
      "SnsTopicARN": "string"
   },
   "Resources": { 
      "LambdaResources": [ 
         { 
            "EventTriggers": [ 
               { 
                  "EventResourceARN": "string"
               }
            ],
            "LambdaArn": "string"
         }
      ],
      "S3Resources": [ 
         { 
            "BucketArn": "string",
            "KeyRange": { 
               "BeginMarker": "string",
               "EndMarker": "string"
            }
         }
      ]
   },
   "RoleARN": "string",
   "ShippingOption": "string",
   "SnowballType": "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 for the address that you want the cluster shipped to.>

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

Description

An optional description of this specific cluster, for example Environmental Data Cluster-01.

Type: String

Length Constraints: Minimum length of 1.

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

JobType

The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

Type: String

Valid Values: IMPORT | EXPORT | LOCAL_USE

Required: Yes

KmsKeyARN

The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

Type: String

Length Constraints: Maximum length of 255.

Pattern: arn:aws.*:kms:.*:[0-9]{12}:key/.*

Required: No

Notification

The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

Type: Notification object

Required: No

Resources

The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language.

Type: JobResource object

Required: Yes

RoleARN

The RoleARN that you want to associate with this cluster. RoleArn values are created by using 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: Yes

ShippingOption

The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:

  • In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snowball Edges shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

  • In India, Snowball Edges are delivered in one to seven days.

  • In the US, you have access to one-day shipping and two-day shipping.

Type: String

Valid Values: SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD

Required: Yes

SnowballType

The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is EDGE.

Type: String

Valid Values: STANDARD | EDGE

Required: No

Response Syntax

{
   "ClusterId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ClusterId

The automatically generated ID for a cluster.

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}

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidInputCombinationException

Job or cluster creation failed. One ore more inputs were invalid. Confirm that the CreateCluster:SnowballType value supports your CreateJob:JobType, and try again.

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: