Skip to content

UpdateEvaluationFormRequest

Source code in docs_src/capo_connect/types/update_evaluation_form_request.py
class UpdateEvaluationFormRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<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>"""
    evaluation_form_id: "capo_connect.types.resource_id.ResourceId"
    """<p>The unique identifier for the evaluation form.</p>"""
    evaluation_form_version: "capo_connect.types.version_number.VersionNumber"
    """<p>A version of the evaluation form to update.</p>"""
    create_new_version: NotRequired["capo_connect.types.boxed_boolean.BoxedBoolean"]
    """<p>A flag indicating whether the operation must create a new version.</p>"""
    title: "capo_connect.types.evaluation_form_title.EvaluationFormTitle"
    """<p>A title of the evaluation form.</p>"""
    description: NotRequired[
        "capo_connect.types.evaluation_form_description.EvaluationFormDescription"
    ]
    """<p>The description of the evaluation form.</p>"""
    items: "capo_connect.types.evaluation_form_items_list.EvaluationFormItemsList"
    """<p>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.</p>"""
    scoring_strategy: NotRequired[
        "capo_connect.types.evaluation_form_scoring_strategy.EvaluationFormScoringStrategy"
    ]
    """<p>A scoring strategy of the evaluation form.</p>"""
    auto_evaluation_configuration: NotRequired[
        "capo_connect.types.evaluation_form_auto_evaluation_configuration.EvaluationFormAutoEvaluationConfiguration"
    ]
    """<p>Whether automated evaluations are enabled.</p>"""
    review_configuration: NotRequired[
        "capo_connect.types.evaluation_review_configuration.EvaluationReviewConfiguration"
    ]
    """<p>Configuration for evaluation review settings of the evaluation form.</p>"""
    as_draft: "capo_connect.types.boxed_boolean.BoxedBoolean"
    """<p>A boolean flag indicating whether to update evaluation form to draft state.</p>"""
    client_token: NotRequired["capo_connect.types.client_token.ClientToken"]
    """<p>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 <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>"""
    target_configuration: NotRequired[
        "capo_connect.types.evaluation_form_target_configuration.EvaluationFormTargetConfiguration"
    ]
    """<p>Configuration that specifies the target for the evaluation form.</p>"""
    language_configuration: NotRequired[
        "capo_connect.types.evaluation_form_language_configuration.EvaluationFormLanguageConfiguration"
    ]
    """<p>Configuration for language settings of the evaluation form.</p>"""
    ai_version: NotRequired[
        "capo_connect.types.evaluation_form_ai_version.EvaluationFormAIVersion"
    ]
    """<p>The AI version to use for the evaluation form. This specifies which AI model version is used for automated evaluations.</p>"""

ai_version instance-attribute

ai_version: NotRequired[EvaluationFormAIVersion]

The AI version to use for the evaluation form. This specifies which AI model version is used for automated evaluations.

as_draft instance-attribute

as_draft: BoxedBoolean

A boolean flag indicating whether to update evaluation form to draft state.

auto_evaluation_configuration instance-attribute

auto_evaluation_configuration: NotRequired[EvaluationFormAutoEvaluationConfiguration]

Whether automated evaluations are enabled.

client_token instance-attribute

client_token: NotRequired[ClientToken]

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.

create_new_version instance-attribute

create_new_version: NotRequired[BoxedBoolean]

A flag indicating whether the operation must create a new version.

description instance-attribute

description: NotRequired[EvaluationFormDescription]

The description of the evaluation form.

evaluation_form_id instance-attribute

evaluation_form_id: ResourceId

The unique identifier for the evaluation form.

evaluation_form_version instance-attribute

evaluation_form_version: VersionNumber

A version of the evaluation form to update.

instance_id instance-attribute

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.

items instance-attribute

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.

language_configuration instance-attribute

language_configuration: NotRequired[EvaluationFormLanguageConfiguration]

Configuration for language settings of the evaluation form.

review_configuration instance-attribute

review_configuration: NotRequired[EvaluationReviewConfiguration]

Configuration for evaluation review settings of the evaluation form.

scoring_strategy instance-attribute

scoring_strategy: NotRequired[EvaluationFormScoringStrategy]

A scoring strategy of the evaluation form.

target_configuration instance-attribute

target_configuration: NotRequired[EvaluationFormTargetConfiguration]

Configuration that specifies the target for the evaluation form.

title instance-attribute

A title of the evaluation form.