DescribeExperienceResponse ¶

class DescribeExperienceResponse(TypedDict, closed=True):
    id: NotRequired["capo_kendra.types.experience_id.ExperienceId"]
    """<p>Shows the identifier of your Amazon Kendra experience.</p>"""
    index_id: NotRequired["capo_kendra.types.index_id.IndexId"]
    """<p>Shows the identifier of the index for your Amazon Kendra experience.</p>"""
    name: NotRequired["capo_kendra.types.experience_name.ExperienceName"]
    """<p>Shows the name of your Amazon Kendra experience.</p>"""
    endpoints: NotRequired["capo_kendra.types.experience_endpoints.ExperienceEndpoints"]
    """<p>Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.</p>"""
    configuration: NotRequired[
        "capo_kendra.types.experience_configuration.ExperienceConfiguration"
    ]
    """<p>Shows the configuration information for your Amazon Kendra experience. This includes <code>ContentSourceConfiguration</code>, which specifies the data source IDs and/or FAQ IDs, and <code>UserIdentityConfiguration</code>, which specifies the user or group information to grant access to your Amazon Kendra experience.</p>"""
    created_at: NotRequired["capo_kendra.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when your Amazon Kendra experience was created.</p>"""
    updated_at: NotRequired["capo_kendra.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when your Amazon Kendra experience was last updated.</p>"""
    description: NotRequired["capo_kendra.types.description.Description"]
    """<p>Shows the description for your Amazon Kendra experience.</p>"""
    status: NotRequired["capo_kendra.types.experience_status.ExperienceStatus"]
    """<p>The current processing status of your Amazon Kendra experience. When the status is <code>ACTIVE</code>, your Amazon Kendra experience is ready to use. When the status is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason that this failed.</p>"""
    role_arn: NotRequired["capo_kendra.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the 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.</p>"""
    error_message: NotRequired["capo_kendra.types.error_message.ErrorMessage"]
    """<p>The reason your Amazon Kendra experience could not properly process.</p>"""