POST

/migrations

http://models.lex.{region}.amazonaws.com/migrations

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 <a href="https://docs.aws.amazon.com/lex/latest/dg/migrate.html">Migrating a bot</a> in the Amazon Lex developer guide.

Access Token Required: API Key

Body Params

v1BotNamestringrequired

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

v2BotNamestringrequired

The name of the Amazon Lex V2 bot that you are migrating the Amazon Lex V1 bot to. <ul> <li> If the Amazon Lex V2 bot doesn't exist, you must use the <code>CREATE_NEW</code> migration strategy. </li> <li> 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. </li> </ul>

v2BotRolestringrequired

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

v1BotVersionstringrequired

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.

migrationStrategystringrequired

The strategy used to conduct the migration. <ul> <li> <code>CREATE_NEW</code> - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot. </li> <li> <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. </li> </ul>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://models.lex.{region}.amazonaws.com/migrations' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}