JobMetadata
Contains information about a specific job including shipping information, job status,
and other important metadata. This information is returned as a part of the response
syntax of
the DescribeJob action.
Contents
- AddressId
-
The ID for the address that you want the Snowball shipped to.
Type: String
Length Constraints: Fixed length of 40.
Pattern:
ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}Required: No
- ClusterId
-
The 39-character ID for the cluster, for example
CID123e4567-e89b-12d3-a456-426655440000.Type: String
Length Constraints: Minimum length of 1.
Required: No
- CreationDate
-
The creation date for this job.
Type: Timestamp
Required: No
- DataTransferProgress
-
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
JobStatevalue ofInProgress, for both import and export jobs.Type: DataTransfer object
Required: No
- Description
-
The description of the job, provided at job creation.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- ForwardingAddressId
-
Type: String
Length Constraints: Fixed length of 40.
Pattern:
ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}Required: No
- JobId
-
The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000.Type: String
Length Constraints: Minimum length of 1.
Required: No
- 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.
Type: JobLogs object
Required: No
- JobState
-
The current status of the jobs.
Type: String
Valid Values:
New | PreparingAppliance | PreparingShipment | InTransitToCustomer | WithCustomer | InTransitToAWS | WithAWSSortingFacility | WithAWS | InProgress | Complete | Cancelled | Listing | PendingRequired: No
- JobType
-
The type of job.
Type: String
Valid Values:
IMPORT | EXPORT | LOCAL_USERequired: No
- 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.
Type: String
Length Constraints: Maximum length of 255.
Pattern:
arn:aws.*:kms:.*:[0-9]{12}:key/.*Required: No
- Notification
-
The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The
Notificationobject is returned as a part of the response syntax of theDescribeJobaction in theJobMetadatadata type.Type: Notification object
Required: No
- Resources
-
An array of
S3Resourceobjects. EachS3Resourceobject represents an Amazon S3 bucket that your transferred data will be exported from or imported into.Type: JobResource object
Required: No
- RoleARN
-
The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).
Type: String
Length Constraints: Maximum length of 255.
Pattern:
arn:aws.*:iam::[0-9]{12}:role/.*Required: No
- ShippingDetails
-
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
Type: ShippingDetails object
Required: No
- 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.
Type: String
Valid Values:
T50 | T80 | T100 | T42 | NoPreferenceRequired: No
- SnowballType
-
The type of device used with this job.
Type: String
Valid Values:
STANDARD | EDGE | EDGE_C | EDGE_CGRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: