amazonka-lex-models-2.0: Amazon Lex Model Building Service 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.LexModels.GetBuiltinSlotTypes

Description

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

For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.

This operation requires permission for the lex:GetBuiltInSlotTypes action.

This operation returns paginated results.

Synopsis

Creating a Request

data GetBuiltinSlotTypes Source #

See: newGetBuiltinSlotTypes smart constructor.

Constructors

GetBuiltinSlotTypes' 

Fields

  • locale :: Maybe Locale

    A list of locales that the slot type supports.

  • maxResults :: Maybe Natural

    The maximum number of slot types to return in the response. The default is 10.

  • nextToken :: Maybe Text

    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 the next page of slot types, specify the pagination token in the next request.

  • signatureContains :: Maybe Text

    Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

Instances

Instances details
ToHeaders GetBuiltinSlotTypes Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

ToPath GetBuiltinSlotTypes Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

ToQuery GetBuiltinSlotTypes Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

AWSPager GetBuiltinSlotTypes Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

AWSRequest GetBuiltinSlotTypes Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

Associated Types

type AWSResponse GetBuiltinSlotTypes #

Generic GetBuiltinSlotTypes Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

Associated Types

type Rep GetBuiltinSlotTypes :: Type -> Type #

Read GetBuiltinSlotTypes Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

Show GetBuiltinSlotTypes Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

NFData GetBuiltinSlotTypes Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

Methods

rnf :: GetBuiltinSlotTypes -> () #

Eq GetBuiltinSlotTypes Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

Hashable GetBuiltinSlotTypes Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

type AWSResponse GetBuiltinSlotTypes Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

type Rep GetBuiltinSlotTypes Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

type Rep GetBuiltinSlotTypes = D1 ('MetaData "GetBuiltinSlotTypes" "Amazonka.LexModels.GetBuiltinSlotTypes" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "GetBuiltinSlotTypes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "locale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Locale)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "signatureContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newGetBuiltinSlotTypes :: GetBuiltinSlotTypes Source #

Create a value of GetBuiltinSlotTypes 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:locale:GetBuiltinSlotTypes', getBuiltinSlotTypes_locale - A list of locales that the slot type supports.

$sel:maxResults:GetBuiltinSlotTypes', getBuiltinSlotTypes_maxResults - The maximum number of slot types to return in the response. The default is 10.

GetBuiltinSlotTypes, getBuiltinSlotTypes_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 the next page of slot types, specify the pagination token in the next request.

$sel:signatureContains:GetBuiltinSlotTypes', getBuiltinSlotTypes_signatureContains - Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

Request Lenses

getBuiltinSlotTypes_locale :: Lens' GetBuiltinSlotTypes (Maybe Locale) Source #

A list of locales that the slot type supports.

getBuiltinSlotTypes_maxResults :: Lens' GetBuiltinSlotTypes (Maybe Natural) Source #

The maximum number of slot types to return in the response. The default is 10.

getBuiltinSlotTypes_nextToken :: Lens' GetBuiltinSlotTypes (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 the next page of slot types, specify the pagination token in the next request.

getBuiltinSlotTypes_signatureContains :: Lens' GetBuiltinSlotTypes (Maybe Text) Source #

Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

Destructuring the Response

data GetBuiltinSlotTypesResponse Source #

See: newGetBuiltinSlotTypesResponse smart constructor.

Constructors

GetBuiltinSlotTypesResponse' 

Fields

  • nextToken :: Maybe Text

    If the response is truncated, the response includes a pagination token that you can use in your next request to fetch the next page of slot types.

  • slotTypes :: Maybe [BuiltinSlotTypeMetadata]

    An array of BuiltInSlotTypeMetadata objects, one entry for each slot type returned.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetBuiltinSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

Associated Types

type Rep GetBuiltinSlotTypesResponse :: Type -> Type #

Read GetBuiltinSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

Show GetBuiltinSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

NFData GetBuiltinSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

Eq GetBuiltinSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

type Rep GetBuiltinSlotTypesResponse Source # 
Instance details

Defined in Amazonka.LexModels.GetBuiltinSlotTypes

type Rep GetBuiltinSlotTypesResponse = D1 ('MetaData "GetBuiltinSlotTypesResponse" "Amazonka.LexModels.GetBuiltinSlotTypes" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "GetBuiltinSlotTypesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "slotTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BuiltinSlotTypeMetadata])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetBuiltinSlotTypesResponse Source #

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

GetBuiltinSlotTypes, getBuiltinSlotTypesResponse_nextToken - If the response is truncated, the response includes a pagination token that you can use in your next request to fetch the next page of slot types.

$sel:slotTypes:GetBuiltinSlotTypesResponse', getBuiltinSlotTypesResponse_slotTypes - An array of BuiltInSlotTypeMetadata objects, one entry for each slot type returned.

$sel:httpStatus:GetBuiltinSlotTypesResponse', getBuiltinSlotTypesResponse_httpStatus - The response's http status code.

Response Lenses

getBuiltinSlotTypesResponse_nextToken :: Lens' GetBuiltinSlotTypesResponse (Maybe Text) Source #

If the response is truncated, the response includes a pagination token that you can use in your next request to fetch the next page of slot types.

getBuiltinSlotTypesResponse_slotTypes :: Lens' GetBuiltinSlotTypesResponse (Maybe [BuiltinSlotTypeMetadata]) Source #

An array of BuiltInSlotTypeMetadata objects, one entry for each slot type returned.