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

Class: Aws::Glacier::Types::GlacierJobDescription

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb

Overview

Contains the description of an Amazon Glacier job.

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.

Returns:

  • (String)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#archive_idString

The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.

Returns:

  • (String)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#archive_sha256_tree_hashString

The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.

Returns:

  • (String)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#archive_size_in_bytesInteger

For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.

Returns:

  • (Integer)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#completedBoolean

The job status. When a job is completed, you get the job's output using Get Job Output (GET output).

Returns:

  • (Boolean)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#completion_dateTime

The UTC time that the job request completed. While the job is in progress, the value is null.

Returns:

  • (Time)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#creation_dateTime

The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example "2012-03-20T17:03:43.221Z".

Returns:

  • (Time)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#inventory_retrieval_parametersTypes::InventoryRetrievalJobDescription

Parameters used for range inventory retrieval.



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#inventory_size_in_bytesInteger

For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.

Returns:

  • (Integer)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#job_descriptionString

The job description provided when initiating the job.

Returns:

  • (String)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#job_idString

An opaque string that identifies an Amazon Glacier job.

Returns:

  • (String)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#job_output_pathString

Contains the job output location.

Returns:

  • (String)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#output_locationTypes::OutputLocation

Contains the location where the data from the select job is stored.



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#retrieval_byte_rangeString

The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. If no range was specified in the archive retrieval, then the whole archive is retrieved. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.

Returns:

  • (String)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#select_parametersTypes::SelectParameters

Contains the parameters that define a select job.



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#sha256_tree_hashString

For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.

The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.

If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

This field is null for the following:

  • Archive retrieval jobs that specify a range that is not tree-hash aligned

^ ^

  • Archival jobs that specify a range that is equal to the whole archive, when the job status is InProgress

^ ^

  • Inventory jobs

  • Select jobs

Returns:

  • (String)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#sns_topicString

An Amazon SNS topic that receives notification.

Returns:

  • (String)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#status_codeString

The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

Returns:

  • (String)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#status_messageString

A friendly message that describes the job status.

Returns:

  • (String)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#tierString

The retrieval option to use for the archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

Returns:

  • (String)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end

#vault_arnString

The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

Returns:

  • (String)


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1162

class GlacierJobDescription < Struct.new(
  :job_id,
  :job_description,
  :action,
  :archive_id,
  :vault_arn,
  :creation_date,
  :completed,
  :status_code,
  :status_message,
  :archive_size_in_bytes,
  :inventory_size_in_bytes,
  :sns_topic,
  :completion_date,
  :sha256_tree_hash,
  :archive_sha256_tree_hash,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :job_output_path,
  :select_parameters,
  :output_location)
  include Aws::Structure
end