EventBridgeScheduler / Client / list_schedule_groups

list_schedule_groups#

EventBridgeScheduler.Client.list_schedule_groups(**kwargs)#

Returns a paginated list of your schedule groups.

Request Syntax

response = client.list_schedule_groups(
    MaxResults=123,
    NamePrefix='string',
    NextToken='string'
)

Parameters:

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) – The name prefix that you can use to return a filtered list of your schedule groups.
NextToken (string) – The token returned by a previous call to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'ScheduleGroups': [
        {
            'Arn': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'LastModificationDate': datetime(2015, 1, 1),
            'Name': 'string',
            'State': 'ACTIVE'|'DELETING'
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  Indicates whether there are additional results to retrieve. If the value is null, there are no more results.
- 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.

Exceptions

EventBridgeScheduler.Client.exceptions.ValidationException
EventBridgeScheduler.Client.exceptions.InternalServerException
EventBridgeScheduler.Client.exceptions.ThrottlingException