amazonka-kendra-2.0: Amazon KendraFrontendService SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Kendra.CreateQuerySuggestionsBlockList

Description

Creates a block list to exlcude certain queries from suggestions.

Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.

You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.

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

CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.

Synopsis

Creating a Request

data CreateQuerySuggestionsBlockList Source #

See: newCreateQuerySuggestionsBlockList smart constructor.

Constructors

CreateQuerySuggestionsBlockList' 

Fields

  • clientToken :: Maybe Text

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

  • description :: Maybe Text

    A user-friendly 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."

  • tags :: Maybe [Tag]

    A tag that you can assign to a block list that categorizes the block list.

  • indexId :: Text

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

  • name :: Text

    A user friendly name for the block list.

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

  • sourceS3Path :: 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.

  • roleArn :: Text

    The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

    You need permissions to the role ARN (Amazon Web Services Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Instances

Instances details
ToJSON CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Methods

toJSON :: CreateQuerySuggestionsBlockList -> Value #

toEncoding :: CreateQuerySuggestionsBlockList -> Encoding #

toJSONList :: [CreateQuerySuggestionsBlockList] -> Value #

toEncodingList :: [CreateQuerySuggestionsBlockList] -> Encoding #

ToHeaders CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Methods

toHeaders :: CreateQuerySuggestionsBlockList -> [Header] #

ToPath CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Methods

toPath :: CreateQuerySuggestionsBlockList -> ByteString #

ToQuery CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Methods

toQuery :: CreateQuerySuggestionsBlockList -> QueryString #

AWSRequest CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Associated Types

type AWSResponse CreateQuerySuggestionsBlockList #

Methods

request :: (Service -> Service) -> CreateQuerySuggestionsBlockList -> Request CreateQuerySuggestionsBlockList #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateQuerySuggestionsBlockList -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateQuerySuggestionsBlockList))) #

Generic CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Associated Types

type Rep CreateQuerySuggestionsBlockList :: Type -> Type #

Methods

from :: CreateQuerySuggestionsBlockList -> Rep CreateQuerySuggestionsBlockList x #

to :: Rep CreateQuerySuggestionsBlockList x -> CreateQuerySuggestionsBlockList #

Read CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Methods

readsPrec :: Int -> ReadS CreateQuerySuggestionsBlockList #

readList :: ReadS [CreateQuerySuggestionsBlockList] #

readPrec :: ReadPrec CreateQuerySuggestionsBlockList #

readListPrec :: ReadPrec [CreateQuerySuggestionsBlockList] #

Show CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Methods

showsPrec :: Int -> CreateQuerySuggestionsBlockList -> ShowS #

show :: CreateQuerySuggestionsBlockList -> String #

showList :: [CreateQuerySuggestionsBlockList] -> ShowS #

NFData CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Methods

rnf :: CreateQuerySuggestionsBlockList -> () #

Eq CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Methods

(==) :: CreateQuerySuggestionsBlockList -> CreateQuerySuggestionsBlockList -> Bool #

(/=) :: CreateQuerySuggestionsBlockList -> CreateQuerySuggestionsBlockList -> Bool #

Hashable CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Methods

hashWithSalt :: Int -> CreateQuerySuggestionsBlockList -> Int #

hash :: CreateQuerySuggestionsBlockList -> Int #

type AWSResponse CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

type AWSResponse CreateQuerySuggestionsBlockList = CreateQuerySuggestionsBlockListResponse
type Rep CreateQuerySuggestionsBlockList Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

type Rep CreateQuerySuggestionsBlockList = D1 ('MetaData "CreateQuerySuggestionsBlockList" "Amazonka.Kendra.CreateQuerySuggestionsBlockList" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateQuerySuggestionsBlockList'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: ((S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "sourceS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3Path) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateQuerySuggestionsBlockList Source #

Arguments

:: Text

$sel:indexId:CreateQuerySuggestionsBlockList'

-> Text

CreateQuerySuggestionsBlockList

-> S3Path

$sel:sourceS3Path:CreateQuerySuggestionsBlockList'

-> Text

CreateQuerySuggestionsBlockList

-> CreateQuerySuggestionsBlockList 

Create a value of CreateQuerySuggestionsBlockList with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:CreateQuerySuggestionsBlockList', createQuerySuggestionsBlockList_clientToken - A token that you provide to identify the request to create a query suggestions block list.

$sel:description:CreateQuerySuggestionsBlockList', createQuerySuggestionsBlockList_description - A user-friendly 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."

$sel:tags:CreateQuerySuggestionsBlockList', createQuerySuggestionsBlockList_tags - A tag that you can assign to a block list that categorizes the block list.

$sel:indexId:CreateQuerySuggestionsBlockList', createQuerySuggestionsBlockList_indexId - The identifier of the index you want to create a query suggestions block list for.

CreateQuerySuggestionsBlockList, createQuerySuggestionsBlockList_name - A user friendly name for the block list.

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

$sel:sourceS3Path:CreateQuerySuggestionsBlockList', createQuerySuggestionsBlockList_sourceS3Path - 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.

CreateQuerySuggestionsBlockList, createQuerySuggestionsBlockList_roleArn - The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Web Services Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Request Lenses

createQuerySuggestionsBlockList_clientToken :: Lens' CreateQuerySuggestionsBlockList (Maybe Text) Source #

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

createQuerySuggestionsBlockList_description :: Lens' CreateQuerySuggestionsBlockList (Maybe Text) Source #

A user-friendly 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."

createQuerySuggestionsBlockList_tags :: Lens' CreateQuerySuggestionsBlockList (Maybe [Tag]) Source #

A tag that you can assign to a block list that categorizes the block list.

createQuerySuggestionsBlockList_indexId :: Lens' CreateQuerySuggestionsBlockList Text Source #

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

createQuerySuggestionsBlockList_name :: Lens' CreateQuerySuggestionsBlockList Text Source #

A user friendly name for the block list.

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

createQuerySuggestionsBlockList_sourceS3Path :: Lens' CreateQuerySuggestionsBlockList S3Path Source #

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.

createQuerySuggestionsBlockList_roleArn :: Lens' CreateQuerySuggestionsBlockList Text Source #

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Web Services Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Destructuring the Response

data CreateQuerySuggestionsBlockListResponse Source #

See: newCreateQuerySuggestionsBlockListResponse smart constructor.

Constructors

CreateQuerySuggestionsBlockListResponse' 

Fields

Instances

Instances details
Generic CreateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Associated Types

type Rep CreateQuerySuggestionsBlockListResponse :: Type -> Type #

Methods

from :: CreateQuerySuggestionsBlockListResponse -> Rep CreateQuerySuggestionsBlockListResponse x #

to :: Rep CreateQuerySuggestionsBlockListResponse x -> CreateQuerySuggestionsBlockListResponse #

Read CreateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Methods

readsPrec :: Int -> ReadS CreateQuerySuggestionsBlockListResponse #

readList :: ReadS [CreateQuerySuggestionsBlockListResponse] #

readPrec :: ReadPrec CreateQuerySuggestionsBlockListResponse #

readListPrec :: ReadPrec [CreateQuerySuggestionsBlockListResponse] #

Show CreateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Methods

showsPrec :: Int -> CreateQuerySuggestionsBlockListResponse -> ShowS #

show :: CreateQuerySuggestionsBlockListResponse -> String #

showList :: [CreateQuerySuggestionsBlockListResponse] -> ShowS #

NFData CreateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Methods

rnf :: CreateQuerySuggestionsBlockListResponse -> () #

Eq CreateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

Methods

(==) :: CreateQuerySuggestionsBlockListResponse -> CreateQuerySuggestionsBlockListResponse -> Bool #

(/=) :: CreateQuerySuggestionsBlockListResponse -> CreateQuerySuggestionsBlockListResponse -> Bool #

type Rep CreateQuerySuggestionsBlockListResponse Source # 
Instance details

Defined in Amazonka.Kendra.CreateQuerySuggestionsBlockList

type Rep CreateQuerySuggestionsBlockListResponse = D1 ('MetaData "CreateQuerySuggestionsBlockListResponse" "Amazonka.Kendra.CreateQuerySuggestionsBlockList" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateQuerySuggestionsBlockListResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateQuerySuggestionsBlockListResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateQuerySuggestionsBlockListResponse'

-> CreateQuerySuggestionsBlockListResponse 

Create a value of CreateQuerySuggestionsBlockListResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateQuerySuggestionsBlockListResponse, createQuerySuggestionsBlockListResponse_id - The identifier of the created block list.

$sel:httpStatus:CreateQuerySuggestionsBlockListResponse', createQuerySuggestionsBlockListResponse_httpStatus - The response's http status code.

Response Lenses

createQuerySuggestionsBlockListResponse_id :: Lens' CreateQuerySuggestionsBlockListResponse (Maybe Text) Source #

The identifier of the created block list.

createQuerySuggestionsBlockListResponse_httpStatus :: Lens' CreateQuerySuggestionsBlockListResponse Int Source #

The response's http status code.