update_user async ¶

async def update_user(
    self,
    broker_id: "capo_mq.types.__string.__string",
    username: "capo_mq.types.__string.__string",
    *,
    config_overrides: Optional[AsyncmqClientConfig] = None,
    console_access: Optional["capo_mq.types.__boolean.__boolean"] = None,
    groups: Optional["capo_mq.types.__list_of__string.__listOf__string"] = None,
    password: Optional["capo_mq.types.__string.__string"] = None,
    replication_user: Optional["capo_mq.types.__boolean.__boolean"] = None,
) -> "capo_mq.types.update_user_response.UpdateUserResponse":
    """<p>Updates the information for an ActiveMQ user.</p>

    Args:
        broker_id: <p>The unique ID that Amazon MQ generates for the broker.</p>
        console_access: <p>Enables access to the the ActiveMQ Web Console for the ActiveMQ user.</p>
        groups: <p>The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.</p>
        password: <p>The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).</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>
        replication_user: <p>Defines whether the user is intended for data replication.</p>

    Raises:
        capo_mq.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
        capo_mq.errors.conflict_exception.ConflictException: <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.update_user_request.UpdateUserRequest]",
    ) -> AsyncOperationResponse[
        "capo_mq.types.update_user_response.UpdateUserResponse"
    ]:
        import capo_mq._operations.mq.update_user

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateUser")
    )
    input_: capo_mq.types.update_user_request.UpdateUserRequest = {
        "broker_id": broker_id,
        "username": username,
    }
    if console_access is not None:
        input_["console_access"] = console_access
    if groups is not None:
        input_["groups"] = groups
    if password is not None:
        input_["password"] = password
    if replication_user is not None:
        input_["replication_user"] = replication_user

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