JobMetadata

Important

End of support notice: On November 12, 2024, AWS will discontinue previous generation AWS Snowball devices, and both Snowcone devices (HDD and SDD). We will continue to support existing customers using these end-of-life devices until November 12, 2025. The latest generation AWS Snowball devices are available for all customers. For more information, visit this blog post.

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.

AddressId

The ID for the address that you want the Snow device 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. Maximum length of 1024.

Pattern: .*

Required: No

CreationDate

The creation date for this job.

Type: Timestamp

Required: No

DataTransferProgress

A value that defines the real-time status of a Snow device'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.

Type: DataTransfer object

Required: No

Description

The description of the job, provided at job creation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*

Required: No

DeviceConfiguration

Important

The container for SnowconeDeviceConfiguration.

Type: DeviceConfiguration object

Required: No

ForwardingAddressId

This field is not supported in your region.

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

ImpactLevel

The highest impact level of data that will be stored or processed on the device, provided at job creation.

Type: String

Valid Values: IL2 | IL4 | IL5 | IL6 | IL99

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. Maximum length of 1024.

Pattern: .*

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 Snow device for your job part is being delivered to you.

Type: JobLogs object

Required: No

JobState

The current status of the jobs.

Type: String

Required: No

JobType

The type of job.

Type: String

Valid Values: IMPORT | EXPORT | LOCAL_USE

Required: 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

LongTermPricingId

The ID of the long-term pricing type for the device.

Type: String

Length Constraints: Fixed length of 41.

Pattern: LTPID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No

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.

Type: Notification object

Required: No

OnDeviceServiceConfiguration

Represents metadata and configuration settings for services on an AWS Snowball Edge device.

Type: OnDeviceServiceConfiguration object

Required: No

PickupDetails

Information identifying the person picking up the device.

Type: PickupDetails object

Required: No

RemoteManagement

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.

Type: String

Valid Values: INSTALLED_ONLY | INSTALLED_AUTOSTART | NOT_INSTALLED

Required: No

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.

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.

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 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 information about Snowball Edge device types, see Device hardware differences in the Snowball Edge Developer Guide.

Type: String

Valid Values: T50 | T80 | T100 | T42 | T98 | T8 | T14 | T32 | NoPreference | T240 | T13

Required: No

SnowballId

Unique ID associated with a device.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*

Required: No

SnowballType

The type of device used with this job.

Type: String

Required: No

TaxDocuments

The metadata associated with the tax documents required in your AWS Region.

Type: TaxDocuments object

Required: No

JobMetadata

Important

Contents

Important

See Also