Skip to content

CreateKnowledgeBaseRequest

Source code in docs_src/capo_bedrock_agent/types/create_knowledge_base_request.py
class CreateKnowledgeBaseRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_bedrock_agent.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>"""
    name: "capo_bedrock_agent.types.name.Name"
    """<p>A name for the knowledge base.</p>"""
    description: NotRequired["capo_bedrock_agent.types.description.Description"]
    """<p>A description of the knowledge base.</p>"""
    role_arn: "capo_bedrock_agent.types.knowledge_base_role_arn.KnowledgeBaseRoleArn"
    """<p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>"""
    knowledge_base_configuration: "capo_bedrock_agent.types.knowledge_base_configuration.KnowledgeBaseConfiguration"
    """<p>Contains details about the embeddings model used for the knowledge base.</p>"""
    storage_configuration: NotRequired[
        "capo_bedrock_agent.types.storage_configuration.StorageConfiguration"
    ]
    """<p>Contains details about the configuration of the vector database used for the knowledge base.</p>"""
    tags: NotRequired["capo_bedrock_agent.types.tags_map.TagsMap"]
    """<p>Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

description instance-attribute

description: NotRequired[Description]

A description of the knowledge base.

knowledge_base_configuration instance-attribute

knowledge_base_configuration: KnowledgeBaseConfiguration

Contains details about the embeddings model used for the knowledge base.

name instance-attribute

name: Name

A name for the knowledge base.

role_arn instance-attribute

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

storage_configuration instance-attribute

storage_configuration: NotRequired[StorageConfiguration]

Contains details about the configuration of the vector database used for the knowledge base.

tags instance-attribute

tags: NotRequired[TagsMap]

Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.