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

Amazonka.LexV2Models.ListSlots

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of slots that match the specified criteria.

Synopsis

data ListSlots = ListSlots' {
- filters :: Maybe (NonEmpty SlotFilter)
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe SlotSortBy
- botId :: Text
- botVersion :: Text
- localeId :: Text
- intentId :: Text
}
newListSlots :: Text -> Text -> Text -> Text -> ListSlots
listSlots_filters :: Lens' ListSlots (Maybe (NonEmpty SlotFilter))
listSlots_maxResults :: Lens' ListSlots (Maybe Natural)
listSlots_nextToken :: Lens' ListSlots (Maybe Text)
listSlots_sortBy :: Lens' ListSlots (Maybe SlotSortBy)
listSlots_botId :: Lens' ListSlots Text
listSlots_botVersion :: Lens' ListSlots Text
listSlots_localeId :: Lens' ListSlots Text
listSlots_intentId :: Lens' ListSlots Text
data ListSlotsResponse = ListSlotsResponse' {
- botId :: Maybe Text
- botVersion :: Maybe Text
- intentId :: Maybe Text
- localeId :: Maybe Text
- nextToken :: Maybe Text
- slotSummaries :: Maybe [SlotSummary]
- httpStatus :: Int
}
newListSlotsResponse :: Int -> ListSlotsResponse
listSlotsResponse_botId :: Lens' ListSlotsResponse (Maybe Text)
listSlotsResponse_botVersion :: Lens' ListSlotsResponse (Maybe Text)
listSlotsResponse_intentId :: Lens' ListSlotsResponse (Maybe Text)
listSlotsResponse_localeId :: Lens' ListSlotsResponse (Maybe Text)
listSlotsResponse_nextToken :: Lens' ListSlotsResponse (Maybe Text)
listSlotsResponse_slotSummaries :: Lens' ListSlotsResponse (Maybe [SlotSummary])
listSlotsResponse_httpStatus :: Lens' ListSlotsResponse Int

Creating a Request

data ListSlots Source #

See: newListSlots smart constructor.

Constructors

ListSlots'

Fields

filters :: Maybe (NonEmpty SlotFilter)
Provides the specification of a filter used to limit the slots in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
maxResults :: Maybe Natural
The maximum number of slots 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.
nextToken :: Maybe Text
If the response from the ListSlots 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.
sortBy :: Maybe SlotSortBy
Determines the sort order for the response from the ListSlots operation. You can choose to sort by the slot name or last updated date in either ascending or descending order.
botId :: Text
The identifier of the bot that contains the slot.
botVersion :: Text
The version of the bot that contains the slot.
localeId :: Text
The identifier of the language and locale of the slots to list. The string must match one of the supported locales. For more information, see Supported languages.
intentId :: Text
The unique identifier of the intent that contains the slot.

Instances

Instances details

