AWS SDK Version 3 for .NET
API Reference

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.

Implementation for accessing CodePipeline AWS CodePipeline

Overview

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 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 AWS CodePipeline Pipeline Structure Reference.

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:

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:

Third party jobs, which are instances of an action created by a partner action and integrated into AWS CodePipeline. Partner actions are created by members of the AWS Partner Network.

You can work with third party jobs by calling:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.CodePipeline.AmazonCodePipelineClient

Namespace: Amazon.CodePipeline
Assembly: AWSSDK.CodePipeline.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonCodePipelineClient : AmazonServiceClient
         IAmazonCodePipeline, IAmazonService, IDisposable

The AmazonCodePipelineClient type exposes the following members

Constructors

NameDescription
Public Method AmazonCodePipelineClient()

Constructs AmazonCodePipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonCodePipelineClient(RegionEndpoint)

Constructs AmazonCodePipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonCodePipelineClient(AmazonCodePipelineConfig)

Constructs AmazonCodePipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonCodePipelineClient(AWSCredentials)

Constructs AmazonCodePipelineClient with AWS Credentials

Public Method AmazonCodePipelineClient(AWSCredentials, RegionEndpoint)

Constructs AmazonCodePipelineClient with AWS Credentials

Public Method AmazonCodePipelineClient(AWSCredentials, AmazonCodePipelineConfig)

Constructs AmazonCodePipelineClient with AWS Credentials and an AmazonCodePipelineClient Configuration object.

Public Method AmazonCodePipelineClient(string, string)

Constructs AmazonCodePipelineClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCodePipelineClient(string, string, RegionEndpoint)

Constructs AmazonCodePipelineClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCodePipelineClient(string, string, AmazonCodePipelineConfig)

Constructs AmazonCodePipelineClient with AWS Access Key ID, AWS Secret Key and an AmazonCodePipelineClient Configuration object.

Public Method AmazonCodePipelineClient(string, string, string)

Constructs AmazonCodePipelineClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCodePipelineClient(string, string, string, RegionEndpoint)

Constructs AmazonCodePipelineClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCodePipelineClient(string, string, string, AmazonCodePipelineConfig)

Constructs AmazonCodePipelineClient with AWS Access Key ID, AWS Secret Key and an AmazonCodePipelineClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method 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.

Public Method AcknowledgeJob(AcknowledgeJobRequest)

Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.

Public Method AcknowledgeJobAsync(string, string, CancellationToken)

Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.

Public Method AcknowledgeJobAsync(AcknowledgeJobRequest, CancellationToken)

Initiates the asynchronous execution of the AcknowledgeJob operation.

Public Method AcknowledgeThirdPartyJob(string, string, string)

Confirms a job worker has received the specified job. Only used for partner actions.

Public Method AcknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest)

Confirms a job worker has received the specified job. Only used for partner actions.

Public Method AcknowledgeThirdPartyJobAsync(string, string, string, CancellationToken)

Confirms a job worker has received the specified job. Only used for partner actions.

Public Method AcknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest, CancellationToken)

Initiates the asynchronous execution of the AcknowledgeThirdPartyJob operation.

Public Method CreateCustomActionType(CreateCustomActionTypeRequest)

Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.

Public Method CreateCustomActionTypeAsync(CreateCustomActionTypeRequest, CancellationToken)

Initiates the asynchronous execution of the CreateCustomActionType operation.

Public Method CreatePipeline(PipelineDeclaration)

Creates a pipeline.

Public Method CreatePipeline(CreatePipelineRequest)

Creates a pipeline.

Public Method CreatePipelineAsync(PipelineDeclaration, CancellationToken)

Creates a pipeline.

