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 |
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
- data DescribeQuerySuggestionsBlockList = DescribeQuerySuggestionsBlockList' {}
- newDescribeQuerySuggestionsBlockList :: Text -> Text -> DescribeQuerySuggestionsBlockList
- describeQuerySuggestionsBlockList_indexId :: Lens' DescribeQuerySuggestionsBlockList Text
- describeQuerySuggestionsBlockList_id :: Lens' DescribeQuerySuggestionsBlockList Text
- data DescribeQuerySuggestionsBlockListResponse = DescribeQuerySuggestionsBlockListResponse' {
- createdAt :: Maybe POSIX
- description :: Maybe Text
- errorMessage :: Maybe Text
- fileSizeBytes :: Maybe Integer
- id :: Maybe Text
- indexId :: Maybe Text
- itemCount :: Maybe Int
- name :: Maybe Text
- roleArn :: Maybe Text
- sourceS3Path :: Maybe S3Path
- status :: Maybe QuerySuggestionsBlockListStatus
- updatedAt :: Maybe POSIX
- httpStatus :: Int
- newDescribeQuerySuggestionsBlockListResponse :: Int -> DescribeQuerySuggestionsBlockListResponse
- describeQuerySuggestionsBlockListResponse_createdAt :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe UTCTime)
- describeQuerySuggestionsBlockListResponse_description :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text)
- describeQuerySuggestionsBlockListResponse_errorMessage :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text)
- describeQuerySuggestionsBlockListResponse_fileSizeBytes :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Integer)
- describeQuerySuggestionsBlockListResponse_id :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text)
- describeQuerySuggestionsBlockListResponse_indexId :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text)
- describeQuerySuggestionsBlockListResponse_itemCount :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Int)
- describeQuerySuggestionsBlockListResponse_name :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text)
- describeQuerySuggestionsBlockListResponse_roleArn :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe Text)
- describeQuerySuggestionsBlockListResponse_sourceS3Path :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe S3Path)
- describeQuerySuggestionsBlockListResponse_status :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe QuerySuggestionsBlockListStatus)
- describeQuerySuggestionsBlockListResponse_updatedAt :: Lens' DescribeQuerySuggestionsBlockListResponse (Maybe UTCTime)
- describeQuerySuggestionsBlockListResponse_httpStatus :: Lens' DescribeQuerySuggestionsBlockListResponse Int
Creating a Request
data DescribeQuerySuggestionsBlockList Source #
See: newDescribeQuerySuggestionsBlockList
smart constructor.
Instances
newDescribeQuerySuggestionsBlockList Source #
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.
DescribeQuerySuggestionsBlockListResponse' | |
|
Instances
newDescribeQuerySuggestionsBlockListResponse Source #
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.