CodePipeline / Paginator / ListPipelineExecutions

ListPipelineExecutions

class CodePipeline.Paginator.ListPipelineExecutions

paginator = client.get_paginator('list_pipeline_executions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    pipelineName='string',
    filter={
        'succeededInStage': {
            'stageName': 'string'
        }
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• pipelineName (string) –

  [REQUIRED]

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

• filter (dict) –

  The pipeline execution to filter on.

  • succeededInStage (dict) –

    Filter for pipeline executions where the stage was successful in the current pipeline version.

    • stageName (string) –

      The name of the stage for filtering for pipeline executions where the stage was successful in the current pipeline version.

• 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',
            'status': 'Cancelled'|'InProgress'|'Stopped'|'Stopping'|'Succeeded'|'Superseded'|'Failed',
            'statusSummary': 'string',
            'startTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1),
            'sourceRevisions': [
                {
                    'actionName': 'string',
                    'revisionId': 'string',
                    'revisionSummary': 'string',
                    'revisionUrl': 'string'
                },
            ],
            'trigger': {
                'triggerType': 'CreatePipeline'|'StartPipelineExecution'|'PollForSourceChanges'|'Webhook'|'CloudWatchEvent'|'PutActionRevision'|'WebhookV2'|'ManualRollback'|'AutomatedRollback',
                'triggerDetail': 'string'
            },
            'stopTrigger': {
                'reason': 'string'
            },
            'executionMode': 'QUEUED'|'SUPERSEDED'|'PARALLEL',
            'executionType': 'STANDARD'|'ROLLBACK',
            'rollbackMetadata': {
                'rollbackTargetPipelineExecutionId': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Represents the output of a ListPipelineExecutions 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.

        • 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.

      • statusSummary (string) –

        Status summary for the pipeline.

      • 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.

      • sourceRevisions (list) –

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

        • (dict) –

          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 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 CodeCommit repositories, the commit ID is linked to a commit details page.

      • trigger (dict) –

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

        The interaction that stopped a pipeline execution.

        • reason (string) –

          The user-specified reason the pipeline was stopped.

      • executionMode (string) –

        The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

      • executionType (string) –

        Type of the pipeline execution.

      • rollbackMetadata (dict) –

        The metadata for the stage execution to be rolled back.

        • rollbackTargetPipelineExecutionId (string) –

          The pipeline execution ID to which the stage will be rolled back.

  • NextToken (string) –

    A token to resume pagination.