Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetMigrations

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

Request Syntax


GET /migrations?maxResults=maxResults&migrationStatusEquals=migrationStatusEquals&nextToken=nextToken&sortByAttribute=sortByAttribute&sortByOrder=sortByOrder&v1BotNameContains=v1BotNameContains HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

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

Valid Range: Minimum value of 1. Maximum value of 50.

migrationStatusEquals

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

Valid Values: IN_PROGRESS | COMPLETED | FAILED

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.

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.

Valid Values: V1_BOT_NAME | MIGRATION_DATE_TIME

sortByOrder

The order so sort the list.

Valid Values: ASCENDING | DESCENDING

v1BotNameContains

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

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

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "migrationSummaries": [ 
      { 
         "migrationId": "string",
         "migrationStatus": "string",
         "migrationStrategy": "string",
         "migrationTimestamp": number,
         "v1BotLocale": "string",
         "v1BotName": "string",
         "v1BotVersion": "string",
         "v2BotId": "string",
         "v2BotRole": "string"
      }
   ],
   "nextToken": "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.

migrationSummaries

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 GetMigration operation.

Type: Array of MigrationSummary objects

nextToken

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.

Type: String

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