Skip to content
AWS for Query.Farm

aws.snowball.describe_job

Example SQL Queries

SELECT * FROM
aws.snowball.describe_job
WHERE
"job_id" = 'VALUE';

Description

Returns information about a specific job including shipping information, job status, and other important metadata.

Table Definition

Column NameColumn Data Type
job_id Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
job_metadata

Information about a specific job, including shipping information, job status, and other important metadata.

STRUCT(
    "job_id" VARCHAR,
    "job_state" VARCHAR,
    "job_type" VARCHAR,
    "snowball_type" VARCHAR,
    "creation_date" TIMESTAMP_S,
    "resources" STRUCT(
        "s3_resources" STRUCT(
            "bucket_arn" VARCHAR,
            "key_range" STRUCT(
                "begin_marker" VARCHAR,
                "end_marker" VARCHAR
            ),
            "target_on_device_services" STRUCT(
                "service_name" VARCHAR,
                "transfer_option" VARCHAR
            )[]
        )[],
        "lambda_resources" STRUCT(
            "lambda_arn" VARCHAR,
            "event_triggers" STRUCT(
                "event_resource_arn" VARCHAR
            )[]
        )[],
        "ec2_ami_resources" STRUCT(
            "ami_id" VARCHAR,
            "snowball_ami_id" VARCHAR
        )[]
    ),
    "description" VARCHAR,
    "kms_key_arn" VARCHAR,
    "role_arn" VARCHAR,
    "address_id" VARCHAR,
    "shipping_details" STRUCT(
        "shipping_option" VARCHAR,
        "inbound_shipment" STRUCT(
            "status" VARCHAR,
            "tracking_number" VARCHAR
        ),
        "outbound_shipment" STRUCT(
            "status" VARCHAR,
            "tracking_number" VARCHAR
        )
    ),
    "snowball_capacity_preference" VARCHAR,
    "notification" STRUCT(
        "sns_topic_arn" VARCHAR,
        "job_states_to_notify" VARCHAR[],
        "notify_all" BOOLEAN,
        "device_pickup_sns_topic_arn" VARCHAR
    ),
    "data_transfer_progress" STRUCT(
        "bytes_transferred" BIGINT,
        "objects_transferred" BIGINT,
        "total_bytes" BIGINT,
        "total_objects" BIGINT
    ),
    "job_log_info" STRUCT(
        "job_completion_report_uri" VARCHAR,
        "job_success_log_uri" VARCHAR,
        "job_failure_log_uri" VARCHAR
    ),
    "cluster_id" VARCHAR,
    "forwarding_address_id" VARCHAR,
    "tax_documents" STRUCT(
        "ind" STRUCT(
            "gstin" VARCHAR
        )
    ),
    "device_configuration" STRUCT(
        "snowcone_device_configuration" STRUCT(
            "wireless_connection" STRUCT(
                "is_wifi_enabled" BOOLEAN
            )
        )
    ),
    "remote_management" VARCHAR,
    "long_term_pricing_id" VARCHAR,
    "on_device_service_configuration" STRUCT(
        "nfs_on_device_service" STRUCT(
            "storage_limit" BIGINT,
            "storage_unit" VARCHAR
        ),
        "tgw_on_device_service" STRUCT(
            "storage_limit" BIGINT,
            "storage_unit" VARCHAR
        ),
        "eks_on_device_service" STRUCT(
            "kubernetes_version" VARCHAR,
            "eks_anywhere_version" VARCHAR
        ),
        "s3_on_device_service" STRUCT(
            "storage_limit" DOUBLE,
            "storage_unit" VARCHAR,
            "service_size" BIGINT,
            "fault_tolerance" BIGINT
        )
    ),
    "impact_level" VARCHAR,
    "pickup_details" STRUCT(
        "name" VARCHAR,
        "phone_number" VARCHAR,
        "email" VARCHAR,
        "identification_number" VARCHAR,
        "identification_expiration_date" TIMESTAMP_S,
        "identification_issuing_org" VARCHAR,
        "device_pickup_id" VARCHAR
    ),
    "snowball_id" VARCHAR
)
Show child fields
job_metadata.address_id

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

