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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to GetPipelineStateAsync.

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

Syntax

C#
public abstract GetPipelineStateResponse GetPipelineState(
         GetPipelineStateRequest request
)
Parameters
request
Type: Amazon.CodePipeline.Model.GetPipelineStateRequest

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

Return Value
The response from the GetPipelineState service method, as returned by CodePipeline.

Exceptions

ExceptionCondition
PipelineNotFoundException The specified pipeline was specified in an invalid format or cannot be found.
ValidationException The validation was specified in an invalid format.

Examples

This example returns the most recent state of a pipeline named MyFirstPipeline.

View information about the state of a pipeline


var response = client.GetPipelineState(new GetPipelineStateRequest 
{
    Name = "MyFirstPipeline"
});

DateTime created = response.Created; // The value for created and all other time- and date-related information such as lastStatusChange, is returned in timestamp format.
string pipelineName = response.PipelineName;
integer pipelineVersion = response.PipelineVersion;
List stageStates = response.StageStates;
DateTime updated = response.Updated;

            

Version Information

.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

See Also