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 |
Lists one or more Amazon Kendra experiences. You can create an 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.
Synopsis
- data ListExperiences = ListExperiences' {}
- newListExperiences :: Text -> ListExperiences
- listExperiences_maxResults :: Lens' ListExperiences (Maybe Natural)
- listExperiences_nextToken :: Lens' ListExperiences (Maybe Text)
- listExperiences_indexId :: Lens' ListExperiences Text
- data ListExperiencesResponse = ListExperiencesResponse' {}
- newListExperiencesResponse :: Int -> ListExperiencesResponse
- listExperiencesResponse_nextToken :: Lens' ListExperiencesResponse (Maybe Text)
- listExperiencesResponse_summaryItems :: Lens' ListExperiencesResponse (Maybe [ExperiencesSummary])
- listExperiencesResponse_httpStatus :: Lens' ListExperiencesResponse Int
Creating a Request
data ListExperiences Source #
See: newListExperiences
smart constructor.
ListExperiences' | |
|
Instances
Create a value of ListExperiences
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:
ListExperiences
, listExperiences_maxResults
- The maximum number of returned Amazon Kendra experiences.
ListExperiences
, listExperiences_nextToken
- If the previous response was incomplete (because there is more data to
retrieve), Amazon Kendra returns a pagination token in the response. You
can use this pagination token to retrieve the next set of Amazon Kendra
experiences.
$sel:indexId:ListExperiences'
, listExperiences_indexId
- The identifier of the index for your Amazon Kendra experience.
Request Lenses
listExperiences_maxResults :: Lens' ListExperiences (Maybe Natural) Source #
The maximum number of returned Amazon Kendra experiences.
listExperiences_nextToken :: Lens' ListExperiences (Maybe Text) Source #
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Kendra experiences.
listExperiences_indexId :: Lens' ListExperiences Text Source #
The identifier of the index for your Amazon Kendra experience.
Destructuring the Response
data ListExperiencesResponse Source #
See: newListExperiencesResponse
smart constructor.
ListExperiencesResponse' | |
|
Instances
newListExperiencesResponse Source #
Create a value of ListExperiencesResponse
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:
ListExperiences
, listExperiencesResponse_nextToken
- If the response is truncated, Amazon Kendra returns this token, which
you can use in a later request to retrieve the next set of Amazon Kendra
experiences.
$sel:summaryItems:ListExperiencesResponse'
, listExperiencesResponse_summaryItems
- An array of summary information for one or more Amazon Kendra
experiences.
$sel:httpStatus:ListExperiencesResponse'
, listExperiencesResponse_httpStatus
- The response's http status code.
Response Lenses
listExperiencesResponse_nextToken :: Lens' ListExperiencesResponse (Maybe Text) Source #
If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of Amazon Kendra experiences.
listExperiencesResponse_summaryItems :: Lens' ListExperiencesResponse (Maybe [ExperiencesSummary]) Source #
An array of summary information for one or more Amazon Kendra experiences.
listExperiencesResponse_httpStatus :: Lens' ListExperiencesResponse Int Source #
The response's http status code.