Skip to content

put_voice_connector_proxy

put_voice_connector_proxy(
    voice_connector_id: VoiceConnectorId,
    default_session_expiry_minutes: Integer,
    phone_number_pool_countries: CountryList,
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
    fall_back_phone_number: Optional[E164PhoneNumber] = None,
    disabled: Optional[Boolean] = None,
) -> PutVoiceConnectorProxyResponse

Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.

End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.

Parameters:

  • voice_connector_id (VoiceConnectorId) –

    The Voice Connector ID.

  • default_session_expiry_minutes (Integer) –

    The default number of minutes allowed for proxy session.

  • phone_number_pool_countries (CountryList) –

    The countries for proxy phone numbers to be selected from.

  • fall_back_phone_number (Optional[E164PhoneNumber], default: None ) –

    The phone number to route calls to after a proxy session expires.

  • disabled (Optional[Boolean], default: None ) –

    When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.

Raises:

Source code in docs_src/capo_chime_sdk_voice/_services/chime_sdk_voice.py
def put_voice_connector_proxy(
    self,
    voice_connector_id: "capo_chime_sdk_voice.types.voice_connector_id.VoiceConnectorId",
    default_session_expiry_minutes: "capo_chime_sdk_voice.types.integer.Integer",
    phone_number_pool_countries: "capo_chime_sdk_voice.types.country_list.CountryList",
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
    fall_back_phone_number: Optional[
        "capo_chime_sdk_voice.types.e164_phone_number.E164PhoneNumber"
    ] = None,
    disabled: Optional["capo_chime_sdk_voice.types.boolean.Boolean"] = None,
) -> "capo_chime_sdk_voice.types.put_voice_connector_proxy_response.PutVoiceConnectorProxyResponse":
    """<p>Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.</p> <important> <p>End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.</p> </important>

    Args:
        voice_connector_id: <p>The Voice Connector ID.</p>
        default_session_expiry_minutes: <p>The default number of minutes allowed for proxy session.</p>
        phone_number_pool_countries: <p>The countries for proxy phone numbers to be selected from.</p>
        fall_back_phone_number: <p>The phone number to route calls to after a proxy session expires.</p>
        disabled: <p>When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.</p>

    Raises:
        capo_chime_sdk_voice.errors.access_denied_exception.AccessDeniedException: <p>You don't have the permissions needed to run this action.</p>
        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.not_found_exception.NotFoundException: <p>The requested resource couldn't be found.</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.
    """

    def _handler(
        req: "OperationRequest[capo_chime_sdk_voice.types.put_voice_connector_proxy_request.PutVoiceConnectorProxyRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_voice.types.put_voice_connector_proxy_response.PutVoiceConnectorProxyResponse"
    ]:
        import capo_chime_sdk_voice._operations.chime_sdk_telephony_service.put_voice_connector_proxy

        output, http_response = (
            capo_chime_sdk_voice._operations.chime_sdk_telephony_service.put_voice_connector_proxy.put_voice_connector_proxy(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

        return capo_chime_sdk_voice.types.put_voice_connector_proxy_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_chime_sdk_voice.types.put_voice_connector_proxy_response.PutVoiceConnectorProxyResponse",
    ) -> dict[str, Any]:
        import capo_chime_sdk_voice.types.put_voice_connector_proxy_response

        return capo_chime_sdk_voice.types.put_voice_connector_proxy_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "PutVoiceConnectorProxy",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_chime_sdk_voice.types.put_voice_connector_proxy_request.PutVoiceConnectorProxyRequest = {
        "voice_connector_id": voice_connector_id,
        "default_session_expiry_minutes": default_session_expiry_minutes,
        "phone_number_pool_countries": phone_number_pool_countries,
    }
    if fall_back_phone_number is not None:
        input_["fall_back_phone_number"] = fall_back_phone_number
    if disabled is not None:
        input_["disabled"] = disabled

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