Skip to content

update_voice_connector_group

update_voice_connector_group(
    voice_connector_group_id: NonEmptyString,
    name: VoiceConnectorGroupName,
    voice_connector_items: VoiceConnectorItemList,
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
    call_distribution_type: Optional[CallDistributionType] = None,
) -> UpdateVoiceConnectorGroupResponse

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

Parameters:

Raises:

Source code in docs_src/capo_chime_sdk_voice/_services/chime_sdk_voice.py
def update_voice_connector_group(
    self,
    voice_connector_group_id: "capo_chime_sdk_voice.types.non_empty_string.NonEmptyString",
    name: "capo_chime_sdk_voice.types.voice_connector_group_name.VoiceConnectorGroupName",
    voice_connector_items: "capo_chime_sdk_voice.types.voice_connector_item_list.VoiceConnectorItemList",
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
    call_distribution_type: Optional[
        "capo_chime_sdk_voice.types.call_distribution_type.CallDistributionType"
    ] = None,
) -> "capo_chime_sdk_voice.types.update_voice_connector_group_response.UpdateVoiceConnectorGroupResponse":
    """<p>Updates the settings for the specified Amazon Chime SDK Voice Connector group.</p>

    Args:
        voice_connector_group_id: <p>The Voice Connector ID.</p>
        name: <p>The name of the Voice Connector group.</p>
        voice_connector_items: <p>The <code>VoiceConnectorItems</code> to associate with the Voice Connector group.</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.conflict_exception.ConflictException: <p>Multiple instances of the same request were made simultaneously.</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_voice_connector_group_request.UpdateVoiceConnectorGroupRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_voice.types.update_voice_connector_group_response.UpdateVoiceConnectorGroupResponse"
    ]:
        import capo_chime_sdk_voice._operations.chime_sdk_telephony_service.update_voice_connector_group

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateVoiceConnectorGroup")
    )
    input_: capo_chime_sdk_voice.types.update_voice_connector_group_request.UpdateVoiceConnectorGroupRequest = {
        "voice_connector_group_id": voice_connector_group_id,
        "name": name,
        "voice_connector_items": voice_connector_items,
    }
    if call_distribution_type is not None:
        input_["call_distribution_type"] = call_distribution_type

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