Amazonka.Kendra.DescribeFaq

Gets information about an FAQ list.

Creating a Request

data DescribeFaq

See: newDescribeFaq smart constructor.

Constructors

DescribeFaq'

Fields

• id :: Text

  The identifier of the FAQ you want to get information on.

• indexId :: Text

  The identifier of the index for the FAQ.

Instances

ToJSON DescribeFaq

Defined in Amazonka.Kendra.DescribeFaq

Methods

toJSON :: DescribeFaq -> Value

toEncoding :: DescribeFaq -> Encoding

toJSONList :: [DescribeFaq] -> Value

toEncodingList :: [DescribeFaq] -> Encoding

ToHeaders DescribeFaq

Defined in Amazonka.Kendra.DescribeFaq

Methods

toHeaders :: DescribeFaq -> [Header]

ToPath DescribeFaq

Defined in Amazonka.Kendra.DescribeFaq

Methods

toPath :: DescribeFaq -> ByteString

ToQuery DescribeFaq

Defined in Amazonka.Kendra.DescribeFaq

Methods

toQuery :: DescribeFaq -> QueryString

AWSRequest DescribeFaq

Defined in Amazonka.Kendra.DescribeFaq

Associated Types

type AWSResponse DescribeFaq

Methods

request :: (Service -> Service) -> DescribeFaq -> Request DescribeFaq

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeFaq -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFaq)))

Generic DescribeFaq

Defined in Amazonka.Kendra.DescribeFaq

Associated Types

type Rep DescribeFaq :: Type -> Type

Methods

from :: DescribeFaq -> Rep DescribeFaq x

to :: Rep DescribeFaq x -> DescribeFaq

Read DescribeFaq

Defined in Amazonka.Kendra.DescribeFaq

Methods

readsPrec :: Int -> ReadS DescribeFaq

readList :: ReadS [DescribeFaq]

readPrec :: ReadPrec DescribeFaq

readListPrec :: ReadPrec [DescribeFaq]

Show DescribeFaq

Defined in Amazonka.Kendra.DescribeFaq

Methods

showsPrec :: Int -> DescribeFaq -> ShowS

show :: DescribeFaq -> String

showList :: [DescribeFaq] -> ShowS

NFData DescribeFaq

Defined in Amazonka.Kendra.DescribeFaq

Methods

rnf :: DescribeFaq -> ()

Eq DescribeFaq

Defined in Amazonka.Kendra.DescribeFaq

Methods

(==) :: DescribeFaq -> DescribeFaq -> Bool

(/=) :: DescribeFaq -> DescribeFaq -> Bool

Hashable DescribeFaq

Defined in Amazonka.Kendra.DescribeFaq

Methods

hashWithSalt :: Int -> DescribeFaq -> Int

hash :: DescribeFaq -> Int

type AWSResponse DescribeFaq

Defined in Amazonka.Kendra.DescribeFaq

type AWSResponse DescribeFaq = DescribeFaqResponse

type Rep DescribeFaq

Defined in Amazonka.Kendra.DescribeFaq

