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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a Route.

Synopsis

data UpdateRoute = UpdateRoute' {
- 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
- routeKey :: Maybe Text
- target :: Maybe Text
- apiId :: Text
- routeId :: Text
}
newUpdateRoute :: Text -> Text -> UpdateRoute
updateRoute_authorizationScopes :: Lens' UpdateRoute (Maybe [Text])
updateRoute_modelSelectionExpression :: Lens' UpdateRoute (Maybe Text)
updateRoute_requestModels :: Lens' UpdateRoute (Maybe (HashMap Text Text))
updateRoute_routeResponseSelectionExpression :: Lens' UpdateRoute (Maybe Text)
updateRoute_requestParameters :: Lens' UpdateRoute (Maybe (HashMap Text ParameterConstraints))
updateRoute_authorizerId :: Lens' UpdateRoute (Maybe Text)
updateRoute_operationName :: Lens' UpdateRoute (Maybe Text)
updateRoute_authorizationType :: Lens' UpdateRoute (Maybe AuthorizationType)
updateRoute_apiKeyRequired :: Lens' UpdateRoute (Maybe Bool)
updateRoute_routeKey :: Lens' UpdateRoute (Maybe Text)
updateRoute_target :: Lens' UpdateRoute (Maybe Text)
updateRoute_apiId :: Lens' UpdateRoute Text
updateRoute_routeId :: Lens' UpdateRoute Text
data UpdateRouteResponse' = UpdateRouteResponse'' {
- 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
}
newUpdateRouteResponse' :: Int -> UpdateRouteResponse'
updateRouteResponse'_authorizationScopes :: Lens' UpdateRouteResponse' (Maybe [Text])
updateRouteResponse'_modelSelectionExpression :: Lens' UpdateRouteResponse' (Maybe Text)
updateRouteResponse'_requestModels :: Lens' UpdateRouteResponse' (Maybe (HashMap Text Text))
updateRouteResponse'_routeResponseSelectionExpression :: Lens' UpdateRouteResponse' (Maybe Text)
updateRouteResponse'_requestParameters :: Lens' UpdateRouteResponse' (Maybe (HashMap Text ParameterConstraints))
updateRouteResponse'_routeId :: Lens' UpdateRouteResponse' (Maybe Text)
updateRouteResponse'_authorizerId :: Lens' UpdateRouteResponse' (Maybe Text)
updateRouteResponse'_operationName :: Lens' UpdateRouteResponse' (Maybe Text)
updateRouteResponse'_apiGatewayManaged :: Lens' UpdateRouteResponse' (Maybe Bool)
updateRouteResponse'_authorizationType :: Lens' UpdateRouteResponse' (Maybe AuthorizationType)
updateRouteResponse'_apiKeyRequired :: Lens' UpdateRouteResponse' (Maybe Bool)
updateRouteResponse'_routeKey :: Lens' UpdateRouteResponse' (Maybe Text)
updateRouteResponse'_target :: Lens' UpdateRouteResponse' (Maybe Text)
updateRouteResponse'_httpStatus :: Lens' UpdateRouteResponse' Int

Creating a Request

data UpdateRoute Source #

Updates a Route.

See: newUpdateRoute smart constructor.

Constructors

UpdateRoute'

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.
routeKey :: Maybe Text
The route key for the route.
target :: Maybe Text
The target for the route.
apiId :: Text
The API identifier.
routeId :: Text
The route ID.

Instances

Instances details

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

newUpdateRoute Source #

Arguments

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

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

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

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

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

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

$sel:authorizerId:UpdateRoute', updateRoute_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:UpdateRoute', updateRoute_operationName - The operation name for the route.

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

$sel:routeKey:UpdateRoute', updateRoute_routeKey - The route key for the route.

$sel:target:UpdateRoute', updateRoute_target - The target for the route.

$sel:apiId:UpdateRoute', updateRoute_apiId - The API identifier.

$sel:routeId:UpdateRoute', updateRoute_routeId - The route ID.

Request Lenses

updateRoute_authorizationScopes :: Lens' UpdateRoute (Maybe [Text]) Source #

The authorization scopes supported by this route.

updateRoute_modelSelectionExpression :: Lens' UpdateRoute (Maybe Text) Source #

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

updateRoute_requestModels :: Lens' UpdateRoute (Maybe (HashMap Text Text)) Source #

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

updateRoute_routeResponseSelectionExpression :: Lens' UpdateRoute (Maybe Text) Source #

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

updateRoute_requestParameters :: Lens' UpdateRoute (Maybe (HashMap Text ParameterConstraints)) Source #

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

updateRoute_authorizerId :: Lens' UpdateRoute (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.

updateRoute_operationName :: Lens' UpdateRoute (Maybe Text) Source #

The operation name for the route.

updateRoute_authorizationType :: Lens' UpdateRoute (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.

updateRoute_apiKeyRequired :: Lens' UpdateRoute (Maybe Bool) Source #

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

updateRoute_routeKey :: Lens' UpdateRoute (Maybe Text) Source #

The route key for the route.

updateRoute_target :: Lens' UpdateRoute (Maybe Text) Source #

The target for the route.

updateRoute_apiId :: Lens' UpdateRoute Text Source #

The API identifier.

updateRoute_routeId :: Lens' UpdateRoute Text Source #

The route ID.

Destructuring the Response

data UpdateRouteResponse' Source #

See: newUpdateRouteResponse' smart constructor.

Constructors

UpdateRouteResponse''

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

newUpdateRouteResponse' Source #

Arguments

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

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

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

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

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

$sel:routeId:UpdateRoute', updateRouteResponse'_routeId - The route ID.

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

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

$sel:routeKey:UpdateRoute', updateRouteResponse'_routeKey - The route key for the route.

$sel:target:UpdateRoute', updateRouteResponse'_target - The target for the route.

$sel:httpStatus:UpdateRouteResponse'', updateRouteResponse'_httpStatus - The response's http status code.

Response Lenses

updateRouteResponse'_authorizationScopes :: Lens' UpdateRouteResponse' (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.

updateRouteResponse'_modelSelectionExpression :: Lens' UpdateRouteResponse' (Maybe Text) Source #

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

updateRouteResponse'_requestModels :: Lens' UpdateRouteResponse' (Maybe (HashMap Text Text)) Source #

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

updateRouteResponse'_routeResponseSelectionExpression :: Lens' UpdateRouteResponse' (Maybe Text) Source #

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

updateRouteResponse'_requestParameters :: Lens' UpdateRouteResponse' (Maybe (HashMap Text ParameterConstraints)) Source #

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

updateRouteResponse'_routeId :: Lens' UpdateRouteResponse' (Maybe Text) Source #

The route ID.

updateRouteResponse'_authorizerId :: Lens' UpdateRouteResponse' (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.

updateRouteResponse'_operationName :: Lens' UpdateRouteResponse' (Maybe Text) Source #

The operation name for the route.

updateRouteResponse'_apiGatewayManaged :: Lens' UpdateRouteResponse' (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.

updateRouteResponse'_authorizationType :: Lens' UpdateRouteResponse' (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.

updateRouteResponse'_apiKeyRequired :: Lens' UpdateRouteResponse' (Maybe Bool) Source #

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

updateRouteResponse'_routeKey :: Lens' UpdateRouteResponse' (Maybe Text) Source #

The route key for the route.

updateRouteResponse'_target :: Lens' UpdateRouteResponse' (Maybe Text) Source #

The target for the route.

updateRouteResponse'_httpStatus :: Lens' UpdateRouteResponse' Int Source #

The response's http status code.