IoTSiteWise / Paginator / ListPipelineExecutions

ListPipelineExecutions

class IoTSiteWise.Paginator.ListPipelineExecutions

paginator = client.get_paginator('list_pipeline_executions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    workspaceName='string',
    pipelineName='string',
    state='NOT_STARTED'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED',
    startTimeAfter=datetime(2015, 1, 1),
    startTimeBefore=datetime(2015, 1, 1),
    endTimeAfter=datetime(2015, 1, 1),
    endTimeBefore=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• workspaceName (string) –

  [REQUIRED]

  The name of the workspace.

• pipelineName (string) –

  [REQUIRED]

  The name of the pipeline.

• state (string) – Filter by execution state. If not specified, executions in all states are returned.

• startTimeAfter (datetime) – Inclusive lower bound on execution start time (ISO-8601). Only executions with startTime >= startTimeAfter are returned. Cannot be combined with endTimeAfter or endTimeBefore.

• startTimeBefore (datetime) – Exclusive upper bound on execution start time (ISO-8601). Only executions with startTime < startTimeBefore are returned. Cannot be combined with endTimeAfter or endTimeBefore.

• endTimeAfter (datetime) – Inclusive lower bound on execution end time (ISO-8601). Only executions with endTime >= endTimeAfter are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.

• endTimeBefore (datetime) – Exclusive upper bound on execution end time (ISO-8601). Only executions with endTime < endTimeBefore are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.

• 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

{
    'pipelineExecutionSummaries': [
        {
            'pipelineExecutionId': 'string',
            'pipelineVersion': 'string',
            'status': {
                'state': 'NOT_STARTED'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED',
                'stateDetails': {
                    'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
                    'message': 'string',
                    'details': [
                        {
                            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
                            'message': 'string'
                        },
                    ]
                }
            },
            'executionPriority': 123,
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Response structure for ListPipelineExecutions operation.

  • pipelineExecutionSummaries (list) –

    A list that summarizes each pipeline execution.

    • (dict) –

      Contains summary information about a pipeline execution.

      • pipelineExecutionId (string) –

        The unique identifier of the pipeline execution.

      • pipelineVersion (string) –

        The pipeline version this execution ran against.

      • status (dict) –

        The current execution status of the pipeline.

        • state (string) –

          Current state of the pipeline execution.

        • stateDetails (dict) –

          Additional information about the execution outcome. Populated when the execution has terminated (failed or cancelled).

          • code (string) –

            Classification of the failure. Present when the execution failed.

          • message (string) –

            Human-readable description of the outcome. For a failed execution, this describes why it failed; for a cancelled execution, this is the reason you supplied when calling CancelPipelineExecution.

          • details (list) –

            Per-step error entries to help diagnose a failed execution. Present when the execution failed.

            • (dict) –

              Contains a detailed error entry for granular troubleshooting of pipeline failures.

              • code (string) –

                The error code.

              • message (string) –

                The associated error message.

      • executionPriority (integer) –

        Scheduling priority for the execution. When not specified, defaults to lowest priority.

      • startTime (datetime) –

        The time the pipeline execution started, in Unix epoch time.

      • endTime (datetime) –

        The time the pipeline execution completed, in Unix epoch time.

  • NextToken (string) –

    A token to resume pagination.