Skip to content

update_phone_number_settings async

update_phone_number_settings(
    calling_name: CallingName,
    *,
    config_overrides: Optional[AsyncChimeSDKVoiceClientConfig] = None,
) -> None

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

Parameters:

  • calling_name (CallingName) –

    The default outbound calling name for the account.

Raises:

Source code in docs_src/capo_chime_sdk_voice/_services/async_chime_sdk_voice.py
async def update_phone_number_settings(
    self,
    calling_name: "capo_chime_sdk_voice.types.calling_name.CallingName",
    *,
    config_overrides: Optional[AsyncChimeSDKVoiceClientConfig] = None,
) -> None:
    """<p>Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.</p>

    Args:
        calling_name: <p>The default outbound calling name for the account.</p>

    Raises:
        capo_chime_sdk_voice.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_voice.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_voice.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_voice.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_voice.errors.throttled_client_exception.ThrottledClientException: <p>The number of customer requests exceeds the request rate limit.</p>
        capo_chime_sdk_voice.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client isn't authorized to request a resource.</p>
        capo_chime_sdk_voice.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime_sdk_voice.types.update_phone_number_settings_request.UpdatePhoneNumberSettingsRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_chime_sdk_voice._operations.chime_sdk_telephony_service.update_phone_number_settings

        (
            output,
            http_response,
        ) = await capo_chime_sdk_voice._operations.chime_sdk_telephony_service.update_phone_number_settings.async_update_phone_number_settings(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime_sdk_voice.types.update_phone_number_settings_request.UpdatePhoneNumberSettingsRequest",
    ) -> dict[str, Any]:
        import capo_chime_sdk_voice.types.update_phone_number_settings_request

        return capo_chime_sdk_voice.types.update_phone_number_settings_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdatePhoneNumberSettings", redact_input=_redact_input),
    )
    input_: capo_chime_sdk_voice.types.update_phone_number_settings_request.UpdatePhoneNumberSettingsRequest = {
        "calling_name": calling_name
    }

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