| 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.GetSlotTypes
Description
Returns slot type information as follows:
- If you specify the
nameContainsfield, returns the$LATESTversion of all slot types that contain the specified string. - If you don't specify the
nameContainsfield, returns information about the$LATESTversion of all slot types.
The operation requires permission for the lex:GetSlotTypes action.
This operation returns paginated results.
Synopsis
- data GetSlotTypes = GetSlotTypes' {}
- newGetSlotTypes :: GetSlotTypes
- getSlotTypes_nameContains :: Lens' GetSlotTypes (Maybe Text)
- getSlotTypes_nextToken :: Lens' GetSlotTypes (Maybe Text)
- getSlotTypes_maxResults :: Lens' GetSlotTypes (Maybe Natural)
- data GetSlotTypesResponse = GetSlotTypesResponse' {
- nextToken :: Maybe Text
- slotTypes :: Maybe [SlotTypeMetadata]
- httpStatus :: Int
- newGetSlotTypesResponse :: Int -> GetSlotTypesResponse
- getSlotTypesResponse_nextToken :: Lens' GetSlotTypesResponse (Maybe Text)
- getSlotTypesResponse_slotTypes :: Lens' GetSlotTypesResponse (Maybe [SlotTypeMetadata])
- getSlotTypesResponse_httpStatus :: Lens' GetSlotTypesResponse Int
Creating a Request
data GetSlotTypes Source #
See: newGetSlotTypes smart constructor.
Constructors
| GetSlotTypes' | |
Fields
| |
Instances
newGetSlotTypes :: GetSlotTypes Source #
Create a value of GetSlotTypes 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:GetSlotTypes', getSlotTypes_nameContains - Substring to match in slot type names. A slot type will be returned if
any part of its name matches the substring. For example, "xyz" matches
both "xyzabc" and "abcxyz."
$sel:nextToken:GetSlotTypes', getSlotTypes_nextToken - A pagination token that fetches the next page of slot types. If the
response to this API call is truncated, Amazon Lex returns a pagination
token in the response. To fetch next page of slot types, specify the
pagination token in the next request.
$sel:maxResults:GetSlotTypes', getSlotTypes_maxResults - The maximum number of slot types to return in the response. The default
is 10.
Request Lenses
getSlotTypes_nameContains :: Lens' GetSlotTypes (Maybe Text) Source #
Substring to match in slot type names. A slot type will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
getSlotTypes_nextToken :: Lens' GetSlotTypes (Maybe Text) Source #
A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch next page of slot types, specify the pagination token in the next request.
getSlotTypes_maxResults :: Lens' GetSlotTypes (Maybe Natural) Source #
The maximum number of slot types to return in the response. The default is 10.
Destructuring the Response
data GetSlotTypesResponse Source #
See: newGetSlotTypesResponse smart constructor.
Constructors
| GetSlotTypesResponse' | |
Fields
| |
Instances
newGetSlotTypesResponse Source #
Arguments
| :: Int | |
| -> GetSlotTypesResponse |
Create a value of GetSlotTypesResponse 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:nextToken:GetSlotTypes', getSlotTypesResponse_nextToken - If the response is truncated, it includes a pagination token that you
can specify in your next request to fetch the next page of slot types.
$sel:slotTypes:GetSlotTypesResponse', getSlotTypesResponse_slotTypes - An array of objects, one for each slot type, that provides information
such as the name of the slot type, the version, and a description.
$sel:httpStatus:GetSlotTypesResponse', getSlotTypesResponse_httpStatus - The response's http status code.
Response Lenses
getSlotTypesResponse_nextToken :: Lens' GetSlotTypesResponse (Maybe Text) Source #
If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of slot types.
getSlotTypesResponse_slotTypes :: Lens' GetSlotTypesResponse (Maybe [SlotTypeMetadata]) Source #
An array of objects, one for each slot type, that provides information such as the name of the slot type, the version, and a description.
getSlotTypesResponse_httpStatus :: Lens' GetSlotTypesResponse Int Source #
The response's http status code.