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 ]

update-data-source¶

Description¶

Updates configurations for a data source.

Warning

You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration .

Synopsis¶

  update-data-source
[--data-deletion-policy <value>]
--data-source-configuration <value>
--data-source-id <value>
[--description <value>]
--knowledge-base-id <value>
--name <value>
[--server-side-encryption-configuration <value>]
[--vector-ingestion-configuration <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-deletion-policy (string)

The data deletion policy of the updated data source.

Possible values:

RETAIN

DELETE

--data-source-configuration (structure)

Contains details about the storage configuration of the data source.

s3Configuration -> (structure)

Contains details about the configuration of the S3 object containing the data source.

bucketArn -> (string)

The Amazon Resource Name (ARN) of the bucket that contains the data source.

bucketOwnerAccountId -> (string)

The bucket account owner ID for the S3 bucket.

inclusionPrefixes -> (list)

A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes .

(string)

type -> (string)

The type of storage for the data source.

Shorthand Syntax:

s3Configuration={bucketArn=string,bucketOwnerAccountId=string,inclusionPrefixes=[string,string]},type=string

JSON Syntax:

{
  "s3Configuration": {
    "bucketArn": "string",
    "bucketOwnerAccountId": "string",
    "inclusionPrefixes": ["string", ...]
  },
  "type": "S3"
}

--data-source-id (string)

The unique identifier of the data source.

--description (string)

Specifies a new description for the data source.

--knowledge-base-id (string)

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

--name (string)

Specifies a new name for the data source.

--server-side-encryption-configuration (structure)

Contains details about server-side encryption of the data source.

kmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.

Shorthand Syntax:

kmsKeyArn=string

JSON Syntax:

{
  "kmsKeyArn": "string"
}

--vector-ingestion-configuration (structure)

Contains details about how to ingest the documents in the data source.

chunkingConfiguration -> (structure)

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

chunkingStrategy -> (string)

Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE , then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration .

NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

fixedSizeChunkingConfiguration -> (structure)

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.

maxTokens -> (integer)

The maximum number of tokens to include in a chunk.

overlapPercentage -> (integer)

The percentage of overlap between adjacent chunks of a data source.

Shorthand Syntax:

chunkingConfiguration={chunkingStrategy=string,fixedSizeChunkingConfiguration={maxTokens=integer,overlapPercentage=integer}}

JSON Syntax:

{
  "chunkingConfiguration": {
    "chunkingStrategy": "FIXED_SIZE"|"NONE",
    "fixedSizeChunkingConfiguration": {
      "maxTokens": integer,
      "overlapPercentage": integer
    }
  }
}

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

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

dataSource -> (structure)

Contains details about the data source.

createdAt -> (timestamp)

The time at which the data source was created.

dataDeletionPolicy -> (string)

The data deletion policy for a data source.

dataSourceConfiguration -> (structure)

Contains details about how the data source is stored.

s3Configuration -> (structure)

Contains details about the configuration of the S3 object containing the data source.

bucketArn -> (string)

The Amazon Resource Name (ARN) of the bucket that contains the data source.

bucketOwnerAccountId -> (string)

The bucket account owner ID for the S3 bucket.

inclusionPrefixes -> (list)

A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes .

(string)

type -> (string)

The type of storage for the data source.

dataSourceId -> (string)

The unique identifier of the data source.

description -> (string)

The description of the data source.

failureReasons -> (list)

The detailed reasons on the failure to delete a data source.

(string)

knowledgeBaseId -> (string)

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

name -> (string)

The name of the data source.

serverSideEncryptionConfiguration -> (structure)

Contains details about the configuration of the server-side encryption.

kmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.

status -> (string)

The status of the data source. The following statuses are possible:

Available – The data source has been created and is ready for ingestion into the knowledge base.

Deleting – The data source is being deleted.

updatedAt -> (timestamp)

The time at which the data source was last updated.

vectorIngestionConfiguration -> (structure)

Contains details about how to ingest the documents in the data source.

chunkingConfiguration -> (structure)

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

chunkingStrategy -> (string)

Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE , then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration .

NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

fixedSizeChunkingConfiguration -> (structure)

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.

maxTokens -> (integer)

The maximum number of tokens to include in a chunk.

overlapPercentage -> (integer)

The percentage of overlap between adjacent chunks of a data source.

Table Of Contents

Feedback

User Guide

Note:

update-data-source¶

Description¶

Warning

Synopsis¶

Options¶

Global Options¶

Output¶