Class: Aws::Snowball::Types::JobMetadata

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

#address_idString

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

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_idString

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

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#creation_dateTime

The creation date for this job.

Returns:

  • (Time)


1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#data_transfer_progressTypes::DataTransfer

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.

Returns:



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the job, provided at job creation.

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#device_configurationTypes::DeviceConfiguration

The container for SnowconeDeviceConfiguration.



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#forwarding_address_idString

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.

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#job_idString

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

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#job_log_infoTypes::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.

Returns:



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#job_stateString

The current status of the jobs.

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#job_typeString

The type of job.

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arnString

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.

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#long_term_pricing_idString

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

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#notificationTypes::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.

Returns:



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#on_device_service_configurationTypes::OnDeviceServiceConfiguration

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



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#remote_managementString

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.

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#resourcesTypes::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.

Returns:



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#shipping_detailsTypes::ShippingDetails

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



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#snowball_capacity_preferenceString

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.

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#snowball_typeString

The type of device used with this job.

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tax_documentsTypes::TaxDocuments

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

Returns:



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1805

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,
  :remote_management,
  :long_term_pricing_id,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end