Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. bedrock
  5. getKnowledgeBase

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.bedrock.getKnowledgeBase

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 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.
    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.
    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.
    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.
    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_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.
    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

    KnowledgeBaseStatus

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native