DescribeFaqResponse ¶

class DescribeFaqResponse(TypedDict, closed=True):
    id: NotRequired["capo_kendra.types.faq_id.FaqId"]
    """<p>The identifier of the FAQ.</p>"""
    index_id: NotRequired["capo_kendra.types.index_id.IndexId"]
    """<p>The identifier of the index for the FAQ.</p>"""
    name: NotRequired["capo_kendra.types.faq_name.FaqName"]
    """<p>The name that you gave the FAQ when it was created.</p>"""
    description: NotRequired["capo_kendra.types.description.Description"]
    """<p>The description of the FAQ that you provided when it was created.</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>"""
    s3_path: NotRequired["capo_kendra.types.s3_path.S3Path"]
    status: NotRequired["capo_kendra.types.faq_status.FaqStatus"]
    """<p>The status of the FAQ. It is ready to use when the status is <code>ACTIVE</code>.</p>"""
    role_arn: NotRequired["capo_kendra.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role that provides access to the S3 bucket containing the FAQ file.</p>"""
    error_message: NotRequired["capo_kendra.types.error_message.ErrorMessage"]
    """<p>If the <code>Status</code> field is <code>FAILED</code>, the <code>ErrorMessage</code> field contains the reason why the FAQ failed.</p>"""
    file_format: NotRequired["capo_kendra.types.faq_file_format.FaqFileFormat"]
    """<p>The file format used for the FAQ file.</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. 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>"""