Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.APIGateway.GetStages

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about one or more Stage resources.

Synopsis

data GetStages = GetStages' {
- deploymentId :: Maybe Text
- restApiId :: Text
}
newGetStages :: Text -> GetStages
getStages_deploymentId :: Lens' GetStages (Maybe Text)
getStages_restApiId :: Lens' GetStages Text
data GetStagesResponse = GetStagesResponse' {
- item :: Maybe [Stage]
- httpStatus :: Int
}
newGetStagesResponse :: Int -> GetStagesResponse
getStagesResponse_item :: Lens' GetStagesResponse (Maybe [Stage])
getStagesResponse_httpStatus :: Lens' GetStagesResponse Int

Creating a Request

data GetStages Source #

Requests API Gateway to get information about one or more Stage resources.

See: newGetStages smart constructor.

Constructors

GetStages'
Fields deploymentId :: Maybe Text The stages' deployment identifiers. restApiId :: Text Required The string identifier of the associated RestApi.

Instances

Instances details

Eq GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods (==) :: GetStages -> GetStages -> Bool # (/=) :: GetStages -> GetStages -> Bool #
Read GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods readsPrec :: Int -> ReadS GetStages # readList :: ReadS [GetStages] # readPrec :: ReadPrec GetStages # readListPrec :: ReadPrec [GetStages] #
Show GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods showsPrec :: Int -> GetStages -> ShowS # show :: GetStages -> String # showList :: [GetStages] -> ShowS #
Generic GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Associated Types type Rep GetStages :: Type -> Type # Methods from :: GetStages -> Rep GetStages x # to :: Rep GetStages x -> GetStages #
NFData GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods rnf :: GetStages -> () #
Hashable GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods hashWithSalt :: Int -> GetStages -> Int # hash :: GetStages -> Int #
AWSRequest GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Associated Types type AWSResponse GetStages # Methods request :: GetStages -> Request GetStages # response :: MonadResource m => Logger -> Service -> Proxy GetStages -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetStages))) #
ToHeaders GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods toHeaders :: GetStages -> [Header] #
ToPath GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods toPath :: GetStages -> ByteString #
ToQuery GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods toQuery :: GetStages -> QueryString #
type Rep GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages type Rep GetStages = D1 ('MetaData "GetStages" "Amazonka.APIGateway.GetStages" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetStages'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages type AWSResponse GetStages = GetStagesResponse

newGetStages Source #

Arguments

:: Text	`$sel:restApiId:GetStages'`
-> GetStages

Create a value of GetStages 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:deploymentId:GetStages', getStages_deploymentId - The stages' deployment identifiers.

$sel:restApiId:GetStages', getStages_restApiId - [Required] The string identifier of the associated RestApi.

Request Lenses

getStages_deploymentId :: Lens' GetStages (Maybe Text) Source #

The stages' deployment identifiers.

getStages_restApiId :: Lens' GetStages Text Source #

Required: The string identifier of the associated RestApi.

Destructuring the Response

data GetStagesResponse Source #

A list of Stage resources that are associated with the ApiKey resource.

Deploying API in Stages

See: newGetStagesResponse smart constructor.

Constructors

GetStagesResponse'
Fields item :: Maybe [Stage] The current page of elements from this collection. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetStagesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods (==) :: GetStagesResponse -> GetStagesResponse -> Bool # (/=) :: GetStagesResponse -> GetStagesResponse -> Bool #
Read GetStagesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods readsPrec :: Int -> ReadS GetStagesResponse # readList :: ReadS [GetStagesResponse] # readPrec :: ReadPrec GetStagesResponse # readListPrec :: ReadPrec [GetStagesResponse] #
Show GetStagesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods showsPrec :: Int -> GetStagesResponse -> ShowS # show :: GetStagesResponse -> String # showList :: [GetStagesResponse] -> ShowS #
Generic GetStagesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetStages Associated Types type Rep GetStagesResponse :: Type -> Type # Methods from :: GetStagesResponse -> Rep GetStagesResponse x # to :: Rep GetStagesResponse x -> GetStagesResponse #
NFData GetStagesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods rnf :: GetStagesResponse -> () #
type Rep GetStagesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetStages type Rep GetStagesResponse = D1 ('MetaData "GetStagesResponse" "Amazonka.APIGateway.GetStages" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetStagesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Stage])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetStagesResponse Source #

Arguments

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

Create a value of GetStagesResponse 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:item:GetStagesResponse', getStagesResponse_item - The current page of elements from this collection.

$sel:httpStatus:GetStagesResponse', getStagesResponse_httpStatus - The response's http status code.

Response Lenses

getStagesResponse_item :: Lens' GetStagesResponse (Maybe [Stage]) Source #

The current page of elements from this collection.

getStagesResponse_httpStatus :: Lens' GetStagesResponse Int Source #

The response's http status code.