Amazon Import/Export Snowball 2016-06-30
- Client: Aws\SnowBall\SnowBallClient
- Service ID: snowball
- Version: 2016-06-30
This page describes the parameters and results for the operations of the Amazon Import/Export Snowball (2016-06-30), and shows how to use the Aws\SnowBall\SnowBallClient object to call the described operations. This documentation is specific to the 2016-06-30 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- CancelCluster ( array $params = [] )
- Cancels a cluster job.
- CancelJob ( array $params = [] )
- Cancels the specified job.
- CreateAddress ( array $params = [] )
- Creates an address for a Snow device to be shipped to.
- CreateCluster ( array $params = [] )
- Creates an empty cluster.
- CreateJob ( array $params = [] )
- Creates a job to import or export data between Amazon S3 and your on-premises data center.
- CreateLongTermPricing ( array $params = [] )
- Creates a job with the long-term usage option for a device.
- CreateReturnShippingLabel ( array $params = [] )
- Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
- DescribeAddress ( array $params = [] )
- Takes an AddressId and returns specific details about that address in the form of an Address object.
- DescribeAddresses ( array $params = [] )
- Returns a specified number of ADDRESS objects.
- DescribeCluster ( array $params = [] )
- Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
- DescribeJob ( array $params = [] )
- Returns information about a specific job including shipping information, job status, and other important metadata.
- DescribeReturnShippingLabel ( array $params = [] )
- Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
- GetJobManifest ( array $params = [] )
- Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value.
- GetJobUnlockCode ( array $params = [] )
- Returns the UnlockCode code value for the specified job.
- GetSnowballUsage ( array $params = [] )
- Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.
- GetSoftwareUpdates ( array $params = [] )
- Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
- ListClusterJobs ( array $params = [] )
- Returns an array of JobListEntry objects of the specified length.
- ListClusters ( array $params = [] )
- Returns an array of ClusterListEntry objects of the specified length.
- ListCompatibleImages ( array $params = [] )
- 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.
- ListJobs ( array $params = [] )
- Returns an array of JobListEntry objects of the specified length.
- ListLongTermPricing ( array $params = [] )
- Lists all long-term pricing types.
- ListPickupLocations ( array $params = [] )
- A list of locations from which the customer can choose to pickup a device.
- ListServiceVersions ( array $params = [] )
- Lists all supported versions for Snow on-device services.
- UpdateCluster ( array $params = [] )
- While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster.
- UpdateJob ( array $params = [] )
- While a job's JobState value is New, you can update some of the information associated with a job.
- UpdateJobShipmentState ( array $params = [] )
- Updates the state when a shipment state changes to a different state.
- UpdateLongTermPricing ( array $params = [] )
- Updates the long-term pricing type.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- DescribeAddresses
- ListClusterJobs
- ListClusters
- ListCompatibleImages
- ListJobs
- ListLongTermPricing
- ListPickupLocations
Operations
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
Members
- ClusterId
-
- Required: Yes
- Type: string
The 39-character ID for the cluster that you want to cancel, for example
CID123e4567-e89b-12d3-a456-426655440000
.
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
Members
- JobId
-
- Required: Yes
- Type: string
The 39-character job ID for the job that you want to cancel, for example
JID123e4567-e89b-12d3-a456-426655440000
.
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
Members
- Address
-
- Required: Yes
- Type: Address structure
The address that you want the Snow device shipped to.
Result Syntax
[ 'AddressId' => '<string>', ]
Result Details
Members
- AddressId
-
- Type: string
The automatically generated ID for a specific address. You'll use this ID when you create a job to specify which address you want the Snow device for that job shipped to.
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
Members
- AddressId
-
- Required: Yes
- Type: string
The ID for the address that you want the cluster shipped to.
- Description
-
- Type: string
An optional description of this specific cluster, for example
Environmental Data Cluster-01
. - ForceCreateJobs
-
- Type: boolean
Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with
OnDeviceServiceConfiguration
. - ForwardingAddressId
-
- Type: string
The forwarding address ID for a cluster. This field is not supported in most regions.
- InitialClusterSize
-
- Type: int
If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.
- JobType
-
- Required: Yes
- Type: string
The type of job for this cluster. Currently, the only job type supported for clusters is
LOCAL_USE
.For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
- KmsKeyARN
-
- Type: string
The
KmsKeyARN
value that you want to associate with this cluster.KmsKeyARN
values are created by using the CreateKey API action in Key Management Service (KMS). - LongTermPricingIds
-
- Type: Array of strings
Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.
- Notification
-
- Type: Notification structure
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
- OnDeviceServiceConfiguration
-
- Type: OnDeviceServiceConfiguration structure
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).
- RemoteManagement
-
- Type: string
Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to
INSTALLED_AUTOSTART
, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device. - Resources
-
- Type: JobResource structure
The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.
- RoleARN
-
- Type: string
The
RoleARN
that you want to associate with this cluster.RoleArn
values are created by using the CreateRole API action in Identity and Access Management (IAM). - ShippingOption
-
- Required: Yes
- Type: string
The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:
-
In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
-
In the European Union (EU), you have access to express shipping. Typically, Snow devices 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, Snow devices are delivered in one to seven days.
-
In the United States of America (US), you have access to one-day shipping and two-day shipping.
-
In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.
-
In the European Union (EU), you have access to express shipping. Typically, Snow devices 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, Snow devices are delivered in one to seven days.
-
In the US, you have access to one-day shipping and two-day shipping.
- SnowballCapacityPreference
-
- Type: string
If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
- SnowballType
-
- Required: Yes
- Type: string
The type of Snow Family devices to use for this cluster.
For cluster jobs, Amazon Web Services Snow Family currently supports only the
EDGE
device type.For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
- TaxDocuments
-
- Type: TaxDocuments structure
The tax documents required in your Amazon Web Services Region.
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
Members
- ClusterId
-
- Type: string
The automatically generated ID for a cluster.
- JobListEntries
-
- Type: Array of JobListEntry structures
List of jobs created for this cluster. For syntax, see ListJobsResult$JobListEntries in this guide.
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.
Only the Snowball; Edge device type is supported when ordering clustered jobs.
The device capacity is optional.
Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services.
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
Members
- AddressId
-
- Type: string
The ID for the address that you want the Snow device shipped to.
- ClusterId
-
- Type: string
The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this
clusterId
value. The other job attributes are inherited from the cluster. - Description
-
- Type: string
Defines an optional description of this specific job, for example
Important Photos 2016-08-11
. - DeviceConfiguration
-
- Type: DeviceConfiguration structure
Defines the device configuration for an Snowcone job.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
- ForwardingAddressId
-
- Type: string
The forwarding address ID for a job. This field is not supported in most Regions.
- ImpactLevel
-
- Type: string
The highest impact level of data that will be stored or processed on the device, provided at job creation.
- JobType
-
- Type: string
Defines the type of job that you're creating.
- KmsKeyARN
-
- Type: string
The
KmsKeyARN
that you want to associate with this job.KmsKeyARN
s are created using the CreateKey Key Management Service (KMS) API action. - LongTermPricingId
-
- Type: string
The ID of the long-term pricing type for the device.
- Notification
-
- Type: Notification structure
Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
- OnDeviceServiceConfiguration
-
- Type: OnDeviceServiceConfiguration structure
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon Web Services Storage Gateway service Tape Gateway type.
- PickupDetails
-
- Type: PickupDetails structure
Information identifying the person picking up the device.
- RemoteManagement
-
- Type: string
Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to
INSTALLED_AUTOSTART
, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Edge client to manage the device. When set toNOT_INSTALLED
, remote management will not be available on the device. - Resources
-
- Type: JobResource structure
Defines the Amazon S3 buckets associated with this job.
With
IMPORT
jobs, you specify the bucket or buckets that your transferred data will be imported into.With
EXPORT
jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify aKeyRange
value. If you choose to export a range, you define the length of the range by providing either an inclusiveBeginMarker
value, an inclusiveEndMarker
value, or both. Ranges are UTF-8 binary sorted. - RoleARN
-
- Type: string
The
RoleARN
that you want to associate with this job.RoleArn
s are created using the CreateRole Identity and Access Management (IAM) API action. - ShippingOption
-
- Type: string
The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:
-
In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
-
In the European Union (EU), you have access to express shipping. Typically, Snow devices 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, Snow devices are delivered in one to seven days.
-
In the US, you have access to one-day shipping and two-day shipping.
- SnowballCapacityPreference
-
- Type: string
If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
- SnowballType
-
- Type: string
The type of Snow Family devices to use for this job.
For cluster jobs, Amazon Web Services Snow Family currently supports only the
EDGE
device type.The type of Amazon Web Services Snow device to use for this job. Currently, the only supported device type for cluster jobs is
EDGE
.For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
- TaxDocuments
-
- Type: TaxDocuments structure
The tax documents required in your Amazon Web Services Region.
Result Syntax
[ 'JobId' => '<string>', ]
Result Details
Members
- JobId
-
- Type: string
The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
.
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
Members
- IsLongTermPricingAutoRenew
-
- Type: boolean
Specifies whether the current long-term pricing type for the device should be renewed.
- LongTermPricingType
-
- Required: Yes
- Type: string
The type of long-term pricing option you want for the device, either 1-year or 3-year long-term pricing.
- SnowballType
-
- Required: Yes
- Type: string
The type of Snow Family devices to use for the long-term pricing job.
Result Syntax
[ 'LongTermPricingId' => '<string>', ]
Result Details
Members
- LongTermPricingId
-
- Type: string
The ID of the long-term pricing type for the device.
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
Members
- JobId
-
- Required: Yes
- Type: string
The ID for a job that you want to create the return shipping label for; for example,
JID123e4567-e89b-12d3-a456-426655440000
. - ShippingOption
-
- Type: string
The shipping speed for a particular job. This speed doesn't dictate how soon the device is returned to Amazon Web Services. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:
Result Syntax
[ 'Status' => 'InProgress|TimedOut|Succeeded|Failed', ]
Result Details
Members
- Status
-
- Type: string
The status information of the task on a Snow device that is being returned to Amazon Web Services.
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, useDescribeReturnShippingLabel
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
Members
- AddressId
-
- Required: Yes
- Type: string
The automatically generated ID for a specific address.
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
Members
- Address
-
- Type: Address structure
The address that you want the Snow device(s) associated with a specific job to be shipped to.
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
Members
- MaxResults
-
- Type: int
The number of
ADDRESS
objects to return. - NextToken
-
- Type: string
HTTP requests are stateless. To identify what object comes "next" in the list of
ADDRESS
objects, you have the option of specifying a value forNextToken
as the starting point for your list of returned addresses.
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
Members
- Addresses
-
- Type: Array of Address structures
The Snow device shipping addresses that were created for this account.
- NextToken
-
- Type: string
HTTP requests are stateless. If you use the automatically generated
NextToken
value in your nextDescribeAddresses
call, your list of returned addresses will start from this point in the array.
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 theNextToken
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
Members
- ClusterId
-
- Required: Yes
- Type: string
The automatically generated ID for a cluster.
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
Members
- ClusterMetadata
-
- Type: ClusterMetadata structure
Information about a specific cluster, including shipping information, cluster status, and other important metadata.
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
Members
- JobId
-
- Required: Yes
- Type: string
The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
.
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
Members
- JobMetadata
-
- Type: JobMetadata structure
Information about a specific job, including shipping information, job status, and other important metadata.
- SubJobMetadata
-
- Type: Array of JobMetadata structures
Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.
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
Members
- JobId
-
- Required: Yes
- Type: string
The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
.
Result Syntax
[ 'ExpirationDate' => <DateTime>, 'ReturnShippingLabelURI' => '<string>', 'Status' => 'InProgress|TimedOut|Succeeded|Failed', ]
Result Details
Members
- ExpirationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The expiration date of the current return shipping label.
- ReturnShippingLabelURI
-
- Type: string
The pre-signed Amazon S3 URI used to download the return shipping label.
- Status
-
- Type: string
The status information of the task on a Snow device that is being returned to Amazon Web Services.
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
Members
- JobId
-
- Required: Yes
- Type: string
The ID for a job that you want to get the manifest file for, for example
JID123e4567-e89b-12d3-a456-426655440000
.
Result Syntax
[ 'ManifestURI' => '<string>', ]
Result Details
Members
- ManifestURI
-
- Type: string
The Amazon S3 presigned URL for the manifest file associated with the specified
JobId
value.
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
Members
- JobId
-
- Required: Yes
- Type: string
The ID for the job that you want to get the
UnlockCode
value for, for exampleJID123e4567-e89b-12d3-a456-426655440000
.
Result Syntax
[ 'UnlockCode' => '<string>', ]
Result Details
Members
- UnlockCode
-
- Type: string
The
UnlockCode
value for the specified job. TheUnlockCode
value can be accessed for up to 360 days after the job has been created.
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
Members
Result Syntax
[ 'SnowballLimit' => <integer>, 'SnowballsInUse' => <integer>, ]
Result Details
Members
- SnowballLimit
-
- Type: int
The service limit for number of Snow devices this account can have at once. The default service limit is 1 (one).
- SnowballsInUse
-
- Type: int
The number of Snow devices that this account is currently using.
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
Members
- JobId
-
- Required: Yes
- Type: string
The ID for a job that you want to get the software update file for, for example
JID123e4567-e89b-12d3-a456-426655440000
.
Result Syntax
[ 'UpdatesURI' => '<string>', ]
Result Details
Members
- UpdatesURI
-
- Type: string
The Amazon S3 presigned URL for the update file associated with the specified
JobId
value. The software update will be available for 2 days after this request is made. To access an update after the 2 days have passed, you'll have to make another call toGetSoftwareUpdates
.
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
Members
- ClusterId
-
- Required: Yes
- Type: string
The 39-character ID for the cluster that you want to list, for example
CID123e4567-e89b-12d3-a456-426655440000
. - MaxResults
-
- Type: int
The number of
JobListEntry
objects to return. - NextToken
-
- Type: string
HTTP requests are stateless. To identify what object comes "next" in the list of
JobListEntry
objects, you have the option of specifyingNextToken
as the starting point for your returned list.
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
Members
- JobListEntries
-
- Type: Array of JobListEntry structures
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. - NextToken
-
- Type: string
HTTP requests are stateless. If you use the automatically generated
NextToken
value in your nextListClusterJobsResult
call, your list of returned jobs will start from this point in the array.
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 theNextToken
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
Members
- MaxResults
-
- Type: int
The number of
ClusterListEntry
objects to return. - NextToken
-
- Type: string
HTTP requests are stateless. To identify what object comes "next" in the list of
ClusterListEntry
objects, you have the option of specifyingNextToken
as the starting point for your returned list.
Result Syntax
[ 'ClusterListEntries' => [ [ 'ClusterId' => '<string>', 'ClusterState' => 'AwaitingQuorum|Pending|InUse|Complete|Cancelled', 'CreationDate' => <DateTime>, 'Description' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ClusterListEntries
-
- Type: Array of ClusterListEntry structures
Each
ClusterListEntry
object contains a cluster's state, a cluster's ID, and other important status information. - NextToken
-
- Type: string
HTTP requests are stateless. If you use the automatically generated
NextToken
value in your nextClusterListEntry
call, your list of returned clusters will start from this point in the array.
Errors
- InvalidNextTokenException:
The
NextToken
string was altered unexpectedly, and the operation has stopped. Run the operation without changing theNextToken
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
Members
- MaxResults
-
- Type: int
The maximum number of results for the list of compatible images. Currently, a Snowball Edge device can store 10 AMIs.
- NextToken
-
- Type: string
HTTP requests are stateless. To identify what object comes "next" in the list of compatible images, you can specify a value for
NextToken
as the starting point for your list of returned images.
Result Syntax
[ 'CompatibleImages' => [ [ 'AmiId' => '<string>', 'Name' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- CompatibleImages
-
- Type: Array of CompatibleImage structures
A JSON-formatted object that describes a compatible AMI, including the ID and name for a Snow device AMI.
- NextToken
-
- Type: string
Because HTTP requests are stateless, this is the starting point for your next list of returned images.
Errors
- InvalidNextTokenException:
The
NextToken
string was altered unexpectedly, and the operation has stopped. Run the operation without changing theNextToken
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
Members
- MaxResults
-
- Type: int
The number of
JobListEntry
objects to return. - NextToken
-
- Type: string
HTTP requests are stateless. To identify what object comes "next" in the list of
JobListEntry
objects, you have the option of specifyingNextToken
as the starting point for your returned list.
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
Members
- JobListEntries
-
- Type: Array of JobListEntry structures
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. - NextToken
-
- Type: string
HTTP requests are stateless. If you use this automatically generated
NextToken
value in your nextListJobs
call, your returnedJobListEntry
objects will start from this point in the array.
Errors
- InvalidNextTokenException:
The
NextToken
string was altered unexpectedly, and the operation has stopped. Run the operation without changing theNextToken
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
Members
- MaxResults
-
- Type: int
The maximum number of
ListLongTermPricing
objects to return. - NextToken
-
- Type: string
Because HTTP requests are stateless, this is the starting point for your next list of
ListLongTermPricing
to return.
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
Members
- LongTermPricingEntries
-
- Type: Array of LongTermPricingListEntry structures
Each
LongTermPricingEntry
object contains a status, ID, and other information about theLongTermPricing
type. - NextToken
-
- Type: string
Because HTTP requests are stateless, this is the starting point for your next list of returned
ListLongTermPricing
list.
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 theNextToken
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
Members
- MaxResults
-
- Type: int
The maximum number of locations to list per page.
- NextToken
-
- Type: string
HTTP requests are stateless. To identify what object comes "next" in the list of
ListPickupLocationsRequest
objects, you have the option of specifyingNextToken
as the starting point for your returned list.
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
Members
- Addresses
-
- Type: Array of Address structures
Information about the address of pickup locations.
- NextToken
-
- Type: string
HTTP requests are stateless. To identify what object comes "next" in the list of
ListPickupLocationsResult
objects, you have the option of specifyingNextToken
as the starting point for your returned list.
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
Members
- DependentServices
-
- Type: Array of DependentService structures
A list of names and versions of dependant services of the requested service.
- MaxResults
-
- Type: int
The maximum number of
ListServiceVersions
objects to return. - NextToken
-
- Type: string
Because HTTP requests are stateless, this is the starting point for the next list of returned
ListServiceVersionsRequest
versions. - ServiceName
-
- Required: Yes
- Type: string
The name of the service for which you're requesting supported versions.
Result Syntax
[ 'DependentServices' => [ [ 'ServiceName' => 'KUBERNETES|EKS_ANYWHERE', 'ServiceVersion' => [ 'Version' => '<string>', ], ], // ... ], 'NextToken' => '<string>', 'ServiceName' => 'KUBERNETES|EKS_ANYWHERE', 'ServiceVersions' => [ [ 'Version' => '<string>', ], // ... ], ]
Result Details
Members
- DependentServices
-
- Type: Array of DependentService structures
A list of names and versions of dependant services of the service for which the system provided supported versions.
- NextToken
-
- Type: string
Because HTTP requests are stateless, this is the starting point of the next list of returned
ListServiceVersionsResult
results. - ServiceName
-
- Required: Yes
- Type: string
The name of the service for which the system provided supported versions.
- ServiceVersions
-
- Required: Yes
- Type: Array of ServiceVersion structures
A list of supported versions.
Errors
- InvalidNextTokenException:
The
NextToken
string was altered unexpectedly, and the operation has stopped. Run the operation without changing theNextToken
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
Members
- AddressId
-
- Type: string
The ID of the updated Address object.
- ClusterId
-
- Required: Yes
- Type: string
The cluster ID of the cluster that you want to update, for example
CID123e4567-e89b-12d3-a456-426655440000
. - Description
-
- Type: string
The updated description of this cluster.
- ForwardingAddressId
-
- Type: string
The updated ID for the forwarding address for a cluster. This field is not supported in most regions.
- Notification
-
- Type: Notification structure
The new or updated Notification object.
- OnDeviceServiceConfiguration
-
- Type: OnDeviceServiceConfiguration structure
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).
- Resources
-
- Type: JobResource structure
The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
- RoleARN
-
- Type: string
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 Identity and Access Management (IAM).
- ShippingOption
-
- Type: string
The updated shipping option value of this cluster's ShippingDetails object.
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
Members
- AddressId
-
- Type: string
The ID of the updated Address object.
- Description
-
- Type: string
The updated description of this job's JobMetadata object.
- ForwardingAddressId
-
- Type: string
The updated ID for the forwarding address for a job. This field is not supported in most regions.
- JobId
-
- Required: Yes
- Type: string
The job ID of the job that you want to update, for example
JID123e4567-e89b-12d3-a456-426655440000
. - Notification
-
- Type: Notification structure
The new or updated Notification object.
- OnDeviceServiceConfiguration
-
- Type: OnDeviceServiceConfiguration structure
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon Web Services Storage Gateway service Tape Gateway type.
- PickupDetails
-
- Type: PickupDetails structure
Information identifying the person picking up the device.
- Resources
-
- Type: JobResource structure
The updated
JobResource
object, or the updated JobResource object. - RoleARN
-
- Type: string
The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRoleIdentity and Access Management (IAM) API action.
- ShippingOption
-
- Type: string
The updated shipping option value of this job's ShippingDetails object.
- SnowballCapacityPreference
-
- Type: string
The updated
SnowballCapacityPreference
of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
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
Members
- JobId
-
- Required: Yes
- Type: string
The job ID of the job whose shipment date you want to update, for example
JID123e4567-e89b-12d3-a456-426655440000
. - ShipmentState
-
- Required: Yes
- Type: string
The state of a device when it is being shipped.
Set to
RECEIVED
when the device arrives at your location.Set to
RETURNED
when you have returned the device to Amazon Web Services.
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
Members
- IsLongTermPricingAutoRenew
-
- Type: boolean
If set to
true
, specifies that the current long-term pricing type for the device should be automatically renewed before the long-term pricing contract expires. - LongTermPricingId
-
- Required: Yes
- Type: string
The ID of the long-term pricing type for the device.
- ReplacementJob
-
- Type: string
Specifies that a device that is ordered with long-term pricing should be replaced with a new device.
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.
Shapes
Address
Description
The address that you want the Snow device(s) associated with a specific job to be shipped to. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. Although no individual elements of the Address
are required, if the address is invalid or unsupported, then an exception is thrown.
Members
- AddressId
-
- Type: string
The unique ID for an address.
- City
-
- Type: string
The city in an address that a Snow device is to be delivered to.
- Company
-
- Type: string
The name of the company to receive a Snow device at an address.
- Country
-
- Type: string
The country in an address that a Snow device is to be delivered to.
- IsRestricted
-
- Type: boolean
If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.
- Landmark
-
- Type: string
This field is no longer used and the value is ignored.
- Name
-
- Type: string
The name of a person to receive a Snow device at an address.
- PhoneNumber
-
- Type: string
The phone number associated with an address that a Snow device is to be delivered to.
- PostalCode
-
- Type: string
The postal code in an address that a Snow device is to be delivered to.
- PrefectureOrDistrict
-
- Type: string
This field is no longer used and the value is ignored.
- StateOrProvince
-
- Type: string
The state or province in an address that a Snow device is to be delivered to.
- Street1
-
- Type: string
The first line in a street address that a Snow device is to be delivered to.
- Street2
-
- Type: string
The second line in a street address that a Snow device is to be delivered to.
- Street3
-
- Type: string
The third line in a street address that a Snow device is to be delivered to.
- Type
-
- Type: string
Differentiates between delivery address and pickup address in the customer account. Provided at job creation.
ClusterLimitExceededException
Description
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.
Members
- Message
-
- Type: string
ClusterListEntry
Description
Contains a cluster's state, a cluster's ID, and other important information.
Members
- ClusterId
-
- Type: string
The 39-character ID for the cluster that you want to list, for example
CID123e4567-e89b-12d3-a456-426655440000
. - ClusterState
-
- Type: string
The current state of this cluster. For information about the state of a specific node, see JobListEntry$JobState.
- CreationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date for this cluster.
- Description
-
- Type: string
Defines an optional description of the cluster, for example
Environmental Data Cluster-01
.
ClusterMetadata
Description
Contains metadata about a specific cluster.
Members
- AddressId
-
- Type: string
The automatically generated ID for a specific address.
- ClusterId
-
- Type: string
The automatically generated ID for a cluster.
- ClusterState
-
- Type: string
The current status of the cluster.
- CreationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date for this cluster.
- Description
-
- Type: string
The optional description of the cluster.
- ForwardingAddressId
-
- Type: string
The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.
- JobType
-
- Type: string
The type of job for this cluster. Currently, the only job type supported for clusters is
LOCAL_USE
. - KmsKeyARN
-
- Type: string
The
KmsKeyARN
Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in Key Management Service (KMS. - Notification
-
- Type: Notification structure
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
- OnDeviceServiceConfiguration
-
- Type: OnDeviceServiceConfiguration structure
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
- Resources
-
- Type: JobResource structure
The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
- RoleARN
-
- Type: string
The role ARN associated with this cluster. This ARN was created using the CreateRole API action in Identity and Access Management (IAM).
- ShippingOption
-
- Type: string
The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:
-
In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.
-
In the European Union (EU), you have access to express shipping. Typically, Snow devices 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, Snow devices are delivered in one to seven days.
-
In the US, you have access to one-day shipping and two-day shipping.
- SnowballType
-
- Type: string
The type of Snowcone device to use for this cluster.
For cluster jobs, Amazon Web Services Snow Family currently supports only the
EDGE
device type. - TaxDocuments
-
- Type: TaxDocuments structure
The tax documents required in your Amazon Web Services Region.
CompatibleImage
Description
A JSON-formatted object that describes a compatible Amazon Machine Image (AMI), including the ID and name for a Snow device AMI. This AMI is compatible with the device's physical hardware requirements, and it should be able to be run in an SBE1 instance on the device.
Members
- AmiId
-
- Type: string
The unique identifier for an individual Snow device AMI.
- Name
-
- Type: string
The optional name of a compatible image.
ConflictException
Description
You get this exception when you call CreateReturnShippingLabel
more than once when other requests are not completed.
Members
- ConflictResource
-
- Type: string
You get this resource when you call
CreateReturnShippingLabel
more than once when other requests are not completed. . - Message
-
- Type: string
DataTransfer
Description
Defines the real-time status of a Snow device's data transfer while the device is at Amazon Web Services. This data is only available while a job has a JobState
value of InProgress
, for both import and export jobs.
Members
- BytesTransferred
-
- Type: long (int|float)
The number of bytes transferred between a Snow device and Amazon S3.
- ObjectsTransferred
-
- Type: long (int|float)
The number of objects transferred between a Snow device and Amazon S3.
- TotalBytes
-
- Type: long (int|float)
The total bytes of data for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.
- TotalObjects
-
- Type: long (int|float)
The total number of objects for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.
DependentService
Description
The name and version of the service dependant on the requested service.
Members
- ServiceName
-
- Type: string
The name of the dependent service.
- ServiceVersion
-
- Type: ServiceVersion structure
The version of the dependent service.
DeviceConfiguration
Description
The container for SnowconeDeviceConfiguration
.
Members
- SnowconeDeviceConfiguration
-
- Type: SnowconeDeviceConfiguration structure
Returns information about the device configuration for an Snowcone job.
EKSOnDeviceServiceConfiguration
Description
An object representing the metadata and configuration settings of EKS Anywhere on the Snow Family device.
Members
- EKSAnywhereVersion
-
- Type: string
The optional version of EKS Anywhere on the Snow Family device.
- KubernetesVersion
-
- Type: string
The Kubernetes version for EKS Anywhere on the Snow Family device.
Ec2AmiResource
Description
A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI), including the Amazon EC2-compatible AMI ID and the Snow device AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the Amazon Web Services Cloud and on the device.
Members
- AmiId
-
- Required: Yes
- Type: string
The ID of the AMI in Amazon EC2.
- SnowballAmiId
-
- Type: string
The ID of the AMI on the Snow device.
Ec2RequestFailedException
Description
Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
Members
- Message
-
- Type: string
EventTriggerDefinition
Description
The container for the EventTriggerDefinition$EventResourceARN.
Members
- EventResourceARN
-
- Type: string
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
INDTaxDocuments
Description
The tax documents required in Amazon Web Services Region in India.
Members
- GSTIN
-
- Type: string
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
InvalidAddressException
Description
The address provided was invalid. Check the address with your region's carrier, and try again.
Members
- Message
-
- Type: string
InvalidInputCombinationException
Description
Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.
Members
- Message
-
- Type: string
InvalidJobStateException
Description
The action can't be performed because the job's current state doesn't allow that action to be performed.
Members
- Message
-
- Type: string
InvalidNextTokenException
Description
The NextToken
string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken
string, and try again.
Members
- Message
-
- Type: string
InvalidResourceException
Description
The specified resource can't be found. Check the information you provided in your last request, and try again.
Members
- Message
-
- Type: string
- ResourceType
-
- Type: string
The provided resource value is invalid.
JobListEntry
Description
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 an export job.
Members
- CreationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date for this job.
- Description
-
- Type: string
The optional description of this specific job, for example
Important Photos 2016-08-11
. - IsMaster
-
- Type: boolean
A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular main job are listed, because they are created after the main job is created.
- JobId
-
- Type: string
The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
. - JobState
-
- Type: string
The current state of this job.
- JobType
-
- Type: string
The type of job.
- SnowballType
-
- Type: string
The type of device used with this job.
JobLogs
Description
Contains job logs. Whenever a Snow device is used to import data into or export data out of Amazon S3, you'll have the option of downloading a PDF job report. Job logs are returned as a part of the response syntax of the DescribeJob
action in the JobMetadata
data type. The job logs can be accessed for up to 60 minutes after this request has been made. To access any of the job logs after 60 minutes have passed, you'll have to make another call to the DescribeJob
action.
For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snow device for your job part is being delivered to you.
The job report provides you insight into the state of your Amazon S3 data transfer. The report includes details about your job or job part for your records.
For deeper visibility into the status of your transferred objects, you can look at the two associated logs: a success log and a failure log. The logs are saved in comma-separated value (CSV) format, and the name of each log includes the ID of the job or job part that the log describes.
Members
- JobCompletionReportURI
-
- Type: string
A link to an Amazon S3 presigned URL where the job completion report is located.
- JobFailureLogURI
-
- Type: string
A link to an Amazon S3 presigned URL where the job failure log is located.
- JobSuccessLogURI
-
- Type: string
A link to an Amazon S3 presigned URL where the job success log is located.
JobMetadata
Description
Contains information about a specific job including shipping information, job status, and other important metadata. This information is returned as a part of the response syntax of the DescribeJob
action.
Members
- AddressId
-
- Type: string
The ID for the address that you want the Snow device shipped to.
- ClusterId
-
- Type: string
The 39-character ID for the cluster, for example
CID123e4567-e89b-12d3-a456-426655440000
. - CreationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date for this job.
- DataTransferProgress
-
- Type: DataTransfer structure
A value that defines the real-time status of a Snow device's data transfer while the device is at Amazon Web Services. This data is only available while a job has a
JobState
value ofInProgress
, for both import and export jobs. - Description
-
- Type: string
The description of the job, provided at job creation.
- DeviceConfiguration
-
- Type: DeviceConfiguration structure
The container for
SnowconeDeviceConfiguration
. - ForwardingAddressId
-
- Type: string
The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.
- ImpactLevel
-
- Type: string
The highest impact level of data that will be stored or processed on the device, provided at job creation.
- JobId
-
- Type: string
The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
. - JobLogInfo
-
- Type: JobLogs structure
Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snow device for your job part is being delivered to you.
- JobState
-
- Type: string
The current status of the jobs.
- JobType
-
- Type: string
The type of job.
- KmsKeyARN
-
- Type: string
The Amazon Resource Name (ARN) for the Key Management Service (KMS) key associated with this job. This ARN was created using the CreateKey API action in KMS.
- LongTermPricingId
-
- Type: string
The ID of the long-term pricing type for the device.
- Notification
-
- Type: Notification structure
The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The
Notification
object is returned as a part of the response syntax of theDescribeJob
action in theJobMetadata
data type. - OnDeviceServiceConfiguration
-
- Type: OnDeviceServiceConfiguration structure
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
- PickupDetails
-
- Type: PickupDetails structure
Information identifying the person picking up the device.
- RemoteManagement
-
- Type: string
Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to
INSTALLED_AUTOSTART
, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device. - Resources
-
- Type: JobResource structure
An array of
S3Resource
objects. EachS3Resource
object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. - RoleARN
-
- Type: string
The role ARN associated with this job. This ARN was created using the CreateRole API action in Identity and Access Management.
- ShippingDetails
-
- Type: ShippingDetails structure
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
- SnowballCapacityPreference
-
- Type: string
The Snow device capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
- SnowballId
-
- Type: string
Unique ID associated with a device.
- SnowballType
-
- Type: string
The type of device used with this job.
- TaxDocuments
-
- Type: TaxDocuments structure
The metadata associated with the tax documents required in your Amazon Web Services Region.
JobResource
Description
Contains an array of Amazon Web Services resource objects. Each object represents an Amazon S3 bucket, an Lambda function, or an Amazon Machine Image (AMI) based on Amazon EC2 that is associated with a particular job.
Members
- Ec2AmiResources
-
- Type: Array of Ec2AmiResource structures
The Amazon Machine Images (AMIs) associated with this job.
- LambdaResources
-
- Type: Array of LambdaResource structures
The Python-language Lambda functions for this job.
- S3Resources
-
- Type: Array of S3Resource structures
An array of
S3Resource
objects.
KMSRequestFailedException
KeyRange
Description
Contains a key range. For export jobs, a S3Resource
object can have an optional KeyRange
value. The length of the range is defined at job creation, and has either an inclusive BeginMarker
, an inclusive EndMarker
, or both. Ranges are UTF-8 binary sorted.
Members
- BeginMarker
-
- Type: string
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
- EndMarker
-
- Type: string
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
LambdaResource
Description
Identifies
Members
- EventTriggers
-
- Type: Array of EventTriggerDefinition structures
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
- LambdaArn
-
- Type: string
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
LongTermPricingListEntry
Description
Each LongTermPricingListEntry
object contains information about a long-term pricing type.
Members
- CurrentActiveJob
-
- Type: string
The current active jobs on the device the long-term pricing type.
- IsLongTermPricingAutoRenew
-
- Type: boolean
If set to
true
, specifies that the current long-term pricing type for the device should be automatically renewed before the long-term pricing contract expires. - JobIds
-
- Type: Array of strings
The IDs of the jobs that are associated with a long-term pricing type.
- LongTermPricingEndDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end date the long-term pricing contract.
- LongTermPricingId
-
- Type: string
The ID of the long-term pricing type for the device.
- LongTermPricingStartDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start date of the long-term pricing contract.
- LongTermPricingStatus
-
- Type: string
The status of the long-term pricing type.
- LongTermPricingType
-
- Type: string
The type of long-term pricing that was selected for the device.
- ReplacementJob
-
- Type: string
A new device that replaces a device that is ordered with long-term pricing.
- SnowballType
-
- Type: string
The type of Snow Family devices associated with this long-term pricing job.
NFSOnDeviceServiceConfiguration
Description
An object that represents the metadata and configuration settings for the NFS (Network File System) service on an Amazon Web Services Snow Family device.
Members
- StorageLimit
-
- Type: int
The maximum NFS storage for one Snow Family device.
- StorageUnit
-
- Type: string
The scale unit of the NFS storage on the device.
Valid values: TB.
Notification
Description
The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification
object is returned as a part of the response syntax of the DescribeJob
action in the JobMetadata
data type.
When the notification settings are defined during job creation, you can choose to notify based on a specific set of job states using the JobStatesToNotify
array of strings, or you can specify that you want to have Amazon SNS notifications sent out for all job states with NotifyAll
set to true.
Members
- DevicePickupSnsTopicARN
-
- Type: string
Used to send SNS notifications for the person picking up the device (identified during job creation).
- JobStatesToNotify
-
- Type: Array of strings
The list of job states that will trigger a notification for this job.
- NotifyAll
-
- Type: boolean
Any change in job state will trigger a notification for this job.
- SnsTopicARN
-
- Type: string
The new SNS
TopicArn
that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
OnDeviceServiceConfiguration
Description
An object that represents the metadata and configuration settings for services on an Amazon Web Services Snow Family device.
Members
- EKSOnDeviceService
-
- Type: EKSOnDeviceServiceConfiguration structure
The configuration of EKS Anywhere on the Snow Family device.
- NFSOnDeviceService
-
- Type: NFSOnDeviceServiceConfiguration structure
Represents the NFS (Network File System) service on a Snow Family device.
- S3OnDeviceService
-
- Type: S3OnDeviceServiceConfiguration structure
Configuration for Amazon S3 compatible storage on Snow family devices.
- TGWOnDeviceService
-
- Type: TGWOnDeviceServiceConfiguration structure
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
PickupDetails
Description
Information identifying the person picking up the device.
Members
- DevicePickupId
-
- Type: string
The unique ID for a device that will be picked up.
-
- Type: string
The email address of the person picking up the device.
- IdentificationExpirationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Expiration date of the credential identifying the person picking up the device.
- IdentificationIssuingOrg
-
- Type: string
Organization that issued the credential identifying the person picking up the device.
- IdentificationNumber
-
- Type: string
The number on the credential identifying the person picking up the device.
- Name
-
- Type: string
The name of the person picking up the device.
- PhoneNumber
-
- Type: string
The phone number of the person picking up the device.
ReturnShippingLabelAlreadyExistsException
Description
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.
Members
- Message
-
- Type: string
S3OnDeviceServiceConfiguration
Description
Amazon S3 compatible storage on Snow family devices configuration items.
Members
- FaultTolerance
-
- Type: int
>Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified
StorageLimit
matches more than one Amazon S3 compatible storage on Snow family devices service configuration. - ServiceSize
-
- Type: int
Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.
- StorageLimit
-
- Type: double
If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.
- StorageUnit
-
- Type: string
Storage unit. Currently the only supported unit is TB.
S3Resource
Description
Each S3Resource
object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. For export jobs, this object can have an optional KeyRange
value. The length of the range is defined at job creation, and has either an inclusive BeginMarker
, an inclusive EndMarker
, or both. Ranges are UTF-8 binary sorted.
Members
- BucketArn
-
- Type: string
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
- KeyRange
-
- Type: KeyRange structure
For export jobs, you can provide an optional
KeyRange
within a specific Amazon S3 bucket. The length of the range is defined at job creation, and has either an inclusiveBeginMarker
, an inclusiveEndMarker
, or both. Ranges are UTF-8 binary sorted. - TargetOnDeviceServices
-
- Type: Array of TargetOnDeviceService structures
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System).
ServiceVersion
Description
The version of the requested service.
Members
- Version
-
- Type: string
The version number of the requested service.
Shipment
Description
The Status
and TrackingNumber
information for an inbound or outbound shipment.
Members
- Status
-
- Type: string
Status information for a shipment.
- TrackingNumber
-
- Type: string
The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snow device as the carrier transports it.
For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.
ShippingDetails
Description
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
Members
- InboundShipment
-
- Type: Shipment structure
The
Status
andTrackingNumber
values for a Snow device being returned to Amazon Web Services for a particular job. - OutboundShipment
-
- Type: Shipment structure
The
Status
andTrackingNumber
values for a Snow device being delivered to the address that you specified for a particular job. - ShippingOption
-
- Type: string
The shipping speed for a particular job. This speed doesn't dictate how soon you'll get the Snow device from the job's creation date. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:
-
In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
-
In the European Union (EU), you have access to express shipping. Typically, Snow devices 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, Snow devices are delivered in one to seven days.
-
In the United States of America (US), you have access to one-day shipping and two-day shipping.
SnowconeDeviceConfiguration
Description
Specifies the device configuration for an Snowcone job.
Members
- WirelessConnection
-
- Type: WirelessConnection structure
Configures the wireless connection for the Snowcone device.
TGWOnDeviceServiceConfiguration
Description
An object that represents the metadata and configuration settings for the Storage Gateway service Tape Gateway type on an Amazon Web Services Snow Family device.
Members
- StorageLimit
-
- Type: int
The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.
- StorageUnit
-
- Type: string
The scale unit of the virtual tapes on the device.
TargetOnDeviceService
Description
An object that represents the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System).
Members
- ServiceName
-
- Type: string
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
- TransferOption
-
- Type: string
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
TaxDocuments
Description
The tax documents required in your Amazon Web Services Region.
Members
- IND
-
- Type: INDTaxDocuments structure
The tax documents required in Amazon Web Services Region in India.
UnsupportedAddressException
Description
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.
Members
- Message
-
- Type: string
WirelessConnection
Description
Configures the wireless connection on an Snowcone device.
Members
- IsWifiEnabled
-
- Type: boolean
Enables the Wi-Fi adapter on an Snowcone device.