Returns a list of all ActiveMQ users.
Parameters:
-
broker_id
(__string)
–
The unique ID that Amazon MQ generates for the broker.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
-
next_token
(Optional[__string], default:
None
)
–
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
Raises:
Source code in docs_src/capo_mq/_services/async_mq.py
| async def list_users(
self,
broker_id: "capo_mq.types.__string.__string",
*,
config_overrides: Optional[AsyncmqClientConfig] = None,
max_results: Optional["capo_mq.types.max_results.MaxResults"] = None,
next_token: Optional["capo_mq.types.__string.__string"] = None,
) -> "capo_mq.types.list_users_response.ListUsersResponse":
"""<p>Returns a list of all ActiveMQ users.</p>
Args:
broker_id: <p>The unique ID that Amazon MQ generates for the broker.</p>
max_results: <p>The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.</p>
next_token: <p>The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.</p>
Raises:
capo_mq.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
capo_mq.errors.forbidden_exception.ForbiddenException: <p>Returns information about an error.</p>
capo_mq.errors.internal_server_error_exception.InternalServerErrorException: <p>Returns information about an error.</p>
capo_mq.errors.not_found_exception.NotFoundException: <p>Returns information about an error.</p>
capo_mq.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_mq.types.list_users_request.ListUsersRequest]",
) -> AsyncOperationResponse[
"capo_mq.types.list_users_response.ListUsersResponse"
]:
import capo_mq._operations.mq.list_users
(
output,
http_response,
) = await capo_mq._operations.mq.list_users.async_list_users(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListUsers")
)
input_: capo_mq.types.list_users_request.ListUsersRequest = {
"broker_id": broker_id
}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|