libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CodePipeline.GetPipelineState

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

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
Eq GetPipelineState Source # 
Instance details

Defined in Amazonka.CodePipeline.GetPipelineState

Methods

(==) :: GetPipelineState -> GetPipelineState -> Bool #

(/=) :: GetPipelineState -> GetPipelineState -> Bool #

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 #

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 #

NFData GetPipelineState Source # 
Instance details

Defined in Amazonka.CodePipeline.GetPipelineState

Methods

rnf :: GetPipelineState -> () #

Hashable GetPipelineState Source # 
Instance details

Defined in Amazonka.CodePipeline.GetPipelineState

Methods

hashWithSalt :: Int -> GetPipelineState -> Int #

hash :: GetPipelineState -> Int #

ToJSON GetPipelineState Source # 
Instance details

Defined in Amazonka.CodePipeline.GetPipelineState

Methods

toJSON :: GetPipelineState -> Value #

toEncoding :: GetPipelineState -> Encoding #

toJSONList :: [GetPipelineState] -> Value #

toEncodingList :: [GetPipelineState] -> Encoding #

AWSRequest GetPipelineState Source # 
Instance details

Defined in Amazonka.CodePipeline.GetPipelineState

Associated Types

type AWSResponse GetPipelineState #

Methods

request :: GetPipelineState -> Request GetPipelineState #

response :: MonadResource m => Logger -> Service -> Proxy GetPipelineState -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetPipelineState))) #

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 #

type Rep GetPipelineState Source # 
Instance details

Defined in Amazonka.CodePipeline.GetPipelineState

type Rep GetPipelineState = D1 ('MetaData "GetPipelineState" "Amazonka.CodePipeline.GetPipelineState" "libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline" 'False) (C1 ('MetaCons "GetPipelineState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetPipelineState Source # 
Instance details

Defined in Amazonka.CodePipeline.GetPipelineState

type AWSResponse GetPipelineState = GetPipelineStateResponse

newGetPipelineState Source #

Arguments

:: Text

$sel:name: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:

$sel:name: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

  • pipelineName :: Maybe Text

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

  • created :: Maybe POSIX

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

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

  • pipelineVersion :: Maybe Natural

    The version number of the pipeline.

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

  • 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
Eq GetPipelineStateResponse Source # 
Instance details

Defined in Amazonka.CodePipeline.GetPipelineState

Methods

(==) :: GetPipelineStateResponse -> GetPipelineStateResponse -> Bool #

(/=) :: GetPipelineStateResponse -> GetPipelineStateResponse -> Bool #

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 #

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 #

NFData GetPipelineStateResponse Source # 
Instance details

Defined in Amazonka.CodePipeline.GetPipelineState

Methods

rnf :: GetPipelineStateResponse -> () #

type Rep GetPipelineStateResponse Source # 
Instance details

Defined in Amazonka.CodePipeline.GetPipelineState

type Rep GetPipelineStateResponse = D1 ('MetaData "GetPipelineStateResponse" "Amazonka.CodePipeline.GetPipelineState" "libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline" 'False) (C1 ('MetaCons "GetPipelineStateResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pipelineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "stageStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StageState])))) :*: (S1 ('MetaSel ('Just "pipelineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (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:

$sel:pipelineName:GetPipelineStateResponse', getPipelineStateResponse_pipelineName - The name of the pipeline for which you want to get the state.

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

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

$sel:pipelineVersion:GetPipelineStateResponse', getPipelineStateResponse_pipelineVersion - The version number of the pipeline.

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

$sel:updated: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_pipelineName :: Lens' GetPipelineStateResponse (Maybe Text) Source #

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

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

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

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