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.ListThesauri

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the thesauri for an index.

Creating a Request

data ListThesauri Source #

See: newListThesauri smart constructor.

Constructors

ListThesauri'

Fields

maxResults :: Maybe Natural
The maximum number of thesauri to return.
nextToken :: Maybe Text
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of thesauri (ThesaurusSummaryItems).
indexId :: Text
The identifier of the index with one or more thesauri.

Instances

Instances details

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

newListThesauri Source #

Arguments

:: Text	`$sel:indexId:ListThesauri'`
-> ListThesauri

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

ListThesauri, listThesauri_maxResults - The maximum number of thesauri to return.

ListThesauri, listThesauri_nextToken - If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of thesauri (ThesaurusSummaryItems).

$sel:indexId:ListThesauri', listThesauri_indexId - The identifier of the index with one or more thesauri.

Request Lenses

listThesauri_maxResults :: Lens' ListThesauri (Maybe Natural) Source #

The maximum number of thesauri to return.

listThesauri_nextToken :: Lens' ListThesauri (Maybe Text) Source #

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of thesauri (ThesaurusSummaryItems).

listThesauri_indexId :: Lens' ListThesauri Text Source #

The identifier of the index with one or more thesauri.

Destructuring the Response

data ListThesauriResponse Source #

See: newListThesauriResponse smart constructor.

Constructors

ListThesauriResponse'
Fields nextToken :: Maybe Text If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of thesauri. thesaurusSummaryItems :: Maybe [ThesaurusSummary] An array of summary information for a thesaurus or multiple thesauri. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListThesauriResponse Source #
Instance details Defined in Amazonka.Kendra.ListThesauri Associated Types type Rep ListThesauriResponse :: Type -> Type # Methods from :: ListThesauriResponse -> Rep ListThesauriResponse x # to :: Rep ListThesauriResponse x -> ListThesauriResponse #
Read ListThesauriResponse Source #
Instance details Defined in Amazonka.Kendra.ListThesauri Methods readsPrec :: Int -> ReadS ListThesauriResponse # readList :: ReadS [ListThesauriResponse] # readPrec :: ReadPrec ListThesauriResponse # readListPrec :: ReadPrec [ListThesauriResponse] #
Show ListThesauriResponse Source #
Instance details Defined in Amazonka.Kendra.ListThesauri Methods showsPrec :: Int -> ListThesauriResponse -> ShowS # show :: ListThesauriResponse -> String # showList :: [ListThesauriResponse] -> ShowS #
NFData ListThesauriResponse Source #
Instance details Defined in Amazonka.Kendra.ListThesauri Methods rnf :: ListThesauriResponse -> () #
Eq ListThesauriResponse Source #
Instance details Defined in Amazonka.Kendra.ListThesauri Methods (==) :: ListThesauriResponse -> ListThesauriResponse -> Bool # (/=) :: ListThesauriResponse -> ListThesauriResponse -> Bool #
type Rep ListThesauriResponse Source #
Instance details Defined in Amazonka.Kendra.ListThesauri type Rep ListThesauriResponse = D1 ('MetaData "ListThesauriResponse" "Amazonka.Kendra.ListThesauri" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListThesauriResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "thesaurusSummaryItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ThesaurusSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListThesauriResponse Source #

Arguments

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

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

ListThesauri, listThesauriResponse_nextToken - If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of thesauri.

$sel:thesaurusSummaryItems:ListThesauriResponse', listThesauriResponse_thesaurusSummaryItems - An array of summary information for a thesaurus or multiple thesauri.

$sel:httpStatus:ListThesauriResponse', listThesauriResponse_httpStatus - The response's http status code.

Response Lenses

listThesauriResponse_nextToken :: Lens' ListThesauriResponse (Maybe Text) Source #

If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of thesauri.

listThesauriResponse_thesaurusSummaryItems :: Lens' ListThesauriResponse (Maybe [ThesaurusSummary]) Source #

An array of summary information for a thesaurus or multiple thesauri.

listThesauriResponse_httpStatus :: Lens' ListThesauriResponse Int Source #

The response's http status code.