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

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi

aws.kendra.getFaq

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi

    Provides details about a specific Amazon Kendra Faq.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const test = aws.kendra.getFaq({
        faqId: "87654321-1234-4321-4321-321987654321",
        indexId: "12345678-1234-1234-1234-123456789123",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    test = aws.kendra.get_faq(faq_id="87654321-1234-4321-4321-321987654321",
        index_id="12345678-1234-1234-1234-123456789123")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kendra"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := kendra.LookupFaq(ctx, &kendra.LookupFaqArgs{
    			FaqId:   "87654321-1234-4321-4321-321987654321",
    			IndexId: "12345678-1234-1234-1234-123456789123",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Aws.Kendra.GetFaq.Invoke(new()
        {
            FaqId = "87654321-1234-4321-4321-321987654321",
            IndexId = "12345678-1234-1234-1234-123456789123",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.kendra.KendraFunctions;
    import com.pulumi.aws.kendra.inputs.GetFaqArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var test = KendraFunctions.getFaq(GetFaqArgs.builder()
                .faqId("87654321-1234-4321-4321-321987654321")
                .indexId("12345678-1234-1234-1234-123456789123")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          Function: aws:kendra:getFaq
          Arguments:
            faqId: 87654321-1234-4321-4321-321987654321
            indexId: 12345678-1234-1234-1234-123456789123
    

    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(faq_id: Optional[str] = None,
                index_id: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetFaqResult
    def get_faq_output(faq_id: Optional[pulumi.Input[str]] = None,
                index_id: Optional[pulumi.Input[str]] = None,
                tags: Optional[pulumi.Input[Mapping[str, 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:kendra/getFaq:getFaq
      arguments:
        # arguments dictionary

    The following arguments are supported:

    FaqId string
    Identifier of the FAQ.
    IndexId string
    Identifier of the index that contains the FAQ.
    Tags Dictionary<string, string>
    Metadata that helps organize the FAQs you create.
    FaqId string
    Identifier of the FAQ.
    IndexId string
    Identifier of the index that contains the FAQ.
    Tags map[string]string
    Metadata that helps organize the FAQs you create.
    faqId String
    Identifier of the FAQ.
    indexId String
    Identifier of the index that contains the FAQ.
    tags Map<String,String>
    Metadata that helps organize the FAQs you create.
    faqId string
    Identifier of the FAQ.
    indexId string
    Identifier of the index that contains the FAQ.
    tags {[key: string]: string}
    Metadata that helps organize the FAQs you create.
    faq_id str
    Identifier of the FAQ.
    index_id str
    Identifier of the index that contains the FAQ.
    tags Mapping[str, str]
    Metadata that helps organize the FAQs you create.
    faqId String
    Identifier of the FAQ.
    indexId String
    Identifier of the index that contains the FAQ.
    tags Map<String>
    Metadata that helps organize the FAQs you create.

    getFaq Result

    The following output properties are available:

    Arn string
    ARN of the FAQ.
    CreatedAt string
    Unix datetime that the faq was created.
    Description string
    Description of the FAQ.
    ErrorMessage string
    When the status field value is FAILED, this contains a message that explains why.
    FaqId string
    FileFormat string
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    Id string
    The provider-assigned unique ID for this managed resource.
    IndexId string
    LanguageCode string
    Code for a language. This shows a supported language for the FAQ document. For more information on supported languages, including their codes, see Adding documents in languages other than English.
    Name string
    Name of the FAQ.
    RoleArn string
    ARN of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.
    S3Paths List<GetFaqS3Path>
    S3 location of the FAQ input data. Detailed below.
    Status string
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    Tags Dictionary<string, string>
    Metadata that helps organize the FAQs you create.
    UpdatedAt string
    Date and time that the FAQ was last updated.
    Arn string
    ARN of the FAQ.
    CreatedAt string
    Unix datetime that the faq was created.
    Description string
    Description of the FAQ.
    ErrorMessage string
    When the status field value is FAILED, this contains a message that explains why.
    FaqId string
    FileFormat string
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    Id string
    The provider-assigned unique ID for this managed resource.
    IndexId string
    LanguageCode string
    Code for a language. This shows a supported language for the FAQ document. For more information on supported languages, including their codes, see Adding documents in languages other than English.
    Name string
    Name of the FAQ.
    RoleArn string
    ARN of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.
    S3Paths []GetFaqS3Path
    S3 location of the FAQ input data. Detailed below.
    Status string
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    Tags map[string]string
    Metadata that helps organize the FAQs you create.
    UpdatedAt string
    Date and time that the FAQ was last updated.
    arn String
    ARN of the FAQ.
    createdAt String
    Unix datetime that the faq was created.
    description String
    Description of the FAQ.
    errorMessage String
    When the status field value is FAILED, this contains a message that explains why.
    faqId String
    fileFormat String
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    id String
    The provider-assigned unique ID for this managed resource.
    indexId String
    languageCode String
    Code for a language. This shows a supported language for the FAQ document. For more information on supported languages, including their codes, see Adding documents in languages other than English.
    name String
    Name of the FAQ.
    roleArn String
    ARN of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.
    s3Paths List<GetFaqS3Path>
    S3 location of the FAQ input data. Detailed below.
    status String
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    tags Map<String,String>
    Metadata that helps organize the FAQs you create.
    updatedAt String
    Date and time that the FAQ was last updated.
    arn string
    ARN of the FAQ.
    createdAt string
    Unix datetime that the faq was created.
    description string
    Description of the FAQ.
    errorMessage string
    When the status field value is FAILED, this contains a message that explains why.
    faqId string
    fileFormat string
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    id string
    The provider-assigned unique ID for this managed resource.
    indexId string
    languageCode string
    Code for a language. This shows a supported language for the FAQ document. For more information on supported languages, including their codes, see Adding documents in languages other than English.
    name string
    Name of the FAQ.
    roleArn string
    ARN of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.
    s3Paths GetFaqS3Path[]
    S3 location of the FAQ input data. Detailed below.
    status string
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    tags {[key: string]: string}
    Metadata that helps organize the FAQs you create.
    updatedAt string
    Date and time that the FAQ was last updated.
    arn str
    ARN of the FAQ.
    created_at str
    Unix datetime that the faq was created.
    description str
    Description of the FAQ.
    error_message str
    When the status field value is FAILED, this contains a message that explains why.
    faq_id str
    file_format str
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    id str
    The provider-assigned unique ID for this managed resource.
    index_id str
    language_code str
    Code for a language. This shows a supported language for the FAQ document. For more information on supported languages, including their codes, see Adding documents in languages other than English.
    name str
    Name of the FAQ.
    role_arn str
    ARN of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.
    s3_paths Sequence[GetFaqS3Path]
    S3 location of the FAQ input data. Detailed below.
    status str
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    tags Mapping[str, str]
    Metadata that helps organize the FAQs you create.
    updated_at str
    Date and time that the FAQ was last updated.
    arn String
    ARN of the FAQ.
    createdAt String
    Unix datetime that the faq was created.
    description String
    Description of the FAQ.
    errorMessage String
    When the status field value is FAILED, this contains a message that explains why.
    faqId String
    fileFormat String
    File format used by the input files for the FAQ. Valid Values are CSV, CSV_WITH_HEADER, JSON.
    id String
    The provider-assigned unique ID for this managed resource.
    indexId String
    languageCode String
    Code for a language. This shows a supported language for the FAQ document. For more information on supported languages, including their codes, see Adding documents in languages other than English.
    name String
    Name of the FAQ.
    roleArn String
    ARN of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.
    s3Paths List<Property Map>
    S3 location of the FAQ input data. Detailed below.
    status String
    Status of the FAQ. It is ready to use when the status is ACTIVE.
    tags Map<String>
    Metadata that helps organize the FAQs you create.
    updatedAt String
    Date and time that the FAQ was last updated.

    Supporting Types

    GetFaqS3Path

    Bucket string
    Name of the S3 bucket that contains the file.
    Key string
    Name of the file.
    Bucket string
    Name of the S3 bucket that contains the file.
    Key string
    Name of the file.
    bucket String
    Name of the S3 bucket that contains the file.
    key String
    Name of the file.
    bucket string
    Name of the S3 bucket that contains the file.
    key string
    Name of the file.
    bucket str
    Name of the S3 bucket that contains the file.
    key str
    Name of the file.
    bucket String
    Name of the S3 bucket that contains the file.
    key String
    Name of the file.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi