Skip to content

ListJobsInput

Source code in docs_src/capo_glacier/types/list_jobs_input.py
class ListJobsInput(TypedDict, closed=True):
    account_id: "capo_glacier.types.string.string"
    """<p>The <code>AccountId</code> value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. </p>"""
    vault_name: "capo_glacier.types.string.string"
    """<p>The name of the vault.</p>"""
    limit: NotRequired["int"]
    """<p>The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.</p>"""
    marker: NotRequired["capo_glacier.types.string.string"]
    """<p>An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.</p>"""
    statuscode: NotRequired["capo_glacier.types.string.string"]
    """<p>The type of job status to return. You can specify the following values: <code>InProgress</code>, <code>Succeeded</code>, or <code>Failed</code>.</p>"""
    completed: NotRequired["capo_glacier.types.string.string"]
    """<p>The state of the jobs to return. You can specify <code>true</code> or <code>false</code>.</p>"""

account_id instance-attribute

account_id: string

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

completed instance-attribute

completed: NotRequired[string]

The state of the jobs to return. You can specify true or false.

limit instance-attribute

limit: NotRequired[int]

The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

marker instance-attribute

marker: NotRequired[string]

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.

statuscode instance-attribute

statuscode: NotRequired[string]

The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed.

vault_name instance-attribute

vault_name: string

The name of the vault.