Skip to content

update_proxy_session

update_proxy_session(
    voice_connector_id: VoiceConnectorId,
    proxy_session_id: NonEmptyString128,
    capabilities: CapabilityList,
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
    expiry_minutes: Optional[PositiveInteger] = None,
) -> UpdateProxySessionResponse

Updates the specified proxy session details, such as voice or SMS capabilities.

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

Parameters:

Raises:

Source code in docs_src/capo_chime_sdk_voice/_services/chime_sdk_voice.py
def update_proxy_session(
    self,
    voice_connector_id: "capo_chime_sdk_voice.types.voice_connector_id.VoiceConnectorId",
    proxy_session_id: "capo_chime_sdk_voice.types.non_empty_string128.NonEmptyString128",
    capabilities: "capo_chime_sdk_voice.types.capability_list.CapabilityList",
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
    expiry_minutes: Optional[
        "capo_chime_sdk_voice.types.positive_integer.PositiveInteger"
    ] = None,
) -> "capo_chime_sdk_voice.types.update_proxy_session_response.UpdateProxySessionResponse":
    """<p>Updates the specified proxy session details, such as voice or SMS capabilities.</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>
        proxy_session_id: <p>The proxy session ID.</p>
        capabilities: <p>The proxy session capabilities.</p>
        expiry_minutes: <p>The number of minutes allowed for the proxy session.</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.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.update_proxy_session_request.UpdateProxySessionRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_voice.types.update_proxy_session_response.UpdateProxySessionResponse"
    ]:
        import capo_chime_sdk_voice._operations.chime_sdk_telephony_service.update_proxy_session

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

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

        return capo_chime_sdk_voice.types.update_proxy_session_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateProxySession", redact_output=_redact_output),
    )
    input_: capo_chime_sdk_voice.types.update_proxy_session_request.UpdateProxySessionRequest = {
        "voice_connector_id": voice_connector_id,
        "proxy_session_id": proxy_session_id,
        "capabilities": capabilities,
    }
    if expiry_minutes is not None:
        input_["expiry_minutes"] = expiry_minutes

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