IoTSiteWise / Paginator / ListExecutions

ListExecutions

class IoTSiteWise.Paginator.ListExecutions

paginator = client.get_paginator('list_executions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• targetResourceType (string) –

  [REQUIRED]

  The type of the target resource.

• targetResourceId (string) –

  [REQUIRED]

  The ID of the target resource.

• resolveToResourceType (string) – The type of the resolved resource.

• resolveToResourceId (string) – The ID of the resolved resource.

• actionType (string) – The type of action exectued.

• 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

{
    'executionSummaries': [
        {
            'executionId': 'string',
            'actionType': 'string',
            'targetResource': {
                'assetId': 'string',
                'computationModelId': 'string'
            },
            'targetResourceVersion': 'string',
            'resolveTo': {
                'assetId': 'string'
            },
            'executionStartTime': datetime(2015, 1, 1),
            'executionEndTime': datetime(2015, 1, 1),
            'executionStatus': {
                'state': 'RUNNING'|'COMPLETED'|'FAILED'
            },
            'executionEntityVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • executionSummaries (list) –

    Contains the list of execution summaries of the computation models.

    • (dict) –

      Contains the execution summary of the computation model.

      • executionId (string) –

        The ID of the execution.

      • actionType (string) –

        The type of action exectued.

      • targetResource (dict) –

        The resource the action will be taken on. This can include asset-based resources and computation model resources.

        • assetId (string) –

          The ID of the asset, in UUID format.

        • computationModelId (string) –

          The ID of the computation model.

      • targetResourceVersion (string) –

        The version of the target resource.

      • resolveTo (dict) –

        The detailed resource this execution resolves to.

        • assetId (string) –

          The ID of the asset that the resource resolves to.

      • executionStartTime (datetime) –

        The time the process started.

      • executionEndTime (datetime) –

        The time the process ended.

      • executionStatus (dict) –

        The status of the execution process.

        • state (string) –

          The current state of the computation model.

      • executionEntityVersion (string) –

        The execution entity version associated with the summary.

  • NextToken (string) –

    A token to resume pagination.