Class: Aws::Snowball::Types::JobMetadata
- Inherits:
-
Struct
- Object
- Struct
- Aws::Snowball::Types::JobMetadata
- Defined in:
- gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb
Overview
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#address_id ⇒ String
The ID for the address that you want the Snow device shipped to.
-
#cluster_id ⇒ String
The 39-character ID for the cluster, for example
CID123e4567-e89b-12d3-a456-426655440000
. -
#creation_date ⇒ Time
The creation date for this job.
-
#data_transfer_progress ⇒ Types::DataTransfer
A value that defines the real-time status of a Snow device's data transfer while the device is at AWS.
-
#description ⇒ String
The description of the job, provided at job creation.
-
#device_configuration ⇒ Types::DeviceConfiguration
The container for
SnowconeDeviceConfiguration
. -
#forwarding_address_id ⇒ String
The ID of the address that you want a job shipped to, after it will be shipped to its primary address.
-
#job_id ⇒ String
The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
. -
#job_log_info ⇒ Types::JobLogs
Links to Amazon S3 presigned URLs for the job report and logs.
-
#job_state ⇒ String
The current status of the jobs.
-
#job_type ⇒ String
The type of job.
-
#kms_key_arn ⇒ String
The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job.
-
#notification ⇒ Types::Notification
The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job.
-
#resources ⇒ Types::JobResource
An array of
S3Resource
objects. -
#role_arn ⇒ String
The role ARN associated with this job.
-
#shipping_details ⇒ Types::ShippingDetails
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
-
#snowball_capacity_preference ⇒ String
The Snow device capacity preference for this job, specified at job creation.
-
#snowball_type ⇒ String
The type of device used with this job.
-
#tax_documents ⇒ Types::TaxDocuments
The metadata associated with the tax documents required in your AWS Region.
Instance Attribute Details
#address_id ⇒ String
The ID for the address that you want the Snow device shipped to.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#cluster_id ⇒ String
The 39-character ID for the cluster, for example
CID123e4567-e89b-12d3-a456-426655440000
.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#creation_date ⇒ Time
The creation date for this job.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#data_transfer_progress ⇒ Types::DataTransfer
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.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description of the job, provided at job creation.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#device_configuration ⇒ Types::DeviceConfiguration
The container for SnowconeDeviceConfiguration
.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#forwarding_address_id ⇒ String
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.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#job_id ⇒ String
The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#job_log_info ⇒ Types::JobLogs
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.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#job_state ⇒ String
The current status of the jobs.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#job_type ⇒ String
The type of job.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#kms_key_arn ⇒ String
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.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#notification ⇒ Types::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.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#resources ⇒ Types::JobResource
An array of S3Resource
objects. Each S3Resource
object
represents an Amazon S3 bucket that your transferred data will be
exported from or imported into.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#shipping_details ⇒ Types::ShippingDetails
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#snowball_capacity_preference ⇒ String
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.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#snowball_type ⇒ String
The type of device used with this job.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |
#tax_documents ⇒ Types::TaxDocuments
The metadata associated with the tax documents required in your AWS Region.
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1618 class JobMetadata < Struct.new( :job_id, :job_state, :job_type, :snowball_type, :creation_date, :resources, :description, :kms_key_arn, :role_arn, :address_id, :shipping_details, :snowball_capacity_preference, :notification, :data_transfer_progress, :job_log_info, :cluster_id, :forwarding_address_id, :tax_documents, :device_configuration) SENSITIVE = [] include Aws::Structure end |