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

Instance Attribute Details

#address_idString

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

Returns:

  • (String)


1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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_idString

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

Returns:

  • (String)


1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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_dateTime

The creation date for this job.

Returns:

  • (Time)


1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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_progressTypes::DataTransfer

A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

Returns:



1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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

#descriptionString

The description of the job, provided at job creation.

Returns:

  • (String)


1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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


1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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_idString

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

Returns:

  • (String)


1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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

Returns:



1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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_stateString

The current status of the jobs.

Returns:

  • (String)


1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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_typeString

The type of job.

Returns:

  • (String)


1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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_arnString

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)


1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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

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



1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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

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



1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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_arnString

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)


1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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_detailsTypes::ShippingDetails

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



1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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_preferenceString

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)


1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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_typeString

The type of appliance used with this job.

Returns:

  • (String)


1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 1152

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