PipelineContext

Represents information about a pipeline to a job worker.

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

AmazonCI/CDContinuous DeliveryDevOpsPipelineRelease Automation

Properties

Name Type Description
pipelineName object
stage object
action object
pipelineArn object
pipelineExecutionId object
View JSON Schema on GitHub

JSON Schema

amazon-codepipeline-pipeline-context-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codepipeline/refs/heads/main/json-schema/amazon-codepipeline-pipeline-context-schema.json",
  "title": "PipelineContext",
  "description": "<p>Represents information about a pipeline to a job worker.</p> <note> <p>PipelineContext contains <code>pipelineArn</code> and <code>pipelineExecutionId</code> for custom action jobs. The <code>pipelineArn</code> and <code>pipelineExecutionId</code> fields are not populated for ThirdParty action jobs.</p> </note>",
  "type": "object",
  "properties": {
    "pipelineName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipelineName"
        },
        {
          "description": "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."
        }
      ]
    },
    "stage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StageContext"
        },
        {
          "description": "The stage of the pipeline."
        }
      ]
    },
    "action": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ActionContext"
        },
        {
          "description": "The context of an action to a job worker in the stage of a pipeline."
        }
      ]
    },
    "pipelineArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipelineArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the pipeline."
        }
      ]
    },
    "pipelineExecutionId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipelineExecutionId"
        },
        {
          "description": "The execution ID of the pipeline."
        }
      ]
    }
  }
}