Table of Contents
Snowball.Client¶A low-level client representing Amazon Import/Export 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 User Guide.
import boto3
client = boto3.client('snowball')
These are the available methods:
can_paginate()cancel_cluster()cancel_job()close()create_address()create_cluster()create_job()create_long_term_pricing()create_return_shipping_label()describe_address()describe_addresses()describe_cluster()describe_job()describe_return_shipping_label()get_job_manifest()get_job_unlock_code()get_paginator()get_snowball_usage()get_software_updates()get_waiter()list_cluster_jobs()list_clusters()list_compatible_images()list_jobs()list_long_term_pricing()update_cluster()update_job()update_job_shipment_state()update_long_term_pricing()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.cancel_cluster(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.cancel_cluster(
ClusterId='string'
)
[REQUIRED]
The 39-character ID for the cluster that you want to cancel, for example CID123e4567-e89b-12d3-a456-426655440000 .
{}
Response Structure
Exceptions
Snowball.Client.exceptions.KMSRequestFailedExceptionSnowball.Client.exceptions.InvalidJobStateExceptionSnowball.Client.exceptions.InvalidResourceExceptionExamples
This operation cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status.
response = client.cancel_cluster(
ClusterId='CID123e4567-e89b-12d3-a456-426655440000',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
cancel_job(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.cancel_job(
JobId='string'
)
[REQUIRED]
The 39-character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000 .
{}
Response Structure
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionSnowball.Client.exceptions.InvalidJobStateExceptionSnowball.Client.exceptions.KMSRequestFailedExceptionExamples
This operation cancels a job. You can only cancel a job before its JobState value changes to PreparingAppliance.
response = client.cancel_job(
JobId='JID123e4567-e89b-12d3-a456-426655440000',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
close()¶Closes underlying endpoint connections.
create_address(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_address(
Address={
'AddressId': 'string',
'Name': 'string',
'Company': 'string',
'Street1': 'string',
'Street2': 'string',
'Street3': 'string',
'City': 'string',
'StateOrProvince': 'string',
'PrefectureOrDistrict': 'string',
'Landmark': 'string',
'Country': 'string',
'PostalCode': 'string',
'PhoneNumber': 'string',
'IsRestricted': True|False
}
)
[REQUIRED]
The address that you want the Snow device shipped to.
The unique ID for an address.
The name of a person to receive a Snow device at an address.
The name of the company to receive a Snow device at an address.
The first line in a street address that a Snow device is to be delivered to.
The second line in a street address that a Snow device is to be delivered to.
The third line in a street address that a Snow device is to be delivered to.
The city in an address that a Snow device is to be delivered to.
The state or province in an address that a Snow device is to be delivered to.
This field is no longer used and the value is ignored.
This field is no longer used and the value is ignored.
The country in an address that a Snow device is to be delivered to.
The postal code in an address that a Snow device is to be delivered to.
The phone number associated with an address that a Snow device is to be delivered to.
If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.
{
'AddressId': 'string'
}
Response Structure
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.
Exceptions
Snowball.Client.exceptions.InvalidAddressExceptionSnowball.Client.exceptions.UnsupportedAddressExceptionExamples
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.
response = client.create_address(
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',
},
)
print(response)
Expected Output:
{
'AddressId': 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
'ResponseMetadata': {
'...': '...',
},
}
create_cluster(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_cluster(
JobType='IMPORT'|'EXPORT'|'LOCAL_USE',
Resources={
'S3Resources': [
{
'BucketArn': 'string',
'KeyRange': {
'BeginMarker': 'string',
'EndMarker': 'string'
},
'TargetOnDeviceServices': [
{
'ServiceName': 'NFS_ON_DEVICE_SERVICE'|'S3_ON_DEVICE_SERVICE',
'TransferOption': 'IMPORT'|'EXPORT'|'LOCAL_USE'
},
]
},
],
'LambdaResources': [
{
'LambdaArn': 'string',
'EventTriggers': [
{
'EventResourceARN': 'string'
},
]
},
],
'Ec2AmiResources': [
{
'AmiId': 'string',
'SnowballAmiId': 'string'
},
]
},
OnDeviceServiceConfiguration={
'NFSOnDeviceService': {
'StorageLimit': 123,
'StorageUnit': 'TB'
},
'TGWOnDeviceService': {
'StorageLimit': 123,
'StorageUnit': 'TB'
}
},
Description='string',
AddressId='string',
KmsKeyARN='string',
RoleARN='string',
SnowballType='STANDARD'|'EDGE'|'EDGE_C'|'EDGE_CG'|'EDGE_S'|'SNC1_HDD'|'SNC1_SSD'|'V3_5C',
ShippingOption='SECOND_DAY'|'NEXT_DAY'|'EXPRESS'|'STANDARD',
Notification={
'SnsTopicARN': 'string',
'JobStatesToNotify': [
'New'|'PreparingAppliance'|'PreparingShipment'|'InTransitToCustomer'|'WithCustomer'|'InTransitToAWS'|'WithAWSSortingFacility'|'WithAWS'|'InProgress'|'Complete'|'Cancelled'|'Listing'|'Pending',
],
'NotifyAll': True|False
},
ForwardingAddressId='string',
TaxDocuments={
'IND': {
'GSTIN': 'string'
}
},
RemoteManagement='INSTALLED_ONLY'|'INSTALLED_AUTOSTART'
)
[REQUIRED]
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 .
[REQUIRED]
The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.
An array of S3Resource objects.
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.
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
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 inclusive BeginMarker , an inclusive EndMarker , or both. Ranges are UTF-8 binary sorted.
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
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).
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).
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
The Python-language Lambda functions for this job.
Identifies
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
The container for the EventTriggerDefinition$EventResourceARN.
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
The Amazon Machine Images (AMIs) associated with this job.
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 Amazon Web Services Cloud and on the device.
The ID of the AMI in Amazon EC2.
The ID of the AMI on the Snow device.
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).
Represents the NFS (Network File System) service on a Snow Family device.
The maximum NFS storage for one Snow Family device.
The scale unit of the NFS storage on the device.
Valid values: TB.
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
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.
The scale unit of the virtual tapes on the device.
Environmental Data Cluster-01 .[REQUIRED]
The ID for the address that you want the cluster shipped to.
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).[REQUIRED]
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).
[REQUIRED]
The type of Snow Family devices to use for this cluster.
Note
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 .
[REQUIRED]
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:
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
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.
The list of job states that will trigger a notification for this job.
Any change in job state will trigger a notification for this job.
The tax documents required in your Amazon Web Services Region.
The tax documents required in Amazon Web Services Region in India.
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
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.dict
Response Syntax
{
'ClusterId': 'string'
}
Response Structure
(dict) --
ClusterId (string) --
The automatically generated ID for a cluster.
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionSnowball.Client.exceptions.KMSRequestFailedExceptionSnowball.Client.exceptions.InvalidInputCombinationExceptionSnowball.Client.exceptions.Ec2RequestFailedExceptionExamples
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.
response = client.create_cluster(
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': False,
},
Resources={
'S3Resources': [
{
'BucketArn': 'arn:aws:s3:::MyBucket',
'KeyRange': {
},
},
],
},
RoleARN='arn:aws:iam::123456789012:role/snowball-import-S3-role',
ShippingOption='SECOND_DAY',
SnowballType='EDGE',
)
print(response)
Expected Output:
{
'ClusterId': 'CID123e4567-e89b-12d3-a456-426655440000',
'ResponseMetadata': {
'...': '...',
},
}
create_job(**kwargs)¶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.
Note
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.
Snow Family device type: SNC1_SSD
Snow Family device type: SNC1_HDD
Device type: EDGE_S
Device type: EDGE_CG
Device type: EDGE_C
Device type: EDGE
Device type: V3_5C
Device type: STANDARD
Note
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region
Device type: STANDARD
Note
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
response = client.create_job(
JobType='IMPORT'|'EXPORT'|'LOCAL_USE',
Resources={
'S3Resources': [
{
'BucketArn': 'string',
'KeyRange': {
'BeginMarker': 'string',
'EndMarker': 'string'
},
'TargetOnDeviceServices': [
{
'ServiceName': 'NFS_ON_DEVICE_SERVICE'|'S3_ON_DEVICE_SERVICE',
'TransferOption': 'IMPORT'|'EXPORT'|'LOCAL_USE'
},
]
},
],
'LambdaResources': [
{
'LambdaArn': 'string',
'EventTriggers': [
{
'EventResourceARN': 'string'
},
]
},
],
'Ec2AmiResources': [
{
'AmiId': 'string',
'SnowballAmiId': 'string'
},
]
},
OnDeviceServiceConfiguration={
'NFSOnDeviceService': {
'StorageLimit': 123,
'StorageUnit': 'TB'
},
'TGWOnDeviceService': {
'StorageLimit': 123,
'StorageUnit': 'TB'
}
},
Description='string',
AddressId='string',
KmsKeyARN='string',
RoleARN='string',
SnowballCapacityPreference='T50'|'T80'|'T100'|'T42'|'T98'|'T8'|'T14'|'NoPreference'|'T32',
ShippingOption='SECOND_DAY'|'NEXT_DAY'|'EXPRESS'|'STANDARD',
Notification={
'SnsTopicARN': 'string',
'JobStatesToNotify': [
'New'|'PreparingAppliance'|'PreparingShipment'|'InTransitToCustomer'|'WithCustomer'|'InTransitToAWS'|'WithAWSSortingFacility'|'WithAWS'|'InProgress'|'Complete'|'Cancelled'|'Listing'|'Pending',
],
'NotifyAll': True|False
},
ClusterId='string',
SnowballType='STANDARD'|'EDGE'|'EDGE_C'|'EDGE_CG'|'EDGE_S'|'SNC1_HDD'|'SNC1_SSD'|'V3_5C',
ForwardingAddressId='string',
TaxDocuments={
'IND': {
'GSTIN': 'string'
}
},
DeviceConfiguration={
'SnowconeDeviceConfiguration': {
'WirelessConnection': {
'IsWifiEnabled': True|False
}
}
},
RemoteManagement='INSTALLED_ONLY'|'INSTALLED_AUTOSTART',
LongTermPricingId='string'
)
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 a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.
An array of S3Resource objects.
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.
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
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 inclusive BeginMarker , an inclusive EndMarker , or both. Ranges are UTF-8 binary sorted.
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
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).
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).
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
The Python-language Lambda functions for this job.
Identifies
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
The container for the EventTriggerDefinition$EventResourceARN.
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
The Amazon Machine Images (AMIs) associated with this job.
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 Amazon Web Services Cloud and on the device.
The ID of the AMI in Amazon EC2.
The ID of the AMI on the Snow device.
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.
Represents the NFS (Network File System) service on a Snow Family device.
The maximum NFS storage for one Snow Family device.
The scale unit of the NFS storage on the device.
Valid values: TB.
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
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.
The scale unit of the virtual tapes on the device.
Important Photos 2016-08-11 .KmsKeyARN that you want to associate with this job. KmsKeyARN s are created using the CreateKey Key Management Service (KMS) API action.RoleARN that you want to associate with this job. RoleArn s are created using the CreateRole Identity and Access Management (IAM) API action.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 .
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:
Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
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.
The list of job states that will trigger a notification for this job.
Any change in job state will trigger a notification for this job.
clusterId value. The other job attributes are inherited from the cluster.The type of Snow Family devices to use for this job.
Note
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 .
The tax documents required in your Amazon Web Services Region.
The tax documents required in Amazon Web Services Region in India.
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
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 .
Returns information about the device configuration for an Snowcone job.
Configures the wireless connection for the Snowcone device.
Enables the Wi-Fi adapter on an Snowcone device.
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.dict
Response Syntax
{
'JobId': 'string'
}
Response Structure
(dict) --
JobId (string) --
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionSnowball.Client.exceptions.KMSRequestFailedExceptionSnowball.Client.exceptions.InvalidInputCombinationExceptionSnowball.Client.exceptions.ClusterLimitExceededExceptionSnowball.Client.exceptions.Ec2RequestFailedExceptionExamples
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.
response = client.create_job(
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': False,
},
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',
)
print(response)
Expected Output:
{
'JobId': 'JID123e4567-e89b-12d3-a456-426655440000',
'ResponseMetadata': {
'...': '...',
},
}
create_long_term_pricing(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_long_term_pricing(
LongTermPricingType='OneYear'|'ThreeYear',
IsLongTermPricingAutoRenew=True|False,
SnowballType='STANDARD'|'EDGE'|'EDGE_C'|'EDGE_CG'|'EDGE_S'|'SNC1_HDD'|'SNC1_SSD'|'V3_5C'
)
[REQUIRED]
The type of long-term pricing option you want for the device, either 1-year or 3-year long-term pricing.
snowballty
Specifies whether the current long-term pricing type for the device should be renewed.
dict
Response Syntax
{
'LongTermPricingId': 'string'
}
Response Structure
(dict) --
LongTermPricingId (string) --
The ID of the long-term pricing type for the device.
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptioncreate_return_shipping_label(**kwargs)¶Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
See also: AWS API Documentation
Request Syntax
response = client.create_return_shipping_label(
JobId='string',
ShippingOption='SECOND_DAY'|'NEXT_DAY'|'EXPRESS'|'STANDARD'
)
[REQUIRED]
The ID for a job that you want to create the return shipping label for; for example, JID123e4567-e89b-12d3-a456-426655440000 .
dict
Response Syntax
{
'Status': 'InProgress'|'TimedOut'|'Succeeded'|'Failed'
}
Response Structure
(dict) --
Status (string) --
The status information of the task on a Snow device that is being returned to Amazon Web Services.
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionSnowball.Client.exceptions.InvalidJobStateExceptionSnowball.Client.exceptions.InvalidInputCombinationExceptionSnowball.Client.exceptions.ConflictExceptionSnowball.Client.exceptions.ReturnShippingLabelAlreadyExistsExceptiondescribe_address(**kwargs)¶Takes an AddressId and returns specific details about that address in the form of an Address object.
See also: AWS API Documentation
Request Syntax
response = client.describe_address(
AddressId='string'
)
[REQUIRED]
The automatically generated ID for a specific address.
{
'Address': {
'AddressId': 'string',
'Name': 'string',
'Company': 'string',
'Street1': 'string',
'Street2': 'string',
'Street3': 'string',
'City': 'string',
'StateOrProvince': 'string',
'PrefectureOrDistrict': 'string',
'Landmark': 'string',
'Country': 'string',
'PostalCode': 'string',
'PhoneNumber': 'string',
'IsRestricted': True|False
}
}
Response Structure
The address that you want the Snow device(s) associated with a specific job to be shipped to.
The unique ID for an address.
The name of a person to receive a Snow device at an address.
The name of the company to receive a Snow device at an address.
The first line in a street address that a Snow device is to be delivered to.
The second line in a street address that a Snow device is to be delivered to.
The third line in a street address that a Snow device is to be delivered to.
The city in an address that a Snow device is to be delivered to.
The state or province in an address that a Snow device is to be delivered to.
This field is no longer used and the value is ignored.
This field is no longer used and the value is ignored.
The country in an address that a Snow device is to be delivered to.
The postal code in an address that a Snow device is to be delivered to.
The phone number associated with an address that a Snow device is to be delivered to.
If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionExamples
This operation describes an address for a job.
response = client.describe_address(
AddressId='ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
)
print(response)
Expected Output:
{
'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',
},
'ResponseMetadata': {
'...': '...',
},
}
describe_addresses(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_addresses(
MaxResults=123,
NextToken='string'
)
ADDRESS objects to return.ADDRESS objects, you have the option of specifying a value for NextToken as the starting point for your list of returned addresses.dict
Response Syntax
{
'Addresses': [
{
'AddressId': 'string',
'Name': 'string',
'Company': 'string',
'Street1': 'string',
'Street2': 'string',
'Street3': 'string',
'City': 'string',
'StateOrProvince': 'string',
'PrefectureOrDistrict': 'string',
'Landmark': 'string',
'Country': 'string',
'PostalCode': 'string',
'PhoneNumber': 'string',
'IsRestricted': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Addresses (list) --
The Snow device shipping addresses that were created for this account.
(dict) --
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.
AddressId (string) --
The unique ID for an address.
Name (string) --
The name of a person to receive a Snow device at an address.
Company (string) --
The name of the company to receive a Snow device at an address.
Street1 (string) --
The first line in a street address that a Snow device is to be delivered to.
Street2 (string) --
The second line in a street address that a Snow device is to be delivered to.
Street3 (string) --
The third line in a street address that a Snow device is to be delivered to.
City (string) --
The city in an address that a Snow device is to be delivered to.
StateOrProvince (string) --
The state or province in an address that a Snow device is to be delivered to.
PrefectureOrDistrict (string) --
This field is no longer used and the value is ignored.
Landmark (string) --
This field is no longer used and the value is ignored.
Country (string) --
The country in an address that a Snow device is to be delivered to.
PostalCode (string) --
The postal code in an address that a Snow device is to be delivered to.
PhoneNumber (string) --
The phone number associated with an address that a Snow device is to be delivered to.
IsRestricted (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.
NextToken (string) --
HTTP requests are stateless. If you use the automatically generated NextToken value in your next DescribeAddresses call, your list of returned addresses will start from this point in the array.
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionSnowball.Client.exceptions.InvalidNextTokenExceptionExamples
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.
response = client.describe_addresses(
)
print(response)
Expected Output:
{
'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',
},
],
'ResponseMetadata': {
'...': '...',
},
}
describe_cluster(**kwargs)¶Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
See also: AWS API Documentation
Request Syntax
response = client.describe_cluster(
ClusterId='string'
)
[REQUIRED]
The automatically generated ID for a cluster.
{
'ClusterMetadata': {
'ClusterId': 'string',
'Description': 'string',
'KmsKeyARN': 'string',
'RoleARN': 'string',
'ClusterState': 'AwaitingQuorum'|'Pending'|'InUse'|'Complete'|'Cancelled',
'JobType': 'IMPORT'|'EXPORT'|'LOCAL_USE',
'SnowballType': 'STANDARD'|'EDGE'|'EDGE_C'|'EDGE_CG'|'EDGE_S'|'SNC1_HDD'|'SNC1_SSD'|'V3_5C',
'CreationDate': datetime(2015, 1, 1),
'Resources': {
'S3Resources': [
{
'BucketArn': 'string',
'KeyRange': {
'BeginMarker': 'string',
'EndMarker': 'string'
},
'TargetOnDeviceServices': [
{
'ServiceName': 'NFS_ON_DEVICE_SERVICE'|'S3_ON_DEVICE_SERVICE',
'TransferOption': 'IMPORT'|'EXPORT'|'LOCAL_USE'
},
]
},
],
'LambdaResources': [
{
'LambdaArn': 'string',
'EventTriggers': [
{
'EventResourceARN': 'string'
},
]
},
],
'Ec2AmiResources': [
{
'AmiId': 'string',
'SnowballAmiId': 'string'
},
]
},
'AddressId': 'string',
'ShippingOption': 'SECOND_DAY'|'NEXT_DAY'|'EXPRESS'|'STANDARD',
'Notification': {
'SnsTopicARN': 'string',
'JobStatesToNotify': [
'New'|'PreparingAppliance'|'PreparingShipment'|'InTransitToCustomer'|'WithCustomer'|'InTransitToAWS'|'WithAWSSortingFacility'|'WithAWS'|'InProgress'|'Complete'|'Cancelled'|'Listing'|'Pending',
],
'NotifyAll': True|False
},
'ForwardingAddressId': 'string',
'TaxDocuments': {
'IND': {
'GSTIN': 'string'
}
},
'OnDeviceServiceConfiguration': {
'NFSOnDeviceService': {
'StorageLimit': 123,
'StorageUnit': 'TB'
},
'TGWOnDeviceService': {
'StorageLimit': 123,
'StorageUnit': 'TB'
}
}
}
}
Response Structure
Information about a specific cluster, including shipping information, cluster status, and other important metadata.
The automatically generated ID for a cluster.
The optional description of the cluster.
The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in Key Management Service (KMS.
The role ARN associated with this cluster. This ARN was created using the CreateRole API action in Identity and Access Management (IAM).
The current status of the cluster.
The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE .
The type of Snowcone device to use for this cluster.
Note
For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.
The creation date for this cluster.
The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
An array of S3Resource objects.
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.
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
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 inclusive BeginMarker , an inclusive EndMarker , or both. Ranges are UTF-8 binary sorted.
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
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).
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).
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
The Python-language Lambda functions for this job.
Identifies
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
The container for the EventTriggerDefinition$EventResourceARN.
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
The Amazon Machine Images (AMIs) associated with this job.
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 Amazon Web Services Cloud and on the device.
The ID of the AMI in Amazon EC2.
The ID of the AMI on the Snow device.
The automatically generated ID for a specific address.
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:
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
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.
The list of job states that will trigger a notification for this job.
Any change in job state will trigger a notification for this job.
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.
The tax documents required in your Amazon Web Services Region.
The tax documents required in Amazon Web Services Region in India.
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
Represents the NFS (Network File System) service on a Snow Family device.
The maximum NFS storage for one Snow Family device.
The scale unit of the NFS storage on the device.
Valid values: TB.
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
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.
The scale unit of the virtual tapes on the device.
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionExamples
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
response = client.describe_cluster(
ClusterId='CID123e4567-e89b-12d3-a456-426655440000',
)
print(response)
Expected Output:
{
'ClusterMetadata': {
'AddressId': 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
'ClusterId': 'CID123e4567-e89b-12d3-a456-426655440000',
'ClusterState': 'Pending',
'CreationDate': datetime(2016, 11, 30, 3, 11, 57, 2, 335, 0),
'Description': 'MyCluster',
'JobType': 'LOCAL_USE',
'KmsKeyARN': 'arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456',
'Notification': {
'JobStatesToNotify': [
],
'NotifyAll': False,
},
'Resources': {
'S3Resources': [
{
'BucketArn': 'arn:aws:s3:::MyBucket',
'KeyRange': {
},
},
],
},
'RoleARN': 'arn:aws:iam::123456789012:role/snowball-import-S3-role',
'ShippingOption': 'SECOND_DAY',
},
'ResponseMetadata': {
'...': '...',
},
}
describe_job(**kwargs)¶Returns information about a specific job including shipping information, job status, and other important metadata.
See also: AWS API Documentation
Request Syntax
response = client.describe_job(
JobId='string'
)
[REQUIRED]
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
{
'JobMetadata': {
'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',
'CreationDate': datetime(2015, 1, 1),
'Resources': {
'S3Resources': [
{
'BucketArn': 'string',
'KeyRange': {
'BeginMarker': 'string',
'EndMarker': 'string'
},
'TargetOnDeviceServices': [
{
'ServiceName': 'NFS_ON_DEVICE_SERVICE'|'S3_ON_DEVICE_SERVICE',
'TransferOption': 'IMPORT'|'EXPORT'|'LOCAL_USE'
},
]
},
],
'LambdaResources': [
{
'LambdaArn': 'string',
'EventTriggers': [
{
'EventResourceARN': 'string'
},
]
},
],
'Ec2AmiResources': [
{
'AmiId': 'string',
'SnowballAmiId': 'string'
},
]
},
'Description': 'string',
'KmsKeyARN': 'string',
'RoleARN': 'string',
'AddressId': 'string',
'ShippingDetails': {
'ShippingOption': 'SECOND_DAY'|'NEXT_DAY'|'EXPRESS'|'STANDARD',
'InboundShipment': {
'Status': 'string',
'TrackingNumber': 'string'
},
'OutboundShipment': {
'Status': 'string',
'TrackingNumber': 'string'
}
},
'SnowballCapacityPreference': 'T50'|'T80'|'T100'|'T42'|'T98'|'T8'|'T14'|'NoPreference'|'T32',
'Notification': {
'SnsTopicARN': 'string',
'JobStatesToNotify': [
'New'|'PreparingAppliance'|'PreparingShipment'|'InTransitToCustomer'|'WithCustomer'|'InTransitToAWS'|'WithAWSSortingFacility'|'WithAWS'|'InProgress'|'Complete'|'Cancelled'|'Listing'|'Pending',
],
'NotifyAll': True|False
},
'DataTransferProgress': {
'BytesTransferred': 123,
'ObjectsTransferred': 123,
'TotalBytes': 123,
'TotalObjects': 123
},
'JobLogInfo': {
'JobCompletionReportURI': 'string',
'JobSuccessLogURI': 'string',
'JobFailureLogURI': 'string'
},
'ClusterId': 'string',
'ForwardingAddressId': 'string',
'TaxDocuments': {
'IND': {
'GSTIN': 'string'
}
},
'DeviceConfiguration': {
'SnowconeDeviceConfiguration': {
'WirelessConnection': {
'IsWifiEnabled': True|False
}
}
},
'RemoteManagement': 'INSTALLED_ONLY'|'INSTALLED_AUTOSTART',
'LongTermPricingId': 'string',
'OnDeviceServiceConfiguration': {
'NFSOnDeviceService': {
'StorageLimit': 123,
'StorageUnit': 'TB'
},
'TGWOnDeviceService': {
'StorageLimit': 123,
'StorageUnit': 'TB'
}
}
},
'SubJobMetadata': [
{
'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',
'CreationDate': datetime(2015, 1, 1),
'Resources': {
'S3Resources': [
{
'BucketArn': 'string',
'KeyRange': {
'BeginMarker': 'string',
'EndMarker': 'string'
},
'TargetOnDeviceServices': [
{
'ServiceName': 'NFS_ON_DEVICE_SERVICE'|'S3_ON_DEVICE_SERVICE',
'TransferOption': 'IMPORT'|'EXPORT'|'LOCAL_USE'
},
]
},
],
'LambdaResources': [
{
'LambdaArn': 'string',
'EventTriggers': [
{
'EventResourceARN': 'string'
},
]
},
],
'Ec2AmiResources': [
{
'AmiId': 'string',
'SnowballAmiId': 'string'
},
]
},
'Description': 'string',
'KmsKeyARN': 'string',
'RoleARN': 'string',
'AddressId': 'string',
'ShippingDetails': {
'ShippingOption': 'SECOND_DAY'|'NEXT_DAY'|'EXPRESS'|'STANDARD',
'InboundShipment': {
'Status': 'string',
'TrackingNumber': 'string'
},
'OutboundShipment': {
'Status': 'string',
'TrackingNumber': 'string'
}
},
'SnowballCapacityPreference': 'T50'|'T80'|'T100'|'T42'|'T98'|'T8'|'T14'|'NoPreference'|'T32',
'Notification': {
'SnsTopicARN': 'string',
'JobStatesToNotify': [
'New'|'PreparingAppliance'|'PreparingShipment'|'InTransitToCustomer'|'WithCustomer'|'InTransitToAWS'|'WithAWSSortingFacility'|'WithAWS'|'InProgress'|'Complete'|'Cancelled'|'Listing'|'Pending',
],
'NotifyAll': True|False
},
'DataTransferProgress': {
'BytesTransferred': 123,
'ObjectsTransferred': 123,
'TotalBytes': 123,
'TotalObjects': 123
},
'JobLogInfo': {
'JobCompletionReportURI': 'string',
'JobSuccessLogURI': 'string',
'JobFailureLogURI': 'string'
},
'ClusterId': 'string',
'ForwardingAddressId': 'string',
'TaxDocuments': {
'IND': {
'GSTIN': 'string'
}
},
'DeviceConfiguration': {
'SnowconeDeviceConfiguration': {
'WirelessConnection': {
'IsWifiEnabled': True|False
}
}
},
'RemoteManagement': 'INSTALLED_ONLY'|'INSTALLED_AUTOSTART',
'LongTermPricingId': 'string',
'OnDeviceServiceConfiguration': {
'NFSOnDeviceService': {
'StorageLimit': 123,
'StorageUnit': 'TB'
},
'TGWOnDeviceService': {
'StorageLimit': 123,
'StorageUnit': 'TB'
}
}
},
]
}
Response Structure
Information about a specific job, including shipping information, job status, and other important metadata.
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
The current status of the jobs.
The type of job.
The type of device used with this job.
The creation date for this job.
An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.
An array of S3Resource objects.
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.
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
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 inclusive BeginMarker , an inclusive EndMarker , or both. Ranges are UTF-8 binary sorted.
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
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).
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).
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
The Python-language Lambda functions for this job.
Identifies
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
The container for the EventTriggerDefinition$EventResourceARN.
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
The Amazon Machine Images (AMIs) associated with this job.
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 Amazon Web Services Cloud and on the device.
The ID of the AMI in Amazon EC2.
The ID of the AMI on the Snow device.
The description of the job, provided at job creation.
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.
The role ARN associated with this job. This ARN was created using the CreateRole API action in Identity and Access Management.
The ID for the address that you want the Snow device shipped to.
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
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:
The Status and TrackingNumber values for a Snow device being returned to Amazon Web Services for a particular job.
Status information for a shipment.
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.
The Status and TrackingNumber values for a Snow device being delivered to the address that you specified for a particular job.
Status information for a shipment.
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.
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 .
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.
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.
The list of job states that will trigger a notification for this job.
Any change in job state will trigger a notification for this job.
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 of InProgress , for both import and export jobs.
The number of bytes transferred between a Snow device and Amazon S3.
The number of objects transferred between a Snow device and Amazon S3.
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.
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.
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.
A link to an Amazon S3 presigned URL where the job completion report is located.
A link to an Amazon S3 presigned URL where the job success log is located.
A link to an Amazon S3 presigned URL where the job failure log is located.
The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000 .
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.
The metadata associated with the tax documents required in your Amazon Web Services Region.
The tax documents required in Amazon Web Services Region in India.
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
The container for SnowconeDeviceConfiguration .
Returns information about the device configuration for an Snowcone job.
Configures the wireless connection for the Snowcone device.
Enables the Wi-Fi adapter on an Snowcone device.
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.
The ID of the long-term pricing type for the device.
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
Represents the NFS (Network File System) service on a Snow Family device.
The maximum NFS storage for one Snow Family device.
The scale unit of the NFS storage on the device.
Valid values: TB.
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
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.
The scale unit of the virtual tapes on the device.
Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.
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.
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
The current status of the jobs.
The type of job.
The type of device used with this job.
The creation date for this job.
An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.
An array of S3Resource objects.
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.
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
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 inclusive BeginMarker , an inclusive EndMarker , or both. Ranges are UTF-8 binary sorted.
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
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).
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).
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
The Python-language Lambda functions for this job.
Identifies
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
The container for the EventTriggerDefinition$EventResourceARN.
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
The Amazon Machine Images (AMIs) associated with this job.
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 Amazon Web Services Cloud and on the device.
The ID of the AMI in Amazon EC2.
The ID of the AMI on the Snow device.
The description of the job, provided at job creation.
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.
The role ARN associated with this job. This ARN was created using the CreateRole API action in Identity and Access Management.
The ID for the address that you want the Snow device shipped to.
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
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:
The Status and TrackingNumber values for a Snow device being returned to Amazon Web Services for a particular job.
Status information for a shipment.
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.
The Status and TrackingNumber values for a Snow device being delivered to the address that you specified for a particular job.
Status information for a shipment.
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.
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 .
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.
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.
The list of job states that will trigger a notification for this job.
Any change in job state will trigger a notification for this job.
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 of InProgress , for both import and export jobs.
The number of bytes transferred between a Snow device and Amazon S3.
The number of objects transferred between a Snow device and Amazon S3.
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.
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.
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.
A link to an Amazon S3 presigned URL where the job completion report is located.
A link to an Amazon S3 presigned URL where the job success log is located.
A link to an Amazon S3 presigned URL where the job failure log is located.
The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000 .
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.
The metadata associated with the tax documents required in your Amazon Web Services Region.
The tax documents required in Amazon Web Services Region in India.
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
The container for SnowconeDeviceConfiguration .
Returns information about the device configuration for an Snowcone job.
Configures the wireless connection for the Snowcone device.
Enables the Wi-Fi adapter on an Snowcone device.
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.
The ID of the long-term pricing type for the device.
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
Represents the NFS (Network File System) service on a Snow Family device.
The maximum NFS storage for one Snow Family device.
The scale unit of the NFS storage on the device.
Valid values: TB.
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
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.
The scale unit of the virtual tapes on the device.
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionExamples
This operation describes a job you've created for AWS Snowball.
response = client.describe_job(
JobId='JID123e4567-e89b-12d3-a456-426655440000',
)
print(response)
Expected Output:
{
'JobMetadata': {
'AddressId': 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
'CreationDate': datetime(2016, 10, 5, 0, 9, 24, 2, 279, 0),
'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': False,
},
'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',
},
'ResponseMetadata': {
'...': '...',
},
}
describe_return_shipping_label(**kwargs)¶Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
See also: AWS API Documentation
Request Syntax
response = client.describe_return_shipping_label(
JobId='string'
)
[REQUIRED]
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
{
'Status': 'InProgress'|'TimedOut'|'Succeeded'|'Failed',
'ExpirationDate': datetime(2015, 1, 1),
'ReturnShippingLabelURI': 'string'
}
Response Structure
The status information of the task on a Snow device that is being returned to Amazon Web Services.
The expiration date of the current return shipping label.
The pre-signed Amazon S3 URI used to download the return shipping label.
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionSnowball.Client.exceptions.InvalidJobStateExceptionSnowball.Client.exceptions.ConflictExceptionget_job_manifest(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.get_job_manifest(
JobId='string'
)
[REQUIRED]
The ID for a job that you want to get the manifest file for, for example JID123e4567-e89b-12d3-a456-426655440000 .
{
'ManifestURI': 'string'
}
Response Structure
The Amazon S3 presigned URL for the manifest file associated with the specified JobId value.
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionSnowball.Client.exceptions.InvalidJobStateExceptionExamples
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.
response = client.get_job_manifest( JobId='JID123e4567-e89b-12d3-a456-426655440000', ) print(response)Expected Output:
{ '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=...', 'ResponseMetadata': { '...': '...', }, }
get_job_unlock_code(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.get_job_unlock_code(
JobId='string'
)
[REQUIRED]
The ID for the job that you want to get the UnlockCode value for, for example JID123e4567-e89b-12d3-a456-426655440000 .
{
'UnlockCode': 'string'
}
Response Structure
The UnlockCode value for the specified job. The UnlockCode value can be accessed for up to 360 days after the job has been created.
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionSnowball.Client.exceptions.InvalidJobStateExceptionExamples
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.
response = client.get_job_unlock_code( JobId='JID123e4567-e89b-12d3-a456-426655440000', ) print(response)Expected Output:
{ 'UnlockCode': '12345-abcde-56789-fghij-01234', 'ResponseMetadata': { '...': '...', }, }
get_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_snowball_usage()¶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.
See also: AWS API Documentation
Request Syntax
response = client.get_snowball_usage()
{
'SnowballLimit': 123,
'SnowballsInUse': 123
}
Response Structure
The service limit for number of Snow devices this account can have at once. The default service limit is 1 (one).
The number of Snow devices that this account is currently using.
Examples
Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.
response = client.get_snowball_usage( ) print(response)Expected Output:
{ 'SnowballLimit': 1, 'SnowballsInUse': 0, 'ResponseMetadata': { '...': '...', }, }
get_software_updates(**kwargs)¶Returns an Amazon S3 presigned URL for an update file associated with a specified JobId .
See also: AWS API Documentation
Request Syntax
response = client.get_software_updates(
JobId='string'
)
[REQUIRED]
The ID for a job that you want to get the software update file for, for example JID123e4567-e89b-12d3-a456-426655440000 .
{
'UpdatesURI': 'string'
}
Response Structure
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 to GetSoftwareUpdates .
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionSnowball.Client.exceptions.InvalidJobStateExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_cluster_jobs(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_cluster_jobs(
ClusterId='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000 .
JobListEntry objects to return.JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.dict
Response Syntax
{
'JobListEntries': [
{
'JobId': 'string',
'JobState': 'New'|'PreparingAppliance'|'PreparingShipment'|'InTransitToCustomer'|'WithCustomer'|'InTransitToAWS'|'WithAWSSortingFacility'|'WithAWS'|'InProgress'|'Complete'|'Cancelled'|'Listing'|'Pending',
'IsMaster': True|False,
'JobType': 'IMPORT'|'EXPORT'|'LOCAL_USE',
'SnowballType': 'STANDARD'|'EDGE'|'EDGE_C'|'EDGE_CG'|'EDGE_S'|'SNC1_HDD'|'SNC1_SSD'|'V3_5C',
'CreationDate': datetime(2015, 1, 1),
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
JobListEntries (list) --
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.
(dict) --
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.
JobId (string) --
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
JobState (string) --
The current state of this job.
IsMaster (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.
JobType (string) --
The type of job.
SnowballType (string) --
The type of device used with this job.
CreationDate (datetime) --
The creation date for this job.
Description (string) --
The optional description of this specific job, for example Important Photos 2016-08-11 .
NextToken (string) --
HTTP requests are stateless. If you use the automatically generated NextToken value in your next ListClusterJobsResult call, your list of returned jobs will start from this point in the array.
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionSnowball.Client.exceptions.InvalidNextTokenExceptionExamples
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.
response = client.list_cluster_jobs(
ClusterId='CID123e4567-e89b-12d3-a456-426655440000',
)
print(response)
Expected Output:
{
'JobListEntries': [
{
'CreationDate': datetime(2016, 11, 30, 3, 12, 4, 2, 335, 0),
'Description': 'MyClustrer-node-001',
'IsMaster': False,
'JobId': 'JID123e4567-e89b-12d3-a456-426655440000',
'JobState': 'New',
'JobType': 'LOCAL_USE',
'SnowballType': 'EDGE',
},
{
'CreationDate': datetime(2016, 11, 30, 3, 12, 5, 2, 335, 0),
'Description': 'MyClustrer-node-002',
'IsMaster': False,
'JobId': 'JID123e4567-e89b-12d3-a456-426655440001',
'JobState': 'New',
'JobType': 'LOCAL_USE',
'SnowballType': 'EDGE',
},
{
'CreationDate': datetime(2016, 11, 30, 3, 12, 5, 2, 335, 0),
'Description': 'MyClustrer-node-003',
'IsMaster': False,
'JobId': 'JID123e4567-e89b-12d3-a456-426655440002',
'JobState': 'New',
'JobType': 'LOCAL_USE',
'SnowballType': 'EDGE',
},
{
'CreationDate': datetime(2016, 11, 30, 3, 12, 5, 2, 335, 0),
'Description': 'MyClustrer-node-004',
'IsMaster': False,
'JobId': 'JID123e4567-e89b-12d3-a456-426655440003',
'JobState': 'New',
'JobType': 'LOCAL_USE',
'SnowballType': 'EDGE',
},
{
'CreationDate': datetime(2016, 11, 30, 3, 12, 5, 2, 335, 0),
'Description': 'MyClustrer-node-005',
'IsMaster': False,
'JobId': 'JID123e4567-e89b-12d3-a456-426655440004',
'JobState': 'New',
'JobType': 'LOCAL_USE',
'SnowballType': 'EDGE',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_clusters(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_clusters(
MaxResults=123,
NextToken='string'
)
ClusterListEntry objects to return.ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.dict
Response Syntax
{
'ClusterListEntries': [
{
'ClusterId': 'string',
'ClusterState': 'AwaitingQuorum'|'Pending'|'InUse'|'Complete'|'Cancelled',
'CreationDate': datetime(2015, 1, 1),
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ClusterListEntries (list) --
Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.
(dict) --
Contains a cluster's state, a cluster's ID, and other important information.
ClusterId (string) --
The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000 .
ClusterState (string) --
The current state of this cluster. For information about the state of a specific node, see JobListEntry$JobState.
CreationDate (datetime) --
The creation date for this cluster.
Description (string) --
Defines an optional description of the cluster, for example Environmental Data Cluster-01 .
NextToken (string) --
HTTP requests are stateless. If you use the automatically generated NextToken value in your next ClusterListEntry call, your list of returned clusters will start from this point in the array.
Exceptions
Snowball.Client.exceptions.InvalidNextTokenExceptionExamples
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.
response = client.list_clusters(
)
print(response)
Expected Output:
{
'ClusterListEntries': [
{
'ClusterId': 'CID123e4567-e89b-12d3-a456-426655440000',
'ClusterState': 'Pending',
'CreationDate': datetime(2016, 11, 30, 3, 11, 57, 2, 335, 0),
'Description': 'MyCluster',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_compatible_images(**kwargs)¶This 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 CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the Amazon Web Services Marketplace.
See also: AWS API Documentation
Request Syntax
response = client.list_compatible_images(
MaxResults=123,
NextToken='string'
)
NextToken as the starting point for your list of returned images.dict
Response Syntax
{
'CompatibleImages': [
{
'AmiId': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CompatibleImages (list) --
A JSON-formatted object that describes a compatible AMI, including the ID and name for a Snow device AMI.
(dict) --
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.
AmiId (string) --
The unique identifier for an individual Snow device AMI.
Name (string) --
The optional name of a compatible image.
NextToken (string) --
Because HTTP requests are stateless, this is the starting point for your next list of returned images.
Exceptions
Snowball.Client.exceptions.InvalidNextTokenExceptionSnowball.Client.exceptions.Ec2RequestFailedExceptionlist_jobs(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_jobs(
MaxResults=123,
NextToken='string'
)
JobListEntry objects to return.JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.dict
Response Syntax
{
'JobListEntries': [
{
'JobId': 'string',
'JobState': 'New'|'PreparingAppliance'|'PreparingShipment'|'InTransitToCustomer'|'WithCustomer'|'InTransitToAWS'|'WithAWSSortingFacility'|'WithAWS'|'InProgress'|'Complete'|'Cancelled'|'Listing'|'Pending',
'IsMaster': True|False,
'JobType': 'IMPORT'|'EXPORT'|'LOCAL_USE',
'SnowballType': 'STANDARD'|'EDGE'|'EDGE_C'|'EDGE_CG'|'EDGE_S'|'SNC1_HDD'|'SNC1_SSD'|'V3_5C',
'CreationDate': datetime(2015, 1, 1),
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
JobListEntries (list) --
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.
(dict) --
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.
JobId (string) --
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
JobState (string) --
The current state of this job.
IsMaster (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.
JobType (string) --
The type of job.
SnowballType (string) --
The type of device used with this job.
CreationDate (datetime) --
The creation date for this job.
Description (string) --
The optional description of this specific job, for example Important Photos 2016-08-11 .
NextToken (string) --
HTTP requests are stateless. If you use this automatically generated NextToken value in your next ListJobs call, your returned JobListEntry objects will start from this point in the array.
Exceptions
Snowball.Client.exceptions.InvalidNextTokenExceptionExamples
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.
response = client.list_jobs(
)
print(response)
Expected Output:
{
'JobListEntries': [
{
'CreationDate': datetime(2016, 4, 14, 23, 56, 26, 3, 105, 0),
'Description': 'MyJob',
'IsMaster': False,
'JobId': 'JID123e4567-e89b-12d3-a456-426655440000',
'JobState': 'New',
'JobType': 'IMPORT',
'SnowballType': 'STANDARD',
},
],
'ResponseMetadata': {
'...': '...',
},
}
list_long_term_pricing(**kwargs)¶Lists all long-term pricing types.
See also: AWS API Documentation
Request Syntax
response = client.list_long_term_pricing(
MaxResults=123,
NextToken='string'
)
ListLongTermPricing objects to return.ListLongTermPricing to return.dict
Response Syntax
{
'LongTermPricingEntries': [
{
'LongTermPricingId': 'string',
'LongTermPricingEndDate': datetime(2015, 1, 1),
'LongTermPricingStartDate': datetime(2015, 1, 1),
'LongTermPricingType': 'OneYear'|'ThreeYear',
'CurrentActiveJob': 'string',
'ReplacementJob': 'string',
'IsLongTermPricingAutoRenew': True|False,
'LongTermPricingStatus': 'string',
'SnowballType': 'STANDARD'|'EDGE'|'EDGE_C'|'EDGE_CG'|'EDGE_S'|'SNC1_HDD'|'SNC1_SSD'|'V3_5C',
'JobIds': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LongTermPricingEntries (list) --
Each LongTermPricingEntry object contains a status, ID, and other information about the LongTermPricing type.
(dict) --
Each LongTermPricingListEntry object contains information about a long-term pricing type.
LongTermPricingId (string) --
The ID of the long-term pricing type for the device.
LongTermPricingEndDate (datetime) --
The end date the long-term pricing contract.
LongTermPricingStartDate (datetime) --
The start date of the long-term pricing contract.
LongTermPricingType (string) --
The type of long-term pricing that was selected for the device.
CurrentActiveJob (string) --
The current active jobs on the device the long-term pricing type.
ReplacementJob (string) --
A new device that replaces a device that is ordered with long-term pricing.
IsLongTermPricingAutoRenew (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.
LongTermPricingStatus (string) --
The status of the long-term pricing type.
SnowballType (string) --
The type of Snow Family devices associated with this long-term pricing job.
JobIds (list) --
The IDs of the jobs that are associated with a long-term pricing type.
NextToken (string) --
Because HTTP requests are stateless, this is the starting point for your next list of returned ListLongTermPricing list.
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionSnowball.Client.exceptions.InvalidNextTokenExceptionupdate_cluster(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.update_cluster(
ClusterId='string',
RoleARN='string',
Description='string',
Resources={
'S3Resources': [
{
'BucketArn': 'string',
'KeyRange': {
'BeginMarker': 'string',
'EndMarker': 'string'
},
'TargetOnDeviceServices': [
{
'ServiceName': 'NFS_ON_DEVICE_SERVICE'|'S3_ON_DEVICE_SERVICE',
'TransferOption': 'IMPORT'|'EXPORT'|'LOCAL_USE'
},
]
},
],
'LambdaResources': [
{
'LambdaArn': 'string',
'EventTriggers': [
{
'EventResourceARN': 'string'
},
]
},
],
'Ec2AmiResources': [
{
'AmiId': 'string',
'SnowballAmiId': 'string'
},
]
},
OnDeviceServiceConfiguration={
'NFSOnDeviceService': {
'StorageLimit': 123,
'StorageUnit': 'TB'
},
'TGWOnDeviceService': {
'StorageLimit': 123,
'StorageUnit': 'TB'
}
},
AddressId='string',
ShippingOption='SECOND_DAY'|'NEXT_DAY'|'EXPRESS'|'STANDARD',
Notification={
'SnsTopicARN': 'string',
'JobStatesToNotify': [
'New'|'PreparingAppliance'|'PreparingShipment'|'InTransitToCustomer'|'WithCustomer'|'InTransitToAWS'|'WithAWSSortingFacility'|'WithAWS'|'InProgress'|'Complete'|'Cancelled'|'Listing'|'Pending',
],
'NotifyAll': True|False
},
ForwardingAddressId='string'
)
[REQUIRED]
The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000 .
The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
An array of S3Resource objects.
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.
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
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 inclusive BeginMarker , an inclusive EndMarker , or both. Ranges are UTF-8 binary sorted.
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
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).
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).
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
The Python-language Lambda functions for this job.
Identifies
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
The container for the EventTriggerDefinition$EventResourceARN.
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
The Amazon Machine Images (AMIs) associated with this job.
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 Amazon Web Services Cloud and on the device.
The ID of the AMI in Amazon EC2.
The ID of the AMI on the Snow device.
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).
Represents the NFS (Network File System) service on a Snow Family device.
The maximum NFS storage for one Snow Family device.
The scale unit of the NFS storage on the device.
Valid values: TB.
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
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.
The scale unit of the virtual tapes on the device.
The new or updated Notification object.
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.
The list of job states that will trigger a notification for this job.
Any change in job state will trigger a notification for this job.
dict
Response Syntax
{}
Response Structure
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionSnowball.Client.exceptions.InvalidJobStateExceptionSnowball.Client.exceptions.KMSRequestFailedExceptionSnowball.Client.exceptions.InvalidInputCombinationExceptionSnowball.Client.exceptions.Ec2RequestFailedExceptionExamples
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.
response = client.update_cluster(
AddressId='ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
ClusterId='CID123e4567-e89b-12d3-a456-426655440000',
Description='updated-cluster-name',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
update_job(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.update_job(
JobId='string',
RoleARN='string',
Notification={
'SnsTopicARN': 'string',
'JobStatesToNotify': [
'New'|'PreparingAppliance'|'PreparingShipment'|'InTransitToCustomer'|'WithCustomer'|'InTransitToAWS'|'WithAWSSortingFacility'|'WithAWS'|'InProgress'|'Complete'|'Cancelled'|'Listing'|'Pending',
],
'NotifyAll': True|False
},
Resources={
'S3Resources': [
{
'BucketArn': 'string',
'KeyRange': {
'BeginMarker': 'string',
'EndMarker': 'string'
},
'TargetOnDeviceServices': [
{
'ServiceName': 'NFS_ON_DEVICE_SERVICE'|'S3_ON_DEVICE_SERVICE',
'TransferOption': 'IMPORT'|'EXPORT'|'LOCAL_USE'
},
]
},
],
'LambdaResources': [
{
'LambdaArn': 'string',
'EventTriggers': [
{
'EventResourceARN': 'string'
},
]
},
],
'Ec2AmiResources': [
{
'AmiId': 'string',
'SnowballAmiId': 'string'
},
]
},
OnDeviceServiceConfiguration={
'NFSOnDeviceService': {
'StorageLimit': 123,
'StorageUnit': 'TB'
},
'TGWOnDeviceService': {
'StorageLimit': 123,
'StorageUnit': 'TB'
}
},
AddressId='string',
ShippingOption='SECOND_DAY'|'NEXT_DAY'|'EXPRESS'|'STANDARD',
Description='string',
SnowballCapacityPreference='T50'|'T80'|'T100'|'T42'|'T98'|'T8'|'T14'|'NoPreference'|'T32',
ForwardingAddressId='string'
)
[REQUIRED]
The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000 .
The new or updated Notification object.
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.
The list of job states that will trigger a notification for this job.
Any change in job state will trigger a notification for this job.
The updated JobResource object, or the updated JobResource object.
An array of S3Resource objects.
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.
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
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 inclusive BeginMarker , an inclusive EndMarker , or both. Ranges are UTF-8 binary sorted.
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
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).
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).
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
The Python-language Lambda functions for this job.
Identifies
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
The container for the EventTriggerDefinition$EventResourceARN.
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
The Amazon Machine Images (AMIs) associated with this job.
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 Amazon Web Services Cloud and on the device.
The ID of the AMI in Amazon EC2.
The ID of the AMI on the Snow device.
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.
Represents the NFS (Network File System) service on a Snow Family device.
The maximum NFS storage for one Snow Family device.
The scale unit of the NFS storage on the device.
Valid values: TB.
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
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.
The scale unit of the virtual tapes on the device.
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 .
dict
Response Syntax
{}
Response Structure
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionSnowball.Client.exceptions.InvalidJobStateExceptionSnowball.Client.exceptions.KMSRequestFailedExceptionSnowball.Client.exceptions.InvalidInputCombinationExceptionSnowball.Client.exceptions.ClusterLimitExceededExceptionSnowball.Client.exceptions.Ec2RequestFailedExceptionExamples
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.
response = client.update_job(
AddressId='ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
Description='updated-job-name',
JobId='JID123e4567-e89b-12d3-a456-426655440000',
ShippingOption='NEXT_DAY',
SnowballCapacityPreference='T100',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
update_job_shipment_state(**kwargs)¶Updates the state when a shipment state changes to a different state.
See also: AWS API Documentation
Request Syntax
response = client.update_job_shipment_state(
JobId='string',
ShipmentState='RECEIVED'|'RETURNED'
)
[REQUIRED]
The job ID of the job whose shipment date you want to update, for example JID123e4567-e89b-12d3-a456-426655440000 .
[REQUIRED]
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.
dict
Response Syntax
{}
Response Structure
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionSnowball.Client.exceptions.InvalidJobStateExceptionupdate_long_term_pricing(**kwargs)¶Updates the long-term pricing type.
See also: AWS API Documentation
Request Syntax
response = client.update_long_term_pricing(
LongTermPricingId='string',
ReplacementJob='string',
IsLongTermPricingAutoRenew=True|False
)
[REQUIRED]
The ID of the long-term pricing type for the device.
true , specifies that the current long-term pricing type for the device should be automatically renewed before the long-term pricing contract expires.dict
Response Syntax
{}
Response Structure
Exceptions
Snowball.Client.exceptions.InvalidResourceExceptionThe available paginators are:
Snowball.Paginator.DescribeAddressesSnowball.Paginator.ListClusterJobsSnowball.Paginator.ListClustersSnowball.Paginator.ListCompatibleImagesSnowball.Paginator.ListJobsSnowball.Paginator.ListLongTermPricingSnowball.Paginator.DescribeAddresses¶paginator = client.get_paginator('describe_addresses')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Snowball.Client.describe_addresses().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Addresses': [
{
'AddressId': 'string',
'Name': 'string',
'Company': 'string',
'Street1': 'string',
'Street2': 'string',
'Street3': 'string',
'City': 'string',
'StateOrProvince': 'string',
'PrefectureOrDistrict': 'string',
'Landmark': 'string',
'Country': 'string',
'PostalCode': 'string',
'PhoneNumber': 'string',
'IsRestricted': True|False
},
],
}
Response Structure
The Snow device shipping addresses that were created for this account.
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.
The unique ID for an address.
The name of a person to receive a Snow device at an address.
The name of the company to receive a Snow device at an address.
The first line in a street address that a Snow device is to be delivered to.
The second line in a street address that a Snow device is to be delivered to.
The third line in a street address that a Snow device is to be delivered to.
The city in an address that a Snow device is to be delivered to.
The state or province in an address that a Snow device is to be delivered to.
This field is no longer used and the value is ignored.
This field is no longer used and the value is ignored.
The country in an address that a Snow device is to be delivered to.
The postal code in an address that a Snow device is to be delivered to.
The phone number associated with an address that a Snow device is to be delivered to.
If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.
Snowball.Paginator.ListClusterJobs¶paginator = client.get_paginator('list_cluster_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Snowball.Client.list_cluster_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ClusterId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000 .
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'JobListEntries': [
{
'JobId': 'string',
'JobState': 'New'|'PreparingAppliance'|'PreparingShipment'|'InTransitToCustomer'|'WithCustomer'|'InTransitToAWS'|'WithAWSSortingFacility'|'WithAWS'|'InProgress'|'Complete'|'Cancelled'|'Listing'|'Pending',
'IsMaster': True|False,
'JobType': 'IMPORT'|'EXPORT'|'LOCAL_USE',
'SnowballType': 'STANDARD'|'EDGE'|'EDGE_C'|'EDGE_CG'|'EDGE_S'|'SNC1_HDD'|'SNC1_SSD'|'V3_5C',
'CreationDate': datetime(2015, 1, 1),
'Description': 'string'
},
],
}
Response Structure
(dict) --
JobListEntries (list) --
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.
(dict) --
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.
JobId (string) --
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
JobState (string) --
The current state of this job.
IsMaster (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.
JobType (string) --
The type of job.
SnowballType (string) --
The type of device used with this job.
CreationDate (datetime) --
The creation date for this job.
Description (string) --
The optional description of this specific job, for example Important Photos 2016-08-11 .
Snowball.Paginator.ListClusters¶paginator = client.get_paginator('list_clusters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Snowball.Client.list_clusters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'ClusterListEntries': [
{
'ClusterId': 'string',
'ClusterState': 'AwaitingQuorum'|'Pending'|'InUse'|'Complete'|'Cancelled',
'CreationDate': datetime(2015, 1, 1),
'Description': 'string'
},
],
}
Response Structure
Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.
Contains a cluster's state, a cluster's ID, and other important information.
The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000 .
The current state of this cluster. For information about the state of a specific node, see JobListEntry$JobState.
The creation date for this cluster.
Defines an optional description of the cluster, for example Environmental Data Cluster-01 .
Snowball.Paginator.ListCompatibleImages¶paginator = client.get_paginator('list_compatible_images')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Snowball.Client.list_compatible_images().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'CompatibleImages': [
{
'AmiId': 'string',
'Name': 'string'
},
],
}
Response Structure
A JSON-formatted object that describes a compatible AMI, including the ID and name for a Snow device AMI.
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.
The unique identifier for an individual Snow device AMI.
The optional name of a compatible image.
Snowball.Paginator.ListJobs¶paginator = client.get_paginator('list_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Snowball.Client.list_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'JobListEntries': [
{
'JobId': 'string',
'JobState': 'New'|'PreparingAppliance'|'PreparingShipment'|'InTransitToCustomer'|'WithCustomer'|'InTransitToAWS'|'WithAWSSortingFacility'|'WithAWS'|'InProgress'|'Complete'|'Cancelled'|'Listing'|'Pending',
'IsMaster': True|False,
'JobType': 'IMPORT'|'EXPORT'|'LOCAL_USE',
'SnowballType': 'STANDARD'|'EDGE'|'EDGE_C'|'EDGE_CG'|'EDGE_S'|'SNC1_HDD'|'SNC1_SSD'|'V3_5C',
'CreationDate': datetime(2015, 1, 1),
'Description': 'string'
},
],
}
Response Structure
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.
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.
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
The current state of this job.
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.
The type of job.
The type of device used with this job.
The creation date for this job.
The optional description of this specific job, for example Important Photos 2016-08-11 .
Snowball.Paginator.ListLongTermPricing¶paginator = client.get_paginator('list_long_term_pricing')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Snowball.Client.list_long_term_pricing().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'LongTermPricingEntries': [
{
'LongTermPricingId': 'string',
'LongTermPricingEndDate': datetime(2015, 1, 1),
'LongTermPricingStartDate': datetime(2015, 1, 1),
'LongTermPricingType': 'OneYear'|'ThreeYear',
'CurrentActiveJob': 'string',
'ReplacementJob': 'string',
'IsLongTermPricingAutoRenew': True|False,
'LongTermPricingStatus': 'string',
'SnowballType': 'STANDARD'|'EDGE'|'EDGE_C'|'EDGE_CG'|'EDGE_S'|'SNC1_HDD'|'SNC1_SSD'|'V3_5C',
'JobIds': [
'string',
]
},
],
}
Response Structure
Each LongTermPricingEntry object contains a status, ID, and other information about the LongTermPricing type.
Each LongTermPricingListEntry object contains information about a long-term pricing type.
The ID of the long-term pricing type for the device.
The end date the long-term pricing contract.
The start date of the long-term pricing contract.
The type of long-term pricing that was selected for the device.
The current active jobs on the device the long-term pricing type.
A new device that replaces a device that is ordered with long-term pricing.
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.
The status of the long-term pricing type.
The type of Snow Family devices associated with this long-term pricing job.
The IDs of the jobs that are associated with a long-term pricing type.