job_metadata.cluster_id

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

job_metadata.creation_date

The creation date for this job.

job_metadata.data_transfer_progress

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.

Show child fields
job_metadata.data_transfer_progress.bytes_transferred

The number of bytes transferred between a Snow device and Amazon S3.

job_metadata.data_transfer_progress.objects_transferred

The number of objects transferred between a Snow device and Amazon S3.

job_metadata.data_transfer_progress.total_bytes

The total bytes of data for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.

job_metadata.data_transfer_progress.total_objects

The total number of objects for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.

job_metadata.description

The description of the job, provided at job creation.

job_metadata.device_configuration

The container for SnowconeDeviceConfiguration.

Show child fields
job_metadata.device_configuration.snowcone_device_configuration

Returns information about the device configuration for an Snowcone job.

Show child fields
job_metadata.device_configuration.snowcone_device_configuration.wireless_connection

Configures the wireless connection for the Snowcone device.

Show child fields
job_metadata.device_configuration.snowcone_device_configuration.wireless_connection.is_wifi_enabled

Enables the Wi-Fi adapter on an Snowcone device.

job_metadata.forwarding_address_id

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.

job_metadata.impact_level

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

job_metadata.job_id

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

job_metadata.job_log_info

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.

Show child fields
job_metadata.job_log_info.job_completion_report_uri

A link to an Amazon S3 presigned URL where the job completion report is located.

job_metadata.job_log_info.job_failure_log_uri

A link to an Amazon S3 presigned URL where the job failure log is located.

job_metadata.job_log_info.job_success_log_uri

A link to an Amazon S3 presigned URL where the job success log is located.

job_metadata.job_state

The current status of the jobs.

job_metadata.job_type

The type of job.

job_metadata.kms_key_arn

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.

job_metadata.long_term_pricing_id

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

job_metadata.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.

Show child fields
job_metadata.notification.device_pickup_sns_topic_arn

Used to send SNS notifications for the person picking up the device (identified during job creation).

job_metadata.notification.job_states_to_notify[]
job_metadata.notification.notify_all

Any change in job state will trigger a notification for this job.

job_metadata.notification.sns_topic_arn

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 Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.

job_metadata.on_device_service_configuration

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

Show child fields
job_metadata.on_device_service_configuration.eks_on_device_service

The configuration of EKS Anywhere on the Snow Family device.

Show child fields
job_metadata.on_device_service_configuration.eks_on_device_service.eks_anywhere_version

The optional version of EKS Anywhere on the Snow Family device.

job_metadata.on_device_service_configuration.eks_on_device_service.kubernetes_version

The Kubernetes version for EKS Anywhere on the Snow Family device.

job_metadata.on_device_service_configuration.nfs_on_device_service

Represents the NFS (Network File System) service on a Snow Family device.

Show child fields
job_metadata.on_device_service_configuration.nfs_on_device_service.storage_limit

The maximum NFS storage for one Snow Family device.

job_metadata.on_device_service_configuration.nfs_on_device_service.storage_unit

The scale unit of the NFS storage on the device.

Valid values: TB.

job_metadata.on_device_service_configuration.s3_on_device_service

Configuration for Amazon S3 compatible storage on Snow family devices.

Show child fields
job_metadata.on_device_service_configuration.s3_on_device_service.fault_tolerance

>Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified StorageLimit matches more than one Amazon S3 compatible storage on Snow family devices service configuration.

job_metadata.on_device_service_configuration.s3_on_device_service.service_size

Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.

job_metadata.on_device_service_configuration.s3_on_device_service.storage_limit

If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.

job_metadata.on_device_service_configuration.s3_on_device_service.storage_unit

Storage unit. Currently the only supported unit is TB.

job_metadata.on_device_service_configuration.tgw_on_device_service

