amazonaws.com – snowball
The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses secure devices to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snow Family commands described here provide access to the same functionality that is available in the Amazon Web Services Snow Family Management Console, which enables you to create and manage jobs for a Snow Family device. To transfer data locally with a Snow Family device, you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or OpsHub for Snow Family. For more information, see the .
- Homepage
- https://api.apis.guru/v2/specs/amazonaws.com:snowball/2016-06-30.json
- Provider
- amazonaws.com:snowball / snowball
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/amazonaws.com/snowball/2016-06-30/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/amazonaws.com/snowball/2016-06-30/openapi.yaml
Tools (28)
Extracted live via the executor SDK.
-
xAmzTargetAwsieSnowballJobManagementServiceCancelCluster.cancelClusterCancels a cluster job. You can only cancel a cluster job while it's in the
AwaitingQuorumstatus. You'll have at least an hour after creating a cluster job to cancel it. -
xAmzTargetAwsieSnowballJobManagementServiceCancelJob.cancelJobCancels the specified job. You can only cancel a job before its
JobStatevalue changes toPreparingAppliance. Requesting theListJobsorDescribeJobaction returns a job'sJobStateas part of the response element data returned. -
xAmzTargetAwsieSnowballJobManagementServiceCreateAddress.createAddressCreates 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.
-
xAmzTargetAwsieSnowballJobManagementServiceCreateCluster.createClusterCreates an empty cluster. Each cluster supports five nodes. You use the CreateJob [blocked] action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.
-
xAmzTargetAwsieSnowballJobManagementServiceCreateJob.createJobCreates 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
clusterIdvalue; 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 .
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
-
-
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.
-
-
Device type: V3_5C
-
Capacity: T32
-
Description: Snowball Edge Compute Optimized without GPU
-
-
Device type: V3_5S
-
Capacity: T240
-
Description: Snowball Edge Storage Optimized 210TB
-
-
-
xAmzTargetAwsieSnowballJobManagementServiceCreateLongTermPricing.createLongTermPricingCreates 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.
-
xAmzTargetAwsieSnowballJobManagementServiceCreateReturnShippingLabel.createReturnShippingLabelCreates a shipping label that will be used to return the Snow device to Amazon Web Services.
-
xAmzTargetAwsieSnowballJobManagementServiceDescribeAddress.describeAddressTakes an
AddressIdand returns specific details about that address in the form of anAddressobject. -
xAmzTargetAwsieSnowballJobManagementServiceDescribeAddresses.describeAddressesReturns a specified number of
ADDRESSobjects. 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. -
xAmzTargetAwsieSnowballJobManagementServiceDescribeCluster.describeClusterReturns information about a specific cluster including shipping information, cluster status, and other important metadata.
-
xAmzTargetAwsieSnowballJobManagementServiceDescribeJob.describeJobReturns information about a specific job including shipping information, job status, and other important metadata.
-
xAmzTargetAwsieSnowballJobManagementServiceDescribeReturnShippingLabel.describeReturnShippingLabelInformation on the shipping label of a Snow device that is being returned to Amazon Web Services.
-
xAmzTargetAwsieSnowballJobManagementServiceGetJobManifest.getJobManifestReturns a link to an Amazon S3 presigned URL for the manifest file associated with the specified
JobIdvalue. 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 theGetJobManifestaction.The manifest is an encrypted file that you can download after your job enters the
WithCustomerstatus. This is the only valid status for calling this API as the manifest andUnlockCodecode value are used for securing your device and should only be used when you have the device. The manifest is decrypted by using theUnlockCodecode 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
UnlockCodevalue 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.
-
xAmzTargetAwsieSnowballJobManagementServiceGetJobUnlockCode.getJobUnlockCodeReturns the
UnlockCodecode value for the specified job. A particularUnlockCodevalue can be accessed for up to 360 days after the associated job has been created.The
UnlockCodevalue 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 isWithCustomeras the manifest andUnlockcode 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
UnlockCodein 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. -
xAmzTargetAwsieSnowballJobManagementServiceGetSnowballUsage.getSnowballUsageReturns 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.
-
xAmzTargetAwsieSnowballJobManagementServiceGetSoftwareUpdates.getSoftwareUpdatesReturns an Amazon S3 presigned URL for an update file associated with a specified
JobId. -
xAmzTargetAwsieSnowballJobManagementServiceListClusterJobs.listClusterJobsReturns an array of
JobListEntryobjects of the specified length. EachJobListEntryobject is for a job in the specified cluster and contains a job's state, a job's ID, and other information. -
xAmzTargetAwsieSnowballJobManagementServiceListClusters.listClustersReturns an array of
ClusterListEntryobjects of the specified length. EachClusterListEntryobject contains a cluster's state, a cluster's ID, and other important status information. -
xAmzTargetAwsieSnowballJobManagementServiceListCompatibleImages.listCompatibleImagesThis action returns a list of the different Amazon EC2 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.
-
xAmzTargetAwsieSnowballJobManagementServiceListJobs.listJobsReturns an array of
JobListEntryobjects of the specified length. EachJobListEntryobject 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. -
xAmzTargetAwsieSnowballJobManagementServiceListLongTermPricing.listLongTermPricingLists all long-term pricing types.
-
xAmzTargetAwsieSnowballJobManagementServiceListServiceVersions.listServiceVersionsLists all supported versions for Snow on-device services. Returns an array of
ServiceVersionobject containing the supported versions for a particular service. -
xAmzTargetAwsieSnowballJobManagementServiceUpdateCluster.updateClusterWhile a cluster's
ClusterStatevalue is in theAwaitingQuorumstate, 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. -
xAmzTargetAwsieSnowballJobManagementServiceUpdateJob.updateJobWhile a job's
JobStatevalue isNew, 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. -
xAmzTargetAwsieSnowballJobManagementServiceUpdateJobShipmentState.updateJobShipmentStateUpdates the state when a shipment state changes to a different state.
-
xAmzTargetAwsieSnowballJobManagementServiceUpdateLongTermPricing.updateLongTermPricingUpdates the long-term pricing type.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools