Documentation

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.

See: newJobMetadata smart constructor.

Create a value of JobMetadata with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:addressId:JobMetadata', jobMetadata_addressId - The ID for the address that you want the Snow device shipped to.

$sel:clusterId:JobMetadata', jobMetadata_clusterId - The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

$sel:creationDate:JobMetadata', jobMetadata_creationDate - The creation date for this job.

$sel:dataTransferProgress:JobMetadata', jobMetadata_dataTransferProgress - 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.

$sel:description:JobMetadata', jobMetadata_description - The description of the job, provided at job creation.

$sel:deviceConfiguration:JobMetadata', jobMetadata_deviceConfiguration - Undocumented member.

$sel:forwardingAddressId:JobMetadata', jobMetadata_forwardingAddressId - 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.

$sel:jobId:JobMetadata', jobMetadata_jobId - The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

$sel:jobLogInfo:JobMetadata', jobMetadata_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.

$sel:jobState:JobMetadata', jobMetadata_jobState - The current status of the jobs.

$sel:jobType:JobMetadata', jobMetadata_jobType - The type of job.

$sel:kmsKeyARN:JobMetadata', jobMetadata_kmsKeyARN - 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.

$sel:longTermPricingId:JobMetadata', jobMetadata_longTermPricingId - The ID of the long-term pricing type for the device.

$sel:notification:JobMetadata', jobMetadata_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.

$sel:onDeviceServiceConfiguration:JobMetadata', jobMetadata_onDeviceServiceConfiguration - Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.

$sel:remoteManagement:JobMetadata', jobMetadata_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.

$sel:resources:JobMetadata', jobMetadata_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.

$sel:roleARN:JobMetadata', jobMetadata_roleARN - The role ARN associated with this job. This ARN was created using the CreateRole API action in Identity and Access Management.

$sel:shippingDetails:JobMetadata', jobMetadata_shippingDetails - A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

$sel:snowballCapacityPreference:JobMetadata', jobMetadata_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 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.

$sel:snowballType:JobMetadata', jobMetadata_snowballType - The type of device used with this job.

$sel:taxDocuments:JobMetadata', jobMetadata_taxDocuments - The metadata associated with the tax documents required in your Amazon Web Services Region.

The ID for the address that you want the Snow device shipped to.

The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

The creation date for this job.

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.

The description of the job, provided at job creation.

Undocumented member.

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.

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

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.

The current status of the jobs.

The type of job.

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.

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

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.

Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.

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.

An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

The role ARN associated with this job. This ARN was created using the CreateRole API action in Identity and Access Management.

A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

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.

The type of device used with this job.

The metadata associated with the tax documents required in your Amazon Web Services Region.