Skip to content

PipelineExecution

Source code in docs_src/capo_codepipeline/types/pipeline_execution.py
class PipelineExecution(TypedDict, closed=True):
    pipeline_name: NotRequired["capo_codepipeline.types.pipeline_name.PipelineName"]
    """<p>The name of the pipeline with the specified pipeline execution.</p>"""
    pipeline_version: NotRequired[
        "capo_codepipeline.types.pipeline_version.PipelineVersion"
    ]
    """<p>The version number of the pipeline with the specified pipeline execution.</p>"""
    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>Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.</p> </li> <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>A summary that contains a description of the pipeline execution status.</p>"""
    artifact_revisions: NotRequired[
        "capo_codepipeline.types.artifact_revision_list.ArtifactRevisionList"
    ]
    """<p>A list of <code>ArtifactRevision</code> objects included in a pipeline execution.</p>"""
    variables: NotRequired[
        "capo_codepipeline.types.resolved_pipeline_variable_list.ResolvedPipelineVariableList"
    ]
    """<p>A list of pipeline variables used for the pipeline execution.</p>"""
    trigger: NotRequired["capo_codepipeline.types.execution_trigger.ExecutionTrigger"]
    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>The type of the pipeline execution.</p>"""
    rollback_metadata: NotRequired[
        "capo_codepipeline.types.pipeline_rollback_metadata.PipelineRollbackMetadata"
    ]
    """<p>The metadata about the execution pertaining to stage rollback.</p>"""

artifact_revisions instance-attribute

artifact_revisions: NotRequired[ArtifactRevisionList]

A list of ArtifactRevision objects included in a pipeline execution.

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]

The type of the pipeline execution.

pipeline_execution_id instance-attribute

pipeline_execution_id: NotRequired[PipelineExecutionId]

The ID of the pipeline execution.

pipeline_name instance-attribute

pipeline_name: NotRequired[PipelineName]

The name of the pipeline with the specified pipeline execution.

pipeline_version instance-attribute

pipeline_version: NotRequired[PipelineVersion]

The version number of the pipeline with the specified pipeline execution.

rollback_metadata instance-attribute

rollback_metadata: NotRequired[PipelineRollbackMetadata]

The metadata about the execution pertaining to stage rollback.

status instance-attribute

status: NotRequired[PipelineExecutionStatus]

The status of the pipeline execution.

  • Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.

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

A summary that contains a description of the pipeline execution status.

trigger instance-attribute

trigger: NotRequired[ExecutionTrigger]

variables instance-attribute

variables: NotRequired[ResolvedPipelineVariableList]

A list of pipeline variables used for the pipeline execution.