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

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

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

Overview

Note:

When making an API call, you may pass JobParameters data as a hash:

{
  format: "string",
  type: "string",
  archive_id: "string",
  description: "string",
  sns_topic: "string",
  retrieval_byte_range: "string",
  tier: "string",
  inventory_retrieval_parameters: {
    start_date: Time.now,
    end_date: Time.now,
    limit: "string",
    marker: "string",
  },
}

Provides options for defining a job.

Instance Attribute Summary collapse

Instance Attribute Details

#archive_idString

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

Returns:

  • (String)


1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1389

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters)
  include Aws::Structure
end

#descriptionString

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)


1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1389

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters)
  include Aws::Structure
end

#formatString

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)


1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1389

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters)
  include Aws::Structure
end

#inventory_retrieval_parametersTypes::InventoryRetrievalJobInput

Input parameters used for range inventory retrieval.



1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1389

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters)
  include Aws::Structure
end

#retrieval_byte_rangeString

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 (10241024) 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)


1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1389

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters)
  include Aws::Structure
end

#sns_topicString

The Amazon SNS topic ARN to which Amazon 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)


1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1389

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters)
  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)


1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1389

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters)
  include Aws::Structure
end

#typeString

The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are "archive-retrieval" and "inventory-retrieval".

Returns:

  • (String)


1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1389

class JobParameters < Struct.new(
  :format,
  :type,
  :archive_id,
  :description,
  :sns_topic,
  :retrieval_byte_range,
  :tier,
  :inventory_retrieval_parameters)
  include Aws::Structure
end