Represents the Storage Gateway service Tape Gateway type on a Snow Family device.

Show child fields
job_metadata.on_device_service_configuration.tgw_on_device_service.storage_limit

The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.

job_metadata.on_device_service_configuration.tgw_on_device_service.storage_unit

The scale unit of the virtual tapes on the device.

job_metadata.pickup_details

Information identifying the person picking up the device.

Show child fields
job_metadata.pickup_details.device_pickup_id

The unique ID for a device that will be picked up.

job_metadata.pickup_details.email

The email address of the person picking up the device.

job_metadata.pickup_details.identification_expiration_date

Expiration date of the credential identifying the person picking up the device.

job_metadata.pickup_details.identification_issuing_org

Organization that issued the credential identifying the person picking up the device.

job_metadata.pickup_details.identification_number

The number on the credential identifying the person picking up the device.

job_metadata.pickup_details.name

The name of the person picking up the device.

job_metadata.pickup_details.phone_number

The phone number of the person picking up the device.

job_metadata.remote_management

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.

job_metadata.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.

Show child fields
job_metadata.resources.ec2_ami_resources[]
Show child fields
job_metadata.resources.ec2_ami_resources[].ami_id

The ID of the AMI in Amazon EC2.

job_metadata.resources.ec2_ami_resources[].snowball_ami_id

The ID of the AMI on the Snow device.

job_metadata.resources.lambda_resources[]
Show child fields
job_metadata.resources.lambda_resources[].event_triggers[]
Show child fields
job_metadata.resources.lambda_resources[].event_triggers[].event_resource_arn

The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.

job_metadata.resources.lambda_resources[].lambda_arn

An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.

job_metadata.resources.s3_resources[]
Show child fields
job_metadata.resources.s3_resources[].bucket_arn

The Amazon Resource Name (ARN) of an Amazon S3 bucket.

job_metadata.resources.s3_resources[].key_range

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.

Show child fields
job_metadata.resources.s3_resources[].key_range.begin_marker

The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

job_metadata.resources.s3_resources[].key_range.end_marker

The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

job_metadata.resources.s3_resources[].target_on_device_services[]
Show child fields
job_metadata.resources.s3_resources[].target_on_device_services[].service_name

Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.

job_metadata.resources.s3_resources[].target_on_device_services[].transfer_option

Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.

job_metadata.role_arn

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

job_metadata.shipping_details

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

Show child fields
job_metadata.shipping_details.inbound_shipment

The Status and TrackingNumber values for a Snow device being returned to Amazon Web Services for a particular job.

Show child fields
job_metadata.shipping_details.inbound_shipment.status

Status information for a shipment.

job_metadata.shipping_details.inbound_shipment.tracking_number

The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snow device as the carrier transports it.

For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.

job_metadata.shipping_details.outbound_shipment

The Status and TrackingNumber values for a Snow device being delivered to the address that you specified for a particular job.

Show child fields
job_metadata.shipping_details.outbound_shipment.status

Status information for a shipment.

job_metadata.shipping_details.outbound_shipment.tracking_number

The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snow device as the carrier transports it.

For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.

job_metadata.shipping_details.shipping_option

The shipping speed for a particular job. This speed doesn't dictate how soon you'll get the Snow device 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, Snow devices shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snow 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, Snow devices 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.

job_metadata.snowball_capacity_preference

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.

job_metadata.snowball_id

Unique ID associated with a device.

job_metadata.snowball_type

The type of device used with this job.

job_metadata.tax_documents

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

Show child fields
job_metadata.tax_documents.ind

The tax documents required in Amazon Web Services Region in India.

Show child fields
job_metadata.tax_documents.ind.gstin

The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.

sub_job_metadata

Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.

