We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi
aws-native.bedrock.getKnowledgeBase
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi
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:
- Knowledge
Base stringId - The unique identifier of the knowledge base.
- Knowledge
Base stringId - The unique identifier of the knowledge base.
- knowledge
Base StringId - The unique identifier of the knowledge base.
- knowledge
Base stringId - The unique identifier of the knowledge base.
- knowledge_
base_ strid - The unique identifier of the knowledge base.
- knowledge
Base StringId - The unique identifier of the knowledge base.
getKnowledgeBase Result
The following output properties are available:
- Created
At string - The time at which the knowledge base was created.
- Description string
- Description of the Resource.
- Failure
Reasons List<string> - A list of reasons that the API operation on the knowledge base failed.
- Knowledge
Base stringArn - The ARN of the knowledge base.
- Knowledge
Base stringId - The unique identifier of the knowledge base.
- Name string
- The name of the knowledge base.
- Role
Arn 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.
Aws Native. Bedrock. Knowledge Base Status - The status of the knowledge base.
- Dictionary<string, string>
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- Updated
At string - The time at which the knowledge base was last updated.
- Created
At string - The time at which the knowledge base was created.
- Description string
- Description of the Resource.
- Failure
Reasons []string - A list of reasons that the API operation on the knowledge base failed.
- Knowledge
Base stringArn - The ARN of the knowledge base.
- Knowledge
Base stringId - The unique identifier of the knowledge base.
- Name string
- The name of the knowledge base.
- Role
Arn string - The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
- Status
Knowledge
Base Status - The status of the knowledge base.
- map[string]string
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- Updated
At string - The time at which the knowledge base was last updated.
- created
At String - The time at which the knowledge base was created.
- description String
- Description of the Resource.
- failure
Reasons List<String> - A list of reasons that the API operation on the knowledge base failed.
- knowledge
Base StringArn - The ARN of the knowledge base.
- knowledge
Base StringId - The unique identifier of the knowledge base.
- name String
- The name of the knowledge base.
- role
Arn String - The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
- status
Knowledge
Base Status - The status of the knowledge base.
- Map<String,String>
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- updated
At String - The time at which the knowledge base was last updated.
- created
At string - The time at which the knowledge base was created.
- description string
- Description of the Resource.
- failure
Reasons string[] - A list of reasons that the API operation on the knowledge base failed.
- knowledge
Base stringArn - The ARN of the knowledge base.
- knowledge
Base stringId - The unique identifier of the knowledge base.
- name string
- The name of the knowledge base.
- role
Arn string - The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
- status
Knowledge
Base Status - The status of the knowledge base.
- {[key: string]: string}
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- updated
At 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_ strarn - The ARN of the knowledge base.
- knowledge_
base_ strid - 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
Knowledge
Base Status - The status of the knowledge base.
- 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.
- created
At String - The time at which the knowledge base was created.
- description String
- Description of the Resource.
- failure
Reasons List<String> - A list of reasons that the API operation on the knowledge base failed.
- knowledge
Base StringArn - The ARN of the knowledge base.
- knowledge
Base StringId - The unique identifier of the knowledge base.
- name String
- The name of the knowledge base.
- role
Arn 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.
- Map<String>
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
- updated
At 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
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi