:doc:`CleanRoomsML <../../cleanroomsml>` / Paginator / ListTrainedModels

*****************
ListTrainedModels
*****************



.. py:class:: CleanRoomsML.Paginator.ListTrainedModels

  ::

    
    paginator = client.get_paginator('list_trained_models')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CleanRoomsML.Client.list_trained_models`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainedModels>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          membershipIdentifier='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type membershipIdentifier: string
    :param membershipIdentifier: **[REQUIRED]** 

      The membership ID of the member that created the trained models you are interested in.

      

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

      
      ::

        {
            'trainedModels': [
                {
                    'createTime': datetime(2015, 1, 1),
                    'updateTime': datetime(2015, 1, 1),
                    'trainedModelArn': 'string',
                    'versionIdentifier': 'string',
                    'incrementalTrainingDataChannels': [
                        {
                            'channelName': 'string',
                            'versionIdentifier': 'string',
                            'modelName': 'string'
                        },
                    ],
                    'name': 'string',
                    'description': 'string',
                    'membershipIdentifier': 'string',
                    'collaborationIdentifier': 'string',
                    'status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_PENDING'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'INACTIVE'|'CANCEL_PENDING'|'CANCEL_IN_PROGRESS'|'CANCEL_FAILED',
                    'configuredModelAlgorithmAssociationArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **trainedModels** *(list) --* 

          The list of trained models.

          
          

          - *(dict) --* 

            Summary information about the trained model.

            
            

            - **createTime** *(datetime) --* 

              The time at which the trained model was created.

              
            

            - **updateTime** *(datetime) --* 

              The most recent time at which the trained model was updated.

              
            

            - **trainedModelArn** *(string) --* 

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

              
            

            - **versionIdentifier** *(string) --* 

              The version identifier of this trained model version.

              
            

            - **incrementalTrainingDataChannels** *(list) --* 

              Information about the incremental training data channels used to create this version of the trained model.

              
              

              - *(dict) --* 

                Contains information about an incremental training data channel that was used to create a trained model. This structure provides details about the base model and channel configuration used during incremental training.

                
                

                - **channelName** *(string) --* 

                  The name of the incremental training data channel that was used.

                  
                

                - **versionIdentifier** *(string) --* 

                  The version identifier of the trained model that was used for incremental training.

                  
                

                - **modelName** *(string) --* 

                  The name of the base trained model that was used for incremental training.

                  
            
          
            

            - **name** *(string) --* 

              The name of the trained model.

              
            

            - **description** *(string) --* 

              The description of the trained model.

              
            

            - **membershipIdentifier** *(string) --* 

              The membership ID of the member that created the trained model.

              
            

            - **collaborationIdentifier** *(string) --* 

              The collaboration ID of the collaboration that contains the trained model.

              
            

            - **status** *(string) --* 

              The status of the trained model.

              
            

            - **configuredModelAlgorithmAssociationArn** *(string) --* 

              The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create this trained model.

              
        
      
        

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

          A token to resume pagination.

          
    