Class: Aws::Glacier::Types::JobParameters

Inherits:

Struct

• Object
• Struct
• Aws::Glacier::Types::JobParameters

Includes:

Structure

Defined in:

lib/aws-sdk-glacier/types.rb

Overview

Provides options for defining a job.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #archive_id ⇒ String

  The ID of the archive that you want to retrieve.

• #description ⇒ String

  The optional description for the job.

• #format ⇒ String

  When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format.

• #inventory_retrieval_parameters ⇒ Types::InventoryRetrievalJobInput

  Input parameters used for range inventory retrieval.

• #output_location ⇒ Types::OutputLocation

  Contains information about the location where the select job results are stored.

• #retrieval_byte_range ⇒ String

  The byte range to retrieve for an archive retrieval.

• #select_parameters ⇒ Types::SelectParameters

  Contains the parameters that define a job.

• #sns_topic ⇒ String

  The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download.

• #tier ⇒ String

  The tier to use for a select or an archive retrieval job.

• #type ⇒ String

  The job type.

Instance Attribute Details

#archive_id ⇒ String

The ID of the archive that you want to retrieve. This field is required only if ‘Type` is set to `select` or `archive-retrieval`code>. An error occurs if you specify this request parameter for an inventory retrieval job request.

Returns:

• (String)

# File 'lib/aws-sdk-glacier/types.rb', line 1433

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

Returns:

• (String)

# File 'lib/aws-sdk-glacier/types.rb', line 1433

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are “CSV” and “JSON”.

Returns:

• (String)

# File 'lib/aws-sdk-glacier/types.rb', line 1433

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#inventory_retrieval_parameters ⇒ Types::InventoryRetrievalJobInput

Input parameters used for range inventory retrieval.

Returns:

• (Types::InventoryRetrievalJobInput)

# File 'lib/aws-sdk-glacier/types.rb', line 1433

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#output_location ⇒ Types::OutputLocation

Contains information about the location where the select job results are stored.

Returns:

• (Types::OutputLocation)

# File 'lib/aws-sdk-glacier/types.rb', line 1433

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#retrieval_byte_range ⇒ String

The byte range to retrieve for an archive retrieval. in the form “StartByteValue-EndByteValue” If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

An error occurs if you specify this field for an inventory retrieval job request.

Returns:

• (String)

# File 'lib/aws-sdk-glacier/types.rb', line 1433

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#select_parameters ⇒ Types::SelectParameters

Contains the parameters that define a job.

Returns:

• (Types::SelectParameters)

# File 'lib/aws-sdk-glacier/types.rb', line 1433

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic ⇒ String

The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

Returns:

• (String)

# File 'lib/aws-sdk-glacier/types.rb', line 1433

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#tier ⇒ String

The tier to use for a select or an archive retrieval job. Valid values are ‘Expedited`, `Standard`, or `Bulk`. `Standard` is the default.

Returns:

• (String)

# File 'lib/aws-sdk-glacier/types.rb', line 1433

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are “select”, “archive-retrieval” and “inventory-retrieval”.

Returns:

• (String)

# File 'lib/aws-sdk-glacier/types.rb', line 1433

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters,
  :select_parameters,
  :output_location)
  SENSITIVE = []
  include Aws::Structure
end