Menu
AWS IoT
Developer Guide

DescribeAuthorizer

DescribeAuthorizer

Describes an authorizer.

https

Request syntax:

GET /authorizer/authorizerName

URI Request Parameters:

Name

Type

Req?

Description

authorizerName

AuthorizerName

yes

The name of the authorizer to describe.

Response syntax:

Content-type: application/json { "authorizerDescription": { "authorizerName": "string", "authorizerArn": "string", "authorizerFunctionArn": "string", "tokenKeyName": "string", "tokenSigningPublicKeys": { "string": "string" }, "status": "string", "creationDate": "timestamp", "lastModifiedDate": "timestamp" } }

Response Body Parameters:

Name

Type

Req?

Description

authorizerDescription

AuthorizerDescription

no

The authorizer description.

Errors:

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

cli

Synopsis:

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

cli-input-json format:

{ "authorizerName": "string" }

cli-input-json fields:

Name

Type

Description

authorizerName

string

length- max:128 min:1

pattern: [w=,@-]+

The name of the authorizer to describe.

Output:

{ "authorizerDescription": { "authorizerName": "string", "authorizerArn": "string", "authorizerFunctionArn": "string", "tokenKeyName": "string", "tokenSigningPublicKeys": { "string": "string" }, "status": "string", "creationDate": "timestamp", "lastModifiedDate": "timestamp" } }

cli output fields:

Name

Type

Description

authorizerDescription

AuthorizerDescription

The authorizer description.

authorizerName

string

length- max:128 min:1

pattern: [w=,@-]+

The authorizer name.

authorizerArn

string

The authorizer ARN.

authorizerFunctionArn

string

The authorizer's Lambda function ARN.

tokenKeyName

string

length- max:128 min:1

pattern: [a-zA-Z0-9_-]+

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.

status

string

The status of the authorizer.

enum: ACTIVE | INACTIVE

creationDate

timestamp

The UNIX timestamp of when the authorizer was created.

lastModifiedDate

timestamp

The UNIX timestamp of when the authorizer was last updated.

Errors:

ResourceNotFoundException

The specified resource does not exist.

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

ThrottlingException

The rate exceeds the limit.

UnauthorizedException

You are not authorized to perform this operation.

ServiceUnavailableException

The service is temporarily unavailable.

InternalFailureException

An unexpected error has occurred.