PipelineContext - AWS CodePipeline

PipelineContext

Represents information about a pipeline to a job worker.

Note

PipelineContext contains pipelineArn and pipelineExecutionId for custom action jobs. The pipelineArn and pipelineExecutionId fields are not populated for ThirdParty action jobs.

Contents

action

The context of an action to a job worker in the stage of a pipeline.

Type: ActionContext object

Required: No

pipelineArn

The Amazon Resource Name (ARN) of the pipeline.

Type: String

Pattern: arn:aws(-[\w]+)*:codepipeline:.+:[0-9]{12}:.+

Required: No

pipelineExecutionId

The execution ID of the pipeline.

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. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.

Type: String

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

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

Required: No

stage

The stage of the pipeline.

Type: StageContext object

Required: No

See Also

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