Skip to content

AuthorizerDescription

Source code in docs_src/capo_iot/types/authorizer_description.py
class AuthorizerDescription(TypedDict, closed=True):
    authorizer_name: NotRequired["capo_iot.types.authorizer_name.AuthorizerName"]
    """<p>The authorizer name.</p>"""
    authorizer_arn: NotRequired["capo_iot.types.authorizer_arn.AuthorizerArn"]
    """<p>The authorizer ARN.</p>"""
    authorizer_function_arn: NotRequired[
        "capo_iot.types.authorizer_function_arn.AuthorizerFunctionArn"
    ]
    """<p>The authorizer's Lambda function ARN.</p>"""
    token_key_name: NotRequired["capo_iot.types.token_key_name.TokenKeyName"]
    """<p>The key used to extract the token from the HTTP headers.</p>"""
    token_signing_public_keys: NotRequired["capo_iot.types.public_key_map.PublicKeyMap"]
    """<p>The public keys used to validate the token signature returned by your custom authentication service.</p>"""
    status: NotRequired["capo_iot.types.authorizer_status.AuthorizerStatus"]
    """<p>The status of the authorizer.</p>"""
    creation_date: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The UNIX timestamp of when the authorizer was created.</p>"""
    last_modified_date: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The UNIX timestamp of when the authorizer was last updated.</p>"""
    signing_disabled: NotRequired["capo_iot.types.boolean_key.BooleanKey"]
    """<p>Specifies whether IoT validates the token signature in an authorization request.</p>"""
    enable_caching_for_http: NotRequired[
        "capo_iot.types.enable_caching_for_http.EnableCachingForHttp"
    ]
    """<p>When <code>true</code>, the result from the authorizer’s Lambda function is cached for the time specified in <code>refreshAfterInSeconds</code>. The cached result is used while the device reuses the same HTTP connection.</p>"""

authorizer_arn instance-attribute

authorizer_arn: NotRequired[AuthorizerArn]

The authorizer ARN.

authorizer_function_arn instance-attribute

authorizer_function_arn: NotRequired[AuthorizerFunctionArn]

The authorizer's Lambda function ARN.

authorizer_name instance-attribute

authorizer_name: NotRequired[AuthorizerName]

The authorizer name.

creation_date instance-attribute

creation_date: NotRequired[DateType]

The UNIX timestamp of when the authorizer was created.

enable_caching_for_http instance-attribute

enable_caching_for_http: NotRequired[EnableCachingForHttp]

When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection.

last_modified_date instance-attribute

last_modified_date: NotRequired[DateType]

The UNIX timestamp of when the authorizer was last updated.

signing_disabled instance-attribute

signing_disabled: NotRequired[BooleanKey]

Specifies whether IoT validates the token signature in an authorization request.

status instance-attribute

status: NotRequired[AuthorizerStatus]

The status of the authorizer.

token_key_name instance-attribute

token_key_name: NotRequired[TokenKeyName]

The key used to extract the token from the HTTP headers.

token_signing_public_keys instance-attribute

token_signing_public_keys: NotRequired[PublicKeyMap]

The public keys used to validate the token signature returned by your custom authentication service.