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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a Route.

Synopsis

data GetRoute = GetRoute' {
- apiId :: Text
- routeId :: Text
}
newGetRoute :: Text -> Text -> GetRoute
getRoute_apiId :: Lens' GetRoute Text
getRoute_routeId :: Lens' GetRoute Text
data GetRouteResponse' = GetRouteResponse'' {
- authorizationScopes :: Maybe [Text]
- modelSelectionExpression :: Maybe Text
- requestModels :: Maybe (HashMap Text Text)
- routeResponseSelectionExpression :: Maybe Text
- requestParameters :: Maybe (HashMap Text ParameterConstraints)
- routeId :: Maybe Text
- authorizerId :: Maybe Text
- operationName :: Maybe Text
- apiGatewayManaged :: Maybe Bool
- authorizationType :: Maybe AuthorizationType
- apiKeyRequired :: Maybe Bool
- routeKey :: Maybe Text
- target :: Maybe Text
- httpStatus :: Int
}
newGetRouteResponse' :: Int -> GetRouteResponse'
getRouteResponse'_authorizationScopes :: Lens' GetRouteResponse' (Maybe [Text])
getRouteResponse'_modelSelectionExpression :: Lens' GetRouteResponse' (Maybe Text)
getRouteResponse'_requestModels :: Lens' GetRouteResponse' (Maybe (HashMap Text Text))
getRouteResponse'_routeResponseSelectionExpression :: Lens' GetRouteResponse' (Maybe Text)
getRouteResponse'_requestParameters :: Lens' GetRouteResponse' (Maybe (HashMap Text ParameterConstraints))
getRouteResponse'_routeId :: Lens' GetRouteResponse' (Maybe Text)
getRouteResponse'_authorizerId :: Lens' GetRouteResponse' (Maybe Text)
getRouteResponse'_operationName :: Lens' GetRouteResponse' (Maybe Text)
getRouteResponse'_apiGatewayManaged :: Lens' GetRouteResponse' (Maybe Bool)
getRouteResponse'_authorizationType :: Lens' GetRouteResponse' (Maybe AuthorizationType)
getRouteResponse'_apiKeyRequired :: Lens' GetRouteResponse' (Maybe Bool)
getRouteResponse'_routeKey :: Lens' GetRouteResponse' (Maybe Text)
getRouteResponse'_target :: Lens' GetRouteResponse' (Maybe Text)
getRouteResponse'_httpStatus :: Lens' GetRouteResponse' Int

Creating a Request

data GetRoute Source #

See: newGetRoute smart constructor.

Constructors

GetRoute'
Fields apiId :: Text The API identifier. routeId :: Text The route ID.

Instances

Instances details

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

newGetRoute Source #

Arguments

:: Text	`$sel:apiId:GetRoute'`
-> Text	`$sel:routeId:GetRoute'`
-> GetRoute

Create a value of GetRoute 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:apiId:GetRoute', getRoute_apiId - The API identifier.

$sel:routeId:GetRoute', getRoute_routeId - The route ID.

Request Lenses

getRoute_apiId :: Lens' GetRoute Text Source #

The API identifier.

getRoute_routeId :: Lens' GetRoute Text Source #

The route ID.

Destructuring the Response

data GetRouteResponse' Source #

See: newGetRouteResponse' smart constructor.

Constructors

GetRouteResponse''

Fields

