list_schedules

EventBridgeScheduler.Client.list_schedules(**kwargs)

Returns a paginated list of your EventBridge Scheduler schedules.

See also: AWS API Documentation

Request Syntax

response = client.list_schedules(
    GroupName='string',
    MaxResults=123,
    NamePrefix='string',
    NextToken='string',
    State='ENABLED'|'DISABLED'
)

Parameters

• GroupName (string) -- If specified, only lists the schedules whose associated schedule group matches the given filter.
• MaxResults (integer) -- 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.
• NamePrefix (string) -- Schedule name prefix to return the filtered list of resources.
• NextToken (string) -- The token returned by a previous call to retrieve the next set of results.
• State (string) -- If specified, only lists the schedules whose current state matches the given filter.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    '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) --

  • NextToken (string) --

    Indicates whether there are additional results to retrieve. If the value is null, there are no more results.

  • 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.

Exceptions

• EventBridgeScheduler.Client.exceptions.ValidationException
• EventBridgeScheduler.Client.exceptions.InternalServerException
• EventBridgeScheduler.Client.exceptions.ResourceNotFoundException
• EventBridgeScheduler.Client.exceptions.ThrottlingException