IoTSiteWise / Paginator / ListActions

ListActions

class IoTSiteWise.Paginator.ListActions

paginator = client.get_paginator('list_actions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_actions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    targetResourceType='ASSET',
    targetResourceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• targetResourceType (string) –

  [REQUIRED]

  The type of resource.

• targetResourceId (string) –

  [REQUIRED]

  The ID of the target resource.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

    A token to resume pagination.