List Ingestion Jobs

bedrockagent_list_ingestion_jobs

R Documentation

Lists the data ingestion jobs for a data source

Description

Lists the data ingestion jobs for a data source. The list also includes information about each job.

Usage

bedrockagent_list_ingestion_jobs(dataSourceId, filters, knowledgeBaseId,
  maxResults, nextToken, sortBy)

Arguments

dataSourceId

[required] The unique identifier of the data source for the list of data ingestion jobs.

filters

Contains information about the filters for filtering the data.

knowledgeBaseId

[required] The unique identifier of the knowledge base for the list of data ingestion jobs.

maxResults

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

nextToken

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

sortBy

Contains details about how to sort the data.

Value

A list with the following syntax:

list(
  ingestionJobSummaries = list(
    list(
      dataSourceId = "string",
      description = "string",
      ingestionJobId = "string",
      knowledgeBaseId = "string",
      startedAt = as.POSIXct(
        "2015-01-01"
      ),
      statistics = list(
        numberOfDocumentsDeleted = 123,
        numberOfDocumentsFailed = 123,
        numberOfDocumentsScanned = 123,
        numberOfMetadataDocumentsModified = 123,
        numberOfMetadataDocumentsScanned = 123,
        numberOfModifiedDocumentsIndexed = 123,
        numberOfNewDocumentsIndexed = 123
      ),
      status = "STARTING"|"IN_PROGRESS"|"COMPLETE"|"FAILED"|"STOPPING"|"STOPPED",
      updatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_ingestion_jobs(
  dataSourceId = "string",
  filters = list(
    list(
      attribute = "STATUS",
      operator = "EQ",
      values = list(
        "string"
      )
    )
  ),
  knowledgeBaseId = "string",
  maxResults = 123,
  nextToken = "string",
  sortBy = list(
    attribute = "STATUS"|"STARTED_AT",
    order = "ASCENDING"|"DESCENDING"
  )
)