Amazonka.Glacier.Types.InventoryRetrievalJobDescription

Documentation

data InventoryRetrievalJobDescription

Describes the options for a range inventory retrieval job.

See: newInventoryRetrievalJobDescription smart constructor.

Constructors

InventoryRetrievalJobDescription'

Fields

• endDate :: Maybe Text

  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.

• format :: Maybe Text

  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.

• limit :: Maybe Text

  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.

• marker :: Maybe Text

  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.

• startDate :: Maybe Text

  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.

Instances

FromJSON InventoryRetrievalJobDescription

Defined in Amazonka.Glacier.Types.InventoryRetrievalJobDescription

Methods

parseJSON :: Value -> Parser InventoryRetrievalJobDescription

parseJSONList :: Value -> Parser [InventoryRetrievalJobDescription]

Generic InventoryRetrievalJobDescription

Defined in Amazonka.Glacier.Types.InventoryRetrievalJobDescription

Associated Types

type Rep InventoryRetrievalJobDescription :: Type -> Type

Methods

from :: InventoryRetrievalJobDescription -> Rep InventoryRetrievalJobDescription x

to :: Rep InventoryRetrievalJobDescription x -> InventoryRetrievalJobDescription

Read InventoryRetrievalJobDescription

Defined in Amazonka.Glacier.Types.InventoryRetrievalJobDescription

Methods

readsPrec :: Int -> ReadS InventoryRetrievalJobDescription

readList :: ReadS [InventoryRetrievalJobDescription]

readPrec :: ReadPrec InventoryRetrievalJobDescription

readListPrec :: ReadPrec [InventoryRetrievalJobDescription]

Show InventoryRetrievalJobDescription

Defined in Amazonka.Glacier.Types.InventoryRetrievalJobDescription

Methods

showsPrec :: Int -> InventoryRetrievalJobDescription -> ShowS

show :: InventoryRetrievalJobDescription -> String

showList :: [InventoryRetrievalJobDescription] -> ShowS

NFData InventoryRetrievalJobDescription

Defined in Amazonka.Glacier.Types.InventoryRetrievalJobDescription

Methods

rnf :: InventoryRetrievalJobDescription -> ()

Eq InventoryRetrievalJobDescription

Defined in Amazonka.Glacier.Types.InventoryRetrievalJobDescription

Methods

(==) :: InventoryRetrievalJobDescription -> InventoryRetrievalJobDescription -> Bool

(/=) :: InventoryRetrievalJobDescription -> InventoryRetrievalJobDescription -> Bool

Hashable InventoryRetrievalJobDescription

Defined in Amazonka.Glacier.Types.InventoryRetrievalJobDescription

Methods

hashWithSalt :: Int -> InventoryRetrievalJobDescription -> Int

hash :: InventoryRetrievalJobDescription -> Int

type Rep InventoryRetrievalJobDescription

Defined in Amazonka.Glacier.Types.InventoryRetrievalJobDescription

type Rep InventoryRetrievalJobDescription = D1 ('MetaData "InventoryRetrievalJobDescription" "Amazonka.Glacier.Types.InventoryRetrievalJobDescription" "amazonka-glacier-2.0-17Kmjv8nUJeKOtbrjLyy76" 'False) (C1 ('MetaCons "InventoryRetrievalJobDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newInventoryRetrievalJobDescription :: InventoryRetrievalJobDescription

Create a value of InventoryRetrievalJobDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endDate:InventoryRetrievalJobDescription', inventoryRetrievalJobDescription_endDate - 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.

$sel:format:InventoryRetrievalJobDescription', inventoryRetrievalJobDescription_format - 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.

$sel:limit:InventoryRetrievalJobDescription', inventoryRetrievalJobDescription_limit - 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.

$sel:marker:InventoryRetrievalJobDescription', inventoryRetrievalJobDescription_marker - 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.

$sel:startDate:InventoryRetrievalJobDescription', inventoryRetrievalJobDescription_startDate - 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.

inventoryRetrievalJobDescription_endDate :: Lens' InventoryRetrievalJobDescription (Maybe Text)

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.

inventoryRetrievalJobDescription_format :: Lens' InventoryRetrievalJobDescription (Maybe Text)

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.

inventoryRetrievalJobDescription_limit :: Lens' InventoryRetrievalJobDescription (Maybe Text)

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.

inventoryRetrievalJobDescription_marker :: Lens' InventoryRetrievalJobDescription (Maybe Text)

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.

inventoryRetrievalJobDescription_startDate :: Lens' InventoryRetrievalJobDescription (Maybe Text)

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.