Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. bedrock
  5. getKnowledgeBase

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.bedrock.getKnowledgeBase

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Bedrock::KnowledgeBase Resource Type

    Using getKnowledgeBase

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getKnowledgeBase(args: GetKnowledgeBaseArgs, opts?: InvokeOptions): Promise<GetKnowledgeBaseResult>
function getKnowledgeBaseOutput(args: GetKnowledgeBaseOutputArgs, opts?: InvokeOptions): Output<GetKnowledgeBaseResult>
    def get_knowledge_base(knowledge_base_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetKnowledgeBaseResult
def get_knowledge_base_output(knowledge_base_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetKnowledgeBaseResult]
    func LookupKnowledgeBase(ctx *Context, args *LookupKnowledgeBaseArgs, opts ...InvokeOption) (*LookupKnowledgeBaseResult, error)
func LookupKnowledgeBaseOutput(ctx *Context, args *LookupKnowledgeBaseOutputArgs, opts ...InvokeOption) LookupKnowledgeBaseResultOutput

    > Note: This function is named LookupKnowledgeBase in the Go SDK.

    public static class GetKnowledgeBase 
{
    public static Task<GetKnowledgeBaseResult> InvokeAsync(GetKnowledgeBaseArgs args, InvokeOptions? opts = null)
    public static Output<GetKnowledgeBaseResult> Invoke(GetKnowledgeBaseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKnowledgeBaseResult> getKnowledgeBase(GetKnowledgeBaseArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:bedrock:getKnowledgeBase
  arguments:
    # arguments dictionary

    The following arguments are supported:

    KnowledgeBaseId string
    The unique identifier of the knowledge base.
    KnowledgeBaseId string
    The unique identifier of the knowledge base.
    knowledgeBaseId String
    The unique identifier of the knowledge base.
    knowledgeBaseId string
    The unique identifier of the knowledge base.
    knowledge_base_id str
    The unique identifier of the knowledge base.
    knowledgeBaseId String
    The unique identifier of the knowledge base.

    getKnowledgeBase Result

    The following output properties are available:

    CreatedAt string
    The time at which the knowledge base was created.
    Description string
    Description of the Resource.
    FailureReasons List<string>
    A list of reasons that the API operation on the knowledge base failed.
    KnowledgeBaseArn string
    The ARN of the knowledge base.
    KnowledgeBaseConfiguration Pulumi.AwsNative.Bedrock.Outputs.KnowledgeBaseConfiguration
    Contains details about the embeddings configuration of the knowledge base.
    KnowledgeBaseId string
    The unique identifier of the knowledge base.
    Name string
    The name of the knowledge base.
    RoleArn string
    The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
    Status Pulumi.AwsNative.Bedrock.KnowledgeBaseStatus
    The status of the knowledge base.
    Tags Dictionary<string, string>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    UpdatedAt string
    The time at which the knowledge base was last updated.
    CreatedAt string
    The time at which the knowledge base was created.
    Description string
    Description of the Resource.
    FailureReasons []string
    A list of reasons that the API operation on the knowledge base failed.
    KnowledgeBaseArn string
    The ARN of the knowledge base.
    KnowledgeBaseConfiguration KnowledgeBaseConfiguration
    Contains details about the embeddings configuration of the knowledge base.
    KnowledgeBaseId string
    The unique identifier of the knowledge base.
    Name string
    The name of the knowledge base.
    RoleArn string
    The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
    Status KnowledgeBaseStatus
    The status of the knowledge base.
    Tags map[string]string
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    UpdatedAt string
    The time at which the knowledge base was last updated.
    createdAt String
    The time at which the knowledge base was created.
    description String
    Description of the Resource.
    failureReasons List<String>
    A list of reasons that the API operation on the knowledge base failed.
    knowledgeBaseArn String
    The ARN of the knowledge base.
    knowledgeBaseConfiguration KnowledgeBaseConfiguration
    Contains details about the embeddings configuration of the knowledge base.
    knowledgeBaseId String
    The unique identifier of the knowledge base.
    name String
    The name of the knowledge base.
    roleArn String
    The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
    status KnowledgeBaseStatus
    The status of the knowledge base.
    tags Map<String,String>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updatedAt String
    The time at which the knowledge base was last updated.
    createdAt string
    The time at which the knowledge base was created.
    description string
    Description of the Resource.
    failureReasons string[]
    A list of reasons that the API operation on the knowledge base failed.
    knowledgeBaseArn string
    The ARN of the knowledge base.
    knowledgeBaseConfiguration KnowledgeBaseConfiguration
    Contains details about the embeddings configuration of the knowledge base.
    knowledgeBaseId string
    The unique identifier of the knowledge base.
    name string
    The name of the knowledge base.
    roleArn string
    The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
    status KnowledgeBaseStatus
    The status of the knowledge base.
    tags {[key: string]: string}
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updatedAt string
    The time at which the knowledge base was last updated.
    created_at str
    The time at which the knowledge base was created.
    description str
    Description of the Resource.
    failure_reasons Sequence[str]
    A list of reasons that the API operation on the knowledge base failed.
    knowledge_base_arn str
    The ARN of the knowledge base.
    knowledge_base_configuration KnowledgeBaseConfiguration
    Contains details about the embeddings configuration of the knowledge base.
    knowledge_base_id str
    The unique identifier of the knowledge base.
    name str
    The name of the knowledge base.
    role_arn str
    The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
    status KnowledgeBaseStatus
    The status of the knowledge base.
    tags Mapping[str, str]
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updated_at str
    The time at which the knowledge base was last updated.
    createdAt String
    The time at which the knowledge base was created.
    description String
    Description of the Resource.
    failureReasons List<String>
    A list of reasons that the API operation on the knowledge base failed.
    knowledgeBaseArn String
    The ARN of the knowledge base.
    knowledgeBaseConfiguration Property Map
    Contains details about the embeddings configuration of the knowledge base.
    knowledgeBaseId String
    The unique identifier of the knowledge base.
    name String
    The name of the knowledge base.
    roleArn String
    The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
    status "CREATING" | "ACTIVE" | "DELETING" | "UPDATING" | "FAILED" | "DELETE_UNSUCCESSFUL"
    The status of the knowledge base.
    tags Map<String>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updatedAt String
    The time at which the knowledge base was last updated.

    Supporting Types

    KnowledgeBaseBedrockEmbeddingModelConfiguration

    Dimensions int
    The dimensions details for the vector configuration used on the Bedrock embeddings model.
    Dimensions int
    The dimensions details for the vector configuration used on the Bedrock embeddings model.
    dimensions Integer
    The dimensions details for the vector configuration used on the Bedrock embeddings model.
    dimensions number
    The dimensions details for the vector configuration used on the Bedrock embeddings model.
    dimensions int
    The dimensions details for the vector configuration used on the Bedrock embeddings model.
    dimensions Number
    The dimensions details for the vector configuration used on the Bedrock embeddings model.

    KnowledgeBaseConfiguration

    Type KnowledgeBaseType
    The type of data that the data source is converted into for the knowledge base.
    KendraKnowledgeBaseConfiguration KnowledgeBaseKendraKnowledgeBaseConfiguration
    Settings for an Amazon Kendra knowledge base.
    SqlKnowledgeBaseConfiguration KnowledgeBaseSqlKnowledgeBaseConfiguration
    VectorKnowledgeBaseConfiguration KnowledgeBaseVectorKnowledgeBaseConfiguration
    Contains details about the model that's used to convert the data source into vector embeddings.
    type KnowledgeBaseType
    The type of data that the data source is converted into for the knowledge base.
    kendraKnowledgeBaseConfiguration KnowledgeBaseKendraKnowledgeBaseConfiguration
    Settings for an Amazon Kendra knowledge base.
    sqlKnowledgeBaseConfiguration KnowledgeBaseSqlKnowledgeBaseConfiguration
    vectorKnowledgeBaseConfiguration KnowledgeBaseVectorKnowledgeBaseConfiguration
    Contains details about the model that's used to convert the data source into vector embeddings.
    type KnowledgeBaseType
    The type of data that the data source is converted into for the knowledge base.
    kendraKnowledgeBaseConfiguration KnowledgeBaseKendraKnowledgeBaseConfiguration
    Settings for an Amazon Kendra knowledge base.
    sqlKnowledgeBaseConfiguration KnowledgeBaseSqlKnowledgeBaseConfiguration
    vectorKnowledgeBaseConfiguration KnowledgeBaseVectorKnowledgeBaseConfiguration
    Contains details about the model that's used to convert the data source into vector embeddings.
    type KnowledgeBaseType
    The type of data that the data source is converted into for the knowledge base.
    kendra_knowledge_base_configuration KnowledgeBaseKendraKnowledgeBaseConfiguration
    Settings for an Amazon Kendra knowledge base.
    sql_knowledge_base_configuration KnowledgeBaseSqlKnowledgeBaseConfiguration
    vector_knowledge_base_configuration KnowledgeBaseVectorKnowledgeBaseConfiguration
    Contains details about the model that's used to convert the data source into vector embeddings.
    type "VECTOR" | "KENDRA" | "SQL"
    The type of data that the data source is converted into for the knowledge base.
    kendraKnowledgeBaseConfiguration Property Map
    Settings for an Amazon Kendra knowledge base.
    sqlKnowledgeBaseConfiguration Property Map
    vectorKnowledgeBaseConfiguration Property Map
    Contains details about the model that's used to convert the data source into vector embeddings.

    KnowledgeBaseCuratedQuery

    NaturalLanguage string
    Sql string
    NaturalLanguage string
    Sql string
    naturalLanguage String
    sql String
    naturalLanguage string
    sql string
    naturalLanguage String
    sql String

    KnowledgeBaseEmbeddingModelConfiguration

    BedrockEmbeddingModelConfiguration KnowledgeBaseBedrockEmbeddingModelConfiguration
    The vector configuration details on the Bedrock embeddings model.
    bedrockEmbeddingModelConfiguration KnowledgeBaseBedrockEmbeddingModelConfiguration
    The vector configuration details on the Bedrock embeddings model.
    bedrockEmbeddingModelConfiguration KnowledgeBaseBedrockEmbeddingModelConfiguration
    The vector configuration details on the Bedrock embeddings model.
    bedrock_embedding_model_configuration KnowledgeBaseBedrockEmbeddingModelConfiguration
    The vector configuration details on the Bedrock embeddings model.
    bedrockEmbeddingModelConfiguration Property Map
    The vector configuration details on the Bedrock embeddings model.

    KnowledgeBaseInclusionType

    KnowledgeBaseKendraKnowledgeBaseConfiguration

    KendraIndexArn string
    The ARN of the Amazon Kendra index.
    KendraIndexArn string
    The ARN of the Amazon Kendra index.
    kendraIndexArn String
    The ARN of the Amazon Kendra index.
    kendraIndexArn string
    The ARN of the Amazon Kendra index.
    kendra_index_arn str
    The ARN of the Amazon Kendra index.
    kendraIndexArn String
    The ARN of the Amazon Kendra index.

    KnowledgeBaseQueryEngineType

    KnowledgeBaseQueryGenerationColumn

    KnowledgeBaseQueryGenerationConfiguration

    KnowledgeBaseQueryGenerationContext

    KnowledgeBaseQueryGenerationTable

    KnowledgeBaseRedshiftConfiguration

    KnowledgeBaseRedshiftProvisionedAuthConfiguration

    KnowledgeBaseRedshiftProvisionedAuthType

    KnowledgeBaseRedshiftProvisionedConfiguration

    KnowledgeBaseRedshiftQueryEngineAwsDataCatalogStorageConfiguration

    TableNames List<string>
    TableNames []string
    tableNames List<String>
    tableNames string[]
    table_names Sequence[str]
    tableNames List<String>

    KnowledgeBaseRedshiftQueryEngineConfiguration

    KnowledgeBaseRedshiftQueryEngineRedshiftStorageConfiguration

    KnowledgeBaseRedshiftQueryEngineStorageConfiguration

    KnowledgeBaseRedshiftQueryEngineStorageType

    KnowledgeBaseRedshiftQueryEngineType

    KnowledgeBaseRedshiftServerlessAuthConfiguration

    KnowledgeBaseRedshiftServerlessAuthType

    KnowledgeBaseRedshiftServerlessConfiguration

    KnowledgeBaseS3Location

    Uri string
    The location's URI
    Uri string
    The location's URI
    uri String
    The location's URI
    uri string
    The location's URI
    uri str
    The location's URI
    uri String
    The location's URI

    KnowledgeBaseSqlKnowledgeBaseConfiguration

    KnowledgeBaseStatus

    KnowledgeBaseSupplementalDataStorageConfiguration

    KnowledgeBaseSupplementalDataStorageLocation

    KnowledgeBaseSupplementalDataStorageLocationType

    KnowledgeBaseType

    KnowledgeBaseVectorKnowledgeBaseConfiguration

    EmbeddingModelArn string
    The ARN of the model used to create vector embeddings for the knowledge base.
    EmbeddingModelConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseEmbeddingModelConfiguration
    The embeddings model configuration details for the vector model used in Knowledge Base.
    SupplementalDataStorageConfiguration Pulumi.AwsNative.Bedrock.Inputs.KnowledgeBaseSupplementalDataStorageConfiguration
    If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate .
    EmbeddingModelArn string
    The ARN of the model used to create vector embeddings for the knowledge base.
    EmbeddingModelConfiguration KnowledgeBaseEmbeddingModelConfiguration
    The embeddings model configuration details for the vector model used in Knowledge Base.
    SupplementalDataStorageConfiguration KnowledgeBaseSupplementalDataStorageConfiguration
    If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate .
    embeddingModelArn String
    The ARN of the model used to create vector embeddings for the knowledge base.
    embeddingModelConfiguration KnowledgeBaseEmbeddingModelConfiguration
    The embeddings model configuration details for the vector model used in Knowledge Base.
    supplementalDataStorageConfiguration KnowledgeBaseSupplementalDataStorageConfiguration
    If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate .
    embeddingModelArn string
    The ARN of the model used to create vector embeddings for the knowledge base.
    embeddingModelConfiguration KnowledgeBaseEmbeddingModelConfiguration
    The embeddings model configuration details for the vector model used in Knowledge Base.
    supplementalDataStorageConfiguration KnowledgeBaseSupplementalDataStorageConfiguration
    If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate .
    embedding_model_arn str
    The ARN of the model used to create vector embeddings for the knowledge base.
    embedding_model_configuration KnowledgeBaseEmbeddingModelConfiguration
    The embeddings model configuration details for the vector model used in Knowledge Base.
    supplemental_data_storage_configuration KnowledgeBaseSupplementalDataStorageConfiguration
    If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate .
    embeddingModelArn String
    The ARN of the model used to create vector embeddings for the knowledge base.
    embeddingModelConfiguration Property Map
    The embeddings model configuration details for the vector model used in Knowledge Base.
    supplementalDataStorageConfiguration Property Map
    If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate .

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi
    pulumi/pulumi-aws-native