Skip to content

get_voice_connector_streaming_configuration

get_voice_connector_streaming_configuration(
    voice_connector_id: VoiceConnectorId,
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
) -> GetVoiceConnectorStreamingConfigurationResponse

Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

Parameters:

Raises:

Source code in docs_src/capo_chime_sdk_voice/_services/chime_sdk_voice.py
def get_voice_connector_streaming_configuration(
    self,
    voice_connector_id: "capo_chime_sdk_voice.types.voice_connector_id.VoiceConnectorId",
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
) -> "capo_chime_sdk_voice.types.get_voice_connector_streaming_configuration_response.GetVoiceConnectorStreamingConfigurationResponse":
    """<p>Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.</p>

    Args:
        voice_connector_id: <p>The Voice Connector ID.</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.get_voice_connector_streaming_configuration_request.GetVoiceConnectorStreamingConfigurationRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_voice.types.get_voice_connector_streaming_configuration_response.GetVoiceConnectorStreamingConfigurationResponse"
    ]:
        import capo_chime_sdk_voice._operations.chime_sdk_telephony_service.get_voice_connector_streaming_configuration

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

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

        return capo_chime_sdk_voice.types.get_voice_connector_streaming_configuration_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "GetVoiceConnectorStreamingConfiguration", redact_output=_redact_output
        ),
    )
    input_: capo_chime_sdk_voice.types.get_voice_connector_streaming_configuration_request.GetVoiceConnectorStreamingConfigurationRequest = {
        "voice_connector_id": voice_connector_id
    }

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