@pulumi/aws/kendra/getQuerySuggestionsBlockList.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Provides details about a specific Amazon Kendra block list used for query suggestions for an index.
 *
 * ## Example Usage
 *
 * ```typescript
 * 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",
 * });
 * ```
 */
export declare function getQuerySuggestionsBlockList(args: GetQuerySuggestionsBlockListArgs, opts?: pulumi.InvokeOptions): Promise<GetQuerySuggestionsBlockListResult>;
/**
 * A collection of arguments for invoking getQuerySuggestionsBlockList.
 */
export interface GetQuerySuggestionsBlockListArgs {
    /**
     * Identifier of the index that contains the block list.
     */
    indexId: string;
    /**
     * Identifier of the block list.
     */
    querySuggestionsBlockListId: string;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    /**
     * Metadata that helps organize the block list you create.
     */
    tags?: {
        [key: string]: string;
    };
}
/**
 * A collection of values returned by getQuerySuggestionsBlockList.
 */
export interface GetQuerySuggestionsBlockListResult {
    /**
     * ARN of the block list.
     */
    readonly arn: string;
    /**
     * Date-time a block list was created.
     */
    readonly createdAt: string;
    /**
     * Description for the block list.
     */
    readonly description: string;
    /**
     * Error message containing details if there are issues processing the block list.
     */
    readonly errorMessage: string;
    /**
     * Current size of the block list text file in S3.
     */
    readonly fileSizeBytes: number;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly indexId: string;
    /**
     * Current number of valid, non-empty words or phrases in the block list text file.
     */
    readonly itemCount: number;
    /**
     * Name of the block list.
     */
    readonly name: string;
    readonly querySuggestionsBlockListId: string;
    readonly region: 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](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
     */
    readonly roleArn: string;
    /**
     * S3 location of the block list input data. Detailed below.
     */
    readonly sourceS3Paths: outputs.kendra.GetQuerySuggestionsBlockListSourceS3Path[];
    /**
     * Current status of the block list. When the value is `ACTIVE`, the block list is ready for use.
     */
    readonly status: string;
    /**
     * Metadata that helps organize the block list you create.
     */
    readonly tags: {
        [key: string]: string;
    };
    /**
     * Date and time that the block list was last updated.
     */
    readonly updatedAt: string;
}
/**
 * Provides details about a specific Amazon Kendra block list used for query suggestions for an index.
 *
 * ## Example Usage
 *
 * ```typescript
 * 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",
 * });
 * ```
 */
export declare function getQuerySuggestionsBlockListOutput(args: GetQuerySuggestionsBlockListOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetQuerySuggestionsBlockListResult>;
/**
 * A collection of arguments for invoking getQuerySuggestionsBlockList.
 */
export interface GetQuerySuggestionsBlockListOutputArgs {
    /**
     * Identifier of the index that contains the block list.
     */
    indexId: pulumi.Input<string>;
    /**
     * Identifier of the block list.
     */
    querySuggestionsBlockListId: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * Metadata that helps organize the block list you create.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}