AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the AWS CodePipeline User Guide.
You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described below.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages.
You can work with pipelines by calling:
Pipelines include stages, which are which are logical groupings of gates and
actions. Each stage contains one or more actions that must complete before the next
stage begins. A stage will result in success or failure. If a stage fails, then the
pipeline stops at that stage and will remain stopped until either a new version of
an artifact appears in the source location, or a user takes action to re-run 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, also refer to the
Pipeline stages include actions, which are categorized into categories such as source or build actions performed within 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.
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:
Using the API to integrate with AWS CodePipeline
For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. In order to integrate with AWS CodePipeline, developers will need to work with the following items:
You can work with jobs by calling:
You can work with third party jobs by calling:
Namespace: Amazon.CodePipeline
Assembly: AWSSDK.dll
Version: (assembly version)
public interface IAmazonCodePipeline IDisposable
The IAmazonCodePipeline type exposes the following members
Name | Description | |
---|---|---|
AcknowledgeJob(string, string) | Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions. | |
AcknowledgeJob(AcknowledgeJobRequest) | Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions. | |
AcknowledgeJobAsync(AcknowledgeJobRequest, CancellationToken) | Initiates the asynchronous execution of the AcknowledgeJob operation. | |
AcknowledgeThirdPartyJob(string, string, string) | Confirms a job worker has received the specified job. Only used for partner actions. | |
AcknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest) | Confirms a job worker has received the specified job. Only used for partner actions. | |
AcknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest, CancellationToken) | Initiates the asynchronous execution of the AcknowledgeThirdPartyJob operation. | |
CreateCustomActionType(CreateCustomActionTypeRequest) | Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions. | |
CreateCustomActionTypeAsync(CreateCustomActionTypeRequest, CancellationToken) | Initiates the asynchronous execution of the CreateCustomActionType operation. | |
CreatePipeline(PipelineDeclaration) | Creates a pipeline. | |
CreatePipeline(CreatePipelineRequest) | Creates a pipeline. | |
CreatePipelineAsync(CreatePipelineRequest, CancellationToken) | Initiates the asynchronous execution of the CreatePipeline operation. | |
DeleteCustomActionType(DeleteCustomActionTypeRequest) |
Marks a custom action as deleted. PollForJobs for the custom action will fail after
the action is marked for deletion. Only used for custom actions.
You cannot recreate a custom action after it has been deleted unless you increase the version number of the action. |
|
DeleteCustomActionTypeAsync(DeleteCustomActionTypeRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteCustomActionType operation. | |
DeletePipeline(string) | Deletes the specified pipeline. | |
DeletePipeline(DeletePipelineRequest) | Deletes the specified pipeline. | |
DeletePipelineAsync(DeletePipelineRequest, CancellationToken) | Initiates the asynchronous execution of the DeletePipeline operation. | |
DisableStageTransition(DisableStageTransitionRequest) | Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline. | |
DisableStageTransitionAsync(DisableStageTransitionRequest, CancellationToken) | Initiates the asynchronous execution of the DisableStageTransition operation. | |
EnableStageTransition(EnableStageTransitionRequest) | Enables artifacts in a pipeline to transition to a stage in a pipeline. | |
EnableStageTransitionAsync(EnableStageTransitionRequest, CancellationToken) | Initiates the asynchronous execution of the EnableStageTransition operation. | |
GetJobDetails(string) |
Returns information about a job. Only used for custom actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. |
|
GetJobDetails(GetJobDetailsRequest) |
Returns information about a job. Only used for custom actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. |
|
GetJobDetailsAsync(GetJobDetailsRequest, CancellationToken) | Initiates the asynchronous execution of the GetJobDetails operation. | |
GetPipeline(string, int) | Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline. | |
GetPipeline(string) | Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline. | |
GetPipeline(GetPipelineRequest) | Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline. | |
GetPipelineAsync(GetPipelineRequest, CancellationToken) | Initiates the asynchronous execution of the GetPipeline operation. | |
GetPipelineState(string) | Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline. | |
GetPipelineState(GetPipelineStateRequest) | Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline. | |
GetPipelineStateAsync(GetPipelineStateRequest, CancellationToken) | Initiates the asynchronous execution of the GetPipelineState operation. | |
GetThirdPartyJobDetails(string, string) |
Requests the details of a job for a third party action. Only used for partner actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. |
|
GetThirdPartyJobDetails(GetThirdPartyJobDetailsRequest) |
Requests the details of a job for a third party action. Only used for partner actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. |
|
GetThirdPartyJobDetailsAsync(GetThirdPartyJobDetailsRequest, CancellationToken) | Initiates the asynchronous execution of the GetThirdPartyJobDetails operation. | |
ListActionTypes() | Gets a summary of all AWS CodePipeline action types associated with your account. | |
ListActionTypes(ActionOwner) | Gets a summary of all AWS CodePipeline action types associated with your account. | |
ListActionTypes(ListActionTypesRequest) | Gets a summary of all AWS CodePipeline action types associated with your account. | |
ListActionTypesAsync(ListActionTypesRequest, CancellationToken) | Initiates the asynchronous execution of the ListActionTypes operation. | |
ListPipelines() | Gets a summary of all of the pipelines associated with your account. | |
ListPipelines(ListPipelinesRequest) | Gets a summary of all of the pipelines associated with your account. | |
ListPipelinesAsync(ListPipelinesRequest, CancellationToken) | Initiates the asynchronous execution of the ListPipelines operation. | |
PollForJobs(PollForJobsRequest) |
Returns information about any jobs for AWS CodePipeline to act upon.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. |
|
PollForJobsAsync(PollForJobsRequest, CancellationToken) | Initiates the asynchronous execution of the PollForJobs operation. | |
PollForThirdPartyJobs(PollForThirdPartyJobsRequest) |
Determines whether there are any third party jobs for a job worker to act on. Only
used for partner actions.
When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. |
|
PollForThirdPartyJobsAsync(PollForThirdPartyJobsRequest, CancellationToken) | Initiates the asynchronous execution of the PollForThirdPartyJobs operation. | |
PutActionRevision(PutActionRevisionRequest) | Provides information to AWS CodePipeline about new revisions to a source. | |
PutActionRevisionAsync(PutActionRevisionRequest, CancellationToken) | Initiates the asynchronous execution of the PutActionRevision operation. | |
PutJobFailureResult(string, FailureDetails) | Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions. | |
PutJobFailureResult(PutJobFailureResultRequest) | Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions. | |
PutJobFailureResultAsync(PutJobFailureResultRequest, CancellationToken) | Initiates the asynchronous execution of the PutJobFailureResult operation. | |
PutJobSuccessResult(PutJobSuccessResultRequest) | Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions. | |
PutJobSuccessResultAsync(PutJobSuccessResultRequest, CancellationToken) | Initiates the asynchronous execution of the PutJobSuccessResult operation. | |
PutThirdPartyJobFailureResult(string, string, FailureDetails) | Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions. | |
PutThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest) | Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions. | |
PutThirdPartyJobFailureResultAsync(PutThirdPartyJobFailureResultRequest, CancellationToken) | Initiates the asynchronous execution of the PutThirdPartyJobFailureResult operation. | |
PutThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest) | Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions. | |
PutThirdPartyJobSuccessResultAsync(PutThirdPartyJobSuccessResultRequest, CancellationToken) | Initiates the asynchronous execution of the PutThirdPartyJobSuccessResult operation. | |
StartPipelineExecution(string) | Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. | |
StartPipelineExecution(StartPipelineExecutionRequest) | Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. | |
StartPipelineExecutionAsync(StartPipelineExecutionRequest, CancellationToken) | Initiates the asynchronous execution of the StartPipelineExecution operation. | |
UpdatePipeline(PipelineDeclaration) | Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1. | |
UpdatePipeline(UpdatePipelineRequest) | Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1. | |
UpdatePipelineAsync(UpdatePipelineRequest, CancellationToken) | Initiates the asynchronous execution of the UpdatePipeline operation. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5