:doc:`IoTSiteWise <../../iotsitewise>` / Client / describe_execution

******************
describe_execution
******************



.. py:method:: IoTSiteWise.Client.describe_execution(**kwargs)

  

  Retrieves information about the execution.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeExecution>`_  


  **Request Syntax**
  ::

    response = client.describe_execution(
        executionId='string'
    )
    
  :type executionId: string
  :param executionId: **[REQUIRED]** 

    The ID of the execution.

    

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

    
    ::

      {
          'executionId': 'string',
          'actionType': 'string',
          'targetResource': {
              'assetId': 'string',
              'computationModelId': 'string'
          },
          'targetResourceVersion': 'string',
          'resolveTo': {
              'assetId': 'string'
          },
          'executionStartTime': datetime(2015, 1, 1),
          'executionEndTime': datetime(2015, 1, 1),
          'executionStatus': {
              'state': 'RUNNING'|'COMPLETED'|'FAILED'
          },
          'executionResult': {
              'string': 'string'
          },
          'executionDetails': {
              'string': 'string'
          },
          'executionEntityVersion': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **executionId** *(string) --* 

        The ID of the execution.

        
      

      - **actionType** *(string) --* 

        The type of action exectued.

        
      

      - **targetResource** *(dict) --* 

        The resource the action will be taken on. This can include asset-based resources and computation model resources.

        
        

        - **assetId** *(string) --* 

          The ID of the asset, in UUID format.

          
        

        - **computationModelId** *(string) --* 

          The ID of the computation model.

          
    
      

      - **targetResourceVersion** *(string) --* 

        The version of the target resource.

        
      

      - **resolveTo** *(dict) --* 

        The detailed resource this execution resolves to.

        
        

        - **assetId** *(string) --* 

          The ID of the asset that the resource resolves to.

          
    
      

      - **executionStartTime** *(datetime) --* 

        The time the process started.

        
      

      - **executionEndTime** *(datetime) --* 

        The time the process ended.

        
      

      - **executionStatus** *(dict) --* 

        The status of the execution process.

        
        

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

          The current state of the computation model.

          
    
      

      - **executionResult** *(dict) --* 

        The result of the execution.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

      - **executionDetails** *(dict) --* 

        Provides detailed information about the execution of your anomaly detection models. This includes model metrics and training timestamps for both training and inference actions.

         

        
        * The training action (Amazon Web Services/ANOMALY_DETECTION_TRAINING), includes performance metrics that help you compare different versions of your anomaly detection models. These metrics provide insights into the model's performance during the training process.
         
        * The inference action (Amazon Web Services/ANOMALY_DETECTION_INFERENCE), includes information about the results of executing your anomaly detection models. This helps you understand the output of your models and assess their performance.
        

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

      - **executionEntityVersion** *(string) --* 

        Entity version used for the execution.

        
  
  **Exceptions**
  
  *   :py:class:`IoTSiteWise.Client.exceptions.InvalidRequestException`

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

  
  *   :py:class:`IoTSiteWise.Client.exceptions.InternalFailureException`

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

  