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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the Routes for an API.

This operation returns paginated results.

Synopsis

data GetRoutes = GetRoutes' {
- maxResults :: Maybe Text
- nextToken :: Maybe Text
- apiId :: Text
}
newGetRoutes :: Text -> GetRoutes
getRoutes_maxResults :: Lens' GetRoutes (Maybe Text)
getRoutes_nextToken :: Lens' GetRoutes (Maybe Text)
getRoutes_apiId :: Lens' GetRoutes Text
data GetRoutesResponse = GetRoutesResponse' {
- items :: Maybe [Route]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetRoutesResponse :: Int -> GetRoutesResponse
getRoutesResponse_items :: Lens' GetRoutesResponse (Maybe [Route])
getRoutesResponse_nextToken :: Lens' GetRoutesResponse (Maybe Text)
getRoutesResponse_httpStatus :: Lens' GetRoutesResponse Int

Creating a Request

data GetRoutes Source #

See: newGetRoutes smart constructor.

Constructors

GetRoutes'
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 GetRoutes Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoutes Methods toHeaders :: GetRoutes -> [Header] #
ToPath GetRoutes Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoutes Methods toPath :: GetRoutes -> ByteString #
ToQuery GetRoutes Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoutes Methods toQuery :: GetRoutes -> QueryString #
AWSPager GetRoutes Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoutes Methods page :: GetRoutes -> AWSResponse GetRoutes -> Maybe GetRoutes #
AWSRequest GetRoutes Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoutes Associated Types type AWSResponse GetRoutes # Methods request :: (Service -> Service) -> GetRoutes -> Request GetRoutes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRoutes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRoutes))) #
Generic GetRoutes Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoutes Associated Types type Rep GetRoutes :: Type -> Type # Methods from :: GetRoutes -> Rep GetRoutes x # to :: Rep GetRoutes x -> GetRoutes #
Read GetRoutes Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoutes Methods readsPrec :: Int -> ReadS GetRoutes # readList :: ReadS [GetRoutes] # readPrec :: ReadPrec GetRoutes # readListPrec :: ReadPrec [GetRoutes] #
Show GetRoutes Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoutes Methods showsPrec :: Int -> GetRoutes -> ShowS # show :: GetRoutes -> String # showList :: [GetRoutes] -> ShowS #
NFData GetRoutes Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoutes Methods rnf :: GetRoutes -> () #
Eq GetRoutes Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoutes Methods (==) :: GetRoutes -> GetRoutes -> Bool # (/=) :: GetRoutes -> GetRoutes -> Bool #
Hashable GetRoutes Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoutes Methods hashWithSalt :: Int -> GetRoutes -> Int # hash :: GetRoutes -> Int #
type AWSResponse GetRoutes Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoutes type AWSResponse GetRoutes = GetRoutesResponse
type Rep GetRoutes Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoutes type Rep GetRoutes = D1 ('MetaData "GetRoutes" "Amazonka.ApiGatewayV2.GetRoutes" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "GetRoutes'" '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))))

newGetRoutes Source #

Arguments

:: Text	`GetRoutes`
-> GetRoutes

Create a value of GetRoutes 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:GetRoutes', getRoutes_maxResults - The maximum number of elements to be returned for this resource.

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

GetRoutes, getRoutes_apiId - The API identifier.

Request Lenses

getRoutes_maxResults :: Lens' GetRoutes (Maybe Text) Source #

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

getRoutes_nextToken :: Lens' GetRoutes (Maybe Text) Source #

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

getRoutes_apiId :: Lens' GetRoutes Text Source #

The API identifier.

Destructuring the Response

data GetRoutesResponse Source #

See: newGetRoutesResponse smart constructor.

Constructors

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

newGetRoutesResponse Source #

Arguments

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

Create a value of GetRoutesResponse 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:GetRoutesResponse', getRoutesResponse_items - The elements from this collection.

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

$sel:httpStatus:GetRoutesResponse', getRoutesResponse_httpStatus - The response's http status code.

Response Lenses

getRoutesResponse_items :: Lens' GetRoutesResponse (Maybe [Route]) Source #

The elements from this collection.

getRoutesResponse_nextToken :: Lens' GetRoutesResponse (Maybe Text) Source #

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

getRoutesResponse_httpStatus :: Lens' GetRoutesResponse Int Source #

The response's http status code.