authorizationScopes :: Maybe [Text]
A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
modelSelectionExpression :: Maybe Text
The model selection expression for the route. Supported only for WebSocket APIs.
requestModels :: Maybe (HashMap Text Text)
The request models for the route. Supported only for WebSocket APIs.
routeResponseSelectionExpression :: Maybe Text
The route response selection expression for the route. Supported only for WebSocket APIs.
requestParameters :: Maybe (HashMap Text ParameterConstraints)
The request parameters for the route. Supported only for WebSocket APIs.
routeId :: Maybe Text
The route ID.
authorizerId :: Maybe Text
The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
operationName :: Maybe Text
The operation name for the route.
apiGatewayManaged :: Maybe Bool
Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.
authorizationType :: Maybe AuthorizationType
The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
apiKeyRequired :: Maybe Bool
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
routeKey :: Maybe Text
The route key for the route.
target :: Maybe Text
The target for the route.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetRouteResponse' Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoute Methods (==) :: GetRouteResponse' -> GetRouteResponse' -> Bool # (/=) :: GetRouteResponse' -> GetRouteResponse' -> Bool #
Read GetRouteResponse' Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoute Methods readsPrec :: Int -> ReadS GetRouteResponse' # readList :: ReadS [GetRouteResponse'] # readPrec :: ReadPrec GetRouteResponse' # readListPrec :: ReadPrec [GetRouteResponse'] #
Show GetRouteResponse' Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoute Methods showsPrec :: Int -> GetRouteResponse' -> ShowS # show :: GetRouteResponse' -> String # showList :: [GetRouteResponse'] -> ShowS #
Generic GetRouteResponse' Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoute Associated Types type Rep GetRouteResponse' :: Type -> Type # Methods from :: GetRouteResponse' -> Rep GetRouteResponse' x # to :: Rep GetRouteResponse' x -> GetRouteResponse' #
NFData GetRouteResponse' Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoute Methods rnf :: GetRouteResponse' -> () #
type Rep GetRouteResponse' Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetRoute type Rep GetRouteResponse' = D1 ('MetaData "GetRouteResponse'" "Amazonka.ApiGatewayV2.GetRoute" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "GetRouteResponse''" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authorizationScopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "modelSelectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "requestModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "routeResponseSelectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "requestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ParameterConstraints)))) :: (S1 ('MetaSel ('Just "routeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "authorizerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "operationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "apiGatewayManaged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "authorizationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthorizationType)))) :: ((S1 ('MetaSel ('Just "apiKeyRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "routeKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetRouteResponse' Source #

Arguments

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

Create a value of GetRouteResponse' 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:authorizationScopes:GetRouteResponse'', getRouteResponse'_authorizationScopes - A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

$sel:modelSelectionExpression:GetRouteResponse'', getRouteResponse'_modelSelectionExpression - The model selection expression for the route. Supported only for WebSocket APIs.

$sel:requestModels:GetRouteResponse'', getRouteResponse'_requestModels - The request models for the route. Supported only for WebSocket APIs.

$sel:routeResponseSelectionExpression:GetRouteResponse'', getRouteResponse'_routeResponseSelectionExpression - The route response selection expression for the route. Supported only for WebSocket APIs.

$sel:requestParameters:GetRouteResponse'', getRouteResponse'_requestParameters - The request parameters for the route. Supported only for WebSocket APIs.

$sel:routeId:GetRoute', getRouteResponse'_routeId - The route ID.

$sel:authorizerId:GetRouteResponse'', getRouteResponse'_authorizerId - The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

$sel:operationName:GetRouteResponse'', getRouteResponse'_operationName - The operation name for the route.

$sel:apiGatewayManaged:GetRouteResponse'', getRouteResponse'_apiGatewayManaged - Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

$sel:authorizationType:GetRouteResponse'', getRouteResponse'_authorizationType - The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

$sel:apiKeyRequired:GetRouteResponse'', getRouteResponse'_apiKeyRequired - Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

$sel:routeKey:GetRouteResponse'', getRouteResponse'_routeKey - The route key for the route.

$sel:target:GetRouteResponse'', getRouteResponse'_target - The target for the route.

$sel:httpStatus:GetRouteResponse'', getRouteResponse'_httpStatus - The response's http status code.

Response Lenses

getRouteResponse'_authorizationScopes :: Lens' GetRouteResponse' (Maybe [Text]) Source #

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

getRouteResponse'_modelSelectionExpression :: Lens' GetRouteResponse' (Maybe Text) Source #

The model selection expression for the route. Supported only for WebSocket APIs.

getRouteResponse'_requestModels :: Lens' GetRouteResponse' (Maybe (HashMap Text Text)) Source #

The request models for the route. Supported only for WebSocket APIs.

getRouteResponse'_routeResponseSelectionExpression :: Lens' GetRouteResponse' (Maybe Text) Source #

The route response selection expression for the route. Supported only for WebSocket APIs.

getRouteResponse'_requestParameters :: Lens' GetRouteResponse' (Maybe (HashMap Text ParameterConstraints)) Source #

The request parameters for the route. Supported only for WebSocket APIs.

getRouteResponse'_routeId :: Lens' GetRouteResponse' (Maybe Text) Source #

The route ID.

getRouteResponse'_authorizerId :: Lens' GetRouteResponse' (Maybe Text) Source #

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

getRouteResponse'_operationName :: Lens' GetRouteResponse' (Maybe Text) Source #

The operation name for the route.

getRouteResponse'_apiGatewayManaged :: Lens' GetRouteResponse' (Maybe Bool) Source #

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

getRouteResponse'_authorizationType :: Lens' GetRouteResponse' (Maybe AuthorizationType) Source #

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

getRouteResponse'_apiKeyRequired :: Lens' GetRouteResponse' (Maybe Bool) Source #

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

getRouteResponse'_routeKey :: Lens' GetRouteResponse' (Maybe Text) Source #

The route key for the route.

getRouteResponse'_target :: Lens' GetRouteResponse' (Maybe Text) Source #

The target for the route.

getRouteResponse'_httpStatus :: Lens' GetRouteResponse' Int Source #

The response's http status code.