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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the Amazon Kendra indexes that you created.

Creating a Request

data ListIndices Source #

See: newListIndices smart constructor.

Constructors

ListIndices'
Fields maxResults :: Maybe Natural The maximum number of indices 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 indexes.

Instances

Instances details

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

newListIndices :: ListIndices Source #

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

ListIndices, listIndices_maxResults - The maximum number of indices to return.

ListIndices, listIndices_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 indexes.

Request Lenses

listIndices_maxResults :: Lens' ListIndices (Maybe Natural) Source #

The maximum number of indices to return.

listIndices_nextToken :: Lens' ListIndices (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 indexes.

Destructuring the Response

data ListIndicesResponse Source #

See: newListIndicesResponse smart constructor.

Constructors

ListIndicesResponse'
Fields indexConfigurationSummaryItems :: Maybe [IndexConfigurationSummary] An array of summary information on the configuration of one or more indexes. 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 indexes. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListIndicesResponse Source #

Arguments

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

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

$sel:indexConfigurationSummaryItems:ListIndicesResponse', listIndicesResponse_indexConfigurationSummaryItems - An array of summary information on the configuration of one or more indexes.

ListIndices, listIndicesResponse_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 indexes.

$sel:httpStatus:ListIndicesResponse', listIndicesResponse_httpStatus - The response's http status code.

Response Lenses

listIndicesResponse_indexConfigurationSummaryItems :: Lens' ListIndicesResponse (Maybe [IndexConfigurationSummary]) Source #

An array of summary information on the configuration of one or more indexes.

listIndicesResponse_nextToken :: Lens' ListIndicesResponse (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 indexes.

listIndicesResponse_httpStatus :: Lens' ListIndicesResponse Int Source #

The response's http status code.