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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Creating a Request

data UpdateExperience Source #

See: newUpdateExperience smart constructor.

Constructors

UpdateExperience'

Fields

configuration :: Maybe ExperienceConfiguration
Configuration information you want to update for your Amazon Kendra experience.
description :: Maybe Text
A new description for your Amazon Kendra experience.
name :: Maybe Text
A new name for your Amazon Kendra experience.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information. For more information, see IAM roles for Amazon Kendra.
id :: Text
The identifier of your Amazon Kendra experience you want to update.
indexId :: Text
The identifier of the index for your Amazon Kendra experience.

Instances

Instances details

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

newUpdateExperience Source #

Arguments

:: Text	`UpdateExperience`
-> Text	`$sel:indexId:UpdateExperience'`
-> UpdateExperience

Create a value of UpdateExperience 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:configuration:UpdateExperience', updateExperience_configuration - Configuration information you want to update for your Amazon Kendra experience.

$sel:description:UpdateExperience', updateExperience_description - A new description for your Amazon Kendra experience.

UpdateExperience, updateExperience_name - A new name for your Amazon Kendra experience.

UpdateExperience, updateExperience_roleArn - The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information. For more information, see IAM roles for Amazon Kendra.

UpdateExperience, updateExperience_id - The identifier of your Amazon Kendra experience you want to update.

$sel:indexId:UpdateExperience', updateExperience_indexId - The identifier of the index for your Amazon Kendra experience.

Request Lenses

updateExperience_configuration :: Lens' UpdateExperience (Maybe ExperienceConfiguration) Source #

Configuration information you want to update for your Amazon Kendra experience.

updateExperience_description :: Lens' UpdateExperience (Maybe Text) Source #

A new description for your Amazon Kendra experience.

updateExperience_name :: Lens' UpdateExperience (Maybe Text) Source #

A new name for your Amazon Kendra experience.

updateExperience_roleArn :: Lens' UpdateExperience (Maybe Text) Source #

The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information. For more information, see IAM roles for Amazon Kendra.

updateExperience_id :: Lens' UpdateExperience Text Source #

The identifier of your Amazon Kendra experience you want to update.

updateExperience_indexId :: Lens' UpdateExperience Text Source #

The identifier of the index for your Amazon Kendra experience.

Destructuring the Response

data UpdateExperienceResponse Source #

See: newUpdateExperienceResponse smart constructor.

Constructors

UpdateExperienceResponse'

Instances

Instances details

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

newUpdateExperienceResponse :: UpdateExperienceResponse Source #

Create a value of UpdateExperienceResponse with all optional fields omitted.

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