:doc:`SageMaker <../../sagemaker>` / Paginator / ListClusterSchedulerConfigs

***************************
ListClusterSchedulerConfigs
***************************



.. py:class:: SageMaker.Paginator.ListClusterSchedulerConfigs

  ::

    
    paginator = client.get_paginator('list_cluster_scheduler_configs')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SageMaker.Client.list_cluster_scheduler_configs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListClusterSchedulerConfigs>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          CreatedAfter=datetime(2015, 1, 1),
          CreatedBefore=datetime(2015, 1, 1),
          NameContains='string',
          ClusterArn='string',
          Status='Creating'|'CreateFailed'|'CreateRollbackFailed'|'Created'|'Updating'|'UpdateFailed'|'UpdateRollbackFailed'|'Updated'|'Deleting'|'DeleteFailed'|'DeleteRollbackFailed'|'Deleted',
          SortBy='Name'|'CreationTime'|'Status',
          SortOrder='Ascending'|'Descending',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type CreatedAfter: datetime
    :param CreatedAfter: 

      Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see `EpochConverter <https://www.epochconverter.com/>`__.

      

    
    :type CreatedBefore: datetime
    :param CreatedBefore: 

      Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see `EpochConverter <https://www.epochconverter.com/>`__.

      

    
    :type NameContains: string
    :param NameContains: 

      Filter for name containing this string.

      

    
    :type ClusterArn: string
    :param ClusterArn: 

      Filter for ARN of the cluster.

      

    
    :type Status: string
    :param Status: 

      Filter for status.

      

    
    :type SortBy: string
    :param SortBy: 

      Filter for sorting the list by a given value. For example, sort by name, creation time, or status.

      

    
    :type SortOrder: string
    :param SortOrder: 

      The order of the list. By default, listed in ``Descending`` order according to by ``SortBy``. To change the list order, you can specify ``SortOrder`` to be ``Ascending``.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'ClusterSchedulerConfigSummaries': [
                {
                    'ClusterSchedulerConfigArn': 'string',
                    'ClusterSchedulerConfigId': 'string',
                    'ClusterSchedulerConfigVersion': 123,
                    'Name': 'string',
                    'CreationTime': datetime(2015, 1, 1),
                    'LastModifiedTime': datetime(2015, 1, 1),
                    'Status': 'Creating'|'CreateFailed'|'CreateRollbackFailed'|'Created'|'Updating'|'UpdateFailed'|'UpdateRollbackFailed'|'Updated'|'Deleting'|'DeleteFailed'|'DeleteRollbackFailed'|'Deleted',
                    'ClusterArn': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ClusterSchedulerConfigSummaries** *(list) --* 

          Summaries of the cluster policies.

          
          

          - *(dict) --* 

            Summary of the cluster policy.

            
            

            - **ClusterSchedulerConfigArn** *(string) --* 

              ARN of the cluster policy.

              
            

            - **ClusterSchedulerConfigId** *(string) --* 

              ID of the cluster policy.

              
            

            - **ClusterSchedulerConfigVersion** *(integer) --* 

              Version of the cluster policy.

              
            

            - **Name** *(string) --* 

              Name of the cluster policy.

              
            

            - **CreationTime** *(datetime) --* 

              Creation time of the cluster policy.

              
            

            - **LastModifiedTime** *(datetime) --* 

              Last modified time of the cluster policy.

              
            

            - **Status** *(string) --* 

              Status of the cluster policy.

              
            

            - **ClusterArn** *(string) --* 

              ARN of the cluster.

              
        
      
    