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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginPutWebhook and EndPutWebhook.

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

Syntax

C#
public abstract Task<PutWebhookResponse> PutWebhookAsync(
         PutWebhookRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CodePipeline.Model.PutWebhookRequest

Container for the necessary parameters to execute the PutWebhook service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the PutWebhook service method, as returned by CodePipeline.

Exceptions

ExceptionCondition
ConcurrentModificationException Unable to modify the tag due to a simultaneous update request.
InvalidTagsException The specified resource tags are invalid.
InvalidWebhookAuthenticationParametersException The specified authentication type is in an invalid format.
InvalidWebhookFilterPatternException The specified event filter rule is in an invalid format.
LimitExceededException The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.
PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
TooManyTagsException The tags limit for a resource has been exceeded.
ValidationException The validation was specified in an invalid format.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also