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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code.

Synopsis

data CreateExperience = CreateExperience' {
- clientToken :: Maybe Text
- configuration :: Maybe ExperienceConfiguration
- description :: Maybe Text
- roleArn :: Maybe Text
- name :: Text
- indexId :: Text
}
newCreateExperience :: Text -> Text -> CreateExperience
createExperience_clientToken :: Lens' CreateExperience (Maybe Text)
createExperience_configuration :: Lens' CreateExperience (Maybe ExperienceConfiguration)
createExperience_description :: Lens' CreateExperience (Maybe Text)
createExperience_roleArn :: Lens' CreateExperience (Maybe Text)
createExperience_name :: Lens' CreateExperience Text
createExperience_indexId :: Lens' CreateExperience Text
data CreateExperienceResponse = CreateExperienceResponse' {
- httpStatus :: Int
- id :: Text
}
newCreateExperienceResponse :: Int -> Text -> CreateExperienceResponse
createExperienceResponse_httpStatus :: Lens' CreateExperienceResponse Int
createExperienceResponse_id :: Lens' CreateExperienceResponse Text

Creating a Request

data CreateExperience Source #

See: newCreateExperience smart constructor.

Constructors

CreateExperience'

Fields

clientToken :: Maybe Text
A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the CreateExperience API with the same client token creates only one Amazon Kendra experience.
configuration :: Maybe ExperienceConfiguration
Configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.
description :: Maybe Text
A description 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.
name :: Text
A name for your Amazon Kendra experience.
indexId :: Text
The identifier of the index for your Amazon Kendra experience.

Instances

Instances details

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

newCreateExperience Source #

Arguments

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

Create a value of CreateExperience 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:clientToken:CreateExperience', createExperience_clientToken - A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the CreateExperience API with the same client token creates only one Amazon Kendra experience.

$sel:configuration:CreateExperience', createExperience_configuration - Configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

$sel:description:CreateExperience', createExperience_description - A description for your Amazon Kendra experience.

CreateExperience, createExperience_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.

CreateExperience, createExperience_name - A name for your Amazon Kendra experience.

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

Request Lenses

createExperience_clientToken :: Lens' CreateExperience (Maybe Text) Source #

A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the CreateExperience API with the same client token creates only one Amazon Kendra experience.

createExperience_configuration :: Lens' CreateExperience (Maybe ExperienceConfiguration) Source #

Configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

createExperience_description :: Lens' CreateExperience (Maybe Text) Source #

A description for your Amazon Kendra experience.

createExperience_roleArn :: Lens' CreateExperience (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.

createExperience_name :: Lens' CreateExperience Text Source #

A name for your Amazon Kendra experience.

createExperience_indexId :: Lens' CreateExperience Text Source #

The identifier of the index for your Amazon Kendra experience.

Destructuring the Response

data CreateExperienceResponse Source #

See: newCreateExperienceResponse smart constructor.

Constructors

CreateExperienceResponse'
Fields httpStatus :: Int The response's http status code. id :: Text The identifier for your created Amazon Kendra experience.

Instances

Instances details

Generic CreateExperienceResponse Source #
Instance details Defined in Amazonka.Kendra.CreateExperience Associated Types type Rep CreateExperienceResponse :: Type -> Type # Methods from :: CreateExperienceResponse -> Rep CreateExperienceResponse x # to :: Rep CreateExperienceResponse x -> CreateExperienceResponse #
Read CreateExperienceResponse Source #
Instance details Defined in Amazonka.Kendra.CreateExperience Methods readsPrec :: Int -> ReadS CreateExperienceResponse # readList :: ReadS [CreateExperienceResponse] # readPrec :: ReadPrec CreateExperienceResponse # readListPrec :: ReadPrec [CreateExperienceResponse] #
Show CreateExperienceResponse Source #
Instance details Defined in Amazonka.Kendra.CreateExperience Methods showsPrec :: Int -> CreateExperienceResponse -> ShowS # show :: CreateExperienceResponse -> String # showList :: [CreateExperienceResponse] -> ShowS #
NFData CreateExperienceResponse Source #
Instance details Defined in Amazonka.Kendra.CreateExperience Methods rnf :: CreateExperienceResponse -> () #
Eq CreateExperienceResponse Source #
Instance details Defined in Amazonka.Kendra.CreateExperience Methods (==) :: CreateExperienceResponse -> CreateExperienceResponse -> Bool # (/=) :: CreateExperienceResponse -> CreateExperienceResponse -> Bool #
type Rep CreateExperienceResponse Source #
Instance details Defined in Amazonka.Kendra.CreateExperience type Rep CreateExperienceResponse = D1 ('MetaData "CreateExperienceResponse" "Amazonka.Kendra.CreateExperience" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateExperienceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateExperienceResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateExperienceResponse'`
-> Text	`CreateExperienceResponse`
-> CreateExperienceResponse

Create a value of CreateExperienceResponse 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:httpStatus:CreateExperienceResponse', createExperienceResponse_httpStatus - The response's http status code.

CreateExperienceResponse, createExperienceResponse_id - The identifier for your created Amazon Kendra experience.

Response Lenses

createExperienceResponse_httpStatus :: Lens' CreateExperienceResponse Int Source #

The response's http status code.

createExperienceResponse_id :: Lens' CreateExperienceResponse Text Source #

The identifier for your created Amazon Kendra experience.