LexModelsV2 / Client / list_slot_types

list_slot_types#

LexModelsV2.Client.list_slot_types(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_slot_types(
    botId='string',
    botVersion='string',
    localeId='string',
    sortBy={
        'attribute': 'SlotTypeName'|'LastUpdatedDateTime',
        'order': 'Ascending'|'Descending'
    },
    filters=[
        {
            'name': 'SlotTypeName'|'ExternalSourceType',
            'values': [
                'string',
            ],
            'operator': 'CO'|'EQ'
        },
    ],
    maxResults=123,
    nextToken='string'
)
Parameters:

  • botId (string) –

    [REQUIRED]

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

  • botVersion (string) –

    [REQUIRED]

    The version of the bot that contains the slot type.

  • 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 ListSlotTypes operation. You can choose to sort by the slot type name or last updated date in either ascending or descending order.

    • attribute (string) – [REQUIRED]

      The attribute to use to sort the list of slot types.

    • order (string) – [REQUIRED]

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

  • filters (list) –

    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.

    • (dict) –

      Filters the response from the ListSlotTypes operation.

      • name (string) – [REQUIRED]

        The name of the field to use for filtering.

      • values (list) – [REQUIRED]

        The value to use to filter the response.

        • (string) –

      • operator (string) – [REQUIRED]

        The operator to use for the filter. Specify EQ when the ListSlotTypes operation should return only aliases that equal the specified value. Specify CO when the ListSlotTypes operation should return aliases that contain the specified value.

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

Return type:

dict

Returns:

Response Syntax

{
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'slotTypeSummaries': [
        {
            'slotTypeId': 'string',
            'slotTypeName': 'string',
            'description': 'string',
            'parentSlotTypeSignature': 'string',
            'lastUpdatedDateTime': datetime(2015, 1, 1),
            'slotTypeCategory': 'Custom'|'Extended'|'ExternalGrammar'|'Composite'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • botId (string) –

      The identifier of the bot that contains the slot types.

    • botVersion (string) –

      The version of the bot that contains the slot types.

    • localeId (string) –

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

    • slotTypeSummaries (list) –

      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.

      • (dict) –

        Provides summary information about a slot type.

        • slotTypeId (string) –

          The unique identifier assigned to the slot type.

        • slotTypeName (string) –

          The name of the slot type.

        • description (string) –

          The description of the slot type.

        • parentSlotTypeSignature (string) –

          If the slot type is derived from a built-on slot type, the name of the parent slot type.

        • lastUpdatedDateTime (datetime) –

          A timestamp of the date and time that the slot type was last updated.

        • slotTypeCategory (string) –

          Indicates the type of the slot type.

          • Custom - A slot type that you created using custom values. For more information, see Creating custom slot types.

          • Extended - A slot type created by extending the AMAZON.AlphaNumeric built-in slot type. For more information, see AMAZON.AlphaNumeric.

          • ExternalGrammar - A slot type using a custom GRXML grammar to define values. For more information, see Using a custom grammar slot type.

    • nextToken (string) –

      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.

Exceptions