IoTSiteWise / Client / execute_action

execute_action#

IoTSiteWise.Client.execute_action(**kwargs)#

Executes an action on a target resource.

See also: AWS API Documentation

Request Syntax

response = client.execute_action(
    targetResource={
        'assetId': 'string'
    },
    actionDefinitionId='string',
    actionPayload={
        'stringValue': 'string'
    },
    clientToken='string'
)
Parameters:

  • targetResource (dict) –

    [REQUIRED]

    The resource the action will be taken on.

    • assetId (string) – [REQUIRED]

      The ID of the asset, in UUID format.

  • actionDefinitionId (string) –

    [REQUIRED]

    The ID of the action definition.

  • actionPayload (dict) –

    [REQUIRED]

    The JSON payload of the action.

    • stringValue (string) – [REQUIRED]

      The payload of the action in a JSON string.

  • clientToken (string) – A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

Return type:

dict

Returns:

Response Syntax

{
    'actionId': 'string'
}

Response Structure

  • (dict) –

    • actionId (string) –

      The ID of the action.

Exceptions

  • IoTSiteWise.Client.exceptions.InvalidRequestException

  • IoTSiteWise.Client.exceptions.ResourceNotFoundException

  • IoTSiteWise.Client.exceptions.InternalFailureException

  • IoTSiteWise.Client.exceptions.ThrottlingException

  • IoTSiteWise.Client.exceptions.LimitExceededException

  • IoTSiteWise.Client.exceptions.ConflictingOperationException