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

***************
describe_action
***************



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

  

  Retrieves information about an action.

  

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


  **Request Syntax**
  ::

    response = client.describe_action(
        actionId='string'
    )
    
  :type actionId: string
  :param actionId: **[REQUIRED]** 

    The ID of the action.

    

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

    
    ::

      {
          'actionId': 'string',
          'targetResource': {
              'assetId': 'string',
              'computationModelId': 'string'
          },
          'actionDefinitionId': 'string',
          'actionPayload': {
              'stringValue': 'string'
          },
          'executionTime': datetime(2015, 1, 1),
          'resolveTo': {
              'assetId': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **actionId** *(string) --* 

        The ID of the action.

        
      

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

        The resource the action will be taken on.

        
        

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

          The ID of the asset, in UUID format.

          
        

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

          The ID of the computation model.

          
    
      

      - **actionDefinitionId** *(string) --* 

        The ID of the action definition.

        
      

      - **actionPayload** *(dict) --* 

        The JSON payload of the action.

        
        

        - **stringValue** *(string) --* 

          The payload of the action in a JSON string.

          
    
      

      - **executionTime** *(datetime) --* 

        The time the action was executed.

        
      

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

        The detailed resource this action resolves to.

        
        

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

          The ID of the asset that the resource resolves to.

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

  