You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:

Struct

Object
Struct
Aws::Snowball::Types::JobMetadata

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.

Instance Attribute Summary collapse

#address_id ⇒ String
The ID for the address that you want the Snowball 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 Snowball's data transfer while the device is at AWS.
#description ⇒ String
The description of the job, provided at job creation.
#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 Snowball capacity preference for this job, specified at job creation.
#snowball_type ⇒ String
The type of device used with this job.

Instance Attribute Details

#address_id ⇒ `String`

The ID for the address that you want the Snowball shipped to.

Returns:

(String)

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

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)
  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 1346

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)
  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 1346

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)
  include Aws::Structure
end

#data_transfer_progress ⇒ `Types::DataTransfer`

A value that defines the real-time status of a Snowball'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.

Returns:

(Types::DataTransfer)

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

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)
  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 1346

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)
  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 1346

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)
  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 1346

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)
  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 Snowball for your job part is being delivered to you.

Returns:

(Types::JobLogs)

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

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)
  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 1346

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)
  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 1346

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

Returns:

(String)

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

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)
  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 1346

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)
  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 1346

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

Returns:

(String)

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

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)
  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 1346

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)
  include Aws::Structure
end

#snowball_capacity_preference ⇒ `String`

The Snowball 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.

Returns:

(String)

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

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)
  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 1346

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)
  include Aws::Structure
end

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#address_id ⇒ String

#cluster_id ⇒ String

#creation_date ⇒ Time

#data_transfer_progress ⇒ Types::DataTransfer

#description ⇒ String

#forwarding_address_id ⇒ String

#job_id ⇒ String

#job_log_info ⇒ Types::JobLogs

#job_state ⇒ String

#job_type ⇒ String

#kms_key_arn ⇒ String

#notification ⇒ Types::Notification

#resources ⇒ Types::JobResource

#role_arn ⇒ String

#shipping_details ⇒ Types::ShippingDetails

#snowball_capacity_preference ⇒ String

#snowball_type ⇒ String

#address_id ⇒ `String`

#cluster_id ⇒ `String`

#creation_date ⇒ `Time`

#data_transfer_progress ⇒ `Types::DataTransfer`

#description ⇒ `String`

#forwarding_address_id ⇒ `String`

#job_id ⇒ `String`

#job_log_info ⇒ `Types::JobLogs`

#job_state ⇒ `String`

#job_type ⇒ `String`

#kms_key_arn ⇒ `String`

#notification ⇒ `Types::Notification`

#resources ⇒ `Types::JobResource`

#role_arn ⇒ `String`

#shipping_details ⇒ `Types::ShippingDetails`

#snowball_capacity_preference ⇒ `String`

#snowball_type ⇒ `String`