Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . iot ]

describe-authorizer

Description

Describes an authorizer.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-authorizer
--authorizer-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--authorizer-name (string)

The name of the authorizer to describe.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To get information about a custom authorizer

The following describe-authorizer example displays details for the specified custom authorizer.

aws iot describe-authorizer \
    --authorizer-name CustomAuthorizer

Output:

{
    "authorizerDescription": {
        "authorizerName": "CustomAuthorizer",
        "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer",
        "authorizerFunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:CustomAuthorizerFunction",
        "tokenKeyName": "MyAuthToken",
        "tokenSigningPublicKeys": {
            "FIRST_KEY": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1uJOB4lQPgG/lM6ZfIwo\nZ+7ENxAio9q6QD4FFqjGZsvjtYwjoe1RKK0U8Eq9xb5O3kRSmyIwTzwzm/f4Gf0Y\nZUloJ+t3PUUwHrmbYTAgTrCUgRFygjfgVwGCPs5ZAX4Eyqt5cr+AIHIiUDbxSa7p\nzwOBKPeic0asNJpqT8PkBbRaKyleJh5oo81NDHHmVtbBm5A5YiJjqYXLaVAowKzZ\n+GqsNvAQ9Jy1wI2VrEa1OfL8flDB/BJLm7zjpfPOHDJQgID0XnZwAlNnZcOhCwIx\n50g2LW2Oy9R/dmqtDmJiVP97Z4GykxPvwlYHrUXY0iW1R3AR/Ac1NhCTGZMwVDB1\nlQIDAQAB\n-----END PUBLIC KEY-----"
        },
        "status": "ACTIVE",
        "creationDate": 1571245658.069,
        "lastModifiedDate": 1571245658.069
    }
}

For more information, see DescribeAuthorizer in the AWS IoT API Reference.

Output

authorizerDescription -> (structure)

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 -> (map)

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

key -> (string)

value -> (string)

status -> (string)

The status of the authorizer.

creationDate -> (timestamp)

The UNIX timestamp of when the authorizer was created.

lastModifiedDate -> (timestamp)

The UNIX timestamp of when the authorizer was last updated.

signingDisabled -> (boolean)

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