StartImport - Amazon Lex V1

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

 

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

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

StartImport

リソースを Amazon Lex にインポートするジョブを開始します。

リクエストの構文

POST /imports/ HTTP/1.1 Content-type: application/json { "mergeStrategy": "string", "payload": blob, "resourceType": "string", "tags": [ { "key": "string", "value": "string" } ] }

URI リクエストパラメータ

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

リクエストボディ

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

mergeStrategy

同名の既存のリソースがある場合に、StartImport オペレーションが取るべきアクションを指定します。

  • FAIL_ON_CONFLICT - インポートファイル内のリソースと既存のリソースが競合を起こした時点で、インポート作業を停止します。競合を起こしているリソース名は、GetImport オペレーションへのレスポンスの failureReason フィールドにあります。

    OVERWRITE_LATEST - 既存のリソースとの競合があっても、インポートオペレーションは続行されます。既存のリソースの $LASTEST バージョンは、インポートファイルのデータで上書きされます。

型: 文字列

有効な値:OVERWRITE_LATEST | FAIL_ON_CONFLICT

必須: はい

payload

バイナリ形式の zip アーカイブ。アーカイブには、インポートするリソースを含む JSON ファイルが 1 つ含まれている必要があります。リソースは、resourceType フィールドで指定されたタイプと一致する必要があります。

型: Base64 でエンコードされたバイナリデータオブジェクト

必須: はい

resourceType

エクスポートするリソースの種類を指定します。また、各リソースは、依存しているリソースもエクスポートします。

  • ボットは、依存性を持つインテントをエクスポートします。

  • インテントは、依存するスロットタイプをエクスポートします。

型: 文字列

有効な値:BOT | INTENT | SLOT_TYPE

必須: はい

tags

インポートされたボットに追加するタグのリスト。タグを追加できるのは、ボットをインポートするときだけです。インテントまたはスロットタイプにタグを追加することはできません。

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

配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。

必須: いいえ

レスポンスの構文

HTTP/1.1 201 Content-type: application/json { "createdDate": number, "importId": "string", "importStatus": "string", "mergeStrategy": "string", "name": "string", "resourceType": "string", "tags": [ { "key": "string", "value": "string" } ] }

レスポンス要素

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

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

createdDate

インポートジョブがリクエストされた日時のタイムスタンプ。

型: タイムスタンプ

importId

特定のインポートジョブの識別子。

型: 文字列

importStatus

インポートジョブのステータス。ステータスが FAILED の場合は、GetImport オペレーションで故障の原因を知ることができます。

型: 文字列

有効な値:IN_PROGRESS | COMPLETE | FAILED

mergeStrategy

マージ競合が発生した場合に実行するアクション。

型: 文字列

有効な値:OVERWRITE_LATEST | FAIL_ON_CONFLICT

name

インポートジョブに付けられた名前。

型: 文字列

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

パターン: [a-zA-Z_]+

resourceType

インポートするリソースのタイプ。

型: 文字列

有効な値:BOT | INTENT | SLOT_TYPE

tags

インポートされたボットに追加されたタグのリスト。

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

配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。

エラー

BadRequestException

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

HTTP ステータスコード:400

InternalFailureException

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

HTTP ステータスコード:500

LimitExceededException

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

HTTP ステータスコード: 429

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

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