STRUCT(
    "job_id" VARCHAR,
    "job_state" VARCHAR,
    "job_type" VARCHAR,
    "snowball_type" VARCHAR,
    "creation_date" TIMESTAMP_S,
    "resources" STRUCT(
        "s3_resources" STRUCT(
            "bucket_arn" VARCHAR,
            "key_range" STRUCT(
                "begin_marker" VARCHAR,
                "end_marker" VARCHAR
            ),
            "target_on_device_services" STRUCT(
                "service_name" VARCHAR,
                "transfer_option" VARCHAR
            )[]
        )[],
        "lambda_resources" STRUCT(
            "lambda_arn" VARCHAR,
            "event_triggers" STRUCT(
                "event_resource_arn" VARCHAR
            )[]
        )[],
        "ec2_ami_resources" STRUCT(
            "ami_id" VARCHAR,
            "snowball_ami_id" VARCHAR
        )[]
    ),
    "description" VARCHAR,
    "kms_key_arn" VARCHAR,
    "role_arn" VARCHAR,
    "address_id" VARCHAR,
    "shipping_details" STRUCT(
        "shipping_option" VARCHAR,
        "inbound_shipment" STRUCT(
            "status" VARCHAR,
            "tracking_number" VARCHAR
        ),
        "outbound_shipment" STRUCT(
            "status" VARCHAR,
            "tracking_number" VARCHAR
        )
    ),
    "snowball_capacity_preference" VARCHAR,
    "notification" STRUCT(
        "sns_topic_arn" VARCHAR,
        "job_states_to_notify" VARCHAR[],
        "notify_all" BOOLEAN,
        "device_pickup_sns_topic_arn" VARCHAR
    ),
    "data_transfer_progress" STRUCT(
        "bytes_transferred" BIGINT,
        "objects_transferred" BIGINT,
        "total_bytes" BIGINT,
        "total_objects" BIGINT
    ),
    "job_log_info" STRUCT(
        "job_completion_report_uri" VARCHAR,
        "job_success_log_uri" VARCHAR,
        "job_failure_log_uri" VARCHAR
    ),
    "cluster_id" VARCHAR,
    "forwarding_address_id" VARCHAR,
    "tax_documents" STRUCT(
        "ind" STRUCT(
            "gstin" VARCHAR
        )
    ),
    "device_configuration" STRUCT(
        "snowcone_device_configuration" STRUCT(
            "wireless_connection" STRUCT(
                "is_wifi_enabled" BOOLEAN
            )
        )
    ),
    "remote_management" VARCHAR,
    "long_term_pricing_id" VARCHAR,
    "on_device_service_configuration" STRUCT(
        "nfs_on_device_service" STRUCT(
            "storage_limit" BIGINT,
            "storage_unit" VARCHAR
        ),
        "tgw_on_device_service" STRUCT(
            "storage_limit" BIGINT,
            "storage_unit" VARCHAR
        ),
        "eks_on_device_service" STRUCT(
            "kubernetes_version" VARCHAR,
            "eks_anywhere_version" VARCHAR
        ),
        "s3_on_device_service" STRUCT(
            "storage_limit" DOUBLE,
            "storage_unit" VARCHAR,
            "service_size" BIGINT,
            "fault_tolerance" BIGINT
        )
    ),
    "impact_level" VARCHAR,
    "pickup_details" STRUCT(
        "name" VARCHAR,
        "phone_number" VARCHAR,
        "email" VARCHAR,
        "identification_number" VARCHAR,
        "identification_expiration_date" TIMESTAMP_S,
        "identification_issuing_org" VARCHAR,
        "device_pickup_id" VARCHAR
    ),
    "snowball_id" VARCHAR
)[]
Show child fields
sub_job_metadata[]
Show child fields
sub_job_metadata[].address_id

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

sub_job_metadata[].cluster_id

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

sub_job_metadata[].creation_date

The creation date for this job.

sub_job_metadata[].data_transfer_progress

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.

Show child fields
sub_job_metadata[].data_transfer_progress.bytes_transferred

The number of bytes transferred between a Snow device and Amazon S3.

sub_job_metadata[].data_transfer_progress.objects_transferred

