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

*****************
ListModelMetadata
*****************



.. py:class:: SageMaker.Paginator.ListModelMetadata

  ::

    
    paginator = client.get_paginator('list_model_metadata')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          SearchExpression={
              'Filters': [
                  {
                      'Name': 'Domain'|'Framework'|'Task'|'FrameworkVersion',
                      'Value': 'string'
                  },
              ]
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type SearchExpression: dict
    :param SearchExpression: 

      One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive.

      

    
      - **Filters** *(list) --* 

        A list of filter objects.

        

      
        - *(dict) --* 

          Part of the search expression. You can specify the name and value (domain, task, framework, framework version, task, and model).

          

        
          - **Name** *(string) --* **[REQUIRED]** 

            The name of the of the model to filter by.

            

          
          - **Value** *(string) --* **[REQUIRED]** 

            The value to filter the model metadata.

            

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

      
      ::

        {
            'ModelMetadataSummaries': [
                {
                    'Domain': 'string',
                    'Framework': 'string',
                    'Task': 'string',
                    'Model': 'string',
                    'FrameworkVersion': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ModelMetadataSummaries** *(list) --* 

          A structure that holds model metadata.

          
          

          - *(dict) --* 

            A summary of the model metadata.

            
            

            - **Domain** *(string) --* 

              The machine learning domain of the model.

              
            

            - **Framework** *(string) --* 

              The machine learning framework of the model.

              
            

            - **Task** *(string) --* 

              The machine learning task of the model.

              
            

            - **Model** *(string) --* 

              The name of the model.

              
            

            - **FrameworkVersion** *(string) --* 

              The framework version of the model.

              
        
      
    