Skip to content

InventoryRetrievalJobDescription

Source code in docs_src/capo_glacier/types/inventory_retrieval_job_description.py 
12
13
14
15
16
17
18
19
20
21
22
class InventoryRetrievalJobDescription(TypedDict, closed=True):
    format: NotRequired["capo_glacier.types.string.string"]
    """<p>The output format for the vault inventory list, which is set by the <b>InitiateJob</b> request when initiating a job to retrieve a vault inventory. Valid values are <code>CSV</code> and <code>JSON</code>.</p>"""
    start_date: NotRequired["capo_glacier.types.date_time.DateTime"]
    """<p>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 <code>2013-03-20T17:03:43Z</code>.</p>"""
    end_date: NotRequired["capo_glacier.types.date_time.DateTime"]
    """<p>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 <code>2013-03-20T17:03:43Z</code>.</p>"""
    limit: NotRequired["capo_glacier.types.string.string"]
    """<p>The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a <b>InitiateJob</b> request. </p>"""
    marker: NotRequired["capo_glacier.types.string.string"]
    """<p>An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new <b>InitiateJob</b> request to obtain additional inventory items. If there are no more inventory items, this value is <code>null</code>. For more information, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html#api-initiate-job-post-vault-inventory-list-filtering"> Range Inventory Retrieval</a>.</p>"""

end_date instance-attribute 

end_date: NotRequired[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.

format instance-attribute 

format: NotRequired[string]

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 instance-attribute 

limit: NotRequired[string]

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 instance-attribute 

marker: NotRequired[string]

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.

start_date instance-attribute 

start_date: NotRequired[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.