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 |
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' {}
- 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.
CreateExperience' | |
|
Instances
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.
CreateExperienceResponse' | |
|
Instances
newCreateExperienceResponse Source #
:: Int | |
-> Text | |
-> 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.