openapi: 3.0.0
info:
version: '2015-07-09'
x-release: v4
title: 'AWS CodePipeline Executions #X Amz Target=CodePipeline 20150709.GetPipeline API'
description:
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 action''s configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.
The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
"Configuration" : { Key : Value },
The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
description: Represents information about the output of an action. ArtifactStoreType: type: string enum: - S3 GetPipelineOutput: type: object properties: pipeline: allOf: - $ref: '#/components/schemas/PipelineDeclaration' - description: 'Represents the structure of actions and stages to be performed in the pipeline. ' metadata: allOf: - $ref: '#/components/schemas/PipelineMetadata' - description: Represents the pipeline metadata information returned as part of the output of aGetPipeline action.
description: Represents the output of a GetPipeline action.
ActionName:
type: string
pattern: '[A-Za-z0-9.@\-_]+'
minLength: 1
maxLength: 100
StageDeclaration:
type: object
required:
- name
- actions
properties:
name:
allOf:
- $ref: '#/components/schemas/StageName'
- description: The name of the stage.
blockers:
allOf:
- $ref: '#/components/schemas/StageBlockerDeclarationList'
- description: Reserved for future use.
actions:
allOf:
- $ref: '#/components/schemas/StageActionDeclarationList'
- description: The actions included in a stage.
description: Represents information about a stage and its definition.
ActionCategory:
type: string
enum:
- Source
- Build
- Deploy
- Test
- Invoke
- Approval
AWSRegionName:
type: string
minLength: 4
maxLength: 30
BlockerDeclaration:
type: object
required:
- name
- type
properties:
name:
allOf:
- $ref: '#/components/schemas/BlockerName'
- description: Reserved for future use.
type:
allOf:
- $ref: '#/components/schemas/BlockerType'
- description: Reserved for future use.
description: Reserved for future use.
ActionConfigurationMap:
type: object
additionalProperties:
$ref: '#/components/schemas/ActionConfigurationValue'
ActionRunOrder:
type: integer
minimum: 1
maximum: 999
PipelineVersion:
type: integer
minimum: 1
InputArtifactList:
type: array
items:
$ref: '#/components/schemas/InputArtifact'
GetPipelineInput:
type: object
required:
- name
title: GetPipelineInput
properties:
name:
allOf:
- $ref: '#/components/schemas/PipelineName'
- description: The name of the pipeline for which you want to get information. Pipeline names must be unique in an Amazon Web Services account.
version:
allOf:
- $ref: '#/components/schemas/PipelineVersion'
- description: The version number of the pipeline. If you do not specify a version, defaults to the current version.
description: Represents the input of a GetPipeline action.
ArtifactStore:
type: object
required:
- type
- location
properties:
type:
allOf:
- $ref: '#/components/schemas/ArtifactStoreType'
- description: The type of the artifact store, such as S3.
location:
allOf:
- $ref: '#/components/schemas/ArtifactStoreLocation'
- description: The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same Amazon Web Services Region as the pipeline to store your pipeline artifacts.
encryptionKey:
allOf:
- $ref: '#/components/schemas/EncryptionKey'
- description: The encryption key used to encrypt the data in the artifact store, such as an Amazon Web Services Key Management Service key. If this is undefined, the default key for Amazon S3 is used.
description: The S3 bucket where artifacts for the pipeline are stored.
You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
artifactStore:
allOf:
- $ref: '#/components/schemas/ArtifactStore'
- description: Represents information about the S3 bucket where artifacts are stored for the pipeline.
You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
A mapping of artifactStore objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.
You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
The name of the artifact to be worked on (for example, "My App").
Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action input artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
' description: Represents information about an artifact to be worked on, such as a test or build artifact. Version: type: string pattern: '[0-9A-Za-z_-]+' minLength: 1 maxLength: 9 StageActionDeclarationList: type: array items: $ref: '#/components/schemas/ActionDeclaration' BlockerType: type: string enum: - Schedule ActionTypeId: type: object required: - category - owner - provider - version properties: category: allOf: - $ref: '#/components/schemas/ActionCategory' - description:A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values.
Source
Build
Test
Deploy
Invoke
Approval
Owner field in the action category section within your pipeline structure: AWS, ThirdParty, and Custom. For more information, see Valid Action Types and Providers in CodePipeline.'
provider:
allOf:
- $ref: '#/components/schemas/ActionProvider'
- description: The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.
version:
allOf:
- $ref: '#/components/schemas/Version'
- description: A string that describes the action version.
description: Represents information about an action type.
ActionProvider:
type: string
pattern: '[0-9A-Za-z_-]+'
minLength: 1
maxLength: 35
EncryptionKey:
type: object
required:
- id
- type
properties:
id:
allOf:
- $ref: '#/components/schemas/EncryptionKeyId'
- description: The ID used to identify the key. For an Amazon Web Services KMS key, you can use the key ID, the key ARN, or the alias ARN.
Aliases are recognized only in the account that created the KMS key. For cross-account actions, you can only use the key ID or key ARN to identify the key. Cross-account actions involve using the role from the other account (AccountB), so specifying the key ID will use the key from the other account (AccountB).