update_user_phone_config ¶

def update_user_phone_config(
    self,
    phone_config: "capo_connect.types.user_phone_config.UserPhoneConfig",
    user_id: "capo_connect.types.user_id.UserId",
    instance_id: "capo_connect.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
) -> None:
    """<p>Updates the phone configuration settings for the specified user.</p> <note> <p>We recommend using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateUserConfig.html">UpdateUserConfig</a> API, which supports additional functionality that is not available in the UpdateUserPhoneConfig API, such as voice enhancement settings and per-channel configuration for auto-accept and After Contact Work (ACW) timeouts. In comparison, the UpdateUserPhoneConfig API will always set the same ACW timeouts to all channels the user handles.</p> </note>

    Args:
        phone_config: <p>Information about phone configuration settings for the user.</p>
        user_id: <p>The identifier of the user account.</p>
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>

    Raises:
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.update_user_phone_config_request.UpdateUserPhoneConfigRequest]",
    ) -> OperationResponse[None]:
        import capo_connect._operations.amazon_connect_service.update_user_phone_config

        output, http_response = (
            capo_connect._operations.amazon_connect_service.update_user_phone_config.update_user_phone_config(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_connect.types.update_user_phone_config_request.UpdateUserPhoneConfigRequest",
    ) -> dict[str, Any]:
        import capo_connect.types.update_user_phone_config_request

        return capo_connect.types.update_user_phone_config_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateUserPhoneConfig", redact_input=_redact_input),
    )
    input_: capo_connect.types.update_user_phone_config_request.UpdateUserPhoneConfigRequest = {
        "phone_config": phone_config,
        "user_id": user_id,
        "instance_id": instance_id,
    }

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