Menu
AWS Snowball
API Reference

ClusterMetadata

Contains metadata about a specific cluster.

Contents

AddressId

The automatically generated ID for a specific address.

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 automatically generated ID for a cluster.

Type: String

Length Constraints: Minimum length of 1.

Required: No

ClusterState

The current status of the cluster.

Type: String

Valid Values: AwaitingQuorum | Pending | InUse | Complete | Cancelled

Required: No

CreationDate

The creation date for this cluster.

Type: Timestamp

Required: No

Description

The optional description of the cluster.

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

KmsKeyARN

The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created 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 arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

Type: JobResource object

Required: No

RoleARN

The role ARN associated with this cluster. This ARN was created 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: No

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

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

See Also

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

On this page: