IoTSiteWise / Client / list_executions

list_executions

IoTSiteWise.Client.list_executions(**kwargs)

Retrieves a paginated list of summaries of all executions.

See also: AWS API Documentation

Request Syntax

response = client.list_executions(
    targetResourceType='ASSET'|'COMPUTATION_MODEL',
    targetResourceId='string',
    resolveToResourceType='ASSET',
    resolveToResourceId='string',
    nextToken='string',
    maxResults=123,
    actionType='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.

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

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

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

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

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

Exceptions