AWS CodePipeline

Get pipeline state

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

Returns information about the state of a pipeline, including the stages and actions. Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.

Inputs

Champ

Type

Description

region [required]

enum

default: us-east-1

name [required]

string

The name of the pipeline about which you want to get information.

Outputs

Expand All

Champ

Type

Description

amzRequestId [required]

string

pipelineName

string

The name of the pipeline for which you want to get the state.

pipelineVersion

number

The version number of the pipeline. A newly created pipeline is always assigned a version number of 1.

stageStates

[object]

A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.

stageName

string

The name of the stage.

inboundExecution

object

pipelineExecutionId [required]

string

The ID of the pipeline execution associated with the stage.

status [required]

string

The status of the stage, or for a completed stage, the last status of the stage. A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.

inboundExecutions

[object]

The inbound executions for a stage.

pipelineExecutionId [required]

string

The ID of the pipeline execution associated with the stage.

status [required]

string

The status of the stage, or for a completed stage, the last status of the stage. A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.

inboundTransitionState

object

The state of the inbound transition, which is either enabled or disabled.

enabled

boolean

Whether the transition between stages is enabled (true) or disabled (false).

lastChangedBy

string

The ID of the user who last changed the transition state.

lastChangedAt

date-time

The timestamp when the transition state was last changed.

disabledReason

string

The user-specified reason why the transition between two stages of a pipeline was disabled.

actionStates

[object]

The state of the stage.

actionName

string

The name of the action.

currentRevision

object

Represents information about the version (or revision) of an action.

revisionId [required]

string

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

revisionChangeId [required]

string

The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).

created [required]

date-time

The date and time when the most recent version of the action was created, in timestamp format.

latestExecution

object

Represents information about the run of an action.

actionExecutionId

string

ID of the workflow action execution in the current stage. Use the GetPipelineState action to retrieve the current action execution details of the current stage. For older executions, this field might be empty. The action execution ID is available for executions run on or after March 2020.

status

string

The status of the action, or for a completed action, the last status of the action.

summary

string

A summary of the run of the action.

lastStatusChange

date-time

The last status change of the action.

token

string

The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command. It is used to validate that the approval request corresponding to this token is still valid.

lastUpdatedBy

string

The ARN of the user who last changed the pipeline.

externalExecutionId

string

The external ID of the run of the action.

externalExecutionUrl

string

The URL of a resource external to Amazon Web Services that is used when running the action (for example, an external repository URL).

percentComplete

number

A percentage of completeness of the action as it runs.

errorDetails

object

The details of an error returned by a URL external to Amazon Web Services.

code

string

The system ID or number code of the error.

message

string

The text of the error message.

entityUrl

string

A URL link for more information about the state of the action, such as a deployment group details page.

revisionUrl

string

A URL link for more information about the revision, such as a commit details page.

latestExecution

object

Information about the latest execution in the stage, including its ID and status.

pipelineExecutionId [required]

string

The ID of the pipeline execution associated with the stage.

status [required]

string

The status of the stage, or for a completed stage, the last status of the stage. A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.

created

date-time

The date and time the pipeline was created, in timestamp format.

updated

date-time

The date and time the pipeline was last updated, in timestamp format.