Menu
AWS IoT
Developer Guide

ListAuthorizers

Lists the authorizers registered in your account.

Request syntax:

GET /authorizers/?pageSize=pageSize&marker=marker&isAscendingOrder=ascendingOrder&status=status

URI Request Parameters:

Name

Type

Req?

Description

pageSize

PageSize

no

The maximum number of results to return at one time.

marker

Marker

no

A marker used to get the next set of results.

ascendingOrder

AscendingOrder

no

Return the list of authorizers in ascending alphabetical order.

status

AuthorizerStatus

no

The status of the list authorizers request.

Response syntax:

Content-type: application/json { "authorizers": [ { "authorizerName": "string", "authorizerArn": "string" } ], "nextMarker": "string" }

Response Body Parameters:

Name

Type

Req?

Description

authorizers

Authorizers

no

The authorizers.

nextMarker

Marker

no

A marker used to get the next set of results.

Errors:

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 list-authorizers \ [--page-size <value>] \ [--marker <value>] \ [--ascending-order | --no-ascending-order] \ [--status <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "pageSize": "integer", "marker": "string", "ascendingOrder": "boolean", "status": "string" }

cli-input-json fields:

Name

Type

Description

pageSize

integer

java class: java.lang.Integer

range- max:250 min:1

The maximum number of results to return at one time.

marker

string

pattern: [A-Za-z0-9+/]+={0,2}

A marker used to get the next set of results.

ascendingOrder

boolean

Return the list of authorizers in ascending alphabetical order.

status

string

enum: ACTIVE | INACTIVE

java class: iot.identity.service.AuthorizerStatus

The status of the list authorizers request.

Output:

{ "authorizers": [ { "authorizerName": "string", "authorizerArn": "string" } ], "nextMarker": "string" }

cli output fields:

Name

Type

Description

authorizers

list

member: AuthorizerSummary

java class: java.util.List

The authorizers.

AuthorizerSummary

AuthorizerSummary

authorizerName

string

length max:128 min:1

pattern: [w=,@-]+

The authorizer name.

authorizerArn

string

The authorizer ARN.

nextMarker

string

pattern: [A-Za-z0-9+/]+={0,2}

A marker used to get the next set of results.

On this page: