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.ListBuiltInSlotTypes

Description

Gets a list of built-in slot types that meet the specified criteria.

Synopsis

Creating a Request

data ListBuiltInSlotTypes Source #

See: newListBuiltInSlotTypes smart constructor.

Constructors

ListBuiltInSlotTypes' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of built-in 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 ListBuiltInSlotTypes 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 BuiltInSlotTypeSortBy

    Determines the sort order for the response from the ListBuiltInSlotTypes operation. You can choose to sort by the slot type signature in either ascending or descending order.

  • 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 ListBuiltInSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

ToHeaders ListBuiltInSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

ToPath ListBuiltInSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

ToQuery ListBuiltInSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

AWSRequest ListBuiltInSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

Associated Types

type AWSResponse ListBuiltInSlotTypes #

Generic ListBuiltInSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

Associated Types

type Rep ListBuiltInSlotTypes :: Type -> Type #

Read ListBuiltInSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

Show ListBuiltInSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

NFData ListBuiltInSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

Methods

rnf :: ListBuiltInSlotTypes -> () #

Eq ListBuiltInSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

Hashable ListBuiltInSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

type AWSResponse ListBuiltInSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

type Rep ListBuiltInSlotTypes Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

type Rep ListBuiltInSlotTypes = D1 ('MetaData "ListBuiltInSlotTypes" "Amazonka.LexV2Models.ListBuiltInSlotTypes" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "ListBuiltInSlotTypes'" 'PrefixI 'True) ((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 BuiltInSlotTypeSortBy)) :*: S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListBuiltInSlotTypes Source #

Create a value of ListBuiltInSlotTypes 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:maxResults:ListBuiltInSlotTypes', listBuiltInSlotTypes_maxResults - The maximum number of built-in 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.

ListBuiltInSlotTypes, listBuiltInSlotTypes_nextToken - If the response from the ListBuiltInSlotTypes 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:ListBuiltInSlotTypes', listBuiltInSlotTypes_sortBy - Determines the sort order for the response from the ListBuiltInSlotTypes operation. You can choose to sort by the slot type signature in either ascending or descending order.

ListBuiltInSlotTypes, listBuiltInSlotTypes_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

listBuiltInSlotTypes_maxResults :: Lens' ListBuiltInSlotTypes (Maybe Natural) Source #

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

listBuiltInSlotTypes_nextToken :: Lens' ListBuiltInSlotTypes (Maybe Text) Source #

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

listBuiltInSlotTypes_sortBy :: Lens' ListBuiltInSlotTypes (Maybe BuiltInSlotTypeSortBy) Source #

Determines the sort order for the response from the ListBuiltInSlotTypes operation. You can choose to sort by the slot type signature in either ascending or descending order.

listBuiltInSlotTypes_localeId :: Lens' ListBuiltInSlotTypes 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 ListBuiltInSlotTypesResponse Source #

See: newListBuiltInSlotTypesResponse smart constructor.

Constructors

ListBuiltInSlotTypesResponse' 

Fields

  • builtInSlotTypeSummaries :: Maybe [BuiltInSlotTypeSummary]

    Summary information for the built-in 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.

  • localeId :: Maybe Text

    The language and locale 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 ListBuiltInSlotTypes operation. If the nextToken field is present, you send the contents as the nextToken parameter of a LIstBuiltInSlotTypes operation request to get the next page of results.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListBuiltInSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

Associated Types

type Rep ListBuiltInSlotTypesResponse :: Type -> Type #

Read ListBuiltInSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

Show ListBuiltInSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

NFData ListBuiltInSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

Eq ListBuiltInSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

type Rep ListBuiltInSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.ListBuiltInSlotTypes

type Rep ListBuiltInSlotTypesResponse = D1 ('MetaData "ListBuiltInSlotTypesResponse" "Amazonka.LexV2Models.ListBuiltInSlotTypes" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "ListBuiltInSlotTypesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "builtInSlotTypeSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BuiltInSlotTypeSummary])) :*: S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListBuiltInSlotTypesResponse Source #

Create a value of ListBuiltInSlotTypesResponse 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:builtInSlotTypeSummaries:ListBuiltInSlotTypesResponse', listBuiltInSlotTypesResponse_builtInSlotTypeSummaries - Summary information for the built-in 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.

ListBuiltInSlotTypes, listBuiltInSlotTypesResponse_localeId - The language and locale of the slot types in the list.

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

$sel:httpStatus:ListBuiltInSlotTypesResponse', listBuiltInSlotTypesResponse_httpStatus - The response's http status code.

Response Lenses

listBuiltInSlotTypesResponse_builtInSlotTypeSummaries :: Lens' ListBuiltInSlotTypesResponse (Maybe [BuiltInSlotTypeSummary]) Source #

Summary information for the built-in 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.

listBuiltInSlotTypesResponse_localeId :: Lens' ListBuiltInSlotTypesResponse (Maybe Text) Source #

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

listBuiltInSlotTypesResponse_nextToken :: Lens' ListBuiltInSlotTypesResponse (Maybe Text) Source #

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