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

Amazonka.Kendra.DescribeThesaurus

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about an existing Amazon Kendra thesaurus.

Synopsis

data DescribeThesaurus = DescribeThesaurus' {
- id :: Text
- indexId :: Text
}
newDescribeThesaurus :: Text -> Text -> DescribeThesaurus
describeThesaurus_id :: Lens' DescribeThesaurus Text
describeThesaurus_indexId :: Lens' DescribeThesaurus Text
data DescribeThesaurusResponse = DescribeThesaurusResponse' {
- createdAt :: Maybe POSIX
- description :: Maybe Text
- errorMessage :: Maybe Text
- fileSizeBytes :: Maybe Integer
- id :: Maybe Text
- indexId :: Maybe Text
- name :: Maybe Text
- roleArn :: Maybe Text
- sourceS3Path :: Maybe S3Path
- status :: Maybe ThesaurusStatus
- synonymRuleCount :: Maybe Integer
- termCount :: Maybe Integer
- updatedAt :: Maybe POSIX
- httpStatus :: Int
}
newDescribeThesaurusResponse :: Int -> DescribeThesaurusResponse
describeThesaurusResponse_createdAt :: Lens' DescribeThesaurusResponse (Maybe UTCTime)
describeThesaurusResponse_description :: Lens' DescribeThesaurusResponse (Maybe Text)
describeThesaurusResponse_errorMessage :: Lens' DescribeThesaurusResponse (Maybe Text)
describeThesaurusResponse_fileSizeBytes :: Lens' DescribeThesaurusResponse (Maybe Integer)
describeThesaurusResponse_id :: Lens' DescribeThesaurusResponse (Maybe Text)
describeThesaurusResponse_indexId :: Lens' DescribeThesaurusResponse (Maybe Text)
describeThesaurusResponse_name :: Lens' DescribeThesaurusResponse (Maybe Text)
describeThesaurusResponse_roleArn :: Lens' DescribeThesaurusResponse (Maybe Text)
describeThesaurusResponse_sourceS3Path :: Lens' DescribeThesaurusResponse (Maybe S3Path)
describeThesaurusResponse_status :: Lens' DescribeThesaurusResponse (Maybe ThesaurusStatus)
describeThesaurusResponse_synonymRuleCount :: Lens' DescribeThesaurusResponse (Maybe Integer)
describeThesaurusResponse_termCount :: Lens' DescribeThesaurusResponse (Maybe Integer)
describeThesaurusResponse_updatedAt :: Lens' DescribeThesaurusResponse (Maybe UTCTime)
describeThesaurusResponse_httpStatus :: Lens' DescribeThesaurusResponse Int

Creating a Request

data DescribeThesaurus Source #

See: newDescribeThesaurus smart constructor.

Constructors

DescribeThesaurus'
Fields id :: Text The identifier of the thesaurus you want to get information on. indexId :: Text The identifier of the index for the thesaurus.

Instances

Instances details

