Skip to content
AWS for Query.Farm

aws.bedrock_agent.get_knowledge_base

Example SQL Queries

SELECT * FROM
aws.bedrock_agent.get_knowledge_base
WHERE
"knowledge_base_id" = 'VALUE';

Description

Gets information about a knoweldge base.

Table Definition

Column NameColumn Data Type
knowledge_base_id Required Input Column

The unique identifier of the knowledge base for which to get information.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

knowledge_base

Contains details about the knowledge base.

STRUCT(
    "created_at" TIMESTAMP_S,
    "description" VARCHAR,
    "failure_reasons" VARCHAR[],
    "knowledge_base_arn" VARCHAR,
    "knowledge_base_configuration" STRUCT(
        "type" VARCHAR,
        "vector_knowledge_base_configuration" STRUCT(
            "embedding_model_arn" VARCHAR,
            "embedding_model_configuration" STRUCT(
                "bedrock_embedding_model_configuration" STRUCT(
                    "dimensions" BIGINT
                )
            )
        )
    ),
    "knowledge_base_id" VARCHAR,
    "name" VARCHAR,
    "role_arn" VARCHAR,
    "status" VARCHAR,
    "storage_configuration" STRUCT(
        "mongo_db_atlas_configuration" STRUCT(
            "collection_name" VARCHAR,
            "credentials_secret_arn" VARCHAR,
            "database_name" VARCHAR,
            "endpoint" VARCHAR,
            "endpoint_service_name" VARCHAR,
            "field_mapping" STRUCT(
                "metadata_field" VARCHAR,
                "text_field" VARCHAR,
                "vector_field" VARCHAR
            ),
            "vector_index_name" VARCHAR
        ),
        "opensearch_serverless_configuration" STRUCT(
            "collection_arn" VARCHAR,
            "field_mapping" STRUCT(
                "metadata_field" VARCHAR,
                "text_field" VARCHAR,
                "vector_field" VARCHAR
            ),
            "vector_index_name" VARCHAR
        ),
        "pinecone_configuration" STRUCT(
            "connection_string" VARCHAR,
            "credentials_secret_arn" VARCHAR,
            "field_mapping" STRUCT(
                "metadata_field" VARCHAR,
                "text_field" VARCHAR
            ),
            "namespace" VARCHAR
        ),
        "rds_configuration" STRUCT(
            "credentials_secret_arn" VARCHAR,
            "database_name" VARCHAR,
            "field_mapping" STRUCT(
                "metadata_field" VARCHAR,
                "primary_key_field" VARCHAR,
                "text_field" VARCHAR,
                "vector_field" VARCHAR
            ),
            "resource_arn" VARCHAR,
            "table_name" VARCHAR
        ),
        "redis_enterprise_cloud_configuration" STRUCT(
            "credentials_secret_arn" VARCHAR,
            "endpoint" VARCHAR,
            "field_mapping" STRUCT(
                "metadata_field" VARCHAR,
                "text_field" VARCHAR,
                "vector_field" VARCHAR
            ),
            "vector_index_name" VARCHAR
        ),
        "type" VARCHAR
    ),
    "updated_at" TIMESTAMP_S
)
Show child fields
knowledge_base.created_at

The time at which the knowledge base was created.

knowledge_base.description

The description of the knowledge base.

knowledge_base.failure_reasons[]
knowledge_base.knowledge_base_arn

The Amazon Resource Name (ARN) of the knowledge base.

knowledge_base.knowledge_base_configuration

Contains details about the embeddings configuration of the knowledge base.

Show child fields
knowledge_base.knowledge_base_configuration.type

The type of data that the data source is converted into for the knowledge base.

knowledge_base.knowledge_base_configuration.vector_knowledge_base_configuration

Contains details about the embeddings model that'sused to convert the data source.

Show child fields
knowledge_base.knowledge_base_configuration.vector_knowledge_base_configuration.embedding_model_arn

The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.

knowledge_base.knowledge_base_configuration.vector_knowledge_base_configuration.embedding_model_configuration

The embeddings model configuration details for the vector model used in Knowledge Base.

Show child fields
knowledge_base.knowledge_base_configuration.vector_knowledge_base_configuration.embedding_model_configuration.bedrock_embedding_model_configuration

The vector configuration details on the Bedrock embeddings model.

Show child fields
knowledge_base.knowledge_base_configuration.vector_knowledge_base_configuration.embedding_model_configuration.bedrock_embedding_model_configuration.dimensions

The dimensions details for the vector configuration used on the Bedrock embeddings model.

knowledge_base.knowledge_base_id

The unique identifier of the knowledge base.

knowledge_base.name

The name of the knowledge base.

knowledge_base.role_arn

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

knowledge_base.status

