PipelineExecution - CodePipeline
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

PipelineExecution

Represents information about an execution of a pipeline.

Contents

artifactRevisions

A list of ArtifactRevision objects included in a pipeline execution.

Type: Array of ArtifactRevision objects

Required: No

executionMode

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

Type: String

Valid Values: QUEUED | SUPERSEDED | PARALLEL

Required: No

executionType

The type of the pipeline execution.

Type: String

Valid Values: STANDARD | ROLLBACK

Required: No

pipelineExecutionId

The ID of the pipeline execution.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No

pipelineName

The name of the pipeline with the specified pipeline execution.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: No

pipelineVersion

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

Type: Integer

Valid Range: Minimum value of 1.

Required: No

rollbackMetadata

The metadata about the execution pertaining to stage rollback.

Type: PipelineRollbackMetadata object

Required: No

status

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.

Type: String

Valid Values: Cancelled | InProgress | Stopped | Stopping | Succeeded | Superseded | Failed

Required: No

statusSummary

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

Type: String

Required: No

trigger

The interaction or event that started a pipeline execution.

Type: ExecutionTrigger object

Required: No

variables

A list of pipeline variables used for the pipeline execution.

Type: Array of ResolvedPipelineVariable objects

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: