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 |
Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.
Synopsis
- data ListRecommendedIntents = ListRecommendedIntents' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- botId :: Text
- botVersion :: Text
- localeId :: Text
- botRecommendationId :: Text
- newListRecommendedIntents :: Text -> Text -> Text -> Text -> ListRecommendedIntents
- listRecommendedIntents_maxResults :: Lens' ListRecommendedIntents (Maybe Natural)
- listRecommendedIntents_nextToken :: Lens' ListRecommendedIntents (Maybe Text)
- listRecommendedIntents_botId :: Lens' ListRecommendedIntents Text
- listRecommendedIntents_botVersion :: Lens' ListRecommendedIntents Text
- listRecommendedIntents_localeId :: Lens' ListRecommendedIntents Text
- listRecommendedIntents_botRecommendationId :: Lens' ListRecommendedIntents Text
- data ListRecommendedIntentsResponse = ListRecommendedIntentsResponse' {}
- newListRecommendedIntentsResponse :: Int -> ListRecommendedIntentsResponse
- listRecommendedIntentsResponse_botId :: Lens' ListRecommendedIntentsResponse (Maybe Text)
- listRecommendedIntentsResponse_botRecommendationId :: Lens' ListRecommendedIntentsResponse (Maybe Text)
- listRecommendedIntentsResponse_botVersion :: Lens' ListRecommendedIntentsResponse (Maybe Text)
- listRecommendedIntentsResponse_localeId :: Lens' ListRecommendedIntentsResponse (Maybe Text)
- listRecommendedIntentsResponse_nextToken :: Lens' ListRecommendedIntentsResponse (Maybe Text)
- listRecommendedIntentsResponse_summaryList :: Lens' ListRecommendedIntentsResponse (Maybe [RecommendedIntentSummary])
- listRecommendedIntentsResponse_httpStatus :: Lens' ListRecommendedIntentsResponse Int
Creating a Request
data ListRecommendedIntents Source #
See: newListRecommendedIntents
smart constructor.
ListRecommendedIntents' | |
|
Instances
newListRecommendedIntents Source #
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> ListRecommendedIntents |
Create a value of ListRecommendedIntents
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:maxResults:ListRecommendedIntents'
, listRecommendedIntents_maxResults
- The maximum number of bot recommendations to return in each page of
results. If there are fewer results than the max page size, only the
actual number of results are returned.
ListRecommendedIntents
, listRecommendedIntents_nextToken
- If the response from the ListRecommendedIntents operation contains more
results than specified in the maxResults parameter, a token is returned
in the response. Use that token in the nextToken parameter to return the
next page of results.
ListRecommendedIntents
, listRecommendedIntents_botId
- The unique identifier of the bot associated with the recommended
intents.
ListRecommendedIntents
, listRecommendedIntents_botVersion
- The version of the bot that contains the recommended intents.
ListRecommendedIntents
, listRecommendedIntents_localeId
- The identifier of the language and locale of the recommended intents.
ListRecommendedIntents
, listRecommendedIntents_botRecommendationId
- The identifier of the bot recommendation that contains the recommended
intents.
Request Lenses
listRecommendedIntents_maxResults :: Lens' ListRecommendedIntents (Maybe Natural) Source #
The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
listRecommendedIntents_nextToken :: Lens' ListRecommendedIntents (Maybe Text) Source #
If the response from the ListRecommendedIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
listRecommendedIntents_botId :: Lens' ListRecommendedIntents Text Source #
The unique identifier of the bot associated with the recommended intents.
listRecommendedIntents_botVersion :: Lens' ListRecommendedIntents Text Source #
The version of the bot that contains the recommended intents.
listRecommendedIntents_localeId :: Lens' ListRecommendedIntents Text Source #
The identifier of the language and locale of the recommended intents.
listRecommendedIntents_botRecommendationId :: Lens' ListRecommendedIntents Text Source #
The identifier of the bot recommendation that contains the recommended intents.
Destructuring the Response
data ListRecommendedIntentsResponse Source #
See: newListRecommendedIntentsResponse
smart constructor.
ListRecommendedIntentsResponse' | |
|
Instances
newListRecommendedIntentsResponse Source #
Create a value of ListRecommendedIntentsResponse
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:
ListRecommendedIntents
, listRecommendedIntentsResponse_botId
- The unique identifier of the bot associated with the recommended intent.
ListRecommendedIntents
, listRecommendedIntentsResponse_botRecommendationId
- The identifier of the bot recommendation that contains the recommended
intent.
ListRecommendedIntents
, listRecommendedIntentsResponse_botVersion
- The version of the bot that contains the intent.
ListRecommendedIntents
, listRecommendedIntentsResponse_localeId
- The identifier of the language and locale of the intents to list. The
string must match one of the supported locales. For more information,
see
Supported languages.
ListRecommendedIntents
, listRecommendedIntentsResponse_nextToken
- A token that indicates whether there are more results to return in a
response to the ListRecommendedIntents operation. If the nextToken field
is present, you send the contents as the nextToken parameter of a
ListRecommendedIntents operation request to get the next page of
results.
$sel:summaryList:ListRecommendedIntentsResponse'
, listRecommendedIntentsResponse_summaryList
- Summary information for the intents that meet the filter criteria
specified in the request. The length of the list is specified in the
maxResults parameter of the request. If there are more intents
available, the nextToken field contains a token to get the next page of
results.
$sel:httpStatus:ListRecommendedIntentsResponse'
, listRecommendedIntentsResponse_httpStatus
- The response's http status code.
Response Lenses
listRecommendedIntentsResponse_botId :: Lens' ListRecommendedIntentsResponse (Maybe Text) Source #
The unique identifier of the bot associated with the recommended intent.
listRecommendedIntentsResponse_botRecommendationId :: Lens' ListRecommendedIntentsResponse (Maybe Text) Source #
The identifier of the bot recommendation that contains the recommended intent.
listRecommendedIntentsResponse_botVersion :: Lens' ListRecommendedIntentsResponse (Maybe Text) Source #
The version of the bot that contains the intent.
listRecommendedIntentsResponse_localeId :: Lens' ListRecommendedIntentsResponse (Maybe Text) Source #
The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
listRecommendedIntentsResponse_nextToken :: Lens' ListRecommendedIntentsResponse (Maybe Text) Source #
A token that indicates whether there are more results to return in a response to the ListRecommendedIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListRecommendedIntents operation request to get the next page of results.
listRecommendedIntentsResponse_summaryList :: Lens' ListRecommendedIntentsResponse (Maybe [RecommendedIntentSummary]) Source #
Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.
listRecommendedIntentsResponse_httpStatus :: Lens' ListRecommendedIntentsResponse Int Source #
The response's http status code.