Expand description
AWS Snow Family is 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 commands described here provide access to the same functionality that is available in the AWS Snow Family Management Console, which enables you to create and manage jobs for a Snow device. To transfer data locally with a Snow device, you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or AWS OpsHub for Snow Family. For more information, see the User Guide.
If you’re using the service, you’re probably looking for SnowballClient and Snowball.
Structs§
- Address
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
Addressare required, if the address is invalid or unsupported, then an exception is thrown.- Cancel
Cluster Request - Cancel
Cluster Result - Cancel
JobRequest - Cancel
JobResult - Cluster
List Entry Contains a cluster's state, a cluster's ID, and other important information.
- Cluster
Metadata Contains metadata about a specific cluster.
- Compatible
Image 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.
- Create
Address Request - Create
Address Result - Create
Cluster Request - Create
Cluster Result - Create
JobRequest - Create
JobResult - Create
Long Term Pricing Request - Create
Long Term Pricing Result - Create
Return Shipping Label Request - Create
Return Shipping Label Result - Data
Transfer Defines the real-time status of a Snow device's data transfer while the device is at AWS. This data is only available while a job has a
JobStatevalue ofInProgress, for both import and export jobs.- Describe
Address Request - Describe
Address Result - Describe
Addresses Request - Describe
Addresses Result - Describe
Cluster Request - Describe
Cluster Result - Describe
JobRequest - Describe
JobResult - Describe
Return Shipping Label Request - Describe
Return Shipping Label Result - Device
Configuration The container for
SnowconeDeviceConfiguration.- Ec2Ami
Resource A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI), including the Amazon EC2 AMI ID and the Snow device AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the AWS Cloud and on the device.
- Event
Trigger Definition The container for the EventTriggerDefinition$EventResourceARN.
- GetJob
Manifest Request - GetJob
Manifest Result - GetJob
Unlock Code Request - GetJob
Unlock Code Result - GetSnowball
Usage Request - GetSnowball
Usage Result - GetSoftware
Updates Request - GetSoftware
Updates Result - INDTax
Documents The tax documents required in AWS Regions in India.
- JobList
Entry Each
JobListEntryobject 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.- JobLogs
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
DescribeJobaction in theJobMetadatadata 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 theDescribeJobaction.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.
- JobMetadata
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
DescribeJobaction.- JobResource
Contains an array of AWS resource objects. Each object represents an Amazon S3 bucket, an AWS Lambda function, or an Amazon Machine Image (AMI) based on Amazon EC2 that is associated with a particular job.
- KeyRange
Contains a key range. For export jobs, a
S3Resourceobject can have an optionalKeyRangevalue. 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.- Lambda
Resource Identifies
- List
Cluster Jobs Request - List
Cluster Jobs Result - List
Clusters Request - List
Clusters Result - List
Compatible Images Request - List
Compatible Images Result - List
Jobs Request - List
Jobs Result - List
Long Term Pricing Request - List
Long Term Pricing Result - Long
Term Pricing List Entry Each
LongTermPricingListEntryobject contains information about a long-term pricing type.- NFSOn
Device Service Configuration An object that represents metadata and configuration settings for NFS service on an AWS Snow Family device.
- Notification
The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The
Notificationobject is returned as a part of the response syntax of theDescribeJobaction in theJobMetadatadata 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
JobStatesToNotifyarray of strings, or you can specify that you want to have Amazon SNS notifications sent out for all job states withNotifyAllset to true.- OnDevice
Service Configuration An object that represents metadata and configuration settings for services on an AWS Snow Family device.
- S3Resource
Each
S3Resourceobject represents an Amazon S3 bucket that your transferred data will be exported from or imported into. For export jobs, this object can have an optionalKeyRangevalue. 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.- Shipment
The
StatusandTrackingNumberinformation for an inbound or outbound shipment.- Shipping
Details A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
- Snowball
Client - A client for the Amazon Snowball API.
- Snowcone
Device Configuration Specifies the device configuration for an AWS Snowcone job.
- Target
OnDevice Service An object that represents the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).
- TaxDocuments
The tax documents required in your AWS Region.
- Update
Cluster Request - Update
Cluster Result - Update
JobRequest - Update
JobResult - Update
JobShipment State Request - Update
JobShipment State Result - Update
Long Term Pricing Request - Update
Long Term Pricing Result - Wireless
Connection Configures the wireless connection on an AWS Snowcone device.
Enums§
- Cancel
Cluster Error - Errors returned by CancelCluster
- Cancel
JobError - Errors returned by CancelJob
- Create
Address Error - Errors returned by CreateAddress
- Create
Cluster Error - Errors returned by CreateCluster
- Create
JobError - Errors returned by CreateJob
- Create
Long Term Pricing Error - Errors returned by CreateLongTermPricing
- Create
Return Shipping Label Error - Errors returned by CreateReturnShippingLabel
- Describe
Address Error - Errors returned by DescribeAddress
- Describe
Addresses Error - Errors returned by DescribeAddresses
- Describe
Cluster Error - Errors returned by DescribeCluster
- Describe
JobError - Errors returned by DescribeJob
- Describe
Return Shipping Label Error - Errors returned by DescribeReturnShippingLabel
- GetJob
Manifest Error - Errors returned by GetJobManifest
- GetJob
Unlock Code Error - Errors returned by GetJobUnlockCode
- GetSnowball
Usage Error - Errors returned by GetSnowballUsage
- GetSoftware
Updates Error - Errors returned by GetSoftwareUpdates
- List
Cluster Jobs Error - Errors returned by ListClusterJobs
- List
Clusters Error - Errors returned by ListClusters
- List
Compatible Images Error - Errors returned by ListCompatibleImages
- List
Jobs Error - Errors returned by ListJobs
- List
Long Term Pricing Error - Errors returned by ListLongTermPricing
- Update
Cluster Error - Errors returned by UpdateCluster
- Update
JobError - Errors returned by UpdateJob
- Update
JobShipment State Error - Errors returned by UpdateJobShipmentState
- Update
Long Term Pricing Error - Errors returned by UpdateLongTermPricing
Traits§
- Snowball
- Trait representing the capabilities of the Amazon Snowball API. Amazon Snowball clients implement this trait.