list-pipeline-executions¶

Description¶

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

Synopsis¶

  list-pipeline-executions
--pipeline-name <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--pipeline-name (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

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

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To view pipeline execution history

The following list-pipeline-executions example shows the pipeline execution history for a pipeline in your AWS account.

aws codepipeline list-pipeline-executions \
    --pipeline-name MyPipeline

Output:

{
    "pipelineExecutionSummaries": [
        {
            "lastUpdateTime": 1496380678.648,
            "pipelineExecutionId": "7cf7f7cb-3137-539g-j458-d7eu3EXAMPLE",
            "startTime": 1496380258.243,
            "status": "Succeeded"
        },
        {
            "lastUpdateTime": 1496591045.634,
            "pipelineExecutionId": "3137f7cb-8d494hj4-039j-d84l-d7eu3EXAMPLE",
            "startTime": 1496590401.222,
            "status": "Succeeded"
        },
        {
            "lastUpdateTime": 1496946071.6456,
            "pipelineExecutionId": "4992f7jf-7cf7-913k-k334-d7eu3EXAMPLE",
            "startTime": 1496945471.5645,
            "status": "Succeeded"
        }
    ]
}

For more information, see View execution history in the AWS CodePipeline User Guide.

Output¶

pipelineExecutionSummaries -> (list)

A list of executions in the history of a pipeline.

(structure)

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.

Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions .

Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions .

Succeeded: The pipeline execution was completed successfully.

Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions .

Failed: The pipeline execution was not completed successfully.

startTime -> (timestamp)

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

lastUpdateTime -> (timestamp)

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

sourceRevisions -> (list)

A list of the source artifact revisions that initiated a pipeline execution.

(structure)

Information about the version (or revision) of a source artifact that initiated a pipeline execution.

actionName -> (string)

The name of the action that processed the revision to the source artifact.

revisionId -> (string)

The system-generated unique ID that identifies the revision number of the artifact.

revisionSummary -> (string)

Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.

revisionUrl -> (string)

The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.

trigger -> (structure)

The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.

triggerType -> (string)

The type of change-detection method, command, or user interaction that started a pipeline execution.

triggerDetail -> (string)

Detail related to the event that started a pipeline execution, such as the webhook ARN of the webhook that triggered the pipeline execution or the user ARN for a user-initiated start-pipeline-execution CLI command.

stopTrigger -> (structure)

The interaction that stopped a pipeline execution.

reason -> (string)

The user-specified reason the pipeline was stopped.

nextToken -> (string)

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

Table of Contents

Feedback

User Guide