2018/11/26 - Amazon Import/Export Snowball - 7 updated api methods
Changes AWS announces the availability of AWS Snowball Edge Compute Optimized to run compute-intensive applications is disconnected and physically harsh environments. It comes with 52 vCPUs, 208GB memory, 8TB NVMe SSD, and 42TB S3-compatible storage to accelerate local processing and is well suited for use cases such as full motion video processing, deep IoT analytics, and continuous machine learning in bandwidth-constrained locations. It features new instances types called SBE-C instances that are available in eight sizes and multiple instances can be run on the device at the same time. Optionally, developers can choose the compute optimized device to include a GPU and use SBE-G instances for accelerating their application performance.
{'SnowballType': ['EDGE_CG', 'EDGE_C']}
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'
}
},
],
'LambdaResources': [
{
'LambdaArn': 'string',
'EventTriggers': [
{
'EventResourceARN': 'string'
},
]
},
],
'Ec2AmiResources': [
{
'AmiId': 'string',
'SnowballAmiId': 'string'
},
]
},
Description='string',
AddressId='string',
KmsKeyARN='string',
RoleARN='string',
SnowballType='STANDARD'|'EDGE'|'EDGE_C'|'EDGE_CG',
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 type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE .
dict
[REQUIRED]
The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS 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.
LambdaResources (list) --
The Python-language Lambda functions for this job.
(dict) --
Identifies
LambdaArn (string) --
An Amazon Resource Name (ARN) that represents an AWS 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 AWS 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 Snowball Edge AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the AWS 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 supported 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 AWS Key Management Service (AWS KMS).
string
[REQUIRED]
The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).
string
The type of AWS Snowball device to use for this cluster. The only supported device types for cluster jobs are EDGE , EDGE_C , and EDGE_CG .
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, devices shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snowball Edges 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, 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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (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
Response Syntax
{
'ClusterId': 'string'
}
Response Structure
(dict) --
ClusterId (string) --
The automatically generated ID for a cluster.
{'SnowballCapacityPreference': ['T42'], 'SnowballType': ['EDGE_CG', 'EDGE_C']}
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.
See also: AWS API Documentation
Request Syntax
client.create_job(
JobType='IMPORT'|'EXPORT'|'LOCAL_USE',
Resources={
'S3Resources': [
{
'BucketArn': 'string',
'KeyRange': {
'BeginMarker': 'string',
'EndMarker': 'string'
}
},
],
'LambdaResources': [
{
'LambdaArn': 'string',
'EventTriggers': [
{
'EventResourceARN': 'string'
},
]
},
],
'Ec2AmiResources': [
{
'AmiId': 'string',
'SnowballAmiId': 'string'
},
]
},
Description='string',
AddressId='string',
KmsKeyARN='string',
RoleARN='string',
SnowballCapacityPreference='T50'|'T80'|'T100'|'T42'|'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',
ForwardingAddressId='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.
LambdaResources (list) --
The Python-language Lambda functions for this job.
(dict) --
Identifies
LambdaArn (string) --
An Amazon Resource Name (ARN) that represents an AWS 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 AWS 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 Snowball Edge AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the AWS 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 supported 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 Snowball shipped to.
string
The KmsKeyARN that you want to associate with this job. KmsKeyARN s are created using the CreateKey AWS Key Management Service (KMS) API action.
string
The RoleARN that you want to associate with this job. RoleArn s are created using the CreateRole AWS 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 Snowball you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
string
The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snowball, rather it represents how quickly the Snowball moves to its destination while in transit. Regional shipping speeds are as follows:
In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snowballs 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, Snowballs 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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (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 AWS Snowball device to use for this job. The only supported device types for cluster jobs are EDGE , EDGE_C , and EDGE_CG .
string
The forwarding address ID for a job. This field is not supported in most regions.
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': {'SnowballType': ['EDGE_CG', 'EDGE_C']}}
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',
'CreationDate': datetime(2015, 1, 1),
'Resources': {
'S3Resources': [
{
'BucketArn': 'string',
'KeyRange': {
'BeginMarker': 'string',
'EndMarker': 'string'
}
},
],
'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'
}
}
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 AWS Key Management Service (AWS KMS).
RoleARN (string) --
The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS 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 AWS Snowball device to use for this cluster. The only supported device types for cluster jobs are EDGE , EDGE_C , and EDGE_CG .
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.
LambdaResources (list) --
The Python-language Lambda functions for this job.
(dict) --
Identifies
LambdaArn (string) --
An Amazon Resource Name (ARN) that represents an AWS 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 AWS 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 Snowball Edge AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the AWS Cloud and on the device.
AmiId (string) --
The ID of the AMI in Amazon EC2.
SnowballAmiId (string) --
The ID of the AMI on the supported 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, 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, 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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (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.
{'JobMetadata': {'SnowballCapacityPreference': ['T42'],
'SnowballType': ['EDGE_CG', 'EDGE_C']},
'SubJobMetadata': {'SnowballCapacityPreference': ['T42'],
'SnowballType': ['EDGE_CG', 'EDGE_C']}}
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',
'CreationDate': datetime(2015, 1, 1),
'Resources': {
'S3Resources': [
{
'BucketArn': 'string',
'KeyRange': {
'BeginMarker': 'string',
'EndMarker': 'string'
}
},
],
'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'|'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'
},
'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',
'CreationDate': datetime(2015, 1, 1),
'Resources': {
'S3Resources': [
{
'BucketArn': 'string',
'KeyRange': {
'BeginMarker': 'string',
'EndMarker': 'string'
}
},
],
'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'|'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'
},
]
}
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.
LambdaResources (list) --
The Python-language Lambda functions for this job.
(dict) --
Identifies
LambdaArn (string) --
An Amazon Resource Name (ARN) that represents an AWS 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 AWS 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 Snowball Edge AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the AWS Cloud and on the device.
AmiId (string) --
The ID of the AMI in Amazon EC2.
SnowballAmiId (string) --
The ID of the AMI on the supported device.
Description (string) --
The description of the job, provided at job creation.
KmsKeyARN (string) --
The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.
RoleARN (string) --
The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).
AddressId (string) --
The ID for the address that you want the Snowball 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 Snowball 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, Snowballs shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snowballs 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, Snowballs 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 Snowball being returned to AWS 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 Snowball 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 Snowball 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 Snowball as the carrier transports it.
For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.
SnowballCapacityPreference (string) --
The Snowball 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.
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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (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 Snowball's data transfer while the device is at AWS. 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 Snowball and Amazon S3.
ObjectsTransferred (integer) --
The number of objects transferred between a Snowball and Amazon S3.
TotalBytes (integer) --
The total bytes of data for a transfer between a Snowball 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 Snowball 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 Snowball 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.
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.
LambdaResources (list) --
The Python-language Lambda functions for this job.
(dict) --
Identifies
LambdaArn (string) --
An Amazon Resource Name (ARN) that represents an AWS 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 AWS 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 Snowball Edge AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the AWS Cloud and on the device.
AmiId (string) --
The ID of the AMI in Amazon EC2.
SnowballAmiId (string) --
The ID of the AMI on the supported device.
Description (string) --
The description of the job, provided at job creation.
KmsKeyARN (string) --
The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.
RoleARN (string) --
The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).
AddressId (string) --
The ID for the address that you want the Snowball 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 Snowball 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, Snowballs shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snowballs 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, Snowballs 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 Snowball being returned to AWS 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 Snowball 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 Snowball 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 Snowball as the carrier transports it.
For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.
SnowballCapacityPreference (string) --
The Snowball 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.
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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (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 Snowball's data transfer while the device is at AWS. 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 Snowball and Amazon S3.
ObjectsTransferred (integer) --
The number of objects transferred between a Snowball and Amazon S3.
TotalBytes (integer) --
The total bytes of data for a transfer between a Snowball 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 Snowball 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 Snowball 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.
{'JobListEntries': {'SnowballType': ['EDGE_CG', 'EDGE_C']}}
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
client.list_cluster_jobs(
ClusterId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000 .
integer
The number of JobListEntry objects to return.
string
HTTP requests are stateless. To identify what object comes "next" in the list of 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',
'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 master job. A master job represents a successful request to create an export job. Master jobs aren't associated with any Snowballs. Instead, each master 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 master job are listed, because they are created after the master 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.
{'JobListEntries': {'SnowballType': ['EDGE_CG', 'EDGE_C']}}
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
client.list_jobs(
MaxResults=123,
NextToken='string'
)
integer
The number of JobListEntry objects to return.
string
HTTP requests are stateless. To identify what object comes "next" in the list of 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',
'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 master job. A master job represents a successful request to create an export job. Master jobs aren't associated with any Snowballs. Instead, each master 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 master job are listed, because they are created after the master 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.
{'SnowballCapacityPreference': ['T42']}
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'
}
},
],
'LambdaResources': [
{
'LambdaArn': 'string',
'EventTriggers': [
{
'EventResourceARN': 'string'
},
]
},
],
'Ec2AmiResources': [
{
'AmiId': 'string',
'SnowballAmiId': 'string'
},
]
},
AddressId='string',
ShippingOption='SECOND_DAY'|'NEXT_DAY'|'EXPRESS'|'STANDARD',
Description='string',
SnowballCapacityPreference='T50'|'T80'|'T100'|'T42'|'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 AWS 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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (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.
LambdaResources (list) --
The Python-language Lambda functions for this job.
(dict) --
Identifies
LambdaArn (string) --
An Amazon Resource Name (ARN) that represents an AWS 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 AWS 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 Snowball Edge AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the AWS 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 supported 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.
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) --