[ aws . bedrock-agentcore-control ]

update-agent-insight-store

Description

Updates the enablement status or encryption configuration of an Agent Insight Store.

See also: AWS API Documentation

Synopsis

  update-agent-insight-store
[--client-token <value>]
--agent-insight-store-id <value>
[--enablement-status <value>]
[--encryption-configuration <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

--client-token (string)

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency .

Constraints:

  • min: 33
  • max: 256
  • pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

--agent-insight-store-id (string) [required]

Specifies the unique identifier of the Agent Insight Store to update.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9-]+

--enablement-status (string)

Specifies whether the Agent Insight Store accepts new Agent Insights. If you don’t specify this parameter, the store’s current enablement setting remains unchanged.

Possible values:

  • ENABLED
  • DISABLED

--encryption-configuration (structure)

Specifies the encryption mode and key configuration to use for new Agent Insights. If you don’t specify this parameter, the store’s current encryption configuration remains unchanged.

mode -> (string) [required]

Specifies the encryption mode used to protect new Agent Insights.

Possible values:

  • AWS_OWNED_KMS_KEY
  • CUSTOMER_MANAGED_KMS

kmsKeyArn -> (string)

Specifies the Amazon Resource Name (ARN) of the customer managed AWS KMS key that you use to encrypt new Agent Insights. This field is required when mode is CUSTOMER_MANAGED_KMS and cannot be specified when mode is AWS_OWNED_KMS_KEY .

Constraints:

  • min: 1
  • max: 2048
  • pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}

Shorthand Syntax:

mode=string,kmsKeyArn=string

JSON Syntax:

{
  "mode": "AWS_OWNED_KMS_KEY"|"CUSTOMER_MANAGED_KMS",
  "kmsKeyArn": "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

agentInsightStoreArn -> (string)

The Amazon Resource Name (ARN) of the updated Agent Insight Store.

Constraints:

  • pattern: arn:aws(-[a-z]+)*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:agent-insight-store\/[a-z0-9-]{1,64}

agentInsightStoreId -> (string)

The unique identifier of the updated Agent Insight Store.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9-]+

status -> (string)

The lifecycle status of the Agent Insight Store after the update request. Valid values:

ACTIVE

The store is available.

UPDATING

The service is applying a requested change.

INACTIVE

The store does not accept new Agent Insights.

ERROR

The store requires intervention.

Possible values:

  • ACTIVE
  • UPDATING
  • INACTIVE
  • ERROR

enablementStatus -> (string)

Specifies whether the Agent Insight Store accepts new Agent Insights after the update request.

Possible values:

  • ENABLED
  • DISABLED

updatedAt -> (timestamp)

The date and time when the Agent Insight Store was last updated.

failureReason -> (string)

Describes the failure that prevented the Agent Insight Store from reaching its requested lifecycle status.

Constraints:

  • min: 0
  • max: 2048