The number of objects transferred between a Snow device and Amazon S3.

sub_job_metadata[].data_transfer_progress.total_bytes

The total bytes of data for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.

sub_job_metadata[].data_transfer_progress.total_objects

The total number of objects for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.

sub_job_metadata[].description

The description of the job, provided at job creation.

sub_job_metadata[].device_configuration

The container for SnowconeDeviceConfiguration.

Show child fields
sub_job_metadata[].device_configuration.snowcone_device_configuration

Returns information about the device configuration for an Snowcone job.

Show child fields
sub_job_metadata[].device_configuration.snowcone_device_configuration.wireless_connection

Configures the wireless connection for the Snowcone device.

Show child fields
sub_job_metadata[].device_configuration.snowcone_device_configuration.wireless_connection.is_wifi_enabled

Enables the Wi-Fi adapter on an Snowcone device.

sub_job_metadata[].forwarding_address_id

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.

sub_job_metadata[].impact_level

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

sub_job_metadata[].job_id

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

sub_job_metadata[].job_log_info

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.

Show child fields
sub_job_metadata[].job_log_info.job_completion_report_uri

A link to an Amazon S3 presigned URL where the job completion report is located.

sub_job_metadata[].job_log_info.job_failure_log_uri

A link to an Amazon S3 presigned URL where the job failure log is located.

sub_job_metadata[].job_log_info.job_success_log_uri

A link to an Amazon S3 presigned URL where the job success log is located.

sub_job_metadata[].job_state

The current status of the jobs.

sub_job_metadata[].job_type

The type of job.

sub_job_metadata[].kms_key_arn

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.

sub_job_metadata[].long_term_pricing_id

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

sub_job_metadata[].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.

Show child fields
sub_job_metadata[].notification.device_pickup_sns_topic_arn

Used to send SNS notifications for the person picking up the device (identified during job creation).

sub_job_metadata[].notification.job_states_to_notify[]
sub_job_metadata[].notification.notify_all

Any change in job state will trigger a notification for this job.

sub_job_metadata[].notification.sns_topic_arn

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 Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.

sub_job_metadata[].on_device_service_configuration

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

Show child fields
sub_job_metadata[].on_device_service_configuration.eks_on_device_service

The configuration of EKS Anywhere on the Snow Family device.

Show child fields
sub_job_metadata[].on_device_service_configuration.eks_on_device_service.eks_anywhere_version

The optional version of EKS Anywhere on the Snow Family device.

sub_job_metadata[].on_device_service_configuration.eks_on_device_service.kubernetes_version

The Kubernetes version for EKS Anywhere on the Snow Family device.

sub_job_metadata[].on_device_service_configuration.nfs_on_device_service

Represents the NFS (Network File System) service on a Snow Family device.

Show child fields
sub_job_metadata[].on_device_service_configuration.nfs_on_device_service.storage_limit

The maximum NFS storage for one Snow Family device.

sub_job_metadata[].on_device_service_configuration.nfs_on_device_service.storage_unit

The scale unit of the NFS storage on the device.

Valid values: TB.

sub_job_metadata[].on_device_service_configuration.s3_on_device_service

Configuration for Amazon S3 compatible storage on Snow family devices.

Show child fields
sub_job_metadata[].on_device_service_configuration.s3_on_device_service.fault_tolerance

>Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified StorageLimit matches more than one Amazon S3 compatible storage on Snow family devices service configuration.

sub_job_metadata[].on_device_service_configuration.s3_on_device_service.service_size

Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.

sub_job_metadata[].on_device_service_configuration.s3_on_device_service.storage_limit

If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.

sub_job_metadata[].on_device_service_configuration.s3_on_device_service.storage_unit

Storage unit. Currently the only supported unit is TB.

sub_job_metadata[].on_device_service_configuration.tgw_on_device_service

Represents the Storage Gateway service Tape Gateway type on a Snow Family device.

Show child fields
sub_job_metadata[].on_device_service_configuration.tgw_on_device_service.storage_limit

