Skip to content

PipelineExecutionSummary

Source code in docs_src/capo_codepipeline/types/pipeline_execution_summary.py
class PipelineExecutionSummary(TypedDict, closed=True):
    pipeline_execution_id: NotRequired[
        "capo_codepipeline.types.pipeline_execution_id.PipelineExecutionId"
    ]
    """<p>The ID of the pipeline execution.</p>"""
    status: NotRequired[
        "capo_codepipeline.types.pipeline_execution_status.PipelineExecutionStatus"
    ]
    """<p>The status of the pipeline execution.</p> <ul> <li> <p>InProgress: The pipeline execution is currently running.</p> </li> <li> <p>Stopped: The pipeline execution was manually stopped. For more information, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped">Stopped Executions</a>.</p> </li> <li> <p>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 <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped">Stopped Executions</a>.</p> </li> <li> <p>Succeeded: The pipeline execution was completed successfully. </p> </li> <li> <p>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 <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-superseded">Superseded Executions</a>.</p> </li> <li> <p>Failed: The pipeline execution was not completed successfully.</p> </li> </ul>"""
    status_summary: NotRequired[
        "capo_codepipeline.types.pipeline_execution_status_summary.PipelineExecutionStatusSummary"
    ]
    """<p>Status summary for the pipeline.</p>"""
    start_time: NotRequired["capo_codepipeline.types.timestamp.Timestamp"]
    """<p>The date and time when the pipeline execution began, in timestamp format.</p>"""
    last_update_time: NotRequired["capo_codepipeline.types.timestamp.Timestamp"]
    """<p>The date and time of the last change to the pipeline execution, in timestamp format.</p>"""
    source_revisions: NotRequired[
        "capo_codepipeline.types.source_revision_list.SourceRevisionList"
    ]
    """<p>A list of the source artifact revisions that initiated a pipeline execution.</p>"""
    trigger: NotRequired["capo_codepipeline.types.execution_trigger.ExecutionTrigger"]
    """<p>The interaction or event that started a pipeline execution, such as automated change detection or a <code>StartPipelineExecution</code> API call.</p>"""
    stop_trigger: NotRequired[
        "capo_codepipeline.types.stop_execution_trigger.StopExecutionTrigger"
    ]
    """<p>The interaction that stopped a pipeline execution.</p>"""
    execution_mode: NotRequired["capo_codepipeline.types.execution_mode.ExecutionMode"]
    """<p>The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.</p>"""
    execution_type: NotRequired["capo_codepipeline.types.execution_type.ExecutionType"]
    """<p>Type of the pipeline execution.</p>"""
    rollback_metadata: NotRequired[
        "capo_codepipeline.types.pipeline_rollback_metadata.PipelineRollbackMetadata"
    ]
    """<p>The metadata for the stage execution to be rolled back.</p>"""

execution_mode instance-attribute

execution_mode: NotRequired[ExecutionMode]

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

execution_type instance-attribute

execution_type: NotRequired[ExecutionType]

Type of the pipeline execution.

last_update_time instance-attribute

last_update_time: NotRequired[Timestamp]

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

pipeline_execution_id instance-attribute

pipeline_execution_id: NotRequired[PipelineExecutionId]

The ID of the pipeline execution.

rollback_metadata instance-attribute

rollback_metadata: NotRequired[PipelineRollbackMetadata]

The metadata for the stage execution to be rolled back.

source_revisions instance-attribute

source_revisions: NotRequired[SourceRevisionList]

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

start_time instance-attribute

start_time: NotRequired[Timestamp]

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

status instance-attribute

status: NotRequired[PipelineExecutionStatus]

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.

status_summary instance-attribute

status_summary: NotRequired[PipelineExecutionStatusSummary]

Status summary for the pipeline.

stop_trigger instance-attribute

stop_trigger: NotRequired[StopExecutionTrigger]

The interaction that stopped a pipeline execution.

trigger instance-attribute

trigger: NotRequired[ExecutionTrigger]

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