Amazonka.Kendra.ListDataSourceSyncJobs

Gets statistics about synchronizing a data source connector.

Creating a Request

data ListDataSourceSyncJobs

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

ToJSON ListDataSourceSyncJobs

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Methods

toJSON :: ListDataSourceSyncJobs -> Value

toEncoding :: ListDataSourceSyncJobs -> Encoding

toJSONList :: [ListDataSourceSyncJobs] -> Value

toEncodingList :: [ListDataSourceSyncJobs] -> Encoding

ToHeaders ListDataSourceSyncJobs

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Methods

toHeaders :: ListDataSourceSyncJobs -> [Header]

ToPath ListDataSourceSyncJobs

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Methods

toPath :: ListDataSourceSyncJobs -> ByteString

ToQuery ListDataSourceSyncJobs

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Methods

toQuery :: ListDataSourceSyncJobs -> QueryString

AWSRequest ListDataSourceSyncJobs

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

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

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Methods

readsPrec :: Int -> ReadS ListDataSourceSyncJobs

readList :: ReadS [ListDataSourceSyncJobs]

readPrec :: ReadPrec ListDataSourceSyncJobs

readListPrec :: ReadPrec [ListDataSourceSyncJobs]

Show ListDataSourceSyncJobs

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Methods

showsPrec :: Int -> ListDataSourceSyncJobs -> ShowS

show :: ListDataSourceSyncJobs -> String

showList :: [ListDataSourceSyncJobs] -> ShowS

NFData ListDataSourceSyncJobs

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Methods

rnf :: ListDataSourceSyncJobs -> ()

Eq ListDataSourceSyncJobs

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Methods

(==) :: ListDataSourceSyncJobs -> ListDataSourceSyncJobs -> Bool

(/=) :: ListDataSourceSyncJobs -> ListDataSourceSyncJobs -> Bool

Hashable ListDataSourceSyncJobs

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Methods

hashWithSalt :: Int -> ListDataSourceSyncJobs -> Int

hash :: ListDataSourceSyncJobs -> Int

type AWSResponse ListDataSourceSyncJobs

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

type AWSResponse ListDataSourceSyncJobs = ListDataSourceSyncJobsResponse

type Rep ListDataSourceSyncJobs

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

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)

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)

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)

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

listDataSourceSyncJobs_statusFilter :: Lens' ListDataSourceSyncJobs (Maybe DataSourceSyncJobStatus)

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

listDataSourceSyncJobs_id :: Lens' ListDataSourceSyncJobs Text

The identifier of the data source connector.

listDataSourceSyncJobs_indexId :: Lens' ListDataSourceSyncJobs Text

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

Destructuring the Response

data ListDataSourceSyncJobsResponse

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

Generic ListDataSourceSyncJobsResponse

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

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Methods

readsPrec :: Int -> ReadS ListDataSourceSyncJobsResponse

readList :: ReadS [ListDataSourceSyncJobsResponse]

readPrec :: ReadPrec ListDataSourceSyncJobsResponse

readListPrec :: ReadPrec [ListDataSourceSyncJobsResponse]

Show ListDataSourceSyncJobsResponse

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Methods

showsPrec :: Int -> ListDataSourceSyncJobsResponse -> ShowS

show :: ListDataSourceSyncJobsResponse -> String

showList :: [ListDataSourceSyncJobsResponse] -> ShowS

NFData ListDataSourceSyncJobsResponse

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Methods

rnf :: ListDataSourceSyncJobsResponse -> ()

Eq ListDataSourceSyncJobsResponse

Defined in Amazonka.Kendra.ListDataSourceSyncJobs

Methods

(==) :: ListDataSourceSyncJobsResponse -> ListDataSourceSyncJobsResponse -> Bool

(/=) :: ListDataSourceSyncJobsResponse -> ListDataSourceSyncJobsResponse -> Bool

type Rep ListDataSourceSyncJobsResponse

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

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])

A history of synchronization jobs for the data source connector.

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

listDataSourceSyncJobsResponse_httpStatus :: Lens' ListDataSourceSyncJobsResponse Int

The response's http status code.