AWS CLI Command Reference

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 ]

stop-ingestion-job

Description

Stops a currently running data ingestion job. You can send a StartIngestionJob request again to ingest the rest of your data when you are ready.

See also: AWS API Documentation

Synopsis

  stop-ingestion-job
--data-source-id <value>
--ingestion-job-id <value>
--knowledge-base-id <value>
[--cli-input-json <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 the data ingestion job you want to stop.

--ingestion-job-id (string)

The unique identifier of the data ingestion job you want to stop.

--knowledge-base-id (string)

The unique identifier of the knowledge base for the data ingestion job you want to stop.

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

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

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

ingestionJob -> (structure)

Contains information about the stopped 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.