Skip to content

FaqSummary

Source code in docs_src/capo_kendra/types/faq_summary.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class FaqSummary(TypedDict, closed=True):
    id: NotRequired["capo_kendra.types.faq_id.FaqId"]
    """<p>The identifier of the FAQ.</p>"""
    name: NotRequired["capo_kendra.types.faq_name.FaqName"]
    """<p>The name that you assigned the FAQ when you created or updated the FAQ.</p>"""
    status: NotRequired["capo_kendra.types.faq_status.FaqStatus"]
    """<p>The current status of the FAQ. When the status is <code>ACTIVE</code> the FAQ is ready for use.</p>"""
    created_at: NotRequired["capo_kendra.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the FAQ was created.</p>"""
    updated_at: NotRequired["capo_kendra.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the FAQ was last updated.</p>"""
    file_format: NotRequired["capo_kendra.types.faq_file_format.FaqFileFormat"]
    """<p>The file type used to create the FAQ. </p>"""
    language_code: NotRequired["capo_kendra.types.language_code.LanguageCode"]
    """<p>The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding documents in languages other than English</a>.</p>"""

created_at instance-attribute 

created_at: NotRequired[Timestamp]

The Unix timestamp when the FAQ was created.

file_format instance-attribute 

file_format: NotRequired[FaqFileFormat]

The file type used to create the FAQ.

id instance-attribute 

id: NotRequired[FaqId]

The identifier of the FAQ.

language_code instance-attribute 

language_code: NotRequired[LanguageCode]

The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

name instance-attribute 

name: NotRequired[FaqName]

The name that you assigned the FAQ when you created or updated the FAQ.

status instance-attribute 

status: NotRequired[FaqStatus]

The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.

updated_at instance-attribute 

updated_at: NotRequired[Timestamp]

The Unix timestamp when the FAQ was last updated.