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

Note:

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

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

Syntax

C#
public abstract GetPipelineResponse GetPipeline(
         GetPipelineRequest request
)
Parameters
request
Type: Amazon.CodePipeline.Model.GetPipelineRequest

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

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

Exceptions

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

Examples

This example returns the structure of a pipeline named MyFirstPipeline.

View the structure of a pipeline


var response = client.GetPipeline(new GetPipelineRequest 
{
    Version = 123, // This is an optional parameter. If you do not specify a version, the most current version of the pipeline structure is returned.
    Name = "MyFirstPipeline"
});

PipelineDeclaration pipeline = response.Pipeline;

            

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