Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . bedrock-agent ]

list-ingestion-jobs¶

Description¶

Lists the ingestion jobs for a data source and information about each of them.

Synopsis¶

  list-ingestion-jobs
--data-source-id <value>
[--filters <value>]
--knowledge-base-id <value>
[--sort-by <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--data-source-id (string)

The unique identifier of the data source for which to return ingestion jobs.

--filters (list)

Contains a definition of a filter for which to filter the results.

(structure)

Defines a filter by which to filter the results.

attribute -> (string)

The attribute by which to filter the results.

operator -> (string)

The operation to carry out between the attribute and the values.

values -> (list)

A list of values for the attribute.

(string)

Shorthand Syntax:

attribute=string,operator=string,values=string,string ...

JSON Syntax:

[
  {
    "attribute": "STATUS",
    "operator": "EQ",
    "values": ["string", ...]
  }
  ...
]

--knowledge-base-id (string)

The unique identifier of the knowledge base for which to return ingestion jobs.

--sort-by (structure)

Contains details about how to sort the results.

attribute -> (string)

The attribute by which to sort the results.

order -> (string)

The order by which to sort the results.

Shorthand Syntax:

attribute=string,order=string

JSON Syntax:

{
  "attribute": "STATUS"|"STARTED_AT",
  "order": "ASCENDING"|"DESCENDING"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

ingestionJobSummaries -> (list)

A list of objects, each of which contains information about an ingestion job.

(structure)

Contains details about an ingestion job.

dataSourceId -> (string)

The unique identifier of the data source in the ingestion job.

description -> (string)

The description of the ingestion job.

ingestionJobId -> (string)

The unique identifier of the ingestion job.

knowledgeBaseId -> (string)

The unique identifier of the knowledge base to which the data source is added.

startedAt -> (timestamp)

The time at which the ingestion job was started.

statistics -> (structure)

Contains statistics for the ingestion job.

numberOfDocumentsDeleted -> (long)

The number of source documents that was deleted.

numberOfDocumentsFailed -> (long)

The number of source documents that failed to be ingested.

numberOfDocumentsScanned -> (long)

The total number of source documents that were scanned. Includes new, updated, and unchanged documents.

numberOfMetadataDocumentsModified -> (long)

The number of metadata files that were updated or deleted.

numberOfMetadataDocumentsScanned -> (long)

The total number of metadata files that were scanned. Includes new, updated, and unchanged files.

numberOfModifiedDocumentsIndexed -> (long)

The number of modified source documents in the data source that were successfully indexed.

numberOfNewDocumentsIndexed -> (long)

The number of new source documents in the data source that were successfully indexed.

status -> (string)

The status of the ingestion job.

updatedAt -> (timestamp)

The time at which the ingestion job was last updated.

nextToken -> (string)

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

Table Of Contents

Feedback

User Guide