amazonka-lexv2-models-2.0: Amazon Lex Model Building V2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.LexV2Models.ListSlotTypes

Description

Gets a list of slot types that match the specified criteria.

Synopsis

Creating a Request

data ListSlotTypes Source #

See: newListSlotTypes smart constructor.

Constructors

ListSlotTypes' 

Fields

  • filters :: Maybe (NonEmpty SlotTypeFilter)

    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.

  • maxResults :: Maybe Natural

    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.

  • nextToken :: Maybe Text

    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.

  • sortBy :: Maybe SlotTypeSortBy

    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.

  • botId :: Text

    The unique identifier of the bot that contains the slot types.

  • botVersion :: Text

    The version of the bot that contains the slot type.

  • localeId :: Text

    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.

Instances

Instances details
ToJSON ListSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

ToHeaders ListSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

ToPath ListSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

ToQuery ListSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

AWSRequest ListSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

Associated Types

type AWSResponse ListSlotTypes #

Generic ListSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

Associated Types

type Rep ListSlotTypes :: Type -> Type #

Read ListSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

Show ListSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

NFData ListSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

Methods

rnf :: ListSlotTypes -> () #

Eq ListSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

Hashable ListSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

type AWSResponse ListSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

type Rep ListSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

newListSlotTypes Source #

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.

Constructors

ListSlotTypesResponse' 

Fields

  • botId :: Maybe Text

    The identifier of the bot that contains the slot types.

  • botVersion :: Maybe Text

    The version of the bot that contains the slot types.

  • localeId :: Maybe Text

    The language and local of the slot types in the list.

  • nextToken :: Maybe Text

    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.

  • slotTypeSummaries :: Maybe [SlotTypeSummary]

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

Associated Types

type Rep ListSlotTypesResponse :: Type -> Type #

Read ListSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

Show ListSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

NFData ListSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

Methods

rnf :: ListSlotTypesResponse -> () #

Eq ListSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

type Rep ListSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.ListSlotTypes

type Rep ListSlotTypesResponse = D1 ('MetaData "ListSlotTypesResponse" "Amazonka.LexV2Models.ListSlotTypes" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "ListSlotTypesResponse'" '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 "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "slotTypeSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SlotTypeSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

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.