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 ]

associate-agent-knowledge-base

Description

Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled , the agent queries the knowledge base for information to augment its response to the user.

See also: AWS API Documentation

Synopsis

  associate-agent-knowledge-base
--agent-id <value>
--agent-version <value>
--description <value>
--knowledge-base-id <value>
[--knowledge-base-state <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

--agent-id (string)

The unique identifier of the agent with which you want to associate the knowledge base.

--agent-version (string)

The version of the agent with which you want to associate the knowledge base.

--description (string)

A description of what the agent should use the knowledge base for.

--knowledge-base-id (string)

The unique identifier of the knowledge base to associate with the agent.

--knowledge-base-state (string)

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

Possible values:

• ENABLED
• DISABLED

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

agentKnowledgeBase -> (structure)

Contains details about the knowledge base that has been associated with the agent.

agentId -> (string)

The unique identifier of the agent with which the knowledge base is associated.

agentVersion -> (string)

The version of the agent with which the knowledge base is associated.

createdAt -> (timestamp)

The time at which the association between the agent and the knowledge base was created.

description -> (string)

The description of the association between the agent and the knowledge base.

knowledgeBaseId -> (string)

The unique identifier of the association between the agent and the knowledge base.

knowledgeBaseState -> (string)

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

updatedAt -> (timestamp)

The time at which the association between the agent and the knowledge base was last updated.