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.

Container for the parameters to the GetPipeline operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CodePipeline.AmazonCodePipelineRequest
      Amazon.CodePipeline.Model.GetPipelineRequest

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

Syntax

C#
public class GetPipelineRequest : AmazonCodePipelineRequest
         IAmazonWebServiceRequest

The GetPipelineRequest type exposes the following members

Constructors

NameDescription
Public Method GetPipelineRequest()

Properties

NameTypeDescription
Public Property Name System.String

Gets and sets the property Name.

The name of the pipeline for which you want to get information. Pipeline names must be unique in an Amazon Web Services account.

Public Property Version System.Int32

Gets and sets the property Version.

The version number of the pipeline. If you do not specify a version, defaults to the current version.

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5