ToJSON DescribeThesaurus Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Methods toJSON :: DescribeThesaurus -> Value # toEncoding :: DescribeThesaurus -> Encoding # toJSONList :: [DescribeThesaurus] -> Value # toEncodingList :: [DescribeThesaurus] -> Encoding #
ToHeaders DescribeThesaurus Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Methods toHeaders :: DescribeThesaurus -> [Header] #
ToPath DescribeThesaurus Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Methods toPath :: DescribeThesaurus -> ByteString #
ToQuery DescribeThesaurus Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Methods toQuery :: DescribeThesaurus -> QueryString #
AWSRequest DescribeThesaurus Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Associated Types type AWSResponse DescribeThesaurus # Methods request :: (Service -> Service) -> DescribeThesaurus -> Request DescribeThesaurus # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeThesaurus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeThesaurus))) #
Generic DescribeThesaurus Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Associated Types type Rep DescribeThesaurus :: Type -> Type # Methods from :: DescribeThesaurus -> Rep DescribeThesaurus x # to :: Rep DescribeThesaurus x -> DescribeThesaurus #
Read DescribeThesaurus Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Methods readsPrec :: Int -> ReadS DescribeThesaurus # readList :: ReadS [DescribeThesaurus] # readPrec :: ReadPrec DescribeThesaurus # readListPrec :: ReadPrec [DescribeThesaurus] #
Show DescribeThesaurus Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Methods showsPrec :: Int -> DescribeThesaurus -> ShowS # show :: DescribeThesaurus -> String # showList :: [DescribeThesaurus] -> ShowS #
NFData DescribeThesaurus Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Methods rnf :: DescribeThesaurus -> () #
Eq DescribeThesaurus Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Methods (==) :: DescribeThesaurus -> DescribeThesaurus -> Bool # (/=) :: DescribeThesaurus -> DescribeThesaurus -> Bool #
Hashable DescribeThesaurus Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Methods hashWithSalt :: Int -> DescribeThesaurus -> Int # hash :: DescribeThesaurus -> Int #
type AWSResponse DescribeThesaurus Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus type AWSResponse DescribeThesaurus = DescribeThesaurusResponse
type Rep DescribeThesaurus Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus type Rep DescribeThesaurus = D1 ('MetaData "DescribeThesaurus" "Amazonka.Kendra.DescribeThesaurus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeThesaurus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeThesaurus Source #

Arguments

:: Text	`DescribeThesaurus`
-> Text	`DescribeThesaurus`
-> DescribeThesaurus

Create a value of DescribeThesaurus 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:

DescribeThesaurus, describeThesaurus_id - The identifier of the thesaurus you want to get information on.

DescribeThesaurus, describeThesaurus_indexId - The identifier of the index for the thesaurus.

Request Lenses

describeThesaurus_id :: Lens' DescribeThesaurus Text Source #

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

describeThesaurus_indexId :: Lens' DescribeThesaurus Text Source #

The identifier of the index for the thesaurus.

Destructuring the Response

data DescribeThesaurusResponse Source #

See: newDescribeThesaurusResponse smart constructor.

Constructors

DescribeThesaurusResponse'

Fields

createdAt :: Maybe POSIX
The Unix datetime that the thesaurus was created.
description :: Maybe Text
The thesaurus description.
errorMessage :: Maybe Text
When the Status field value is FAILED, the ErrorMessage field provides more information.
fileSizeBytes :: Maybe Integer
The size of the thesaurus file in bytes.
id :: Maybe Text
The identifier of the thesaurus.
indexId :: Maybe Text
The identifier of the index for the thesaurus.
name :: Maybe Text
The thesaurus name.
roleArn :: Maybe Text
An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
sourceS3Path :: Maybe S3Path
status :: Maybe ThesaurusStatus
The current status of the thesaurus. When the value is ACTIVE, queries are able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage field provides more information.
If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active.
synonymRuleCount :: Maybe Integer
The number of synonym rules in the thesaurus file.
termCount :: Maybe Integer
The number of unique terms in the thesaurus file. For example, the synonyms a,b,c and a=>d, the term count would be 4.
updatedAt :: Maybe POSIX
The Unix datetime that the thesaurus was last updated.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeThesaurusResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Associated Types type Rep DescribeThesaurusResponse :: Type -> Type # Methods from :: DescribeThesaurusResponse -> Rep DescribeThesaurusResponse x # to :: Rep DescribeThesaurusResponse x -> DescribeThesaurusResponse #
Read DescribeThesaurusResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Methods readsPrec :: Int -> ReadS DescribeThesaurusResponse # readList :: ReadS [DescribeThesaurusResponse] # readPrec :: ReadPrec DescribeThesaurusResponse # readListPrec :: ReadPrec [DescribeThesaurusResponse] #
Show DescribeThesaurusResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Methods showsPrec :: Int -> DescribeThesaurusResponse -> ShowS # show :: DescribeThesaurusResponse -> String # showList :: [DescribeThesaurusResponse] -> ShowS #
NFData DescribeThesaurusResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Methods rnf :: DescribeThesaurusResponse -> () #
Eq DescribeThesaurusResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus Methods (==) :: DescribeThesaurusResponse -> DescribeThesaurusResponse -> Bool # (/=) :: DescribeThesaurusResponse -> DescribeThesaurusResponse -> Bool #
type Rep DescribeThesaurusResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeThesaurus type Rep DescribeThesaurusResponse = D1 ('MetaData "DescribeThesaurusResponse" "Amazonka.Kendra.DescribeThesaurus" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeThesaurusResponse'" '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 "fileSizeBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "indexId") '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 "sourceS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Path)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThesaurusStatus)))) :: ((S1 ('MetaSel ('Just "synonymRuleCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "termCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeThesaurusResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeThesaurusResponse'`
-> DescribeThesaurusResponse

Create a value of DescribeThesaurusResponse 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:

DescribeThesaurusResponse, describeThesaurusResponse_createdAt - The Unix datetime that the thesaurus was created.

$sel:description:DescribeThesaurusResponse', describeThesaurusResponse_description - The thesaurus description.

DescribeThesaurusResponse, describeThesaurusResponse_errorMessage - When the Status field value is FAILED, the ErrorMessage field provides more information.

$sel:fileSizeBytes:DescribeThesaurusResponse', describeThesaurusResponse_fileSizeBytes - The size of the thesaurus file in bytes.

DescribeThesaurus, describeThesaurusResponse_id - The identifier of the thesaurus.

DescribeThesaurus, describeThesaurusResponse_indexId - The identifier of the index for the thesaurus.

DescribeThesaurusResponse, describeThesaurusResponse_name - The thesaurus name.

DescribeThesaurusResponse, describeThesaurusResponse_roleArn - An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

$sel:sourceS3Path:DescribeThesaurusResponse', describeThesaurusResponse_sourceS3Path - Undocumented member.

DescribeThesaurusResponse, describeThesaurusResponse_status - The current status of the thesaurus. When the value is ACTIVE, queries are able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage field provides more information.

If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active.

$sel:synonymRuleCount:DescribeThesaurusResponse', describeThesaurusResponse_synonymRuleCount - The number of synonym rules in the thesaurus file.

$sel:termCount:DescribeThesaurusResponse', describeThesaurusResponse_termCount - The number of unique terms in the thesaurus file. For example, the synonyms a,b,c and a=>d, the term count would be 4.

DescribeThesaurusResponse, describeThesaurusResponse_updatedAt - The Unix datetime that the thesaurus was last updated.

$sel:httpStatus:DescribeThesaurusResponse', describeThesaurusResponse_httpStatus - The response's http status code.

Response Lenses

describeThesaurusResponse_createdAt :: Lens' DescribeThesaurusResponse (Maybe UTCTime) Source #

The Unix datetime that the thesaurus was created.

describeThesaurusResponse_description :: Lens' DescribeThesaurusResponse (Maybe Text) Source #

The thesaurus description.

describeThesaurusResponse_errorMessage :: Lens' DescribeThesaurusResponse (Maybe Text) Source #

When the Status field value is FAILED, the ErrorMessage field provides more information.

describeThesaurusResponse_fileSizeBytes :: Lens' DescribeThesaurusResponse (Maybe Integer) Source #

The size of the thesaurus file in bytes.

describeThesaurusResponse_id :: Lens' DescribeThesaurusResponse (Maybe Text) Source #

The identifier of the thesaurus.

describeThesaurusResponse_indexId :: Lens' DescribeThesaurusResponse (Maybe Text) Source #

The identifier of the index for the thesaurus.

describeThesaurusResponse_name :: Lens' DescribeThesaurusResponse (Maybe Text) Source #

The thesaurus name.

describeThesaurusResponse_roleArn :: Lens' DescribeThesaurusResponse (Maybe Text) Source #

An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

describeThesaurusResponse_sourceS3Path :: Lens' DescribeThesaurusResponse (Maybe S3Path) Source #

Undocumented member.

describeThesaurusResponse_status :: Lens' DescribeThesaurusResponse (Maybe ThesaurusStatus) Source #

The current status of the thesaurus. When the value is ACTIVE, queries are able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage field provides more information.

If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active.

describeThesaurusResponse_synonymRuleCount :: Lens' DescribeThesaurusResponse (Maybe Integer) Source #

The number of synonym rules in the thesaurus file.

describeThesaurusResponse_termCount :: Lens' DescribeThesaurusResponse (Maybe Integer) Source #

The number of unique terms in the thesaurus file. For example, the synonyms a,b,c and a=>d, the term count would be 4.

describeThesaurusResponse_updatedAt :: Lens' DescribeThesaurusResponse (Maybe UTCTime) Source #

The Unix datetime that the thesaurus was last updated.

describeThesaurusResponse_httpStatus :: Lens' DescribeThesaurusResponse Int Source #

The response's http status code.