Skip to content

ListJobsRequest

Source code in docs_src/capo_s3_control/types/list_jobs_request.py
class ListJobsRequest(TypedDict, closed=True):
    account_id: "capo_s3_control.types.account_id.AccountId"
    """<p>The Amazon Web Services account ID associated with the S3 Batch Operations job.</p>"""
    job_statuses: NotRequired["capo_s3_control.types.job_status_list.JobStatusList"]
    """<p>The <code>List Jobs</code> request returns jobs that match the statuses listed in this element.</p>"""
    next_token: NotRequired[
        "capo_s3_control.types.string_for_next_token.StringForNextToken"
    ]
    """<p>A pagination token to request the next page of results. Use the token that Amazon S3 returned in the <code>NextToken</code> element of the <code>ListJobsResult</code> from the previous <code>List Jobs</code> request.</p>"""
    max_results: NotRequired["capo_s3_control.types.max_results.MaxResults"]
    """<p>The maximum number of jobs that Amazon S3 will include in the <code>List Jobs</code> response. If there are more jobs than this number, the response will include a pagination token in the <code>NextToken</code> field to enable you to retrieve the next page of results.</p>"""

account_id instance-attribute

account_id: AccountId

The Amazon Web Services account ID associated with the S3 Batch Operations job.

job_statuses instance-attribute

job_statuses: NotRequired[JobStatusList]

The List Jobs request returns jobs that match the statuses listed in this element.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

next_token instance-attribute

next_token: NotRequired[StringForNextToken]

A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.