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

********************
ListResourceCatalogs
********************



.. py:class:: SageMaker.Paginator.ListResourceCatalogs

  ::

    
    paginator = client.get_paginator('list_resource_catalogs')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          NameContains='string',
          CreationTimeAfter=datetime(2015, 1, 1),
          CreationTimeBefore=datetime(2015, 1, 1),
          SortOrder='Ascending'|'Descending',
          SortBy='CreationTime',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type NameContains: string
    :param NameContains: 

      A string that partially matches one or more ``ResourceCatalog``s names. Filters ``ResourceCatalog`` by name.

      

    
    :type CreationTimeAfter: datetime
    :param CreationTimeAfter: 

      Use this parameter to search for ``ResourceCatalog``s created after a specific date and time.

      

    
    :type CreationTimeBefore: datetime
    :param CreationTimeBefore: 

      Use this parameter to search for ``ResourceCatalog``s created before a specific date and time.

      

    
    :type SortOrder: string
    :param SortOrder: 

      The order in which the resource catalogs are listed.

      

    
    :type SortBy: string
    :param SortBy: 

      The value on which the resource catalog list is sorted.

      

    
    :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**

      
      ::

        {
            'ResourceCatalogs': [
                {
                    'ResourceCatalogArn': 'string',
                    'ResourceCatalogName': 'string',
                    'Description': 'string',
                    'CreationTime': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ResourceCatalogs** *(list) --* 

          A list of the requested ``ResourceCatalog``s.

          
          

          - *(dict) --* 

            A resource catalog containing all of the resources of a specific resource type within a resource owner account. For an example on sharing the Amazon SageMaker Feature Store ``DefaultFeatureGroupCatalog``, see `Share Amazon SageMaker Catalog resource type <https://docs.aws.amazon.com/sagemaker/latest/APIReference/feature-store-cross-account-discoverability-share-sagemaker-catalog.html>`__ in the Amazon SageMaker Developer Guide.

            
            

            - **ResourceCatalogArn** *(string) --* 

              The Amazon Resource Name (ARN) of the ``ResourceCatalog``.

              
            

            - **ResourceCatalogName** *(string) --* 

              The name of the ``ResourceCatalog``.

              
            

            - **Description** *(string) --* 

              A free form description of the ``ResourceCatalog``.

              
            

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

              The time the ``ResourceCatalog`` was created.

              
        
      
    