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

Class: Aws::Glacier::Types::InventoryRetrievalJobDescription

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

Overview

Describes the options for a range inventory retrieval job.

Instance Attribute Summary collapse

Instance Attribute Details

#end_dateTime

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Returns:

  • (Time)


1564
1565
1566
1567
1568
1569
1570
1571
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1564

class InventoryRetrievalJobDescription < Struct.new(
  :format,
  :start_date,
  :end_date,
  :limit,
  :marker)
  include Aws::Structure
end

#formatString

The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.

Returns:

  • (String)


1564
1565
1566
1567
1568
1569
1570
1571
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1564

class InventoryRetrievalJobDescription < Struct.new(
  :format,
  :start_date,
  :end_date,
  :limit,
  :marker)
  include Aws::Structure
end

#limitString

The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

Returns:

  • (String)


1564
1565
1566
1567
1568
1569
1570
1571
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1564

class InventoryRetrievalJobDescription < Struct.new(
  :format,
  :start_date,
  :end_date,
  :limit,
  :marker)
  include Aws::Structure
end

#markerString

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.

Returns:

  • (String)


1564
1565
1566
1567
1568
1569
1570
1571
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1564

class InventoryRetrievalJobDescription < Struct.new(
  :format,
  :start_date,
  :end_date,
  :limit,
  :marker)
  include Aws::Structure
end

#start_dateTime

The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

Returns:

  • (Time)


1564
1565
1566
1567
1568
1569
1570
1571
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1564

class InventoryRetrievalJobDescription < Struct.new(
  :format,
  :start_date,
  :end_date,
  :limit,
  :marker)
  include Aws::Structure
end