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

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

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.

    Create QuerySuggestionsBlockList Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new QuerySuggestionsBlockList(name: string, args: QuerySuggestionsBlockListArgs, opts?: CustomResourceOptions);
    @overload
def QuerySuggestionsBlockList(resource_name: str,
                              args: QuerySuggestionsBlockListArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def QuerySuggestionsBlockList(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              index_id: Optional[str] = None,
                              role_arn: Optional[str] = None,
                              source_s3_path: Optional[QuerySuggestionsBlockListS3PathArgs] = None,
                              description: Optional[str] = None,
                              name: Optional[str] = None,
                              tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewQuerySuggestionsBlockList(ctx *Context, name string, args QuerySuggestionsBlockListArgs, opts ...ResourceOption) (*QuerySuggestionsBlockList, error)
    public QuerySuggestionsBlockList(string name, QuerySuggestionsBlockListArgs args, CustomResourceOptions? opts = null)
    public QuerySuggestionsBlockList(String name, QuerySuggestionsBlockListArgs args)
public QuerySuggestionsBlockList(String name, QuerySuggestionsBlockListArgs args, CustomResourceOptions options)

    type: aws-native:kendra:QuerySuggestionsBlockList
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws-native_kendra_query_suggestions_block_list" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args QuerySuggestionsBlockListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args QuerySuggestionsBlockListArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args QuerySuggestionsBlockListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args QuerySuggestionsBlockListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args QuerySuggestionsBlockListArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    QuerySuggestionsBlockList Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The QuerySuggestionsBlockList resource accepts the following input properties:

    IndexId string
    The identifier of the index for 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.Inputs.QuerySuggestionsBlockListS3Path
    Description string
    A description for the block list.
    Name string
    The name of the block list.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of key-value pairs that identify or categorize the block list.
    IndexId string
    The identifier of the index for 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 QuerySuggestionsBlockListS3PathArgs
    Description string
    A description for the block list.
    Name string
    The name of the block list.
    Tags TagArgs
    A list of key-value pairs that identify or categorize the block list.
    index_id string
    The identifier of the index for 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
    description string
    A description for the block list.
    name string
    The name of the block list.
    tags list(object)
    A list of key-value pairs that identify or categorize the block list.
    indexId String
    The identifier of the index for 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
    description String
    A description for the block list.
    name String
    The name of the block list.
    tags List<Tag>
    A list of key-value pairs that identify or categorize the block list.
    indexId string
    The identifier of the index for 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
    description string
    A description for the block list.
    name string
    The name of the block list.
    tags Tag[]
    A list of key-value pairs that identify or categorize the block list.
    index_id str
    The identifier of the index for 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 QuerySuggestionsBlockListS3PathArgs
    description str
    A description for the block list.
    name str
    The name of the block list.
    tags Sequence[TagArgs]
    A list of key-value pairs that identify or categorize the block list.
    indexId String
    The identifier of the index for 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
    description String
    A description for the block list.
    name String
    The name of the block list.
    tags List<Property Map>
    A list of key-value pairs that identify or categorize the block list.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the QuerySuggestionsBlockList resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the query suggestions block list.
    AwsId string
    The identifier of the block list.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the query suggestions block list.
    AwsId string
    The identifier of the block list.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the query suggestions block list.
    aws_id string
    The identifier of the block list.
    id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the query suggestions block list.
    awsId String
    The identifier of the block list.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the query suggestions block list.
    awsId string
    The identifier of the block list.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the query suggestions block list.
    aws_id str
    The identifier of the block list.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the query suggestions block list.
    awsId String
    The identifier of the block list.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    QuerySuggestionsBlockListS3Path, QuerySuggestionsBlockListS3PathArgs

    Information required to find a specific file in an Amazon S3 bucket.
    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, TagArgs

    A set of tags to apply to the resource.
    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