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.UpdateIndex

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Updates an existing Amazon Kendra index.

Synopsis

data UpdateIndex = UpdateIndex' {
}
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.

Constructors

UpdateIndex'

Fields

capacityUnits :: Maybe CapacityUnitsConfiguration
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.
description :: Maybe Text
A new description for the index.
documentMetadataConfigurationUpdates :: Maybe [DocumentMetadataConfiguration]
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.
name :: Maybe Text
The name of the index you want to update.
roleArn :: Maybe Text
An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.
userContextPolicy :: Maybe UserContextPolicy
The user context policy.
userGroupResolutionConfiguration :: Maybe 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.
userTokenConfigurations :: Maybe [UserTokenConfiguration]
The user token configuration.
id :: Text
The identifier of the index you want to update.

Instances

Instances details

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

newUpdateIndex Source #

Arguments

:: Text	`UpdateIndex`
-> UpdateIndex

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.

Constructors

UpdateIndexResponse'

Instances

Instances details

Generic UpdateIndexResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateIndex Associated Types type Rep UpdateIndexResponse :: Type -> Type # Methods from :: UpdateIndexResponse -> Rep UpdateIndexResponse x # to :: Rep UpdateIndexResponse x -> UpdateIndexResponse #
Read UpdateIndexResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateIndex Methods readsPrec :: Int -> ReadS UpdateIndexResponse # readList :: ReadS [UpdateIndexResponse] # readPrec :: ReadPrec UpdateIndexResponse # readListPrec :: ReadPrec [UpdateIndexResponse] #
Show UpdateIndexResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateIndex Methods showsPrec :: Int -> UpdateIndexResponse -> ShowS # show :: UpdateIndexResponse -> String # showList :: [UpdateIndexResponse] -> ShowS #
NFData UpdateIndexResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateIndex Methods rnf :: UpdateIndexResponse -> () #
Eq UpdateIndexResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateIndex Methods (==) :: UpdateIndexResponse -> UpdateIndexResponse -> Bool # (/=) :: UpdateIndexResponse -> UpdateIndexResponse -> Bool #
type Rep UpdateIndexResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateIndex type Rep UpdateIndexResponse = D1 ('MetaData "UpdateIndexResponse" "Amazonka.Kendra.UpdateIndex" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UpdateIndexResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateIndexResponse :: UpdateIndexResponse Source #

Create a value of UpdateIndexResponse with all optional fields omitted.

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