Public Method CreatePipelineAsync(CreatePipelineRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePipeline operation.

Public Method 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.

Public Method DeleteCustomActionTypeAsync(DeleteCustomActionTypeRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteCustomActionType operation.

Public Method DeletePipeline(string)

Deletes the specified pipeline.

Public Method DeletePipeline(DeletePipelineRequest)

Deletes the specified pipeline.

Public Method DeletePipelineAsync(string, CancellationToken)

Deletes the specified pipeline.

Public Method DeletePipelineAsync(DeletePipelineRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePipeline operation.

Public Method DisableStageTransition(DisableStageTransitionRequest)

Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.

Public Method DisableStageTransitionAsync(DisableStageTransitionRequest, CancellationToken)

Initiates the asynchronous execution of the DisableStageTransition operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method EnableStageTransition(EnableStageTransitionRequest)

Enables artifacts in a pipeline to transition to a stage in a pipeline.

Public Method EnableStageTransitionAsync(EnableStageTransitionRequest, CancellationToken)

Initiates the asynchronous execution of the EnableStageTransition operation.

Public Method 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.

Public Method 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.

Public Method GetJobDetailsAsync(string, CancellationToken)

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.

Public Method GetJobDetailsAsync(GetJobDetailsRequest, CancellationToken)

Initiates the asynchronous execution of the GetJobDetails operation.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method GetPipelineAsync(string, int, CancellationToken)

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.

Public Method GetPipelineAsync(string, CancellationToken)

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.

Public Method GetPipelineAsync(GetPipelineRequest, CancellationToken)

Initiates the asynchronous execution of the GetPipeline operation.

Public Method GetPipelineExecution(GetPipelineExecutionRequest)

Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.

Public Method GetPipelineExecutionAsync(GetPipelineExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the GetPipelineExecution operation.

Public Method GetPipelineState(string)

Returns information about the state of a pipeline, including the stages and actions.

Public Method GetPipelineState(GetPipelineStateRequest)

Returns information about the state of a pipeline, including the stages and actions.

Public Method GetPipelineStateAsync(string, CancellationToken)

Returns information about the state of a pipeline, including the stages and actions.

Public Method GetPipelineStateAsync(GetPipelineStateRequest, CancellationToken)

Initiates the asynchronous execution of the GetPipelineState operation.

Public Method 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.

Public Method 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.

Public Method GetThirdPartyJobDetailsAsync(string, string, CancellationToken)

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.

Public Method GetThirdPartyJobDetailsAsync(GetThirdPartyJobDetailsRequest, CancellationToken)

Initiates the asynchronous execution of the GetThirdPartyJobDetails operation.

Public Method ListActionTypes()

Gets a summary of all AWS CodePipeline action types associated with your account.

Public Method ListActionTypes(ActionOwner)

Gets a summary of all AWS CodePipeline action types associated with your account.

Public Method ListActionTypes(ListActionTypesRequest)

Gets a summary of all AWS CodePipeline action types associated with your account.

Public Method ListActionTypesAsync(CancellationToken)

Gets a summary of all AWS CodePipeline action types associated with your account.

Public Method ListActionTypesAsync(ActionOwner, CancellationToken)

Gets a summary of all AWS CodePipeline action types associated with your account.

Public Method ListActionTypesAsync(ListActionTypesRequest, CancellationToken)

Initiates the asynchronous execution of the ListActionTypes operation.

Public Method ListPipelineExecutions(ListPipelineExecutionsRequest)

Gets a summary of the most recent executions for a pipeline.

Public Method ListPipelineExecutionsAsync(ListPipelineExecutionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListPipelineExecutions operation.

Public Method ListPipelines()

Gets a summary of all of the pipelines associated with your account.

Public Method ListPipelines(ListPipelinesRequest)

Gets a summary of all of the pipelines associated with your account.

Public Method ListPipelinesAsync(CancellationToken)

Gets a summary of all of the pipelines associated with your account.

Public Method ListPipelinesAsync(ListPipelinesRequest, CancellationToken)

Initiates the asynchronous execution of the ListPipelines operation.

Public Method 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.

Public Method PollForJobsAsync(PollForJobsRequest, CancellationToken)

Initiates the asynchronous execution of the PollForJobs operation.

Public Method 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.

Public Method PollForThirdPartyJobsAsync(PollForThirdPartyJobsRequest, CancellationToken)

Initiates the asynchronous execution of the PollForThirdPartyJobs operation.

Public Method PutActionRevision(PutActionRevisionRequest)

Provides information to AWS CodePipeline about new revisions to a source.

Public Method PutActionRevisionAsync(PutActionRevisionRequest, CancellationToken)

Initiates the asynchronous execution of the PutActionRevision operation.

Public Method PutApprovalResult(PutApprovalResultRequest)

Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.

Public Method PutApprovalResultAsync(PutApprovalResultRequest, CancellationToken)

Initiates the asynchronous execution of the PutApprovalResult operation.

Public Method PutJobFailureResult(string, FailureDetails)

Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.

Public Method PutJobFailureResult(PutJobFailureResultRequest)

Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.

Public Method PutJobFailureResultAsync(string, FailureDetails, CancellationToken)

Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.

Public Method PutJobFailureResultAsync(PutJobFailureResultRequest, CancellationToken)

Initiates the asynchronous execution of the PutJobFailureResult operation.

Public Method PutJobSuccessResult(PutJobSuccessResultRequest)

Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.

Public Method PutJobSuccessResultAsync(PutJobSuccessResultRequest, CancellationToken)

Initiates the asynchronous execution of the PutJobSuccessResult operation.

Public Method 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.

Public Method PutThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest)

Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.

Public Method PutThirdPartyJobFailureResultAsync(string, string, FailureDetails, CancellationToken)

Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.

Public Method PutThirdPartyJobFailureResultAsync(PutThirdPartyJobFailureResultRequest, CancellationToken)

Initiates the asynchronous execution of the PutThirdPartyJobFailureResult operation.

Public Method PutThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest)

Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.

Public Method PutThirdPartyJobSuccessResultAsync(PutThirdPartyJobSuccessResultRequest, CancellationToken)

Initiates the asynchronous execution of the PutThirdPartyJobSuccessResult operation.

Public Method RetryStageExecution(RetryStageExecutionRequest)

Resumes the pipeline execution by retrying the last failed actions in a stage.

Public Method RetryStageExecutionAsync(RetryStageExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the RetryStageExecution operation.

Public Method StartPipelineExecution(string)

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

Public Method StartPipelineExecution(StartPipelineExecutionRequest)

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

Public Method StartPipelineExecutionAsync(string, CancellationToken)

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

Public Method StartPipelineExecutionAsync(StartPipelineExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the StartPipelineExecution operation.

Public Method 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.

Public Method 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.

Public Method UpdatePipelineAsync(PipelineDeclaration, CancellationToken)

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.

Public Method UpdatePipelineAsync(UpdatePipelineRequest, CancellationToken)

Initiates the asynchronous execution of the UpdatePipeline operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms