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.ApiGatewayV2.GetStages

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the Stages for an API.

This operation returns paginated results.

Synopsis

data GetStages = GetStages' {
- maxResults :: Maybe Text
- nextToken :: Maybe Text
- apiId :: Text
}
newGetStages :: Text -> GetStages
getStages_maxResults :: Lens' GetStages (Maybe Text)
getStages_nextToken :: Lens' GetStages (Maybe Text)
getStages_apiId :: Lens' GetStages Text
data GetStagesResponse = GetStagesResponse' {
- items :: Maybe [Stage]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetStagesResponse :: Int -> GetStagesResponse
getStagesResponse_items :: Lens' GetStagesResponse (Maybe [Stage])
getStagesResponse_nextToken :: Lens' GetStagesResponse (Maybe Text)
getStagesResponse_httpStatus :: Lens' GetStagesResponse Int

Creating a Request

data GetStages Source #

See: newGetStages smart constructor.

Constructors

GetStages'
Fields maxResults :: Maybe Text The maximum number of elements to be returned for this resource. nextToken :: Maybe Text The next page of elements from this collection. Not valid for the last element of the collection. apiId :: Text The API identifier.

Instances

Instances details

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

newGetStages Source #

Arguments

:: Text	`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:maxResults:GetStages', getStages_maxResults - The maximum number of elements to be returned for this resource.

GetStages, getStages_nextToken - The next page of elements from this collection. Not valid for the last element of the collection.

GetStages, getStages_apiId - The API identifier.

Request Lenses

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

The maximum number of elements to be returned for this resource.

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

The next page of elements from this collection. Not valid for the last element of the collection.

getStages_apiId :: Lens' GetStages Text Source #

The API identifier.

Destructuring the Response

data GetStagesResponse Source #

See: newGetStagesResponse smart constructor.

Constructors

GetStagesResponse'
Fields items :: Maybe [Stage] The elements from this collection. nextToken :: Maybe Text The next page of elements from this collection. Not valid for the last element of the collection. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetStagesResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetStages Associated Types type Rep GetStagesResponse :: Type -> Type # Methods from :: GetStagesResponse -> Rep GetStagesResponse x # to :: Rep GetStagesResponse x -> GetStagesResponse #
Read GetStagesResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetStages Methods readsPrec :: Int -> ReadS GetStagesResponse # readList :: ReadS [GetStagesResponse] # readPrec :: ReadPrec GetStagesResponse # readListPrec :: ReadPrec [GetStagesResponse] #
Show GetStagesResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetStages Methods showsPrec :: Int -> GetStagesResponse -> ShowS # show :: GetStagesResponse -> String # showList :: [GetStagesResponse] -> ShowS #
NFData GetStagesResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetStages Methods rnf :: GetStagesResponse -> () #
Eq GetStagesResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetStages Methods (==) :: GetStagesResponse -> GetStagesResponse -> Bool # (/=) :: GetStagesResponse -> GetStagesResponse -> Bool #
type Rep GetStagesResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetStages type Rep GetStagesResponse = D1 ('MetaData "GetStagesResponse" "Amazonka.ApiGatewayV2.GetStages" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "GetStagesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Stage])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:items:GetStagesResponse', getStagesResponse_items - The elements from this collection.

GetStages, getStagesResponse_nextToken - The next page of elements from this collection. Not valid for the last element of the collection.

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

Response Lenses

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

The elements from this collection.

getStagesResponse_nextToken :: Lens' GetStagesResponse (Maybe Text) Source #

The next page of elements from this collection. Not valid for the last element of the collection.

getStagesResponse_httpStatus :: Lens' GetStagesResponse Int Source #

The response's http status code.