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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets statistics about synchronizing a data source connector.

Synopsis

data ListDataSourceSyncJobs = ListDataSourceSyncJobs' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- startTimeFilter :: Maybe TimeRange
- statusFilter :: Maybe DataSourceSyncJobStatus
- id :: Text
- indexId :: Text
}
newListDataSourceSyncJobs :: Text -> Text -> ListDataSourceSyncJobs
listDataSourceSyncJobs_maxResults :: Lens' ListDataSourceSyncJobs (Maybe Natural)
listDataSourceSyncJobs_nextToken :: Lens' ListDataSourceSyncJobs (Maybe Text)
listDataSourceSyncJobs_startTimeFilter :: Lens' ListDataSourceSyncJobs (Maybe TimeRange)
listDataSourceSyncJobs_statusFilter :: Lens' ListDataSourceSyncJobs (Maybe DataSourceSyncJobStatus)
listDataSourceSyncJobs_id :: Lens' ListDataSourceSyncJobs Text
listDataSourceSyncJobs_indexId :: Lens' ListDataSourceSyncJobs Text
data ListDataSourceSyncJobsResponse = ListDataSourceSyncJobsResponse' {
- history :: Maybe [DataSourceSyncJob]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListDataSourceSyncJobsResponse :: Int -> ListDataSourceSyncJobsResponse
listDataSourceSyncJobsResponse_history :: Lens' ListDataSourceSyncJobsResponse (Maybe [DataSourceSyncJob])
listDataSourceSyncJobsResponse_nextToken :: Lens' ListDataSourceSyncJobsResponse (Maybe Text)
listDataSourceSyncJobsResponse_httpStatus :: Lens' ListDataSourceSyncJobsResponse Int

Creating a Request

data ListDataSourceSyncJobs Source #

See: newListDataSourceSyncJobs smart constructor.

Constructors

ListDataSourceSyncJobs'

Fields

maxResults :: Maybe Natural
The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.
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 jobs.
startTimeFilter :: Maybe TimeRange
When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
statusFilter :: Maybe DataSourceSyncJobStatus
Only returns synchronization jobs with the Status field equal to the specified status.
id :: Text
The identifier of the data source connector.
indexId :: Text
The identifier of the index used with the data source connector.

Instances

Instances details

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

newListDataSourceSyncJobs Source #

Arguments

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

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

ListDataSourceSyncJobs, listDataSourceSyncJobs_maxResults - The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

ListDataSourceSyncJobs, listDataSourceSyncJobs_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 jobs.

$sel:startTimeFilter:ListDataSourceSyncJobs', listDataSourceSyncJobs_startTimeFilter - When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

$sel:statusFilter:ListDataSourceSyncJobs', listDataSourceSyncJobs_statusFilter - Only returns synchronization jobs with the Status field equal to the specified status.

ListDataSourceSyncJobs, listDataSourceSyncJobs_id - The identifier of the data source connector.

$sel:indexId:ListDataSourceSyncJobs', listDataSourceSyncJobs_indexId - The identifier of the index used with the data source connector.

Request Lenses

listDataSourceSyncJobs_maxResults :: Lens' ListDataSourceSyncJobs (Maybe Natural) Source #

The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

listDataSourceSyncJobs_nextToken :: Lens' ListDataSourceSyncJobs (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 jobs.

listDataSourceSyncJobs_startTimeFilter :: Lens' ListDataSourceSyncJobs (Maybe TimeRange) Source #

When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

listDataSourceSyncJobs_statusFilter :: Lens' ListDataSourceSyncJobs (Maybe DataSourceSyncJobStatus) Source #

Only returns synchronization jobs with the Status field equal to the specified status.

listDataSourceSyncJobs_id :: Lens' ListDataSourceSyncJobs Text Source #

The identifier of the data source connector.

listDataSourceSyncJobs_indexId :: Lens' ListDataSourceSyncJobs Text Source #

The identifier of the index used with the data source connector.

Destructuring the Response

data ListDataSourceSyncJobsResponse Source #

See: newListDataSourceSyncJobsResponse smart constructor.

Constructors

ListDataSourceSyncJobsResponse'
Fields history :: Maybe [DataSourceSyncJob] A history of synchronization jobs for the data source connector. 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 jobs. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListDataSourceSyncJobsResponse Source #

Arguments

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

Create a value of ListDataSourceSyncJobsResponse 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:history:ListDataSourceSyncJobsResponse', listDataSourceSyncJobsResponse_history - A history of synchronization jobs for the data source connector.

ListDataSourceSyncJobs, listDataSourceSyncJobsResponse_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 jobs.

$sel:httpStatus:ListDataSourceSyncJobsResponse', listDataSourceSyncJobsResponse_httpStatus - The response's http status code.

Response Lenses

listDataSourceSyncJobsResponse_history :: Lens' ListDataSourceSyncJobsResponse (Maybe [DataSourceSyncJob]) Source #

A history of synchronization jobs for the data source connector.

listDataSourceSyncJobsResponse_nextToken :: Lens' ListDataSourceSyncJobsResponse (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 jobs.

listDataSourceSyncJobsResponse_httpStatus :: Lens' ListDataSourceSyncJobsResponse Int Source #

The response's http status code.