Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Returns intent information as follows:
- If you specify the
nameContains
field, returns the> LATEST
version of all intents that contain the specified string. - If you don't specify the
nameContains
field, returns information about the> LATEST
version of all intents.
The operation requires permission for the lex:GetIntents
action.
This operation returns paginated results.
Synopsis
- getIntents :: GetIntents
- data GetIntents
- giNameContains :: Lens' GetIntents (Maybe Text)
- giNextToken :: Lens' GetIntents (Maybe Text)
- giMaxResults :: Lens' GetIntents (Maybe Natural)
- getIntentsResponse :: Int -> GetIntentsResponse
- data GetIntentsResponse
- gisrsIntents :: Lens' GetIntentsResponse [IntentMetadata]
- gisrsNextToken :: Lens' GetIntentsResponse (Maybe Text)
- gisrsResponseStatus :: Lens' GetIntentsResponse Int
Creating a Request
getIntents :: GetIntents Source #
Creates a value of GetIntents
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
giNameContains
- 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."giNextToken
- 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.giMaxResults
- The maximum number of intents to return in the response. The default is 10.
data GetIntents Source #
See: getIntents
smart constructor.
Instances
Request Lenses
giNameContains :: 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."
giNextToken :: 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.
giMaxResults :: Lens' GetIntents (Maybe Natural) Source #
The maximum number of intents to return in the response. The default is 10.
Destructuring the Response
Creates a value of GetIntentsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gisrsIntents
- An array ofIntent
objects. For more information, seePutBot
.gisrsNextToken
- 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.gisrsResponseStatus
- -- | The response status code.
data GetIntentsResponse Source #
See: getIntentsResponse
smart constructor.
Instances
Response Lenses
gisrsIntents :: Lens' GetIntentsResponse [IntentMetadata] Source #
An array of Intent
objects. For more information, see PutBot
.
gisrsNextToken :: 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.
gisrsResponseStatus :: Lens' GetIntentsResponse Int Source #
- - | The response status code.