AWS Classic
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:
getFaq Result
The following output properties are available:
- Arn string
The Amazon Resource Name (ARN) of the FAQ.
- Created
At string The Unix datetime that the faq was created.
- Description string
The description of the FAQ.
- Error
Message string When the
status
field value isFAILED
, this contains a message that explains why.- Faq
Id string - File
Format 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.
- Index
Id string - Language
Code 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.
- Role
Arn 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<Get
Faq S3Path> 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.
- Dictionary<string, string>
Metadata that helps organize the FAQs you create.
- Updated
At string The date and time that the FAQ was last updated.
- Arn string
The Amazon Resource Name (ARN) of the FAQ.
- Created
At string The Unix datetime that the faq was created.
- Description string
The description of the FAQ.
- Error
Message string When the
status
field value isFAILED
, this contains a message that explains why.- Faq
Id string - File
Format 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.
- Index
Id string - Language
Code 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.
- Role
Arn 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
[]Get
Faq S3Path 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.
- map[string]string
Metadata that helps organize the FAQs you create.
- Updated
At string The date and time that the FAQ was last updated.
- arn String
The Amazon Resource Name (ARN) of the FAQ.
- created
At String The Unix datetime that the faq was created.
- description String
The description of the FAQ.
- error
Message String When the
status
field value isFAILED
, this contains a message that explains why.- faq
Id String - file
Format 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.
- index
Id String - language
Code 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.
- role
Arn 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<Get
Faq S3Path> 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.
- Map<String,String>
Metadata that helps organize the FAQs you create.
- updated
At String The date and time that the FAQ was last updated.
- arn string
The Amazon Resource Name (ARN) of the FAQ.
- created
At string The Unix datetime that the faq was created.
- description string
The description of the FAQ.
- error
Message string When the
status
field value isFAILED
, this contains a message that explains why.- faq
Id string - file
Format 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.
- index
Id string - language
Code 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.
- role
Arn 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
Get
Faq S3Path[] 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.
- {[key: string]: string}
Metadata that helps organize the FAQs you create.
- updated
At 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 isFAILED
, 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[GetFaq S3Path] 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.
- 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.
- created
At String The Unix datetime that the faq was created.
- description String
The description of the FAQ.
- error
Message String When the
status
field value isFAILED
, this contains a message that explains why.- faq
Id String - file
Format 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.
- index
Id String - language
Code 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.
- role
Arn 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.
- Map<String>
Metadata that helps organize the FAQs you create.
- updated
At String The date and time that the FAQ was last updated.
Supporting Types
GetFaqS3Path
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.