Overview
This is the CodePipeline API Reference. This guide provides descriptions of the actions and data types for CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the CodePipeline User Guide.
You can use the CodePipeline API to work with pipelines, stages, actions, and transitions.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.
You can work with pipelines by calling:
CreatePipeline, which creates a uniquely named pipeline.
DeletePipeline, which deletes the specified pipeline.
GetPipeline, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).
GetPipelineExecution, which returns information about a specific execution of a pipeline.
GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
ListActionExecutions, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.
ListPipelines, which gets a summary of all of the pipelines associated with your account.
ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
StartPipelineExecution, which runs the most recent revision of an artifact through the pipeline.
StopPipelineExecution, which stops the specified pipeline execution from continuing through the pipeline.
UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see CodePipeline Pipeline Structure Reference.
Pipeline stages include actions that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState. Valid action categories are:
Source
Build
Test
Deploy
Approval
Invoke
Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with CodePipeline
For third-party integrators or developers who want to create their own integrations with CodePipeline, the expected sequence varies from the standard API user. To integrate with CodePipeline, developers need to work with the following items:
Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
You can work with jobs by calling:
AcknowledgeJob, which confirms whether a job worker has received the specified job.
GetJobDetails, which returns the details of a job.
PollForJobs, which determines whether there are any jobs to act on.
PutJobFailureResult, which provides details of a job failure.
PutJobSuccessResult, which provides details of a job success.
Third party jobs, which are instances of an action created by a partner action and integrated into CodePipeline. Partner actions are created by members of the Amazon Web Services Partner Network.
You can work with third party jobs by calling:
AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job.
GetThirdPartyJobDetails, which requests the details of a job for a partner action.
PollForThirdPartyJobs, which determines whether there are any jobs to act on.
PutThirdPartyJobFailureResult, which provides details of a job failure.
PutThirdPartyJobSuccessResult, which provides details of a job success.
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.
ArtifactRevision objects included in a pipeline execution.
description: Represents information about an execution of a pipeline.
GetPipelineExecutionOutput:
type: object
properties:
pipelineExecution:
allOf:
- $ref: '#/components/schemas/PipelineExecution'
- description: Represents information about the execution of a pipeline.
description: Represents the output of a GetPipelineExecution action.
PipelineVersion:
type: integer
minimum: 1
Revision:
type: string
minLength: 1
maxLength: 1500
PipelineExecutionNotFoundException: {}
ArtifactRevision:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/ArtifactName'
- description: The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user when an action is created.
revisionId:
allOf:
- $ref: '#/components/schemas/Revision'
- description: The revision ID of the artifact.
revisionChangeIdentifier:
allOf:
- $ref: '#/components/schemas/RevisionChangeIdentifier'
- description: An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
revisionSummary:
allOf:
- $ref: '#/components/schemas/RevisionSummary'
- description: Summary information about the most recent revision of the artifact. For GitHub and CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.
created:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date and time when the most recent revision of the artifact was created, in timestamp format.
revisionUrl:
allOf:
- $ref: '#/components/schemas/Url'
- description: The commit ID for the artifact revision. For artifacts stored in GitHub or CodeCommit repositories, the commit ID is linked to a commit details page.
description: 'Represents revision details of an artifact. '
ValidationException: {}
PipelineExecutionStatusSummary:
type: string
PipelineName:
type: string
pattern: '[A-Za-z0-9.@\-_]+'
minLength: 1
maxLength: 100
GetPipelineExecutionInput:
type: object
required:
- pipelineName
- pipelineExecutionId
title: GetPipelineExecutionInput
properties:
pipelineName:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline about which you want to get execution details.
pipelineExecutionId:
allOf:
- $ref: '#/components/schemas/PipelineExecutionId'
- description: The ID of the pipeline execution about which you want to get execution details.
description: Represents the input of a GetPipelineExecution action.
Url:
type: string
minLength: 1
maxLength: 2048
PipelineExecutionId:
type: string
pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
RevisionSummary:
type: string
minLength: 1
maxLength: 2048
PipelineNotFoundException: {}
RevisionChangeIdentifier:
type: string
minLength: 1
maxLength: 100
Timestamp:
type: string
format: date-time
ArtifactName:
type: string
pattern: '[a-zA-Z0-9_\-]+'
minLength: 1
maxLength: 100
PipelineExecutionStatus:
type: string
enum:
- Cancelled
- InProgress
- Stopped
- Stopping
- Succeeded
- Superseded
- Failed
ArtifactRevisionList:
type: array
items:
$ref: '#/components/schemas/ArtifactRevision'
parameters:
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/codepipeline/
x-hasEquivalentPaths: true