get_authorizer¶
Operation¶
async
¶
get_authorizer(input: GetAuthorizerInput, plugins: list[Plugin] | None = None) -> GetAuthorizerOutput
Describe an existing Authorizer resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetAuthorizerInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetAuthorizerOutput
|
An instance of |
Input¶
dataclass
¶
Request to describe an existing Authorizer resource.
Output¶
dataclass
¶
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
Attributes¶
class-attribute
instance-attribute
¶
auth_type: str | None = None
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
class-attribute
instance-attribute
¶
authorizer_credentials: str | None = None
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
class-attribute
instance-attribute
¶
authorizer_result_ttl_in_seconds: int | None = None
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.
class-attribute
instance-attribute
¶
authorizer_uri: str | None = None
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:path/2015-03-31/functions/arn: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-31/functions/[FunctionARN]/invocations.
class-attribute
instance-attribute
¶
id: str | None = None
The identifier for the authorizer resource.
class-attribute
instance-attribute
¶
identity_source: str | None = None
The identity source for which authorization is requested. For a TOKEN
or COGNITO_USER_POOLS 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.
class-attribute
instance-attribute
¶
identity_validation_expression: str | None = None
A validation expression for the incoming identity token. For TOKEN
authorizers, this value is a regular expression. For
COGNITO_USER_POOLS authorizers, API Gateway will match the aud field
of the incoming token from the client against the specified regular
expression. It will invoke the authorizer's Lambda function when 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.
class-attribute
instance-attribute
¶
provider_ar_ns: list[str] | None = None
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.
class-attribute
instance-attribute
¶
type: AuthorizerType | None = None
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.