AWS CodePipeline

Gets a summary of the most recent executions for a pipeline.

See also: AWS API Documentation

Request Syntax

client.list_pipeline_executions(
    pipelineName='string',
    maxResults=123,
    nextToken='string'
)

type pipelineName

string

param pipelineName

[REQUIRED]

The name of the pipeline for which you want to get execution summary information.

type maxResults

integer

param maxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. The available pipeline execution history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.

type nextToken

string

param nextToken

The token that was returned from the previous list pipeline executions call, which can be used to return the next set of pipeline executions in the list.

rtype

dict

returns

Response Syntax

{
    'pipelineExecutionSummaries': [
        {
            'pipelineExecutionId': 'string',
            'status': 'InProgress'|'Succeeded'|'Superseded'|'Failed',
            'startTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  Represents the output of a list pipeline executions action.

  • pipelineExecutionSummaries (list) --

    A list of executions in the history of a pipeline.

    • (dict) --

      Summary information about a pipeline execution.

      • pipelineExecutionId (string) --

        The ID of the pipeline execution.

      • status (string) --

        The status of the pipeline execution.

        • InProgress: The pipeline execution is currently running.

        • Succeeded: The pipeline execution completed successfully.

        • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution caught up and continued through the pipeline instead.

        • Failed: The pipeline execution did not complete successfully.

      • startTime (datetime) --

        The date and time when the pipeline execution began, in timestamp format.

      • lastUpdateTime (datetime) --

        The date and time of the last change to the pipeline execution, in timestamp format.

  • nextToken (string) --

    A token that can be used in the next list pipeline executions call to return the next set of pipeline executions. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.