IoTSiteWise / Client / list_actions

list_actions#

IoTSiteWise.Client.list_actions(**kwargs)#

Retrieves a paginated list of actions for a specific target resource.

See also: AWS API Documentation

Request Syntax

response = client.list_actions(
    targetResourceType='ASSET',
    targetResourceId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • targetResourceType (string) –

    [REQUIRED]

    The type of resource.

  • targetResourceId (string) –

    [REQUIRED]

    The ID of the target resource.

  • nextToken (string) – The token to be used for the next set of paginated results.

  • maxResults (integer) – The maximum number of results to return for each paginated request.

Return type:

dict

Returns:

Response Syntax

{
    'actionSummaries': [
        {
            'actionId': 'string',
            'actionDefinitionId': 'string',
            'targetResource': {
                'assetId': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • actionSummaries (list) –

      A list that summarizes the actions associated with the specified asset.

      • (dict) –

        Contains the summary of the actions.

        • actionId (string) –

          The ID of the action.

        • actionDefinitionId (string) –

          The ID of the action definition.

        • targetResource (dict) –

          The resource the action will be taken on.

          • assetId (string) –

            The ID of the asset, in UUID format.

    • nextToken (string) –

      The token for the next set of results, or null if there are no additional results.

Exceptions