Network.AWS.APIGateway.GetAuthorizer

Describe an existing Authorizer resource.

AWS CLI

Creating a Request

getAuthorizer

Arguments

:: Text

gaaRestAPIId

-> Text

gaaAuthorizerId

-> GetAuthorizer

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

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

• gaaRestAPIId - The RestApi identifier for the Authorizer resource.
• gaaAuthorizerId - The identifier of the Authorizer resource.

data GetAuthorizer

Request to describe an existing Authorizer resource.

See: getAuthorizer smart constructor.

Instances

Eq GetAuthorizer

Methods

(==) :: GetAuthorizer -> GetAuthorizer -> Bool

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

Data GetAuthorizer

Methods

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

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

toConstr :: GetAuthorizer -> Constr

dataTypeOf :: GetAuthorizer -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetAuthorizer

Methods

readsPrec :: Int -> ReadS GetAuthorizer

readList :: ReadS [GetAuthorizer]

readPrec :: ReadPrec GetAuthorizer

readListPrec :: ReadPrec [GetAuthorizer]

Show GetAuthorizer

Methods

showsPrec :: Int -> GetAuthorizer -> ShowS

show :: GetAuthorizer -> String

showList :: [GetAuthorizer] -> ShowS

Generic GetAuthorizer

Associated Types

type Rep GetAuthorizer :: * -> *

Methods

from :: GetAuthorizer -> Rep GetAuthorizer x

to :: Rep GetAuthorizer x -> GetAuthorizer

Hashable GetAuthorizer

Methods

hashWithSalt :: Int -> GetAuthorizer -> Int

hash :: GetAuthorizer -> Int

NFData GetAuthorizer

Methods

rnf :: GetAuthorizer -> ()

AWSRequest GetAuthorizer

Associated Types

type Rs GetAuthorizer :: *

Methods

request :: GetAuthorizer -> Request GetAuthorizer

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

ToPath GetAuthorizer

Methods

toPath :: GetAuthorizer -> ByteString

ToHeaders GetAuthorizer

Methods

toHeaders :: GetAuthorizer -> [Header]

ToQuery GetAuthorizer

Methods

toQuery :: GetAuthorizer -> QueryString

type Rep GetAuthorizer

type Rep GetAuthorizer = D1 (MetaData "GetAuthorizer" "Network.AWS.APIGateway.GetAuthorizer" "amazonka-apigateway-1.4.5-BIK2fycuXdJFBbWQ9Hqf16" False) (C1 (MetaCons "GetAuthorizer'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gaaRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_gaaAuthorizerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs GetAuthorizer

type Rs GetAuthorizer = Authorizer

Request Lenses

gaaRestAPIId :: Lens' GetAuthorizer Text

The RestApi identifier for the Authorizer resource.

gaaAuthorizerId :: Lens' GetAuthorizer 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 - [Required] Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN 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. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.
• aProviderARNs - A list of the provider ARNs of the authorizer. For an TOKEN authorizer, this is not defined. For authorizers of the COGNITO_USER_POOLS type, each element corresponds to a user pool ARN of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} .
• aName - [Required] The name of the authorizer.
• aId - The identifier for the authorizer resource.
• aAuthorizerResultTtlInSeconds - The TTL in seconds of cached authorizer results. If 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/exports. Has no functional impact.
• aType - [Required] The type of the authorizer. Currently, the valid type is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool.
• aIdentitySource - [Required] The source of the identity in an incoming request. For a TOKEN authorizer, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is header, so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token. For COGNITO_USER_POOLS authorizers, this property is used.
• aAuthorizerCredentials - Specifies the credentials required for the authorizer, if any. Two options are available. 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.4.5-BIK2fycuXdJFBbWQ9Hqf16" 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)

Required

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN 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. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.

aProviderARNs :: Lens' Authorizer [Text]

A list of the provider ARNs of the authorizer. For an TOKEN authorizer, this is not defined. For authorizers of the COGNITO_USER_POOLS type, each element corresponds to a user pool ARN of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} .

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 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/exports. Has no functional impact.

aType :: Lens' Authorizer (Maybe AuthorizerType)

Required

The type of the authorizer. Currently, the valid type is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool.

aIdentitySource :: Lens' Authorizer (Maybe Text)

Required

The source of the identity in an incoming request. For a TOKEN authorizer, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is header, so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token. For COGNITO_USER_POOLS authorizers, this property is used.

aAuthorizerCredentials :: Lens' Authorizer (Maybe Text)

Specifies the credentials required for the authorizer, if any. Two options are available. 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.