[ aws . s3vectors ]

update-metadata-configuration

Description

Adds or deletes text search configurations on a vector index. Specify either add or delete , but not both. The vector index must be in ENHANCED mode.

Permissions

You must have the s3vectors:UpdateMetadataConfiguration permission to use this operation.

See also: AWS API Documentation

Synopsis

  update-metadata-configuration
[--vector-bucket-name <value>]
[--index-name <value>]
[--index-arn <value>]
[--add <value>]
[--delete <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]
[--cli-error-format <value>]
[--help]

Options

--vector-bucket-name (string)

The name of the vector bucket that contains the vector index.

Constraints:

  • min: 3
  • max: 63

--index-name (string)

The name of the vector index to update.

Constraints:

  • min: 3
  • max: 63

--index-arn (string)

The Amazon Resource Name (ARN) of the vector index to update.

Constraints:

  • pattern: arn:aws[-a-z0-9]*:s3vectors:[a-z0-9-]+:[0-9]{12}:bucket/[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]/index/[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]

--add (structure)

Text search configurations to add to the vector index.

textSearchConfigurations -> (list)

Text search configurations to add. Amazon S3 Vectors begins building the corresponding full-text indexes after the update is accepted.

Constraints:

  • min: 0
  • max: 10

(structure)

A full-text search configuration for a single metadata key.

metadataKey -> (string) [required]

The metadata key to make full-text searchable.

Constraints:

  • min: 1
  • max: 63

language -> (string)

The language that the text search analyzer uses. Valid values are en (English), fr (French), es (Spanish), pt (Portuguese), it (Italian), de (German), nl (Dutch), zh (Chinese), ja (Japanese), and ko (Korean). If you don’t specify a language, Amazon S3 Vectors uses the default standard analyzer.

Possible values:

  • en
  • fr
  • es
  • pt
  • it
  • de
  • nl
  • zh
  • ja
  • ko

status -> (string)

The backfill status of the text search configuration. Valid values are ACTIVE , which indicates that the analyzer is built and serving queries, and BUILDING , which indicates that the analyzer is being backfilled and isn’t yet serving queries. This field is returned by GetIndex .

Possible values:

  • ACTIVE
  • BUILDING

Shorthand Syntax:

textSearchConfigurations=[{metadataKey=string,language=string,status=string},{metadataKey=string,language=string,status=string}]

JSON Syntax:

{
  "textSearchConfigurations": [
    {
      "metadataKey": "string",
      "language": "en"|"fr"|"es"|"pt"|"it"|"de"|"nl"|"zh"|"ja"|"ko",
      "status": "ACTIVE"|"BUILDING"
    }
    ...
  ]
}

--delete (structure)

Text search configurations to delete from the vector index.

textSearchConfigurations -> (list)

Searchable metadata keys whose text search configurations to delete.

Constraints:

  • min: 1
  • max: 10

(structure)

A searchable metadata key that identifies a text search configuration.

metadataKey -> (string) [required]

The searchable metadata key whose text search configuration to delete.

Constraints:

  • min: 1
  • max: 63

Shorthand Syntax:

textSearchConfigurations=[{metadataKey=string},{metadataKey=string}]

JSON Syntax:

{
  "textSearchConfigurations": [
    {
      "metadataKey": "string"
    }
    ...
  ]
}

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

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

indexArn -> (string)

The Amazon Resource Name (ARN) of the updated vector index.

Constraints:

  • pattern: arn:aws[-a-z0-9]*:s3vectors:[a-z0-9-]+:[0-9]{12}:bucket/[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]/index/[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]