Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Gets information about an FAQ list.
Synopsis
- data DescribeFaq = DescribeFaq' {}
- newDescribeFaq :: Text -> Text -> DescribeFaq
- describeFaq_id :: Lens' DescribeFaq Text
- describeFaq_indexId :: Lens' DescribeFaq Text
- data DescribeFaqResponse = DescribeFaqResponse' {}
- newDescribeFaqResponse :: Int -> DescribeFaqResponse
- describeFaqResponse_createdAt :: Lens' DescribeFaqResponse (Maybe UTCTime)
- describeFaqResponse_description :: Lens' DescribeFaqResponse (Maybe Text)
- describeFaqResponse_errorMessage :: Lens' DescribeFaqResponse (Maybe Text)
- describeFaqResponse_fileFormat :: Lens' DescribeFaqResponse (Maybe FaqFileFormat)
- describeFaqResponse_id :: Lens' DescribeFaqResponse (Maybe Text)
- describeFaqResponse_indexId :: Lens' DescribeFaqResponse (Maybe Text)
- describeFaqResponse_languageCode :: Lens' DescribeFaqResponse (Maybe Text)
- describeFaqResponse_name :: Lens' DescribeFaqResponse (Maybe Text)
- describeFaqResponse_roleArn :: Lens' DescribeFaqResponse (Maybe Text)
- describeFaqResponse_s3Path :: Lens' DescribeFaqResponse (Maybe S3Path)
- describeFaqResponse_status :: Lens' DescribeFaqResponse (Maybe FaqStatus)
- describeFaqResponse_updatedAt :: Lens' DescribeFaqResponse (Maybe UTCTime)
- describeFaqResponse_httpStatus :: Lens' DescribeFaqResponse Int
Creating a Request
data DescribeFaq Source #
See: newDescribeFaq
smart constructor.
Instances
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 Source #
The identifier of the FAQ you want to get information on.
describeFaq_indexId :: Lens' DescribeFaq Text Source #
The identifier of the index for the FAQ.
Destructuring the Response
data DescribeFaqResponse Source #
See: newDescribeFaqResponse
smart constructor.
DescribeFaqResponse' | |
|
Instances
newDescribeFaqResponse Source #
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) Source #
The date and time that the FAQ was created.
describeFaqResponse_description :: Lens' DescribeFaqResponse (Maybe Text) Source #
The description of the FAQ that you provided when it was created.
describeFaqResponse_errorMessage :: Lens' DescribeFaqResponse (Maybe Text) Source #
If the Status
field is FAILED
, the ErrorMessage
field contains the
reason why the FAQ failed.
describeFaqResponse_fileFormat :: Lens' DescribeFaqResponse (Maybe FaqFileFormat) Source #
The file format used by the input files for the FAQ.
describeFaqResponse_id :: Lens' DescribeFaqResponse (Maybe Text) Source #
The identifier of the FAQ.
describeFaqResponse_indexId :: Lens' DescribeFaqResponse (Maybe Text) Source #
The identifier of the index for the FAQ.
describeFaqResponse_languageCode :: Lens' DescribeFaqResponse (Maybe Text) Source #
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) Source #
The name that you gave the FAQ when it was created.
describeFaqResponse_roleArn :: Lens' DescribeFaqResponse (Maybe Text) Source #
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) Source #
Undocumented member.
describeFaqResponse_status :: Lens' DescribeFaqResponse (Maybe FaqStatus) Source #
The status of the FAQ. It is ready to use when the status is ACTIVE
.
describeFaqResponse_updatedAt :: Lens' DescribeFaqResponse (Maybe UTCTime) Source #
The date and time that the FAQ was last updated.
describeFaqResponse_httpStatus :: Lens' DescribeFaqResponse Int Source #
The response's http status code.