EventBridgeScheduler / Paginator / ListScheduleGroups
ListScheduleGroups#
- class EventBridgeScheduler.Paginator.ListScheduleGroups#
paginator = client.get_paginator('list_schedule_groups')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
EventBridgeScheduler.Client.list_schedule_groups()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( NamePrefix='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
NamePrefix (string) – The name prefix that you can use to return a filtered list of your schedule groups.
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
{ 'ScheduleGroups': [ { 'Arn': 'string', 'CreationDate': datetime(2015, 1, 1), 'LastModificationDate': datetime(2015, 1, 1), 'Name': 'string', 'State': 'ACTIVE'|'DELETING' }, ] }
Response Structure
(dict) –
ScheduleGroups (list) –
The schedule groups that match the specified criteria.
(dict) –
The details of a schedule group.
Arn (string) –
The Amazon Resource Name (ARN) of the schedule group.
CreationDate (datetime) –
The time at which the schedule group was created.
LastModificationDate (datetime) –
The time at which the schedule group was last modified.
Name (string) –
The name of the schedule group.
State (string) –
Specifies the state of the schedule group.