IAmazonCodePipeline.GetPipeline Method (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.

Note:

For .NET Core 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

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

Type: GetPipelineResponse

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

Exceptions

Exception	Condition
PipelineNotFoundException	The pipeline was specified in an invalid format or cannot be found.
PipelineVersionNotFoundException	The 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 client = new AmazonCodePipelineClient();
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

IAmazonCodePipeline.GetPipeline (GetPipelineRequest)

Method