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 an existing Amazon Kendra index.
Synopsis
- data DescribeIndex = DescribeIndex' {}
- newDescribeIndex :: Text -> DescribeIndex
- describeIndex_id :: Lens' DescribeIndex Text
- data DescribeIndexResponse = DescribeIndexResponse' {
- capacityUnits :: Maybe CapacityUnitsConfiguration
- createdAt :: Maybe POSIX
- description :: Maybe Text
- documentMetadataConfigurations :: Maybe [DocumentMetadataConfiguration]
- edition :: Maybe IndexEdition
- errorMessage :: Maybe Text
- id :: Maybe Text
- indexStatistics :: Maybe IndexStatistics
- name :: Maybe Text
- roleArn :: Maybe Text
- serverSideEncryptionConfiguration :: Maybe ServerSideEncryptionConfiguration
- status :: Maybe IndexStatus
- updatedAt :: Maybe POSIX
- userContextPolicy :: Maybe UserContextPolicy
- userGroupResolutionConfiguration :: Maybe UserGroupResolutionConfiguration
- userTokenConfigurations :: Maybe [UserTokenConfiguration]
- httpStatus :: Int
- newDescribeIndexResponse :: Int -> DescribeIndexResponse
- describeIndexResponse_capacityUnits :: Lens' DescribeIndexResponse (Maybe CapacityUnitsConfiguration)
- describeIndexResponse_createdAt :: Lens' DescribeIndexResponse (Maybe UTCTime)
- describeIndexResponse_description :: Lens' DescribeIndexResponse (Maybe Text)
- describeIndexResponse_documentMetadataConfigurations :: Lens' DescribeIndexResponse (Maybe [DocumentMetadataConfiguration])
- describeIndexResponse_edition :: Lens' DescribeIndexResponse (Maybe IndexEdition)
- describeIndexResponse_errorMessage :: Lens' DescribeIndexResponse (Maybe Text)
- describeIndexResponse_id :: Lens' DescribeIndexResponse (Maybe Text)
- describeIndexResponse_indexStatistics :: Lens' DescribeIndexResponse (Maybe IndexStatistics)
- describeIndexResponse_name :: Lens' DescribeIndexResponse (Maybe Text)
- describeIndexResponse_roleArn :: Lens' DescribeIndexResponse (Maybe Text)
- describeIndexResponse_serverSideEncryptionConfiguration :: Lens' DescribeIndexResponse (Maybe ServerSideEncryptionConfiguration)
- describeIndexResponse_status :: Lens' DescribeIndexResponse (Maybe IndexStatus)
- describeIndexResponse_updatedAt :: Lens' DescribeIndexResponse (Maybe UTCTime)
- describeIndexResponse_userContextPolicy :: Lens' DescribeIndexResponse (Maybe UserContextPolicy)
- describeIndexResponse_userGroupResolutionConfiguration :: Lens' DescribeIndexResponse (Maybe UserGroupResolutionConfiguration)
- describeIndexResponse_userTokenConfigurations :: Lens' DescribeIndexResponse (Maybe [UserTokenConfiguration])
- describeIndexResponse_httpStatus :: Lens' DescribeIndexResponse Int
Creating a Request
data DescribeIndex Source #
See: newDescribeIndex
smart constructor.
Instances
Create a value of DescribeIndex
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:
DescribeIndex
, describeIndex_id
- The identifier of the index you want to get information on.
Request Lenses
describeIndex_id :: Lens' DescribeIndex Text Source #
The identifier of the index you want to get information on.
Destructuring the Response
data DescribeIndexResponse Source #
See: newDescribeIndexResponse
smart constructor.
DescribeIndexResponse' | |
|
Instances
newDescribeIndexResponse Source #
Create a value of DescribeIndexResponse
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:capacityUnits:DescribeIndexResponse'
, describeIndexResponse_capacityUnits
- For Enterprise Edition indexes, you can choose to use additional
capacity to meet the needs of your application. This contains the
capacity units used for the index. A query or document storage capacity
of zero indicates that the index is using the default capacity. For more
information on the default capacity for an index and adjusting this, see
Adjusting capacity.
DescribeIndexResponse
, describeIndexResponse_createdAt
- The Unix datetime that the index was created.
$sel:description:DescribeIndexResponse'
, describeIndexResponse_description
- The description for the index.
$sel:documentMetadataConfigurations:DescribeIndexResponse'
, describeIndexResponse_documentMetadataConfigurations
- Configuration information for document metadata or fields. Document
metadata are fields or attributes associated with your documents. For
example, the company department name associated with each document.
DescribeIndexResponse
, describeIndexResponse_edition
- The Amazon Kendra edition used for the index. You decide the edition
when you create the index.
DescribeIndexResponse
, describeIndexResponse_errorMessage
- When the Status
field value is FAILED
, the ErrorMessage
field
contains a message that explains why.
DescribeIndex
, describeIndexResponse_id
- The identifier of the index.
$sel:indexStatistics:DescribeIndexResponse'
, describeIndexResponse_indexStatistics
- Provides information about the number of FAQ questions and answers and
the number of text documents indexed.
DescribeIndexResponse
, describeIndexResponse_name
- The name of the index.
DescribeIndexResponse
, describeIndexResponse_roleArn
- The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra
permission to write to your Amazon Cloudwatch logs.
$sel:serverSideEncryptionConfiguration:DescribeIndexResponse'
, describeIndexResponse_serverSideEncryptionConfiguration
- The identifier of the KMScustomer master key (CMK) that is used to
encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
DescribeIndexResponse
, describeIndexResponse_status
- The current status of the index. When the value is ACTIVE
, the index
is ready for use. If the Status
field value is FAILED
, the
ErrorMessage
field contains a message that explains why.
DescribeIndexResponse
, describeIndexResponse_updatedAt
- The Unix datetime that the index was last updated.
$sel:userContextPolicy:DescribeIndexResponse'
, describeIndexResponse_userContextPolicy
- The user context policy for the Amazon Kendra index.
$sel:userGroupResolutionConfiguration:DescribeIndexResponse'
, describeIndexResponse_userGroupResolutionConfiguration
- Whether you have enabled the configuration for fetching access levels of
groups and users from an IAM Identity Center (successor to Single
Sign-On) identity source.
$sel:userTokenConfigurations:DescribeIndexResponse'
, describeIndexResponse_userTokenConfigurations
- The user token configuration for the Amazon Kendra index.
$sel:httpStatus:DescribeIndexResponse'
, describeIndexResponse_httpStatus
- The response's http status code.
Response Lenses
describeIndexResponse_capacityUnits :: Lens' DescribeIndexResponse (Maybe CapacityUnitsConfiguration) Source #
For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.
describeIndexResponse_createdAt :: Lens' DescribeIndexResponse (Maybe UTCTime) Source #
The Unix datetime that the index was created.
describeIndexResponse_description :: Lens' DescribeIndexResponse (Maybe Text) Source #
The description for the index.
describeIndexResponse_documentMetadataConfigurations :: Lens' DescribeIndexResponse (Maybe [DocumentMetadataConfiguration]) Source #
Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
describeIndexResponse_edition :: Lens' DescribeIndexResponse (Maybe IndexEdition) Source #
The Amazon Kendra edition used for the index. You decide the edition when you create the index.
describeIndexResponse_errorMessage :: Lens' DescribeIndexResponse (Maybe Text) Source #
When the Status
field value is FAILED
, the ErrorMessage
field
contains a message that explains why.
describeIndexResponse_id :: Lens' DescribeIndexResponse (Maybe Text) Source #
The identifier of the index.
describeIndexResponse_indexStatistics :: Lens' DescribeIndexResponse (Maybe IndexStatistics) Source #
Provides information about the number of FAQ questions and answers and the number of text documents indexed.
describeIndexResponse_name :: Lens' DescribeIndexResponse (Maybe Text) Source #
The name of the index.
describeIndexResponse_roleArn :: Lens' DescribeIndexResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.
describeIndexResponse_serverSideEncryptionConfiguration :: Lens' DescribeIndexResponse (Maybe ServerSideEncryptionConfiguration) Source #
The identifier of the KMScustomer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
describeIndexResponse_status :: Lens' DescribeIndexResponse (Maybe IndexStatus) Source #
The current status of the index. When the value is ACTIVE
, the index
is ready for use. If the Status
field value is FAILED
, the
ErrorMessage
field contains a message that explains why.
describeIndexResponse_updatedAt :: Lens' DescribeIndexResponse (Maybe UTCTime) Source #
The Unix datetime that the index was last updated.
describeIndexResponse_userContextPolicy :: Lens' DescribeIndexResponse (Maybe UserContextPolicy) Source #
The user context policy for the Amazon Kendra index.
describeIndexResponse_userGroupResolutionConfiguration :: Lens' DescribeIndexResponse (Maybe UserGroupResolutionConfiguration) Source #
Whether you have enabled the configuration for fetching access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) identity source.
describeIndexResponse_userTokenConfigurations :: Lens' DescribeIndexResponse (Maybe [UserTokenConfiguration]) Source #
The user token configuration for the Amazon Kendra index.
describeIndexResponse_httpStatus :: Lens' DescribeIndexResponse Int Source #
The response's http status code.