2021/11/30 - Amazon Import/Export Snowball - 7 updated api methods
Changes Tapeball is to integrate tape gateway onto snowball, it enables customer to transfer local data on the tape to snowball,and then ingest the data into tape gateway on the cloud.
{'OnDeviceServiceConfiguration': {'TGWOnDeviceService': {'StorageLimit': 'integer',
'StorageUnit': 'TB'}}}
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
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',
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'
)
string
[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 .
dict
[REQUIRED]
The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.
S3Resources (list) --
An array of S3Resource objects.
(dict) --
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.
BucketArn (string) --
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
KeyRange (dict) --
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.
BeginMarker (string) --
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
EndMarker (string) --
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
TargetOnDeviceServices (list) --
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).
(dict) --
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).
ServiceName (string) --
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
TransferOption (string) --
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
LambdaResources (list) --
The Python-language Lambda functions for this job.
(dict) --
Identifies
LambdaArn (string) --
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
EventTriggers (list) --
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
(dict) --
The container for the EventTriggerDefinition$EventResourceARN .
EventResourceARN (string) --
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
Ec2AmiResources (list) --
The Amazon Machine Images (AMIs) associated with this job.
(dict) --
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.
AmiId (string) -- [REQUIRED]
The ID of the AMI in Amazon EC2.
SnowballAmiId (string) --
The ID of the AMI on the Snow device.
dict
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).
NFSOnDeviceService (dict) --
Represents the NFS (Network File System) service on a Snow Family device.
StorageLimit (integer) --
The maximum NFS storage for one Snow Family device.
StorageUnit (string) --
The scale unit of the NFS storage on the device.
Valid values: TB.
TGWOnDeviceService (dict) --
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
StorageLimit (integer) --
The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.
StorageUnit (string) --
The scale unit of the virtual tapes on the device.
string
An optional description of this specific cluster, for example Environmental Data Cluster-01 .
string
[REQUIRED]
The ID for the address that you want the cluster shipped to.
string
The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in Key Management Service (KMS).
string
[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).
string
[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 .
string
[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:
In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
In India, Snow devices are delivered in one to seven days.
In the United States of America (US), you have access to one-day shipping and two-day shipping.
In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
In India, Snow devices are delivered in one to seven days.
In the US, you have access to one-day shipping and two-day shipping.
dict
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
SnsTopicARN (string) --
The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
JobStatesToNotify (list) --
The list of job states that will trigger a notification for this job.
(string) --
NotifyAll (boolean) --
Any change in job state will trigger a notification for this job.
string
The forwarding address ID for a cluster. This field is not supported in most regions.
dict
The tax documents required in your Amazon Web Services Region.
IND (dict) --
The tax documents required in Amazon Web Services Region in India.
GSTIN (string) --
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
string
Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to INSTALLED_AUTOSTART , remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.
dict
Response Syntax
{
'ClusterId': 'string'
}
Response Structure
(dict) --
ClusterId (string) --
The automatically generated ID for a cluster.
{'OnDeviceServiceConfiguration': {'TGWOnDeviceService': {'StorageLimit': 'integer',
'StorageUnit': 'TB'}}}
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
Capacity: T14
Description: Snowcone
Snow Family device type: SNC1_HDD
Capacity: T8
Description: Snowcone
Device type: EDGE_S
Capacity: T98
Description: Snowball Edge Storage Optimized for data transfer only
Device type: EDGE_CG
Capacity: T42
Description: Snowball Edge Compute Optimized with GPU
Device type: EDGE_C
Capacity: T42
Description: Snowball Edge Compute Optimized without GPU
Device type: EDGE
Capacity: T100
Description: Snowball Edge Storage Optimized with EC2 Compute
Device type: STANDARD
Capacity: T50
Description: Original Snowball device
Note
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region
Device type: STANDARD
Capacity: T80
Description: Original Snowball device
Note
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
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',
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',
ForwardingAddressId='string',
TaxDocuments={
'IND': {
'GSTIN': 'string'
}
},
DeviceConfiguration={
'SnowconeDeviceConfiguration': {
'WirelessConnection': {
'IsWifiEnabled': True|False
}
}
},
RemoteManagement='INSTALLED_ONLY'|'INSTALLED_AUTOSTART',
LongTermPricingId='string'
)
string
Defines the type of job that you're creating.
dict
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.
S3Resources (list) --
An array of S3Resource objects.
(dict) --
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.
BucketArn (string) --
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
KeyRange (dict) --
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.
BeginMarker (string) --
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
EndMarker (string) --
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
TargetOnDeviceServices (list) --
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).
(dict) --
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).
ServiceName (string) --
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
TransferOption (string) --
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
LambdaResources (list) --
The Python-language Lambda functions for this job.
(dict) --
Identifies
LambdaArn (string) --
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
EventTriggers (list) --
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
(dict) --
The container for the EventTriggerDefinition$EventResourceARN .
EventResourceARN (string) --
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
Ec2AmiResources (list) --
The Amazon Machine Images (AMIs) associated with this job.
(dict) --
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.
AmiId (string) -- [REQUIRED]
The ID of the AMI in Amazon EC2.
SnowballAmiId (string) --
The ID of the AMI on the Snow device.
dict
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.
NFSOnDeviceService (dict) --
Represents the NFS (Network File System) service on a Snow Family device.
StorageLimit (integer) --
The maximum NFS storage for one Snow Family device.
StorageUnit (string) --
The scale unit of the NFS storage on the device.
Valid values: TB.
TGWOnDeviceService (dict) --
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
StorageLimit (integer) --
The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.
StorageUnit (string) --
The scale unit of the virtual tapes on the device.
string
Defines an optional description of this specific job, for example Important Photos 2016-08-11 .
string
The ID for the address that you want the Snow device shipped to.
string
The KmsKeyARN that you want to associate with this job. KmsKeyARN s are created using the CreateKey Key Management Service (KMS) API action.
string
The RoleARN that you want to associate with this job. RoleArn s are created using the CreateRole Identity and Access Management (IAM) API action.
string
If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide .
string
The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:
In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
In India, Snow devices are delivered in one to seven days.
In the US, you have access to one-day shipping and two-day shipping.
dict
Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
SnsTopicARN (string) --
The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
JobStatesToNotify (list) --
The list of job states that will trigger a notification for this job.
(string) --
NotifyAll (boolean) --
Any change in job state will trigger a notification for this job.
string
The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.
string
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 .
string
The forwarding address ID for a job. This field is not supported in most Regions.
dict
The tax documents required in your Amazon Web Services Region.
IND (dict) --
The tax documents required in Amazon Web Services Region in India.
GSTIN (string) --
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
dict
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 .
SnowconeDeviceConfiguration (dict) --
Returns information about the device configuration for an Snowcone job.
WirelessConnection (dict) --
Configures the wireless connection for the Snowcone device.
IsWifiEnabled (boolean) --
Enables the Wi-Fi adapter on an Snowcone device.
string
Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART , remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.
string
The ID of the long-term pricing type for 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 .
{'ClusterMetadata': {'OnDeviceServiceConfiguration': {'TGWOnDeviceService': {'StorageLimit': 'integer',
'StorageUnit': 'TB'}}}}
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
See also: AWS API Documentation
Request Syntax
client.describe_cluster(
ClusterId='string'
)
string
[REQUIRED]
The automatically generated ID for a cluster.
dict
Response Syntax
{
'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',
'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
(dict) --
ClusterMetadata (dict) --
Information about a specific cluster, including shipping information, cluster status, and other important metadata.
ClusterId (string) --
The automatically generated ID for a cluster.
Description (string) --
The optional description of the cluster.
KmsKeyARN (string) --
The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in Key Management Service (KMS.
RoleARN (string) --
The role ARN associated with this cluster. This ARN was created using the CreateRole API action in Identity and Access Management (IAM).
ClusterState (string) --
The current status of the cluster.
JobType (string) --
The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE .
SnowballType (string) --
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.
CreationDate (datetime) --
The creation date for this cluster.
Resources (dict) --
The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
S3Resources (list) --
An array of S3Resource objects.
(dict) --
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.
BucketArn (string) --
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
KeyRange (dict) --
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.
BeginMarker (string) --
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
EndMarker (string) --
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
TargetOnDeviceServices (list) --
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).
(dict) --
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).
ServiceName (string) --
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
TransferOption (string) --
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
LambdaResources (list) --
The Python-language Lambda functions for this job.
(dict) --
Identifies
LambdaArn (string) --
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
EventTriggers (list) --
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
(dict) --
The container for the EventTriggerDefinition$EventResourceARN .
EventResourceARN (string) --
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
Ec2AmiResources (list) --
The Amazon Machine Images (AMIs) associated with this job.
(dict) --
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.
AmiId (string) --
The ID of the AMI in Amazon EC2.
SnowballAmiId (string) --
The ID of the AMI on the Snow device.
AddressId (string) --
The automatically generated ID for a specific address.
ShippingOption (string) --
The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:
In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
In India, Snow devices are delivered in one to seven days.
In the US, you have access to one-day shipping and two-day shipping.
Notification (dict) --
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
SnsTopicARN (string) --
The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
JobStatesToNotify (list) --
The list of job states that will trigger a notification for this job.
(string) --
NotifyAll (boolean) --
Any change in job state will trigger a notification for this job.
ForwardingAddressId (string) --
The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.
TaxDocuments (dict) --
The tax documents required in your Amazon Web Services Region.
IND (dict) --
The tax documents required in Amazon Web Services Region in India.
GSTIN (string) --
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
OnDeviceServiceConfiguration (dict) --
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
NFSOnDeviceService (dict) --
Represents the NFS (Network File System) service on a Snow Family device.
StorageLimit (integer) --
The maximum NFS storage for one Snow Family device.
StorageUnit (string) --
The scale unit of the NFS storage on the device.
Valid values: TB.
TGWOnDeviceService (dict) --
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
StorageLimit (integer) --
The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.
StorageUnit (string) --
The scale unit of the virtual tapes on the device.
{'JobMetadata': {'OnDeviceServiceConfiguration': {'TGWOnDeviceService': {'StorageLimit': 'integer',
'StorageUnit': 'TB'}}},
'SubJobMetadata': {'OnDeviceServiceConfiguration': {'TGWOnDeviceService': {'StorageLimit': 'integer',
'StorageUnit': 'TB'}}}}
Returns information about a specific job including shipping information, job status, and other important metadata.
See also: AWS API Documentation
Request Syntax
client.describe_job(
JobId='string'
)
string
[REQUIRED]
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
dict
Response Syntax
{
'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',
'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',
'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',
'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',
'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
(dict) --
JobMetadata (dict) --
Information about a specific job, including shipping information, job status, and other important metadata.
JobId (string) --
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
JobState (string) --
The current status of the jobs.
JobType (string) --
The type of job.
SnowballType (string) --
The type of device used with this job.
CreationDate (datetime) --
The creation date for this job.
Resources (dict) --
An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.
S3Resources (list) --
An array of S3Resource objects.
(dict) --
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.
BucketArn (string) --
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
KeyRange (dict) --
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.
BeginMarker (string) --
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
EndMarker (string) --
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
TargetOnDeviceServices (list) --
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).
(dict) --
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).
ServiceName (string) --
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
TransferOption (string) --
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
LambdaResources (list) --
The Python-language Lambda functions for this job.
(dict) --
Identifies
LambdaArn (string) --
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
EventTriggers (list) --
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
(dict) --
The container for the EventTriggerDefinition$EventResourceARN .
EventResourceARN (string) --
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
Ec2AmiResources (list) --
The Amazon Machine Images (AMIs) associated with this job.
(dict) --
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.
AmiId (string) --
The ID of the AMI in Amazon EC2.
SnowballAmiId (string) --
The ID of the AMI on the Snow device.
Description (string) --
The description of the job, provided at job creation.
KmsKeyARN (string) --
The Amazon Resource Name (ARN) for the Key Management Service (KMS) key associated with this job. This ARN was created using the CreateKey API action in KMS.
RoleARN (string) --
The role ARN associated with this job. This ARN was created using the CreateRole API action in Identity and Access Management.
AddressId (string) --
The ID for the address that you want the Snow device shipped to.
ShippingDetails (dict) --
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
ShippingOption (string) --
The shipping speed for a particular job. This speed doesn't dictate how soon you'll get the Snow device from the job's creation date. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:
In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
In India, Snow devices are delivered in one to seven days.
In the United States of America (US), you have access to one-day shipping and two-day shipping.
InboundShipment (dict) --
The Status and TrackingNumber values for a Snow device being returned to Amazon Web Services for a particular job.
Status (string) --
Status information for a shipment.
TrackingNumber (string) --
The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snow device as the carrier transports it.
For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.
OutboundShipment (dict) --
The Status and TrackingNumber values for a Snow device being delivered to the address that you specified for a particular job.
Status (string) --
Status information for a shipment.
TrackingNumber (string) --
The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snow device as the carrier transports it.
For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.
SnowballCapacityPreference (string) --
The Snow device capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide .
Notification (dict) --
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.
SnsTopicARN (string) --
The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
JobStatesToNotify (list) --
The list of job states that will trigger a notification for this job.
(string) --
NotifyAll (boolean) --
Any change in job state will trigger a notification for this job.
DataTransferProgress (dict) --
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.
BytesTransferred (integer) --
The number of bytes transferred between a Snow device and Amazon S3.
ObjectsTransferred (integer) --
The number of objects transferred between a Snow device and Amazon S3.
TotalBytes (integer) --
The total bytes of data for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.
TotalObjects (integer) --
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.
JobLogInfo (dict) --
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.
JobCompletionReportURI (string) --
A link to an Amazon S3 presigned URL where the job completion report is located.
JobSuccessLogURI (string) --
A link to an Amazon S3 presigned URL where the job success log is located.
JobFailureLogURI (string) --
A link to an Amazon S3 presigned URL where the job failure log is located.
ClusterId (string) --
The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000 .
ForwardingAddressId (string) --
The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.
TaxDocuments (dict) --
The metadata associated with the tax documents required in your Amazon Web Services Region.
IND (dict) --
The tax documents required in Amazon Web Services Region in India.
GSTIN (string) --
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
DeviceConfiguration (dict) --
The container for SnowconeDeviceConfiguration .
SnowconeDeviceConfiguration (dict) --
Returns information about the device configuration for an Snowcone job.
WirelessConnection (dict) --
Configures the wireless connection for the Snowcone device.
IsWifiEnabled (boolean) --
Enables the Wi-Fi adapter on an Snowcone device.
RemoteManagement (string) --
Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART , remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.
LongTermPricingId (string) --
The ID of the long-term pricing type for the device.
OnDeviceServiceConfiguration (dict) --
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
NFSOnDeviceService (dict) --
Represents the NFS (Network File System) service on a Snow Family device.
StorageLimit (integer) --
The maximum NFS storage for one Snow Family device.
StorageUnit (string) --
The scale unit of the NFS storage on the device.
Valid values: TB.
TGWOnDeviceService (dict) --
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
StorageLimit (integer) --
The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.
StorageUnit (string) --
The scale unit of the virtual tapes on the device.
SubJobMetadata (list) --
Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.
(dict) --
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.
JobId (string) --
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
JobState (string) --
The current status of the jobs.
JobType (string) --
The type of job.
SnowballType (string) --
The type of device used with this job.
CreationDate (datetime) --
The creation date for this job.
Resources (dict) --
An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.
S3Resources (list) --
An array of S3Resource objects.
(dict) --
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.
BucketArn (string) --
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
KeyRange (dict) --
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.
BeginMarker (string) --
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
EndMarker (string) --
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
TargetOnDeviceServices (list) --
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).
(dict) --
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).
ServiceName (string) --
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
TransferOption (string) --
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
LambdaResources (list) --
The Python-language Lambda functions for this job.
(dict) --
Identifies
LambdaArn (string) --
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
EventTriggers (list) --
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
(dict) --
The container for the EventTriggerDefinition$EventResourceARN .
EventResourceARN (string) --
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
Ec2AmiResources (list) --
The Amazon Machine Images (AMIs) associated with this job.
(dict) --
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.
AmiId (string) --
The ID of the AMI in Amazon EC2.
SnowballAmiId (string) --
The ID of the AMI on the Snow device.
Description (string) --
The description of the job, provided at job creation.
KmsKeyARN (string) --
The Amazon Resource Name (ARN) for the Key Management Service (KMS) key associated with this job. This ARN was created using the CreateKey API action in KMS.
RoleARN (string) --
The role ARN associated with this job. This ARN was created using the CreateRole API action in Identity and Access Management.
AddressId (string) --
The ID for the address that you want the Snow device shipped to.
ShippingDetails (dict) --
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
ShippingOption (string) --
The shipping speed for a particular job. This speed doesn't dictate how soon you'll get the Snow device from the job's creation date. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:
In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
In India, Snow devices are delivered in one to seven days.
In the United States of America (US), you have access to one-day shipping and two-day shipping.
InboundShipment (dict) --
The Status and TrackingNumber values for a Snow device being returned to Amazon Web Services for a particular job.
Status (string) --
Status information for a shipment.
TrackingNumber (string) --
The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snow device as the carrier transports it.
For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.
OutboundShipment (dict) --
The Status and TrackingNumber values for a Snow device being delivered to the address that you specified for a particular job.
Status (string) --
Status information for a shipment.
TrackingNumber (string) --
The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snow device as the carrier transports it.
For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.
SnowballCapacityPreference (string) --
The Snow device capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide .
Notification (dict) --
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.
SnsTopicARN (string) --
The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
JobStatesToNotify (list) --
The list of job states that will trigger a notification for this job.
(string) --
NotifyAll (boolean) --
Any change in job state will trigger a notification for this job.
DataTransferProgress (dict) --
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.
BytesTransferred (integer) --
The number of bytes transferred between a Snow device and Amazon S3.
ObjectsTransferred (integer) --
The number of objects transferred between a Snow device and Amazon S3.
TotalBytes (integer) --
The total bytes of data for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.
TotalObjects (integer) --
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.
JobLogInfo (dict) --
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.
JobCompletionReportURI (string) --
A link to an Amazon S3 presigned URL where the job completion report is located.
JobSuccessLogURI (string) --
A link to an Amazon S3 presigned URL where the job success log is located.
JobFailureLogURI (string) --
A link to an Amazon S3 presigned URL where the job failure log is located.
ClusterId (string) --
The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000 .
ForwardingAddressId (string) --
The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.
TaxDocuments (dict) --
The metadata associated with the tax documents required in your Amazon Web Services Region.
IND (dict) --
The tax documents required in Amazon Web Services Region in India.
GSTIN (string) --
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
DeviceConfiguration (dict) --
The container for SnowconeDeviceConfiguration .
SnowconeDeviceConfiguration (dict) --
Returns information about the device configuration for an Snowcone job.
WirelessConnection (dict) --
Configures the wireless connection for the Snowcone device.
IsWifiEnabled (boolean) --
Enables the Wi-Fi adapter on an Snowcone device.
RemoteManagement (string) --
Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART , remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.
LongTermPricingId (string) --
The ID of the long-term pricing type for the device.
OnDeviceServiceConfiguration (dict) --
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
NFSOnDeviceService (dict) --
Represents the NFS (Network File System) service on a Snow Family device.
StorageLimit (integer) --
The maximum NFS storage for one Snow Family device.
StorageUnit (string) --
The scale unit of the NFS storage on the device.
Valid values: TB.
TGWOnDeviceService (dict) --
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
StorageLimit (integer) --
The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.
StorageUnit (string) --
The scale unit of the virtual tapes on the device.
{'ReturnShippingLabelURI': 'string'}
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
See also: AWS API Documentation
Request Syntax
client.describe_return_shipping_label(
JobId='string'
)
string
[REQUIRED]
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
dict
Response Syntax
{
'Status': 'InProgress'|'TimedOut'|'Succeeded'|'Failed',
'ExpirationDate': datetime(2015, 1, 1),
'ReturnShippingLabelURI': 'string'
}
Response Structure
(dict) --
Status (string) --
The status information of the task on a Snow device that is being returned to Amazon Web Services.
ExpirationDate (datetime) --
The expiration date of the current return shipping label.
ReturnShippingLabelURI (string) --
The pre-signed Amazon S3 URI used to download the return shipping label.
{'OnDeviceServiceConfiguration': {'TGWOnDeviceService': {'StorageLimit': 'integer',
'StorageUnit': 'TB'}}}
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
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'
)
string
[REQUIRED]
The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000 .
string
The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in Identity and Access Management (IAM).
string
The updated description of this cluster.
dict
The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
S3Resources (list) --
An array of S3Resource objects.
(dict) --
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.
BucketArn (string) --
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
KeyRange (dict) --
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.
BeginMarker (string) --
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
EndMarker (string) --
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
TargetOnDeviceServices (list) --
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).
(dict) --
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).
ServiceName (string) --
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
TransferOption (string) --
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
LambdaResources (list) --
The Python-language Lambda functions for this job.
(dict) --
Identifies
LambdaArn (string) --
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
EventTriggers (list) --
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
(dict) --
The container for the EventTriggerDefinition$EventResourceARN .
EventResourceARN (string) --
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
Ec2AmiResources (list) --
The Amazon Machine Images (AMIs) associated with this job.
(dict) --
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.
AmiId (string) -- [REQUIRED]
The ID of the AMI in Amazon EC2.
SnowballAmiId (string) --
The ID of the AMI on the Snow device.
dict
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).
NFSOnDeviceService (dict) --
Represents the NFS (Network File System) service on a Snow Family device.
StorageLimit (integer) --
The maximum NFS storage for one Snow Family device.
StorageUnit (string) --
The scale unit of the NFS storage on the device.
Valid values: TB.
TGWOnDeviceService (dict) --
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
StorageLimit (integer) --
The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.
StorageUnit (string) --
The scale unit of the virtual tapes on the device.
string
The ID of the updated Address object.
string
The updated shipping option value of this cluster's ShippingDetails object.
dict
The new or updated Notification object.
SnsTopicARN (string) --
The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
JobStatesToNotify (list) --
The list of job states that will trigger a notification for this job.
(string) --
NotifyAll (boolean) --
Any change in job state will trigger a notification for this job.
string
The updated ID for the forwarding address for a cluster. This field is not supported in most regions.
dict
Response Syntax
{}
Response Structure
(dict) --
{'OnDeviceServiceConfiguration': {'TGWOnDeviceService': {'StorageLimit': 'integer',
'StorageUnit': 'TB'}}}
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
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',
ForwardingAddressId='string'
)
string
[REQUIRED]
The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000 .
string
The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRole Identity and Access Management (IAM) API action.
dict
The new or updated Notification object.
SnsTopicARN (string) --
The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
JobStatesToNotify (list) --
The list of job states that will trigger a notification for this job.
(string) --
NotifyAll (boolean) --
Any change in job state will trigger a notification for this job.
dict
The updated JobResource object, or the updated JobResource object.
S3Resources (list) --
An array of S3Resource objects.
(dict) --
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.
BucketArn (string) --
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
KeyRange (dict) --
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.
BeginMarker (string) --
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
EndMarker (string) --
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
TargetOnDeviceServices (list) --
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).
(dict) --
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).
ServiceName (string) --
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
TransferOption (string) --
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
LambdaResources (list) --
The Python-language Lambda functions for this job.
(dict) --
Identifies
LambdaArn (string) --
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
EventTriggers (list) --
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
(dict) --
The container for the EventTriggerDefinition$EventResourceARN .
EventResourceARN (string) --
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
Ec2AmiResources (list) --
The Amazon Machine Images (AMIs) associated with this job.
(dict) --
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.
AmiId (string) -- [REQUIRED]
The ID of the AMI in Amazon EC2.
SnowballAmiId (string) --
The ID of the AMI on the Snow device.
dict
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.
NFSOnDeviceService (dict) --
Represents the NFS (Network File System) service on a Snow Family device.
StorageLimit (integer) --
The maximum NFS storage for one Snow Family device.
StorageUnit (string) --
The scale unit of the NFS storage on the device.
Valid values: TB.
TGWOnDeviceService (dict) --
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
StorageLimit (integer) --
The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.
StorageUnit (string) --
The scale unit of the virtual tapes on the device.
string
The ID of the updated Address object.
string
The updated shipping option value of this job's ShippingDetails object.
string
The updated description of this job's JobMetadata object.
string
The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide .
string
The updated ID for the forwarding address for a job. This field is not supported in most regions.
dict
Response Syntax
{}
Response Structure
(dict) --