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

Class: Aws::Glacier::Types::InventoryRetrievalJobInput

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 InventoryRetrievalJobInput data as a hash:

{
  start_date: Time.now,
  end_date: Time.now,
  limit: "string",
  marker: "string",
}

Provides options for specifying 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)


1302
1303
1304
1305
1306
1307
1308
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1302

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

#limitString

Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1.

Returns:

  • (String)


1302
1303
1304
1305
1306
1307
1308
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1302

class InventoryRetrievalJobInput < Struct.new(
  :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.

Returns:

  • (String)


1302
1303
1304
1305
1306
1307
1308
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1302

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

#start_dateTime

The start of the date range in 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)


1302
1303
1304
1305
1306
1307
1308
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 1302

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