| 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.GetIntents
Description
Returns intent information as follows:
- If you specify the
nameContainsfield, returns the$LATESTversion of all intents that contain the specified string. - If you don't specify the
nameContainsfield, returns information about the$LATESTversion of all intents.
The operation requires permission for the lex:GetIntents action.
This operation returns paginated results.
Synopsis
- data GetIntents = GetIntents' {}
- newGetIntents :: GetIntents
- getIntents_nameContains :: Lens' GetIntents (Maybe Text)
- getIntents_nextToken :: Lens' GetIntents (Maybe Text)
- getIntents_maxResults :: Lens' GetIntents (Maybe Natural)
- data GetIntentsResponse = GetIntentsResponse' {
- intents :: Maybe [IntentMetadata]
- nextToken :: Maybe Text
- httpStatus :: Int
- newGetIntentsResponse :: Int -> GetIntentsResponse
- getIntentsResponse_intents :: Lens' GetIntentsResponse (Maybe [IntentMetadata])
- getIntentsResponse_nextToken :: Lens' GetIntentsResponse (Maybe Text)
- getIntentsResponse_httpStatus :: Lens' GetIntentsResponse Int
Creating a Request
data GetIntents Source #
See: newGetIntents smart constructor.
Constructors
| GetIntents' | |
Fields
| |
Instances
newGetIntents :: GetIntents Source #
Create a value of GetIntents 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:nameContains:GetIntents', getIntents_nameContains - Substring to match in intent names. An intent will be returned if any
part of its name matches the substring. For example, "xyz" matches
both "xyzabc" and "abcxyz."
$sel:nextToken:GetIntents', getIntents_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:maxResults:GetIntents', getIntents_maxResults - The maximum number of intents to return in the response. The default is
10.
Request Lenses
getIntents_nameContains :: Lens' GetIntents (Maybe Text) Source #
Substring to match in intent names. An intent will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
getIntents_nextToken :: Lens' GetIntents (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.
getIntents_maxResults :: Lens' GetIntents (Maybe Natural) Source #
The maximum number of intents to return in the response. The default is 10.
Destructuring the Response
data GetIntentsResponse Source #
See: newGetIntentsResponse smart constructor.
Constructors
| GetIntentsResponse' | |
Fields
| |
Instances
newGetIntentsResponse Source #
Arguments
| :: Int | |
| -> GetIntentsResponse |
Create a value of GetIntentsResponse 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:GetIntentsResponse', getIntentsResponse_intents - An array of Intent objects. For more information, see PutBot.
$sel:nextToken:GetIntents', getIntentsResponse_nextToken - If the response is truncated, the response includes a pagination token
that you can specify in your next request to fetch the next page of
intents.
$sel:httpStatus:GetIntentsResponse', getIntentsResponse_httpStatus - The response's http status code.
Response Lenses
getIntentsResponse_intents :: Lens' GetIntentsResponse (Maybe [IntentMetadata]) Source #
An array of Intent objects. For more information, see PutBot.
getIntentsResponse_nextToken :: Lens' GetIntentsResponse (Maybe Text) Source #
If the response is truncated, the response includes a pagination token that you can specify in your next request to fetch the next page of intents.
getIntentsResponse_httpStatus :: Lens' GetIntentsResponse Int Source #
The response's http status code.