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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 Amazon Web Services.

• #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 Key Management Service (KMS) key associated with this job.

• #long_term_pricing_id ⇒ String

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

• #notification ⇒ Types::Notification

  The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job.

• #on_device_service_configuration ⇒ Types::OnDeviceServiceConfiguration

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

• #remote_management ⇒ String

  Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network.

• #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 Amazon Web Services Region.

Instance Attribute Details

#address_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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_date ⇒ Time

The creation date for this job.

Returns:

• (Time)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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_progress ⇒ Types::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:

• (Types::DataTransfer)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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

#description ⇒ String

The description of the job, provided at job creation.

Returns:

• (String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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_configuration ⇒ Types::DeviceConfiguration

The container for SnowconeDeviceConfiguration.

Returns:

• (Types::DeviceConfiguration)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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

Returns:

• (String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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

Returns:

• (Types::JobLogs)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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_state ⇒ String

The current status of the jobs.

Returns:

• (String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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_type ⇒ String

The type of job.

Returns:

• (String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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_arn ⇒ String

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)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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

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

Returns:

• (Types::Notification)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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_configuration ⇒ Types::OnDeviceServiceConfiguration

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

Returns:

• (Types::OnDeviceServiceConfiguration)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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_management ⇒ String

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)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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

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

Returns:

• (Types::JobResource)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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_details ⇒ Types::ShippingDetails

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

Returns:

• (Types::ShippingDetails)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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

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)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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_type ⇒ String

The type of device used with this job.

Returns:

• (String)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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_documents ⇒ Types::TaxDocuments

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

Returns:

• (Types::TaxDocuments)

# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1807

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