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.

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.

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 BeginGetPipelineState and EndGetPipelineState.

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

Syntax

C#
public virtual Task<GetPipelineStateResponse> GetPipelineStateAsync(
         GetPipelineStateRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CodePipeline.Model.GetPipelineStateRequest

Container for the necessary parameters to execute the GetPipelineState 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 GetPipelineState service method, as returned by CodePipeline.

Exceptions

ExceptionCondition
PipelineNotFoundException The pipeline was specified in an invalid format or cannot be found.
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