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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Route for an API.

Synopsis

data CreateRoute = CreateRoute' {
- authorizationScopes :: Maybe [Text]
- modelSelectionExpression :: Maybe Text
- requestModels :: Maybe (HashMap Text Text)
- routeResponseSelectionExpression :: Maybe Text
- requestParameters :: Maybe (HashMap Text ParameterConstraints)
- authorizerId :: Maybe Text
- operationName :: Maybe Text
- authorizationType :: Maybe AuthorizationType
- apiKeyRequired :: Maybe Bool
- target :: Maybe Text
- apiId :: Text
- routeKey :: Text
}
newCreateRoute :: Text -> Text -> CreateRoute
createRoute_authorizationScopes :: Lens' CreateRoute (Maybe [Text])
createRoute_modelSelectionExpression :: Lens' CreateRoute (Maybe Text)
createRoute_requestModels :: Lens' CreateRoute (Maybe (HashMap Text Text))
createRoute_routeResponseSelectionExpression :: Lens' CreateRoute (Maybe Text)
createRoute_requestParameters :: Lens' CreateRoute (Maybe (HashMap Text ParameterConstraints))
createRoute_authorizerId :: Lens' CreateRoute (Maybe Text)
createRoute_operationName :: Lens' CreateRoute (Maybe Text)
createRoute_authorizationType :: Lens' CreateRoute (Maybe AuthorizationType)
createRoute_apiKeyRequired :: Lens' CreateRoute (Maybe Bool)
createRoute_target :: Lens' CreateRoute (Maybe Text)
createRoute_apiId :: Lens' CreateRoute Text
createRoute_routeKey :: Lens' CreateRoute Text
data CreateRouteResponse' = CreateRouteResponse'' {
- 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
}
newCreateRouteResponse' :: Int -> CreateRouteResponse'
createRouteResponse'_authorizationScopes :: Lens' CreateRouteResponse' (Maybe [Text])
createRouteResponse'_modelSelectionExpression :: Lens' CreateRouteResponse' (Maybe Text)
createRouteResponse'_requestModels :: Lens' CreateRouteResponse' (Maybe (HashMap Text Text))
createRouteResponse'_routeResponseSelectionExpression :: Lens' CreateRouteResponse' (Maybe Text)
createRouteResponse'_requestParameters :: Lens' CreateRouteResponse' (Maybe (HashMap Text ParameterConstraints))
createRouteResponse'_routeId :: Lens' CreateRouteResponse' (Maybe Text)
createRouteResponse'_authorizerId :: Lens' CreateRouteResponse' (Maybe Text)
createRouteResponse'_operationName :: Lens' CreateRouteResponse' (Maybe Text)
createRouteResponse'_apiGatewayManaged :: Lens' CreateRouteResponse' (Maybe Bool)
createRouteResponse'_authorizationType :: Lens' CreateRouteResponse' (Maybe AuthorizationType)
createRouteResponse'_apiKeyRequired :: Lens' CreateRouteResponse' (Maybe Bool)
createRouteResponse'_routeKey :: Lens' CreateRouteResponse' (Maybe Text)
createRouteResponse'_target :: Lens' CreateRouteResponse' (Maybe Text)
createRouteResponse'_httpStatus :: Lens' CreateRouteResponse' Int

Creating a Request

data CreateRoute Source #

Creates a new Route resource to represent a route.

See: newCreateRoute smart constructor.

Constructors

CreateRoute'

Fields

authorizationScopes :: Maybe [Text]
The authorization scopes supported by this route.
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.
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.
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 the route. Supported only for WebSocket APIs.
target :: Maybe Text
The target for the route.
apiId :: Text
The API identifier.
routeKey :: Text
The route key for the route.

Instances

Instances details

Eq CreateRoute Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Methods (==) :: CreateRoute -> CreateRoute -> Bool # (/=) :: CreateRoute -> CreateRoute -> Bool #
Read CreateRoute Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Methods readsPrec :: Int -> ReadS CreateRoute # readList :: ReadS [CreateRoute] # readPrec :: ReadPrec CreateRoute # readListPrec :: ReadPrec [CreateRoute] #
Show CreateRoute Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Methods showsPrec :: Int -> CreateRoute -> ShowS # show :: CreateRoute -> String # showList :: [CreateRoute] -> ShowS #
Generic CreateRoute Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Associated Types type Rep CreateRoute :: Type -> Type # Methods from :: CreateRoute -> Rep CreateRoute x # to :: Rep CreateRoute x -> CreateRoute #
NFData CreateRoute Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Methods rnf :: CreateRoute -> () #
Hashable CreateRoute Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Methods hashWithSalt :: Int -> CreateRoute -> Int # hash :: CreateRoute -> Int #
ToJSON CreateRoute Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Methods toJSON :: CreateRoute -> Value # toEncoding :: CreateRoute -> Encoding # toJSONList :: [CreateRoute] -> Value # toEncodingList :: [CreateRoute] -> Encoding #
AWSRequest CreateRoute Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Associated Types type AWSResponse CreateRoute # Methods request :: CreateRoute -> Request CreateRoute # response :: MonadResource m => Logger -> Service -> Proxy CreateRoute -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateRoute))) #
ToHeaders CreateRoute Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Methods toHeaders :: CreateRoute -> [Header] #
ToPath CreateRoute Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Methods toPath :: CreateRoute -> ByteString #
ToQuery CreateRoute Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Methods toQuery :: CreateRoute -> QueryString #
type Rep CreateRoute Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute type Rep CreateRoute = D1 ('MetaData "CreateRoute" "Amazonka.ApiGatewayV2.CreateRoute" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "CreateRoute'" '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 "authorizerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "operationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "authorizationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthorizationType)) :: S1 ('MetaSel ('Just "apiKeyRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "routeKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateRoute Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute type AWSResponse CreateRoute = CreateRouteResponse'

newCreateRoute Source #

Arguments

:: Text	`$sel:apiId:CreateRoute'`
-> Text	`$sel:routeKey:CreateRoute'`
-> CreateRoute

Create a value of CreateRoute 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:CreateRoute', createRoute_authorizationScopes - The authorization scopes supported by this route.

$sel:modelSelectionExpression:CreateRoute', createRoute_modelSelectionExpression - The model selection expression for the route. Supported only for WebSocket APIs.

$sel:requestModels:CreateRoute', createRoute_requestModels - The request models for the route. Supported only for WebSocket APIs.

$sel:routeResponseSelectionExpression:CreateRoute', createRoute_routeResponseSelectionExpression - The route response selection expression for the route. Supported only for WebSocket APIs.

$sel:requestParameters:CreateRoute', createRoute_requestParameters - The request parameters for the route. Supported only for WebSocket APIs.

$sel:authorizerId:CreateRoute', createRoute_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:CreateRoute', createRoute_operationName - The operation name for the route.

$sel:authorizationType:CreateRoute', createRoute_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:CreateRoute', createRoute_apiKeyRequired - Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

$sel:target:CreateRoute', createRoute_target - The target for the route.

$sel:apiId:CreateRoute', createRoute_apiId - The API identifier.

$sel:routeKey:CreateRoute', createRoute_routeKey - The route key for the route.

Request Lenses

createRoute_authorizationScopes :: Lens' CreateRoute (Maybe [Text]) Source #

The authorization scopes supported by this route.

createRoute_modelSelectionExpression :: Lens' CreateRoute (Maybe Text) Source #

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

createRoute_requestModels :: Lens' CreateRoute (Maybe (HashMap Text Text)) Source #

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

createRoute_routeResponseSelectionExpression :: Lens' CreateRoute (Maybe Text) Source #

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

createRoute_requestParameters :: Lens' CreateRoute (Maybe (HashMap Text ParameterConstraints)) Source #

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

createRoute_authorizerId :: Lens' CreateRoute (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.

createRoute_operationName :: Lens' CreateRoute (Maybe Text) Source #

The operation name for the route.

createRoute_authorizationType :: Lens' CreateRoute (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.

createRoute_apiKeyRequired :: Lens' CreateRoute (Maybe Bool) Source #

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

createRoute_target :: Lens' CreateRoute (Maybe Text) Source #

The target for the route.

createRoute_apiId :: Lens' CreateRoute Text Source #

The API identifier.

createRoute_routeKey :: Lens' CreateRoute Text Source #

The route key for the route.

Destructuring the Response

data CreateRouteResponse' Source #

See: newCreateRouteResponse' smart constructor.

Constructors

CreateRouteResponse''

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 CreateRouteResponse' Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Methods (==) :: CreateRouteResponse' -> CreateRouteResponse' -> Bool # (/=) :: CreateRouteResponse' -> CreateRouteResponse' -> Bool #
Read CreateRouteResponse' Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Methods readsPrec :: Int -> ReadS CreateRouteResponse' # readList :: ReadS [CreateRouteResponse'] # readPrec :: ReadPrec CreateRouteResponse' # readListPrec :: ReadPrec [CreateRouteResponse'] #
Show CreateRouteResponse' Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Methods showsPrec :: Int -> CreateRouteResponse' -> ShowS # show :: CreateRouteResponse' -> String # showList :: [CreateRouteResponse'] -> ShowS #
Generic CreateRouteResponse' Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Associated Types type Rep CreateRouteResponse' :: Type -> Type # Methods from :: CreateRouteResponse' -> Rep CreateRouteResponse' x # to :: Rep CreateRouteResponse' x -> CreateRouteResponse' #
NFData CreateRouteResponse' Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute Methods rnf :: CreateRouteResponse' -> () #
type Rep CreateRouteResponse' Source #
Instance details Defined in Amazonka.ApiGatewayV2.CreateRoute type Rep CreateRouteResponse' = D1 ('MetaData "CreateRouteResponse'" "Amazonka.ApiGatewayV2.CreateRoute" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "CreateRouteResponse''" '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))))))

newCreateRouteResponse' Source #

Arguments

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

Create a value of CreateRouteResponse' 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:CreateRoute', createRouteResponse'_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:CreateRoute', createRouteResponse'_modelSelectionExpression - The model selection expression for the route. Supported only for WebSocket APIs.

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

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

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

$sel:routeId:CreateRouteResponse'', createRouteResponse'_routeId - The route ID.

$sel:authorizerId:CreateRoute', createRouteResponse'_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:CreateRoute', createRouteResponse'_operationName - The operation name for the route.

$sel:apiGatewayManaged:CreateRouteResponse'', createRouteResponse'_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:CreateRoute', createRouteResponse'_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:CreateRoute', createRouteResponse'_apiKeyRequired - Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

$sel:routeKey:CreateRoute', createRouteResponse'_routeKey - The route key for the route.

$sel:target:CreateRoute', createRouteResponse'_target - The target for the route.

$sel:httpStatus:CreateRouteResponse'', createRouteResponse'_httpStatus - The response's http status code.

Response Lenses

createRouteResponse'_authorizationScopes :: Lens' CreateRouteResponse' (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.

createRouteResponse'_modelSelectionExpression :: Lens' CreateRouteResponse' (Maybe Text) Source #

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

createRouteResponse'_requestModels :: Lens' CreateRouteResponse' (Maybe (HashMap Text Text)) Source #

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

createRouteResponse'_routeResponseSelectionExpression :: Lens' CreateRouteResponse' (Maybe Text) Source #

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

createRouteResponse'_requestParameters :: Lens' CreateRouteResponse' (Maybe (HashMap Text ParameterConstraints)) Source #

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

createRouteResponse'_routeId :: Lens' CreateRouteResponse' (Maybe Text) Source #

The route ID.

createRouteResponse'_authorizerId :: Lens' CreateRouteResponse' (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.

createRouteResponse'_operationName :: Lens' CreateRouteResponse' (Maybe Text) Source #

The operation name for the route.

createRouteResponse'_apiGatewayManaged :: Lens' CreateRouteResponse' (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.

createRouteResponse'_authorizationType :: Lens' CreateRouteResponse' (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.

createRouteResponse'_apiKeyRequired :: Lens' CreateRouteResponse' (Maybe Bool) Source #

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

createRouteResponse'_routeKey :: Lens' CreateRouteResponse' (Maybe Text) Source #

The route key for the route.

createRouteResponse'_target :: Lens' CreateRouteResponse' (Maybe Text) Source #

The target for the route.

createRouteResponse'_httpStatus :: Lens' CreateRouteResponse' Int Source #

The response's http status code.