Skip to content

StartMigrationRequest

Source code in docs_src/capo_lex_model_building_service/types/start_migration_request.py
class StartMigrationRequest(TypedDict, closed=True):
    v1_bot_name: "capo_lex_model_building_service.types.bot_name.BotName"
    """<p>The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.</p>"""
    v1_bot_version: "capo_lex_model_building_service.types.version.Version"
    """<p>The version of the bot to migrate to Amazon Lex V2. You can migrate the <code>$LATEST</code> version as well as any numbered version.</p>"""
    v2_bot_name: "capo_lex_model_building_service.types.v2_bot_name.V2BotName"
    """<p>The name of the Amazon Lex V2 bot that you are migrating the Amazon Lex V1 bot to. </p> <ul> <li> <p>If the Amazon Lex V2 bot doesn't exist, you must use the <code>CREATE_NEW</code> migration strategy.</p> </li> <li> <p>If the Amazon Lex V2 bot exists, you must use the <code>UPDATE_EXISTING</code> migration strategy to change the contents of the Amazon Lex V2 bot.</p> </li> </ul>"""
    v2_bot_role: "capo_lex_model_building_service.types.iam_role_arn.IamRoleArn"
    """<p>The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.</p>"""
    migration_strategy: (
        "capo_lex_model_building_service.types.migration_strategy.MigrationStrategy"
    )
    """<p>The strategy used to conduct the migration.</p> <ul> <li> <p> <code>CREATE_NEW</code> - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.</p> </li> <li> <p> <code>UPDATE_EXISTING</code> - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.</p> </li> </ul>"""

migration_strategy instance-attribute

migration_strategy: MigrationStrategy

The strategy used to conduct the migration.

  • CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.

  • UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.

v1_bot_name instance-attribute

v1_bot_name: BotName

The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.

v1_bot_version instance-attribute

v1_bot_version: Version

The version of the bot to migrate to Amazon Lex V2. You can migrate the $LATEST version as well as any numbered version.

v2_bot_name instance-attribute

v2_bot_name: V2BotName

The name of the Amazon Lex V2 bot that you are migrating the Amazon Lex V1 bot to.

  • If the Amazon Lex V2 bot doesn't exist, you must use the CREATE_NEW migration strategy.

  • If the Amazon Lex V2 bot exists, you must use the UPDATE_EXISTING migration strategy to change the contents of the Amazon Lex V2 bot.

v2_bot_role instance-attribute

v2_bot_role: IamRoleArn

The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.