:doc:`Bedrock <../../bedrock>` / Client / list_model_copy_jobs

********************
list_model_copy_jobs
********************



.. py:method:: Bedrock.Client.list_model_copy_jobs(**kwargs)

  

  Returns a list of model copy jobs that you have submitted. You can filter the jobs to return based on one or more criteria. For more information, see `Copy models to be used in other regions <https://docs.aws.amazon.com/bedrock/latest/userguide/copy-model.html>`__ in the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html>`__.

  

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


  **Request Syntax**
  ::

    response = client.list_model_copy_jobs(
        creationTimeAfter=datetime(2015, 1, 1),
        creationTimeBefore=datetime(2015, 1, 1),
        statusEquals='InProgress'|'Completed'|'Failed',
        sourceAccountEquals='string',
        sourceModelArnEquals='string',
        targetModelNameContains='string',
        maxResults=123,
        nextToken='string',
        sortBy='CreationTime',
        sortOrder='Ascending'|'Descending'
    )
    
  :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 maxResults: integer
  :param maxResults: 

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the ``nextToken`` field when making another request to return the next batch of results.

    

  
  :type nextToken: string
  :param nextToken: 

    If the total number of results is greater than the ``maxResults`` value provided in the request, enter the token returned in the ``nextToken`` field in the response in this field to return the next batch of results.

    

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

    

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

    
    ::

      {
          'nextToken': 'string',
          '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'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **nextToken** *(string) --* 

        If the total number of results is greater than the ``maxResults`` value provided in the request, use this token when making another request in the ``nextToken`` field to return the next batch of results.

        
      

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

            
      
    
  
  **Exceptions**
  
  *   :py:class:`Bedrock.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Bedrock.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Bedrock.Client.exceptions.ValidationException`

  
  *   :py:class:`Bedrock.Client.exceptions.InternalServerException`

  
  *   :py:class:`Bedrock.Client.exceptions.ThrottlingException`

  