AWS v6.54.0, Sep 27 24

AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

aws.kendra.getThesaurus

Explore with Pulumi AI

AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.kendra.getThesaurus({
    indexId: "12345678-1234-1234-1234-123456789123",
    thesaurusId: "87654321-1234-4321-4321-321987654321",
});

import pulumi
import pulumi_aws as aws

example = aws.kendra.get_thesaurus(index_id="12345678-1234-1234-1234-123456789123",
    thesaurus_id="87654321-1234-4321-4321-321987654321")

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.LookupThesaurus(ctx, &kendra.LookupThesaurusArgs{
			IndexId:     "12345678-1234-1234-1234-123456789123",
			ThesaurusId: "87654321-1234-4321-4321-321987654321",
		}, 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 example = Aws.Kendra.GetThesaurus.Invoke(new()
    {
        IndexId = "12345678-1234-1234-1234-123456789123",
        ThesaurusId = "87654321-1234-4321-4321-321987654321",
    });

});

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.GetThesaurusArgs;
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 example = KendraFunctions.getThesaurus(GetThesaurusArgs.builder()
            .indexId("12345678-1234-1234-1234-123456789123")
            .thesaurusId("87654321-1234-4321-4321-321987654321")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      Function: aws:kendra:getThesaurus
      Arguments:
        indexId: 12345678-1234-1234-1234-123456789123
        thesaurusId: 87654321-1234-4321-4321-321987654321

Using getThesaurus

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 getThesaurus(args: GetThesaurusArgs, opts?: InvokeOptions): Promise<GetThesaurusResult>
function getThesaurusOutput(args: GetThesaurusOutputArgs, opts?: InvokeOptions): Output<GetThesaurusResult>

def get_thesaurus(index_id: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  thesaurus_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetThesaurusResult
def get_thesaurus_output(index_id: Optional[pulumi.Input[str]] = None,
                  tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                  thesaurus_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetThesaurusResult]

func LookupThesaurus(ctx *Context, args *LookupThesaurusArgs, opts ...InvokeOption) (*LookupThesaurusResult, error)
func LookupThesaurusOutput(ctx *Context, args *LookupThesaurusOutputArgs, opts ...InvokeOption) LookupThesaurusResultOutput

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

public static class GetThesaurus 
{
    public static Task<GetThesaurusResult> InvokeAsync(GetThesaurusArgs args, InvokeOptions? opts = null)
    public static Output<GetThesaurusResult> Invoke(GetThesaurusInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetThesaurusResult> getThesaurus(GetThesaurusArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:kendra/getThesaurus:getThesaurus
  arguments:
    # arguments dictionary

The following arguments are supported:

IndexId string: Identifier of the index that contains the Thesaurus.
ThesaurusId string: Identifier of the Thesaurus.
Tags Dictionary<string, string>: Metadata that helps organize the Thesaurus you create.

IndexId string: Identifier of the index that contains the Thesaurus.
ThesaurusId string: Identifier of the Thesaurus.
Tags map[string]string: Metadata that helps organize the Thesaurus you create.

indexId String: Identifier of the index that contains the Thesaurus.
thesaurusId String: Identifier of the Thesaurus.
tags Map<String,String>: Metadata that helps organize the Thesaurus you create.

indexId string: Identifier of the index that contains the Thesaurus.
thesaurusId string: Identifier of the Thesaurus.
tags {[key: string]: string}: Metadata that helps organize the Thesaurus you create.

index_id str: Identifier of the index that contains the Thesaurus.
thesaurus_id str: Identifier of the Thesaurus.
tags Mapping[str, str]: Metadata that helps organize the Thesaurus you create.

indexId String: Identifier of the index that contains the Thesaurus.
thesaurusId String: Identifier of the Thesaurus.
tags Map<String>: Metadata that helps organize the Thesaurus you create.

getThesaurus Result

The following output properties are available:

Arn string: ARN of the Thesaurus.
CreatedAt string: Unix datetime that the Thesaurus was created.
Description string: Description of the Thesaurus.
ErrorMessage string: When the status field value is FAILED, this contains a message that explains why.
FileSizeBytes int: Size of the Thesaurus file in bytes.
Id string: The provider-assigned unique ID for this managed resource.
IndexId string
Name string: Name of the Thesaurus.
RoleArn string: ARN of a role with permission to access the S3 bucket that contains the Thesaurus. For more information, see IAM Roles for Amazon Kendra.
SourceS3Paths List<GetThesaurusSourceS3Path>: S3 location of the Thesaurus input data. Detailed below.
Status string: Status of the Thesaurus. It is ready to use when the status is ACTIVE.
SynonymRuleCount int: Number of synonym rules in the Thesaurus file.
Tags Dictionary<string, string>: Metadata that helps organize the Thesaurus you create.
TermCount int: Number of unique terms in the Thesaurus file. For example, the synonyms a,b,c and a=>d, the term count would be 4.
ThesaurusId string
UpdatedAt string: Date and time that the Thesaurus was last updated.

Arn string: ARN of the Thesaurus.
CreatedAt string: Unix datetime that the Thesaurus was created.
Description string: Description of the Thesaurus.
ErrorMessage string: When the status field value is FAILED, this contains a message that explains why.
FileSizeBytes int: Size of the Thesaurus file in bytes.
Id string: The provider-assigned unique ID for this managed resource.
IndexId string
Name string: Name of the Thesaurus.
RoleArn string: ARN of a role with permission to access the S3 bucket that contains the Thesaurus. For more information, see IAM Roles for Amazon Kendra.
SourceS3Paths []GetThesaurusSourceS3Path: S3 location of the Thesaurus input data. Detailed below.
Status string: Status of the Thesaurus. It is ready to use when the status is ACTIVE.
SynonymRuleCount int: Number of synonym rules in the Thesaurus file.
Tags map[string]string: Metadata that helps organize the Thesaurus you create.
TermCount int: Number of unique terms in the Thesaurus file. For example, the synonyms a,b,c and a=>d, the term count would be 4.
ThesaurusId string
UpdatedAt string: Date and time that the Thesaurus was last updated.

arn String: ARN of the Thesaurus.
createdAt String: Unix datetime that the Thesaurus was created.
description String: Description of the Thesaurus.
errorMessage String: When the status field value is FAILED, this contains a message that explains why.
fileSizeBytes Integer: Size of the Thesaurus file in bytes.
id String: The provider-assigned unique ID for this managed resource.
indexId String
name String: Name of the Thesaurus.
roleArn String: ARN of a role with permission to access the S3 bucket that contains the Thesaurus. For more information, see IAM Roles for Amazon Kendra.
sourceS3Paths List<GetThesaurusSourceS3Path>: S3 location of the Thesaurus input data. Detailed below.
status String: Status of the Thesaurus. It is ready to use when the status is ACTIVE.
synonymRuleCount Integer: Number of synonym rules in the Thesaurus file.
tags Map<String,String>: Metadata that helps organize the Thesaurus you create.
termCount Integer: Number of unique terms in the Thesaurus file. For example, the synonyms a,b,c and a=>d, the term count would be 4.
thesaurusId String
updatedAt String: Date and time that the Thesaurus was last updated.

arn string: ARN of the Thesaurus.
createdAt string: Unix datetime that the Thesaurus was created.
description string: Description of the Thesaurus.
errorMessage string: When the status field value is FAILED, this contains a message that explains why.
fileSizeBytes number: Size of the Thesaurus file in bytes.
id string: The provider-assigned unique ID for this managed resource.
indexId string
name string: Name of the Thesaurus.
roleArn string: ARN of a role with permission to access the S3 bucket that contains the Thesaurus. For more information, see IAM Roles for Amazon Kendra.
sourceS3Paths GetThesaurusSourceS3Path[]: S3 location of the Thesaurus input data. Detailed below.
status string: Status of the Thesaurus. It is ready to use when the status is ACTIVE.
synonymRuleCount number: Number of synonym rules in the Thesaurus file.
tags {[key: string]: string}: Metadata that helps organize the Thesaurus you create.
termCount number: Number of unique terms in the Thesaurus file. For example, the synonyms a,b,c and a=>d, the term count would be 4.
thesaurusId string
updatedAt string: Date and time that the Thesaurus was last updated.

arn str: ARN of the Thesaurus.
created_at str: Unix datetime that the Thesaurus was created.
description str: Description of the Thesaurus.
error_message str: When the status field value is FAILED, this contains a message that explains why.
file_size_bytes int: Size of the Thesaurus file in bytes.
id str: The provider-assigned unique ID for this managed resource.
index_id str
name str: Name of the Thesaurus.
role_arn str: ARN of a role with permission to access the S3 bucket that contains the Thesaurus. For more information, see IAM Roles for Amazon Kendra.
source_s3_paths Sequence[GetThesaurusSourceS3Path]: S3 location of the Thesaurus input data. Detailed below.
status str: Status of the Thesaurus. It is ready to use when the status is ACTIVE.
synonym_rule_count int: Number of synonym rules in the Thesaurus file.
tags Mapping[str, str]: Metadata that helps organize the Thesaurus you create.
term_count int: Number of unique terms in the Thesaurus file. For example, the synonyms a,b,c and a=>d, the term count would be 4.
thesaurus_id str
updated_at str: Date and time that the Thesaurus was last updated.

arn String: ARN of the Thesaurus.
createdAt String: Unix datetime that the Thesaurus was created.
description String: Description of the Thesaurus.
errorMessage String: When the status field value is FAILED, this contains a message that explains why.
fileSizeBytes Number: Size of the Thesaurus file in bytes.
id String: The provider-assigned unique ID for this managed resource.
indexId String
name String: Name of the Thesaurus.
roleArn String: ARN of a role with permission to access the S3 bucket that contains the Thesaurus. For more information, see IAM Roles for Amazon Kendra.
sourceS3Paths List<Property Map>: S3 location of the Thesaurus input data. Detailed below.
status String: Status of the Thesaurus. It is ready to use when the status is ACTIVE.
synonymRuleCount Number: Number of synonym rules in the Thesaurus file.
tags Map<String>: Metadata that helps organize the Thesaurus you create.
termCount Number: Number of unique terms in the Thesaurus file. For example, the synonyms a,b,c and a=>d, the term count would be 4.
thesaurusId String
updatedAt String: Date and time that the Thesaurus was last updated.

Supporting Types

GetThesaurusSourceS3Path

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 v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

pulumi/pulumi-aws

aws.kendra.getThesaurus

On this page

On this page

Example Usage

Using getThesaurus

getThesaurus Result

Supporting Types

GetThesaurusSourceS3Path

Package Details

On this page

On this page