[ aws . bedrock-agent ]

start-ingestion-job

Description

Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.

See also: AWS API Documentation

Synopsis

  start-ingestion-job
[--client-token <value>]
--data-source-id <value>
[--description <value>]
--knowledge-base-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--client-token (string)

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency .

--data-source-id (string)

The unique identifier of the data source you want to ingest into your knowledge base.

--description (string)

A description of the data ingestion job.

--knowledge-base-id (string)

The unique identifier of the knowledge base for the data ingestion job.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

ingestionJob -> (structure)

Contains information about the data ingestion job.

dataSourceId -> (string)

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

description -> (string)

The description of the data ingestion job.

failureReasons -> (list)

A list of reasons that the data ingestion job failed.

(string)

ingestionJobId -> (string)

The unique identifier of the data ingestion job.

knowledgeBaseId -> (string)

The unique identifier of the knowledge for the data ingestion job.

startedAt -> (timestamp)

The time the data ingestion job started.

If you stop a data ingestion job, the startedAt time is the time the job was started before the job was stopped.

statistics -> (structure)

Contains statistics about the data ingestion job.

numberOfDocumentsDeleted -> (long)

The number of source documents that were 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 data ingestion job.

updatedAt -> (timestamp)

The time the data ingestion job was last updated.

If you stop a data ingestion job, the updatedAt time is the time the job was stopped.