String addressId
The unique ID for an address.
String name
The name of a person to receive a Snowball at an address.
String company
The name of the company to receive a Snowball at an address.
String street1
The first line in a street address that a Snowball is to be delivered to.
String street2
The second line in a street address that a Snowball is to be delivered to.
String street3
The third line in a street address that a Snowball is to be delivered to.
String city
The city in an address that a Snowball is to be delivered to.
String stateOrProvince
The state or province in an address that a Snowball is to be delivered to.
String prefectureOrDistrict
The prefecture or district that the appliance will be shipped to.
String landmark
The landmark identifying the address that the appliance will be shipped to.
String country
The country in an address that a Snowball is to be delivered to.
String postalCode
The postal code in an address that a Snowball is to be delivered to.
String phoneNumber
The phone number associated with an address that a Snowball is to be delivered to.
String clusterId
The 39-character ID for the cluster that you want to cancel, for example
CID123e4567-e89b-12d3-a456-426655440000.
String jobId
The 39-character job ID for the job that you want to cancel, for example
JID123e4567-e89b-12d3-a456-426655440000.
String clusterId
The 39-character ID for the cluster that you want to list, for example
CID123e4567-e89b-12d3-a456-426655440000.
String clusterState
The current state of this cluster. For information about the state of a specific node, see JobListEntry$JobState.
Date creationDate
The creation date for this cluster.
String description
Defines an optional description of the cluster, for example Environmental Data Cluster-01.
String clusterId
The automatically generated ID for a cluster.
String description
The optional description of the cluster.
String kmsKeyARN
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).
String roleARN
The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).
String clusterState
The current status of the cluster.
String jobType
The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.
String snowballType
The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for
cluster jobs is EDGE.
Date creationDate
The creation date for this cluster.
JobResource resources
The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
String addressId
The automatically generated ID for a specific address.
String shippingOption
The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:
In Australia, you have access to express shipping. Typically, appliances 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, Snowball Edges are delivered in one to seven days.
In the US, you have access to one-day shipping and two-day shipping.
Notification notification
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
Address address
The address that you want the Snowball shipped to.
String addressId
The automatically generated ID for a specific address. You'll use this ID when you create a job to specify which address you want the Snowball for that job shipped to.
String jobType
The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.
JobResource resources
The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language.
String description
An optional description of this specific cluster, for example Environmental Data Cluster-01.
String addressId
The ID for the address that you want the cluster shipped to.>
String kmsKeyARN
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 roleARN
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 snowballType
The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for
cluster jobs is EDGE.
String shippingOption
The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:
In Australia, you have access to express shipping. Typically, appliances 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, Snowball Edges are delivered in one to seven days.
In the US, you have access to one-day shipping and two-day shipping.
Notification notification
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
String clusterId
The automatically generated ID for a cluster.
String jobType
Defines the type of job that you're creating.
JobResource resources
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.
String description
Defines an optional description of this specific job, for example Important Photos 2016-08-11.
String addressId
The ID for the address that you want the Snowball shipped to.
String kmsKeyARN
The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using
the CreateKey AWS Key
Management Service (KMS) API action.
String roleARN
The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and
Access Management (IAM) API action.
String snowballCapacityPreference
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 shippingOption
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.
Notification notification
Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
String clusterId
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 snowballType
The type of AWS Snowball appliance to use for this job. Currently, the only supported appliance type for cluster
jobs is EDGE.
String jobId
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
Long bytesTransferred
The number of bytes transferred between a Snowball and Amazon S3.
Long objectsTransferred
The number of objects transferred between a Snowball and Amazon S3.
Long totalBytes
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.
Long totalObjects
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.
Integer maxResults
The number of ADDRESS objects to return.
String nextToken
HTTP requests are stateless. To identify what object comes "next" in the list of ADDRESS objects,
you have the option of specifying a value for NextToken as the starting point for your list of
returned addresses.
List<E> addresses
The Snowball shipping addresses that were created for this account.
String nextToken
HTTP requests are stateless. If you use the automatically generated NextToken value in your next
DescribeAddresses call, your list of returned addresses will start from this point in the array.
String addressId
The automatically generated ID for a specific address.
Address address
The address that you want the Snowball or Snowballs associated with a specific job to be shipped to.
String clusterId
The automatically generated ID for a cluster.
ClusterMetadata clusterMetadata
Information about a specific cluster, including shipping information, cluster status, and other important metadata.
String jobId
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
JobMetadata jobMetadata
Information about a specific job, including shipping information, job status, and other important metadata.
List<E> subJobMetadata
Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.
String eventResourceARN
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an AWS Lambda function's event trigger associated with this job.
String jobId
The ID for a job that you want to get the manifest file for, for example
JID123e4567-e89b-12d3-a456-426655440000.
String manifestURI
The Amazon S3 presigned URL for the manifest file associated with the specified JobId value.
String jobId
The ID for the job that you want to get the UnlockCode value for, for example
JID123e4567-e89b-12d3-a456-426655440000.
String unlockCode
The UnlockCode value for the specified job. The UnlockCode value can be accessed for up
to 90 days after the job has been created.
String jobId
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
String jobState
The current state of this job.
Boolean isMaster
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.
String jobType
The type of job.
String snowballType
The type of appliance used with this job.
Date creationDate
The creation date for this job.
String description
The optional description of this specific job, for example Important Photos 2016-08-11.
String jobCompletionReportURI
A link to an Amazon S3 presigned URL where the job completion report is located.
String jobSuccessLogURI
A link to an Amazon S3 presigned URL where the job success log is located.
String jobFailureLogURI
A link to an Amazon S3 presigned URL where the job failure log is located.
String jobId
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
String jobState
The current status of the jobs.
String jobType
The type of job.
String snowballType
The type of appliance used with this job.
Date creationDate
The creation date for this job.
JobResource resources
An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket
that your transferred data will be exported from or imported into.
String description
The description of the job, provided at job creation.
String kmsKeyARN
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.
String roleARN
The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS
Identity and Access Management (IAM).
String addressId
The ID for the address that you want the Snowball shipped to.
ShippingDetails shippingDetails
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
String snowballCapacityPreference
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 notification
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.
DataTransfer dataTransferProgress
A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS. This data
is only available while a job has a JobState value of InProgress, for both import and
export jobs.
JobLogs jobLogInfo
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.
String clusterId
The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.
String lambdaArn
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.
List<E> eventTriggers
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
String clusterId
The 39-character ID for the cluster that you want to list, for example
CID123e4567-e89b-12d3-a456-426655440000.
Integer maxResults
The number of JobListEntry objects to return.
String nextToken
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.
List<E> jobListEntries
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.
String nextToken
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.
Integer maxResults
The number of ClusterListEntry objects to return.
String nextToken
HTTP requests are stateless. To identify what object comes "next" in the list of ClusterListEntry
objects, you have the option of specifying NextToken as the starting point for your returned list.
List<E> clusterListEntries
Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status
information.
String nextToken
HTTP requests are stateless. If you use the automatically generated NextToken value in your next
ClusterListEntry call, your list of returned clusters will start from this point in the array.
List<E> jobListEntries
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.
String nextToken
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.
String snsTopicARN
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.
List<E> jobStatesToNotify
The list of job states that will trigger a notification for this job.
Boolean notifyAll
Any change in job state will trigger a notification for this job.
String bucketArn
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
KeyRange keyRange
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.
String status
Status information for a shipment. Valid statuses include NEW, IN_TRANSIT, and
DELIVERED.
String trackingNumber
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.
String shippingOption
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.
Shipment inboundShipment
The Status and TrackingNumber values for a Snowball being delivered to the address that
you specified for a particular job.
Shipment outboundShipment
The Status and TrackingNumber values for a Snowball being returned to AWS for a
particular job.
String clusterId
The cluster ID of the cluster that you want to update, for example
CID123e4567-e89b-12d3-a456-426655440000.
String roleARN
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 AWS Identity and Access Management (IAM).
String description
The updated description of this cluster.
JobResource resources
The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
String addressId
The ID of the updated Address object.
String shippingOption
The updated shipping option value of this cluster's ShippingDetails object.
Notification notification
The new or updated Notification object.
String jobId
The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.
String roleARN
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.
Notification notification
The new or updated Notification object.
JobResource resources
The updated S3Resource object (for a single Amazon S3 bucket or key range), or the updated JobResource object (for multiple buckets or key ranges).
String addressId
The ID of the updated Address object.
String shippingOption
The updated shipping option value of this job's ShippingDetails object.
String description
The updated description of this job's JobMetadata object.
String snowballCapacityPreference
The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs
are only available in the US regions.
Copyright © 2017. All rights reserved.