Skip to content

ListJobsInput

Source code in docs_src/capo_endusermessaging/types/list_jobs_input.py
class ListJobsInput(TypedDict, closed=True):
    max_results: NotRequired["capo_endusermessaging.types.max_results.MaxResults"]
    """<p>The maximum number of results to return per page.</p>"""
    next_token: NotRequired["capo_endusermessaging.types.next_token.NextToken"]
    """<p>The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.</p>"""
    status: NotRequired["capo_endusermessaging.types.job_status.JobStatus"]
    """<p>Filters the results to jobs that have the specified status.</p>"""
    brand_profile_id: NotRequired[
        "capo_endusermessaging.types.brand_profile_id_or_arn.BrandProfileIdOrArn"
    ]
    """<p>Filters the results to jobs for the specified brand profile.</p>"""
    operation_type: NotRequired[
        "capo_endusermessaging.types.job_operation_type.JobOperationType"
    ]
    """<p>Filters the results to jobs of the specified operation type.</p>"""

brand_profile_id instance-attribute

brand_profile_id: NotRequired[BrandProfileIdOrArn]

Filters the results to jobs for the specified brand profile.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of results to return per page.

next_token instance-attribute

next_token: NotRequired[NextToken]

The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.

operation_type instance-attribute

operation_type: NotRequired[JobOperationType]

Filters the results to jobs of the specified operation type.

status instance-attribute

status: NotRequired[JobStatus]

Filters the results to jobs that have the specified status.