Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. kendra
  6. getQuerySuggestionsBlockList

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.76.0
published on Monday, Aug 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.kendra.getQuerySuggestionsBlockList

aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.76.0
published on Monday, Aug 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    A block list used for query suggestions for an Amazon Kendra index. A block list contains words or phrases that should not appear as query suggestions.

    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?: InvokeOutputOptions): Output<GetQuerySuggestionsBlockListResult>
    def get_query_suggestions_block_list(arn: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetQuerySuggestionsBlockListResult
def get_query_suggestions_block_list_output(arn: pulumi.Input[Optional[str]] = None,
                                     opts: Optional[InvokeOutputOptions] = 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 Output<GetQuerySuggestionsBlockListResult> Invoke(GetQuerySuggestionsBlockListInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetQuerySuggestionsBlockListResult> getQuerySuggestionsBlockList(GetQuerySuggestionsBlockListArgs args, InvokeOptions options)
public static Output<GetQuerySuggestionsBlockListResult> getQuerySuggestionsBlockList(GetQuerySuggestionsBlockListArgs args, InvokeOptions options)
public static Output<GetQuerySuggestionsBlockListResult> getQuerySuggestionsBlockList(GetQuerySuggestionsBlockListArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:kendra:getQuerySuggestionsBlockList
  arguments:
    # arguments dictionary
    data "aws-native_kendra_get_query_suggestions_block_list" "name" {
    # arguments
}

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the query suggestions block list.
    Arn string
    The Amazon Resource Name (ARN) of the query suggestions block list.
    arn string
    The Amazon Resource Name (ARN) of the query suggestions block list.
    arn String
    The Amazon Resource Name (ARN) of the query suggestions block list.
    arn string
    The Amazon Resource Name (ARN) of the query suggestions block list.
    arn str
    The Amazon Resource Name (ARN) of the query suggestions block list.
    arn String
    The Amazon Resource Name (ARN) of the query suggestions block list.

    getQuerySuggestionsBlockList Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the query suggestions block list.
    Description string
    A description for the block list.
    Id string
    The identifier of the block list.
    Name string
    The name of the block list.
    RoleArn string
    The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file.
    SourceS3Path Pulumi.AwsNative.Kendra.Outputs.QuerySuggestionsBlockListS3Path
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of key-value pairs that identify or categorize the block list.
    Arn string
    The Amazon Resource Name (ARN) of the query suggestions block list.
    Description string
    A description for the block list.
    Id string
    The identifier of the block list.
    Name string
    The name of the block list.
    RoleArn string
    The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file.
    SourceS3Path QuerySuggestionsBlockListS3Path
    Tags Tag
    A list of key-value pairs that identify or categorize the block list.
    arn string
    The Amazon Resource Name (ARN) of the query suggestions block list.
    description string
    A description for the block list.
    id string
    The identifier of the block list.
    name string
    The name of the block list.
    role_arn string
    The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file.
    source_s3_path object
    tags list(object)
    A list of key-value pairs that identify or categorize the block list.
    arn String
    The Amazon Resource Name (ARN) of the query suggestions block list.
    description String
    A description for the block list.
    id String
    The identifier of the block list.
    name String
    The name of the block list.
    roleArn String
    The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file.
    sourceS3Path QuerySuggestionsBlockListS3Path
    tags List<Tag>
    A list of key-value pairs that identify or categorize the block list.
    arn string
    The Amazon Resource Name (ARN) of the query suggestions block list.
    description string
    A description for the block list.
    id string
    The identifier of the block list.
    name string
    The name of the block list.
    roleArn string
    The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file.
    sourceS3Path QuerySuggestionsBlockListS3Path
    tags Tag[]
    A list of key-value pairs that identify or categorize the block list.
    arn str
    The Amazon Resource Name (ARN) of the query suggestions block list.
    description str
    A description for the block list.
    id str
    The identifier of the block list.
    name str
    The name of the block list.
    role_arn str
    The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file.
    source_s3_path QuerySuggestionsBlockListS3Path
    tags Sequence[root_Tag]
    A list of key-value pairs that identify or categorize the block list.
    arn String
    The Amazon Resource Name (ARN) of the query suggestions block list.
    description String
    A description for the block list.
    id String
    The identifier of the block list.
    name String
    The name of the block list.
    roleArn String
    The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file.
    sourceS3Path Property Map
    tags List<Property Map>
    A list of key-value pairs that identify or categorize the block list.

    Supporting Types

    QuerySuggestionsBlockListS3Path

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

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.76.0
    published on Monday, Aug 24, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial