Network.AWS.APIGateway.UpdateAuthorizer

Updates an existing Authorizer resource.

AWS CLI

Creating a Request

updateAuthorizer

Arguments

:: Text

uaaRestAPIId

-> Text

uaaAuthorizerId

-> UpdateAuthorizer

Creates a value of UpdateAuthorizer with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uaaPatchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.
• uaaRestAPIId - The string identifier of the associated RestApi .
• uaaAuthorizerId - The identifier of the Authorizer resource.

data UpdateAuthorizer

Request to update an existing Authorizer resource.

See: updateAuthorizer smart constructor.

Instances

Eq UpdateAuthorizer

Methods

(==) :: UpdateAuthorizer -> UpdateAuthorizer -> Bool

(/=) :: UpdateAuthorizer -> UpdateAuthorizer -> Bool

Data UpdateAuthorizer

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateAuthorizer -> c UpdateAuthorizer

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateAuthorizer

toConstr :: UpdateAuthorizer -> Constr

dataTypeOf :: UpdateAuthorizer -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateAuthorizer)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateAuthorizer)

gmapT :: (forall b. Data b => b -> b) -> UpdateAuthorizer -> UpdateAuthorizer

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateAuthorizer -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateAuthorizer -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateAuthorizer -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateAuthorizer -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateAuthorizer -> m UpdateAuthorizer

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateAuthorizer -> m UpdateAuthorizer

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateAuthorizer -> m UpdateAuthorizer

Read UpdateAuthorizer

Methods

readsPrec :: Int -> ReadS UpdateAuthorizer

readList :: ReadS [UpdateAuthorizer]

readPrec :: ReadPrec UpdateAuthorizer

readListPrec :: ReadPrec [UpdateAuthorizer]

Show UpdateAuthorizer

Methods

showsPrec :: Int -> UpdateAuthorizer -> ShowS

show :: UpdateAuthorizer -> String

showList :: [UpdateAuthorizer] -> ShowS

Generic UpdateAuthorizer

Associated Types

type Rep UpdateAuthorizer :: * -> *

Methods

from :: UpdateAuthorizer -> Rep UpdateAuthorizer x

to :: Rep UpdateAuthorizer x -> UpdateAuthorizer

Hashable UpdateAuthorizer

Methods

hashWithSalt :: Int -> UpdateAuthorizer -> Int

hash :: UpdateAuthorizer -> Int

ToJSON UpdateAuthorizer

Methods

toJSON :: UpdateAuthorizer -> Value

toEncoding :: UpdateAuthorizer -> Encoding

toJSONList :: [UpdateAuthorizer] -> Value

toEncodingList :: [UpdateAuthorizer] -> Encoding

NFData UpdateAuthorizer

Methods

rnf :: UpdateAuthorizer -> ()

AWSRequest UpdateAuthorizer

Associated Types

type Rs UpdateAuthorizer :: *

Methods

request :: UpdateAuthorizer -> Request UpdateAuthorizer

response :: MonadResource m => Logger -> Service -> Proxy * UpdateAuthorizer -> ClientResponse -> m (Response UpdateAuthorizer)

ToQuery UpdateAuthorizer

Methods

toQuery :: UpdateAuthorizer -> QueryString

ToPath UpdateAuthorizer

Methods

toPath :: UpdateAuthorizer -> ByteString

ToHeaders UpdateAuthorizer

Methods

toHeaders :: UpdateAuthorizer -> [Header]

type Rep UpdateAuthorizer

type Rep UpdateAuthorizer = D1 (MetaData "UpdateAuthorizer" "Network.AWS.APIGateway.UpdateAuthorizer" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "UpdateAuthorizer'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_uaaPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PatchOperation]))) ((:*:) (S1 (MetaSel (Just Symbol "_uaaRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_uaaAuthorizerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs UpdateAuthorizer

type Rs UpdateAuthorizer = Authorizer

Request Lenses

uaaPatchOperations :: Lens' UpdateAuthorizer [PatchOperation]

A list of update operations to be applied to the specified resource and in the order specified in this list.

uaaRestAPIId :: Lens' UpdateAuthorizer Text

The string identifier of the associated RestApi .

uaaAuthorizerId :: Lens' UpdateAuthorizer Text

The identifier of the Authorizer resource.

Destructuring the Response

authorizer :: Authorizer

Creates a value of Authorizer with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• aAuthorizerURI - Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path2015-03-31functionsarn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial / . For Lambda functions, this is usually of the form 2015-03-31functions[FunctionARN]invocations .
• aIdentityValidationExpression - A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. Amazon API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
• aProviderARNs - A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN or REQUEST authorizer, this is not defined.
• aName - [Required] The name of the authorizer.
• aId - The identifier for the authorizer resource.
• aAuthorizerResultTtlInSeconds - The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
• aAuthType - Optional customer-defined field, used in Swagger imports and exports without functional impact.
• aType - [Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
• aIdentitySource - The identity source for which authorization is requested. * For a TOKEN authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth , the header mapping expression is method.request.header.Auth . * For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name . These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional. * For a COGNITO_USER_POOLS authorizer, this property is not used.
• aAuthorizerCredentials - Specifies the required credentials as an IAM role for Amazon API Gateway to invoke the authorizer. To specify an IAM role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

data Authorizer

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

Enable custom authorization

See: authorizer smart constructor.

Instances

Eq Authorizer

Methods

(==) :: Authorizer -> Authorizer -> Bool

(/=) :: Authorizer -> Authorizer -> Bool

Data Authorizer

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Authorizer -> c Authorizer

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Authorizer

toConstr :: Authorizer -> Constr

dataTypeOf :: Authorizer -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Authorizer)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Authorizer)

gmapT :: (forall b. Data b => b -> b) -> Authorizer -> Authorizer

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Authorizer -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Authorizer -> r

gmapQ :: (forall d. Data d => d -> u) -> Authorizer -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Authorizer -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Authorizer -> m Authorizer

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Authorizer -> m Authorizer

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Authorizer -> m Authorizer

Read Authorizer

Methods

readsPrec :: Int -> ReadS Authorizer

readList :: ReadS [Authorizer]

readPrec :: ReadPrec Authorizer

readListPrec :: ReadPrec [Authorizer]

Show Authorizer

Methods

showsPrec :: Int -> Authorizer -> ShowS

show :: Authorizer -> String

showList :: [Authorizer] -> ShowS

Generic Authorizer

Associated Types

type Rep Authorizer :: * -> *

Methods

from :: Authorizer -> Rep Authorizer x

to :: Rep Authorizer x -> Authorizer

Hashable Authorizer

Methods

hashWithSalt :: Int -> Authorizer -> Int

hash :: Authorizer -> Int

FromJSON Authorizer

Methods

parseJSON :: Value -> Parser Authorizer

parseJSONList :: Value -> Parser [Authorizer]

NFData Authorizer

Methods

rnf :: Authorizer -> ()

type Rep Authorizer

type Rep Authorizer = D1 (MetaData "Authorizer" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "Authorizer'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aAuthorizerURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aIdentityValidationExpression") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_aProviderARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_aName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aAuthorizerResultTtlInSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_aAuthType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_aType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AuthorizerType))) ((:*:) (S1 (MetaSel (Just Symbol "_aIdentitySource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aAuthorizerCredentials") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

Response Lenses

aAuthorizerURI :: Lens' Authorizer (Maybe Text)

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path2015-03-31functionsarn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial / . For Lambda functions, this is usually of the form 2015-03-31functions[FunctionARN]invocations .

aIdentityValidationExpression :: Lens' Authorizer (Maybe Text)

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. Amazon API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

aProviderARNs :: Lens' Authorizer [Text]

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN or REQUEST authorizer, this is not defined.

aName :: Lens' Authorizer (Maybe Text)

Required

The name of the authorizer.

aId :: Lens' Authorizer (Maybe Text)

The identifier for the authorizer resource.

aAuthorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int)

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

aAuthType :: Lens' Authorizer (Maybe Text)

Optional customer-defined field, used in Swagger imports and exports without functional impact.

aType :: Lens' Authorizer (Maybe AuthorizerType)

Required

The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

aIdentitySource :: Lens' Authorizer (Maybe Text)

The identity source for which authorization is requested. * For a TOKEN authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth , the header mapping expression is method.request.header.Auth . * For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name . These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional. * For a COGNITO_USER_POOLS authorizer, this property is not used.

aAuthorizerCredentials :: Lens' Authorizer (Maybe Text)

Specifies the required credentials as an IAM role for Amazon API Gateway to invoke the authorizer. To specify an IAM role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.