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

Contents

Description

Returns information about the state of a pipeline, including the stages and actions.

Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.

Synopsis

data GetPipelineState = GetPipelineState' {
- name :: Text
}
newGetPipelineState :: Text -> GetPipelineState
getPipelineState_name :: Lens' GetPipelineState Text
data GetPipelineStateResponse = GetPipelineStateResponse' {
- created :: Maybe POSIX
- pipelineName :: Maybe Text
- pipelineVersion :: Maybe Natural
- stageStates :: Maybe [StageState]
- updated :: Maybe POSIX
- httpStatus :: Int
}
newGetPipelineStateResponse :: Int -> GetPipelineStateResponse
getPipelineStateResponse_created :: Lens' GetPipelineStateResponse (Maybe UTCTime)
getPipelineStateResponse_pipelineName :: Lens' GetPipelineStateResponse (Maybe Text)
getPipelineStateResponse_pipelineVersion :: Lens' GetPipelineStateResponse (Maybe Natural)
getPipelineStateResponse_stageStates :: Lens' GetPipelineStateResponse (Maybe [StageState])
getPipelineStateResponse_updated :: Lens' GetPipelineStateResponse (Maybe UTCTime)
getPipelineStateResponse_httpStatus :: Lens' GetPipelineStateResponse Int

Creating a Request

data GetPipelineState Source #

Represents the input of a GetPipelineState action.

See: newGetPipelineState smart constructor.

Constructors

GetPipelineState'
Fields name :: Text The name of the pipeline about which you want to get information.

Instances

Instances details

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

newGetPipelineState Source #

Arguments

:: Text	`GetPipelineState`
-> GetPipelineState

Create a value of GetPipelineState 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:

GetPipelineState, getPipelineState_name - The name of the pipeline about which you want to get information.

Request Lenses

getPipelineState_name :: Lens' GetPipelineState Text Source #

The name of the pipeline about which you want to get information.

Destructuring the Response

data GetPipelineStateResponse Source #

Represents the output of a GetPipelineState action.

See: newGetPipelineStateResponse smart constructor.

Constructors

GetPipelineStateResponse'

Fields

created :: Maybe POSIX
The date and time the pipeline was created, in timestamp format.
pipelineName :: Maybe Text
The name of the pipeline for which you want to get the state.
pipelineVersion :: Maybe Natural
The version number of the pipeline.
A newly created pipeline is always assigned a version number of 1.
stageStates :: Maybe [StageState]
A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.
updated :: Maybe POSIX
The date and time the pipeline was last updated, in timestamp format.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetPipelineStateResponse Source #
Instance details Defined in Amazonka.CodePipeline.GetPipelineState Associated Types type Rep GetPipelineStateResponse :: Type -> Type # Methods from :: GetPipelineStateResponse -> Rep GetPipelineStateResponse x # to :: Rep GetPipelineStateResponse x -> GetPipelineStateResponse #
Read GetPipelineStateResponse Source #
Instance details Defined in Amazonka.CodePipeline.GetPipelineState Methods readsPrec :: Int -> ReadS GetPipelineStateResponse # readList :: ReadS [GetPipelineStateResponse] # readPrec :: ReadPrec GetPipelineStateResponse # readListPrec :: ReadPrec [GetPipelineStateResponse] #
Show GetPipelineStateResponse Source #
Instance details Defined in Amazonka.CodePipeline.GetPipelineState Methods showsPrec :: Int -> GetPipelineStateResponse -> ShowS # show :: GetPipelineStateResponse -> String # showList :: [GetPipelineStateResponse] -> ShowS #
NFData GetPipelineStateResponse Source #
Instance details Defined in Amazonka.CodePipeline.GetPipelineState Methods rnf :: GetPipelineStateResponse -> () #
Eq GetPipelineStateResponse Source #
Instance details Defined in Amazonka.CodePipeline.GetPipelineState Methods (==) :: GetPipelineStateResponse -> GetPipelineStateResponse -> Bool # (/=) :: GetPipelineStateResponse -> GetPipelineStateResponse -> Bool #
type Rep GetPipelineStateResponse Source #
Instance details Defined in Amazonka.CodePipeline.GetPipelineState type Rep GetPipelineStateResponse = D1 ('MetaData "GetPipelineStateResponse" "Amazonka.CodePipeline.GetPipelineState" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "GetPipelineStateResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "pipelineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pipelineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: (S1 ('MetaSel ('Just "stageStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StageState])) :: (S1 ('MetaSel ('Just "updated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetPipelineStateResponse Source #

Arguments

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

Create a value of GetPipelineStateResponse 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:

GetPipelineStateResponse, getPipelineStateResponse_created - The date and time the pipeline was created, in timestamp format.

GetPipelineStateResponse, getPipelineStateResponse_pipelineName - The name of the pipeline for which you want to get the state.

GetPipelineStateResponse, getPipelineStateResponse_pipelineVersion - The version number of the pipeline.

A newly created pipeline is always assigned a version number of 1.

$sel:stageStates:GetPipelineStateResponse', getPipelineStateResponse_stageStates - A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.

GetPipelineStateResponse, getPipelineStateResponse_updated - The date and time the pipeline was last updated, in timestamp format.

$sel:httpStatus:GetPipelineStateResponse', getPipelineStateResponse_httpStatus - The response's http status code.

Response Lenses

getPipelineStateResponse_created :: Lens' GetPipelineStateResponse (Maybe UTCTime) Source #

The date and time the pipeline was created, in timestamp format.

getPipelineStateResponse_pipelineName :: Lens' GetPipelineStateResponse (Maybe Text) Source #

The name of the pipeline for which you want to get the state.

getPipelineStateResponse_pipelineVersion :: Lens' GetPipelineStateResponse (Maybe Natural) Source #

The version number of the pipeline.

A newly created pipeline is always assigned a version number of 1.

getPipelineStateResponse_stageStates :: Lens' GetPipelineStateResponse (Maybe [StageState]) Source #

A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.

getPipelineStateResponse_updated :: Lens' GetPipelineStateResponse (Maybe UTCTime) Source #

The date and time the pipeline was last updated, in timestamp format.

getPipelineStateResponse_httpStatus :: Lens' GetPipelineStateResponse Int Source #

The response's http status code.