Skip to content

update_voice_connector async

update_voice_connector(
    voice_connector_id: VoiceConnectorId,
    name: VoiceConnectorName,
    require_encryption: Boolean,
    *,
    config_overrides: Optional[AsyncChimeSDKVoiceClientConfig] = None,
) -> UpdateVoiceConnectorResponse

Updates the details for the specified Amazon Chime SDK Voice Connector.

Parameters:

  • voice_connector_id (VoiceConnectorId) –

    The Voice Connector ID.

  • name (VoiceConnectorName) –

    The name of the Voice Connector.

  • require_encryption (Boolean) –

    When enabled, requires encryption for the Voice Connector.

Raises:

Source code in docs_src/capo_chime_sdk_voice/_services/async_chime_sdk_voice.py
async def update_voice_connector(
    self,
    voice_connector_id: "capo_chime_sdk_voice.types.voice_connector_id.VoiceConnectorId",
    name: "capo_chime_sdk_voice.types.voice_connector_name.VoiceConnectorName",
    require_encryption: "capo_chime_sdk_voice.types.boolean.Boolean",
    *,
    config_overrides: Optional[AsyncChimeSDKVoiceClientConfig] = None,
) -> "capo_chime_sdk_voice.types.update_voice_connector_response.UpdateVoiceConnectorResponse":
    """<p>Updates the details for the specified Amazon Chime SDK Voice Connector.</p>

    Args:
        voice_connector_id: <p>The Voice Connector ID.</p>
        name: <p>The name of the Voice Connector.</p>
        require_encryption: <p>When enabled, requires encryption for the Voice Connector.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime_sdk_voice.types.update_voice_connector_request.UpdateVoiceConnectorRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime_sdk_voice.types.update_voice_connector_response.UpdateVoiceConnectorResponse"
    ]:
        import capo_chime_sdk_voice._operations.chime_sdk_telephony_service.update_voice_connector

        (
            output,
            http_response,
        ) = await capo_chime_sdk_voice._operations.chime_sdk_telephony_service.update_voice_connector.async_update_voice_connector(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateVoiceConnector")
    )
    input_: capo_chime_sdk_voice.types.update_voice_connector_request.UpdateVoiceConnectorRequest = {
        "voice_connector_id": voice_connector_id,
        "name": name,
        "require_encryption": require_encryption,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output