GetMigration - Amazon Lex V1

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

 

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

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

GetMigration

Amazon Lex V1 ボットから Amazon Lex V2 ボットへの移行中または完了した移行についての詳細を提供します。このオペレーションを行うと、移行に関連するアラートや警告が表示されます。

リクエストの構文

GET /migrations/migrationId HTTP/1.1

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

migrationId

表示する移行の一意の識別子。migrationIDStartMigration のオペレーションで返されます。

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

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

必須: はい

リクエストボディ

リクエストにリクエスト本文がありません。

レスポンスの構文

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" }

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

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

alerts

Amazon Lex V1 ボットから Amazon Lex V2 への移行に関する問題を示すアラートと警告のリスト。Amazon Lex V2 内で Amazon Lex V1 の機能の実装が異なる場合、警告が表示されます。

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

型: MigrationAlert オブジェクトの配列

migrationId

移行の一意の識別子。これは、GetMigration オペレーションを呼び出す際に使用される識別子と同じです。

型: 文字列

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

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

migrationStatus

移行のステータスを示します。ステータスが COMPLETE になると移行が完了し、Amazon Lex V2 でボットが利用できるようになります。移行を完了するには、アラートや警告を解決する必要がある場合があります。

型: 文字列

有効な値:IN_PROGRESS | COMPLETED | FAILED

migrationStrategy

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

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

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

型: 文字列

有効な値:CREATE_NEW | UPDATE_EXISTING

migrationTimestamp

移行が開始された日時。

型: タイムスタンプ

v1BotLocale

Amazon Lex V1 ボットのロケールが Amazon Lex V2 に移行しました。

型: 文字列

有効な値: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 V1 ボットの名前が Amazon Lex V2 に移行しました。

型: 文字列

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

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

v1BotVersion

Amazon Lex V1 ボットのバージョンが Amazon Lex V2 に移行しました。

型: 文字列

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

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

v2BotId

Amazon Lex V1 の移行先である Amazon Lex V2 ボットの一意の識別子。

型: 文字列

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

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

v2BotRole

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

型: 文字列

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

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

エラー

BadRequestException

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

HTTP ステータスコード:400

InternalFailureException

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

HTTP ステータスコード:500

LimitExceededException

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

HTTP ステータスコード: 429

NotFoundException

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

HTTP ステータスコード: 404

その他の参照資料

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