:doc:`EventBridgeScheduler <../../scheduler>` / Client / list_schedule_groups

********************
list_schedule_groups
********************



.. py:method:: EventBridgeScheduler.Client.list_schedule_groups(**kwargs)

  

  Returns a paginated list of your schedule groups.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/ListScheduleGroups>`_  


  **Request Syntax**
  ::

    response = client.list_schedule_groups(
        MaxResults=123,
        NamePrefix='string',
        NextToken='string'
    )
    
  :type MaxResults: integer
  :param 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.

    

  
  :type NamePrefix: string
  :param NamePrefix: 

    The name prefix that you can use to return a filtered list of your schedule groups.

    

  
  :type NextToken: string
  :param NextToken: 

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

    

  
  
  :rtype: 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**
  
  *   :py:class:`EventBridgeScheduler.Client.exceptions.ValidationException`

  
  *   :py:class:`EventBridgeScheduler.Client.exceptions.InternalServerException`

  
  *   :py:class:`EventBridgeScheduler.Client.exceptions.ThrottlingException`

  