GetMigration - Amazon Lex

GetMigration

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.

Request Syntax

GET /migrations/migrationId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

migrationId

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

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "alerts": [ { "details": [ "string" ], "message": "string", "referenceURLs": [ "string" ], "type": "string" } ], "migrationId": "string", "migrationStatus": "string", "migrationStrategy": "string", "migrationTimestamp": number, "v1BotLocale": "string", "v1BotName": "string", "v1BotVersion": "string", "v2BotId": "string", "v2BotRole": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

alerts

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 in Amazon Lex V2.

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

Type: Array of MigrationAlert objects

migrationId

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

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

migrationStatus

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.

Type: String

Valid Values: IN_PROGRESS | COMPLETED | FAILED

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.

Type: String

Valid Values: CREATE_NEW | UPDATE_EXISTING

migrationTimestamp

The date and time that the migration started.

Type: Timestamp

v1BotLocale

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

Type: String

Valid Values: 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

v1BotName

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

Type: String

Length Constraints: Minimum length of 2. Maximum length of 50.

Pattern: ^([A-Za-z]_?)+$

v1BotVersion

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: \$LATEST|[0-9]+

v2BotId

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

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

v2BotRole

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[\w\-]+:iam::[\d]{12}:role/.+$

Errors

BadRequestException

The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.

HTTP Status Code: 400

InternalFailureException

An internal Amazon Lex error occurred. Try your request again.

HTTP Status Code: 500

LimitExceededException

The request exceeded a limit. Try your request again.

HTTP Status Code: 429

NotFoundException

The resource specified in the request was not found. Check the resource and try again.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: