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

CodePipeline

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:

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:

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 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:

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:

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.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

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.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

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.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

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.
Public Property Paginators Amazon.CodePipeline.Model.ICodePipelinePaginatorFactory

Paginators for the service

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. Used for custom actions only.

Public Method AcknowledgeJob(AcknowledgeJobRequest)

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

Public Method AcknowledgeJobAsync(string, string, CancellationToken)

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

Public Method AcknowledgeJobAsync(AcknowledgeJobRequest, CancellationToken)

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

Public Method AcknowledgeThirdPartyJob(string, string, string)

Confirms a job worker has received the specified job. Used for partner actions only.

Public Method AcknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest)

Confirms a job worker has received the specified job. Used for partner actions only.

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

Confirms a job worker has received the specified job. Used for partner actions only.

Public Method AcknowledgeThirdPartyJobAsync(AcknowledgeThirdPartyJobRequest, CancellationToken)

Confirms a job worker has received the specified job. Used for partner actions only.

Public Method CreateCustomActionType(CreateCustomActionTypeRequest)

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

Public Method CreateCustomActionTypeAsync(CreateCustomActionTypeRequest, CancellationToken)

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

Public Method CreatePipeline(PipelineDeclaration)

Creates a pipeline.

In the pipeline structure, 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.

Public Method CreatePipeline(CreatePipelineRequest)

Creates a pipeline.

In the pipeline structure, 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.

Public Method CreatePipelineAsync(PipelineDeclaration, CancellationToken)

Creates a pipeline.

In the pipeline structure, 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.

Public Method CreatePipelineAsync(CreatePipelineRequest, CancellationToken)

Creates a pipeline.

In the pipeline structure, 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.

Public Method DeleteCustomActionType(DeleteCustomActionTypeRequest)

Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only.

To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.

Public Method DeleteCustomActionTypeAsync(DeleteCustomActionTypeRequest, CancellationToken)

Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only.

To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.

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)

Deletes the specified pipeline.

Public Method DeleteWebhook(DeleteWebhookRequest)

Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.

Public Method DeleteWebhookAsync(DeleteWebhookRequest, CancellationToken)

Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.

Public Method DeregisterWebhookWithThirdParty(DeregisterWebhookWithThirdPartyRequest)

Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.

Public Method DeregisterWebhookWithThirdPartyAsync(DeregisterWebhookWithThirdPartyRequest, CancellationToken)

Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method DisableStageTransition(DisableStageTransitionRequest)

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

Public Method DisableStageTransitionAsync(DisableStageTransitionRequest, CancellationToken)

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

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)

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

Public Method GetActionType(GetActionTypeRequest)

Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.

Public Method GetActionTypeAsync(GetActionTypeRequest, CancellationToken)

Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.

Public Method GetJobDetails(string)

Returns information about a job. Used for custom actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

Public Method GetJobDetails(GetJobDetailsRequest)

Returns information about a job. Used for custom actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

Public Method GetJobDetailsAsync(string, CancellationToken)

Returns information about a job. Used for custom actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

Public Method GetJobDetailsAsync(GetJobDetailsRequest, CancellationToken)

Returns information about a job. Used for custom actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

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)

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 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)

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 GetPipelineState(string)

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

Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.

Public Method GetPipelineState(GetPipelineStateRequest)

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

Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.

Public Method GetPipelineStateAsync(string, CancellationToken)

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

Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.

Public Method GetPipelineStateAsync(GetPipelineStateRequest, CancellationToken)

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

Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.

Public Method GetThirdPartyJobDetails(string, string)

Requests the details of a job for a third party action. Used for partner actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

Public Method GetThirdPartyJobDetails(GetThirdPartyJobDetailsRequest)

Requests the details of a job for a third party action. Used for partner actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also 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. Used for partner actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

Public Method GetThirdPartyJobDetailsAsync(GetThirdPartyJobDetailsRequest, CancellationToken)

Requests the details of a job for a third party action. Used for partner actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

Public Method ListActionExecutions(ListActionExecutionsRequest)

Lists the action executions that have occurred in a pipeline.

Public Method ListActionExecutionsAsync(ListActionExecutionsRequest, CancellationToken)

Lists the action executions that have occurred in a pipeline.

Public Method ListActionTypes()

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

Public Method ListActionTypes(ActionOwner)

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

Public Method ListActionTypes(ListActionTypesRequest)

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

Public Method ListActionTypesAsync(CancellationToken)

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

Public Method ListActionTypesAsync(ActionOwner, CancellationToken)

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

Public Method ListActionTypesAsync(ListActionTypesRequest, CancellationToken)

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

Public Method ListPipelineExecutions(ListPipelineExecutionsRequest)

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

Public Method ListPipelineExecutionsAsync(ListPipelineExecutionsRequest, CancellationToken)

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

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)

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

Public Method ListTagsForResource(ListTagsForResourceRequest)

Gets the set of key-value pairs (metadata) that are used to manage the resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Gets the set of key-value pairs (metadata) that are used to manage the resource.

Public Method ListWebhooks(ListWebhooksRequest)

Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.

Public Method ListWebhooksAsync(ListWebhooksRequest, CancellationToken)

Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.

Public Method PollForJobs(PollForJobsRequest)

Returns information about any jobs for CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains AWS or ThirdParty in the owner field, the PollForJobs action returns an error.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

Public Method PollForJobsAsync(PollForJobsRequest, CancellationToken)

Returns information about any jobs for CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains AWS or ThirdParty in the owner field, the PollForJobs action returns an error.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

Public Method PollForThirdPartyJobs(PollForThirdPartyJobsRequest)

Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.

Public Method PollForThirdPartyJobsAsync(PollForThirdPartyJobsRequest, CancellationToken)

Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.

Public Method PutActionRevision(PutActionRevisionRequest)

Provides information to CodePipeline about new revisions to a source.

Public Method PutActionRevisionAsync(PutActionRevisionRequest, CancellationToken)

Provides information to CodePipeline about new revisions to a source.

Public Method PutApprovalResult(PutApprovalResultRequest)

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

Public Method PutApprovalResultAsync(PutApprovalResultRequest, CancellationToken)

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

Public Method PutJobFailureResult(string, FailureDetails)

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

Public Method PutJobFailureResult(PutJobFailureResultRequest)

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

Public Method PutJobFailureResultAsync(string, FailureDetails, CancellationToken)

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

Public Method PutJobFailureResultAsync(PutJobFailureResultRequest, CancellationToken)

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

Public Method PutJobSuccessResult(PutJobSuccessResultRequest)

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

Public Method PutJobSuccessResultAsync(PutJobSuccessResultRequest, CancellationToken)

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

Public Method PutThirdPartyJobFailureResult(string, string, FailureDetails)

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

Public Method PutThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest)

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

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

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

Public Method PutThirdPartyJobFailureResultAsync(PutThirdPartyJobFailureResultRequest, CancellationToken)

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

Public Method PutThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest)

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

Public Method PutThirdPartyJobSuccessResultAsync(PutThirdPartyJobSuccessResultRequest, CancellationToken)

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

Public Method PutWebhook(PutWebhookRequest)

Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.

Public Method PutWebhookAsync(PutWebhookRequest, CancellationToken)

Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.

Public Method RegisterWebhookWithThirdParty(RegisterWebhookWithThirdPartyRequest)

Configures a connection between the webhook that was created and the external tool with events to be detected.

Public Method RegisterWebhookWithThirdPartyAsync(RegisterWebhookWithThirdPartyRequest, CancellationToken)

Configures a connection between the webhook that was created and the external tool with events to be detected.

Public Method RetryStageExecution(RetryStageExecutionRequest)

You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.

Public Method RetryStageExecutionAsync(RetryStageExecutionRequest, CancellationToken)

You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.

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)

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

Public Method StopPipelineExecution(StopPipelineExecutionRequest)

Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.

Public Method StopPipelineExecutionAsync(StopPipelineExecutionRequest, CancellationToken)

Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.

Public Method TagResource(TagResourceRequest)

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Public Method UntagResource(UntagResourceRequest)

Removes tags from an Amazon Web Services resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes tags from an Amazon Web Services resource.

Public Method UpdateActionType(UpdateActionTypeRequest)

Updates an action type that was created with any supported integration model, where the action type is to be used by customers of the action type provider. Use a JSON file with the action definition and UpdateActionType to provide the full structure.

Public Method UpdateActionTypeAsync(UpdateActionTypeRequest, CancellationToken)

Updates an action type that was created with any supported integration model, where the action type is to be used by customers of the action type provider. Use a JSON file with the action definition and UpdateActionType to provide the full structure.

Public Method UpdatePipeline(PipelineDeclaration)

Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and 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 and 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 and 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)

Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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