describe_user `async` ¶

describe_user(
    broker_id: __string,
    username: __string,
    *,
    config_overrides: Optional[AsyncmqClientConfig] = None,
) -> DescribeUserResponse

Returns information about an ActiveMQ user.

Parameters:

broker_id (__string) –

The unique ID that Amazon MQ generates for the broker.
username (__string) –

The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Raises:

BadRequestException –

Returns information about an error.
ForbiddenException –

Returns information about an error.
InternalServerErrorException –

Returns information about an error.
NotFoundException –

Returns information about an error.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_mq/_services/async_mq.py

async def describe_user(
    self,
    broker_id: "capo_mq.types.__string.__string",
    username: "capo_mq.types.__string.__string",
    *,
    config_overrides: Optional[AsyncmqClientConfig] = None,
) -> "capo_mq.types.describe_user_response.DescribeUserResponse":
    """<p>Returns information about an ActiveMQ user.</p>

    Args:
        broker_id: <p>The unique ID that Amazon MQ generates for the broker.</p>
        username: <p>The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.</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.describe_user_request.DescribeUserRequest]",
    ) -> AsyncOperationResponse[
        "capo_mq.types.describe_user_response.DescribeUserResponse"
    ]:
        import capo_mq._operations.mq.describe_user

        (
            output,
            http_response,
        ) = await capo_mq._operations.mq.describe_user.async_describe_user(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeUser")
    )
    input_: capo_mq.types.describe_user_request.DescribeUserRequest = {
        "broker_id": broker_id,
        "username": username,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_user async ¶

describe_user `async` ¶