EventBridgeScheduler / Paginator / ListSchedules

ListSchedules

class EventBridgeScheduler.Paginator.ListSchedules

paginator = client.get_paginator('list_schedules')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EventBridgeScheduler.Client.list_schedules().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GroupName='string',
    NamePrefix='string',
    State='ENABLED'|'DISABLED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• GroupName (string) – If specified, only lists the schedules whose associated schedule group matches the given filter.

• NamePrefix (string) – Schedule name prefix to return the filtered list of resources.

• State (string) – If specified, only lists the schedules whose current state matches the given filter.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Schedules': [
        {
            'Arn': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'GroupName': 'string',
            'LastModificationDate': datetime(2015, 1, 1),
            'Name': 'string',
            'State': 'ENABLED'|'DISABLED',
            'Target': {
                'Arn': 'string'
            }
        },
    ]
}

Response Structure

• (dict) –

  • Schedules (list) –

    The schedules that match the specified criteria.

    • (dict) –

      The details of a schedule.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the schedule.

      • CreationDate (datetime) –

        The time at which the schedule was created.

      • GroupName (string) –

        The name of the schedule group associated with this schedule.

      • LastModificationDate (datetime) –

        The time at which the schedule was last modified.

      • Name (string) –

        The name of the schedule.

      • State (string) –

        Specifies whether the schedule is enabled or disabled.

      • Target (dict) –

        The schedule’s target details.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the target.