- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListAuthorizersCommand
Lists the authorizers registered in your account.
Requires permission to access the ListAuthorizers action.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTClient, ListAuthorizersCommand } from "@aws-sdk/client-iot"; // ES Modules import
// const { IoTClient, ListAuthorizersCommand } = require("@aws-sdk/client-iot"); // CommonJS import
const client = new IoTClient(config);
const input = { // ListAuthorizersRequest
pageSize: Number("int"),
marker: "STRING_VALUE",
ascendingOrder: true || false,
status: "ACTIVE" || "INACTIVE",
};
const command = new ListAuthorizersCommand(input);
const response = await client.send(command);
// { // ListAuthorizersResponse
// authorizers: [ // Authorizers
// { // AuthorizerSummary
// authorizerName: "STRING_VALUE",
// authorizerArn: "STRING_VALUE",
// },
// ],
// nextMarker: "STRING_VALUE",
// };
ListAuthorizersCommand Input
See ListAuthorizersCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ascendingOrder | boolean | undefined | Return the list of authorizers in ascending alphabetical order. |
marker | string | undefined | A marker used to get the next set of results. |
pageSize | number | undefined | The maximum number of results to return at one time. |
status | AuthorizerStatus | undefined | The status of the list authorizers request. |
ListAuthorizersCommand Output
See ListAuthorizersCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
authorizers | AuthorizerSummary[] | undefined | The authorizers. |
nextMarker | string | undefined | A marker used to get the next set of results. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalFailureException | server | An unexpected error has occurred. |
| InvalidRequestException | client | The request is not valid. |
| ServiceUnavailableException | server | The service is temporarily unavailable. |
| ThrottlingException | client | The rate exceeds the limit. |
| UnauthorizedException | client | You are not authorized to perform this operation. |
| IoTServiceException | Base exception class for all service exceptions from IoT service. |