Class GetFaqResult


  • public final class GetFaqResult
    extends java.lang.Object
    • Method Detail

      • arn

        public java.lang.String arn()
        Returns:
        ARN of the FAQ.
      • createdAt

        public java.lang.String createdAt()
        Returns:
        Unix datetime that the faq was created.
      • description

        public java.lang.String description()
        Returns:
        Description of the FAQ.
      • errorMessage

        public java.lang.String errorMessage()
        Returns:
        When the `status` field value is `FAILED`, this contains a message that explains why.
      • faqId

        public java.lang.String faqId()
      • fileFormat

        public java.lang.String fileFormat()
        Returns:
        File format used by the input files for the FAQ. Valid Values are `CSV`, `CSV_WITH_HEADER`, `JSON`.
      • id

        public java.lang.String id()
        Returns:
        The provider-assigned unique ID for this managed resource.
      • indexId

        public java.lang.String indexId()
      • languageCode

        public java.lang.String languageCode()
        Returns:
        Code for a language. This shows a supported language for the FAQ document. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
      • name

        public java.lang.String name()
        Returns:
        Name of the FAQ.
      • roleArn

        public java.lang.String roleArn()
        Returns:
        ARN of a role with permission to access the S3 bucket that contains the FAQs. For more information, see [IAM Roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
      • s3Paths

        public java.util.List<GetFaqS3Path> s3Paths()
        Returns:
        S3 location of the FAQ input data. Detailed below.
      • status

        public java.lang.String status()
        Returns:
        Status of the FAQ. It is ready to use when the status is ACTIVE.
      • tags

        public java.util.Map<java.lang.String,​java.lang.String> tags()
        Returns:
        Metadata that helps organize the FAQs you create.
      • updatedAt

        public java.lang.String updatedAt()
        Returns:
        Date and time that the FAQ was last updated.