Skip to content

associate_phone_numbers_with_voice_connector_group

associate_phone_numbers_with_voice_connector_group(
    voice_connector_group_id: NonEmptyString,
    e164_phone_numbers: E164PhoneNumberList,
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
    force_associate: Optional[NullableBoolean] = None,
) -> AssociatePhoneNumbersWithVoiceConnectorGroupResponse

Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.

Parameters:

  • voice_connector_group_id (NonEmptyString) –

    The Amazon Chime SDK Voice Connector group ID.

  • e164_phone_numbers (E164PhoneNumberList) –

    List of phone numbers, in E.164 format.

  • force_associate (Optional[NullableBoolean], default: None ) –

    If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

Raises:

Source code in docs_src/capo_chime_sdk_voice/_services/chime_sdk_voice.py
def associate_phone_numbers_with_voice_connector_group(
    self,
    voice_connector_group_id: "capo_chime_sdk_voice.types.non_empty_string.NonEmptyString",
    e164_phone_numbers: "capo_chime_sdk_voice.types.e164_phone_number_list.E164PhoneNumberList",
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
    force_associate: Optional[
        "capo_chime_sdk_voice.types.nullable_boolean.NullableBoolean"
    ] = None,
) -> "capo_chime_sdk_voice.types.associate_phone_numbers_with_voice_connector_group_response.AssociatePhoneNumbersWithVoiceConnectorGroupResponse":
    """<p>Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.</p>

    Args:
        voice_connector_group_id: <p>The Amazon Chime SDK Voice Connector group ID.</p>
        e164_phone_numbers: <p>List of phone numbers, in E.164 format.</p>
        force_associate: <p>If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.</p>

    Raises:
        capo_chime_sdk_voice.errors.access_denied_exception.AccessDeniedException: <p>You don't have the permissions needed to run this action.</p>
        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.associate_phone_numbers_with_voice_connector_group_request.AssociatePhoneNumbersWithVoiceConnectorGroupRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_voice.types.associate_phone_numbers_with_voice_connector_group_response.AssociatePhoneNumbersWithVoiceConnectorGroupResponse"
    ]:
        import capo_chime_sdk_voice._operations.chime_sdk_telephony_service.associate_phone_numbers_with_voice_connector_group

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

    def _redact_input(
        input_: "capo_chime_sdk_voice.types.associate_phone_numbers_with_voice_connector_group_request.AssociatePhoneNumbersWithVoiceConnectorGroupRequest",
    ) -> dict[str, Any]:
        import capo_chime_sdk_voice.types.associate_phone_numbers_with_voice_connector_group_request

        return capo_chime_sdk_voice.types.associate_phone_numbers_with_voice_connector_group_request.redact_sensitive(
            input_
        )

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

        return capo_chime_sdk_voice.types.associate_phone_numbers_with_voice_connector_group_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "AssociatePhoneNumbersWithVoiceConnectorGroup",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_chime_sdk_voice.types.associate_phone_numbers_with_voice_connector_group_request.AssociatePhoneNumbersWithVoiceConnectorGroupRequest = {
        "voice_connector_group_id": voice_connector_group_id,
        "e164_phone_numbers": e164_phone_numbers,
    }
    if force_associate is not None:
        input_["force_associate"] = force_associate

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