[ aws . bedrock-agent ]

get-knowledge-base

Description

Get an existing knowledge base

See also: AWS API Documentation

Synopsis

  get-knowledge-base
--knowledge-base-id <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]

Options

--knowledge-base-id (string)

Identifier for a resource.

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

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

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

Output

knowledgeBase -> (structure)

Contains the information of a knowledge base.

knowledgeBaseId -> (string)

Identifier for a resource.

name -> (string)

Name for a resource.

knowledgeBaseArn -> (string)

ARN of a KnowledgeBase

description -> (string)

Description of the Resource.

roleArn -> (string)

ARN of a IAM role.

knowledgeBaseConfiguration -> (structure)

Configures a bedrock knowledge base.

type -> (string)

The type of a knowledge base.

vectorKnowledgeBaseConfiguration -> (structure)

Configurations for a vector knowledge base.

embeddingModelArn -> (string)

Arn of a Bedrock model.

storageConfiguration -> (structure)

Configures the physical storage of ingested data in a knowledge base.

type -> (string)

The storage type of a knowledge base.

opensearchServerlessConfiguration -> (structure)

Contains the configurations to use OpenSearch Serverless to store knowledge base data.

collectionArn -> (string)

Arn of an OpenSearch Serverless collection.

vectorIndexName -> (string)

Arn of an OpenSearch Serverless index.

fieldMapping -> (structure)

A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names

vectorField -> (string)

Name of the field

textField -> (string)

Name of the field

metadataField -> (string)

Name of the field

pineconeConfiguration -> (structure)

Contains the configurations to use Pinecone to store knowledge base data.

connectionString -> (string)

Pinecone connection string

credentialsSecretArn -> (string)

Arn of a SecretsManager Secret.

namespace -> (string)

Pinecone namespace

fieldMapping -> (structure)

A mapping of Bedrock Knowledge Base fields to Pinecone field names

textField -> (string)

Name of the field

metadataField -> (string)

Name of the field

redisEnterpriseCloudConfiguration -> (structure)

Contains the configurations to use Redis Enterprise Cloud to store knowledge base data.

endpoint -> (string)

Redis enterprise cloud endpoint

vectorIndexName -> (string)

Name of a redis enterprise cloud index

credentialsSecretArn -> (string)

Arn of a SecretsManager Secret.

fieldMapping -> (structure)

A mapping of Bedrock Knowledge Base fields to Redis Cloud field names

vectorField -> (string)

Name of the field

textField -> (string)

Name of the field

metadataField -> (string)

Name of the field

rdsConfiguration -> (structure)

Contains the configurations to use RDS to store knowledge base data.

resourceArn -> (string)

Arn of a RDS Resource.

credentialsSecretArn -> (string)

Arn of a SecretsManager Secret.

databaseName -> (string)

Name of the database within RDS

tableName -> (string)

Name of the table within RDS

fieldMapping -> (structure)

A mapping of Bedrock Knowledge Base fields to RDS column names

primaryKeyField -> (string)

Name of the column

vectorField -> (string)

Name of the column

textField -> (string)

Name of the column

metadataField -> (string)

Name of the column

status -> (string)

The status of a knowledge base.

createdAt -> (timestamp)

Time Stamp.

updatedAt -> (timestamp)

Time Stamp.

failureReasons -> (list)

Failure Reasons for Error.

(string)

Failure Reason for Error.