Struct CreateQuerySuggestionsBlockListInput 

#[non_exhaustive]
pub struct CreateQuerySuggestionsBlockListInput {
    pub index_id: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub source_s3_path: Option<S3Path>,
    pub client_token: Option<String>,
    pub role_arn: Option<String>,
    pub tags: Option<Vec<Tag>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

index_id: Option<String>

The identifier of the index you want to create a query suggestions block list for.

name: Option<String>

A name for the block list.

For example, the name 'offensive-words', which includes all offensive words that could appear in user queries and need to be blocked from suggestions.

description: Option<String>

A description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

source_s3_path: Option<S3Path>

The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

client_token: Option<String>

A token that you provide to identify the request to create a query suggestions block list.

role_arn: Option<String>

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the block list text file. For more information, see IAM access roles for Amazon Kendra.

tags: Option<Vec<Tag>>

A list of key-value pairs that identify or categorize the block list. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Implementations

impl CreateQuerySuggestionsBlockListInput

pub fn index_id(&self) -> Option<&str>

The identifier of the index you want to create a query suggestions block list for.

pub fn name(&self) -> Option<&str>

A name for the block list.

For example, the name 'offensive-words', which includes all offensive words that could appear in user queries and need to be blocked from suggestions.

pub fn description(&self) -> Option<&str>

A description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

pub fn source_s3_path(&self) -> Option<&S3Path>

The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

pub fn client_token(&self) -> Option<&str>

A token that you provide to identify the request to create a query suggestions block list.

pub fn role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the block list text file. For more information, see IAM access roles for Amazon Kendra.

pub fn tags(&self) -> &[Tag]

A list of key-value pairs that identify or categorize the block list. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

impl CreateQuerySuggestionsBlockListInput

pub fn builder() -> CreateQuerySuggestionsBlockListInputBuilder

Creates a new builder-style object to manufacture CreateQuerySuggestionsBlockListInput.

Trait Implementations

impl Clone for CreateQuerySuggestionsBlockListInput

fn clone(&self) -> CreateQuerySuggestionsBlockListInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateQuerySuggestionsBlockListInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateQuerySuggestionsBlockListInput

fn eq(&self, other: &CreateQuerySuggestionsBlockListInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateQuerySuggestionsBlockListInput