:doc:`IoTTwinMaker <../../iottwinmaker>` / Client / cancel_metadata_transfer_job

****************************
cancel_metadata_transfer_job
****************************



.. py:method:: IoTTwinMaker.Client.cancel_metadata_transfer_job(**kwargs)

  

  Cancels the metadata transfer job.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/CancelMetadataTransferJob>`_  


  **Request Syntax**
  ::

    response = client.cancel_metadata_transfer_job(
        metadataTransferJobId='string'
    )
    
  :type metadataTransferJobId: string
  :param metadataTransferJobId: **[REQUIRED]** 

    The metadata transfer job Id.

    

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

    
    ::

      {
          'metadataTransferJobId': 'string',
          'arn': 'string',
          'updateDateTime': datetime(2015, 1, 1),
          'status': {
              'state': 'VALIDATING'|'PENDING'|'RUNNING'|'CANCELLING'|'ERROR'|'COMPLETED'|'CANCELLED',
              'error': {
                  'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
                  'message': 'string'
              },
              'queuedPosition': 123
          },
          'progress': {
              'totalCount': 123,
              'succeededCount': 123,
              'skippedCount': 123,
              'failedCount': 123
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **metadataTransferJobId** *(string) --* 

        The metadata transfer job Id.

        
      

      - **arn** *(string) --* 

        The metadata transfer job ARN.

        
      

      - **updateDateTime** *(datetime) --* 

        Used to update the DateTime property.

        
      

      - **status** *(dict) --* 

        The metadata transfer job's status.

        
        

        - **state** *(string) --* 

          The metadata transfer job state.

          
        

        - **error** *(dict) --* 

          The metadata transfer job error.

          
          

          - **code** *(string) --* 

            The error code.

            
          

          - **message** *(string) --* 

            The error message.

            
      
        

        - **queuedPosition** *(integer) --* 

          The queued position.

          
    
      

      - **progress** *(dict) --* 

        The metadata transfer job's progress.

        
        

        - **totalCount** *(integer) --* 

          The total count. [of what]

          
        

        - **succeededCount** *(integer) --* 

          The succeeded count.

          
        

        - **skippedCount** *(integer) --* 

          The skipped count.

          
        

        - **failedCount** *(integer) --* 

          The failed count.

          
    
  
  **Exceptions**
  
  *   :py:class:`IoTTwinMaker.Client.exceptions.InternalServerException`

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

  
  *   :py:class:`IoTTwinMaker.Client.exceptions.ResourceNotFoundException`

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

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

  
  *   :py:class:`IoTTwinMaker.Client.exceptions.ConflictException`

  