IoT / Client / list_authorizers

list_authorizers#

IoT.Client.list_authorizers(**kwargs)#

Lists the authorizers registered in your account.

Requires permission to access the ListAuthorizers action.

See also: AWS API Documentation

Request Syntax

response = client.list_authorizers(
    pageSize=123,
    marker='string',
    ascendingOrder=True|False,
    status='ACTIVE'|'INACTIVE'
)
Parameters:
  • pageSize (integer) – The maximum number of results to return at one time.

  • marker (string) – A marker used to get the next set of results.

  • ascendingOrder (boolean) – Return the list of authorizers in ascending alphabetical order.

  • status (string) – The status of the list authorizers request.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • authorizers (list) –

      The authorizers.

      • (dict) –

        The authorizer summary.

        • authorizerName (string) –

          The authorizer name.

        • authorizerArn (string) –

          The authorizer ARN.

    • nextMarker (string) –

      A marker used to get the next set of results.

Exceptions

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.UnauthorizedException

  • IoT.Client.exceptions.ServiceUnavailableException

  • IoT.Client.exceptions.InternalFailureException