IoT / Client / describe_authorizer

describe_authorizer

IoT.Client.describe_authorizer(**kwargs)

Describes an authorizer.

Requires permission to access the DescribeAuthorizer action.

See also: AWS API Documentation

Request Syntax

response = client.describe_authorizer(
    authorizerName='string'
)

Parameters:

authorizerName (string) –

[REQUIRED]

The name of the authorizer to describe.

Return type:

dict

Returns:

Response Syntax

{
    'authorizerDescription': {
        'authorizerName': 'string',
        'authorizerArn': 'string',
        'authorizerFunctionArn': 'string',
        'tokenKeyName': 'string',
        'tokenSigningPublicKeys': {
            'string': 'string'
        },
        'status': 'ACTIVE'|'INACTIVE',
        'creationDate': datetime(2015, 1, 1),
        'lastModifiedDate': datetime(2015, 1, 1),
        'signingDisabled': True|False,
        'enableCachingForHttp': True|False
    }
}

Response Structure

• (dict) –

  • authorizerDescription (dict) –

    The authorizer description.

    • authorizerName (string) –

      The authorizer name.

    • authorizerArn (string) –

      The authorizer ARN.

    • authorizerFunctionArn (string) –

      The authorizer’s Lambda function ARN.

    • tokenKeyName (string) –

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

    • tokenSigningPublicKeys (dict) –

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

      • (string) –

        • (string) –

    • status (string) –

      The status of the authorizer.

    • creationDate (datetime) –

      The UNIX timestamp of when the authorizer was created.

    • lastModifiedDate (datetime) –

      The UNIX timestamp of when the authorizer was last updated.

    • signingDisabled (boolean) –

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

    • enableCachingForHttp (boolean) –

      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.

Exceptions

• IoT.Client.exceptions.ResourceNotFoundException

• IoT.Client.exceptions.InvalidRequestException

• IoT.Client.exceptions.ThrottlingException

• IoT.Client.exceptions.UnauthorizedException

• IoT.Client.exceptions.ServiceUnavailableException

• IoT.Client.exceptions.InternalFailureException