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 |
Gets a list of slot types that match the specified criteria.
Synopsis
- data ListSlotTypes = ListSlotTypes' {
- filters :: Maybe (NonEmpty SlotTypeFilter)
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe SlotTypeSortBy
- botId :: Text
- botVersion :: Text
- localeId :: Text
- newListSlotTypes :: Text -> Text -> Text -> ListSlotTypes
- listSlotTypes_filters :: Lens' ListSlotTypes (Maybe (NonEmpty SlotTypeFilter))
- listSlotTypes_maxResults :: Lens' ListSlotTypes (Maybe Natural)
- listSlotTypes_nextToken :: Lens' ListSlotTypes (Maybe Text)
- listSlotTypes_sortBy :: Lens' ListSlotTypes (Maybe SlotTypeSortBy)
- listSlotTypes_botId :: Lens' ListSlotTypes Text
- listSlotTypes_botVersion :: Lens' ListSlotTypes Text
- listSlotTypes_localeId :: Lens' ListSlotTypes Text
- data ListSlotTypesResponse = ListSlotTypesResponse' {
- botId :: Maybe Text
- botVersion :: Maybe Text
- localeId :: Maybe Text
- nextToken :: Maybe Text
- slotTypeSummaries :: Maybe [SlotTypeSummary]
- httpStatus :: Int
- newListSlotTypesResponse :: Int -> ListSlotTypesResponse
- listSlotTypesResponse_botId :: Lens' ListSlotTypesResponse (Maybe Text)
- listSlotTypesResponse_botVersion :: Lens' ListSlotTypesResponse (Maybe Text)
- listSlotTypesResponse_localeId :: Lens' ListSlotTypesResponse (Maybe Text)
- listSlotTypesResponse_nextToken :: Lens' ListSlotTypesResponse (Maybe Text)
- listSlotTypesResponse_slotTypeSummaries :: Lens' ListSlotTypesResponse (Maybe [SlotTypeSummary])
- listSlotTypesResponse_httpStatus :: Lens' ListSlotTypesResponse Int
Creating a Request
data ListSlotTypes Source #
See: newListSlotTypes
smart constructor.
ListSlotTypes' | |
|
Instances
Create a value of ListSlotTypes
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:filters:ListSlotTypes'
, listSlotTypes_filters
- Provides the specification of a filter used to limit the slot types in
the response to only those that match the filter specification. You can
only specify one filter and only one string to filter on.
$sel:maxResults:ListSlotTypes'
, listSlotTypes_maxResults
- The maximum number of slot types 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.
ListSlotTypes
, listSlotTypes_nextToken
- If the response from the ListSlotTypes
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:ListSlotTypes'
, listSlotTypes_sortBy
- Determines the sort order for the response from the ListSlotTypes
operation. You can choose to sort by the slot type name or last updated
date in either ascending or descending order.
ListSlotTypes
, listSlotTypes_botId
- The unique identifier of the bot that contains the slot types.
ListSlotTypes
, listSlotTypes_botVersion
- The version of the bot that contains the slot type.
ListSlotTypes
, listSlotTypes_localeId
- The identifier of the language and locale of the slot types to list. The
string must match one of the supported locales. For more information,
see
Supported languages.
Request Lenses
listSlotTypes_filters :: Lens' ListSlotTypes (Maybe (NonEmpty SlotTypeFilter)) Source #
Provides the specification of a filter used to limit the slot types in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
listSlotTypes_maxResults :: Lens' ListSlotTypes (Maybe Natural) Source #
The maximum number of slot types 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.
listSlotTypes_nextToken :: Lens' ListSlotTypes (Maybe Text) Source #
If the response from the ListSlotTypes
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.
listSlotTypes_sortBy :: Lens' ListSlotTypes (Maybe SlotTypeSortBy) Source #
Determines the sort order for the response from the ListSlotTypes
operation. You can choose to sort by the slot type name or last updated
date in either ascending or descending order.
listSlotTypes_botId :: Lens' ListSlotTypes Text Source #
The unique identifier of the bot that contains the slot types.
listSlotTypes_botVersion :: Lens' ListSlotTypes Text Source #
The version of the bot that contains the slot type.
listSlotTypes_localeId :: Lens' ListSlotTypes Text Source #
The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see Supported languages.
Destructuring the Response
data ListSlotTypesResponse Source #
See: newListSlotTypesResponse
smart constructor.
ListSlotTypesResponse' | |
|
Instances
newListSlotTypesResponse Source #
Create a value of ListSlotTypesResponse
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:
ListSlotTypes
, listSlotTypesResponse_botId
- The identifier of the bot that contains the slot types.
ListSlotTypes
, listSlotTypesResponse_botVersion
- The version of the bot that contains the slot types.
ListSlotTypes
, listSlotTypesResponse_localeId
- The language and local of the slot types in the list.
ListSlotTypes
, listSlotTypesResponse_nextToken
- A token that indicates whether there are more results to return in a
response to the ListSlotTypes
operation. If the nextToken
field is
present, you send the contents as the nextToken
parameter of a
ListSlotTypes
operation request to get the next page of results.
$sel:slotTypeSummaries:ListSlotTypesResponse'
, listSlotTypesResponse_slotTypeSummaries
- Summary information for the slot types 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 slot types
available, the nextToken
field contains a token to get the next page
of results.
$sel:httpStatus:ListSlotTypesResponse'
, listSlotTypesResponse_httpStatus
- The response's http status code.
Response Lenses
listSlotTypesResponse_botId :: Lens' ListSlotTypesResponse (Maybe Text) Source #
The identifier of the bot that contains the slot types.
listSlotTypesResponse_botVersion :: Lens' ListSlotTypesResponse (Maybe Text) Source #
The version of the bot that contains the slot types.
listSlotTypesResponse_localeId :: Lens' ListSlotTypesResponse (Maybe Text) Source #
The language and local of the slot types in the list.
listSlotTypesResponse_nextToken :: Lens' ListSlotTypesResponse (Maybe Text) Source #
A token that indicates whether there are more results to return in a
response to the ListSlotTypes
operation. If the nextToken
field is
present, you send the contents as the nextToken
parameter of a
ListSlotTypes
operation request to get the next page of results.
listSlotTypesResponse_slotTypeSummaries :: Lens' ListSlotTypesResponse (Maybe [SlotTypeSummary]) Source #
Summary information for the slot types 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 slot types
available, the nextToken
field contains a token to get the next page
of results.
listSlotTypesResponse_httpStatus :: Lens' ListSlotTypesResponse Int Source #
The response's http status code.