Amazon Lex Model Building Service

2021/07/13 - Amazon Lex Model Building Service - 3 new api methods

Changes  Customers can now migrate bots built with Lex V1 APIs to V2 APIs. This release adds APIs to initiate and manage the migration of a bot.

GetMigrations (new) Link ¶

Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.

See also: AWS API Documentation

Request Syntax

client.get_migrations(
    sortByAttribute='V1_BOT_NAME'|'MIGRATION_DATE_TIME',
    sortByOrder='ASCENDING'|'DESCENDING',
    v1BotNameContains='string',
    migrationStatusEquals='IN_PROGRESS'|'COMPLETED'|'FAILED',
    maxResults=123,
    nextToken='string'
)
type sortByAttribute

string

param sortByAttribute

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.

type sortByOrder

string

param sortByOrder

The order so sort the list.

type v1BotNameContains

string

param v1BotNameContains

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

type migrationStatusEquals

string

param migrationStatusEquals

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

type maxResults

integer

param maxResults

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

type nextToken

string

param 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.

rtype

dict

returns

Response Syntax

{
    'migrationSummaries': [
        {
            'migrationId': 'string',
            'v1BotName': 'string',
            'v1BotVersion': 'string',
            'v1BotLocale': 'de-DE'|'en-AU'|'en-GB'|'en-US'|'es-419'|'es-ES'|'es-US'|'fr-FR'|'fr-CA'|'it-IT'|'ja-JP',
            'v2BotId': 'string',
            'v2BotRole': 'string',
            'migrationStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED',
            'migrationStrategy': 'CREATE_NEW'|'UPDATE_EXISTING',
            'migrationTimestamp': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • migrationSummaries (list) --

      An array of summaries for migrations from Amazon Lex V1 to Amazon Lex V2. To see details of the migration, use the migrationId from the summary in a call to the operation.

      • (dict) --

        Provides information about migrating a bot from Amazon Lex V1 to Amazon Lex V2.

        • migrationId (string) --

          The unique identifier that Amazon Lex assigned to the migration.

        • v1BotName (string) --

          The name of the Amazon Lex V1 bot that is the source of the migration.

        • v1BotVersion (string) --

          The version of the Amazon Lex V1 bot that is the source of the migration.

        • v1BotLocale (string) --

          The locale of the Amazon Lex V1 bot that is the source of the migration.

        • v2BotId (string) --

          The unique identifier of the Amazon Lex V2 that is the destination of the migration.

        • v2BotRole (string) --

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

        • migrationStatus (string) --

          The status of the operation. When the status is COMPLETE 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.

        • migrationTimestamp (datetime) --

          The date and time that the migration started.

    • nextToken (string) --

      If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of migrations.

StartMigration (new) Link ¶

Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when you want to take advantage of the new features of Amazon Lex V2.

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

See also: AWS API Documentation

Request Syntax

client.start_migration(
    v1BotName='string',
    v1BotVersion='string',
    v2BotName='string',
    v2BotRole='string',
    migrationStrategy='CREATE_NEW'|'UPDATE_EXISTING'
)
type v1BotName

string

param v1BotName

[REQUIRED]

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

type v1BotVersion

string

param v1BotVersion

[REQUIRED]

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

type v2BotName

string

param v2BotName

[REQUIRED]

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.

type v2BotRole

string

param v2BotRole

[REQUIRED]

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

type migrationStrategy

string

param migrationStrategy

[REQUIRED]

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.

rtype

dict

returns

Response Syntax

{
    'v1BotName': 'string',
    'v1BotVersion': 'string',
    'v1BotLocale': 'de-DE'|'en-AU'|'en-GB'|'en-US'|'es-419'|'es-ES'|'es-US'|'fr-FR'|'fr-CA'|'it-IT'|'ja-JP',
    'v2BotId': 'string',
    'v2BotRole': 'string',
    'migrationId': 'string',
    'migrationStrategy': 'CREATE_NEW'|'UPDATE_EXISTING',
    'migrationTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • v1BotName (string) --

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

    • v1BotVersion (string) --

      The version of the bot to migrate to Amazon Lex V2.

    • v1BotLocale (string) --

      The locale used for the Amazon Lex V1 bot.

    • v2BotId (string) --

      The unique identifier for the Amazon Lex V2 bot.

    • v2BotRole (string) --

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

    • migrationId (string) --

      The unique identifier that Amazon Lex assigned to the migration.

    • migrationStrategy (string) --

      The strategy used to conduct the migration.

    • migrationTimestamp (datetime) --

      The date and time that the migration started.

GetMigration (new) Link ¶

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

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

string

param migrationId

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'migrationId': 'string',
    'v1BotName': 'string',
    'v1BotVersion': 'string',
    'v1BotLocale': 'de-DE'|'en-AU'|'en-GB'|'en-US'|'es-419'|'es-ES'|'es-US'|'fr-FR'|'fr-CA'|'it-IT'|'ja-JP',
    '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) --