type Rep DescribeFaq = D1 ('MetaData "DescribeFaq" "Amazonka.Kendra.DescribeFaq" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeFaq'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeFaq

Arguments

:: Text

DescribeFaq

-> Text

DescribeFaq

-> DescribeFaq

Create a value of DescribeFaq with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeFaq, describeFaq_id - The identifier of the FAQ you want to get information on.

DescribeFaq, describeFaq_indexId - The identifier of the index for the FAQ.

Request Lenses

describeFaq_id :: Lens' DescribeFaq Text

The identifier of the FAQ you want to get information on.

describeFaq_indexId :: Lens' DescribeFaq Text

The identifier of the index for the FAQ.

Destructuring the Response

data DescribeFaqResponse

See: newDescribeFaqResponse smart constructor.

Constructors

DescribeFaqResponse'

Fields

• createdAt :: Maybe POSIX

  The date and time that the FAQ was created.

• description :: Maybe Text

  The description of the FAQ that you provided when it was created.

• errorMessage :: Maybe Text

  If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

• fileFormat :: Maybe FaqFileFormat

  The file format used by the input files for the FAQ.

• id :: Maybe Text

  The identifier of the FAQ.

• indexId :: Maybe Text

  The identifier of the index for the FAQ.

• languageCode :: Maybe Text

  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 Adding documents in languages other than English.

• name :: Maybe Text

  The name that you gave the FAQ when it was created.

• roleArn :: Maybe Text

  The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

• s3Path :: Maybe S3Path
• status :: Maybe FaqStatus

  The status of the FAQ. It is ready to use when the status is ACTIVE.

• updatedAt :: Maybe POSIX

  The date and time that the FAQ was last updated.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeFaqResponse

Defined in Amazonka.Kendra.DescribeFaq

Associated Types

type Rep DescribeFaqResponse :: Type -> Type

Methods

from :: DescribeFaqResponse -> Rep DescribeFaqResponse x

to :: Rep DescribeFaqResponse x -> DescribeFaqResponse

Read DescribeFaqResponse

Defined in Amazonka.Kendra.DescribeFaq

Methods

readsPrec :: Int -> ReadS DescribeFaqResponse

readList :: ReadS [DescribeFaqResponse]

readPrec :: ReadPrec DescribeFaqResponse

readListPrec :: ReadPrec [DescribeFaqResponse]

Show DescribeFaqResponse

Defined in Amazonka.Kendra.DescribeFaq

Methods

showsPrec :: Int -> DescribeFaqResponse -> ShowS

show :: DescribeFaqResponse -> String

showList :: [DescribeFaqResponse] -> ShowS

NFData DescribeFaqResponse

Defined in Amazonka.Kendra.DescribeFaq

Methods

rnf :: DescribeFaqResponse -> ()

Eq DescribeFaqResponse

Defined in Amazonka.Kendra.DescribeFaq

Methods

(==) :: DescribeFaqResponse -> DescribeFaqResponse -> Bool

(/=) :: DescribeFaqResponse -> DescribeFaqResponse -> Bool

type Rep DescribeFaqResponse

Defined in Amazonka.Kendra.DescribeFaq

type Rep DescribeFaqResponse = D1 ('MetaData "DescribeFaqResponse" "Amazonka.Kendra.DescribeFaq" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeFaqResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "fileFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FaqFileFormat)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "s3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Path)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FaqStatus))) :*: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeFaqResponse

Arguments

:: Int

$sel:httpStatus:DescribeFaqResponse'

-> DescribeFaqResponse

Create a value of DescribeFaqResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeFaqResponse, describeFaqResponse_createdAt - The date and time that the FAQ was created.

$sel:description:DescribeFaqResponse', describeFaqResponse_description - The description of the FAQ that you provided when it was created.

DescribeFaqResponse, describeFaqResponse_errorMessage - If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

DescribeFaqResponse, describeFaqResponse_fileFormat - The file format used by the input files for the FAQ.

DescribeFaq, describeFaqResponse_id - The identifier of the FAQ.

DescribeFaq, describeFaqResponse_indexId - The identifier of the index for the FAQ.

DescribeFaqResponse, describeFaqResponse_languageCode - 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 Adding documents in languages other than English.

DescribeFaqResponse, describeFaqResponse_name - The name that you gave the FAQ when it was created.

DescribeFaqResponse, describeFaqResponse_roleArn - The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

DescribeFaqResponse, describeFaqResponse_s3Path - Undocumented member.

DescribeFaqResponse, describeFaqResponse_status - The status of the FAQ. It is ready to use when the status is ACTIVE.

DescribeFaqResponse, describeFaqResponse_updatedAt - The date and time that the FAQ was last updated.

$sel:httpStatus:DescribeFaqResponse', describeFaqResponse_httpStatus - The response's http status code.

Response Lenses

describeFaqResponse_createdAt :: Lens' DescribeFaqResponse (Maybe UTCTime)

The date and time that the FAQ was created.

describeFaqResponse_description :: Lens' DescribeFaqResponse (Maybe Text)

The description of the FAQ that you provided when it was created.

describeFaqResponse_errorMessage :: Lens' DescribeFaqResponse (Maybe Text)

If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

describeFaqResponse_fileFormat :: Lens' DescribeFaqResponse (Maybe FaqFileFormat)

The file format used by the input files for the FAQ.

describeFaqResponse_id :: Lens' DescribeFaqResponse (Maybe Text)

The identifier of the FAQ.

describeFaqResponse_indexId :: Lens' DescribeFaqResponse (Maybe Text)

The identifier of the index for the FAQ.

describeFaqResponse_languageCode :: Lens' DescribeFaqResponse (Maybe Text)

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 Adding documents in languages other than English.

describeFaqResponse_name :: Lens' DescribeFaqResponse (Maybe Text)

The name that you gave the FAQ when it was created.

describeFaqResponse_roleArn :: Lens' DescribeFaqResponse (Maybe Text)

The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

describeFaqResponse_s3Path :: Lens' DescribeFaqResponse (Maybe S3Path)

Undocumented member.

describeFaqResponse_status :: Lens' DescribeFaqResponse (Maybe FaqStatus)

The status of the FAQ. It is ready to use when the status is ACTIVE.

describeFaqResponse_updatedAt :: Lens' DescribeFaqResponse (Maybe UTCTime)

The date and time that the FAQ was last updated.

describeFaqResponse_httpStatus :: Lens' DescribeFaqResponse Int

The response's http status code.