1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. kendra
  5. getFaq

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.kendra.getFaq

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    A Kendra FAQ resource

    Using getFaq

    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 getFaq(args: GetFaqArgs, opts?: InvokeOptions): Promise<GetFaqResult>
    function getFaqOutput(args: GetFaqOutputArgs, opts?: InvokeOptions): Output<GetFaqResult>
    def get_faq(id: Optional[str] = None,
                index_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetFaqResult
    def get_faq_output(id: Optional[pulumi.Input[str]] = None,
                index_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetFaqResult]
    func LookupFaq(ctx *Context, args *LookupFaqArgs, opts ...InvokeOption) (*LookupFaqResult, error)
    func LookupFaqOutput(ctx *Context, args *LookupFaqOutputArgs, opts ...InvokeOption) LookupFaqResultOutput

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

    public static class GetFaq 
    {
        public static Task<GetFaqResult> InvokeAsync(GetFaqArgs args, InvokeOptions? opts = null)
        public static Output<GetFaqResult> Invoke(GetFaqInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFaqResult> getFaq(GetFaqArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:kendra:getFaq
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    IndexId string
    Index ID
    Id string

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    IndexId string
    Index ID
    id String

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    indexId String
    Index ID
    id string

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    indexId string
    Index ID
    id str

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    index_id str
    Index ID
    id String

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    indexId String
    Index ID

    getFaq Result

    The following output properties are available:

    Arn string
    arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
    Id string

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    LanguageCode string
    The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Tags for labeling the FAQ
    Arn string
    arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
    Id string

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    LanguageCode string
    The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .
    Tags Tag
    Tags for labeling the FAQ
    arn String
    arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
    id String

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    languageCode String
    The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .
    tags List<Tag>
    Tags for labeling the FAQ
    arn string
    arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
    id string

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    languageCode string
    The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .
    tags Tag[]
    Tags for labeling the FAQ
    arn str
    arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
    id str

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    language_code str
    The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .
    tags Sequence[root_Tag]
    Tags for labeling the FAQ
    arn String
    arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
    id String

    The identifier for the FAQ. For example:

    f61995a6-cd5c-4e99-9cfc-58816d8bfaa7

    languageCode String
    The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .
    tags List<Property Map>
    Tags for labeling the FAQ

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    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.9.0 published on Monday, Nov 18, 2024 by Pulumi