IoTSiteWise / Client / describe_action

describe_action#

IoTSiteWise.Client.describe_action(**kwargs)#

Retrieves information about an action.

See also: AWS API Documentation

Request Syntax

response = client.describe_action(
    actionId='string'
)
Parameters:

actionId (string) –

[REQUIRED]

The ID of the action.

Return type:

dict

Returns:

Response Syntax

{
    'actionId': 'string',
    'targetResource': {
        'assetId': 'string'
    },
    'actionDefinitionId': 'string',
    'actionPayload': {
        'stringValue': 'string'
    },
    'executionTime': datetime(2015, 1, 1)
}

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.

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

Exceptions