AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

getFaq

Provides details about a specific Amazon Kendra Faq.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var test = Output.Create(Aws.Kendra.GetFaq.InvokeAsync(new Aws.Kendra.GetFaqArgs
        {
            FaqId = "87654321-1234-4321-4321-321987654321",
            IndexId = "12345678-1234-1234-1234-123456789123",
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test = Output.of(KendraFunctions.getFaq(GetFaqArgs.builder()
            .faqId("87654321-1234-4321-4321-321987654321")
            .indexId("12345678-1234-1234-1234-123456789123")
            .build()));

    }
}
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")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = pulumi.output(aws.kendra.getFaq({
    faqId: "87654321-1234-4321-4321-321987654321",
    indexId: "12345678-1234-1234-1234-123456789123",
}));
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

The identifier of the FAQ.

IndexId string

The identifier of the index that contains the FAQ.

Tags Dictionary<string, string>

Metadata that helps organize the FAQs you create.

FaqId string

The identifier of the FAQ.

IndexId string

The identifier of the index that contains the FAQ.

Tags map[string]string

Metadata that helps organize the FAQs you create.

faqId String

The identifier of the FAQ.

indexId String

The identifier of the index that contains the FAQ.

tags Map<String,String>

Metadata that helps organize the FAQs you create.

faqId string

The identifier of the FAQ.

indexId string

The identifier of the index that contains the FAQ.

tags {[key: string]: string}

Metadata that helps organize the FAQs you create.

faq_id str

The identifier of the FAQ.

index_id str

The identifier of the index that contains the FAQ.

tags Mapping[str, str]

Metadata that helps organize the FAQs you create.

faqId String

The identifier of the FAQ.

indexId String

The 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

The Amazon Resource Name (ARN) of the FAQ.

CreatedAt string

The Unix datetime that the faq was created.

Description string

The description of the FAQ.

ErrorMessage string

When the status field value is FAILED, this contains a message that explains why.

FaqId string
FileFormat string

The 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

The 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

Specifies the name of the FAQ.

RoleArn string

The Amazon Resource Name (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>

The S3 location of the FAQ input data. Detailed below.

Status string

The 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

The date and time that the FAQ was last updated.

Arn string

The Amazon Resource Name (ARN) of the FAQ.

CreatedAt string

The Unix datetime that the faq was created.

Description string

The description of the FAQ.

ErrorMessage string

When the status field value is FAILED, this contains a message that explains why.

FaqId string
FileFormat string

The 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

The 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

Specifies the name of the FAQ.

RoleArn string

The Amazon Resource Name (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

The S3 location of the FAQ input data. Detailed below.

Status string

The 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

The date and time that the FAQ was last updated.

arn String

The Amazon Resource Name (ARN) of the FAQ.

createdAt String

The Unix datetime that the faq was created.

description String

The description of the FAQ.

errorMessage String

When the status field value is FAILED, this contains a message that explains why.

faqId String
fileFormat String

The 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

The 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

Specifies the name of the FAQ.

roleArn String

The Amazon Resource Name (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>

The S3 location of the FAQ input data. Detailed below.

status String

The 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

The date and time that the FAQ was last updated.

arn string

The Amazon Resource Name (ARN) of the FAQ.

createdAt string

The Unix datetime that the faq was created.

description string

The description of the FAQ.

errorMessage string

When the status field value is FAILED, this contains a message that explains why.

faqId string
fileFormat string

The 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

The 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

Specifies the name of the FAQ.

roleArn string

The Amazon Resource Name (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[]

The S3 location of the FAQ input data. Detailed below.

status string

The 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

The date and time that the FAQ was last updated.

arn str

The Amazon Resource Name (ARN) of the FAQ.

created_at str

The Unix datetime that the faq was created.

description str

The 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

The 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

The 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

Specifies the name of the FAQ.

role_arn str

The Amazon Resource Name (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]

The S3 location of the FAQ input data. Detailed below.

status str

The 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

The date and time that the FAQ was last updated.

arn String

The Amazon Resource Name (ARN) of the FAQ.

createdAt String

The Unix datetime that the faq was created.

description String

The description of the FAQ.

errorMessage String

When the status field value is FAILED, this contains a message that explains why.

faqId String
fileFormat String

The 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

The 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

Specifies the name of the FAQ.

roleArn String

The Amazon Resource Name (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>

The S3 location of the FAQ input data. Detailed below.

status String

The 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

The date and time that the FAQ was last updated.

Supporting Types

GetFaqS3Path

Bucket string

The name of the S3 bucket that contains the file.

Key string

The name of the file.

Bucket string

The name of the S3 bucket that contains the file.

Key string

The name of the file.

bucket String

The name of the S3 bucket that contains the file.

key String

The name of the file.

bucket string

The name of the S3 bucket that contains the file.

key string

The name of the file.

bucket str

The name of the S3 bucket that contains the file.

key str

The name of the file.

bucket String

The name of the S3 bucket that contains the file.

key String

The name of the file.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.