| 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.LexV2Models.ListBuiltInIntents
Description
Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
To use a built-in intent as a the base for your own intent, include the
built-in intent signature in the parentIntentSignature parameter when
you call the CreateIntent operation. For more information, see
CreateIntent.
Synopsis
- data ListBuiltInIntents = ListBuiltInIntents' {}
- newListBuiltInIntents :: Text -> ListBuiltInIntents
- listBuiltInIntents_maxResults :: Lens' ListBuiltInIntents (Maybe Natural)
- listBuiltInIntents_nextToken :: Lens' ListBuiltInIntents (Maybe Text)
- listBuiltInIntents_sortBy :: Lens' ListBuiltInIntents (Maybe BuiltInIntentSortBy)
- listBuiltInIntents_localeId :: Lens' ListBuiltInIntents Text
- data ListBuiltInIntentsResponse = ListBuiltInIntentsResponse' {}
- newListBuiltInIntentsResponse :: Int -> ListBuiltInIntentsResponse
- listBuiltInIntentsResponse_builtInIntentSummaries :: Lens' ListBuiltInIntentsResponse (Maybe [BuiltInIntentSummary])
- listBuiltInIntentsResponse_localeId :: Lens' ListBuiltInIntentsResponse (Maybe Text)
- listBuiltInIntentsResponse_nextToken :: Lens' ListBuiltInIntentsResponse (Maybe Text)
- listBuiltInIntentsResponse_httpStatus :: Lens' ListBuiltInIntentsResponse Int
Creating a Request
data ListBuiltInIntents Source #
See: newListBuiltInIntents smart constructor.
Constructors
| ListBuiltInIntents' | |
Fields
| |
Instances
newListBuiltInIntents Source #
Arguments
| :: Text | |
| -> ListBuiltInIntents |
Create a value of ListBuiltInIntents 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:ListBuiltInIntents', listBuiltInIntents_maxResults - The maximum number of built-in intents 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.
ListBuiltInIntents, listBuiltInIntents_nextToken - If the response from the ListBuiltInIntents 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.
$sel:sortBy:ListBuiltInIntents', listBuiltInIntents_sortBy - Specifies sorting parameters for the list of built-in intents. You can
specify that the list be sorted by the built-in intent signature in
either ascending or descending order.
ListBuiltInIntents, listBuiltInIntents_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.
Request Lenses
listBuiltInIntents_maxResults :: Lens' ListBuiltInIntents (Maybe Natural) Source #
The maximum number of built-in intents 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.
listBuiltInIntents_nextToken :: Lens' ListBuiltInIntents (Maybe Text) Source #
If the response from the ListBuiltInIntents 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.
listBuiltInIntents_sortBy :: Lens' ListBuiltInIntents (Maybe BuiltInIntentSortBy) Source #
Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.
listBuiltInIntents_localeId :: Lens' ListBuiltInIntents 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.
Destructuring the Response
data ListBuiltInIntentsResponse Source #
See: newListBuiltInIntentsResponse smart constructor.
Constructors
| ListBuiltInIntentsResponse' | |
Fields
| |
Instances
newListBuiltInIntentsResponse Source #
Create a value of ListBuiltInIntentsResponse 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:builtInIntentSummaries:ListBuiltInIntentsResponse', listBuiltInIntentsResponse_builtInIntentSummaries - Summary information for the built-in 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.
ListBuiltInIntents, listBuiltInIntentsResponse_localeId - The language and locale of the intents in the list.
ListBuiltInIntents, listBuiltInIntentsResponse_nextToken - A token that indicates whether there are more results to return in a
response to the ListBuiltInIntents operation. If the nextToken field
is present, you send the contents as the nextToken parameter of a
ListBotAliases operation request to get the next page of results.
$sel:httpStatus:ListBuiltInIntentsResponse', listBuiltInIntentsResponse_httpStatus - The response's http status code.
Response Lenses
listBuiltInIntentsResponse_builtInIntentSummaries :: Lens' ListBuiltInIntentsResponse (Maybe [BuiltInIntentSummary]) Source #
Summary information for the built-in 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.
listBuiltInIntentsResponse_localeId :: Lens' ListBuiltInIntentsResponse (Maybe Text) Source #
The language and locale of the intents in the list.
listBuiltInIntentsResponse_nextToken :: Lens' ListBuiltInIntentsResponse (Maybe Text) Source #
A token that indicates whether there are more results to return in a
response to the ListBuiltInIntents operation. If the nextToken field
is present, you send the contents as the nextToken parameter of a
ListBotAliases operation request to get the next page of results.
listBuiltInIntentsResponse_httpStatus :: Lens' ListBuiltInIntentsResponse Int Source #
The response's http status code.