:doc:`SageMaker <../../sagemaker>` / Client / list_model_cards

****************
list_model_cards
****************



.. py:method:: SageMaker.Client.list_model_cards(**kwargs)

  

  List existing model cards.

  

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


  **Request Syntax**
  ::

    response = client.list_model_cards(
        CreationTimeAfter=datetime(2015, 1, 1),
        CreationTimeBefore=datetime(2015, 1, 1),
        MaxResults=123,
        NameContains='string',
        ModelCardStatus='Draft'|'PendingReview'|'Approved'|'Archived',
        NextToken='string',
        SortBy='Name'|'CreationTime',
        SortOrder='Ascending'|'Descending'
    )
    
  :type CreationTimeAfter: datetime
  :param CreationTimeAfter: 

    Only list model cards that were created after the time specified.

    

  
  :type CreationTimeBefore: datetime
  :param CreationTimeBefore: 

    Only list model cards that were created before the time specified.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of model cards to list.

    

  
  :type NameContains: string
  :param NameContains: 

    Only list model cards with names that contain the specified string.

    

  
  :type ModelCardStatus: string
  :param ModelCardStatus: 

    Only list model cards with the specified approval status.

    

  
  :type NextToken: string
  :param NextToken: 

    If the response to a previous ``ListModelCards`` request was truncated, the response includes a ``NextToken``. To retrieve the next set of model cards, use the token in the next request.

    

  
  :type SortBy: string
  :param SortBy: 

    Sort model cards by either name or creation time. Sorts by creation time by default.

    

  
  :type SortOrder: string
  :param SortOrder: 

    Sort model cards by ascending or descending order.

    

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

    
    ::

      {
          'ModelCardSummaries': [
              {
                  'ModelCardName': 'string',
                  'ModelCardArn': 'string',
                  'ModelCardStatus': 'Draft'|'PendingReview'|'Approved'|'Archived',
                  'CreationTime': datetime(2015, 1, 1),
                  'LastModifiedTime': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ModelCardSummaries** *(list) --* 

        The summaries of the listed model cards.

        
        

        - *(dict) --* 

          A summary of the model card.

          
          

          - **ModelCardName** *(string) --* 

            The name of the model card.

            
          

          - **ModelCardArn** *(string) --* 

            The Amazon Resource Name (ARN) of the model card.

            
          

          - **ModelCardStatus** *(string) --* 

            The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

             

            
            * ``Draft``: The model card is a work in progress.
             
            * ``PendingReview``: The model card is pending review.
             
            * ``Approved``: The model card is approved.
             
            * ``Archived``: The model card is archived. No more updates should be made to the model card, but it can still be exported.
            

            
          

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

            The date and time that the model card was created.

            
          

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

            The date and time that the model card was last modified.

            
      
    
      

      - **NextToken** *(string) --* 

        If the response is truncated, SageMaker returns this token. To retrieve the next set of model cards, use it in the subsequent request.

        
  