The status of the knowledge base. The following statuses are possible:

  • CREATING – The knowledge base is being created.

  • ACTIVE – The knowledge base is ready to be queried.

  • DELETING – The knowledge base is being deleted.

  • UPDATING – The knowledge base is being updated.

  • FAILED – The knowledge base API operation failed.

knowledge_base.storage_configuration

Contains details about the storage configuration of the knowledge base.

Show child fields
knowledge_base.storage_configuration.mongo_db_atlas_configuration

Contains the storage configuration of the knowledge base in MongoDB Atlas.

Show child fields
knowledge_base.storage_configuration.mongo_db_atlas_configuration.collection_name

The collection name of the knowledge base in MongoDB Atlas.

knowledge_base.storage_configuration.mongo_db_atlas_configuration.credentials_secret_arn

The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.

knowledge_base.storage_configuration.mongo_db_atlas_configuration.database_name

The database name in your MongoDB Atlas cluster for your knowledge base.

knowledge_base.storage_configuration.mongo_db_atlas_configuration.endpoint

The endpoint URL of your MongoDB Atlas cluster for your knowledge base.

knowledge_base.storage_configuration.mongo_db_atlas_configuration.endpoint_service_name

The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.

knowledge_base.storage_configuration.mongo_db_atlas_configuration.field_mapping

Contains the names of the fields to which to map information about the vector store.

Show child fields
knowledge_base.storage_configuration.mongo_db_atlas_configuration.field_mapping.metadata_field

The name of the field in which Amazon Bedrock stores metadata about the vector store.

knowledge_base.storage_configuration.mongo_db_atlas_configuration.field_mapping.text_field

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

knowledge_base.storage_configuration.mongo_db_atlas_configuration.field_mapping.vector_field

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

knowledge_base.storage_configuration.mongo_db_atlas_configuration.vector_index_name

The name of the MongoDB Atlas vector search index.

knowledge_base.storage_configuration.opensearch_serverless_configuration

Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.

Show child fields
knowledge_base.storage_configuration.opensearch_serverless_configuration.collection_arn

The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping

Contains the names of the fields to which to map information about the vector store.

Show child fields
knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.metadata_field

The name of the field in which Amazon Bedrock stores metadata about the vector store.

knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.text_field

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.vector_field

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

knowledge_base.storage_configuration.opensearch_serverless_configuration.vector_index_name

The name of the vector store.

knowledge_base.storage_configuration.pinecone_configuration

Contains the storage configuration of the knowledge base in Pinecone.

Show child fields
knowledge_base.storage_configuration.pinecone_configuration.connection_string

The endpoint URL for your index management page.

knowledge_base.storage_configuration.pinecone_configuration.credentials_secret_arn

The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.

knowledge_base.storage_configuration.pinecone_configuration.field_mapping

Contains the names of the fields to which to map information about the vector store.

Show child fields
knowledge_base.storage_configuration.pinecone_configuration.field_mapping.metadata_field

The name of the field in which Amazon Bedrock stores metadata about the vector store.

knowledge_base.storage_configuration.pinecone_configuration.field_mapping.text_field

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

knowledge_base.storage_configuration.pinecone_configuration.namespace

The namespace to be used to write new data to your database.

knowledge_base.storage_configuration.rds_configuration

Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.

Show child fields
knowledge_base.storage_configuration.rds_configuration.credentials_secret_arn

The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.

knowledge_base.storage_configuration.rds_configuration.database_name

The name of your Amazon RDS database.

knowledge_base.storage_configuration.rds_configuration.field_mapping

Contains the names of the fields to which to map information about the vector store.

Show child fields
knowledge_base.storage_configuration.rds_configuration.field_mapping.metadata_field

The name of the field in which Amazon Bedrock stores metadata about the vector store.

knowledge_base.storage_configuration.rds_configuration.field_mapping.primary_key_field

The name of the field in which Amazon Bedrock stores the ID for each entry.

knowledge_base.storage_configuration.rds_configuration.field_mapping.text_field

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

knowledge_base.storage_configuration.rds_configuration.field_mapping.vector_field

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

knowledge_base.storage_configuration.rds_configuration.resource_arn

The Amazon Resource Name (ARN) of the vector store.

knowledge_base.storage_configuration.rds_configuration.table_name

The name of the table in the database.

knowledge_base.storage_configuration.redis_enterprise_cloud_configuration

Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.

Show child fields
knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.credentials_secret_arn

The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.

knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.endpoint

The endpoint URL of the Redis Enterprise Cloud database.

knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping

Contains the names of the fields to which to map information about the vector store.

Show child fields
knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.metadata_field

The name of the field in which Amazon Bedrock stores metadata about the vector store.

knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.text_field

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.vector_field

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.vector_index_name

The name of the vector index.

knowledge_base.storage_configuration.type

The vector store service in which the knowledge base is stored.

knowledge_base.updated_at

The time at which the knowledge base was last updated.