:doc:`Bedrock <../../bedrock>` / Paginator / ListModelCopyJobs

*****************
ListModelCopyJobs
*****************



.. py:class:: Bedrock.Paginator.ListModelCopyJobs

  ::

    
    paginator = client.get_paginator('list_model_copy_jobs')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Bedrock.Client.list_model_copy_jobs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListModelCopyJobs>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          creationTimeAfter=datetime(2015, 1, 1),
          creationTimeBefore=datetime(2015, 1, 1),
          statusEquals='InProgress'|'Completed'|'Failed',
          sourceAccountEquals='string',
          sourceModelArnEquals='string',
          targetModelNameContains='string',
          sortBy='CreationTime',
          sortOrder='Ascending'|'Descending',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type creationTimeAfter: datetime
    :param creationTimeAfter: 

      Filters for model copy jobs created after the specified time.

      

    
    :type creationTimeBefore: datetime
    :param creationTimeBefore: 

      Filters for model copy jobs created before the specified time.

      

    
    :type statusEquals: string
    :param statusEquals: 

      Filters for model copy jobs whose status matches the value that you specify.

      

    
    :type sourceAccountEquals: string
    :param sourceAccountEquals: 

      Filters for model copy jobs in which the account that the source model belongs to is equal to the value that you specify.

      

    
    :type sourceModelArnEquals: string
    :param sourceModelArnEquals: 

      Filters for model copy jobs in which the Amazon Resource Name (ARN) of the source model to is equal to the value that you specify.

      

    
    :type targetModelNameContains: string
    :param targetModelNameContains: 

      Filters for model copy jobs in which the name of the copied model contains the string that you specify.

      

    
    :type sortBy: string
    :param sortBy: 

      The field to sort by in the returned list of model copy jobs.

      

    
    :type sortOrder: string
    :param sortOrder: 

      Specifies whether to sort the results in ascending or descending order.

      

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

      
      ::

        {
            'modelCopyJobSummaries': [
                {
                    'jobArn': 'string',
                    'status': 'InProgress'|'Completed'|'Failed',
                    'creationTime': datetime(2015, 1, 1),
                    'targetModelArn': 'string',
                    'targetModelName': 'string',
                    'sourceAccountId': 'string',
                    'sourceModelArn': 'string',
                    'targetModelKmsKeyArn': 'string',
                    'targetModelTags': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'failureMessage': 'string',
                    'sourceModelName': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **modelCopyJobSummaries** *(list) --* 

          A list of information about each model copy job.

          
          

          - *(dict) --* 

            Contains details about each model copy job.

             

            This data type is used in the following API operations:

             

            
            * `ListModelCopyJobs response <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListModelCopyJobs.html#API_ListModelCopyJobs_ResponseSyntax>`__
            

            
            

            - **jobArn** *(string) --* 

              The Amazon Resoource Name (ARN) of the model copy job.

              
            

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

              The status of the model copy job.

              
            

            - **creationTime** *(datetime) --* 

              The time that the model copy job was created.

              
            

            - **targetModelArn** *(string) --* 

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

              
            

            - **targetModelName** *(string) --* 

              The name of the copied model.

              
            

            - **sourceAccountId** *(string) --* 

              The unique identifier of the account that the model being copied originated from.

              
            

            - **sourceModelArn** *(string) --* 

              The Amazon Resource Name (ARN) of the original model being copied.

              
            

            - **targetModelKmsKeyArn** *(string) --* 

              The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied model.

              
            

            - **targetModelTags** *(list) --* 

              Tags associated with the copied model.

              
              

              - *(dict) --* 

                Definition of the key/value pair for a tag.

                
                

                - **key** *(string) --* 

                  Key for the tag.

                  
                

                - **value** *(string) --* 

                  Value for the tag.

                  
            
          
            

            - **failureMessage** *(string) --* 

              If a model fails to be copied, a message describing why the job failed is included here.

              
            

            - **sourceModelName** *(string) --* 

              The name of the original model being copied.

              
        
      
        

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

          A token to resume pagination.

          
    