Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.DescribeQuerySuggestionsBlockList

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about a block list used for query suggestions for an index.

This is used to check the current settings that are applied to a block list.

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

Synopsis

Creating a Request

data DescribeQuerySuggestionsBlockList Source #

See: newDescribeQuerySuggestionsBlockList smart constructor.

Constructors

DescribeQuerySuggestionsBlockList'
Fields indexId :: Text The identifier of the index for the block list. id :: Text The identifier of the block list you want to get information on.

Instances

Instances details

ToJSON DescribeQuerySuggestionsBlockList Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Methods toJSON :: DescribeQuerySuggestionsBlockList -> Value # toEncoding :: DescribeQuerySuggestionsBlockList -> Encoding # toJSONList :: [DescribeQuerySuggestionsBlockList] -> Value # toEncodingList :: [DescribeQuerySuggestionsBlockList] -> Encoding #
ToHeaders DescribeQuerySuggestionsBlockList Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Methods toHeaders :: DescribeQuerySuggestionsBlockList -> [Header] #
ToPath DescribeQuerySuggestionsBlockList Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Methods toPath :: DescribeQuerySuggestionsBlockList -> ByteString #
ToQuery DescribeQuerySuggestionsBlockList Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Methods toQuery :: DescribeQuerySuggestionsBlockList -> QueryString #
AWSRequest DescribeQuerySuggestionsBlockList Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Associated Types type AWSResponse DescribeQuerySuggestionsBlockList # Methods request :: (Service -> Service) -> DescribeQuerySuggestionsBlockList -> Request DescribeQuerySuggestionsBlockList # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeQuerySuggestionsBlockList -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeQuerySuggestionsBlockList))) #
Generic DescribeQuerySuggestionsBlockList Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Associated Types type Rep DescribeQuerySuggestionsBlockList :: Type -> Type # Methods from :: DescribeQuerySuggestionsBlockList -> Rep DescribeQuerySuggestionsBlockList x # to :: Rep DescribeQuerySuggestionsBlockList x -> DescribeQuerySuggestionsBlockList #
Read DescribeQuerySuggestionsBlockList Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Methods readsPrec :: Int -> ReadS DescribeQuerySuggestionsBlockList # readList :: ReadS [DescribeQuerySuggestionsBlockList] # readPrec :: ReadPrec DescribeQuerySuggestionsBlockList # readListPrec :: ReadPrec [DescribeQuerySuggestionsBlockList] #
Show DescribeQuerySuggestionsBlockList Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Methods showsPrec :: Int -> DescribeQuerySuggestionsBlockList -> ShowS # show :: DescribeQuerySuggestionsBlockList -> String # showList :: [DescribeQuerySuggestionsBlockList] -> ShowS #
NFData DescribeQuerySuggestionsBlockList Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Methods rnf :: DescribeQuerySuggestionsBlockList -> () #
Eq DescribeQuerySuggestionsBlockList Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Methods (==) :: DescribeQuerySuggestionsBlockList -> DescribeQuerySuggestionsBlockList -> Bool # (/=) :: DescribeQuerySuggestionsBlockList -> DescribeQuerySuggestionsBlockList -> Bool #
Hashable DescribeQuerySuggestionsBlockList Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Methods hashWithSalt :: Int -> DescribeQuerySuggestionsBlockList -> Int # hash :: DescribeQuerySuggestionsBlockList -> Int #
type AWSResponse DescribeQuerySuggestionsBlockList Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList type AWSResponse DescribeQuerySuggestionsBlockList = DescribeQuerySuggestionsBlockListResponse
type Rep DescribeQuerySuggestionsBlockList Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList type Rep DescribeQuerySuggestionsBlockList = D1 ('MetaData "DescribeQuerySuggestionsBlockList" "Amazonka.Kendra.DescribeQuerySuggestionsBlockList" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeQuerySuggestionsBlockList'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeQuerySuggestionsBlockList Source #

Arguments

:: Text	`DescribeQuerySuggestionsBlockList`
-> Text	`DescribeQuerySuggestionsBlockList`
-> DescribeQuerySuggestionsBlockList

Create a value of DescribeQuerySuggestionsBlockList 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:

DescribeQuerySuggestionsBlockList, describeQuerySuggestionsBlockList_indexId - The identifier of the index for the block list.

DescribeQuerySuggestionsBlockList, describeQuerySuggestionsBlockList_id - The identifier of the block list you want to get information on.

Request Lenses

describeQuerySuggestionsBlockList_indexId :: Lens' DescribeQuerySuggestionsBlockList Text Source #

The identifier of the index for the block list.

describeQuerySuggestionsBlockList_id :: Lens' DescribeQuerySuggestionsBlockList Text Source #

The identifier of the block list you want to get information on.

Destructuring the Response

data DescribeQuerySuggestionsBlockListResponse Source #

See: newDescribeQuerySuggestionsBlockListResponse smart constructor.

Constructors

DescribeQuerySuggestionsBlockListResponse'

Fields

createdAt :: Maybe POSIX
The date-time a block list for query suggestions was created.
description :: Maybe Text
The description for the block list.
errorMessage :: Maybe Text
The error message containing details if there are issues processing the block list.
fileSizeBytes :: Maybe Integer
The current size of the block list text file in S3.
id :: Maybe Text
The identifier of the block list.
indexId :: Maybe Text
The identifier of the index for the block list.
itemCount :: Maybe Int
The current number of valid, non-empty words or phrases in the block list text file.
name :: Maybe Text
The name of the block list.
roleArn :: Maybe Text
The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.
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.
sourceS3Path :: Maybe S3Path
Shows the current 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.
status :: Maybe QuerySuggestionsBlockListStatus
The current status of the block list. When the value is ACTIVE, the block list is ready for use.
updatedAt :: Maybe POSIX
The date-time a block list for query suggestions was last updated.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeQuerySuggestionsBlockListResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Associated Types type Rep DescribeQuerySuggestionsBlockListResponse :: Type -> Type # Methods from :: DescribeQuerySuggestionsBlockListResponse -> Rep DescribeQuerySuggestionsBlockListResponse x # to :: Rep DescribeQuerySuggestionsBlockListResponse x -> DescribeQuerySuggestionsBlockListResponse #
Read DescribeQuerySuggestionsBlockListResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Methods readsPrec :: Int -> ReadS DescribeQuerySuggestionsBlockListResponse # readList :: ReadS [DescribeQuerySuggestionsBlockListResponse] # readPrec :: ReadPrec DescribeQuerySuggestionsBlockListResponse # readListPrec :: ReadPrec [DescribeQuerySuggestionsBlockListResponse] #
Show DescribeQuerySuggestionsBlockListResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Methods showsPrec :: Int -> DescribeQuerySuggestionsBlockListResponse -> ShowS # show :: DescribeQuerySuggestionsBlockListResponse -> String # showList :: [DescribeQuerySuggestionsBlockListResponse] -> ShowS #
NFData DescribeQuerySuggestionsBlockListResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Methods rnf :: DescribeQuerySuggestionsBlockListResponse -> () #
Eq DescribeQuerySuggestionsBlockListResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList Methods (==) :: DescribeQuerySuggestionsBlockListResponse -> DescribeQuerySuggestionsBlockListResponse -> Bool # (/=) :: DescribeQuerySuggestionsBlockListResponse -> DescribeQuerySuggestionsBlockListResponse -> Bool #
type Rep DescribeQuerySuggestionsBlockListResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsBlockList type Rep DescribeQuerySuggestionsBlockListResponse = D1 ('MetaData "DescribeQuerySuggestionsBlockListResponse" "Amazonka.Kendra.DescribeQuerySuggestionsBlockList" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeQuerySuggestionsBlockListResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "fileSizeBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "itemCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "sourceS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Path)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuerySuggestionsBlockListStatus))) :: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeQuerySuggestionsBlockListResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeQuerySuggestionsBlockListResponse'`
-> DescribeQuerySuggestionsBlockListResponse

Create a value of DescribeQuerySuggestionsBlockListResponse 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:

DescribeQuerySuggestionsBlockListResponse, describeQuerySuggestionsBlockListResponse_createdAt - The date-time a block list for query suggestions was created.

$sel:description:DescribeQuerySuggestionsBlockListResponse', describeQuerySuggestionsBlockListResponse_description - The description for the block list.

DescribeQuerySuggestionsBlockListResponse, describeQuerySuggestionsBlockListResponse_errorMessage - The error message containing details if there are issues processing the block list.

$sel:fileSizeBytes:DescribeQuerySuggestionsBlockListResponse', describeQuerySuggestionsBlockListResponse_fileSizeBytes - The current size of the block list text file in S3.

DescribeQuerySuggestionsBlockList, describeQuerySuggestionsBlockListResponse_id - The identifier of the block list.

DescribeQuerySuggestionsBlockList, describeQuerySuggestionsBlockListResponse_indexId - The identifier of the index for the block list.

DescribeQuerySuggestionsBlockListResponse, describeQuerySuggestionsBlockListResponse_itemCount - The current number of valid, non-empty words or phrases in the block list text file.

DescribeQuerySuggestionsBlockListResponse, describeQuerySuggestionsBlockListResponse_name - The name of the block list.

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

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.

$sel:sourceS3Path:DescribeQuerySuggestionsBlockListResponse', describeQuerySuggestionsBlockListResponse_sourceS3Path - Shows the current 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.

DescribeQuerySuggestionsBlockListResponse, describeQuerySuggestionsBlockListResponse_status - The current status of the block list. When the value is ACTIVE, the block list is ready for use.

DescribeQuerySuggestionsBlockListResponse, describeQuerySuggestionsBlockListResponse_updatedAt - The date-time a block list for query suggestions was last updated.

$sel:httpStatus:DescribeQuerySuggestionsBlockListResponse', describeQuerySuggestionsBlockListResponse_httpStatus - The response's http status code.

Response Lenses

describeQuerySuggestionsBlockListResponse_createdAt :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe UTCTime) Source #

The date-time a block list for query suggestions was created.

describeQuerySuggestionsBlockListResponse_description :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text) Source #

The description for the block list.

describeQuerySuggestionsBlockListResponse_errorMessage :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text) Source #

The error message containing details if there are issues processing the block list.

describeQuerySuggestionsBlockListResponse_fileSizeBytes :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Integer) Source #

The current size of the block list text file in S3.

describeQuerySuggestionsBlockListResponse_id :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text) Source #

The identifier of the block list.

describeQuerySuggestionsBlockListResponse_indexId :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text) Source #

The identifier of the index for the block list.

describeQuerySuggestionsBlockListResponse_itemCount :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Int) Source #

The current number of valid, non-empty words or phrases in the block list text file.

describeQuerySuggestionsBlockListResponse_name :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text) Source #

The name of the block list.

describeQuerySuggestionsBlockListResponse_roleArn :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text) Source #

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

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.

describeQuerySuggestionsBlockListResponse_sourceS3Path :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe S3Path) Source #

Shows the current 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.

describeQuerySuggestionsBlockListResponse_status :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe QuerySuggestionsBlockListStatus) Source #

The current status of the block list. When the value is ACTIVE, the block list is ready for use.

describeQuerySuggestionsBlockListResponse_updatedAt :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe UTCTime) Source #

The date-time a block list for query suggestions was last updated.

describeQuerySuggestionsBlockListResponse_httpStatus :: Lens' DescribeQuerySuggestionsBlockListResponse Int Source #

The response's http status code.