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 |
Updates an existing Amazon Kendra index.
Synopsis
- data UpdateIndex = UpdateIndex' {
- capacityUnits :: Maybe CapacityUnitsConfiguration
- description :: Maybe Text
- documentMetadataConfigurationUpdates :: Maybe [DocumentMetadataConfiguration]
- name :: Maybe Text
- roleArn :: Maybe Text
- userContextPolicy :: Maybe UserContextPolicy
- userGroupResolutionConfiguration :: Maybe UserGroupResolutionConfiguration
- userTokenConfigurations :: Maybe [UserTokenConfiguration]
- id :: Text
- newUpdateIndex :: Text -> UpdateIndex
- updateIndex_capacityUnits :: Lens' UpdateIndex (Maybe CapacityUnitsConfiguration)
- updateIndex_description :: Lens' UpdateIndex (Maybe Text)
- updateIndex_documentMetadataConfigurationUpdates :: Lens' UpdateIndex (Maybe [DocumentMetadataConfiguration])
- updateIndex_name :: Lens' UpdateIndex (Maybe Text)
- updateIndex_roleArn :: Lens' UpdateIndex (Maybe Text)
- updateIndex_userContextPolicy :: Lens' UpdateIndex (Maybe UserContextPolicy)
- updateIndex_userGroupResolutionConfiguration :: Lens' UpdateIndex (Maybe UserGroupResolutionConfiguration)
- updateIndex_userTokenConfigurations :: Lens' UpdateIndex (Maybe [UserTokenConfiguration])
- updateIndex_id :: Lens' UpdateIndex Text
- data UpdateIndexResponse = UpdateIndexResponse' {
- newUpdateIndexResponse :: UpdateIndexResponse
Creating a Request
data UpdateIndex Source #
See: newUpdateIndex
smart constructor.
UpdateIndex' | |
|
Instances
Create a value of UpdateIndex
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:UpdateIndex'
, updateIndex_capacityUnits
- Sets the number of additional document storage and query capacity units
that should be used by the index. You can change the capacity of the
index up to 5 times per day, or make 5 API calls.
If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.
$sel:description:UpdateIndex'
, updateIndex_description
- A new description for the index.
$sel:documentMetadataConfigurationUpdates:UpdateIndex'
, updateIndex_documentMetadataConfigurationUpdates
- The document metadata configuration you want to update for the index.
Document metadata are fields or attributes associated with your
documents. For example, the company department name associated with each
document.
UpdateIndex
, updateIndex_name
- The name of the index you want to update.
UpdateIndex
, updateIndex_roleArn
- An Identity and Access Management (IAM) role that gives Amazon Kendra
permission to access Amazon CloudWatch logs and metrics.
$sel:userContextPolicy:UpdateIndex'
, updateIndex_userContextPolicy
- The user context policy.
$sel:userGroupResolutionConfiguration:UpdateIndex'
, updateIndex_userGroupResolutionConfiguration
- Enables fetching access levels of groups and users from an IAM Identity
Center (successor to Single Sign-On) identity source. To configure this,
see
UserGroupResolutionConfiguration.
$sel:userTokenConfigurations:UpdateIndex'
, updateIndex_userTokenConfigurations
- The user token configuration.
UpdateIndex
, updateIndex_id
- The identifier of the index you want to update.
Request Lenses
updateIndex_capacityUnits :: Lens' UpdateIndex (Maybe CapacityUnitsConfiguration) Source #
Sets the number of additional document storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day, or make 5 API calls.
If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.
updateIndex_description :: Lens' UpdateIndex (Maybe Text) Source #
A new description for the index.
updateIndex_documentMetadataConfigurationUpdates :: Lens' UpdateIndex (Maybe [DocumentMetadataConfiguration]) Source #
The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
updateIndex_name :: Lens' UpdateIndex (Maybe Text) Source #
The name of the index you want to update.
updateIndex_roleArn :: Lens' UpdateIndex (Maybe Text) Source #
An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.
updateIndex_userContextPolicy :: Lens' UpdateIndex (Maybe UserContextPolicy) Source #
The user context policy.
updateIndex_userGroupResolutionConfiguration :: Lens' UpdateIndex (Maybe UserGroupResolutionConfiguration) Source #
Enables fetching access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) identity source. To configure this, see UserGroupResolutionConfiguration.
updateIndex_userTokenConfigurations :: Lens' UpdateIndex (Maybe [UserTokenConfiguration]) Source #
The user token configuration.
updateIndex_id :: Lens' UpdateIndex Text Source #
The identifier of the index you want to update.
Destructuring the Response
data UpdateIndexResponse Source #
See: newUpdateIndexResponse
smart constructor.
Instances
Generic UpdateIndexResponse Source # | |
Defined in Amazonka.Kendra.UpdateIndex type Rep UpdateIndexResponse :: Type -> Type # from :: UpdateIndexResponse -> Rep UpdateIndexResponse x # to :: Rep UpdateIndexResponse x -> UpdateIndexResponse # | |
Read UpdateIndexResponse Source # | |
Defined in Amazonka.Kendra.UpdateIndex | |
Show UpdateIndexResponse Source # | |
Defined in Amazonka.Kendra.UpdateIndex showsPrec :: Int -> UpdateIndexResponse -> ShowS # show :: UpdateIndexResponse -> String # showList :: [UpdateIndexResponse] -> ShowS # | |
NFData UpdateIndexResponse Source # | |
Defined in Amazonka.Kendra.UpdateIndex rnf :: UpdateIndexResponse -> () # | |
Eq UpdateIndexResponse Source # | |
Defined in Amazonka.Kendra.UpdateIndex (==) :: UpdateIndexResponse -> UpdateIndexResponse -> Bool # (/=) :: UpdateIndexResponse -> UpdateIndexResponse -> Bool # | |
type Rep UpdateIndexResponse Source # | |
newUpdateIndexResponse :: UpdateIndexResponse Source #
Create a value of UpdateIndexResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.