ToJSON ListSlots Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Methods toJSON :: ListSlots -> Value # toEncoding :: ListSlots -> Encoding # toJSONList :: [ListSlots] -> Value # toEncodingList :: [ListSlots] -> Encoding #
ToHeaders ListSlots Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Methods toHeaders :: ListSlots -> [Header] #
ToPath ListSlots Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Methods toPath :: ListSlots -> ByteString #
ToQuery ListSlots Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Methods toQuery :: ListSlots -> QueryString #
AWSRequest ListSlots Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Associated Types type AWSResponse ListSlots # Methods request :: (Service -> Service) -> ListSlots -> Request ListSlots # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSlots -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSlots))) #
Generic ListSlots Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Associated Types type Rep ListSlots :: Type -> Type # Methods from :: ListSlots -> Rep ListSlots x # to :: Rep ListSlots x -> ListSlots #
Read ListSlots Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Methods readsPrec :: Int -> ReadS ListSlots # readList :: ReadS [ListSlots] # readPrec :: ReadPrec ListSlots # readListPrec :: ReadPrec [ListSlots] #
Show ListSlots Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Methods showsPrec :: Int -> ListSlots -> ShowS # show :: ListSlots -> String # showList :: [ListSlots] -> ShowS #
NFData ListSlots Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Methods rnf :: ListSlots -> () #
Eq ListSlots Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Methods (==) :: ListSlots -> ListSlots -> Bool # (/=) :: ListSlots -> ListSlots -> Bool #
Hashable ListSlots Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Methods hashWithSalt :: Int -> ListSlots -> Int # hash :: ListSlots -> Int #
type AWSResponse ListSlots Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots type AWSResponse ListSlots = ListSlotsResponse
type Rep ListSlots Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots type Rep ListSlots = D1 ('MetaData "ListSlots" "Amazonka.LexV2Models.ListSlots" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "ListSlots'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SlotFilter))) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SlotSortBy)))) :: ((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "intentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListSlots Source #

Arguments

:: Text	`ListSlots`
-> Text	`ListSlots`
-> Text	`ListSlots`
-> Text	`ListSlots`
-> ListSlots

Create a value of ListSlots 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:ListSlots', listSlots_filters - Provides the specification of a filter used to limit the slots 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:ListSlots', listSlots_maxResults - The maximum number of slots 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.

ListSlots, listSlots_nextToken - If the response from the ListSlots 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:ListSlots', listSlots_sortBy - Determines the sort order for the response from the ListSlots operation. You can choose to sort by the slot name or last updated date in either ascending or descending order.

ListSlots, listSlots_botId - The identifier of the bot that contains the slot.

ListSlots, listSlots_botVersion - The version of the bot that contains the slot.

ListSlots, listSlots_localeId - The identifier of the language and locale of the slots to list. The string must match one of the supported locales. For more information, see Supported languages.

ListSlots, listSlots_intentId - The unique identifier of the intent that contains the slot.

Request Lenses

listSlots_filters :: Lens' ListSlots (Maybe (NonEmpty SlotFilter)) Source #

Provides the specification of a filter used to limit the slots in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.

listSlots_maxResults :: Lens' ListSlots (Maybe Natural) Source #

The maximum number of slots 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.

listSlots_nextToken :: Lens' ListSlots (Maybe Text) Source #

If the response from the ListSlots 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.

listSlots_sortBy :: Lens' ListSlots (Maybe SlotSortBy) Source #

Determines the sort order for the response from the ListSlots operation. You can choose to sort by the slot name or last updated date in either ascending or descending order.

listSlots_botId :: Lens' ListSlots Text Source #

The identifier of the bot that contains the slot.

listSlots_botVersion :: Lens' ListSlots Text Source #

The version of the bot that contains the slot.

listSlots_localeId :: Lens' ListSlots Text Source #

The identifier of the language and locale of the slots to list. The string must match one of the supported locales. For more information, see Supported languages.

listSlots_intentId :: Lens' ListSlots Text Source #

The unique identifier of the intent that contains the slot.

Destructuring the Response

data ListSlotsResponse Source #

See: newListSlotsResponse smart constructor.

Constructors

ListSlotsResponse'

Fields

botId :: Maybe Text
The identifier of the bot that contains the slots.
botVersion :: Maybe Text
The version of the bot that contains the slots.
intentId :: Maybe Text
The identifier of the intent that contains the slots.
localeId :: Maybe Text
The language and locale of the slots in the list.
nextToken :: Maybe Text
A token that indicates whether there are more results to return in a response to the ListSlots operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListSlots operation request to get the next page of results.
slotSummaries :: Maybe [SlotSummary]
Summary information for the slots 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 slots available, the nextToken field contains a token to get the next page of results.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListSlotsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Associated Types type Rep ListSlotsResponse :: Type -> Type # Methods from :: ListSlotsResponse -> Rep ListSlotsResponse x # to :: Rep ListSlotsResponse x -> ListSlotsResponse #
Read ListSlotsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Methods readsPrec :: Int -> ReadS ListSlotsResponse # readList :: ReadS [ListSlotsResponse] # readPrec :: ReadPrec ListSlotsResponse # readListPrec :: ReadPrec [ListSlotsResponse] #
Show ListSlotsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Methods showsPrec :: Int -> ListSlotsResponse -> ShowS # show :: ListSlotsResponse -> String # showList :: [ListSlotsResponse] -> ShowS #
NFData ListSlotsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Methods rnf :: ListSlotsResponse -> () #
Eq ListSlotsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots Methods (==) :: ListSlotsResponse -> ListSlotsResponse -> Bool # (/=) :: ListSlotsResponse -> ListSlotsResponse -> Bool #
type Rep ListSlotsResponse Source #
Instance details Defined in Amazonka.LexV2Models.ListSlots type Rep ListSlotsResponse = D1 ('MetaData "ListSlotsResponse" "Amazonka.LexV2Models.ListSlots" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "ListSlotsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "intentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "slotSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SlotSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newListSlotsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListSlotsResponse'`
-> ListSlotsResponse

Create a value of ListSlotsResponse 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:

ListSlots, listSlotsResponse_botId - The identifier of the bot that contains the slots.

ListSlots, listSlotsResponse_botVersion - The version of the bot that contains the slots.

ListSlots, listSlotsResponse_intentId - The identifier of the intent that contains the slots.

ListSlots, listSlotsResponse_localeId - The language and locale of the slots in the list.

ListSlots, listSlotsResponse_nextToken - A token that indicates whether there are more results to return in a response to the ListSlots operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListSlots operation request to get the next page of results.

$sel:slotSummaries:ListSlotsResponse', listSlotsResponse_slotSummaries - Summary information for the slots 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 slots available, the nextToken field contains a token to get the next page of results.

$sel:httpStatus:ListSlotsResponse', listSlotsResponse_httpStatus - The response's http status code.

Response Lenses

listSlotsResponse_botId :: Lens' ListSlotsResponse (Maybe Text) Source #

The identifier of the bot that contains the slots.

listSlotsResponse_botVersion :: Lens' ListSlotsResponse (Maybe Text) Source #

The version of the bot that contains the slots.

listSlotsResponse_intentId :: Lens' ListSlotsResponse (Maybe Text) Source #

The identifier of the intent that contains the slots.

listSlotsResponse_localeId :: Lens' ListSlotsResponse (Maybe Text) Source #

The language and locale of the slots in the list.

listSlotsResponse_nextToken :: Lens' ListSlotsResponse (Maybe Text) Source #

A token that indicates whether there are more results to return in a response to the ListSlots operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListSlots operation request to get the next page of results.

listSlotsResponse_slotSummaries :: Lens' ListSlotsResponse (Maybe [SlotSummary]) Source #

Summary information for the slots 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 slots available, the nextToken field contains a token to get the next page of results.

listSlotsResponse_httpStatus :: Lens' ListSlotsResponse Int Source #

The response's http status code.