amazonka-kendra-2.0: Amazon KendraFrontendService SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Kendra.ListDataSources

Description

Lists the data source connectors that you have created.

Synopsis

Creating a Request

data ListDataSources Source #

See: newListDataSources smart constructor.

Constructors

ListDataSources' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of data source connectors 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 data source connectors.

  • indexId :: Text

    The identifier of the index used with one or more data source connectors.

Instances

Instances details
ToJSON ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Methods

toJSON :: ListDataSources -> Value #

toEncoding :: ListDataSources -> Encoding #

toJSONList :: [ListDataSources] -> Value #

toEncodingList :: [ListDataSources] -> Encoding #

ToHeaders ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Methods

toHeaders :: ListDataSources -> [Header] #

ToPath ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Methods

toPath :: ListDataSources -> ByteString #

ToQuery ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Methods

toQuery :: ListDataSources -> QueryString #

AWSRequest ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Associated Types

type AWSResponse ListDataSources #

Methods

request :: (Service -> Service) -> ListDataSources -> Request ListDataSources #

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

Generic ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Associated Types

type Rep ListDataSources :: Type -> Type #

Methods

from :: ListDataSources -> Rep ListDataSources x #

to :: Rep ListDataSources x -> ListDataSources #

Read ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Methods

readsPrec :: Int -> ReadS ListDataSources #

readList :: ReadS [ListDataSources] #

readPrec :: ReadPrec ListDataSources #

readListPrec :: ReadPrec [ListDataSources] #

Show ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Methods

showsPrec :: Int -> ListDataSources -> ShowS #

show :: ListDataSources -> String #

showList :: [ListDataSources] -> ShowS #

NFData ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Methods

rnf :: ListDataSources -> () #

Eq ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Methods

(==) :: ListDataSources -> ListDataSources -> Bool #

(/=) :: ListDataSources -> ListDataSources -> Bool #

Hashable ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Methods

hashWithSalt :: Int -> ListDataSources -> Int #

hash :: ListDataSources -> Int #

type AWSResponse ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

type AWSResponse ListDataSources = ListDataSourcesResponse
type Rep ListDataSources Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

type Rep ListDataSources = D1 ('MetaData "ListDataSources" "Amazonka.Kendra.ListDataSources" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListDataSources'" '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))))

newListDataSources Source #

Arguments

:: Text

$sel:indexId:ListDataSources'

-> ListDataSources 

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

ListDataSources, listDataSources_maxResults - The maximum number of data source connectors to return.

ListDataSources, listDataSources_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 data source connectors.

$sel:indexId:ListDataSources', listDataSources_indexId - The identifier of the index used with one or more data source connectors.

Request Lenses

listDataSources_maxResults :: Lens' ListDataSources (Maybe Natural) Source #

The maximum number of data source connectors to return.

listDataSources_nextToken :: Lens' ListDataSources (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 data source connectors.

listDataSources_indexId :: Lens' ListDataSources Text Source #

The identifier of the index used with one or more data source connectors.

Destructuring the Response

data ListDataSourcesResponse Source #

See: newListDataSourcesResponse smart constructor.

Constructors

ListDataSourcesResponse' 

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 data source connectors.

  • summaryItems :: Maybe [DataSourceSummary]

    An array of summary information for one or more data source connector.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListDataSourcesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Associated Types

type Rep ListDataSourcesResponse :: Type -> Type #

Methods

from :: ListDataSourcesResponse -> Rep ListDataSourcesResponse x #

to :: Rep ListDataSourcesResponse x -> ListDataSourcesResponse #

Read ListDataSourcesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Methods

readsPrec :: Int -> ReadS ListDataSourcesResponse #

readList :: ReadS [ListDataSourcesResponse] #

readPrec :: ReadPrec ListDataSourcesResponse #

readListPrec :: ReadPrec [ListDataSourcesResponse] #

Show ListDataSourcesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Methods

showsPrec :: Int -> ListDataSourcesResponse -> ShowS #

show :: ListDataSourcesResponse -> String #

showList :: [ListDataSourcesResponse] -> ShowS #

NFData ListDataSourcesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Methods

rnf :: ListDataSourcesResponse -> () #

Eq ListDataSourcesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

Methods

(==) :: ListDataSourcesResponse -> ListDataSourcesResponse -> Bool #

(/=) :: ListDataSourcesResponse -> ListDataSourcesResponse -> Bool #

type Rep ListDataSourcesResponse Source # 
Instance details

Defined in Amazonka.Kendra.ListDataSources

type Rep ListDataSourcesResponse = D1 ('MetaData "ListDataSourcesResponse" "Amazonka.Kendra.ListDataSources" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ListDataSourcesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "summaryItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataSourceSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDataSourcesResponse Source #

Arguments

:: Int

$sel:httpStatus:ListDataSourcesResponse'

-> ListDataSourcesResponse 

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

ListDataSources, listDataSourcesResponse_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 data source connectors.

$sel:summaryItems:ListDataSourcesResponse', listDataSourcesResponse_summaryItems - An array of summary information for one or more data source connector.

$sel:httpStatus:ListDataSourcesResponse', listDataSourcesResponse_httpStatus - The response's http status code.

Response Lenses

listDataSourcesResponse_nextToken :: Lens' ListDataSourcesResponse (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 data source connectors.

listDataSourcesResponse_summaryItems :: Lens' ListDataSourcesResponse (Maybe [DataSourceSummary]) Source #

An array of summary information for one or more data source connector.

listDataSourcesResponse_httpStatus :: Lens' ListDataSourcesResponse Int Source #

The response's http status code.