Skip to content

get_phone_number_settings

get_phone_number_settings(
    *, config_overrides: Optional[ChimeClientConfig] = None
) -> GetPhoneNumberSettingsResponse

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

Raises:

Source code in docs_src/capo_chime/_services/chime.py
def get_phone_number_settings(
    self, *, config_overrides: Optional[ChimeClientConfig] = None
) -> "capo_chime.types.get_phone_number_settings_response.GetPhoneNumberSettingsResponse":
    """<p>Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.</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.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.
    """

    def _handler(
        req: "OperationRequest[None]",
    ) -> OperationResponse[
        "capo_chime.types.get_phone_number_settings_response.GetPhoneNumberSettingsResponse"
    ]:
        import capo_chime._operations.uc_buzz_console_service.get_phone_number_settings

        output, http_response = (
            capo_chime._operations.uc_buzz_console_service.get_phone_number_settings.get_phone_number_settings(
                req.options
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_chime.types.get_phone_number_settings_response.GetPhoneNumberSettingsResponse",
    ) -> dict[str, Any]:
        import capo_chime.types.get_phone_number_settings_response

        return capo_chime.types.get_phone_number_settings_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetPhoneNumberSettings", redact_output=_redact_output),
    )

    response = execute_pipeline(
        OperationRequest(input=None, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output