Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CodePipeline.GetPipeline

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Creating a Request

data GetPipeline Source #

Represents the input of a GetPipeline action.

See: newGetPipeline smart constructor.

Constructors

GetPipeline'
Fields version :: Maybe Natural The version number of the pipeline. If you do not specify a version, defaults to the current version. name :: Text The name of the pipeline for which you want to get information. Pipeline names must be unique under an AWS user account.

Instances

Instances details

ToJSON GetPipeline Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Methods toJSON :: GetPipeline -> Value # toEncoding :: GetPipeline -> Encoding # toJSONList :: [GetPipeline] -> Value # toEncodingList :: [GetPipeline] -> Encoding #
ToHeaders GetPipeline Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Methods toHeaders :: GetPipeline -> [Header] #
ToPath GetPipeline Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Methods toPath :: GetPipeline -> ByteString #
ToQuery GetPipeline Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Methods toQuery :: GetPipeline -> QueryString #
AWSRequest GetPipeline Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Associated Types type AWSResponse GetPipeline # Methods request :: (Service -> Service) -> GetPipeline -> Request GetPipeline # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetPipeline -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetPipeline))) #
Generic GetPipeline Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Associated Types type Rep GetPipeline :: Type -> Type # Methods from :: GetPipeline -> Rep GetPipeline x # to :: Rep GetPipeline x -> GetPipeline #
Read GetPipeline Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Methods readsPrec :: Int -> ReadS GetPipeline # readList :: ReadS [GetPipeline] # readPrec :: ReadPrec GetPipeline # readListPrec :: ReadPrec [GetPipeline] #
Show GetPipeline Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Methods showsPrec :: Int -> GetPipeline -> ShowS # show :: GetPipeline -> String # showList :: [GetPipeline] -> ShowS #
NFData GetPipeline Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Methods rnf :: GetPipeline -> () #
Eq GetPipeline Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Methods (==) :: GetPipeline -> GetPipeline -> Bool # (/=) :: GetPipeline -> GetPipeline -> Bool #
Hashable GetPipeline Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Methods hashWithSalt :: Int -> GetPipeline -> Int # hash :: GetPipeline -> Int #
type AWSResponse GetPipeline Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline type AWSResponse GetPipeline = GetPipelineResponse
type Rep GetPipeline Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline type Rep GetPipeline = D1 ('MetaData "GetPipeline" "Amazonka.CodePipeline.GetPipeline" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "GetPipeline'" 'PrefixI 'True) (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetPipeline Source #

Arguments

:: Text	`GetPipeline`
-> GetPipeline

Create a value of GetPipeline with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

GetPipeline, getPipeline_name - The name of the pipeline for which you want to get information. Pipeline names must be unique under an AWS user account.

Request Lenses

getPipeline_version :: Lens' GetPipeline (Maybe Natural) Source #

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

getPipeline_name :: Lens' GetPipeline Text Source #

The name of the pipeline for which you want to get information. Pipeline names must be unique under an AWS user account.

Destructuring the Response

data GetPipelineResponse Source #

Represents the output of a GetPipeline action.

See: newGetPipelineResponse smart constructor.

Constructors

GetPipelineResponse'
Fields metadata :: Maybe PipelineMetadata Represents the pipeline metadata information returned as part of the output of a `GetPipeline` action. pipeline :: Maybe PipelineDeclaration Represents the structure of actions and stages to be performed in the pipeline. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetPipelineResponse Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Associated Types type Rep GetPipelineResponse :: Type -> Type # Methods from :: GetPipelineResponse -> Rep GetPipelineResponse x # to :: Rep GetPipelineResponse x -> GetPipelineResponse #
Read GetPipelineResponse Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Methods readsPrec :: Int -> ReadS GetPipelineResponse # readList :: ReadS [GetPipelineResponse] # readPrec :: ReadPrec GetPipelineResponse # readListPrec :: ReadPrec [GetPipelineResponse] #
Show GetPipelineResponse Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Methods showsPrec :: Int -> GetPipelineResponse -> ShowS # show :: GetPipelineResponse -> String # showList :: [GetPipelineResponse] -> ShowS #
NFData GetPipelineResponse Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Methods rnf :: GetPipelineResponse -> () #
Eq GetPipelineResponse Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline Methods (==) :: GetPipelineResponse -> GetPipelineResponse -> Bool # (/=) :: GetPipelineResponse -> GetPipelineResponse -> Bool #
type Rep GetPipelineResponse Source #
Instance details Defined in Amazonka.CodePipeline.GetPipeline type Rep GetPipelineResponse = D1 ('MetaData "GetPipelineResponse" "Amazonka.CodePipeline.GetPipeline" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "GetPipelineResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipelineMetadata)) :: (S1 ('MetaSel ('Just "pipeline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipelineDeclaration)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetPipelineResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetPipelineResponse'`
-> GetPipelineResponse

Create a value of GetPipelineResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:metadata:GetPipelineResponse', getPipelineResponse_metadata - Represents the pipeline metadata information returned as part of the output of a GetPipeline action.

$sel:pipeline:GetPipelineResponse', getPipelineResponse_pipeline - Represents the structure of actions and stages to be performed in the pipeline.

$sel:httpStatus:GetPipelineResponse', getPipelineResponse_httpStatus - The response's http status code.

Response Lenses

getPipelineResponse_metadata :: Lens' GetPipelineResponse (Maybe PipelineMetadata) Source #

Represents the pipeline metadata information returned as part of the output of a GetPipeline action.

getPipelineResponse_pipeline :: Lens' GetPipelineResponse (Maybe PipelineDeclaration) Source #

Represents the structure of actions and stages to be performed in the pipeline.

getPipelineResponse_httpStatus :: Lens' GetPipelineResponse Int Source #

The response's http status code.