Skip to content

GetMigrationsRequest

Source code in docs_src/capo_lex_model_building_service/types/get_migrations_request.py
class GetMigrationsRequest(TypedDict, closed=True):
    sort_by_attribute: NotRequired[
        "capo_lex_model_building_service.types.migration_sort_attribute.MigrationSortAttribute"
    ]
    """<p>The field to sort the list of migrations by. You can sort by the Amazon Lex V1 bot name or the date and time that the migration was started.</p>"""
    sort_by_order: NotRequired[
        "capo_lex_model_building_service.types.sort_order.SortOrder"
    ]
    """<p>The order so sort the list.</p>"""
    v1_bot_name_contains: NotRequired[
        "capo_lex_model_building_service.types.bot_name.BotName"
    ]
    """<p>Filters the list to contain only bots whose name contains the specified string. The string is matched anywhere in bot name.</p>"""
    migration_status_equals: NotRequired[
        "capo_lex_model_building_service.types.migration_status.MigrationStatus"
    ]
    """<p>Filters the list to contain only migrations in the specified state.</p>"""
    max_results: NotRequired[
        "capo_lex_model_building_service.types.max_results.MaxResults"
    ]
    """<p>The maximum number of migrations to return in the response. The default is 10.</p>"""
    next_token: NotRequired[
        "capo_lex_model_building_service.types.next_token.NextToken"
    ]
    """<p>A pagination token that fetches the next page of migrations. If the response to this operation is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of migrations, specify the pagination token in the request.</p>"""

max_results instance-attribute

max_results: NotRequired[MaxResults]

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

migration_status_equals instance-attribute

migration_status_equals: NotRequired[MigrationStatus]

Filters the list to contain only migrations in the specified state.

next_token instance-attribute

next_token: NotRequired[NextToken]

A pagination token that fetches the next page of migrations. If the response to this operation is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of migrations, specify the pagination token in the request.

sort_by_attribute instance-attribute

sort_by_attribute: NotRequired[MigrationSortAttribute]

The field to sort the list of migrations by. You can sort by the Amazon Lex V1 bot name or the date and time that the migration was started.

sort_by_order instance-attribute

sort_by_order: NotRequired[SortOrder]

The order so sort the list.

v1_bot_name_contains instance-attribute

v1_bot_name_contains: NotRequired[BotName]

Filters the list to contain only bots whose name contains the specified string. The string is matched anywhere in bot name.