update_user_settings `async` ¶

update_user_settings(
    account_id: String,
    user_id: String,
    user_settings: UserSettings,
    *,
    config_overrides: Optional[AsyncChimeClientConfig] = None,
) -> None

Updates the settings for the specified user, such as phone number settings.

Parameters:

account_id (String) –

The Amazon Chime account ID.
user_id (String) –

The user ID.
user_settings (UserSettings) –

The user settings to update.

Raises:

BadRequestException –

The input parameters don't match the service's restrictions.
ForbiddenException –

The client is permanently forbidden from making the request.
NotFoundException –

One or more of the resources in the request does not exist in the system.
ServiceFailureException –

The service encountered an unexpected error.
ServiceUnavailableException –

The service is currently unavailable.
ThrottledClientException –

The client exceeded its request rate limit.
UnauthorizedClientException –

The client is not currently authorized to make the request.
UnknownServiceError –

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

Source code in docs_src/capo_chime/_services/async_chime.py

async def update_user_settings(
    self,
    account_id: "capo_chime.types.string.String",
    user_id: "capo_chime.types.string.String",
    user_settings: "capo_chime.types.user_settings.UserSettings",
    *,
    config_overrides: Optional[AsyncChimeClientConfig] = None,
) -> None:
    """<p>Updates the settings for the specified user, such as phone number settings.</p>

    Args:
        account_id: <p>The Amazon Chime account ID.</p>
        user_id: <p>The user ID.</p>
        user_settings: <p>The user settings to update.</p>

    Raises:
        capo_chime.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system.</p>
        capo_chime.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime.types.update_user_settings_request.UpdateUserSettingsRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_chime._operations.uc_buzz_console_service.update_user_settings

        (
            output,
            http_response,
        ) = await capo_chime._operations.uc_buzz_console_service.update_user_settings.async_update_user_settings(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateUserSettings")
    )
    input_: capo_chime.types.update_user_settings_request.UpdateUserSettingsRequest = {
        "account_id": account_id,
        "user_id": user_id,
        "user_settings": user_settings,
    }

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

update_user_settings async ¶

update_user_settings `async` ¶