update_evaluation_form
async
¶
update_evaluation_form(
instance_id: InstanceId,
evaluation_form_id: ResourceId,
evaluation_form_version: VersionNumber,
title: EvaluationFormTitle,
items: EvaluationFormItemsList,
*,
config_overrides: Optional[AsyncConnectClientConfig] = None,
create_new_version: Optional[BoxedBoolean] = None,
description: Optional[EvaluationFormDescription] = None,
scoring_strategy: Optional[EvaluationFormScoringStrategy] = None,
auto_evaluation_configuration: Optional[
EvaluationFormAutoEvaluationConfiguration
] = None,
review_configuration: Optional[EvaluationReviewConfiguration] = None,
as_draft: Optional[BoxedBoolean] = None,
client_token: Optional[ClientToken] = None,
target_configuration: Optional[EvaluationFormTargetConfiguration] = None,
language_configuration: Optional[EvaluationFormLanguageConfiguration] = None,
ai_version: Optional[EvaluationFormAIVersion] = None,
) -> UpdateEvaluationFormResponse
Updates details about a specific evaluation form version in the specified Connect Customer instance. Question and section identifiers cannot be duplicated within the same evaluation form.
This operation does not support partial updates. Instead it does a full update of evaluation form content.
Parameters:
-
instance_id(InstanceId) –The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
-
evaluation_form_id(ResourceId) –The unique identifier for the evaluation form.
-
evaluation_form_version(VersionNumber) –A version of the evaluation form to update.
-
create_new_version(Optional[BoxedBoolean], default:None) –A flag indicating whether the operation must create a new version.
-
title(EvaluationFormTitle) –A title of the evaluation form.
-
description(Optional[EvaluationFormDescription], default:None) –The description of the evaluation form.
-
items(EvaluationFormItemsList) –Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
-
scoring_strategy(Optional[EvaluationFormScoringStrategy], default:None) –A scoring strategy of the evaluation form.
-
auto_evaluation_configuration(Optional[EvaluationFormAutoEvaluationConfiguration], default:None) –Whether automated evaluations are enabled.
-
review_configuration(Optional[EvaluationReviewConfiguration], default:None) –Configuration for evaluation review settings of the evaluation form.
-
as_draft(Optional[BoxedBoolean], default:None) –A boolean flag indicating whether to update evaluation form to draft state.
-
client_token(Optional[ClientToken], default:None) –A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
-
target_configuration(Optional[EvaluationFormTargetConfiguration], default:None) –Configuration that specifies the target for the evaluation form.
-
language_configuration(Optional[EvaluationFormLanguageConfiguration], default:None) –Configuration for language settings of the evaluation form.
-
ai_version(Optional[EvaluationFormAIVersion], default:None) –The AI version to use for the evaluation form. This specifies which AI model version is used for automated evaluations.
Raises:
-
InternalServiceException–Request processing failed because of an error or failure with the service.
-
InvalidParameterException–One or more of the specified parameters are not valid.
-
ResourceConflictException–A resource already has that name.
-
ResourceNotFoundException–The specified resource was not found.
-
ServiceQuotaExceededException–The service quota has been exceeded.
-
ThrottlingException–The throttling limit has been exceeded.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_connect/_services/async_connect.py
26787 26788 26789 26790 26791 26792 26793 26794 26795 26796 26797 26798 26799 26800 26801 26802 26803 26804 26805 26806 26807 26808 26809 26810 26811 26812 26813 26814 26815 26816 26817 26818 26819 26820 26821 26822 26823 26824 26825 26826 26827 26828 26829 26830 26831 26832 26833 26834 26835 26836 26837 26838 26839 26840 26841 26842 26843 26844 26845 26846 26847 26848 26849 26850 26851 26852 26853 26854 26855 26856 26857 26858 26859 26860 26861 26862 26863 26864 26865 26866 26867 26868 26869 26870 26871 26872 26873 26874 26875 26876 26877 26878 26879 26880 26881 26882 26883 26884 26885 26886 26887 26888 26889 26890 26891 26892 26893 26894 26895 26896 26897 26898 26899 26900 26901 26902 26903 26904 26905 | |