LexModelsV2 / Client / list_built_in_slot_types

list_built_in_slot_types#

LexModelsV2.Client.list_built_in_slot_types(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_built_in_slot_types(
    localeId='string',
    sortBy={
        'attribute': 'SlotTypeSignature',
        'order': 'Ascending'|'Descending'
    },
    maxResults=123,
    nextToken='string'
)
Parameters:

  • localeId (string) –

    [REQUIRED]

    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.

  • sortBy (dict) –

    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.

    • attribute (string) – [REQUIRED]

      The attribute to use to sort the list of built-in intents.

    • order (string) – [REQUIRED]

      The order to sort the list. You can choose ascending or descending.

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

Return type:

dict

Returns:

Response Syntax

{
    'builtInSlotTypeSummaries': [
        {
            'slotTypeSignature': 'string',
            'description': 'string'
        },
    ],
    'nextToken': 'string',
    'localeId': 'string'
}

Response Structure

  • (dict) –

    • builtInSlotTypeSummaries (list) –

      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.

      • (dict) –

        Provides summary information about a built-in slot type for the ListBuiltInSlotTypes operation.

        • slotTypeSignature (string) –

          The signature of the built-in slot type. Use this to specify the parent slot type of a derived slot type.

        • description (string) –

          The description of the built-in slot type.

    • nextToken (string) –

      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.

    • localeId (string) –

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

Exceptions