AWS v6.54.0, Sep 27 24

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

aws.kendra.getQuerySuggestionsBlockList

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.getQuerySuggestionsBlockList({
    indexId: "12345678-1234-1234-1234-123456789123",
    querySuggestionsBlockListId: "87654321-1234-4321-4321-321987654321",
});

import pulumi
import pulumi_aws as aws

example = aws.kendra.get_query_suggestions_block_list(index_id="12345678-1234-1234-1234-123456789123",
    query_suggestions_block_list_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.LookupQuerySuggestionsBlockList(ctx, &kendra.LookupQuerySuggestionsBlockListArgs{
			IndexId:                     "12345678-1234-1234-1234-123456789123",
			QuerySuggestionsBlockListId: "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.GetQuerySuggestionsBlockList.Invoke(new()
    {
        IndexId = "12345678-1234-1234-1234-123456789123",
        QuerySuggestionsBlockListId = "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.GetQuerySuggestionsBlockListArgs;
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.getQuerySuggestionsBlockList(GetQuerySuggestionsBlockListArgs.builder()
            .indexId("12345678-1234-1234-1234-123456789123")
            .querySuggestionsBlockListId("87654321-1234-4321-4321-321987654321")
            .build());

    }
}

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

Using getQuerySuggestionsBlockList

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 getQuerySuggestionsBlockList(args: GetQuerySuggestionsBlockListArgs, opts?: InvokeOptions): Promise<GetQuerySuggestionsBlockListResult>
function getQuerySuggestionsBlockListOutput(args: GetQuerySuggestionsBlockListOutputArgs, opts?: InvokeOptions): Output<GetQuerySuggestionsBlockListResult>

def get_query_suggestions_block_list(index_id: Optional[str] = None,
                                     query_suggestions_block_list_id: Optional[str] = None,
                                     tags: Optional[Mapping[str, str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetQuerySuggestionsBlockListResult
def get_query_suggestions_block_list_output(index_id: Optional[pulumi.Input[str]] = None,
                                     query_suggestions_block_list_id: Optional[pulumi.Input[str]] = None,
                                     tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetQuerySuggestionsBlockListResult]

func LookupQuerySuggestionsBlockList(ctx *Context, args *LookupQuerySuggestionsBlockListArgs, opts ...InvokeOption) (*LookupQuerySuggestionsBlockListResult, error)
func LookupQuerySuggestionsBlockListOutput(ctx *Context, args *LookupQuerySuggestionsBlockListOutputArgs, opts ...InvokeOption) LookupQuerySuggestionsBlockListResultOutput

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

public static class GetQuerySuggestionsBlockList 
{
    public static Task<GetQuerySuggestionsBlockListResult> InvokeAsync(GetQuerySuggestionsBlockListArgs args, InvokeOptions? opts = null)
    public static Output<GetQuerySuggestionsBlockListResult> Invoke(GetQuerySuggestionsBlockListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetQuerySuggestionsBlockListResult> getQuerySuggestionsBlockList(GetQuerySuggestionsBlockListArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

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

IndexId string: Identifier of the index that contains the block list.
QuerySuggestionsBlockListId string: Identifier of the block list.
Tags map[string]string: Metadata that helps organize the block list you create.

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

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

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

indexId String: Identifier of the index that contains the block list.
querySuggestionsBlockListId String: Identifier of the block list.
tags Map<String>: Metadata that helps organize the block list you create.

getQuerySuggestionsBlockList Result

The following output properties are available:

Arn string: ARN of the block list.
CreatedAt string: Date-time a block list was created.
Description string: Description for the block list.
ErrorMessage string: Error message containing details if there are issues processing the block list.
FileSizeBytes int: Current size of the block list text file in S3.
Id string: The provider-assigned unique ID for this managed resource.
IndexId string
ItemCount int: Current number of valid, non-empty words or phrases in the block list text file.
Name string: Name of the block list.
QuerySuggestionsBlockListId string
RoleArn string: ARN of a role with permission to access the S3 bucket that contains the block list. For more information, see IAM Roles for Amazon Kendra.
SourceS3Paths List<GetQuerySuggestionsBlockListSourceS3Path>: S3 location of the block list input data. Detailed below.
Status string: Current status of the block list. When the value is ACTIVE, the block list is ready for use.
Tags Dictionary<string, string>: Metadata that helps organize the block list you create.
UpdatedAt string: Date and time that the block list was last updated.

Arn string: ARN of the block list.
CreatedAt string: Date-time a block list was created.
Description string: Description for the block list.
ErrorMessage string: Error message containing details if there are issues processing the block list.
FileSizeBytes int: Current size of the block list text file in S3.
Id string: The provider-assigned unique ID for this managed resource.
IndexId string
ItemCount int: Current number of valid, non-empty words or phrases in the block list text file.
Name string: Name of the block list.
QuerySuggestionsBlockListId string
RoleArn string: ARN of a role with permission to access the S3 bucket that contains the block list. For more information, see IAM Roles for Amazon Kendra.
SourceS3Paths []GetQuerySuggestionsBlockListSourceS3Path: S3 location of the block list input data. Detailed below.
Status string: Current status of the block list. When the value is ACTIVE, the block list is ready for use.
Tags map[string]string: Metadata that helps organize the block list you create.
UpdatedAt string: Date and time that the block list was last updated.

arn String: ARN of the block list.
createdAt String: Date-time a block list was created.
description String: Description for the block list.
errorMessage String: Error message containing details if there are issues processing the block list.
fileSizeBytes Integer: Current size of the block list text file in S3.
id String: The provider-assigned unique ID for this managed resource.
indexId String
itemCount Integer: Current number of valid, non-empty words or phrases in the block list text file.
name String: Name of the block list.
querySuggestionsBlockListId String
roleArn String: ARN of a role with permission to access the S3 bucket that contains the block list. For more information, see IAM Roles for Amazon Kendra.
sourceS3Paths List<GetQuerySuggestionsBlockListSourceS3Path>: S3 location of the block list input data. Detailed below.
status String: Current status of the block list. When the value is ACTIVE, the block list is ready for use.
tags Map<String,String>: Metadata that helps organize the block list you create.
updatedAt String: Date and time that the block list was last updated.

arn string: ARN of the block list.
createdAt string: Date-time a block list was created.
description string: Description for the block list.
errorMessage string: Error message containing details if there are issues processing the block list.
fileSizeBytes number: Current size of the block list text file in S3.
id string: The provider-assigned unique ID for this managed resource.
indexId string
itemCount number: Current number of valid, non-empty words or phrases in the block list text file.
name string: Name of the block list.
querySuggestionsBlockListId string
roleArn string: ARN of a role with permission to access the S3 bucket that contains the block list. For more information, see IAM Roles for Amazon Kendra.
sourceS3Paths GetQuerySuggestionsBlockListSourceS3Path[]: S3 location of the block list input data. Detailed below.
status string: Current status of the block list. When the value is ACTIVE, the block list is ready for use.
tags {[key: string]: string}: Metadata that helps organize the block list you create.
updatedAt string: Date and time that the block list was last updated.

arn str: ARN of the block list.
created_at str: Date-time a block list was created.
description str: Description for the block list.
error_message str: Error message containing details if there are issues processing the block list.
file_size_bytes int: Current size of the block list text file in S3.
id str: The provider-assigned unique ID for this managed resource.
index_id str
item_count int: Current number of valid, non-empty words or phrases in the block list text file.
name str: Name of the block list.
query_suggestions_block_list_id str
role_arn str: ARN of a role with permission to access the S3 bucket that contains the block list. For more information, see IAM Roles for Amazon Kendra.
source_s3_paths Sequence[GetQuerySuggestionsBlockListSourceS3Path]: S3 location of the block list input data. Detailed below.
status str: Current status of the block list. When the value is ACTIVE, the block list is ready for use.
tags Mapping[str, str]: Metadata that helps organize the block list you create.
updated_at str: Date and time that the block list was last updated.

arn String: ARN of the block list.
createdAt String: Date-time a block list was created.
description String: Description for the block list.
errorMessage String: Error message containing details if there are issues processing the block list.
fileSizeBytes Number: Current size of the block list text file in S3.
id String: The provider-assigned unique ID for this managed resource.
indexId String
itemCount Number: Current number of valid, non-empty words or phrases in the block list text file.
name String: Name of the block list.
querySuggestionsBlockListId String
roleArn String: ARN of a role with permission to access the S3 bucket that contains the block list. For more information, see IAM Roles for Amazon Kendra.
sourceS3Paths List<Property Map>: S3 location of the block list input data. Detailed below.
status String: Current status of the block list. When the value is ACTIVE, the block list is ready for use.
tags Map<String>: Metadata that helps organize the block list you create.
updatedAt String: Date and time that the block list was last updated.

Supporting Types

GetQuerySuggestionsBlockListSourceS3Path

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.getQuerySuggestionsBlockList

On this page

On this page

Example Usage

Using getQuerySuggestionsBlockList

getQuerySuggestionsBlockList Result

Supporting Types

GetQuerySuggestionsBlockListSourceS3Path

Package Details

On this page

On this page