@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
75 lines (74 loc) • 2.58 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Definition of AWS::Bedrock::KnowledgeBase Resource Type
*/
export declare function getKnowledgeBase(args: GetKnowledgeBaseArgs, opts?: pulumi.InvokeOptions): Promise<GetKnowledgeBaseResult>;
export interface GetKnowledgeBaseArgs {
/**
* The unique identifier of the knowledge base.
*/
knowledgeBaseId: string;
}
export interface GetKnowledgeBaseResult {
/**
* The time at which the knowledge base was created.
*/
readonly createdAt?: string;
/**
* Description of the Resource.
*/
readonly description?: string;
/**
* A list of reasons that the API operation on the knowledge base failed.
*/
readonly failureReasons?: string[];
/**
* The ARN of the knowledge base.
*/
readonly knowledgeBaseArn?: string;
/**
* Contains details about the embeddings configuration of the knowledge base.
*/
readonly knowledgeBaseConfiguration?: outputs.bedrock.KnowledgeBaseConfiguration;
/**
* The unique identifier of the knowledge base.
*/
readonly knowledgeBaseId?: string;
/**
* The name of the knowledge base.
*/
readonly name?: string;
/**
* The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
*/
readonly roleArn?: string;
/**
* The status of the knowledge base.
*/
readonly status?: enums.bedrock.KnowledgeBaseStatus;
/**
* Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
*
* - [Tag naming limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions)
* - [Tagging best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices)
*/
readonly tags?: {
[key: string]: string;
};
/**
* The time at which the knowledge base was last updated.
*/
readonly updatedAt?: string;
}
/**
* Definition of AWS::Bedrock::KnowledgeBase Resource Type
*/
export declare function getKnowledgeBaseOutput(args: GetKnowledgeBaseOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetKnowledgeBaseResult>;
export interface GetKnowledgeBaseOutputArgs {
/**
* The unique identifier of the knowledge base.
*/
knowledgeBaseId: pulumi.Input<string>;
}