Skip to content

UpdateExperienceRequest

Source code in docs_src/capo_kendra/types/update_experience_request.py
class UpdateExperienceRequest(TypedDict, closed=True):
    id: "capo_kendra.types.experience_id.ExperienceId"
    """<p>The identifier of your Amazon Kendra experience you want to update.</p>"""
    name: NotRequired["capo_kendra.types.experience_name.ExperienceName"]
    """<p>A new name for your Amazon Kendra experience.</p>"""
    index_id: "capo_kendra.types.index_id.IndexId"
    """<p>The identifier of the index for your Amazon Kendra experience.</p>"""
    role_arn: NotRequired["capo_kendra.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of an IAM role with permission to access the <code>Query</code> API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code> API, and IAM Identity Center that stores your users and groups information. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>"""
    configuration: NotRequired[
        "capo_kendra.types.experience_configuration.ExperienceConfiguration"
    ]
    """<p>Configuration information you want to update for your Amazon Kendra experience.</p>"""
    description: NotRequired["capo_kendra.types.description.Description"]
    """<p>A new description for your Amazon Kendra experience.</p>"""

configuration instance-attribute

configuration: NotRequired[ExperienceConfiguration]

Configuration information you want to update for your Amazon Kendra experience.

description instance-attribute

description: NotRequired[Description]

A new description for your Amazon Kendra experience.

id instance-attribute

The identifier of your Amazon Kendra experience you want to update.

index_id instance-attribute

index_id: IndexId

The identifier of the index for your Amazon Kendra experience.

name instance-attribute

name: NotRequired[ExperienceName]

A new name for your Amazon Kendra experience.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of an IAM role with permission to access the Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your users and groups information. For more information, see IAM roles for Amazon Kendra.