StartMigration - Amazon Lex V1

Amazon Lex V2 を使用している場合は、代わりに Amazon Lex V2 ガイドを参照してください。

 

Amazon Lex V1 を使用している場合は、ボットを Amazon Lex V2 にアップグレードすることをお勧めします。V1 には新機能を追加されませんので、すべての新しいボットには V2 を使用することを強くお勧めします。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

StartMigration

Amazon Lex V1 から Amazon Lex V2 へのボットの移行を開始します。Amazon Lex V2 の新機能を利用する場合は、ボットを移行します。

詳細については、「Amazon Lex developer guide」(Amazon Lex デベロッパーガイド) の「Migrating a bot」(ボットの移行) を参照してください。

リクエストの構文

POST /migrations HTTP/1.1 Content-type: application/json { "migrationStrategy": "string", "v1BotName": "string", "v1BotVersion": "string", "v2BotName": "string", "v2BotRole": "string" }

URI リクエストパラメータ

リクエストでは URI パラメータを使用しません。

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

migrationStrategy

移行を実行するために使用された戦略。

  • CREATE_NEW - 新しい Amazon Lex V2 ボットを作成し、Amazon Lex V1 ボットをこの新しいボットに移行します。

  • UPDATE_EXISTING - 既存の Amazon Lex V2 ボットのメタデータおよび移行されるロケールを上書きします。Amazon Lex V2 ボットの他のロケールは変更されません。ロケールが存在しない場合は、Amazon Lex V2 ボットに新しいロケールが作成されます。

型: 文字列

有効な値: CREATE_NEW | UPDATE_EXISTING

必須: はい

v1BotName

Amazon Lex V2 に移行する Amazon Lex V1 ボットの名前。

型: 文字列

長さの制限: 最小長は 2 です。最大長は 50 です。

パターン: ^([A-Za-z]_?)+$

必須: はい

v1BotVersion

Amazon Lex V2 に移行するボットのバージョン。$LATEST バージョンだけでなく、任意の番号のバージョンを移行することができます。

型: 文字列

長さの制限:最小長は 1 です。最大長は 64 文字です。

パターン: \$LATEST|[0-9]+

必須: はい

v2BotName

Amazon Lex V1 ボットの移行先となる Amazon Lex V2 ボットの名前。

  • Amazon Lex V2 のボットが存在しない場合は、CREATE_NEW の移行戦略を使用する必要があります。

  • Amazon Lex V2 ボットが存在する場合、UPDATE_EXISTING 移行戦略を使用して Amazon Lex V2 ボットの内容を変更する必要があります。

型: 文字列

長さの制限: 最小長は 1 です。最大長は 100 です。

Pattern: ^([0-9a-zA-Z][_-]?)+$

必須: はい

v2BotRole

Amazon Lex が Amazon Lex V2 ボットの実行に使用する IAM ロール。

型: 文字列

長さの制限: 最小長は 20 です。最大長は 2,048 です。

パターン: ^arn:[\w\-]+:iam::[\d]{12}:role/.+$

必須:はい

レスポンスの構文

HTTP/1.1 202 Content-type: application/json { "migrationId": "string", "migrationStrategy": "string", "migrationTimestamp": number, "v1BotLocale": "string", "v1BotName": "string", "v1BotVersion": "string", "v2BotId": "string", "v2BotRole": "string" }

レスポンス要素

アクションが成功すると、HTTP 202 レスポンスが返されます。

サービスから以下のデータが JSON 形式で返されます。

migrationId

Amazon Lex が移行に割り当てた一意の識別子。

型: 文字列

長さの制限: 固定長は 10 です。

パターン: ^[0-9a-zA-Z]+$

migrationStrategy

移行を実行するために使用された戦略。

型: 文字列

有効な値: CREATE_NEW | UPDATE_EXISTING

migrationTimestamp

移行が開始された日時。

型: タイムスタンプ

v1BotLocale

Amazon Lex V1 ボットに使用されるロケール。

型: 文字列

有効な値: 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

Amazon Lex V2 に移行する Amazon Lex V1 ボットの名前。

型: 文字列

長さの制限: 最小長は 2 です。最大長は 50 です。

パターン: ^([A-Za-z]_?)+$

v1BotVersion

Amazon Lex V2 に移行するボットのバージョン。

型: 文字列

長さの制限:最小長は 1 です。最大長は 64 文字です。

パターン: \$LATEST|[0-9]+

v2BotId

Amazon Lex V2 ボットの一意の識別子。

型: 文字列

長さの制限: 固定長は 10 です。

パターン: ^[0-9a-zA-Z]+$

v2BotRole

Amazon Lex が Amazon Lex V2 ボットの実行に使用する IAM ロール。

型: 文字列

長さの制限: 最小長は 20 です。最大長は 2,048 です。

パターン: ^arn:[\w\-]+:iam::[\d]{12}:role/.+$

エラー

AccessDeniedException

お客様の IAM ユーザーまたはロールには、ボットの移行に必要な Amazon Lex V2 API を呼び出す許可がありません。

HTTP ステータスコード: 403

BadRequestException

リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。

HTTP ステータスコード:400

InternalFailureException

Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。

HTTP ステータスコード:500

LimitExceededException

リクエストが制限を超えました。リクエストを再試行してください。

HTTP ステータスコード: 429

NotFoundException

リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。

HTTP ステータスコード: 404

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。