LexModelBuildingService / Client / get_builtin_slot_types

get_builtin_slot_types#

LexModelBuildingService.Client.get_builtin_slot_types(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.get_builtin_slot_types(
    locale='de-DE'|'en-AU'|'en-GB'|'en-IN'|'en-US'|'es-419'|'es-ES'|'es-US'|'fr-FR'|'fr-CA'|'it-IT'|'ja-JP'|'ko-KR',
    signatureContains='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • locale (string) – A list of locales that the slot type supports.

  • signatureContains (string) – 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.”

  • nextToken (string) – 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.

  • maxResults (integer) – The maximum number of slot types to return in the response. The default is 10.

Return type:

dict

Returns:

Response Syntax

{
    'slotTypes': [
        {
            'signature': 'string',
            'supportedLocales': [
                'de-DE'|'en-AU'|'en-GB'|'en-IN'|'en-US'|'es-419'|'es-ES'|'es-US'|'fr-FR'|'fr-CA'|'it-IT'|'ja-JP'|'ko-KR',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • slotTypes (list) –

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

      • (dict) –

        Provides information about a built in slot type.

        • signature (string) –

          A unique identifier for the built-in slot type. To find the signature for a slot type, see Slot Type Reference in the Alexa Skills Kit.

        • supportedLocales (list) –

          A list of target locales for the slot.

          • (string) –

    • nextToken (string) –

      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.

Exceptions

  • LexModelBuildingService.Client.exceptions.LimitExceededException

  • LexModelBuildingService.Client.exceptions.InternalFailureException

  • LexModelBuildingService.Client.exceptions.BadRequestException