CancelCluster

$result = $client->cancelCluster([/* ... */]);
$promise = $client->cancelClusterAsync([/* ... */]);

Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it.

Parameter Syntax

$result = $client->cancelCluster([
    'ClusterId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

KMSRequestFailedException:

The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

InvalidJobStateException:

The action can't be performed because the job's current state doesn't allow that action to be performed.

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

Examples

Example 1: To cancel a cluster job

This operation cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status.

$result = $client->cancelCluster([
    'ClusterId' => 'CID123e4567-e89b-12d3-a456-426655440000',
]);

CancelJob

$result = $client->cancelJob([/* ... */]);
$promise = $client->cancelJobAsync([/* ... */]);

Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned.

Parameter Syntax

$result = $client->cancelJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidJobStateException:

The action can't be performed because the job's current state doesn't allow that action to be performed.

KMSRequestFailedException:

The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

Examples

Example 1: To cancel a job for a Snowball device

This operation cancels a job. You can only cancel a job before its JobState value changes to PreparingAppliance.

$result = $client->cancelJob([
    'JobId' => 'JID123e4567-e89b-12d3-a456-426655440000',
]);

CreateAddress

$result = $client->createAddress([/* ... */]);
$promise = $client->createAddressAsync([/* ... */]);

Creates an address for a Snow device to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown. If providing an address as a JSON file through the cli-input-json option, include the full file path. For example, --cli-input-json file://create-address.json.

Parameter Syntax

$result = $client->createAddress([
    'Address' => [ // REQUIRED
        'AddressId' => '<string>',
        'City' => '<string>',
        'Company' => '<string>',
        'Country' => '<string>',
        'IsRestricted' => true || false,
        'Landmark' => '<string>',
        'Name' => '<string>',
        'PhoneNumber' => '<string>',
        'PostalCode' => '<string>',
        'PrefectureOrDistrict' => '<string>',
        'StateOrProvince' => '<string>',
        'Street1' => '<string>',
        'Street2' => '<string>',
        'Street3' => '<string>',
        'Type' => 'CUST_PICKUP|AWS_SHIP',
    ],
]);

Parameter Details

Result Syntax

[
    'AddressId' => '<string>',
]

Result Details

Errors

InvalidAddressException:

The address provided was invalid. Check the address with your region's carrier, and try again.

UnsupportedAddressException:

The address is either outside the serviceable area for your region, or an error occurred. Check the address with your region's carrier and try again. If the issue persists, contact Amazon Web Services Support.

Examples

Example 1: To create an address for a job

This operation creates an address for a job. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.

$result = $client->createAddress([
    'Address' => [
        'City' => 'Seattle',
        'Company' => 'My Company's Name',
        'Country' => 'USA',
        'Name' => 'My Name',
        'PhoneNumber' => '425-555-5555',
        'PostalCode' => '98101',
        'StateOrProvince' => 'WA',
        'Street1' => '123 Main Street',
    ],
]);

Result syntax:

[
    'AddressId' => 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
]

CreateCluster

$result = $client->createCluster([/* ... */]);
$promise = $client->createClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createCluster([
    'AddressId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'ForceCreateJobs' => true || false,
    'ForwardingAddressId' => '<string>',
    'InitialClusterSize' => <integer>,
    'JobType' => 'IMPORT|EXPORT|LOCAL_USE', // REQUIRED
    'KmsKeyARN' => '<string>',
    'LongTermPricingIds' => ['<string>', ...],
    'Notification' => [
        'DevicePickupSnsTopicARN' => '<string>',
        'JobStatesToNotify' => ['<string>', ...],
        'NotifyAll' => true || false,
        'SnsTopicARN' => '<string>',
    ],
    'OnDeviceServiceConfiguration' => [
        'EKSOnDeviceService' => [
            'EKSAnywhereVersion' => '<string>',
            'KubernetesVersion' => '<string>',
        ],
        'NFSOnDeviceService' => [
            'StorageLimit' => <integer>,
            'StorageUnit' => 'TB',
        ],
        'S3OnDeviceService' => [
            'FaultTolerance' => <integer>,
            'ServiceSize' => <integer>,
            'StorageLimit' => <float>,
            'StorageUnit' => 'TB',
        ],
        'TGWOnDeviceService' => [
            'StorageLimit' => <integer>,
            'StorageUnit' => 'TB',
        ],
    ],
    'RemoteManagement' => 'INSTALLED_ONLY|INSTALLED_AUTOSTART|NOT_INSTALLED',
    'Resources' => [
        'Ec2AmiResources' => [
            [
                'AmiId' => '<string>', // REQUIRED
                'SnowballAmiId' => '<string>',
            ],
            // ...
        ],
        'LambdaResources' => [
            [
                'EventTriggers' => [
                    [
                        'EventResourceARN' => '<string>',
                    ],
                    // ...
                ],
                'LambdaArn' => '<string>',
            ],
            // ...
        ],
        'S3Resources' => [
            [
                'BucketArn' => '<string>',
                'KeyRange' => [
                    'BeginMarker' => '<string>',
                    'EndMarker' => '<string>',
                ],
                'TargetOnDeviceServices' => [
                    [
                        'ServiceName' => 'NFS_ON_DEVICE_SERVICE|S3_ON_DEVICE_SERVICE',
                        'TransferOption' => 'IMPORT|EXPORT|LOCAL_USE',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'RoleARN' => '<string>',
    'ShippingOption' => 'SECOND_DAY|NEXT_DAY|EXPRESS|STANDARD', // REQUIRED
    'SnowballCapacityPreference' => 'T50|T80|T100|T42|T98|T8|T14|T32|NoPreference|T240|T13',
    'SnowballType' => 'STANDARD|EDGE|EDGE_C|EDGE_CG|EDGE_S|SNC1_HDD|SNC1_SSD|V3_5C|V3_5S|RACK_5U_C', // REQUIRED
    'TaxDocuments' => [
        'IND' => [
            'GSTIN' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'ClusterId' => '<string>',
    'JobListEntries' => [
        [
            'CreationDate' => <DateTime>,
            'Description' => '<string>',
            'IsMaster' => true || false,
            'JobId' => '<string>',
            'JobState' => 'New|PreparingAppliance|PreparingShipment|InTransitToCustomer|WithCustomer|InTransitToAWS|WithAWSSortingFacility|WithAWS|InProgress|Complete|Cancelled|Listing|Pending',
            'JobType' => 'IMPORT|EXPORT|LOCAL_USE',
            'SnowballType' => 'STANDARD|EDGE|EDGE_C|EDGE_CG|EDGE_S|SNC1_HDD|SNC1_SSD|V3_5C|V3_5S|RACK_5U_C',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

KMSRequestFailedException:

The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

InvalidInputCombinationException:

Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.

Ec2RequestFailedException:

Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.

Examples

Example 1: To create a cluster

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.

$result = $client->createCluster([
    'AddressId' => 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
    'Description' => 'MyCluster',
    'JobType' => 'LOCAL_USE',
    'KmsKeyARN' => 'arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456',
    'Notification' => [
        'JobStatesToNotify' => [
        ],
        'NotifyAll' => ,
    ],
    'Resources' => [
        'S3Resources' => [
            [
                'BucketArn' => 'arn:aws:s3:::MyBucket',
                'KeyRange' => [
                ],
            ],
        ],
    ],
    'RoleARN' => 'arn:aws:iam::123456789012:role/snowball-import-S3-role',
    'ShippingOption' => 'SECOND_DAY',
    'SnowballType' => 'EDGE',
]);

Result syntax:

[
    'ClusterId' => 'CID123e4567-e89b-12d3-a456-426655440000',
]

CreateJob

$result = $client->createJob([/* ... */]);
$promise = $client->createJobAsync([/* ... */]);

Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web Services account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.

Snow Family devices and their capacities.

• Device type: SNC1_SSD

  • Capacity: T14

  • Description: Snowcone

• Device type: SNC1_HDD

  • Capacity: T8

  • Description: Snowcone

• Device type: EDGE_S

  • Capacity: T98

  • Description: Snowball Edge Storage Optimized for data transfer only

• Device type: EDGE_CG

  • Capacity: T42

  • Description: Snowball Edge Compute Optimized with GPU

• Device type: EDGE_C

  • Capacity: T42

  • Description: Snowball Edge Compute Optimized without GPU

• Device type: EDGE

  • Capacity: T100

  • Description: Snowball Edge Storage Optimized with EC2 Compute

  This device is replaced with T98.

• Device type: STANDARD

  • Capacity: T50

  • Description: Original Snowball device

    This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region

• Device type: STANDARD

  • Capacity: T80

  • Description: Original Snowball device

    This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.

• Snow Family device type: RACK_5U_C

  • Capacity: T13

  • Description: Snowblade.

• Device type: V3_5S

  • Capacity: T240

  • Description: Snowball Edge Storage Optimized 210TB

Parameter Syntax

$result = $client->createJob([
    'AddressId' => '<string>',
    'ClusterId' => '<string>',
    'Description' => '<string>',
    'DeviceConfiguration' => [
        'SnowconeDeviceConfiguration' => [
            'WirelessConnection' => [
                'IsWifiEnabled' => true || false,
            ],
        ],
    ],
    'ForwardingAddressId' => '<string>',
    'ImpactLevel' => 'IL2|IL4|IL5|IL6|IL99',
    'JobType' => 'IMPORT|EXPORT|LOCAL_USE',
    'KmsKeyARN' => '<string>',
    'LongTermPricingId' => '<string>',
    'Notification' => [
        'DevicePickupSnsTopicARN' => '<string>',
        'JobStatesToNotify' => ['<string>', ...],
        'NotifyAll' => true || false,
        'SnsTopicARN' => '<string>',
    ],
    'OnDeviceServiceConfiguration' => [
        'EKSOnDeviceService' => [
            'EKSAnywhereVersion' => '<string>',
            'KubernetesVersion' => '<string>',
        ],
        'NFSOnDeviceService' => [
            'StorageLimit' => <integer>,
            'StorageUnit' => 'TB',
        ],
        'S3OnDeviceService' => [
            'FaultTolerance' => <integer>,
            'ServiceSize' => <integer>,
            'StorageLimit' => <float>,
            'StorageUnit' => 'TB',
        ],
        'TGWOnDeviceService' => [
            'StorageLimit' => <integer>,
            'StorageUnit' => 'TB',
        ],
    ],
    'PickupDetails' => [
        'DevicePickupId' => '<string>',
        'Email' => '<string>',
        'IdentificationExpirationDate' => <integer || string || DateTime>,
        'IdentificationIssuingOrg' => '<string>',
        'IdentificationNumber' => '<string>',
        'Name' => '<string>',
        'PhoneNumber' => '<string>',
    ],
    'RemoteManagement' => 'INSTALLED_ONLY|INSTALLED_AUTOSTART|NOT_INSTALLED',
    'Resources' => [
        'Ec2AmiResources' => [
            [
                'AmiId' => '<string>', // REQUIRED
                'SnowballAmiId' => '<string>',
            ],
            // ...
        ],
        'LambdaResources' => [
            [
                'EventTriggers' => [
                    [
                        'EventResourceARN' => '<string>',
                    ],
                    // ...
                ],
                'LambdaArn' => '<string>',
            ],
            // ...
        ],
        'S3Resources' => [
            [
                'BucketArn' => '<string>',
                'KeyRange' => [
                    'BeginMarker' => '<string>',
                    'EndMarker' => '<string>',
                ],
                'TargetOnDeviceServices' => [
                    [
                        'ServiceName' => 'NFS_ON_DEVICE_SERVICE|S3_ON_DEVICE_SERVICE',
                        'TransferOption' => 'IMPORT|EXPORT|LOCAL_USE',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'RoleARN' => '<string>',
    'ShippingOption' => 'SECOND_DAY|NEXT_DAY|EXPRESS|STANDARD',
    'SnowballCapacityPreference' => 'T50|T80|T100|T42|T98|T8|T14|T32|NoPreference|T240|T13',
    'SnowballType' => 'STANDARD|EDGE|EDGE_C|EDGE_CG|EDGE_S|SNC1_HDD|SNC1_SSD|V3_5C|V3_5S|RACK_5U_C',
    'TaxDocuments' => [
        'IND' => [
            'GSTIN' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

KMSRequestFailedException:

The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

InvalidInputCombinationException:

Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.

ClusterLimitExceededException:

Job creation failed. Currently, clusters support five nodes. If you have fewer than five nodes for your cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster has exactly five nodes.

Ec2RequestFailedException:

Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.

Examples

Example 1: To create a job

Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.

$result = $client->createJob([
    'AddressId' => 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
    'Description' => 'My Job',
    'JobType' => 'IMPORT',
    'KmsKeyARN' => 'arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456',
    'Notification' => [
        'JobStatesToNotify' => [
        ],
        'NotifyAll' => ,
    ],
    'Resources' => [
        'S3Resources' => [
            [
                'BucketArn' => 'arn:aws:s3:::MyBucket',
                'KeyRange' => [
                ],
            ],
        ],
    ],
    'RoleARN' => 'arn:aws:iam::123456789012:role/snowball-import-S3-role',
    'ShippingOption' => 'SECOND_DAY',
    'SnowballCapacityPreference' => 'T80',
    'SnowballType' => 'STANDARD',
]);

Result syntax:

[
    'JobId' => 'JID123e4567-e89b-12d3-a456-426655440000',
]

CreateLongTermPricing

$result = $client->createLongTermPricing([/* ... */]);
$promise = $client->createLongTermPricingAsync([/* ... */]);

Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.

Parameter Syntax

$result = $client->createLongTermPricing([
    'IsLongTermPricingAutoRenew' => true || false,
    'LongTermPricingType' => 'OneYear|ThreeYear|OneMonth', // REQUIRED
    'SnowballType' => 'STANDARD|EDGE|EDGE_C|EDGE_CG|EDGE_S|SNC1_HDD|SNC1_SSD|V3_5C|V3_5S|RACK_5U_C', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'LongTermPricingId' => '<string>',
]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

CreateReturnShippingLabel

$result = $client->createReturnShippingLabel([/* ... */]);
$promise = $client->createReturnShippingLabelAsync([/* ... */]);

Creates a shipping label that will be used to return the Snow device to Amazon Web Services.

Parameter Syntax

$result = $client->createReturnShippingLabel([
    'JobId' => '<string>', // REQUIRED
    'ShippingOption' => 'SECOND_DAY|NEXT_DAY|EXPRESS|STANDARD',
]);

Parameter Details

Result Syntax

[
    'Status' => 'InProgress|TimedOut|Succeeded|Failed',
]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidJobStateException:

The action can't be performed because the job's current state doesn't allow that action to be performed.

InvalidInputCombinationException:

Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.

ConflictException:

You get this exception when you call CreateReturnShippingLabel more than once when other requests are not completed.

ReturnShippingLabelAlreadyExistsException:

You get this exception if you call CreateReturnShippingLabel and a valid return shipping label already exists. In this case, use DescribeReturnShippingLabel to get the URL.

DescribeAddress

$result = $client->describeAddress([/* ... */]);
$promise = $client->describeAddressAsync([/* ... */]);

Takes an AddressId and returns specific details about that address in the form of an Address object.

Parameter Syntax

$result = $client->describeAddress([
    'AddressId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Address' => [
        'AddressId' => '<string>',
        'City' => '<string>',
        'Company' => '<string>',
        'Country' => '<string>',
        'IsRestricted' => true || false,
        'Landmark' => '<string>',
        'Name' => '<string>',
        'PhoneNumber' => '<string>',
        'PostalCode' => '<string>',
        'PrefectureOrDistrict' => '<string>',
        'StateOrProvince' => '<string>',
        'Street1' => '<string>',
        'Street2' => '<string>',
        'Street3' => '<string>',
        'Type' => 'CUST_PICKUP|AWS_SHIP',
    ],
]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

Examples

Example 1: To describe an address for a job

This operation describes an address for a job.

$result = $client->describeAddress([
    'AddressId' => 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
]);

Result syntax:

[
    'Address' => [
        'AddressId' => 'ADID5643ec50-3eec-4eb3-9be6-9374c10eb51b',
        'City' => 'Seattle',
        'Company' => 'My Company',
        'Country' => 'US',
        'Name' => 'My Name',
        'PhoneNumber' => '425-555-5555',
        'PostalCode' => '98101',
        'StateOrProvince' => 'WA',
        'Street1' => '123 Main Street',
    ],
]

DescribeAddresses

$result = $client->describeAddresses([/* ... */]);
$promise = $client->describeAddressesAsync([/* ... */]);

Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

Parameter Syntax

$result = $client->describeAddresses([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Addresses' => [
        [
            'AddressId' => '<string>',
            'City' => '<string>',
            'Company' => '<string>',
            'Country' => '<string>',
            'IsRestricted' => true || false,
            'Landmark' => '<string>',
            'Name' => '<string>',
            'PhoneNumber' => '<string>',
            'PostalCode' => '<string>',
            'PrefectureOrDistrict' => '<string>',
            'StateOrProvince' => '<string>',
            'Street1' => '<string>',
            'Street2' => '<string>',
            'Street3' => '<string>',
            'Type' => 'CUST_PICKUP|AWS_SHIP',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidNextTokenException:

The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

Examples

Example 1: To describe all the addresses you've created for AWS Snowball

This operation describes all the addresses that you've created for AWS Snowball. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

$result = $client->describeAddresses([
]);

Result syntax:

[
    'Addresses' => [
        [
            'AddressId' => 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
            'City' => 'Seattle',
            'Company' => 'My Company',
            'Country' => 'US',
            'Name' => 'My Name',
            'PhoneNumber' => '425-555-5555',
            'PostalCode' => '98101',
            'StateOrProvince' => 'WA',
            'Street1' => '123 Main Street',
        ],
    ],
]

DescribeCluster

$result = $client->describeCluster([/* ... */]);
$promise = $client->describeClusterAsync([/* ... */]);

Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

Parameter Syntax

$result = $client->describeCluster([
    'ClusterId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ClusterMetadata' => [
        'AddressId' => '<string>',
        'ClusterId' => '<string>',
        'ClusterState' => 'AwaitingQuorum|Pending|InUse|Complete|Cancelled',
        'CreationDate' => <DateTime>,
        'Description' => '<string>',
        'ForwardingAddressId' => '<string>',
        'JobType' => 'IMPORT|EXPORT|LOCAL_USE',
        'KmsKeyARN' => '<string>',
        'Notification' => [
            'DevicePickupSnsTopicARN' => '<string>',
            'JobStatesToNotify' => ['<string>', ...],
            'NotifyAll' => true || false,
            'SnsTopicARN' => '<string>',
        ],
        'OnDeviceServiceConfiguration' => [
            'EKSOnDeviceService' => [
                'EKSAnywhereVersion' => '<string>',
                'KubernetesVersion' => '<string>',
            ],
            'NFSOnDeviceService' => [
                'StorageLimit' => <integer>,
                'StorageUnit' => 'TB',
            ],
            'S3OnDeviceService' => [
                'FaultTolerance' => <integer>,
                'ServiceSize' => <integer>,
                'StorageLimit' => <float>,
                'StorageUnit' => 'TB',
            ],
            'TGWOnDeviceService' => [
                'StorageLimit' => <integer>,
                'StorageUnit' => 'TB',
            ],
        ],
        'Resources' => [
            'Ec2AmiResources' => [
                [
                    'AmiId' => '<string>',
                    'SnowballAmiId' => '<string>',
                ],
                // ...
            ],
            'LambdaResources' => [
                [
                    'EventTriggers' => [
                        [
                            'EventResourceARN' => '<string>',
                        ],
                        // ...
                    ],
                    'LambdaArn' => '<string>',
                ],
                // ...
            ],
            'S3Resources' => [
                [
                    'BucketArn' => '<string>',
                    'KeyRange' => [
                        'BeginMarker' => '<string>',
                        'EndMarker' => '<string>',
                    ],
                    'TargetOnDeviceServices' => [
                        [
                            'ServiceName' => 'NFS_ON_DEVICE_SERVICE|S3_ON_DEVICE_SERVICE',
                            'TransferOption' => 'IMPORT|EXPORT|LOCAL_USE',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'RoleARN' => '<string>',
        'ShippingOption' => 'SECOND_DAY|NEXT_DAY|EXPRESS|STANDARD',
        'SnowballType' => 'STANDARD|EDGE|EDGE_C|EDGE_CG|EDGE_S|SNC1_HDD|SNC1_SSD|V3_5C|V3_5S|RACK_5U_C',
        'TaxDocuments' => [
            'IND' => [
                'GSTIN' => '<string>',
            ],
        ],
    ],
]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

Examples

Example 1: To describe a cluster

Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

$result = $client->describeCluster([
    'ClusterId' => 'CID123e4567-e89b-12d3-a456-426655440000',
]);

Result syntax:

[
    'ClusterMetadata' => [
        'AddressId' => 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
        'ClusterId' => 'CID123e4567-e89b-12d3-a456-426655440000',
        'ClusterState' => 'Pending',
        'CreationDate' => ,
        'Description' => 'MyCluster',
        'JobType' => 'LOCAL_USE',
        'KmsKeyARN' => 'arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456',
        'Notification' => [
            'JobStatesToNotify' => [
            ],
            'NotifyAll' => ,
        ],
        'Resources' => [
            'S3Resources' => [
                [
                    'BucketArn' => 'arn:aws:s3:::MyBucket',
                    'KeyRange' => [
                    ],
                ],
            ],
        ],
        'RoleARN' => 'arn:aws:iam::123456789012:role/snowball-import-S3-role',
        'ShippingOption' => 'SECOND_DAY',
    ],
]

DescribeJob

$result = $client->describeJob([/* ... */]);
$promise = $client->describeJobAsync([/* ... */]);

Returns information about a specific job including shipping information, job status, and other important metadata.

Parameter Syntax

$result = $client->describeJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'JobMetadata' => [
        'AddressId' => '<string>',
        'ClusterId' => '<string>',
        'CreationDate' => <DateTime>,
        'DataTransferProgress' => [
            'BytesTransferred' => <integer>,
            'ObjectsTransferred' => <integer>,
            'TotalBytes' => <integer>,
            'TotalObjects' => <integer>,
        ],
        'Description' => '<string>',
        'DeviceConfiguration' => [
            'SnowconeDeviceConfiguration' => [
                'WirelessConnection' => [
                    'IsWifiEnabled' => true || false,
                ],
            ],
        ],
        'ForwardingAddressId' => '<string>',
        'ImpactLevel' => 'IL2|IL4|IL5|IL6|IL99',
        'JobId' => '<string>',
        'JobLogInfo' => [
            'JobCompletionReportURI' => '<string>',
            'JobFailureLogURI' => '<string>',
            'JobSuccessLogURI' => '<string>',
        ],
        'JobState' => 'New|PreparingAppliance|PreparingShipment|InTransitToCustomer|WithCustomer|InTransitToAWS|WithAWSSortingFacility|WithAWS|InProgress|Complete|Cancelled|Listing|Pending',
        'JobType' => 'IMPORT|EXPORT|LOCAL_USE',
        'KmsKeyARN' => '<string>',
        'LongTermPricingId' => '<string>',
        'Notification' => [
            'DevicePickupSnsTopicARN' => '<string>',
            'JobStatesToNotify' => ['<string>', ...],
            'NotifyAll' => true || false,
            'SnsTopicARN' => '<string>',
        ],
        'OnDeviceServiceConfiguration' => [
            'EKSOnDeviceService' => [
                'EKSAnywhereVersion' => '<string>',
                'KubernetesVersion' => '<string>',
            ],
            'NFSOnDeviceService' => [
                'StorageLimit' => <integer>,
                'StorageUnit' => 'TB',
            ],
            'S3OnDeviceService' => [
                'FaultTolerance' => <integer>,
                'ServiceSize' => <integer>,
                'StorageLimit' => <float>,
                'StorageUnit' => 'TB',
            ],
            'TGWOnDeviceService' => [
                'StorageLimit' => <integer>,
                'StorageUnit' => 'TB',
            ],
        ],
        'PickupDetails' => [
            'DevicePickupId' => '<string>',
            'Email' => '<string>',
            'IdentificationExpirationDate' => <DateTime>,
            'IdentificationIssuingOrg' => '<string>',
            'IdentificationNumber' => '<string>',
            'Name' => '<string>',
            'PhoneNumber' => '<string>',
        ],
        'RemoteManagement' => 'INSTALLED_ONLY|INSTALLED_AUTOSTART|NOT_INSTALLED',
        'Resources' => [
            'Ec2AmiResources' => [
                [
                    'AmiId' => '<string>',
                    'SnowballAmiId' => '<string>',
                ],
                // ...
            ],
            'LambdaResources' => [
                [
                    'EventTriggers' => [
                        [
                            'EventResourceARN' => '<string>',
                        ],
                        // ...
                    ],
                    'LambdaArn' => '<string>',
                ],
                // ...
            ],
            'S3Resources' => [
                [
                    'BucketArn' => '<string>',
                    'KeyRange' => [
                        'BeginMarker' => '<string>',
                        'EndMarker' => '<string>',
                    ],
                    'TargetOnDeviceServices' => [
                        [
                            'ServiceName' => 'NFS_ON_DEVICE_SERVICE|S3_ON_DEVICE_SERVICE',
                            'TransferOption' => 'IMPORT|EXPORT|LOCAL_USE',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'RoleARN' => '<string>',
        'ShippingDetails' => [
            'InboundShipment' => [
                'Status' => '<string>',
                'TrackingNumber' => '<string>',
            ],
            'OutboundShipment' => [
                'Status' => '<string>',
                'TrackingNumber' => '<string>',
            ],
            'ShippingOption' => 'SECOND_DAY|NEXT_DAY|EXPRESS|STANDARD',
        ],
        'SnowballCapacityPreference' => 'T50|T80|T100|T42|T98|T8|T14|T32|NoPreference|T240|T13',
        'SnowballId' => '<string>',
        'SnowballType' => 'STANDARD|EDGE|EDGE_C|EDGE_CG|EDGE_S|SNC1_HDD|SNC1_SSD|V3_5C|V3_5S|RACK_5U_C',
        'TaxDocuments' => [
            'IND' => [
                'GSTIN' => '<string>',
            ],
        ],
    ],
    'SubJobMetadata' => [
        [
            'AddressId' => '<string>',
            'ClusterId' => '<string>',
            'CreationDate' => <DateTime>,
            'DataTransferProgress' => [
                'BytesTransferred' => <integer>,
                'ObjectsTransferred' => <integer>,
                'TotalBytes' => <integer>,
                'TotalObjects' => <integer>,
            ],
            'Description' => '<string>',
            'DeviceConfiguration' => [
                'SnowconeDeviceConfiguration' => [
                    'WirelessConnection' => [
                        'IsWifiEnabled' => true || false,
                    ],
                ],
            ],
            'ForwardingAddressId' => '<string>',
            'ImpactLevel' => 'IL2|IL4|IL5|IL6|IL99',
            'JobId' => '<string>',
            'JobLogInfo' => [
                'JobCompletionReportURI' => '<string>',
                'JobFailureLogURI' => '<string>',
                'JobSuccessLogURI' => '<string>',
            ],
            'JobState' => 'New|PreparingAppliance|PreparingShipment|InTransitToCustomer|WithCustomer|InTransitToAWS|WithAWSSortingFacility|WithAWS|InProgress|Complete|Cancelled|Listing|Pending',
            'JobType' => 'IMPORT|EXPORT|LOCAL_USE',
            'KmsKeyARN' => '<string>',
            'LongTermPricingId' => '<string>',
            'Notification' => [
                'DevicePickupSnsTopicARN' => '<string>',
                'JobStatesToNotify' => ['<string>', ...],
                'NotifyAll' => true || false,
                'SnsTopicARN' => '<string>',
            ],
            'OnDeviceServiceConfiguration' => [
                'EKSOnDeviceService' => [
                    'EKSAnywhereVersion' => '<string>',
                    'KubernetesVersion' => '<string>',
                ],
                'NFSOnDeviceService' => [
                    'StorageLimit' => <integer>,
                    'StorageUnit' => 'TB',
                ],
                'S3OnDeviceService' => [
                    'FaultTolerance' => <integer>,
                    'ServiceSize' => <integer>,
                    'StorageLimit' => <float>,
                    'StorageUnit' => 'TB',
                ],
                'TGWOnDeviceService' => [
                    'StorageLimit' => <integer>,
                    'StorageUnit' => 'TB',
                ],
            ],
            'PickupDetails' => [
                'DevicePickupId' => '<string>',
                'Email' => '<string>',
                'IdentificationExpirationDate' => <DateTime>,
                'IdentificationIssuingOrg' => '<string>',
                'IdentificationNumber' => '<string>',
                'Name' => '<string>',
                'PhoneNumber' => '<string>',
            ],
            'RemoteManagement' => 'INSTALLED_ONLY|INSTALLED_AUTOSTART|NOT_INSTALLED',
            'Resources' => [
                'Ec2AmiResources' => [
                    [
                        'AmiId' => '<string>',
                        'SnowballAmiId' => '<string>',
                    ],
                    // ...
                ],
                'LambdaResources' => [
                    [
                        'EventTriggers' => [
                            [
                                'EventResourceARN' => '<string>',
                            ],
                            // ...
                        ],
                        'LambdaArn' => '<string>',
                    ],
                    // ...
                ],
                'S3Resources' => [
                    [
                        'BucketArn' => '<string>',
                        'KeyRange' => [
                            'BeginMarker' => '<string>',
                            'EndMarker' => '<string>',
                        ],
                        'TargetOnDeviceServices' => [
                            [
                                'ServiceName' => 'NFS_ON_DEVICE_SERVICE|S3_ON_DEVICE_SERVICE',
                                'TransferOption' => 'IMPORT|EXPORT|LOCAL_USE',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'RoleARN' => '<string>',
            'ShippingDetails' => [
                'InboundShipment' => [
                    'Status' => '<string>',
                    'TrackingNumber' => '<string>',
                ],
                'OutboundShipment' => [
                    'Status' => '<string>',
                    'TrackingNumber' => '<string>',
                ],
                'ShippingOption' => 'SECOND_DAY|NEXT_DAY|EXPRESS|STANDARD',
            ],
            'SnowballCapacityPreference' => 'T50|T80|T100|T42|T98|T8|T14|T32|NoPreference|T240|T13',
            'SnowballId' => '<string>',
            'SnowballType' => 'STANDARD|EDGE|EDGE_C|EDGE_CG|EDGE_S|SNC1_HDD|SNC1_SSD|V3_5C|V3_5S|RACK_5U_C',
            'TaxDocuments' => [
                'IND' => [
                    'GSTIN' => '<string>',
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

Examples

Example 1: To describe a job you've created for AWS Snowball

This operation describes a job you've created for AWS Snowball.

$result = $client->describeJob([
    'JobId' => 'JID123e4567-e89b-12d3-a456-426655440000',
]);

Result syntax:

[
    'JobMetadata' => [
        'AddressId' => 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
        'CreationDate' => ,
        'Description' => 'My Job',
        'JobId' => 'JID123e4567-e89b-12d3-a456-426655440000',
        'JobState' => 'New',
        'JobType' => 'IMPORT',
        'KmsKeyARN' => 'arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456',
        'Notification' => [
            'JobStatesToNotify' => [
            ],
            'NotifyAll' => ,
        ],
        'Resources' => [
            'S3Resources' => [
                [
                    'BucketArn' => 'arn:aws:s3:::MyBucket',
                    'KeyRange' => [
                    ],
                ],
            ],
        ],
        'RoleARN' => 'arn:aws:iam::123456789012:role/snowball-import-S3-role',
        'ShippingDetails' => [
            'ShippingOption' => 'SECOND_DAY',
        ],
        'SnowballCapacityPreference' => 'T80',
        'SnowballType' => 'STANDARD',
    ],
]

DescribeReturnShippingLabel

$result = $client->describeReturnShippingLabel([/* ... */]);
$promise = $client->describeReturnShippingLabelAsync([/* ... */]);

Information on the shipping label of a Snow device that is being returned to Amazon Web Services.

Parameter Syntax

$result = $client->describeReturnShippingLabel([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ExpirationDate' => <DateTime>,
    'ReturnShippingLabelURI' => '<string>',
    'Status' => 'InProgress|TimedOut|Succeeded|Failed',
]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidJobStateException:

The action can't be performed because the job's current state doesn't allow that action to be performed.

ConflictException:

You get this exception when you call CreateReturnShippingLabel more than once when other requests are not completed.

GetJobManifest

$result = $client->getJobManifest([/* ... */]);
$promise = $client->getJobManifestAsync([/* ... */]);

Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.

The manifest is an encrypted file that you can download after your job enters the WithCustomer status. This is the only valid status for calling this API as the manifest and UnlockCode code value are used for securing your device and should only be used when you have the device. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snow device through the Snowball client when the client is started for the first time.

As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job.

The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created.

Parameter Syntax

$result = $client->getJobManifest([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ManifestURI' => '<string>',
]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidJobStateException:

The action can't be performed because the job's current state doesn't allow that action to be performed.

Examples

Example 1: To get the manifest for a job you've created for AWS Snowball

Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time.As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.

$result = $client->getJobManifest([
    'JobId' => 'JID123e4567-e89b-12d3-a456-426655440000',
]);

Result syntax:

[
    'ManifestURI' => 'https://awsie-frosty-manifests-prod.s3.amazonaws.com/JID123e4567-e89b-12d3-a456-426655440000_manifest.bin?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20161224T005115Z&X-Amz-SignedHeaders=...',
]

GetJobUnlockCode

$result = $client->getJobUnlockCode([/* ... */]);
$promise = $client->getJobUnlockCodeAsync([/* ... */]);

Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 360 days after the associated job has been created.

The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snow device through the Snowball client when the client is started for the first time. The only valid status for calling this API is WithCustomer as the manifest and Unlock code values are used for securing your device and should only be used when you have the device.

As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job.

Parameter Syntax

$result = $client->getJobUnlockCode([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'UnlockCode' => '<string>',
]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidJobStateException:

The action can't be performed because the job's current state doesn't allow that action to be performed.

Examples

Example 1: To get the unlock code for a job you've created for AWS Snowball

Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created.The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time.As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

$result = $client->getJobUnlockCode([
    'JobId' => 'JID123e4567-e89b-12d3-a456-426655440000',
]);

Result syntax:

[
    'UnlockCode' => '12345-abcde-56789-fghij-01234',
]

GetSnowballUsage

$result = $client->getSnowballUsage([/* ... */]);
$promise = $client->getSnowballUsageAsync([/* ... */]);

Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.

The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support.

Parameter Syntax

$result = $client->getSnowballUsage([
]);

Parameter Details

Result Syntax

[
    'SnowballLimit' => <integer>,
    'SnowballsInUse' => <integer>,
]

Result Details

Errors

There are no errors described for this operation.

Examples

Example 1: To see your Snowball service limit and the number of Snowballs you have in use

Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.

$result = $client->getSnowballUsage([
]);

Result syntax:

[
    'SnowballLimit' => 1,
    'SnowballsInUse' => 0,
]

GetSoftwareUpdates

$result = $client->getSoftwareUpdates([/* ... */]);
$promise = $client->getSoftwareUpdatesAsync([/* ... */]);

Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.

Parameter Syntax

$result = $client->getSoftwareUpdates([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'UpdatesURI' => '<string>',
]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidJobStateException:

The action can't be performed because the job's current state doesn't allow that action to be performed.

ListClusterJobs

$result = $client->listClusterJobs([/* ... */]);
$promise = $client->listClusterJobsAsync([/* ... */]);

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.

Parameter Syntax

$result = $client->listClusterJobs([
    'ClusterId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'JobListEntries' => [
        [
            'CreationDate' => <DateTime>,
            'Description' => '<string>',
            'IsMaster' => true || false,
            'JobId' => '<string>',
            'JobState' => 'New|PreparingAppliance|PreparingShipment|InTransitToCustomer|WithCustomer|InTransitToAWS|WithAWSSortingFacility|WithAWS|InProgress|Complete|Cancelled|Listing|Pending',
            'JobType' => 'IMPORT|EXPORT|LOCAL_USE',
            'SnowballType' => 'STANDARD|EDGE|EDGE_C|EDGE_CG|EDGE_S|SNC1_HDD|SNC1_SSD|V3_5C|V3_5S|RACK_5U_C',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidNextTokenException:

The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

Examples

Example 1: To get a list of jobs in a cluster that you've created for AWS Snowball

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.

$result = $client->listClusterJobs([
    'ClusterId' => 'CID123e4567-e89b-12d3-a456-426655440000',
]);

Result syntax:

[
    'JobListEntries' => [
        [
            'CreationDate' => ,
            'Description' => 'MyClustrer-node-001',
            'IsMaster' => ,
            'JobId' => 'JID123e4567-e89b-12d3-a456-426655440000',
            'JobState' => 'New',
            'JobType' => 'LOCAL_USE',
            'SnowballType' => 'EDGE',
        ],
        [
            'CreationDate' => ,
            'Description' => 'MyClustrer-node-002',
            'IsMaster' => ,
            'JobId' => 'JID123e4567-e89b-12d3-a456-426655440001',
            'JobState' => 'New',
            'JobType' => 'LOCAL_USE',
            'SnowballType' => 'EDGE',
        ],
        [
            'CreationDate' => ,
            'Description' => 'MyClustrer-node-003',
            'IsMaster' => ,
            'JobId' => 'JID123e4567-e89b-12d3-a456-426655440002',
            'JobState' => 'New',
            'JobType' => 'LOCAL_USE',
            'SnowballType' => 'EDGE',
        ],
        [
            'CreationDate' => ,
            'Description' => 'MyClustrer-node-004',
            'IsMaster' => ,
            'JobId' => 'JID123e4567-e89b-12d3-a456-426655440003',
            'JobState' => 'New',
            'JobType' => 'LOCAL_USE',
            'SnowballType' => 'EDGE',
        ],
        [
            'CreationDate' => ,
            'Description' => 'MyClustrer-node-005',
            'IsMaster' => ,
            'JobId' => 'JID123e4567-e89b-12d3-a456-426655440004',
            'JobState' => 'New',
            'JobType' => 'LOCAL_USE',
            'SnowballType' => 'EDGE',
        ],
    ],
]

ListClusters

$result = $client->listClusters([/* ... */]);
$promise = $client->listClustersAsync([/* ... */]);

Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

Parameter Syntax

$result = $client->listClusters([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ClusterListEntries' => [
        [
            'ClusterId' => '<string>',
            'ClusterState' => 'AwaitingQuorum|Pending|InUse|Complete|Cancelled',
            'CreationDate' => <DateTime>,
            'Description' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidNextTokenException:

The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

Examples

Example 1: To get a list of clusters that you've created for AWS Snowball

Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

$result = $client->listClusters([
]);

Result syntax:

[
    'ClusterListEntries' => [
        [
            'ClusterId' => 'CID123e4567-e89b-12d3-a456-426655440000',
            'ClusterState' => 'Pending',
            'CreationDate' => ,
            'Description' => 'MyCluster',
        ],
    ],
]

ListCompatibleImages

$result = $client->listCompatibleImages([/* ... */]);
$promise = $client->listCompatibleImagesAsync([/* ... */]);

This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.

Parameter Syntax

$result = $client->listCompatibleImages([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CompatibleImages' => [
        [
            'AmiId' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidNextTokenException:

The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

Ec2RequestFailedException:

Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.

ListJobs

$result = $client->listJobs([/* ... */]);
$promise = $client->listJobsAsync([/* ... */]);

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

Parameter Syntax

$result = $client->listJobs([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'JobListEntries' => [
        [
            'CreationDate' => <DateTime>,
            'Description' => '<string>',
            'IsMaster' => true || false,
            'JobId' => '<string>',
            'JobState' => 'New|PreparingAppliance|PreparingShipment|InTransitToCustomer|WithCustomer|InTransitToAWS|WithAWSSortingFacility|WithAWS|InProgress|Complete|Cancelled|Listing|Pending',
            'JobType' => 'IMPORT|EXPORT|LOCAL_USE',
            'SnowballType' => 'STANDARD|EDGE|EDGE_C|EDGE_CG|EDGE_S|SNC1_HDD|SNC1_SSD|V3_5C|V3_5S|RACK_5U_C',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidNextTokenException:

The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

Examples

Example 1: To get a list of jobs that you've created for AWS Snowball

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

$result = $client->listJobs([
]);

Result syntax:

[
    'JobListEntries' => [
        [
            'CreationDate' => ,
            'Description' => 'MyJob',
            'IsMaster' => ,
            'JobId' => 'JID123e4567-e89b-12d3-a456-426655440000',
            'JobState' => 'New',
            'JobType' => 'IMPORT',
            'SnowballType' => 'STANDARD',
        ],
    ],
]

ListLongTermPricing

$result = $client->listLongTermPricing([/* ... */]);
$promise = $client->listLongTermPricingAsync([/* ... */]);

Lists all long-term pricing types.

Parameter Syntax

$result = $client->listLongTermPricing([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'LongTermPricingEntries' => [
        [
            'CurrentActiveJob' => '<string>',
            'IsLongTermPricingAutoRenew' => true || false,
            'JobIds' => ['<string>', ...],
            'LongTermPricingEndDate' => <DateTime>,
            'LongTermPricingId' => '<string>',
            'LongTermPricingStartDate' => <DateTime>,
            'LongTermPricingStatus' => '<string>',
            'LongTermPricingType' => 'OneYear|ThreeYear|OneMonth',
            'ReplacementJob' => '<string>',
            'SnowballType' => 'STANDARD|EDGE|EDGE_C|EDGE_CG|EDGE_S|SNC1_HDD|SNC1_SSD|V3_5C|V3_5S|RACK_5U_C',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidNextTokenException:

The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

ListPickupLocations

$result = $client->listPickupLocations([/* ... */]);
$promise = $client->listPickupLocationsAsync([/* ... */]);

A list of locations from which the customer can choose to pickup a device.

Parameter Syntax

$result = $client->listPickupLocations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Addresses' => [
        [
            'AddressId' => '<string>',
            'City' => '<string>',
            'Company' => '<string>',
            'Country' => '<string>',
            'IsRestricted' => true || false,
            'Landmark' => '<string>',
            'Name' => '<string>',
            'PhoneNumber' => '<string>',
            'PostalCode' => '<string>',
            'PrefectureOrDistrict' => '<string>',
            'StateOrProvince' => '<string>',
            'Street1' => '<string>',
            'Street2' => '<string>',
            'Street3' => '<string>',
            'Type' => 'CUST_PICKUP|AWS_SHIP',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

Examples

Example 1: To get a list of locations from which the customer can choose to pickup a device.

Returns a specified number of Address objects. Each Address is a pickup location address for Snow Family devices.

$result = $client->listPickupLocations([
]);

Result syntax:

[
    'Addresses' => [
        [
            'AddressId' => 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
            'City' => 'Seattle',
            'Company' => 'My Company',
            'Country' => 'US',
            'Name' => 'My Name',
            'PhoneNumber' => '425-555-5555',
            'PostalCode' => '98101',
            'StateOrProvince' => 'WA',
            'Street1' => '123 Main Street',
        ],
    ],
]

ListServiceVersions

$result = $client->listServiceVersions([/* ... */]);
$promise = $client->listServiceVersionsAsync([/* ... */]);

Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object containing the supported versions for a particular service.

Parameter Syntax

$result = $client->listServiceVersions([
    'DependentServices' => [
        [
            'ServiceName' => 'KUBERNETES|EKS_ANYWHERE',
            'ServiceVersion' => [
                'Version' => '<string>',
            ],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ServiceName' => 'KUBERNETES|EKS_ANYWHERE', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DependentServices' => [
        [
            'ServiceName' => 'KUBERNETES|EKS_ANYWHERE',
            'ServiceVersion' => [
                'Version' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'ServiceName' => 'KUBERNETES|EKS_ANYWHERE',
    'ServiceVersions' => [
        [
            'Version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidNextTokenException:

The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

UpdateCluster

$result = $client->updateCluster([/* ... */]);
$promise = $client->updateClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateCluster([
    'AddressId' => '<string>',
    'ClusterId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'ForwardingAddressId' => '<string>',
    'Notification' => [
        'DevicePickupSnsTopicARN' => '<string>',
        'JobStatesToNotify' => ['<string>', ...],
        'NotifyAll' => true || false,
        'SnsTopicARN' => '<string>',
    ],
    'OnDeviceServiceConfiguration' => [
        'EKSOnDeviceService' => [
            'EKSAnywhereVersion' => '<string>',
            'KubernetesVersion' => '<string>',
        ],
        'NFSOnDeviceService' => [
            'StorageLimit' => <integer>,
            'StorageUnit' => 'TB',
        ],
        'S3OnDeviceService' => [
            'FaultTolerance' => <integer>,
            'ServiceSize' => <integer>,
            'StorageLimit' => <float>,
            'StorageUnit' => 'TB',
        ],
        'TGWOnDeviceService' => [
            'StorageLimit' => <integer>,
            'StorageUnit' => 'TB',
        ],
    ],
    'Resources' => [
        'Ec2AmiResources' => [
            [
                'AmiId' => '<string>', // REQUIRED
                'SnowballAmiId' => '<string>',
            ],
            // ...
        ],
        'LambdaResources' => [
            [
                'EventTriggers' => [
                    [
                        'EventResourceARN' => '<string>',
                    ],
                    // ...
                ],
                'LambdaArn' => '<string>',
            ],
            // ...
        ],
        'S3Resources' => [
            [
                'BucketArn' => '<string>',
                'KeyRange' => [
                    'BeginMarker' => '<string>',
                    'EndMarker' => '<string>',
                ],
                'TargetOnDeviceServices' => [
                    [
                        'ServiceName' => 'NFS_ON_DEVICE_SERVICE|S3_ON_DEVICE_SERVICE',
                        'TransferOption' => 'IMPORT|EXPORT|LOCAL_USE',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'RoleARN' => '<string>',
    'ShippingOption' => 'SECOND_DAY|NEXT_DAY|EXPRESS|STANDARD',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidJobStateException:

The action can't be performed because the job's current state doesn't allow that action to be performed.

KMSRequestFailedException:

The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

InvalidInputCombinationException:

Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.

Ec2RequestFailedException:

Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.

Examples

Example 1: To update a cluster

This action allows you to update certain parameters for a cluster. Once the cluster changes to a different state, usually within 60 minutes of it being created, this action is no longer available.

$result = $client->updateCluster([
    'AddressId' => 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
    'ClusterId' => 'CID123e4567-e89b-12d3-a456-426655440000',
    'Description' => 'updated-cluster-name',
]);

UpdateJob

$result = $client->updateJob([/* ... */]);
$promise = $client->updateJobAsync([/* ... */]);

While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.

Parameter Syntax

$result = $client->updateJob([
    'AddressId' => '<string>',
    'Description' => '<string>',
    'ForwardingAddressId' => '<string>',
    'JobId' => '<string>', // REQUIRED
    'Notification' => [
        'DevicePickupSnsTopicARN' => '<string>',
        'JobStatesToNotify' => ['<string>', ...],
        'NotifyAll' => true || false,
        'SnsTopicARN' => '<string>',
    ],
    'OnDeviceServiceConfiguration' => [
        'EKSOnDeviceService' => [
            'EKSAnywhereVersion' => '<string>',
            'KubernetesVersion' => '<string>',
        ],
        'NFSOnDeviceService' => [
            'StorageLimit' => <integer>,
            'StorageUnit' => 'TB',
        ],
        'S3OnDeviceService' => [
            'FaultTolerance' => <integer>,
            'ServiceSize' => <integer>,
            'StorageLimit' => <float>,
            'StorageUnit' => 'TB',
        ],
        'TGWOnDeviceService' => [
            'StorageLimit' => <integer>,
            'StorageUnit' => 'TB',
        ],
    ],
    'PickupDetails' => [
        'DevicePickupId' => '<string>',
        'Email' => '<string>',
        'IdentificationExpirationDate' => <integer || string || DateTime>,
        'IdentificationIssuingOrg' => '<string>',
        'IdentificationNumber' => '<string>',
        'Name' => '<string>',
        'PhoneNumber' => '<string>',
    ],
    'Resources' => [
        'Ec2AmiResources' => [
            [
                'AmiId' => '<string>', // REQUIRED
                'SnowballAmiId' => '<string>',
            ],
            // ...
        ],
        'LambdaResources' => [
            [
                'EventTriggers' => [
                    [
                        'EventResourceARN' => '<string>',
                    ],
                    // ...
                ],
                'LambdaArn' => '<string>',
            ],
            // ...
        ],
        'S3Resources' => [
            [
                'BucketArn' => '<string>',
                'KeyRange' => [
                    'BeginMarker' => '<string>',
                    'EndMarker' => '<string>',
                ],
                'TargetOnDeviceServices' => [
                    [
                        'ServiceName' => 'NFS_ON_DEVICE_SERVICE|S3_ON_DEVICE_SERVICE',
                        'TransferOption' => 'IMPORT|EXPORT|LOCAL_USE',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'RoleARN' => '<string>',
    'ShippingOption' => 'SECOND_DAY|NEXT_DAY|EXPRESS|STANDARD',
    'SnowballCapacityPreference' => 'T50|T80|T100|T42|T98|T8|T14|T32|NoPreference|T240|T13',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidJobStateException:

The action can't be performed because the job's current state doesn't allow that action to be performed.

KMSRequestFailedException:

The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

InvalidInputCombinationException:

Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.

ClusterLimitExceededException:

Job creation failed. Currently, clusters support five nodes. If you have fewer than five nodes for your cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster has exactly five nodes.

Ec2RequestFailedException:

Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.

Examples

Example 1: To update a job

This action allows you to update certain parameters for a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.

$result = $client->updateJob([
    'AddressId' => 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
    'Description' => 'updated-job-name',
    'JobId' => 'JID123e4567-e89b-12d3-a456-426655440000',
    'ShippingOption' => 'NEXT_DAY',
    'SnowballCapacityPreference' => 'T100',
]);

UpdateJobShipmentState

$result = $client->updateJobShipmentState([/* ... */]);
$promise = $client->updateJobShipmentStateAsync([/* ... */]);

Updates the state when a shipment state changes to a different state.

Parameter Syntax

$result = $client->updateJobShipmentState([
    'JobId' => '<string>', // REQUIRED
    'ShipmentState' => 'RECEIVED|RETURNED', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.

InvalidJobStateException:

The action can't be performed because the job's current state doesn't allow that action to be performed.

UpdateLongTermPricing

$result = $client->updateLongTermPricing([/* ... */]);
$promise = $client->updateLongTermPricingAsync([/* ... */]);

Updates the long-term pricing type.

Parameter Syntax

$result = $client->updateLongTermPricing([
    'IsLongTermPricingAutoRenew' => true || false,
    'LongTermPricingId' => '<string>', // REQUIRED
    'ReplacementJob' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidResourceException:

The specified resource can't be found. Check the information you provided in your last request, and try again.