list_proxy_sessions ¶

def list_proxy_sessions(
    self,
    voice_connector_id: "capo_chime_sdk_voice.types.voice_connector_id.VoiceConnectorId",
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
    status: Optional[
        "capo_chime_sdk_voice.types.proxy_session_status.ProxySessionStatus"
    ] = None,
    next_token: Optional[
        "capo_chime_sdk_voice.types.next_token_string.NextTokenString"
    ] = None,
    max_results: Optional["capo_chime_sdk_voice.types.result_max.ResultMax"] = None,
) -> "capo_chime_sdk_voice.types.list_proxy_sessions_response.ListProxySessionsResponse":
    """<p>Lists the proxy sessions for 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>
        status: <p>The proxy session status.</p>
        next_token: <p>The token used to retrieve the next page of results.</p>
        max_results: <p>The maximum number of results to return in a single call.</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.list_proxy_sessions_request.ListProxySessionsRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_voice.types.list_proxy_sessions_response.ListProxySessionsResponse"
    ]:
        import capo_chime_sdk_voice._operations.chime_sdk_telephony_service.list_proxy_sessions

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

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

        return capo_chime_sdk_voice.types.list_proxy_sessions_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListProxySessions", redact_output=_redact_output),
    )
    input_: capo_chime_sdk_voice.types.list_proxy_sessions_request.ListProxySessionsRequest = {
        "voice_connector_id": voice_connector_id
    }
    if status is not None:
        input_["status"] = status
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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