aws-native.wisdom.getKnowledgeBase

Explore with Pulumi AI

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

pulumi/pulumi-aws-native

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:wisdom:getKnowledgeBase
  arguments:
    # arguments dictionary

The following arguments are supported:

KnowledgeBaseId string: The ID of the knowledge base.

KnowledgeBaseId string: The ID of the knowledge base.

knowledgeBaseId String: The ID of the knowledge base.

knowledgeBaseId string: The ID of the knowledge base.

knowledge_base_id str: The ID of the knowledge base.

knowledgeBaseId String: The ID of the knowledge base.

getKnowledgeBase Result

The following output properties are available:

KnowledgeBaseArn string: The Amazon Resource Name (ARN) of the knowledge base.
KnowledgeBaseId string: The ID of the knowledge base.
RenderingConfiguration Pulumi.AwsNative.Wisdom.Outputs.KnowledgeBaseRenderingConfiguration: Information about how to render the content.

KnowledgeBaseArn string: The Amazon Resource Name (ARN) of the knowledge base.
KnowledgeBaseId string: The ID of the knowledge base.
RenderingConfiguration KnowledgeBaseRenderingConfiguration: Information about how to render the content.

knowledgeBaseArn String: The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId String: The ID of the knowledge base.
renderingConfiguration KnowledgeBaseRenderingConfiguration: Information about how to render the content.

knowledgeBaseArn string: The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId string: The ID of the knowledge base.
renderingConfiguration KnowledgeBaseRenderingConfiguration: Information about how to render the content.

knowledge_base_arn str: The Amazon Resource Name (ARN) of the knowledge base.
knowledge_base_id str: The ID of the knowledge base.
rendering_configuration KnowledgeBaseRenderingConfiguration: Information about how to render the content.

knowledgeBaseArn String: The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId String: The ID of the knowledge base.
renderingConfiguration Property Map: Information about how to render the content.

Supporting Types

KnowledgeBaseRenderingConfiguration

TemplateUri string

A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
Zendesk: id , title , updated_at , or draft