Skip to content

list_authorizers

list_authorizers(
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    page_size: Optional[PageSize] = None,
    marker: Optional[Marker] = None,
    ascending_order: Optional[AscendingOrder] = None,
    status: Optional[AuthorizerStatus] = None,
) -> ListAuthorizersResponse

Lists the authorizers registered in your account.

Requires permission to access the ListAuthorizers action.

Parameters:

  • page_size (Optional[PageSize], default: None ) –

    The maximum number of results to return at one time.

  • marker (Optional[Marker], default: None ) –

    A marker used to get the next set of results.

  • ascending_order (Optional[AscendingOrder], default: None ) –

    Return the list of authorizers in ascending alphabetical order.

  • status (Optional[AuthorizerStatus], default: None ) –

    The status of the list authorizers request.

Raises:

Source code in docs_src/capo_iot/_services/io_t.py
def list_authorizers(
    self,
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    page_size: Optional["capo_iot.types.page_size.PageSize"] = None,
    marker: Optional["capo_iot.types.marker.Marker"] = None,
    ascending_order: Optional[
        "capo_iot.types.ascending_order.AscendingOrder"
    ] = None,
    status: Optional["capo_iot.types.authorizer_status.AuthorizerStatus"] = None,
) -> "capo_iot.types.list_authorizers_response.ListAuthorizersResponse":
    """<p>Lists the authorizers registered in your account.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListAuthorizers</a> action.</p>

    Args:
        page_size: <p>The maximum number of results to return at one time.</p>
        marker: <p>A marker used to get the next set of results.</p>
        ascending_order: <p>Return the list of authorizers in ascending alphabetical order.</p>
        status: <p>The status of the list authorizers request.</p>

    Raises:
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.list_authorizers_request.ListAuthorizersRequest]",
    ) -> OperationResponse[
        "capo_iot.types.list_authorizers_response.ListAuthorizersResponse"
    ]:
        import capo_iot._operations.aws_iot_service.list_authorizers

        output, http_response = (
            capo_iot._operations.aws_iot_service.list_authorizers.list_authorizers(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAuthorizers")
    )
    input_: capo_iot.types.list_authorizers_request.ListAuthorizersRequest = {}
    if page_size is not None:
        input_["page_size"] = page_size
    if marker is not None:
        input_["marker"] = marker
    if ascending_order is not None:
        input_["ascending_order"] = ascending_order
    if status is not None:
        input_["status"] = status

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output