| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.LexModels.GetBuiltinIntents
Description
Gets a list of built-in intents that meet the specified criteria.
This operation requires permission for the lex:GetBuiltinIntents
action.
This operation returns paginated results.
Synopsis
- data GetBuiltinIntents = GetBuiltinIntents' {}
- newGetBuiltinIntents :: GetBuiltinIntents
- getBuiltinIntents_locale :: Lens' GetBuiltinIntents (Maybe Locale)
- getBuiltinIntents_nextToken :: Lens' GetBuiltinIntents (Maybe Text)
- getBuiltinIntents_signatureContains :: Lens' GetBuiltinIntents (Maybe Text)
- getBuiltinIntents_maxResults :: Lens' GetBuiltinIntents (Maybe Natural)
- data GetBuiltinIntentsResponse = GetBuiltinIntentsResponse' {
- intents :: Maybe [BuiltinIntentMetadata]
- nextToken :: Maybe Text
- httpStatus :: Int
- newGetBuiltinIntentsResponse :: Int -> GetBuiltinIntentsResponse
- getBuiltinIntentsResponse_intents :: Lens' GetBuiltinIntentsResponse (Maybe [BuiltinIntentMetadata])
- getBuiltinIntentsResponse_nextToken :: Lens' GetBuiltinIntentsResponse (Maybe Text)
- getBuiltinIntentsResponse_httpStatus :: Lens' GetBuiltinIntentsResponse Int
Creating a Request
data GetBuiltinIntents Source #
See: newGetBuiltinIntents smart constructor.
Constructors
| GetBuiltinIntents' | |
Fields
| |
Instances
newGetBuiltinIntents :: GetBuiltinIntents Source #
Create a value of GetBuiltinIntents 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:locale:GetBuiltinIntents', getBuiltinIntents_locale - A list of locales that the intent supports.
$sel:nextToken:GetBuiltinIntents', getBuiltinIntents_nextToken - A pagination token that fetches the next page of intents. If this API
call is truncated, Amazon Lex returns a pagination token in the
response. To fetch the next page of intents, use the pagination token in
the next request.
$sel:signatureContains:GetBuiltinIntents', getBuiltinIntents_signatureContains - Substring to match in built-in intent signatures. An intent will be
returned if any part of its signature matches the substring. For
example, "xyz" matches both "xyzabc" and "abcxyz." To find the
signature for an intent, see
Standard Built-in Intents
in the Alexa Skills Kit.
$sel:maxResults:GetBuiltinIntents', getBuiltinIntents_maxResults - The maximum number of intents to return in the response. The default is
10.
Request Lenses
getBuiltinIntents_locale :: Lens' GetBuiltinIntents (Maybe Locale) Source #
A list of locales that the intent supports.
getBuiltinIntents_nextToken :: Lens' GetBuiltinIntents (Maybe Text) Source #
A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, use the pagination token in the next request.
getBuiltinIntents_signatureContains :: Lens' GetBuiltinIntents (Maybe Text) Source #
Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
getBuiltinIntents_maxResults :: Lens' GetBuiltinIntents (Maybe Natural) Source #
The maximum number of intents to return in the response. The default is 10.
Destructuring the Response
data GetBuiltinIntentsResponse Source #
See: newGetBuiltinIntentsResponse smart constructor.
Constructors
| GetBuiltinIntentsResponse' | |
Fields
| |
Instances
newGetBuiltinIntentsResponse Source #
Create a value of GetBuiltinIntentsResponse 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:intents:GetBuiltinIntentsResponse', getBuiltinIntentsResponse_intents - An array of builtinIntentMetadata objects, one for each intent in the
response.
$sel:nextToken:GetBuiltinIntents', getBuiltinIntentsResponse_nextToken - A pagination token that fetches the next page of intents. If the
response to this API call is truncated, Amazon Lex returns a pagination
token in the response. To fetch the next page of intents, specify the
pagination token in the next request.
$sel:httpStatus:GetBuiltinIntentsResponse', getBuiltinIntentsResponse_httpStatus - The response's http status code.
Response Lenses
getBuiltinIntentsResponse_intents :: Lens' GetBuiltinIntentsResponse (Maybe [BuiltinIntentMetadata]) Source #
An array of builtinIntentMetadata objects, one for each intent in the
response.
getBuiltinIntentsResponse_nextToken :: Lens' GetBuiltinIntentsResponse (Maybe Text) Source #
A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.
getBuiltinIntentsResponse_httpStatus :: Lens' GetBuiltinIntentsResponse Int Source #
The response's http status code.