Skip to content

ListSchedulesInput

Source code in docs_src/capo_scheduler/types/list_schedules_input.py
class ListSchedulesInput(TypedDict, closed=True):
    group_name: NotRequired[
        "capo_scheduler.types.schedule_group_name.ScheduleGroupName"
    ]
    """<p>If specified, only lists the schedules whose associated schedule group matches the given filter.</p>"""
    name_prefix: NotRequired["capo_scheduler.types.name_prefix.NamePrefix"]
    """<p>Schedule name prefix to return the filtered list of resources.</p>"""
    state: NotRequired["capo_scheduler.types.schedule_state.ScheduleState"]
    """<p>If specified, only lists the schedules whose current state matches the given filter.</p>"""
    next_token: NotRequired["capo_scheduler.types.next_token.NextToken"]
    """<p>The token returned by a previous call to retrieve the next set of results.</p>"""
    max_results: NotRequired["capo_scheduler.types.max_results.MaxResults"]
    """<p>If specified, limits the number of results returned by this operation. The operation also returns a <code>NextToken</code> which you can use in a subsequent operation to retrieve the next set of results.</p>"""

group_name instance-attribute

group_name: NotRequired[ScheduleGroupName]

If specified, only lists the schedules whose associated schedule group matches the given filter.

max_results instance-attribute

max_results: NotRequired[MaxResults]

If specified, limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

name_prefix instance-attribute

name_prefix: NotRequired[NamePrefix]

Schedule name prefix to return the filtered list of resources.

next_token instance-attribute

next_token: NotRequired[NextToken]

The token returned by a previous call to retrieve the next set of results.

state instance-attribute

state: NotRequired[ScheduleState]

If specified, only lists the schedules whose current state matches the given filter.