The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.

sub_job_metadata[].on_device_service_configuration.tgw_on_device_service.storage_unit

The scale unit of the virtual tapes on the device.

sub_job_metadata[].pickup_details

Information identifying the person picking up the device.

Show child fields
sub_job_metadata[].pickup_details.device_pickup_id

The unique ID for a device that will be picked up.

sub_job_metadata[].pickup_details.email

The email address of the person picking up the device.

sub_job_metadata[].pickup_details.identification_expiration_date

Expiration date of the credential identifying the person picking up the device.

sub_job_metadata[].pickup_details.identification_issuing_org

Organization that issued the credential identifying the person picking up the device.

sub_job_metadata[].pickup_details.identification_number

The number on the credential identifying the person picking up the device.

sub_job_metadata[].pickup_details.name

The name of the person picking up the device.

sub_job_metadata[].pickup_details.phone_number

The phone number of the person picking up the device.

sub_job_metadata[].remote_management

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.

sub_job_metadata[].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.

Show child fields
sub_job_metadata[].resources.ec2_ami_resources[]
Show child fields
sub_job_metadata[].resources.ec2_ami_resources[].ami_id

The ID of the AMI in Amazon EC2.

sub_job_metadata[].resources.ec2_ami_resources[].snowball_ami_id

The ID of the AMI on the Snow device.

sub_job_metadata[].resources.lambda_resources[]
Show child fields
sub_job_metadata[].resources.lambda_resources[].event_triggers[]
Show child fields
sub_job_metadata[].resources.lambda_resources[].event_triggers[].event_resource_arn

The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.

sub_job_metadata[].resources.lambda_resources[].lambda_arn

An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.

sub_job_metadata[].resources.s3_resources[]
Show child fields
sub_job_metadata[].resources.s3_resources[].bucket_arn

The Amazon Resource Name (ARN) of an Amazon S3 bucket.

sub_job_metadata[].resources.s3_resources[].key_range

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.

Show child fields
sub_job_metadata[].resources.s3_resources[].key_range.begin_marker

The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

sub_job_metadata[].resources.s3_resources[].key_range.end_marker

The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

sub_job_metadata[].resources.s3_resources[].target_on_device_services[]
Show child fields
sub_job_metadata[].resources.s3_resources[].target_on_device_services[].service_name

Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.

sub_job_metadata[].resources.s3_resources[].target_on_device_services[].transfer_option

Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.

sub_job_metadata[].role_arn

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

sub_job_metadata[].shipping_details

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

Show child fields
sub_job_metadata[].shipping_details.inbound_shipment

The Status and TrackingNumber values for a Snow device being returned to Amazon Web Services for a particular job.

Show child fields
sub_job_metadata[].shipping_details.inbound_shipment.status

Status information for a shipment.

sub_job_metadata[].shipping_details.inbound_shipment.tracking_number

The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snow device as the carrier transports it.

For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.

sub_job_metadata[].shipping_details.outbound_shipment

The Status and TrackingNumber values for a Snow device being delivered to the address that you specified for a particular job.

Show child fields
sub_job_metadata[].shipping_details.outbound_shipment.status

Status information for a shipment.

sub_job_metadata[].shipping_details.outbound_shipment.tracking_number

The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snow device as the carrier transports it.

For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.

sub_job_metadata[].shipping_details.shipping_option

The shipping speed for a particular job. This speed doesn't dictate how soon you'll get the Snow device 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, Snow devices shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snow 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, Snow devices 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.

sub_job_metadata[].snowball_capacity_preference

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.

sub_job_metadata[].snowball_id

Unique ID associated with a device.

sub_job_metadata[].snowball_type

The type of device used with this job.

sub_job_metadata[].tax_documents

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

Show child fields
sub_job_metadata[].tax_documents.ind

The tax documents required in Amazon Web Services Region in India.

Show child fields
sub_job_metadata[].tax_documents.ind.gstin

The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.