LexModelBuildingService / Client / get_migration

get_migration

LexModelBuildingService.Client.get_migration(**kwargs)

Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration alerts and warnings related to the migration.

See also: AWS API Documentation

Request Syntax

response = client.get_migration(
    migrationId='string'
)

Parameters:

migrationId (string) –

[REQUIRED]

The unique identifier of the migration to view. The migrationID is returned by the operation.

Return type:

dict

Returns:

Response Syntax

{
    'migrationId': 'string',
    'v1BotName': 'string',
    'v1BotVersion': 'string',
    'v1BotLocale': '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',
    'v2BotId': 'string',
    'v2BotRole': 'string',
    'migrationStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED',
    'migrationStrategy': 'CREATE_NEW'|'UPDATE_EXISTING',
    'migrationTimestamp': datetime(2015, 1, 1),
    'alerts': [
        {
            'type': 'ERROR'|'WARN',
            'message': 'string',
            'details': [
                'string',
            ],
            'referenceURLs': [
                'string',
            ]
        },
    ]
}

Response Structure

• (dict) –

  • migrationId (string) –

    The unique identifier of the migration. This is the same as the identifier used when calling the GetMigration operation.

  • v1BotName (string) –

    The name of the Amazon Lex V1 bot migrated to Amazon Lex V2.

  • v1BotVersion (string) –

    The version of the Amazon Lex V1 bot migrated to Amazon Lex V2.

  • v1BotLocale (string) –

    The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2.

  • v2BotId (string) –

    The unique identifier of the Amazon Lex V2 bot that the Amazon Lex V1 is being migrated to.

  • v2BotRole (string) –

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

  • migrationStatus (string) –

    Indicates the status of the migration. When the status is COMPLETE the migration is finished and the bot is available in Amazon Lex V2. There may be alerts and warnings that need to be resolved to complete the migration.

  • migrationStrategy (string) –

    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.

  • migrationTimestamp (datetime) –

    The date and time that the migration started.

  • alerts (list) –

    A list of alerts and warnings that indicate issues with the migration for the Amazon Lex V1 bot to Amazon Lex V2. You receive a warning when an Amazon Lex V1 feature has a different implementation if Amazon Lex V2.

    For more information, see Migrating a bot in the Amazon Lex V2 developer guide.

    • (dict) –

      Provides information about alerts and warnings that Amazon Lex sends during a migration. The alerts include information about how to resolve the issue.

      • type (string) –

        The type of alert. There are two kinds of alerts:

        • ERROR - There was an issue with the migration that can’t be resolved. The migration stops.

        • WARN - There was an issue with the migration that requires manual changes to the new Amazon Lex V2 bot. The migration continues.

      • message (string) –

        A message that describes why the alert was issued.

      • details (list) –

        Additional details about the alert.

        • (string) –

      • referenceURLs (list) –

        A link to the Amazon Lex documentation that describes how to resolve the alert.

        • (string) –

Exceptions

• LexModelBuildingService.Client.exceptions.LimitExceededException

• LexModelBuildingService.Client.exceptions.InternalFailureException

• LexModelBuildingService.Client.exceptions.BadRequestException

• LexModelBuildingService.Client.exceptions.NotFoundException