サポート終了通知: 2025 年 9 月 15 日、 AWS は Amazon Lex V1 のサポートを終了します。 V1 2025 年 9 月 15 日を過ぎると、Amazon Lex V1 コンソールまたは Amazon Lex V1 リソースにはアクセスできなくなります。Amazon Lex V2 を使用している場合は、代わりに [Amazon Lex V2 ガイド](https://docs.aws.amazon.com/lexv2/latest/dg/what-is.html)を参照してください。 翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # アクション 次のアクションは、Amazon Lex Model·Building·Service でサポートされています。 + [CreateBotVersion](API_CreateBotVersion.md) + [CreateIntentVersion](API_CreateIntentVersion.md) + [CreateSlotTypeVersion](API_CreateSlotTypeVersion.md) + [DeleteBot](API_DeleteBot.md) + [DeleteBotAlias](API_DeleteBotAlias.md) + [DeleteBotChannelAssociation](API_DeleteBotChannelAssociation.md) + [DeleteBotVersion](API_DeleteBotVersion.md) + [DeleteIntent](API_DeleteIntent.md) + [DeleteIntentVersion](API_DeleteIntentVersion.md) + [DeleteSlotType](API_DeleteSlotType.md) + [DeleteSlotTypeVersion](API_DeleteSlotTypeVersion.md) + [DeleteUtterances](API_DeleteUtterances.md) + [GetBot](API_GetBot.md) + [GetBotAlias](API_GetBotAlias.md) + [GetBotAliases](API_GetBotAliases.md) + [GetBotChannelAssociation](API_GetBotChannelAssociation.md) + [GetBotChannelAssociations](API_GetBotChannelAssociations.md) + [GetBots](API_GetBots.md) + [GetBotVersions](API_GetBotVersions.md) + [GetBuiltinIntent](API_GetBuiltinIntent.md) + [GetBuiltinIntents](API_GetBuiltinIntents.md) + [GetBuiltinSlotTypes](API_GetBuiltinSlotTypes.md) + [GetExport](API_GetExport.md) + [GetImport](API_GetImport.md) + [GetIntent](API_GetIntent.md) + [GetIntents](API_GetIntents.md) + [GetIntentVersions](API_GetIntentVersions.md) + [GetMigration](API_GetMigration.md) + [GetMigrations](API_GetMigrations.md) + [GetSlotType](API_GetSlotType.md) + [GetSlotTypes](API_GetSlotTypes.md) + [GetSlotTypeVersions](API_GetSlotTypeVersions.md) + [GetUtterancesView](API_GetUtterancesView.md) + [ListTagsForResource](API_ListTagsForResource.md) + [PutBot](API_PutBot.md) + [PutBotAlias](API_PutBotAlias.md) + [PutIntent](API_PutIntent.md) + [PutSlotType](API_PutSlotType.md) + [StartImport](API_StartImport.md) + [StartMigration](API_StartMigration.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) 次のアクションは、Amazon Lex Runtime Service でサポートされています + [DeleteSession](API_runtime_DeleteSession.md) + [GetSession](API_runtime_GetSession.md) + [PostContent](API_runtime_PostContent.md) + [PostText](API_runtime_PostText.md) + [PutSession](API_runtime_PutSession.md) # Amazon Lex Model Building Service 次のアクションは、Amazon Lex Model·Building·Service でサポートされています。 + [CreateBotVersion](API_CreateBotVersion.md) + [CreateIntentVersion](API_CreateIntentVersion.md) + [CreateSlotTypeVersion](API_CreateSlotTypeVersion.md) + [DeleteBot](API_DeleteBot.md) + [DeleteBotAlias](API_DeleteBotAlias.md) + [DeleteBotChannelAssociation](API_DeleteBotChannelAssociation.md) + [DeleteBotVersion](API_DeleteBotVersion.md) + [DeleteIntent](API_DeleteIntent.md) + [DeleteIntentVersion](API_DeleteIntentVersion.md) + [DeleteSlotType](API_DeleteSlotType.md) + [DeleteSlotTypeVersion](API_DeleteSlotTypeVersion.md) + [DeleteUtterances](API_DeleteUtterances.md) + [GetBot](API_GetBot.md) + [GetBotAlias](API_GetBotAlias.md) + [GetBotAliases](API_GetBotAliases.md) + [GetBotChannelAssociation](API_GetBotChannelAssociation.md) + [GetBotChannelAssociations](API_GetBotChannelAssociations.md) + [GetBots](API_GetBots.md) + [GetBotVersions](API_GetBotVersions.md) + [GetBuiltinIntent](API_GetBuiltinIntent.md) + [GetBuiltinIntents](API_GetBuiltinIntents.md) + [GetBuiltinSlotTypes](API_GetBuiltinSlotTypes.md) + [GetExport](API_GetExport.md) + [GetImport](API_GetImport.md) + [GetIntent](API_GetIntent.md) + [GetIntents](API_GetIntents.md) + [GetIntentVersions](API_GetIntentVersions.md) + [GetMigration](API_GetMigration.md) + [GetMigrations](API_GetMigrations.md) + [GetSlotType](API_GetSlotType.md) + [GetSlotTypes](API_GetSlotTypes.md) + [GetSlotTypeVersions](API_GetSlotTypeVersions.md) + [GetUtterancesView](API_GetUtterancesView.md) + [ListTagsForResource](API_ListTagsForResource.md) + [PutBot](API_PutBot.md) + [PutBotAlias](API_PutBotAlias.md) + [PutIntent](API_PutIntent.md) + [PutSlotType](API_PutSlotType.md) + [StartImport](API_StartImport.md) + [StartMigration](API_StartMigration.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) # CreateBotVersion 指定されたボットの `$LATEST` バージョンに基づいて新しいバージョンを作成します。このリソースの `$LATEST` バージョンが、最後のバージョンを作成してから変更されていない場合、Amazon Lex は新しいバージョンを作成しません。最後に作成したバージョンを返します。 **注記** ボットのバージョンで更新できるのは `$LATEST` バージョンのみです。`CreateBotVersion` オペレーションを使用して作成した番号付きのバージョンを更新することはできません。 ボットの最初のバージョンを作成すると、Amazon Lex はバージョンを 1 に設定します。それ以降のバージョンは 1 ずつ増えます。詳細については、「[バージョニング](versioning-aliases.md#versioning-intro)」を参照してください。 このオペレーションには `lex:CreateBotVersion` アクションに対するアクセス許可が必要です。 ## リクエストの構文 ``` POST /bots/name/versions HTTP/1.1 Content-type: application/json { "checksum": "string" } ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_CreateBotVersion_RequestSyntax) ** 作成する新しいバージョンのボットの名前。名前は、大文字と小文字が区別されます。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [checksum](#API_CreateBotVersion_RequestSyntax) ** ボットの `$LATEST` バージョンの特定のリビジョンを識別します。チェックサムを指定しても、`$LATEST` バージョンのボットのチェックサムが異なる場合は、`PreconditionFailedException` 例外が返され、Amazon Lexは新しいバージョンを公開しません。チェックサムを指定しない場合、Amazon Lex は `$LATEST` バージョンを公開します。 タイプ: 文字列 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 201 Content-type: application/json { "abortStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "checksum": "string", "childDirected": boolean, "clarificationPrompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "createdDate": number, "description": "string", "detectSentiment": boolean, "enableModelImprovements": boolean, "failureReason": "string", "idleSessionTTLInSeconds": number, "intents": [ { "intentName": "string", "intentVersion": "string" } ], "lastUpdatedDate": number, "locale": "string", "name": "string", "status": "string", "version": "string", "voiceId": "string" } ``` ## レスポンス要素 アクションが成功すると、HTTP 201 レスポンスが返されます。 サービスから以下のデータが JSON 形式で返されます。 ** [abortStatement](#API_CreateBotVersion_ResponseSyntax) ** Amazon Lex が会話をキャンセルするために使用するメッセージ。詳細については、「[PutBot](API_PutBot.md)」を参照してください。 型: [Statement](API_Statement.md) オブジェクト ** [checksum](#API_CreateBotVersion_ResponseSyntax) ** 作成されたボットのバージョンを識別するチェックサム。 タイプ: 文字列 ** [childDirected](#API_CreateBotVersion_ResponseSyntax) ** Amazon Lex Model·Building·Service で作成された各 Amazon Lex ボットについて、Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連しており、COPPA (Children's Online Privacy Protection Act) の対象となっているかどうかを、`childDirected` フィールドに `true` または `false` を指定する必要があります。`true` のフィールド中の `childDirected` を指定することで、Amazon Lex の使用が、全体あるいは一部が 13 歳未満の子どもに向けられた、あるいはターゲットとし、また COPPA の対象となるウェブサイト、プログラムと、関係して **いる** ことに同意します。`false` のフィールド中の `childDirected` を指定することで、Amazon Lex の使用が、全体あるいは一部が 13 歳未満の子どもに向けられた、あるいはターゲットとし、また COPPA の対象となるウェブサイト、プログラムと、関係して **いない** ことに同意します。Amazon Lex の全体または一部の使用が、13歳未満の児童を対象にしており、COPPAの対象となるウェブサイト、プログラム、またはその他のアプリケーションに関連するかどうかを正確に設定するために、`childDirected` フィールドにデフォルト値を指定することはできません。 Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連する場合は、COPPA により必要とされる検証可能な保護者の同意が必要です。13 歳未満の児童を対象とするウェブサイト、プログラム、またはその他のアプリケーションに関連する Amazon Lex の全体または一部の使用についての詳細は、[「Amazon Lex FAQ」](https://aws.amazon.com/lex/faqs#data-security)を参照してください。 型: ブール値 ** [clarificationPrompt](#API_CreateBotVersion_ResponseSyntax) ** Amazon Lex がユーザーのリクエストを理解できない場合に使用するメッセージ。詳細については、「[PutBot](API_PutBot.md)」を参照してください。 型: [Prompt](API_Prompt.md) オブジェクト ** [createdDate](#API_CreateBotVersion_ResponseSyntax) ** ボットバージョンの作成日｡ 型: タイムスタンプ ** [description](#API_CreateBotVersion_ResponseSyntax) ** ボットの説明。 タイプ: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 ** [detectSentiment](#API_CreateBotVersion_ResponseSyntax) ** ユーザーが入力した発話を Amazon Comprehend に送信してセンチメント分析を行うかどうかを示します。 型: ブール値 ** [enableModelImprovements](#API_CreateBotVersion_ResponseSyntax) ** ボットが精度向上を使用しているかどうかを示します。`true` はボットが精度向上を使用していることを示し、それ以外は `false` となります。 型: ブール値 ** [failureReason](#API_CreateBotVersion_ResponseSyntax) ** `status` が `FAILED` の場合、Amazon Lex はボットの構築に失敗した理由を提示します。 タイプ: 文字列 ** [idleSessionTTLInSeconds](#API_CreateBotVersion_ResponseSyntax) ** Amazon Lex が会話で収集したデータを保持する最大時間 (秒) です。詳細については、「[PutBot](API_PutBot.md)」を参照してください。 型: 整数 有効範囲: 最小値 は 60 です。最大値は 86400 です。 ** [intents](#API_CreateBotVersion_ResponseSyntax) ** `Intent` オブジェクトの配列。詳細については、「[PutBot](API_PutBot.md)」を参照してください。 型: [Intent](API_Intent.md) オブジェクトの配列 ** [lastUpdatedDate](#API_CreateBotVersion_ResponseSyntax) ** このボットの `$LATEST` バージョンが更新された日。 型: タイムスタンプ ** [locale](#API_CreateBotVersion_ResponseSyntax) ** ボットのターゲットロケールを指定します。 型: 文字列 有効な値：`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` ** [name](#API_CreateBotVersion_ResponseSyntax) ** ボットの名前。 タイプ: 文字列 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` ** [status](#API_CreateBotVersion_ResponseSyntax) ** ボットの作成や更新のリクエストを送信すると、Amazon Lex は `status` レスポンス要素を `BUILDING` に設定します。Amazon Lex がボットを構築した後、`status` を `READY` に設定します。Amazon Lex がボットをビルドできない場合、`status` を `FAILED` に設定します。Amazon Lex は、`failureReason` レスポンス要素に失敗の理由を返します。 型: 文字列 有効な値：`BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT` ** [version](#API_CreateBotVersion_ResponseSyntax) ** 取得するボットのバージョンです。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `\$LATEST|[0-9]+` ** [voiceId](#API_CreateBotVersion_ResponseSyntax) ** Amazon Lex がユーザーとの音声対話に使用する Amazon Polly 音声 ID です。 タイプ: 文字列 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ** PreconditionFailedException ** 変更しようとしているリソースのチェックサムがリクエストのチェックサムと一致しません。リソースのチェックサムを確認して、もう一度お試しください。 HTTP ステータスコード: 412 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/CreateBotVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/CreateBotVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/CreateBotVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/CreateBotVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/CreateBotVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/CreateBotVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/CreateBotVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/CreateBotVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/CreateBotVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/CreateBotVersion) # CreateIntentVersion `$LATEST` バージョンのインテントに基づいて、インテントの新しいバージョンを作成します。`$LATEST` バージョンのインテントの最後の更新から変更がない場合、Amazon Lex は新しいバージョンを作成しません。最後に作成したバージョンを返します。 **注記** `$LATEST` バージョンのインテントのみアップデートすることができます。`CreateIntentVersion` オペレーションを使用して作成した番号付きのバージョンを更新することはできません。 ボットの最初のバージョンを作成すると、Amazon Lex はバージョンを 1 に設定します。それ以降のバージョンは 1 ずつ増えます。詳細については、「[バージョニング](versioning-aliases.md#versioning-intro)」を参照してください。 このオペレーションには `lex:CreateIntentVersion` アクションを実行するアクセス許可が必要です。 ## リクエストの構文 ``` POST /intents/name/versions HTTP/1.1 Content-type: application/json { "checksum": "string" } ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_CreateIntentVersion_RequestSyntax) ** 新しいバージョンを作成するインテントの名前。名前は、大文字と小文字が区別されます。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [checksum](#API_CreateIntentVersion_RequestSyntax) ** 新しいバージョンの作成に使用する `$LATEST` バージョンのインテントのチェックサム。チェックサムを指定しても、`$LATEST` バージョンのインテントのチェックサムが異なる場合、Amazon Lex は `PreconditionFailedException` の例外を返し、新しいバージョンを公開しません。チェックサムを指定しない場合、Amazon Lex は `$LATEST` バージョンを公開します。 タイプ: 文字列 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 201 Content-type: application/json { "checksum": "string", "conclusionStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "confirmationPrompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "createdDate": number, "description": "string", "dialogCodeHook": { "messageVersion": "string", "uri": "string" }, "followUpPrompt": { "prompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "rejectionStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" } }, "fulfillmentActivity": { "codeHook": { "messageVersion": "string", "uri": "string" }, "type": "string" }, "inputContexts": [ { "name": "string" } ], "kendraConfiguration": { "kendraIndex": "string", "queryFilterString": "string", "role": "string" }, "lastUpdatedDate": number, "name": "string", "outputContexts": [ { "name": "string", "timeToLiveInSeconds": number, "turnsToLive": number } ], "parentIntentSignature": "string", "rejectionStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "sampleUtterances": [ "string" ], "slots": [ { "defaultValueSpec": { "defaultValueList": [ { "defaultValue": "string" } ] }, "description": "string", "name": "string", "obfuscationSetting": "string", "priority": number, "responseCard": "string", "sampleUtterances": [ "string" ], "slotConstraint": "string", "slotType": "string", "slotTypeVersion": "string", "valueElicitationPrompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" } } ], "version": "string" } ``` ## レスポンス要素 アクションが成功すると、HTTP 201 レスポンスが返されます。 サービスから以下のデータが JSON 形式で返されます。 ** [checksum](#API_CreateIntentVersion_ResponseSyntax) ** 作成されたインテントバージョンのチェックサム。 タイプ: 文字列 ** [conclusionStatement](#API_CreateIntentVersion_ResponseSyntax) ** `fulfillmentActivity` フィールドで指定された Lambda 関数がインテントを達成すると、Amazon Lex はこのステートメントをユーザーに伝えます。 型: [Statement](API_Statement.md) オブジェクト ** [confirmationPrompt](#API_CreateIntentVersion_ResponseSyntax) ** これが定義されている場合、Amazon Lex がユーザーのインテントを達成する前の確認に使用するプロンプトです。 型: [Prompt](API_Prompt.md) オブジェクト ** [createdDate](#API_CreateIntentVersion_ResponseSyntax) ** インテントが作成された日付。 型: タイムスタンプ ** [description](#API_CreateIntentVersion_ResponseSyntax) ** インテントの説明。 タイプ: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 ** [dialogCodeHook](#API_CreateIntentVersion_ResponseSyntax) ** これが定義されている場合、Amazon Lex は各ユーザー入力に対してこの Lambda 関数を呼び出します。 型: [CodeHook](API_CodeHook.md) オブジェクト ** [followUpPrompt](#API_CreateIntentVersion_ResponseSyntax) ** これが定義されている場合、Amazon Lex はこのプロンプトを使用して、インテントが達成された後に追加のユーザーアクティビティを要求します。 型: [FollowUpPrompt](API_FollowUpPrompt.md) オブジェクト ** [fulfillmentActivity](#API_CreateIntentVersion_ResponseSyntax) ** インテントがどのように達成されるのかを説明します。 型: [FulfillmentActivity](API_FulfillmentActivity.md) オブジェクト ** [inputContexts](#API_CreateIntentVersion_ResponseSyntax) ** Amazon Lex がユーザーとの会話の中でインテントを選択するためのアクティブなコンテキストをリストアップした `InputContext` オブジェクトの配列です。 型: [InputContext](API_InputContext.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 5 項目です。 ** [kendraConfiguration](#API_CreateIntentVersion_ResponseSyntax) ** Amazon Kendra インデックスと `AMAZON.KendraSearchIntent` インテントを接続するための設定情報 (項目がある場合)。 型: [KendraConfiguration](API_KendraConfiguration.md) オブジェクト ** [lastUpdatedDate](#API_CreateIntentVersion_ResponseSyntax) ** インテントが更新された日付。 型: タイムスタンプ ** [name](#API_CreateIntentVersion_ResponseSyntax) ** インテントの名前。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` ** [outputContexts](#API_CreateIntentVersion_ResponseSyntax) ** `OutputContext` オブジェクトの配列で、インテントが達成されたときにアクティブになるコンテキストを列挙します。 型: [OutputContext](API_OutputContext.md) オブジェクトの配列 の配列メンバー: 最小数は 0 項目です。最大数は 10 項目です。 ** [parentIntentSignature](#API_CreateIntentVersion_ResponseSyntax) ** 組み込みインテントの一意の識別子。 タイプ: 文字列 ** [rejectionStatement](#API_CreateIntentVersion_ResponseSyntax) ** ユーザーが `confirmationPrompt` で定義された質問に「いいえ」と答えた場合、Amazon Lex はインテントがキャンセルされたことを確認するためにこのステートメントを返します。 型: [Statement](API_Statement.md) オブジェクト ** [sampleUtterances](#API_CreateIntentVersion_ResponseSyntax) ** インテント用に構成されたサンプル発話の配列。 型: 文字列の配列 配列メンバー: 最小数は 0 項目です。最大数は 1500 項目です。 長さの制限：最小長 1、最大長は 200 です。 ** [slots](#API_CreateIntentVersion_ResponseSyntax) ** インテントを達成するために必要な情報を定義するスロットタイプの配列。 型: [Slot](API_Slot.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 100 項目です。 ** [version](#API_CreateIntentVersion_ResponseSyntax) ** インテントの新しいバージョンに割り当てられたバージョン番号。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `\$LATEST|[0-9]+` ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ** PreconditionFailedException ** 変更しようとしているリソースのチェックサムがリクエストのチェックサムと一致しません。リソースのチェックサムを確認して、もう一度お試しください。 HTTP ステータスコード: 412 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/CreateIntentVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/CreateIntentVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/CreateIntentVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/CreateIntentVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/CreateIntentVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/CreateIntentVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/CreateIntentVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/CreateIntentVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/CreateIntentVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/CreateIntentVersion) # CreateSlotTypeVersion 指定された `$LATEST` バージョンのスロットタイプに基づいて新しいバージョンを作成します。このリソースの `$LATEST` バージョンが最後に作成されたバージョンから変更がない場合、Amazon Lex は新しいバージョンを作成しません。最後に作成したバージョンを返します。 **注記** スロットタイプの `$LATEST` バージョンのみ更新できます。`CreateSlotTypeVersion` オペレーションを使用して作成した番号付きのバージョンを更新することはできません。 スロットタイプのバージョンを作成すると、Amazon Lex はバージョンを 1 に設定します。それ以降のバージョンは 1 ずつ増えます。詳細については、「[バージョニング](versioning-aliases.md#versioning-intro)」を参照してください。 このオペレーションには、`lex:CreateSlotTypeVersion` アクションに対する許可が必要です。 ## リクエストの構文 ``` POST /slottypes/name/versions HTTP/1.1 Content-type: application/json { "checksum": "string" } ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_CreateSlotTypeVersion_RequestSyntax) ** 新しいバージョンを作成するスロットタイプの名前。名前は、大文字と小文字が区別されます。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [checksum](#API_CreateSlotTypeVersion_RequestSyntax) ** 公開したいスロットタイプの `$LATEST` バージョンのチェックサム。チェックサムを指定しても、`$LATEST` バージョンのスロットタイプのチェックサムが異なる場合、Amazon Lex は `PreconditionFailedException` の例外を返し、新しいバージョンを公開しません。チェックサムを指定しない場合、Amazon Lex は `$LATEST` バージョンを公開します。 タイプ: 文字列 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 201 Content-type: application/json { "checksum": "string", "createdDate": number, "description": "string", "enumerationValues": [ { "synonyms": [ "string" ], "value": "string" } ], "lastUpdatedDate": number, "name": "string", "parentSlotTypeSignature": "string", "slotTypeConfigurations": [ { "regexConfiguration": { "pattern": "string" } } ], "valueSelectionStrategy": "string", "version": "string" } ``` ## レスポンス要素 アクションが成功すると、HTTP 201 レスポンスが返されます。 サービスから以下のデータが JSON 形式で返されます。 ** [checksum](#API_CreateSlotTypeVersion_ResponseSyntax) ** スロットタイプの `$LATEST` バージョンのチェックサム。 タイプ: 文字列 ** [createdDate](#API_CreateSlotTypeVersion_ResponseSyntax) ** スロットタイプが作成された日付。 型: タイムスタンプ ** [description](#API_CreateSlotTypeVersion_ResponseSyntax) ** スロットタイプの説明。 タイプ: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 ** [enumerationValues](#API_CreateSlotTypeVersion_ResponseSyntax) ** スロットタイプが取得できる値を定義する `EnumerationValue` オブジェクトのリスト。 型: [EnumerationValue](API_EnumerationValue.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 10000 項目です。 ** [lastUpdatedDate](#API_CreateSlotTypeVersion_ResponseSyntax) ** スロットタイプが更新された日付。リソースを作成する場合、作成日と最終更新日は同じ日付になります。 型: タイムスタンプ ** [name](#API_CreateSlotTypeVersion_ResponseSyntax) ** スロットタイプの名前。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` ** [parentSlotTypeSignature](#API_CreateSlotTypeVersion_ResponseSyntax) ** このスロットタイプの親として使用される組み込みスロットタイプです。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `^((AMAZON\.)_?|[A-Za-z]_?)+` ** [slotTypeConfigurations](#API_CreateSlotTypeVersion_ResponseSyntax) ** 親組み込みスロットタイプを拡張する構成情報。 型: [SlotTypeConfiguration](API_SlotTypeConfiguration.md) オブジェクトの配列 の配列メンバー: 最小数は 0 項目です。最大数は 10 項目です。 ** [valueSelectionStrategy](#API_CreateSlotTypeVersion_ResponseSyntax) ** Amazon Lex がスロットの価値を決定するために使用する戦略。詳細については、「[PutSlotType](API_PutSlotType.md)」を参照してください。 型: 文字列 有効な値：`ORIGINAL_VALUE | TOP_RESOLUTION` ** [version](#API_CreateSlotTypeVersion_ResponseSyntax) ** 新しいスロットタイプバージョンに割り当てられたバージョン。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `\$LATEST|[0-9]+` ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ** PreconditionFailedException ** 変更しようとしているリソースのチェックサムがリクエストのチェックサムと一致しません。リソースのチェックサムを確認して、もう一度お試しください。 HTTP ステータスコード: 412 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/CreateSlotTypeVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/CreateSlotTypeVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/CreateSlotTypeVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/CreateSlotTypeVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/CreateSlotTypeVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/CreateSlotTypeVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/CreateSlotTypeVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/CreateSlotTypeVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/CreateSlotTypeVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/CreateSlotTypeVersion) # DeleteBot `$LATEST` バージョンを含む、すべてのバージョンのボットを削除します。特定のバージョンのボットを削除するには、[DeleteBotVersion](API_DeleteBotVersion.md) オペレーションを行います。`DeleteBot` のオペレーションでは、ボットのスキーマはすぐには削除されません。その代わり、削除マークをつけておき、後で削除します。 Amazon Lex は、ユーザーの入力に対するボットの応答能力を向上させるために、発話を無期限に保存します。これらの発話は、ボットが削除されても削除されません。発話を削除するには、[DeleteUtterances](API_DeleteUtterances.md) オペレーションを使用します。 ボットにエイリアスがある場合、削除することはできません。その代わり、`DeleteBot` オペレーションは、ボットを参照するエイリアスへの参照を含む `ResourceInUseException` 例外を返します。ボットへの参照を削除するには、エイリアスを削除します。同じ例外が再び発生した場合は、`DeleteBot` オペレーションが成功するまで、参照元のエイリアスを削除してください。 このオペレーションには、`lex:DeleteBot` アクションに対する許可が必要です。 ## リクエストの構文 ``` DELETE /bots/name HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_DeleteBot_RequestSyntax) ** ボットの名前。名前は、大文字と小文字が区別されます。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 204 ``` ## レスポンス要素 アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ** ResourceInUseException ** 削除しようとしているリソースは、別のリソースによって参照されています。この情報を使用して、削除するリソースへの参照を解除します。 例外の本文には、リソースを記述する JSON オブジェクトが含まれています。 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,` `"resourceReference": {` `"name": string, "version": string } }` ** exampleReference ** 削除するリソースを参照しているリソースについて説明します。このオブジェクトは、`ResourceInUseException` の例外の一部として返されます。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteBot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteBot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteBot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteBot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteBot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteBot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteBot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteBot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteBot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteBot) # DeleteBotAlias 指定されたボットのエイリアスを削除します。 ボットとメッセージングチャンネルの関連付けに使用されているエイリアスを削除することはできません。チャンネルアソシエーションにエイリアスが使用されている場合、`DeleteBot` オペレーションは、ボットを参照しているチャンネルアソシエーションへの参照を含む `ResourceInUseException` 例外を返します。チャンネルの関連付けを削除することで、エイリアスへの参照を削除することができます。同じ例外が再び発生した場合は、`DeleteBotAlias` オペレーションが成功するまで参照元のアソシエーションを削除してください。 ## リクエストの構文 ``` DELETE /bots/botName/aliases/name HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [botName](#API_DeleteBotAlias_RequestSyntax) ** エイリアスが指すボットの名前。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [name](#API_DeleteBotAlias_RequestSyntax) ** 削除するエイリアスの名前。名前は、大文字と小文字が区別されます。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 204 ``` ## レスポンス要素 アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ** ResourceInUseException ** 削除しようとしているリソースは、別のリソースによって参照されています。この情報を使用して、削除するリソースへの参照を解除します。 例外の本文には、リソースを記述する JSON オブジェクトが含まれています。 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,` `"resourceReference": {` `"name": string, "version": string } }` ** exampleReference ** 削除するリソースを参照しているリソースについて説明します。このオブジェクトは、`ResourceInUseException` の例外の一部として返されます。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteBotAlias) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteBotAlias) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteBotAlias) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteBotAlias) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteBotAlias) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteBotAlias) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteBotAlias) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteBotAlias) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteBotAlias) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteBotAlias) # DeleteBotChannelAssociation Amazon Lex ボットとメッセージングプラットフォームの間の関連付けを削除します。 このオペレーションには `lex:DeleteBotChannelAssociation` アクションに対するアクセス許可が必要です。 ## リクエストの構文 ``` DELETE /bots/botName/aliases/aliasName/channels/name HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [aliasName](#API_DeleteBotChannelAssociation_RequestSyntax) ** この関連付けが作成されている Amazon Lex ボットの特定のバージョンを指すエイリアス。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [botName](#API_DeleteBotChannelAssociation_RequestSyntax) ** Amazon Lex ボットの名前。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [name](#API_DeleteBotChannelAssociation_RequestSyntax) ** 関連付けの名前。名前は、大文字と小文字が区別されます。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 204 ``` ## レスポンス要素 アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteBotChannelAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteBotChannelAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteBotChannelAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteBotChannelAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteBotChannelAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteBotChannelAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteBotChannelAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteBotChannelAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteBotChannelAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteBotChannelAssociation) # DeleteBotVersion 指定されたバージョンのボットを削除します。ボットのすべてのバージョンを削除するには、[DeleteBot](API_DeleteBot.md) オペレーションを使用します。 このオペレーションには、`lex:DeleteBotVersion` アクションに対する許可が必要です。 ## リクエストの構文 ``` DELETE /bots/name/versions/version HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_DeleteBotVersion_RequestSyntax) ** ボットの名前。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [version](#API_DeleteBotVersion_RequestSyntax) ** 削除するボットのバージョン。`$LATEST` バージョンのボットを削除することはできません。`$LATEST` バージョンを削除するには、[DeleteBot](API_DeleteBot.md) オペレーションを行います。 長さの制限：最小長 1、最大長 64 パターン: `[0-9]+` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 204 ``` ## レスポンス要素 アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ** ResourceInUseException ** 削除しようとしているリソースは、別のリソースによって参照されています。この情報を使用して、削除するリソースへの参照を解除します。 例外の本文には、リソースを記述する JSON オブジェクトが含まれています。 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,` `"resourceReference": {` `"name": string, "version": string } }` ** exampleReference ** 削除するリソースを参照しているリソースについて説明します。このオブジェクトは、`ResourceInUseException` の例外の一部として返されます。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteBotVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteBotVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteBotVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteBotVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteBotVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteBotVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteBotVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteBotVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteBotVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteBotVersion) # DeleteIntent `$LATEST` バージョンを含む、すべてのバージョンのインテントを削除します。特定のバージョンのインテントを削除するには、[DeleteIntentVersion](API_DeleteIntentVersion.md) のオペレーションを行います。 インテントのバージョンを削除できるのは、インテントが参照されていない場合のみです。1 つ以上のボット ([Amazon Lex: 仕組み](how-it-works.md) を参照してください) で参照されているインテントを削除するには、まずそれらの参照を削除する必要があります。 **注記** `ResourceInUseException` の例外が発生した場合は、インテントがどこで参照されているかを示す参照例を提供します。インテントへの参照を削除するには、ボットを更新するか、ボットを削除します。再度インテントを削除しようとしたときに同じ例外が発生した場合は、インテントの参照先がなくなり、`DeleteIntent` への呼び出しが成功するまで繰り返します。 このオペレーションには `lex:DeleteIntent` アクションに対するアクセス許可が必要です。 ## リクエストの構文 ``` DELETE /intents/name HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_DeleteIntent_RequestSyntax) ** インテントの名前。名前は、大文字と小文字が区別されます。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 204 ``` ## レスポンス要素 アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ** ResourceInUseException ** 削除しようとしているリソースは、別のリソースによって参照されています。この情報を使用して、削除するリソースへの参照を解除します。 例外の本文には、リソースを記述する JSON オブジェクトが含まれています。 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,` `"resourceReference": {` `"name": string, "version": string } }` ** exampleReference ** 削除するリソースを参照しているリソースについて説明します。このオブジェクトは、`ResourceInUseException` の例外の一部として返されます。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteIntent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteIntent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteIntent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteIntent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteIntent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteIntent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteIntent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteIntent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteIntent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteIntent) # DeleteIntentVersion 指定されたバージョンのインテントを削除します。あるインテントのすべてのバージョンを削除するには、[DeleteIntent](API_DeleteIntent.md) オペレーションを使用します。 このオペレーションには、`lex:DeleteIntentVersion` アクションに対する許可が必要です。 ## リクエストの構文 ``` DELETE /intents/name/versions/version HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_DeleteIntentVersion_RequestSyntax) ** インテントの名前。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [version](#API_DeleteIntentVersion_RequestSyntax) ** 削除するインテントのバージョン。`$LATEST` バージョンのインテントを削除することはできません。`$LATEST` バージョンを削除するには、[DeleteIntent](API_DeleteIntent.md) オペレーションを行います。 長さの制限：最小長 1、最大長 64 パターン: `[0-9]+` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 204 ``` ## レスポンス要素 アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ** ResourceInUseException ** 削除しようとしているリソースは、別のリソースによって参照されています。この情報を使用して、削除するリソースへの参照を解除します。 例外の本文には、リソースを記述する JSON オブジェクトが含まれています。 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,` `"resourceReference": {` `"name": string, "version": string } }` ** exampleReference ** 削除するリソースを参照しているリソースについて説明します。このオブジェクトは、`ResourceInUseException` の例外の一部として返されます。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteIntentVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteIntentVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteIntentVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteIntentVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteIntentVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteIntentVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteIntentVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteIntentVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteIntentVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteIntentVersion) # DeleteSlotType `$LATEST` バージョンを含む、スロットタイプのすべてのバージョンを削除します。スロットタイプの特定のバージョンを削除するには、[DeleteSlotTypeVersion](API_DeleteSlotTypeVersion.md) のオペレーションを行います。 スロットタイプのバージョンは、参照されていない場合にのみ削除できます。1 つ以上のインテントで参照されるスロットタイプを削除するには、まずそれらの参照を解除する必要があります。 **注記** `ResourceInUseException` の例外が発生した場合は、スロットタイプがどこで参照されているかを示す参照例を提供します。スロットタイプへの参照を解除するには、ボットを更新するか、ボットを削除します。もう一度、スロットタイプを削除しようとしたときに同じ例外が発生した場合は、スロットタイプの参照先がすべて解除され、`DeleteSlotType` への呼び出しが成功するまで繰り返します。 このオペレーションには `lex:DeleteSlotType` アクションに対するアクセス許可が必要です。 ## リクエストの構文 ``` DELETE /slottypes/name HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_DeleteSlotType_RequestSyntax) ** スロットタイプの名前。名前は、大文字と小文字が区別されます。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 204 ``` ## レスポンス要素 アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ** ResourceInUseException ** 削除しようとしているリソースは、別のリソースによって参照されています。この情報を使用して、削除するリソースへの参照を解除します。 例外の本文には、リソースを記述する JSON オブジェクトが含まれています。 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,` `"resourceReference": {` `"name": string, "version": string } }` ** exampleReference ** 削除するリソースを参照しているリソースについて説明します。このオブジェクトは、`ResourceInUseException` の例外の一部として返されます。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteSlotType) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteSlotType) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteSlotType) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteSlotType) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteSlotType) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteSlotType) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteSlotType) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteSlotType) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteSlotType) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteSlotType) # DeleteSlotTypeVersion 指定されたバージョンのスロットタイプを削除します。あるスロットタイプのすべてのバージョンを削除するには、[DeleteSlotType](API_DeleteSlotType.md) オペレーションを行います。 このオペレーションには、`lex:DeleteSlotTypeVersion` アクションに対する許可が必要です。 ## リクエストの構文 ``` DELETE /slottypes/name/version/version HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_DeleteSlotTypeVersion_RequestSyntax) ** スロットタイプの名前。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [version](#API_DeleteSlotTypeVersion_RequestSyntax) ** 削除するスロットタイプのバージョン。スロットタイプの `$LATEST` バージョンは削除できません。`$LATEST` バージョンを削除するには、[DeleteSlotType](API_DeleteSlotType.md) オペレーションを行います。 長さの制限：最小長 1、最大長 64 パターン: `[0-9]+` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 204 ``` ## レスポンス要素 アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ** ResourceInUseException ** 削除しようとしているリソースは、別のリソースによって参照されています。この情報を使用して、削除するリソースへの参照を解除します。 例外の本文には、リソースを記述する JSON オブジェクトが含まれています。 `{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,` `"resourceReference": {` `"name": string, "version": string } }` ** exampleReference ** 削除するリソースを参照しているリソースについて説明します。このオブジェクトは、`ResourceInUseException` の例外の一部として返されます。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteSlotTypeVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteSlotTypeVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteSlotTypeVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteSlotTypeVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteSlotTypeVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteSlotTypeVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteSlotTypeVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteSlotTypeVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteSlotTypeVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteSlotTypeVersion) # DeleteUtterances 保存された発話を削除します。 Amazon Lex は、ユーザーがボットに送信する発話を保存します。発話は、[GetUtterancesView](API_GetUtterancesView.md) のオペレーションを使用するために15日間保存され、その後、ユーザーの入力に反応するボットの能力を向上させるために無期限に保存されます。 `DeleteUtterances` オペレーションを使用して、特定のユーザーの保存された発話を手動で削除します。`DeleteUtterances` オペレーションを行うと、ユーザーの入力に対するボットの応答能力を向上させるために保存されていた発話は、直ちに削除されます。`GetUtterancesView` オペレーションで使用するために保存された発話は 15 日後に削除されます。 このオペレーションには、`lex:DeleteUtterances` アクションに対する許可が必要です。 ## リクエストの構文 ``` DELETE /bots/botName/utterances/userId HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [botName](#API_DeleteUtterances_RequestSyntax) ** 発話を格納したボットの名前。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [userId](#API_DeleteUtterances_RequestSyntax) ** 発話をしたユーザーの一意の識別子。これは、発話を含んだ [PostContent](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) または [PostText](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) 操作リクエストで送信されたユーザー ID です。 長さの制限: 最小長は 2 です。最大長は 100 です。 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 204 ``` ## レスポンス要素 アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/DeleteUtterances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/DeleteUtterances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/DeleteUtterances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/DeleteUtterances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/DeleteUtterances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/DeleteUtterances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/DeleteUtterances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/DeleteUtterances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/DeleteUtterances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/DeleteUtterances) # GetBot 特定のボットのメタデータ情報を返します。ボットの名前、ボットのバージョンまたはエイリアスを指定する必要があります。 このオペレーションには、`lex:GetBot` アクションに対する許可が必要です。 ## リクエストの構文 ``` GET /bots/name/versions/versionoralias HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_GetBot_RequestSyntax) ** ボットの名前。名前は、大文字と小文字が区別されます。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [versionoralias](#API_GetBot_RequestSyntax) ** ボットのバージョンまたはエイリアス。 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "abortStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "checksum": "string", "childDirected": boolean, "clarificationPrompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "createdDate": number, "description": "string", "detectSentiment": boolean, "enableModelImprovements": boolean, "failureReason": "string", "idleSessionTTLInSeconds": number, "intents": [ { "intentName": "string", "intentVersion": "string" } ], "lastUpdatedDate": number, "locale": "string", "name": "string", "nluIntentConfidenceThreshold": number, "status": "string", "version": "string", "voiceId": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [abortStatement](#API_GetBot_ResponseSyntax) ** ユーザーが会話を完了せずに終了することを選択した場合に Amazon Lex が返すメッセージ。詳細については、「[PutBot](API_PutBot.md)」を参照してください。 型: [Statement](API_Statement.md) オブジェクト ** [checksum](#API_GetBot_ResponseSyntax) ** ボットの `$LATEST` バージョンの特定のリビジョンを識別するために使用される、ボットのチェックサム。 タイプ: 文字列 ** [childDirected](#API_GetBot_ResponseSyntax) ** Amazon Lex Model·Building·Service で作成された各 Amazon Lex ボットについて、Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連しており、COPPA (Children's Online Privacy Protection Act) の対象となっているかどうかを、`childDirected` フィールドに `true` または `false` を指定する必要があります。`true` のフィールド中の `childDirected` を指定することで、Amazon Lex の使用が、全体あるいは一部が 13 歳未満の子どもに向けられた、あるいはターゲットとし、また COPPA の対象となるウェブサイト、プログラムと、関係して **いる** ことに同意します。`false` のフィールド中の `childDirected` を指定することで、Amazon Lex の使用が、全体あるいは一部が 13 歳未満の子どもに向けられた、あるいはターゲットとし、また COPPA の対象となるウェブサイト、プログラムと、関係して **いない** ことに同意します。Amazon Lex の全体または一部の使用が、13歳未満の児童を対象にしており、COPPAの対象となるウェブサイト、プログラム、またはその他のアプリケーションに関連するかどうかを正確に設定するために、`childDirected` フィールドにデフォルト値を指定することはできません。 Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連する場合は、COPPA により必要とされる検証可能な保護者の同意が必要です。13 歳未満の児童を対象とするウェブサイト、プログラム、またはその他のアプリケーションに関連する Amazon Lex の全体または一部の使用についての詳細は、[「Amazon Lex FAQ」](https://aws.amazon.com/lex/faqs#data-security)を参照してください。 型: ブール値 ** [clarificationPrompt](#API_GetBot_ResponseSyntax) ** Amazon Lex がユーザーのリクエストを理解できない場合に、使用するメッセージ。詳細については、「[PutBot](API_PutBot.md)」を参照してください。 型: [Prompt](API_Prompt.md) オブジェクト ** [createdDate](#API_GetBot_ResponseSyntax) ** ボットが作成された日付。 型: タイムスタンプ ** [description](#API_GetBot_ResponseSyntax) ** ボットの説明。 タイプ: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 ** [detectSentiment](#API_GetBot_ResponseSyntax) ** ユーザーの発話を Amazon Comprehend に送信して、センチメント分析を行うかどうかを示します。 型: ブール値 ** [enableModelImprovements](#API_GetBot_ResponseSyntax) ** ボットが精度向上を使用しているかどうかを示します。`true` はボットが精度向上を使用していることを示し、それ以外は `false` となります。 型: ブール値 ** [failureReason](#API_GetBot_ResponseSyntax) ** `status` が `FAILED` の場合、Amazon Lex はボットの構築に失敗した理由を提示します。 タイプ: 文字列 ** [idleSessionTTLInSeconds](#API_GetBot_ResponseSyntax) ** Amazon Lex が会話で収集したデータを保持する最大時間 (秒) です。詳細については、「[PutBot](API_PutBot.md)」を参照してください。 型: 整数 有効範囲: 最小値 は 60 です。最大値は 86400 です。 ** [intents](#API_GetBot_ResponseSyntax) ** `intent` オブジェクトの配列。詳細については、「[PutBot](API_PutBot.md)」を参照してください。 型: [Intent](API_Intent.md) オブジェクトの配列 ** [lastUpdatedDate](#API_GetBot_ResponseSyntax) ** ボットが更新された日付。リソースを作成すると、作成日と最終更新日は同じ日付になります。 型: タイムスタンプ ** [locale](#API_GetBot_ResponseSyntax) ** ボットのターゲットロケール。 型: 文字列 有効な値：`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` ** [name](#API_GetBot_ResponseSyntax) ** ボットの名前。 タイプ: 文字列 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` ** [nluIntentConfidenceThreshold](#API_GetBot_ResponseSyntax) ** Amazon Lex が [PostContent](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) または [PostText](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) レスポンスで代替インテントを返す際に、`AMAZON.FallbackIntent`、`AMAZON.KendraSearchIntent`、またはその両方を挿入する場所を決定するスコアです。`AMAZON.FallbackIntent` は、すべてのインテントの信頼性スコアがこの値を下回る場合に挿入されます。`AMAZON.KendraSearchIntent` は、ボットに設定されている場合のみ挿入されます。 型: 倍精度浮動小数点数 有効範囲: 最小値 は 0 です。最大値は 1 です。 ** [status](#API_GetBot_ResponseSyntax) ** ボットのステータス。 ステータスが `BUILDING` の場合、Amazon Lex はテストと使用のためにボットを構築します。 ボットのステータスが `READY_BASIC_TESTING` の場合、ボットのインテントで指定された正確な発話を使用してボットをテストできます。ボットが完全なテストまたは実行の準備ができたら、ステータスは `READY` になります。 ボットの構築に問題があった場合、ステータスは `FAILED` となり、`failureReason` のフィールドにはボットが構築できなかった理由が記載されます。 ボットが保存され、まだビルドされていない場合、ステータスは `NOT_BUILT` になります。 型: 文字列 有効な値：`BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT` ** [version](#API_GetBot_ResponseSyntax) ** ボットのバージョン。新規のボットの場合、バージョンは常に `$LATEST` です。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `\$LATEST|[0-9]+` ** [voiceId](#API_GetBot_ResponseSyntax) ** Amazon Lex がユーザーとの音声対話に使用する Amazon Polly 音声 ID。詳細については、「[PutBot](API_PutBot.md)」を参照してください。 タイプ: 文字列 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBot) # GetBotAlias Amazon Lex ボットエイリアスに関する情報を返します。エイリアスの詳細については、「[バージョニングとエイリアス](versioning-aliases.md)」を参照してください。 このオペレーションには、`lex:GetBotAlias` アクションに対する許可が必要です。 ## リクエストの構文 ``` GET /bots/botName/aliases/name HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [botName](#API_GetBotAlias_RequestSyntax) ** ボットの名前。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [name](#API_GetBotAlias_RequestSyntax) ** ボットエイリアスの名前。名前は、大文字と小文字が区別されます。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "botName": "string", "botVersion": "string", "checksum": "string", "conversationLogs": { "iamRoleArn": "string", "logSettings": [ { "destination": "string", "kmsKeyArn": "string", "logType": "string", "resourceArn": "string", "resourcePrefix": "string" } ] }, "createdDate": number, "description": "string", "lastUpdatedDate": number, "name": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [botName](#API_GetBotAlias_ResponseSyntax) ** エイリアスが指すボットの名前。 タイプ: 文字列 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` ** [botVersion](#API_GetBotAlias_ResponseSyntax) ** エイリアスが指すボットのバージョン。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `\$LATEST|[0-9]+` ** [checksum](#API_GetBotAlias_ResponseSyntax) ** ボットエイリアスのチェックサム。 タイプ: 文字列 ** [conversationLogs](#API_GetBotAlias_ResponseSyntax) ** Amazon Lex がエイリアスの会話ログをどのように使用するかを決定する設定。 型: [ConversationLogsResponse](API_ConversationLogsResponse.md) オブジェクト ** [createdDate](#API_GetBotAlias_ResponseSyntax) ** ボットエイリアスが作成された日付。 型: タイムスタンプ ** [description](#API_GetBotAlias_ResponseSyntax) ** ボットエイリアスの説明。 タイプ: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 ** [lastUpdatedDate](#API_GetBotAlias_ResponseSyntax) ** ボットエイリアスが更新された日付。リソースを作成する場合、作成日と最終更新日は同じ日付になります。 型: タイムスタンプ ** [name](#API_GetBotAlias_ResponseSyntax) ** ボットエイリアスの名前。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBotAlias) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBotAlias) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBotAlias) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBotAlias) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBotAlias) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBotAlias) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBotAlias) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBotAlias) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBotAlias) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBotAlias) # GetBotAliases 指定された Amazon Lex ボットのエイリアスのリストを返します。 このオペレーションには、`lex:GetBotAliases` アクションに対する許可が必要です。 ## リクエストの構文 ``` GET /bots/botName/aliases/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [botName](#API_GetBotAliases_RequestSyntax) ** ボットの名前。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [maxResults](#API_GetBotAliases_RequestSyntax) ** レスポンスに返されるエイリアスの最大数。デフォルトは 50 です 。 有効範囲: 最小値 1。最大値は 50 です。 ** [nameContains](#API_GetBotAliases_RequestSyntax) ** ボットのエイリアス名で一致する部分文字列。名前の一部が部分文字列と一致する場合、エイリアスが返されます。例えば、「xyz」は「xyzabc」と「abcxyz」の両方に一致します。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` ** [nextToken](#API_GetBotAliases_RequestSyntax) ** エイリアスの次のページを取得するためのページ割りトークン。この呼び出しに対する応答が切り捨てられた場合、Amazon Lex は応答の中にページ割りトークンを返します。次のページのエイリアスを取得するには、次のリクエストでページ割りページ割りトークンを指定します。 ## リクエスト本文 リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "BotAliases": [ { "botName": "string", "botVersion": "string", "checksum": "string", "conversationLogs": { "iamRoleArn": "string", "logSettings": [ { "destination": "string", "kmsKeyArn": "string", "logType": "string", "resourceArn": "string", "resourcePrefix": "string" } ] }, "createdDate": number, "description": "string", "lastUpdatedDate": number, "name": "string" } ], "nextToken": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [BotAliases](#API_GetBotAliases_ResponseSyntax) ** `BotAliasMetadata` オブジェクトの配列で、それぞれがボットのエイリアスを表します。 型: [BotAliasMetadata](API_BotAliasMetadata.md) オブジェクトの配列 ** [nextToken](#API_GetBotAliases_ResponseSyntax) ** エイリアスの次のページを取得するためのページ割りトークン。この呼び出しに対する応答が切り捨てられた場合、Amazon Lex は応答の中にページ割りトークンを返します。次のページのエイリアスを取得するには、次のリクエストでページ割りページ割りトークンを指定します。 タイプ: 文字列 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ## 以下も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBotAliases) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBotAliases) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBotAliases) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBotAliases) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBotAliases) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBotAliases) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBotAliases) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBotAliases) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBotAliases) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBotAliases) # GetBotChannelAssociation Amazon Lex ボットとメッセージングプラットフォームの間の関連付けに関する情報を返します。 このオペレーションには、`lex:GetBotChannelAssociation` アクションに対する許可が必要です。 ## リクエストの構文 ``` GET /bots/botName/aliases/aliasName/channels/name HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [aliasName](#API_GetBotChannelAssociation_RequestSyntax) ** この関連付けが作成されている Amazon Lex ボットの特定のバージョンを指すエイリアス。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [botName](#API_GetBotChannelAssociation_RequestSyntax) ** Amazon Lex ボットの名前。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [name](#API_GetBotChannelAssociation_RequestSyntax) ** ボットとチャンネル間の関連付けの名前。名前は、大文字と小文字が区別されます。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "botAlias": "string", "botConfiguration": { "string" : "string" }, "botName": "string", "createdDate": number, "description": "string", "failureReason": "string", "name": "string", "status": "string", "type": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [botAlias](#API_GetBotChannelAssociation_ResponseSyntax) ** この関連付けが作成されている Amazon Lex ボットの特定のバージョンを指すエイリアス。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` ** [botConfiguration](#API_GetBotChannelAssociation_ResponseSyntax) ** メッセージングプラットフォームが Amazon Lex ボットと通信するために必要な情報を提供します。 型: 文字列間のマッピング マップエントリ: 10 の項目の最大数。 ** [botName](#API_GetBotChannelAssociation_ResponseSyntax) ** Amazon Lex ボットの名前。 タイプ: 文字列 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` ** [createdDate](#API_GetBotChannelAssociation_ResponseSyntax) ** ボットとチャンネルの関連付けが作成された日付。 型: タイムスタンプ ** [description](#API_GetBotChannelAssociation_ResponseSyntax) ** ボットとチャンネル間の関連付けの説明。 タイプ: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 ** [failureReason](#API_GetBotChannelAssociation_ResponseSyntax) ** `status` が `FAILED` の場合、Amazon Lex は関連性の作成に失敗した理由を提示します。 タイプ: 文字列 ** [name](#API_GetBotChannelAssociation_ResponseSyntax) ** ボットとチャンネル間の関連付けの名前。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` ** [status](#API_GetBotChannelAssociation_ResponseSyntax) ** ボットチャンネルのステータス。 + `CREATED` - チャンネルが作成され、使用可能な状態です。 + `IN_PROGRESS` - チャンネルの作成中。 + `FAILED` - チャンネルの作成中にエラーが発生しました。失敗の原因については、「`failureReason`」フィールドを参照してください。 型: 文字列 有効な値：`IN_PROGRESS | CREATED | FAILED` ** [type](#API_GetBotChannelAssociation_ResponseSyntax) ** メッセージングプラットフォームのタイプ。 型: 文字列 有効な値：`Facebook | Slack | Twilio-Sms | Kik` ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBotChannelAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBotChannelAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBotChannelAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBotChannelAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBotChannelAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBotChannelAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBotChannelAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBotChannelAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBotChannelAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBotChannelAssociation) # GetBotChannelAssociations 特定のボットに関連付けられているすべてのチャンネルのリストを返します。 この `GetBotChannelAssociations` オペレーションには、`lex:GetBotChannelAssociations` アクションに対するアクセス許可が必要です。 ## リクエストの構文 ``` GET /bots/botName/aliases/aliasName/channels/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [aliasName](#API_GetBotChannelAssociations_RequestSyntax) ** この関連付けが作成されている Amazon Lex ボットの特定のバージョンを指すエイリアス。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^(-|^([A-Za-z]_?)+$)$` 必須: はい ** [botName](#API_GetBotChannelAssociations_RequestSyntax) ** アソシエーション内の Amazon Lex ボットの名前。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [maxResults](#API_GetBotChannelAssociations_RequestSyntax) ** レスポンスに返されるアソシエーションの最大数。デフォルトは 50 です。 有効範囲: 最小値 1。最大値は 50 です。 ** [nameContains](#API_GetBotChannelAssociations_RequestSyntax) ** チャンネルアソシエーション名で照合する部分文字列。関連付けは、名前の一部が部分文字列と一致する場合に返されます。例えば、「xyz」は「xyzabc」と「abcxyz」の両方に一致します。すべてのボットチャンネルのアソシエーションを返すには、`nameContains` パラメータにハイフン (「-」) を使用します。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` ** [nextToken](#API_GetBotChannelAssociations_RequestSyntax) ** 関連付けの次のページを取得するためのページ割りトークン。この呼び出しに対する応答が切り捨てられた場合、Amazon Lex は応答の中にページ割りトークンを返します。次のページの関連付けを取得するには、次のリクエストでページ割りトークンを指定します。 ## リクエスト本文 リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "botChannelAssociations": [ { "botAlias": "string", "botConfiguration": { "string" : "string" }, "botName": "string", "createdDate": number, "description": "string", "failureReason": "string", "name": "string", "status": "string", "type": "string" } ], "nextToken": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [botChannelAssociations](#API_GetBotChannelAssociations_ResponseSyntax) ** Amazon Lex ボットとチャンネルとの関連付けに関する情報を提供するオブジェクトの配列 (各関連付けごとに 1 つ)。 型: [BotChannelAssociation](API_BotChannelAssociation.md) オブジェクトの配列 ** [nextToken](#API_GetBotChannelAssociations_ResponseSyntax) ** 次のページの関連付けを取得するページ割りトークン。この呼び出しに対する応答が切り捨てられた場合、Amazon Lex は応答の中にページ割りトークンを返します。次のページの関連付けを取得するには、次のリクエストでページ割りトークンを指定します。 タイプ: 文字列 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ## 以下も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBotChannelAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBotChannelAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBotChannelAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBotChannelAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBotChannelAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBotChannelAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBotChannelAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBotChannelAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBotChannelAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBotChannelAssociations) # GetBots 以下のようにボット情報を返します。 + `nameContains` フィールドを指定すると、名前に指定した文字列が含まれるすべてのボットの `$LATEST` バージョンの情報が応答に含まれます。 + `nameContains` フィールドを指定しなかった場合、このオペレーションでは、すべてのボットの `$LATEST` バージョンの情報が返されます。 このオペレーションには `lex:GetBots` アクションに対するアクセス許可が必要です。 ## リクエストの構文 ``` GET /bots/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [maxResults](#API_GetBots_RequestSyntax) ** リクエストが返すレスポンスに含まれるボットの最大数。デフォルトは 10 です。 有効範囲: 最小値 1。最大値は 50 です。 ** [nameContains](#API_GetBots_RequestSyntax) ** ボット名にマッチする部分文字列。ボットの名前の一部が部分文字列と一致する場合、ボットが返されます。例えば、「xyz」は「xyzabc」と「abcxyz」の両方に一致します。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` ** [nextToken](#API_GetBots_RequestSyntax) ** ボットの次のページを取得するページ割りトークン。この呼び出しに対する応答が切り捨てられた場合、Amazon Lex は応答の中にページ割りトークンを返します。ボットの次のページを取得するには、次のリクエストでページ分割トークンを指定します。 ## リクエスト本文 リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "bots": [ { "createdDate": number, "description": "string", "lastUpdatedDate": number, "name": "string", "status": "string", "version": "string" } ], "nextToken": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [bots](#API_GetBots_ResponseSyntax) ** `botMetadata` オブジェクトの配列で、各ボットに 1 つのエントリがあります。 型: [BotMetadata](API_BotMetadata.md) オブジェクトの配列 ** [nextToken](#API_GetBots_ResponseSyntax) ** レスポンスが切り捨てられる場合、次のリクエストでボットの次のページを取得するためのページ割りトークンが含まれます。 タイプ: 文字列 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBots) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBots) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBots) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBots) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBots) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBots) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBots) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBots) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBots) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBots) # GetBotVersions ボットのすべてのバージョンに関する情報を受け取ります。 `GetBotVersions` オペレーションは、ボットの各バージョンに対して `BotMetadata` オブジェクトを返します。例えば、あるボットに 3 つの番号がついたバージョンがある場合、`GetBotVersions` オペレーションは、各番号のバージョンに 1 つ、`$LATEST` バージョンに 1 つ、合計 4 つの `BotMetadata` オブジェクトをレスポンスに返します。 `GetBotVersions` オペレーションは、少なくとも 1 つの `$LATEST` バージョンを常に返します。 このオペレーションには、`lex:GetBotVersions` アクションに対する許可が必要です。 ## リクエストの構文 ``` GET /bots/name/versions/?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [maxResults](#API_GetBotVersions_RequestSyntax) ** レスポンスに返されるボットバージョンの最大数。デフォルトは 10 です。 有効範囲: 最小値 1。最大値は 50 です。 ** [name](#API_GetBotVersions_RequestSyntax) ** バージョンを返すボットの名前です。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [nextToken](#API_GetBotVersions_RequestSyntax) ** ボットバージョンの次のページを取得するためのページ割りトークン。この呼び出しに対する応答が切り捨てられた場合、Amazon Lex は応答の中にページ割りトークンを返します。次のページのバージョンを取得するには、次のリクエストでページ割りトークンを指定します。 ## リクエスト本文 リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "bots": [ { "createdDate": number, "description": "string", "lastUpdatedDate": number, "name": "string", "status": "string", "version": "string" } ], "nextToken": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [bots](#API_GetBotVersions_ResponseSyntax) ** `BotMetadata` オブジェクトの配列で、ボットの各番号のバージョンに 1 つずつ、さらに `$LATEST` バージョンに 1 つあります。 型: [BotMetadata](API_BotMetadata.md) オブジェクトの配列 ** [nextToken](#API_GetBotVersions_ResponseSyntax) ** ボットバージョンの次のページを取得するためのページ割りトークン。この呼び出しに対する応答が切り捨てられた場合、Amazon Lex は応答の中にページ割りトークンを返します。次のページのバージョンを取得するには、次のリクエストでページ割りトークンを指定します。 タイプ: 文字列 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBotVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBotVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBotVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBotVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBotVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBotVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBotVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBotVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBotVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBotVersions) # GetBuiltinIntent 組み込みインテントに関する情報を返します。 このオペレーションには `lex:GetBuiltinIntent` アクションに対するアクセス許可が必要です。 ## リクエストの構文 ``` GET /builtins/intents/signature HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [signature](#API_GetBuiltinIntent_RequestSyntax) ** 組み込みインテントの一意の識別子。インテントの署名を見つけるには、*「Alexa Skills Kit」*の[「Standard Built-in Intents」](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents)(標準の組み込みインテント) を参照してください。 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "signature": "string", "slots": [ { "name": "string" } ], "supportedLocales": [ "string" ] } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [signature](#API_GetBuiltinIntent_ResponseSyntax) ** 組み込みインテントの一意の識別子。 タイプ: 文字列 ** [slots](#API_GetBuiltinIntent_ResponseSyntax) ** `BuiltinIntentSlot` オブジェクトの配列で、インテントの各スロットタイプごとに 1 つのエントリがあります。 型: [BuiltinIntentSlot](API_BuiltinIntentSlot.md) オブジェクトの配列 ** [supportedLocales](#API_GetBuiltinIntent_ResponseSyntax) ** インテントがサポートするロケールのリスト。 型: 文字列の配列 有効な値：`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` ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBuiltinIntent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBuiltinIntent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBuiltinIntent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBuiltinIntent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBuiltinIntent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBuiltinIntent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBuiltinIntent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBuiltinIntent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBuiltinIntent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBuiltinIntent) # GetBuiltinIntents 指定された基準を満たす組み込みインテントのリストを取得します。 このオペレーションには `lex:GetBuiltinIntents` アクションに対するアクセス許可が必要です。 ## リクエストの構文 ``` GET /builtins/intents/?locale=locale&maxResults=maxResults&nextToken=nextToken&signatureContains=signatureContains HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [locale](#API_GetBuiltinIntents_RequestSyntax) ** インテントがサポートするロケールのリスト。 有効な値：`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` ** [maxResults](#API_GetBuiltinIntents_RequestSyntax) ** レスポンスに返されるインテントの最大数。デフォルトは 10 です。 有効範囲: 最小値 1。最大値は 50 です。 ** [nextToken](#API_GetBuiltinIntents_RequestSyntax) ** インテントの次のページを取得するページ割りトークン。この API コールが切り捨てられると、Amazon Lex はレスポンスでページ割りトークンを返します。次のページのエイリアスを取得するには、次のリクエストでページ割りトークンを指定します。 ** [signatureContains](#API_GetBuiltinIntents_RequestSyntax) ** 組み込みインテントシグニチャで照合する部分文字列。インテントは、署名の一部が部分文字列と一致した場合に返されます。例えば、「xyz」は「xyzabc」と「abcxyz」の両方に一致します。インテントの署名を見つけるには、*「Alexa Skills Kit」*の[「Standard Built-in Intents」](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents)(標準の組み込みインテント) を参照してください。 ## リクエスト本文 リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "intents": [ { "signature": "string", "supportedLocales": [ "string" ] } ], "nextToken": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [intents](#API_GetBuiltinIntents_ResponseSyntax) ** `builtinIntentMetadata` オブジェクトの配列で、レスポンスの各インテントに対して 1 つずつです。 型: [BuiltinIntentMetadata](API_BuiltinIntentMetadata.md) オブジェクトの配列 ** [nextToken](#API_GetBuiltinIntents_ResponseSyntax) ** インテントの次のページを取得するページ割りトークン。この API コールに対するレスポンスが切り捨てられた場合、Amazon Lex はレスポンスでページ割りトークンを返します。インテントの次のページを取得するには、次のリクエストでページ割りトークンを指定します。 タイプ: 文字列 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ## 以下も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBuiltinIntents) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBuiltinIntents) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBuiltinIntents) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBuiltinIntents) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBuiltinIntents) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBuiltinIntents) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBuiltinIntents) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBuiltinIntents) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBuiltinIntents) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBuiltinIntents) # GetBuiltinSlotTypes 指定された基準を満たす組み込みスロットタイプのリストを取得します。 組み込みスロットタイプの一覧については、[「Alexa Skills Kit」](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference)の*「Slot Type Reference」*を参照してください。 このオペレーションには `lex:GetBuiltInSlotTypes` アクションに対するアクセス許可が必要です。 ## リクエストの構文 ``` GET /builtins/slottypes/?locale=locale&maxResults=maxResults&nextToken=nextToken&signatureContains=signatureContains HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [locale](#API_GetBuiltinSlotTypes_RequestSyntax) ** スロットタイプがサポートするロケールのリスト。 有効な値：`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` ** [maxResults](#API_GetBuiltinSlotTypes_RequestSyntax) ** レスポンスに返されるスロットタイプの最大数。デフォルトは 10 です。 有効範囲: 最小値 1。最大値は 50 です。 ** [nextToken](#API_GetBuiltinSlotTypes_RequestSyntax) ** スロットタイプの次のページを取得するページ割りトークン。この API コールに対するレスポンスが切り捨てられた場合、Amazon Lex はレスポンスでページ割りトークンを返します。スロットタイプの次のページを取得するには、次のリクエストでページ割りトークンを指定します。 ** [signatureContains](#API_GetBuiltinSlotTypes_RequestSyntax) ** 組み込みスロットタイプのシグニチャで一致する部分文字列。スロットタイプは、署名の一部が部分文字列と一致した場合に返されます。例えば、「xyz」は「xyzabc」と「abcxyz」の両方に一致します。 ## リクエスト本文 リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "slotTypes": [ { "signature": "string", "supportedLocales": [ "string" ] } ] } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [nextToken](#API_GetBuiltinSlotTypes_ResponseSyntax) ** レスポンスが切り捨てられた場合、レスポンスにページ割りトークンが含まれており、次のリクエストでスロットタイプの次のページを取得できます。 タイプ: 文字列 ** [slotTypes](#API_GetBuiltinSlotTypes_ResponseSyntax) ** `BuiltInSlotTypeMetadata` オブジェクトの配列で、返された各スロットタイプごとに 1 つのエントリがあります。 型: [BuiltinSlotTypeMetadata](API_BuiltinSlotTypeMetadata.md) オブジェクトの配列 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ## 以下も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBuiltinSlotTypes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBuiltinSlotTypes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBuiltinSlotTypes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBuiltinSlotTypes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBuiltinSlotTypes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBuiltinSlotTypes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBuiltinSlotTypes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBuiltinSlotTypes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBuiltinSlotTypes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBuiltinSlotTypes) # GetExport Amazon Lex リソースの内容を指定された形式でエクスポートします。 ## リクエストの構文 ``` GET /exports/?exportType=exportType&name=name&resourceType=resourceType&version=version HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [exportType](#API_GetExport_RequestSyntax) ** エクスポートするデータの形式。 有効な値：`ALEXA_SKILLS_KIT | LEX` 必須: はい ** [name](#API_GetExport_RequestSyntax) ** エクスポートするボットの名前。 長さの制限：最小長 1、最大長は 100 です。 パターン: `[a-zA-Z_]+` 必須: はい ** [resourceType](#API_GetExport_RequestSyntax) ** エクスポートするリソースのタイプ。 有効な値：`BOT | INTENT | SLOT_TYPE` 必須: はい ** [version](#API_GetExport_RequestSyntax) ** エクスポートするボットのバージョン。 長さの制限：最小長 1、最大長 64 パターン: `[0-9]+` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "exportStatus": "string", "exportType": "string", "failureReason": "string", "name": "string", "resourceType": "string", "url": "string", "version": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [exportStatus](#API_GetExport_ResponseSyntax) ** エクスポートのステータス。 + `IN_PROGRESS` - エクスポートが進行中です。 + `READY` - エクスポートが完了しました。 + `FAILED` - エクスポートを完了できませんでした。 型: 文字列 有効な値：`IN_PROGRESS | READY | FAILED` ** [exportType](#API_GetExport_ResponseSyntax) ** エクスポートするデータの形式 型: 文字列 有効な値：`ALEXA_SKILLS_KIT | LEX` ** [failureReason](#API_GetExport_ResponseSyntax) ** `status` が `FAILED` の場合、Amazon Lex がリソースのエクスポートに失敗した理由を提示します。 タイプ: 文字列 ** [name](#API_GetExport_ResponseSyntax) ** エクスポートされるボットの名前。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `[a-zA-Z_]+` ** [resourceType](#API_GetExport_ResponseSyntax) ** エクスポートされたリソースのタイプ。 型: 文字列 有効な値：`BOT | INTENT | SLOT_TYPE` ** [url](#API_GetExport_ResponseSyntax) ** エクスポートされたリソースの場所を提供する S3 の署名付き URL。エクスポートされたリソースは、エクスポートされた JSON 形式のリソースを含む ZIP アーカイブです。アーカイブの構造は変わる可能性があります。コードはアーカイブ構造に依存してはいけません。 タイプ: 文字列 ** [version](#API_GetExport_ResponseSyntax) ** エクスポートされるボットのバージョン。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `[0-9]+` ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetExport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetExport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetExport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetExport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetExport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetExport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetExport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetExport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetExport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetExport) # GetImport `StartImport` オペレーションで開始したインポートジョブに関する情報を取得します。 ## リクエストの構文 ``` GET /imports/importId HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [importId](#API_GetImport_RequestSyntax) ** 返すインポートジョブ情報の識別子。 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "createdDate": number, "failureReason": [ "string" ], "importId": "string", "importStatus": "string", "mergeStrategy": "string", "name": "string", "resourceType": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [createdDate](#API_GetImport_ResponseSyntax) ** インポートジョブが作成された日時のタイムスタンプ。 型: タイムスタンプ ** [failureReason](#API_GetImport_ResponseSyntax) ** インポートジョブの完了に失敗した理由を示す文字列。 型: 文字列の配列 ** [importId](#API_GetImport_ResponseSyntax) ** 特定のインポートジョブの識別子。 タイプ: 文字列 ** [importStatus](#API_GetImport_ResponseSyntax) ** インポートジョブのステータス。ステータスが `FAILED` の場合、`failureReason` フィールドから失敗の理由を確認できます。 型: 文字列 有効な値：`IN_PROGRESS | COMPLETE | FAILED` ** [mergeStrategy](#API_GetImport_ResponseSyntax) ** インポートファイル内の既存のリソースとリソースの間に競合があった場合に実行されるアクション。 型: 文字列 有効な値：`OVERWRITE_LATEST | FAIL_ON_CONFLICT` ** [name](#API_GetImport_ResponseSyntax) ** インポートジョブに付けられた名前。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `[a-zA-Z_]+` ** [resourceType](#API_GetImport_ResponseSyntax) ** インポートされたリソースのタイプ。 型: 文字列 有効な値：`BOT | INTENT | SLOT_TYPE` ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetImport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetImport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetImport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetImport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetImport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetImport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetImport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetImport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetImport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetImport) # GetIntent インテントに関する情報を返します。インテント名に加えて、インテントバージョンを指定する必要があります。 このオペレーションには `lex:GetIntent` アクションを実行するアクセス許可が必要です。 ## リクエストの構文 ``` GET /intents/name/versions/version HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_GetIntent_RequestSyntax) ** インテントの名前。名前は、大文字と小文字が区別されます。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [version](#API_GetIntent_RequestSyntax) ** インテントのバージョン。 長さの制限：最小長 1、最大長 64 パターン: `\$LATEST|[0-9]+` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "checksum": "string", "conclusionStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "confirmationPrompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "createdDate": number, "description": "string", "dialogCodeHook": { "messageVersion": "string", "uri": "string" }, "followUpPrompt": { "prompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "rejectionStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" } }, "fulfillmentActivity": { "codeHook": { "messageVersion": "string", "uri": "string" }, "type": "string" }, "inputContexts": [ { "name": "string" } ], "kendraConfiguration": { "kendraIndex": "string", "queryFilterString": "string", "role": "string" }, "lastUpdatedDate": number, "name": "string", "outputContexts": [ { "name": "string", "timeToLiveInSeconds": number, "turnsToLive": number } ], "parentIntentSignature": "string", "rejectionStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "sampleUtterances": [ "string" ], "slots": [ { "defaultValueSpec": { "defaultValueList": [ { "defaultValue": "string" } ] }, "description": "string", "name": "string", "obfuscationSetting": "string", "priority": number, "responseCard": "string", "sampleUtterances": [ "string" ], "slotConstraint": "string", "slotType": "string", "slotTypeVersion": "string", "valueElicitationPrompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" } } ], "version": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [checksum](#API_GetIntent_ResponseSyntax) ** インテントのチェックサム。 タイプ: 文字列 ** [conclusionStatement](#API_GetIntent_ResponseSyntax) ** `fulfillmentActivity` 要素で指定された Lambda 関数がインテントを達成すると、Amazon Lex はこのステートメントをユーザーに伝えます。 型: [Statement](API_Statement.md) オブジェクト ** [confirmationPrompt](#API_GetIntent_ResponseSyntax) ** これがボットに定義されている場合、Amazon Lex がユーザーのインテントを達成する前の確認に使用するプロンプトです。詳細については、「[PutIntent](API_PutIntent.md)」を参照してください。 型: [Prompt](API_Prompt.md) オブジェクト ** [createdDate](#API_GetIntent_ResponseSyntax) ** インテントが作成された日付。 型: タイムスタンプ ** [description](#API_GetIntent_ResponseSyntax) ** インテントの説明。 タイプ: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 ** [dialogCodeHook](#API_GetIntent_ResponseSyntax) ** これがボットに定義されている場合、Amazon Lex は各ユーザー入力に対してこの Lambda 関数を呼び出します。詳細については、「[PutIntent](API_PutIntent.md)」を参照してください。 型: [CodeHook](API_CodeHook.md) オブジェクト ** [followUpPrompt](#API_GetIntent_ResponseSyntax) ** これが定義されている場合、Amazon Lex はこのプロンプトを使用して、インテントが達成された後に追加のユーザーアクティビティを要求します。詳細については、「[PutIntent](API_PutIntent.md)」を参照してください。 型: [FollowUpPrompt](API_FollowUpPrompt.md) オブジェクト ** [fulfillmentActivity](#API_GetIntent_ResponseSyntax) ** インテントがどのように達成されるのかを説明します。詳細については、「[PutIntent](API_PutIntent.md)」を参照してください。 型: [FulfillmentActivity](API_FulfillmentActivity.md) オブジェクト ** [inputContexts](#API_GetIntent_ResponseSyntax) ** Amazon Lex がユーザーとの会話の中でインテントを選択するためのアクティブなコンテキストをリストアップした `InputContext` オブジェクトの配列です。 型: [InputContext](API_InputContext.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 5 項目です。 ** [kendraConfiguration](#API_GetIntent_ResponseSyntax) ** `AMAZON.KendraSearchIntent` インテントで Amazon Kendra インデックスに接続するための設定情報 (項目がある場合)。 型: [KendraConfiguration](API_KendraConfiguration.md) オブジェクト ** [lastUpdatedDate](#API_GetIntent_ResponseSyntax) ** インテントが更新された日付。リソースを作成する場合、作成日と最終更新日は同じ日付になります。 型: タイムスタンプ ** [name](#API_GetIntent_ResponseSyntax) ** インテントの名前。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` ** [outputContexts](#API_GetIntent_ResponseSyntax) ** `OutputContext` オブジェクトの配列で、インテントが達成されたときにアクティブになるコンテキストを列挙します。 型: [OutputContext](API_OutputContext.md) オブジェクトの配列 の配列メンバー: 最小数は 0 項目です。最大数は 10 項目です。 ** [parentIntentSignature](#API_GetIntent_ResponseSyntax) ** 組み込みインテントの一意の識別子。 タイプ: 文字列 ** [rejectionStatement](#API_GetIntent_ResponseSyntax) ** ユーザーが `confirmationPrompt` で定義された質問に「いいえ」と答えた場合、Amazon Lex はインテントがキャンセルされたことを確認するためにこのステートメントを返します。 型: [Statement](API_Statement.md) オブジェクト ** [sampleUtterances](#API_GetIntent_ResponseSyntax) ** インテント用に構成されたサンプル発話の配列。 型: 文字列の配列 配列メンバー: 最小数は 0 項目です。最大数は 1500 項目です。 長さの制限：最小長 1、最大長は 200 です。 ** [slots](#API_GetIntent_ResponseSyntax) ** インテント用に設定されたインテントスロットの配列。 型: [Slot](API_Slot.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 100 項目です。 ** [version](#API_GetIntent_ResponseSyntax) ** インテントのバージョン。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `\$LATEST|[0-9]+` ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetIntent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetIntent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetIntent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetIntent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetIntent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetIntent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetIntent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetIntent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetIntent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetIntent) # GetIntents 次のようにインテント情報を返します。 + `nameContains` フィールドを指定した場合は、指定した文字列を含むすべてのインテントの `$LATEST` バージョン情報を返します。 + `nameContains` フィールドを指定しない場合は、すべてのインテントの `$LATEST` バージョンの情報を返します。 オペレーションには `lex:GetIntents` アクションに対するアクセス許可が必要です。 ## リクエストの構文 ``` GET /intents/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [maxResults](#API_GetIntents_RequestSyntax) ** レスポンスに返されるインテントの最大数。デフォルトは 10 です。 有効範囲: 最小値 1。最大値は 50 です。 ** [nameContains](#API_GetIntents_RequestSyntax) ** インテント名で一致する部分文字列。インテントの名前の一部が部分文字列と一致する場合、インテントが返されます。例えば、「xyz」は「xyzabc」と「abcxyz」の両方に一致します。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` ** [nextToken](#API_GetIntents_RequestSyntax) ** インテントの次のページを取得するページ割りトークン。この API コールに対するレスポンスが切り捨てられた場合、Amazon Lex はレスポンスでページ割りトークンを返します。インテントの次のページを取得するには、次のリクエストでページ割りトークンを指定します。 ## リクエスト本文 リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "intents": [ { "createdDate": number, "description": "string", "lastUpdatedDate": number, "name": "string", "version": "string" } ], "nextToken": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [intents](#API_GetIntents_ResponseSyntax) ** `Intent` オブジェクトの配列。詳細については、「[PutBot](API_PutBot.md)」を参照してください。 型: [IntentMetadata](API_IntentMetadata.md) オブジェクトの配列 ** [nextToken](#API_GetIntents_ResponseSyntax) ** レスポンスが切り捨てられた場合、レスポンスにページ割りトークンが含まれており、次のリクエストで指定してインテントの次のページを取得できます。 タイプ: 文字列 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetIntents) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetIntents) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetIntents) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetIntents) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetIntents) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetIntents) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetIntents) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetIntents) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetIntents) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetIntents) # GetIntentVersions インテントのすべてのバージョンに関する情報を取得します。 `GetIntentVersions` オペレーションは、インテントの各バージョンに `IntentMetadata` オブジェクトを返します。例えば、あるインテントに 3 つの番号が付いたバージョンがある場合、`GetIntentVersions` オペレーションは、各番号のバージョンに 1 つ、`$LATEST` バージョンに 1 つ、合計 4 つの `IntentMetadata` オブジェクトをレスポンスに返します。 `GetIntentVersions` オペレーションは、少なくとも 1 つの `$LATEST` バージョンを常に返します。 このオペレーションには、`lex:GetIntentVersions` アクションに対する許可が必要です。 ## リクエストの構文 ``` GET /intents/name/versions/?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [maxResults](#API_GetIntentVersions_RequestSyntax) ** レスポンスに返されるインテントバージョンの最大数。デフォルトは 10 です。 有効範囲: 最小値 1。最大値は 50 です。 ** [name](#API_GetIntentVersions_RequestSyntax) ** バージョンを返すインテントの名前。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [nextToken](#API_GetIntentVersions_RequestSyntax) ** インテントバージョンの次のページを取得するためのページ割りトークン。この呼び出しに対する応答が切り捨てられた場合、Amazon Lex は応答の中にページ割りトークンを返します。次のページのバージョンを取得するには、次のリクエストでページ割りトークンを指定します。 ## リクエスト本文 リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "intents": [ { "createdDate": number, "description": "string", "lastUpdatedDate": number, "name": "string", "version": "string" } ], "nextToken": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [intents](#API_GetIntentVersions_ResponseSyntax) ** `IntentMetadata` オブジェクトの配列で、インテントの各番号のバージョンに 1 つずつ、さらに `$LATEST` バージョンに 1 つあります。 型: [IntentMetadata](API_IntentMetadata.md) オブジェクトの配列 ** [nextToken](#API_GetIntentVersions_ResponseSyntax) ** インテントバージョンの次のページを取得するためのページ割りトークン。この呼び出しに対する応答が切り捨てられた場合、Amazon Lex は応答の中にページ割りトークンを返します。次のページのバージョンを取得するには、次のリクエストでページ割りトークンを指定します。 タイプ: 文字列 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetIntentVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetIntentVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetIntentVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetIntentVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetIntentVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetIntentVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetIntentVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetIntentVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetIntentVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetIntentVersions) # GetMigration Amazon Lex V1 ボットから Amazon Lex V2 ボットへの移行中または完了した移行についての詳細を提供します。このオペレーションを行うと、移行に関連するアラートや警告が表示されます。 ## リクエストの構文 ``` GET /migrations/migrationId HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [migrationId](#API_GetMigration_RequestSyntax) ** 表示する移行の一意の識別子。`migrationID` は [StartMigration](API_StartMigration.md) のオペレーションで返されます。 長さの制限: 固定長は 10 です。 パターン: `^[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](#API_GetMigration_ResponseSyntax) ** Amazon Lex V1 ボットから Amazon Lex V2 への移行に関する問題を示すアラートと警告のリスト。Amazon Lex V2 内で Amazon Lex V1 の機能の実装が異なる場合、警告が表示されます。 詳細については、*「Amazon Lex V2 developer guide」*(Amazon Lex V2 デベロッパーガイド) の[「ボットを移行する」](https://docs.aws.amazon.com/lexv2/latest/dg/migrate.html)(Migrating a bot) を参照してください。 型: [MigrationAlert](API_MigrationAlert.md) オブジェクトの配列 ** [migrationId](#API_GetMigration_ResponseSyntax) ** 移行の一意の識別子。これは、`GetMigration` オペレーションを呼び出す際に使用される識別子と同じです。 タイプ: 文字列 長さの制限: 固定長は 10 です。 パターン: `^[0-9a-zA-Z]+$` ** [migrationStatus](#API_GetMigration_ResponseSyntax) ** 移行のステータスを示します。ステータスが `COMPLETE` になると移行が完了し、Amazon Lex V2 でボットが利用できるようになります。移行を完了するには、アラートや警告を解決する必要がある場合があります。 型: 文字列 有効な値：`IN_PROGRESS | COMPLETED | FAILED` ** [migrationStrategy](#API_GetMigration_ResponseSyntax) ** 移行を実行するために使用された戦略。 + `CREATE_NEW` - 新しい Amazon Lex V2 ボットを作成し、Amazon Lex V1 ボットをこの新しいボットに移行します。 + `UPDATE_EXISTING` - 既存の Amazon Lex V2 ボットのメタデータおよび移行されるロケールを上書きします。Amazon Lex V2 ボットの他のロケールは変更されません。ロケールが存在しない場合は、Amazon Lex V2 ボットに新しいロケールが作成されます。 型: 文字列 有効な値：`CREATE_NEW | UPDATE_EXISTING` ** [migrationTimestamp](#API_GetMigration_ResponseSyntax) ** 移行が開始された日時。 型: タイムスタンプ ** [v1BotLocale](#API_GetMigration_ResponseSyntax) ** 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](#API_GetMigration_ResponseSyntax) ** Amazon Lex V1 ボットの名前が Amazon Lex V2 に移行しました。 タイプ: 文字列 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` ** [v1BotVersion](#API_GetMigration_ResponseSyntax) ** Amazon Lex V1 ボットのバージョンが Amazon Lex V2 に移行しました。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `\$LATEST|[0-9]+` ** [v2BotId](#API_GetMigration_ResponseSyntax) ** Amazon Lex V1 の移行先である Amazon Lex V2 ボットの一意の識別子。 タイプ: 文字列 長さの制限: 固定長は 10 です。 パターン: `^[0-9a-zA-Z]+$` ** [v2BotRole](#API_GetMigration_ResponseSyntax) ** Amazon Lex が Amazon Lex V2 ボットの実行に使用する IAM ロール。 タイプ: 文字列 長さの制限: 最小長は 20 です。最大長は 2,048 です。 パターン: `^arn:[\w\-]+:iam::[\d]{12}:role/.+$` ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetMigration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetMigration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetMigration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetMigration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetMigration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetMigration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetMigration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetMigration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetMigration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetMigration) # GetMigrations Amazon Lex V1 と Amazon Lex V2 間の移行の一覧を取得します。 ## リクエストの構文 ``` GET /migrations?maxResults=maxResults&migrationStatusEquals=migrationStatusEquals&nextToken=nextToken&sortByAttribute=sortByAttribute&sortByOrder=sortByOrder&v1BotNameContains=v1BotNameContains HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [maxResults](#API_GetMigrations_RequestSyntax) ** レスポンスに返される移行の最大数。デフォルトは 10 です。 有効範囲: 最小値 1。最大値は 50 です。 ** [migrationStatusEquals](#API_GetMigrations_RequestSyntax) ** 指定した状態のマイグレーションのみを含むようにリストをフィルタリングします。 有効な値：`IN_PROGRESS | COMPLETED | FAILED` ** [nextToken](#API_GetMigrations_RequestSyntax) ** マイグレーションの次のページを取得するページ割りトークン。このオペレーションに対するレスポンスが切り捨てられた場合、Amazon Lex はレスポンスでページ割りトークンを返します。マイグレーションの次のページを取得するには、リクエストでページ割りトークンを指定します。 ** [sortByAttribute](#API_GetMigrations_RequestSyntax) ** マイグレーションのリストをソートするフィールド。Amazon Lex V1 のボット名や、移行が開始された日時でソートすることができます。 有効な値：`V1_BOT_NAME | MIGRATION_DATE_TIME` ** [sortByOrder](#API_GetMigrations_RequestSyntax) ** 順番はリストをソートします。 有効な値：`ASCENDING | DESCENDING` ** [v1BotNameContains](#API_GetMigrations_RequestSyntax) ** リストにフィルタを適用して、指定した文字列を含む名前を持つボットのみを含めます。文字列はボット名の任意の場所で一致します。 長さの制限: 最小長は 2 です。最大長は 50 です。 Pattern: `^([A-Za-z]_?)+$` ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` 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" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [migrationSummaries](#API_GetMigrations_ResponseSyntax) ** Amazon Lex V1 から Amazon Lex V2 への移行に関する概要の配列。移行の詳細を確認するには、[GetMigration](API_GetMigration.md) のオペレーションの呼び出しでサマリーから `migrationId` を使用します。 型: [MigrationSummary](API_MigrationSummary.md) オブジェクトの配列 ** [nextToken](#API_GetMigrations_ResponseSyntax) ** レスポンスが切り捨てられる場合は、次のマイグレーションページを取得するために次のリクエストで指定できるページ割りトークンが含まれます。 タイプ: 文字列 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ## 以下も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetMigrations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetMigrations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetMigrations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetMigrations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetMigrations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetMigrations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetMigrations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetMigrations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetMigrations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetMigrations) # GetSlotType スロットタイプの特定のバージョンに関する情報を返します。スロットタイプ名に加えて、スロットタイプバージョンを指定する必要があります。 このオペレーションには、`lex:GetSlotType` アクションに対する許可が必要です。 ## リクエストの構文 ``` GET /slottypes/name/versions/version HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_GetSlotType_RequestSyntax) ** スロットタイプの名前。名前は、大文字と小文字が区別されます。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [version](#API_GetSlotType_RequestSyntax) ** スロットタイプのバージョン。 長さの制限：最小長 1、最大長 64 パターン: `\$LATEST|[0-9]+` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "checksum": "string", "createdDate": number, "description": "string", "enumerationValues": [ { "synonyms": [ "string" ], "value": "string" } ], "lastUpdatedDate": number, "name": "string", "parentSlotTypeSignature": "string", "slotTypeConfigurations": [ { "regexConfiguration": { "pattern": "string" } } ], "valueSelectionStrategy": "string", "version": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [checksum](#API_GetSlotType_ResponseSyntax) ** スロットタイプの `$LATEST` バージョンのチェックサム。 タイプ: 文字列 ** [createdDate](#API_GetSlotType_ResponseSyntax) ** スロットタイプが作成された日付。 型: タイムスタンプ ** [description](#API_GetSlotType_ResponseSyntax) ** スロットタイプの説明。 タイプ: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 ** [enumerationValues](#API_GetSlotType_ResponseSyntax) ** スロットタイプが取得できる値を定義する `EnumerationValue` オブジェクトのリスト。 型: [EnumerationValue](API_EnumerationValue.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 10000 項目です。 ** [lastUpdatedDate](#API_GetSlotType_ResponseSyntax) ** スロットタイプが更新された日付。リソースを作成する場合、作成日と最終更新日は同じ日付になります。 型: タイムスタンプ ** [name](#API_GetSlotType_ResponseSyntax) ** スロットタイプの名前。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` ** [parentSlotTypeSignature](#API_GetSlotType_ResponseSyntax) ** スロットタイプの親として使用される組み込みスロットタイプ。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `^((AMAZON\.)_?|[A-Za-z]_?)+` ** [slotTypeConfigurations](#API_GetSlotType_ResponseSyntax) ** 親組み込みスロットタイプを拡張する構成情報。 型: [SlotTypeConfiguration](API_SlotTypeConfiguration.md) オブジェクトの配列 の配列メンバー: 最小数は 0 項目です。最大数は 10 項目です。 ** [valueSelectionStrategy](#API_GetSlotType_ResponseSyntax) ** Amazon Lex がスロットの価値を決定するために使用する戦略。詳細については、「[PutSlotType](API_PutSlotType.md)」を参照してください。 型: 文字列 有効な値：`ORIGINAL_VALUE | TOP_RESOLUTION` ** [version](#API_GetSlotType_ResponseSyntax) ** スロットタイプのバージョン。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `\$LATEST|[0-9]+` ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetSlotType) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetSlotType) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetSlotType) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetSlotType) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetSlotType) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetSlotType) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetSlotType) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetSlotType) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetSlotType) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetSlotType) # GetSlotTypes スロットタイプの情報を次のように返します。 + `nameContains` フィールドを指定した場合は、指定した文字列を含むすべてのスロットタイプの `$LATEST` バージョン情報を返します。 + `nameContains` フィールドを指定しない場合は、すべてのスロットタイプの `$LATEST` バージョン情報を返します。 オペレーションには `lex:GetSlotTypes` アクションに対するアクセス許可が必要です。 ## リクエストの構文 ``` GET /slottypes/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [maxResults](#API_GetSlotTypes_RequestSyntax) ** レスポンスに返されるスロットタイプの最大数。デフォルトは 10 です。 有効範囲: 最小値 1。最大値は 50 です。 ** [nameContains](#API_GetSlotTypes_RequestSyntax) ** スロットタイプ名に一致する部分文字列。スロットタイプの名前の一部が部分文字列と一致する場合、スロットタイプが返されます。例えば、「xyz」は「xyzabc」と「abcxyz」の両方に一致します。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` ** [nextToken](#API_GetSlotTypes_RequestSyntax) ** スロットタイプの次のページを取得するページ割りトークン。この API コールに対するレスポンスが切り捨てられた場合、Amazon Lex はレスポンスでページ割りトークンを返します。スロットタイプの次のページを取得するには、次のリクエストでページ割りトークンを指定します。 ## リクエスト本文 リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "slotTypes": [ { "createdDate": number, "description": "string", "lastUpdatedDate": number, "name": "string", "version": "string" } ] } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [nextToken](#API_GetSlotTypes_ResponseSyntax) ** レスポンスが切り捨てられる場合は、次のリクエストでスロットタイプの次のページを取得するために指定できるページ割りトークンが含まれます。 タイプ: 文字列 ** [slotTypes](#API_GetSlotTypes_ResponseSyntax) ** スロットタイプごとに 1 つずつ、スロットタイプの名前、バージョン、説明などの情報を提供するオブジェクトの配列。 型: [SlotTypeMetadata](API_SlotTypeMetadata.md) オブジェクトの配列 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetSlotTypes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetSlotTypes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetSlotTypes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetSlotTypes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetSlotTypes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetSlotTypes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetSlotTypes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetSlotTypes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetSlotTypes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetSlotTypes) # GetSlotTypeVersions スロットタイプのすべてのバージョンに関する情報を取得します。 `GetSlotTypeVersions` オペレーションは、スロットタイプの各バージョンの `SlotTypeMetadata` オブジェクトを返します。例えば、あるスロットタイプに 3 つの番号が付いたバージョンがある場合、`GetSlotTypeVersions` オペレーションは、各番号のバージョンに 1 つ、`$LATEST` バージョンに 1 つ、合計 4 つの `SlotTypeMetadata` オブジェクトをレスポンスに返します。 `GetSlotTypeVersions` オペレーションは、少なくとも 1 つの `$LATEST` バージョンを常に返します。 このオペレーションには、`lex:GetSlotTypeVersions` アクションに対する許可が必要です。 ## リクエストの構文 ``` GET /slottypes/name/versions/?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [maxResults](#API_GetSlotTypeVersions_RequestSyntax) ** レスポンスに返されるスロットタイプバージョンの最大数。デフォルトは 10 です。 有効範囲: 最小値 1。最大値は 50 です。 ** [name](#API_GetSlotTypeVersions_RequestSyntax) ** バージョンを返すスロットタイプの名前です。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [nextToken](#API_GetSlotTypeVersions_RequestSyntax) ** スロットタイプのバージョンの次のページを取得するためのページ割りトークン。この呼び出しに対する応答が切り捨てられた場合、Amazon Lex は応答の中にページ割りトークンを返します。次のページのバージョンを取得するには、次のリクエストでページ割りトークンを指定します。 ## リクエスト本文 リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "slotTypes": [ { "createdDate": number, "description": "string", "lastUpdatedDate": number, "name": "string", "version": "string" } ] } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [nextToken](#API_GetSlotTypeVersions_ResponseSyntax) ** スロットタイプのバージョンの次のページを取得するためのページ割りトークン。この呼び出しに対する応答が切り捨てられた場合、Amazon Lex は応答の中にページ割りトークンを返します。次のページのバージョンを取得するには、次のリクエストでページ割りトークンを指定します。 タイプ: 文字列 ** [slotTypes](#API_GetSlotTypeVersions_ResponseSyntax) ** `SlotTypeMetadata` オブジェクトの配列で、スロットタイプの番号付きバージョンごとに 1 つ、`$LATEST` バージョンに 1 つです。 型: [SlotTypeMetadata](API_SlotTypeMetadata.md) オブジェクトの配列 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetSlotTypeVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetSlotTypeVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetSlotTypeVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetSlotTypeVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetSlotTypeVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetSlotTypeVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetSlotTypeVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetSlotTypeVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetSlotTypeVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetSlotTypeVersions) # GetUtterancesView `GetUtterancesView` のオペレーションを使用して、ユーザーがボットに対して行った発話に関する情報を取得します。このリストを使用して、ボットが応答する発話を調整できます。 例: 花を注文するボットを作成したとします。ユーザーがボットをしばらく使用した後、`GetUtterancesView` オペレーションを使用して、ユーザーが行ったリクエストとその成功の有無を確認します。「花が欲しい」という発話が認識されていないかもしれません。この発話を `OrderFlowers` インテントに追加することで、ボットがその発話を認識するようになります。 ボットの新しいバージョンを公開すると、古いバージョンと新しいバージョンに関する情報を取得して、2 つのバージョン間でパフォーマンスを比較できます。 発話の統計は 1 日に 1 回生成されます。過去 15 日間のデータを使用できます。1 回のリクエストで最大 5 バージョンのボットの情報をリクエストできます。Amazon Lex は、過去 15 日間にボットが受信した最大頻度の発話を返します。レスポンスには、バージョンごとに最大 100 の発話に関する情報が含まれます。 発話の統計は、以下の条件では生成されません。 + ボットが作成されたとき、`childDirected` フィールドが TRUE に設定されます。 + 1 つ以上のスロットでスロットの難読化を実行しています。 + Amazon Lex の改善への参加をオプトアウトしました。 このオペレーションには、`lex:GetUtterancesView` アクションに対する許可が必要です。 ## リクエストの構文 ``` GET /bots/botname/utterances?view=aggregation&bot_versions=botVersions&status_type=statusType HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [botname](#API_GetUtterancesView_RequestSyntax) ** 発話情報を返すボットの名前。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [botVersions](#API_GetUtterancesView_RequestSyntax) ** 発話情報を返す必要があるボットバージョンの配列。制限は、リクエストごとに 5 バージョンです。 配列メンバー: 最小数は 1 項目です。最大数は 5 項目です。 長さの制限：最小長 1、最大長 64 パターン: `\$LATEST|[0-9]+` 必須: はい ** [statusType](#API_GetUtterancesView_RequestSyntax) ** 認識された発話を返すには、`Detected` を使用します。認識されなかった発話を返すには、`Missed` を使用します。 有効な値：`Detected | Missed` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "botName": "string", "utterances": [ { "botVersion": "string", "utterances": [ { "count": number, "distinctUsers": number, "firstUtteredDate": number, "lastUtteredDate": number, "utteranceString": "string" } ] } ] } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [botName](#API_GetUtterancesView_ResponseSyntax) ** 利用者情報を返すボットの名前。 タイプ: 文字列 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` ** [utterances](#API_GetUtterancesView_ResponseSyntax) ** [UtteranceList](API_UtteranceList.md) オブジェクトの配列で、それぞれがボットで処理された発話を記述する [UtteranceData](API_UtteranceData.md) オブジェクトのリストを含みます。レスポンスには、各バージョンごとに最大 100 個の `UtteranceData` オブジェクトが含まれます。Amazon Lex は、過去 15 日間にボットが受信した最大頻度の発話を返します。 型: [UtteranceList](API_UtteranceList.md) オブジェクトの配列 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ## 以下も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetUtterancesView) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetUtterancesView) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetUtterancesView) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetUtterancesView) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetUtterancesView) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetUtterancesView) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetUtterancesView) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetUtterancesView) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetUtterancesView) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetUtterancesView) # ListTagsForResource 指定のリソースグループに関連付けられたタグを取得します。ボット、ボットエイリアス、ボットチャンネルのみに、タグを関連付けることができます。 ## リクエストの構文 ``` GET /tags/resourceArn HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) ** タグのリストを取得するリソースの Amazon リソースネーム (ARN)。 長さの制限：最小長 1、最大長は 1011 です。 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "tags": [ { "key": "string", "value": "string" } ] } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [tags](#API_ListTagsForResource_ResponseSyntax) ** リソースに関連付けられたタグ。 型: [Tag](API_Tag.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/ListTagsForResource) # PutBot Amazon Lex 会話ボットを作成、または既存のボットを置き換えます。ボットを作成または更新する際に必要なのは、名前、ロケール、およびボットが 13 歳未満の子供を対象としているかどうかを指定することだけです。これにより、後からインテントを追加したり、既存のボットからインテントを削除したりすることができます。最低限の情報でボットを作成した場合、ボットの作成や更新は行われますが、Amazon Lex は `` の応答 `FAILED` を返します。1 つ以上のインテントを追加すると、ボットを構築できます。Amazon Lex ボットの詳細については、「[Amazon Lex: 仕組み](how-it-works.md)」を参照してください。 既存のボットの名前を指定した場合、リクエストのフィールドは、`$LATEST` バージョンのボットの既存の値に置き換えられます。　 Amazon Lex ではリクエストで値が入力されていないフィールドは削除されますが、`idleTTLInSeconds` と `privacySettings` のフィールドはデフォルト値に設定されます。必須フィールドに値を指定しない場合、Amazon Lex は例外をスローします。 このオペレーションには、`lex:PutBot` アクションに対するアクセス許可が必要です。詳細については、「[Amazon Lex のための Identity and Access Management](security-iam.md)」を参照してください。 ## リクエストの構文 ``` PUT /bots/name/versions/$LATEST HTTP/1.1 Content-type: application/json { "abortStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "checksum": "string", "childDirected": boolean, "clarificationPrompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "createVersion": boolean, "description": "string", "detectSentiment": boolean, "enableModelImprovements": boolean, "idleSessionTTLInSeconds": number, "intents": [ { "intentName": "string", "intentVersion": "string" } ], "locale": "string", "nluIntentConfidenceThreshold": number, "processBehavior": "string", "tags": [ { "key": "string", "value": "string" } ], "voiceId": "string" } ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_PutBot_RequestSyntax) ** ボットの名前。キースペース名では、大文字と小文字は区別*されません*。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [abortStatement](#API_PutBot_RequestSyntax) ** Amazon Lexは、ユーザーが入力したコンテキストを理解できない場合、何度か情報を聞き出そうとします。Amazon Lex は次に `abortStatement` で定義されたメッセージをユーザーに送信してから、会話をキャンセルします。リトライの回数を設定するには、スロットタイプの `valueElicitationPrompt` フィールドを使用します。 例えば、ピザ注文ボットでは、Amazon Lex がユーザーに「どんな種類のクラストが欲しいですか？」と尋ねるかもしれません。ユーザーの回答が想定される回答 (例えば、「薄い生地」、「ディープディッシュ」など) ではない場合、Amazon Lex はさらに数回質問をし、正しい回答を引き出そうとします。 例えば、ピザを注文するアプリケーションでは、`OrderPizza` がインテントの 1 つになります。このインテントには、`CrustType` スロットを必要かもしれません。`CrustType` スロットの作成時に `valueElicitationPrompt` フィールドを指定します。 フォールバックインテントを定義している場合、キャンセルステートメントはユーザーに送信されず、代わりにフォールバックインテントが使用されます。詳細については、[「AMAZON.FallbackIntent」](https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html)を参照してください。 型: [Statement](API_Statement.md) オブジェクト 必須: いいえ ** [checksum](#API_PutBot_RequestSyntax) ** `$LATEST` バージョンの特定のリビジョンを識別します。 新しいボットを作成する場合は、`checksum` フィールドを空白にします。チェックサムを指定した場合、`BadRequestException` の例外が発生します。 ボットを更新する場合は、`checksum` フィールドに `$LATEST` バージョンの最新リビジョンのチェックサムを設定します。` checksum` フィールドを指定しない場合や、チェックサムが `$LATEST` バージョンと一致しない場合は、`PreconditionFailedException` 例外が発生します。 タイプ: 文字列 必須: いいえ ** [childDirected](#API_PutBot_RequestSyntax) ** Amazon Lex Model·Building·Service で作成された各 Amazon Lex ボットについて、Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連しており、COPPA (Children's Online Privacy Protection Act) の対象となっているかどうかを、`childDirected` フィールドに `true` または `false` を指定する必要があります。`true` のフィールド中の `childDirected` を指定することで、Amazon Lex の使用が、全体あるいは一部が 13 歳未満の子どもに向けられた、あるいはターゲットとし、また COPPA の対象となるウェブサイト、プログラムと、関係して **いる** ことに同意します。`false` のフィールド中の `childDirected` を指定することで、Amazon Lex の使用が、全体あるいは一部が 13 歳未満の子どもに向けられた、あるいはターゲットとし、また COPPA の対象となるウェブサイト、プログラムと、関係して **いない** ことに同意します。Amazon Lex の全体または一部の使用が、13歳未満の児童を対象にしており、COPPAの対象となるウェブサイト、プログラム、またはその他のアプリケーションに関連するかどうかを正確に設定するために、`childDirected` フィールドにデフォルト値を指定することはできません。 Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連する場合は、COPPA により必要とされる検証可能な保護者の同意が必要です。13 歳未満の児童を対象とするウェブサイト、プログラム、またはその他のアプリケーションに関連する Amazon Lex の全体または一部の使用についての詳細は、[「Amazon Lex FAQ」](https://aws.amazon.com/lex/faqs#data-security)を参照してください。 型: ブール値 必須: はい ** [clarificationPrompt](#API_PutBot_RequestSyntax) ** Amazon Lex がユーザーのインテントを理解できない場合、このメッセージを使用して明確化します。Amazon Lex が明確化のプロンプトを何回繰り返すかを `maxAttempts` フィールドで指定します。それでも Amazon Lex が理解できない場合は、`abortStatement` フィールドでメッセージを送信します。 明瞭化のためのプロンプトを作成する際には、ユーザーからの正しい回答を示唆するようにしてください。例えば、ピザとドリンクを注文するボットの場合は、このような明確化のためのプロンプトを作成します。「どうなさいますか？ 「ピザを注文」または「飲み物を注文」と話してください」 フォールバックインテントを定義している場合は、`maxAttempts` フィールドで定義された回数だけ明確化のプロンプトが繰り返された場合に起動されます。詳細については、[「AMAZON.FallbackIntent」](https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html)を参照してください。 明示的なプロンプトを定義しない場合、実行時に Amazon Lex は 3 つのケースで 400 Bad Request の例外を返します。 + フォローアッププロンプト - ユーザーがフォローアッププロンプトに応答しても、インテントが提供されない場合。例えば、「今日は他に何かご希望はありますか？」というフォローアッププロンプトに応答して、ユーザーが「はい」答えた場合。Amazon Lexは、インテントを取得するためにユーザーへ送る明確なプロンプトがないため、400 Bad Request例外を返します。 + Lambda 関数 - Lambda 関数を使用する場合、`ElicitIntent` のダイアログタイプを返します。Amazon Lex には、ユーザーからインテントを取得するための明確化プロンプトがないため、400 Bad Request 例外が返されます。 + PutSession operation - `PutSession` オペレーションを使用するときは、`ElicitIntent` ダイアログタイプを送信します。Amazon Lex には、ユーザーからインテントを取得するための明確化プロンプトがないため、400 Bad Request 例外が返されます。 型: [Prompt](API_Prompt.md) オブジェクト 必須: いいえ ** [createVersion](#API_PutBot_RequestSyntax) ** `true` に設定すると、新しく採番されたバージョンのボットが作成されます。これは、`CreateBotVersion` のオペレーションを呼び出すのと同じです。`createVersion` を指定しなかった場合、デフォルトは `false` です。 型: ブール値 必須: いいえ ** [description](#API_PutBot_RequestSyntax) ** ボットの説明。 タイプ: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 必須: いいえ ** [detectSentiment](#API_PutBot_RequestSyntax) ** `true` に設定すると、ユーザーの発話はセンチメント分析のために Amazon Comprehend へ送られます。`detectSentiment` を指定しなかった場合、デフォルトは `false` です。 型: ブール値 必須: いいえ ** [enableModelImprovements](#API_PutBot_RequestSyntax) ** `true` に設定すると、自然言語理解の向上にアクセスできるようになります。 `enableModelImprovements` パラメータを `true` に設定すると、`nluIntentConfidenceThreshold` パラメータを使って信頼度スコアを設定できます。詳細については、[「Confidence Scores」](https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html)(信頼スコア) を参照してください。 `enableModelImprovements` パラメータは、特定のリージョンでしか設定できません。パラメータを `true` に設定すると、ボットは精度の向上にアクセスできるようになります。 en-US ロケールで `enableModelImprovements` パラメータを `false` に設定できるリージョンは、以下の通りです。 + 米国東部 (バージニア北部) (us-east-1) + 米国西部 (オレゴン) (us-west-2) + アジアパシフィック (シドニー) (ap-southeast-2) + 欧州 (アイルランド) (eu-west-1) 他のリージョンとロケールでは、`enableModelImprovements` パラメータはデフォルトで `true` に設定されています。これらのリージョンとロケールでは、パラメータを `false` に設定すると `ValidationException` の例外が発生します。 タイプ: ブール値 必須: いいえ ** [idleSessionTTLInSeconds](#API_PutBot_RequestSyntax) ** Amazon Lex が会話で収集したデータを保持する最大時間 (秒) です。 ユーザーインタラクションセッションは、指定された時間の間はアクティブのままです。この間に会話が発生しない場合、セッションは期限切れになり、Amazon Lex はタイムアウト前に提供されたデータをすべて削除します。 例えば、ユーザーが OrderPizza のインテントを選択したものの、注文を途中で止めてしまったとします。ユーザーは指定した時間内に注文を完了をできなかった場合、Amazon Lex は収集したスロット情報を破棄し、ユーザーは最初からやり直す必要があります。 `PutBot` オペレーションリクエストに `idleSessionTTLInSeconds` 要素を含まない場合、Amazon Lex はデフォルト値を使用します。これは、リクエストが既存のボットを置き換える場合も同様です。 デフォルトは 300 秒 (5 分) です。 型: 整数 有効範囲: 最小値 は 60 です。最大値は 86400 です。 必須: いいえ ** [intents](#API_PutBot_RequestSyntax) ** `Intent` オブジェクトの配列。各インテントは、ユーザーが表現できるコマンドを表しています。例えば、ピザを注文するボットは、OrderPizza インテントをサポートしています。詳細については、「[Amazon Lex: 仕組み](how-it-works.md)」を参照してください。 型: [Intent](API_Intent.md) オブジェクトの配列 必須: いいえ ** [locale](#API_PutBot_RequestSyntax) ** ボットのターゲットロケールを指定します。ボットで使用するインテントは、ボットのロケールと互換性がある必要があります。 デフォルトは `en-US` です。 型: 文字列 有効な値：`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` 必須: はい ** [nluIntentConfidenceThreshold](#API_PutBot_RequestSyntax) ** Amazon Lex が [PostContent](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) または [PostText](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) レスポンスで代替インテントを返す際に、`AMAZON.FallbackIntent`、`AMAZON.KendraSearchIntent`、またはその両方を挿入するしきい値を決定します。`AMAZON.FallbackIntent` および `AMAZON.KendraSearchIntent` は、ボットに設定されている場合にのみ挿入されます。 以下のリージョンで信頼性スコアを使用するには、`enableModelImprovements` パラメータを `true` に設定する必要があります。 + 米国東部 (バージニア北部) (us-east-1) + 米国西部 (オレゴン) (us-west-2) + アジアパシフィック (シドニー) (ap-southeast-2) + 欧州 (アイルランド) (eu-west-1) 他のリージョンでは、`enableModelImprovements` パラメータはデフォルトで `true` に設定されています。 例えば、信頼度の閾値が 0.80 で、`AMAZON.FallbackIntent` を設定したボットがあったとします。Amazon Lex は、以下の 3 つの代替インテントを返します：IntentA (0.70)、IntentB (0.60)、intentC (0.50)。`PostText` オペレーションからのレスポンスは次のようになります。 + AMAZON.FallbackIntent + IntentA + IntentB + IntentC 型: 倍精度浮動小数点数 有効範囲: 最小値 は 0 です。最大値は 1 です。 必須: いいえ ** [processBehavior](#API_PutBot_RequestSyntax) ** `processBehavior` 要素を `BUILD` に設定すると、Amazon Lex は実行可能なボットを構築します。要素を `SAVE` にした場合、Amazon Lex はボットを保存しますが、構築はしません。 この値を指定しない場合、デフォルト値は `BUILD` です。 型: 文字列 有効な値：`SAVE | BUILD` 必須：いいえ ** [tags](#API_PutBot_RequestSyntax) ** ボットに追加するタグのリスト。タグの追加は、ボットの作成時にのみ可能で、`PutBot` のオペレーションでボットのタグを更新することはできません。タグを更新するには、`TagResource` のオペレーションを使用します。 型: [Tag](API_Tag.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。 必須: いいえ ** [voiceId](#API_PutBot_RequestSyntax) ** Amazon Lex がユーザーとの音声対話に使用する Amazon Polly の音声ID です。音声に設定されたロケールは、ボットのロケールと一致する必要があります。Amazon Polly の詳細については、*「Amazon Polly Developer Guide」*(Amazon Polly デベロッパーガイド) の[「Voices in Amazon Polly」](https://docs.aws.amazon.com/polly/latest/dg/voicelist.html)(Amazon Polly における音声) を参照してください。 タイプ: 文字列 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "abortStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "checksum": "string", "childDirected": boolean, "clarificationPrompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "createdDate": number, "createVersion": boolean, "description": "string", "detectSentiment": boolean, "enableModelImprovements": boolean, "failureReason": "string", "idleSessionTTLInSeconds": number, "intents": [ { "intentName": "string", "intentVersion": "string" } ], "lastUpdatedDate": number, "locale": "string", "name": "string", "nluIntentConfidenceThreshold": number, "status": "string", "tags": [ { "key": "string", "value": "string" } ], "version": "string", "voiceId": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [abortStatement](#API_PutBot_ResponseSyntax) ** Amazon Lex が会話をキャンセルするために使用するメッセージ。詳細については、「[PutBot](#API_PutBot)」を参照してください。 型: [Statement](API_Statement.md) オブジェクト ** [checksum](#API_PutBot_ResponseSyntax) ** 作成したボットのチェックサム。 タイプ: 文字列 ** [childDirected](#API_PutBot_ResponseSyntax) ** Amazon Lex Model·Building·Service で作成された各 Amazon Lex ボットについて、Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連しており、COPPA (Children's Online Privacy Protection Act) の対象となっているかどうかを、`childDirected` フィールドに `true` または `false` を指定する必要があります。`true` のフィールド中の `childDirected` を指定することで、Amazon Lex の使用が、全体あるいは一部が 13 歳未満の子どもに向けられた、あるいはターゲットとし、また COPPA の対象となるウェブサイト、プログラムと、関係して **いる** ことに同意します。`false` のフィールド中の `childDirected` を指定することで、Amazon Lex の使用が、全体あるいは一部が 13 歳未満の子どもに向けられた、あるいはターゲットとし、また COPPA の対象となるウェブサイト、プログラムと、関係して **いない** ことに同意します。Amazon Lex の全体または一部の使用が、13歳未満の児童を対象にしており、COPPAの対象となるウェブサイト、プログラム、またはその他のアプリケーションに関連するかどうかを正確に設定するために、`childDirected` フィールドにデフォルト値を指定することはできません。 Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連する場合は、COPPA により必要とされる検証可能な保護者の同意が必要です。13 歳未満の児童を対象とするウェブサイト、プログラム、またはその他のアプリケーションに関連する Amazon Lex の全体または一部の使用についての詳細は、[「Amazon Lex FAQ」](https://aws.amazon.com/lex/faqs#data-security)を参照してください。 型: ブール値 ** [clarificationPrompt](#API_PutBot_ResponseSyntax) ** Amazon Lex がユーザーのインテントを理解できない場合に、使用するプロンプト。詳細については、「[PutBot](#API_PutBot)」を参照してください。 型: [Prompt](API_Prompt.md) オブジェクト ** [createdDate](#API_PutBot_ResponseSyntax) ** ボットが作成された日付。 型: タイムスタンプ ** [createVersion](#API_PutBot_ResponseSyntax) ** 新しいバージョンのボットが作成された場合の `True`。リクエストで `createVersion` フィールドが指定されていない場合は、レスポンスで `createVersion` フィールドが false に設定されます。 型: ブール値 ** [description](#API_PutBot_ResponseSyntax) ** ボットの説明。 タイプ: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 ** [detectSentiment](#API_PutBot_ResponseSyntax) ** センチメント分析のためにユーザーの発話を Amazon Comprehend に送信するようにボットが設定されている場合の `true`。リクエストで `detectSentiment` フィールドが指定されていない場合、`detectSentiment` フィールドはレスポンスでは `false` になります。 型: ブール値 ** [enableModelImprovements](#API_PutBot_ResponseSyntax) ** ボットが精度向上を使用しているかどうかを示します。`true` はボットが精度向上を使用していることを示し、それ以外は `false` となります。 型: ブール値 ** [failureReason](#API_PutBot_ResponseSyntax) ** `status` が `FAILED` の場合、Amazon Lex はボットの構築に失敗した理由を提示します。 タイプ: 文字列 ** [idleSessionTTLInSeconds](#API_PutBot_ResponseSyntax) ** Amazon Lex が会話の中で収集したデータを保持する最大時間。詳細については、「[PutBot](#API_PutBot)」を参照してください。 型: 整数 有効範囲: 最小値 は 60 です。最大値は 86400 です。 ** [intents](#API_PutBot_ResponseSyntax) ** `Intent` オブジェクトの配列。詳細については、「[PutBot](#API_PutBot)」を参照してください。 型: [Intent](API_Intent.md) オブジェクトの配列 ** [lastUpdatedDate](#API_PutBot_ResponseSyntax) ** ボットが更新された日付。リソースを作成すると、作成日と最終更新日は同じ日付になります。 型: タイムスタンプ ** [locale](#API_PutBot_ResponseSyntax) ** ボットのターゲットロケール。 型: 文字列 有効な値：`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` ** [name](#API_PutBot_ResponseSyntax) ** ボットの名前。 タイプ: 文字列 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` ** [nluIntentConfidenceThreshold](#API_PutBot_ResponseSyntax) ** Amazon Lex が [PostContent](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) または [PostText](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) レスポンスで代替インテントを返す際に、`AMAZON.FallbackIntent`、`AMAZON.KendraSearchIntent`、またはその両方を挿入する場所を決定するスコアです。`AMAZON.FallbackIntent` は、すべてのインテントの信頼性スコアがこの値を下回る場合に挿入されます。`AMAZON.KendraSearchIntent` は、ボットに設定されている場合のみ挿入されます。 型: 倍精度浮動小数点数 有効範囲: 最小値 は 0 です。最大値は 1 です。 ** [status](#API_PutBot_ResponseSyntax) ** `processBehavior` を `BUILD` に設定したボット作成リクエストを送信すると、Amazon Lexは `status` レスポンス要素を `BUILDING` に設定します。 `READY_BASIC_TESTING` の状態では、スロットタイプでボットの意図や値として設定された発話と正確に一致するユーザーの入力でボットをテストすることができます。 Amazon Lex がボットを構築できない場合、Amazon Lex は `status` を `FAILED` に設定します。Amazon Lex は、`failureReason` レスポンス要素に失敗の理由を返します。 `processBehavior` を `SAVE` に設定すると、Amazon Lex はステータスコードを `NOT BUILT` に設定します。 ボットが `READY` の状態になったら、ボットをテストして公開することができます。 型: 文字列 有効な値：`BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT` ** [tags](#API_PutBot_ResponseSyntax) ** ボットに関連付けられているタグのリスト。 型: [Tag](API_Tag.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。 ** [version](#API_PutBot_ResponseSyntax) ** ボットのバージョン。新規のボットの場合、バージョンは常に `$LATEST` です。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `\$LATEST|[0-9]+` ** [voiceId](#API_PutBot_ResponseSyntax) ** Amazon Lex がユーザーとの音声対話に使用する Amazon Polly 音声 ID。詳細については、「[PutBot](#API_PutBot)」を参照してください。 タイプ: 文字列 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** PreconditionFailedException ** 変更しようとしているリソースのチェックサムがリクエストのチェックサムと一致しません。リソースのチェックサムを確認して、もう一度お試しください。 HTTP ステータスコード: 412 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/PutBot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/PutBot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/PutBot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/PutBot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/PutBot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/PutBot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/PutBot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/PutBot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/PutBot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/PutBot) # PutBotAlias 指定されたバージョンのボットのエイリアスを作成したり、指定されたボットのエイリアスを置き換えたりします。エイリアスが示すボットのバージョンを変更するには、エイリアスを置き換えます。エイリアスの詳細については、「[バージョニングとエイリアス](versioning-aliases.md)」を参照してください。 このオペレーションには、`lex:PutBotAlias` アクションに対する許可が必要です。 ## リクエストの構文 ``` PUT /bots/botName/aliases/name HTTP/1.1 Content-type: application/json { "botVersion": "string", "checksum": "string", "conversationLogs": { "iamRoleArn": "string", "logSettings": [ { "destination": "string", "kmsKeyArn": "string", "logType": "string", "resourceArn": "string" } ] }, "description": "string", "tags": [ { "key": "string", "value": "string" } ] } ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [botName](#API_PutBotAlias_RequestSyntax) ** ボットの名前。 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [name](#API_PutBotAlias_RequestSyntax) ** エイリアスの名前。キースペース名では、大文字と小文字は区別*されません*。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [botVersion](#API_PutBotAlias_RequestSyntax) ** ボットのバージョン。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `\$LATEST|[0-9]+` 必須: はい ** [checksum](#API_PutBotAlias_RequestSyntax) ** `$LATEST` バージョンの特定のリビジョンを識別します。 新しいボットエイリアスを作成する場合は、`checksum` フィールドを空白にします。チェックサムを指定した場合、`BadRequestException` の例外が発生します。 ボットエイリアスを更新する場合は、`checksum` フィールドに `$LATEST` バージョンの最新リビジョンのチェックサムを設定します。` checksum` フィールドを指定しない場合や、チェックサムが `$LATEST` バージョンと一致しない場合は、`PreconditionFailedException` 例外が発生します。 タイプ: 文字列 必須: いいえ ** [conversationLogs](#API_PutBotAlias_RequestSyntax) ** エイリアスの会話ログの設定。 型: [ConversationLogsRequest](API_ConversationLogsRequest.md) オブジェクト 必須: いいえ ** [description](#API_PutBotAlias_RequestSyntax) ** エイリアスの説明。 型: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 必須: いいえ ** [tags](#API_PutBotAlias_RequestSyntax) ** ボットエイリアスに追加するタグのリスト。タグを追加できるのは、エイリアスを作成したときだけで、`PutBotAlias` オペレーションを使ってボットのエイリアスのタグを更新することはできません。タグを更新するには、`TagResource` のオペレーションを使用します。 型: [Tag](API_Tag.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "botName": "string", "botVersion": "string", "checksum": "string", "conversationLogs": { "iamRoleArn": "string", "logSettings": [ { "destination": "string", "kmsKeyArn": "string", "logType": "string", "resourceArn": "string", "resourcePrefix": "string" } ] }, "createdDate": number, "description": "string", "lastUpdatedDate": number, "name": "string", "tags": [ { "key": "string", "value": "string" } ] } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [botName](#API_PutBotAlias_ResponseSyntax) ** エイリアスが指すボットの名前。 タイプ: 文字列 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` ** [botVersion](#API_PutBotAlias_ResponseSyntax) ** エイリアスが指すボットのバージョン。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `\$LATEST|[0-9]+` ** [checksum](#API_PutBotAlias_ResponseSyntax) ** 現在のバージョンのエイリアスのチェックサム。 タイプ: 文字列 ** [conversationLogs](#API_PutBotAlias_ResponseSyntax) ** Amazon Lex がエイリアスの会話ログをどのように使用するかを決定する設定。 型: [ConversationLogsResponse](API_ConversationLogsResponse.md) オブジェクト ** [createdDate](#API_PutBotAlias_ResponseSyntax) ** ボットエイリアスが作成された日付。 型: タイムスタンプ ** [description](#API_PutBotAlias_ResponseSyntax) ** エイリアスの説明。 型: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 ** [lastUpdatedDate](#API_PutBotAlias_ResponseSyntax) ** ボットエイリアスが更新された日付。リソースを作成する場合、作成日と最終更新日は同じ日付になります。 型: タイムスタンプ ** [name](#API_PutBotAlias_ResponseSyntax) ** エイリアスの名前。 型: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` ** [tags](#API_PutBotAlias_ResponseSyntax) ** ボットに関連付けられているタグのリスト。 型: [Tag](API_Tag.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** PreconditionFailedException ** 変更しようとしているリソースのチェックサムがリクエストのチェックサムと一致しません。リソースのチェックサムを確認して、もう一度お試しください。 HTTP ステータスコード: 412 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/PutBotAlias) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/PutBotAlias) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/PutBotAlias) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/PutBotAlias) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/PutBotAlias) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/PutBotAlias) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/PutBotAlias) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/PutBotAlias) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/PutBotAlias) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/PutBotAlias) # PutIntent インテントを作成するか、既存のインテントを置き換えます。 ユーザーとボットのインタラクションを定義するには、1 つ以上のインテントを使用します。例えば、ピザを注文するボットの場合、`OrderPizza` のインテントを作成します。 インテントを作成するか、既存のインテントを置き換えるには、次の項目を指定する必要があります。 + インテント名。例えば、`OrderPizza`。 + サンプル発話。例えば、「ピザを注文できますか」 「ピザを注文したいです」 + 収集される情報です。ボットがユーザーから要求する情報のスロットタイプを指定します。日付や時刻などの標準的なスロットタイプと、ピザのサイズやクラストなどのカスタムスロットタイプを指定できます。 + インテントはどのように達成されるのか。Lambda 関数を提供するか、クライアントアプリケーションにインテント情報を返すようにインテントを構成します。Lambda 関数を使用した場合、すべてのインテント情報が利用可能になると、Amazon Lex は Lambda 関数を起動します。クライアントアプリケーションにインテント情報を返すようにインテントを設定した場合。 リクエストには、以下のような他のオプション情報を指定することができます。 + ユーザーにインテントを確認してもらうための確認プロンプト。例えば、「ピザを注文しましょうか」 + インテントが達成された後にユーザーに送信する結果ステートメント。例えば、「あなたのピザを注文しました」 + ユーザーに追加のアクティビティを要求するフォローアッププロンプトです。例えば、「ピザと一緒にドリンクを注文しますか」と尋ねます 既存のインテント名を指定してインテントを更新した場合、Amazon Lex は `$LATEST` バージョンのインテントの値をリクエストの値に置き換えます。Amazon Lex では、リクエストで入力されていないフィールドは削除されます。必須フィールドを指定しない場合、Amazon Lex は例外をスローします。`$LATEST` バージョンのインテントを更新すると、`$LATEST` バージョンのインテントを使用しているボットの `status` フィールドが `NOT_BUILT` に設定されます。 詳細については、「[Amazon Lex: 仕組み](how-it-works.md)」を参照してください。 このオペレーションには、`lex:PutIntent` アクションに対する許可が必要です。 ## リクエストの構文 ``` PUT /intents/name/versions/$LATEST HTTP/1.1 Content-type: application/json { "checksum": "string", "conclusionStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "confirmationPrompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "createVersion": boolean, "description": "string", "dialogCodeHook": { "messageVersion": "string", "uri": "string" }, "followUpPrompt": { "prompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "rejectionStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" } }, "fulfillmentActivity": { "codeHook": { "messageVersion": "string", "uri": "string" }, "type": "string" }, "inputContexts": [ { "name": "string" } ], "kendraConfiguration": { "kendraIndex": "string", "queryFilterString": "string", "role": "string" }, "outputContexts": [ { "name": "string", "timeToLiveInSeconds": number, "turnsToLive": number } ], "parentIntentSignature": "string", "rejectionStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "sampleUtterances": [ "string" ], "slots": [ { "defaultValueSpec": { "defaultValueList": [ { "defaultValue": "string" } ] }, "description": "string", "name": "string", "obfuscationSetting": "string", "priority": number, "responseCard": "string", "sampleUtterances": [ "string" ], "slotConstraint": "string", "slotType": "string", "slotTypeVersion": "string", "valueElicitationPrompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" } } ] } ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_PutIntent_RequestSyntax) ** インテントの名前。キースペース名では、大文字と小文字は区別*されません*。 組み込みインテントネームと一致しないか、ビルトインのインテントネームに「AMAZON」が含まれています。削除済み。例えば、`AMAZON.HelpIntent` という組み込みインテントがあるので、`HelpIntent` というカスタムインテントを作ることはできません。 組み込みインテントの一覧については、[「Alexa Skills Kit」](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents)の*「Standard Built-in Intents」*を参照してください。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [checksum](#API_PutIntent_RequestSyntax) ** `$LATEST` バージョンの特定のリビジョンを識別します。 新しいインテントを作成する場合は、`checksum` フィールドを空白にします。チェックサムを指定した場合、`BadRequestException` の例外が発生します。 インテントを更新する場合は、`checksum` フィールドに `$LATEST` バージョンの最新リビジョンのチェックサムを設定します。` checksum` フィールドを指定しない場合や、チェックサムが `$LATEST` バージョンと一致しない場合は、`PreconditionFailedException` 例外が発生します。 タイプ: 文字列 必須: いいえ ** [conclusionStatement](#API_PutIntent_RequestSyntax) ** インテントが Lambda 関数によって正常に達成された後に、Amazon Lex がユーザーに伝えるステートメントです。 この要素は、`fulfillmentActivity` で Lambda 関数を提供する場合にのみ関係します。インテントをクライアントアプリケーションに返す場合は、この要素を指定することはできません。 `followUpPrompt` および `conclusionStatement` は相互に排他的です。指定できる値は 1 つだけです。 型: [Statement](API_Statement.md) オブジェクト 必須: いいえ ** [confirmationPrompt](#API_PutIntent_RequestSyntax) ** ユーザーにインテントの確認を求めます。この質問には「はい」または「いいえ」の答えがあるはずです。 Amazon Lex は、このプロンプトを使用して、インテントがフルフィルメントの準備ができていることをユーザーが確認できるようにします。例えば、`OrderPizza` のインテントでは、注文する前に正しいかどうかを確認したいと思うかもしれません。ユーザーの質問に単純に応答するインテントなど、情報提供前のユーザー確認が必要のない場合もあります。 `rejectionStatement` と `confirmationPrompt` の両方を提供するか、両方とも提供しません。 型: [Prompt](API_Prompt.md) オブジェクト 必須: いいえ ** [createVersion](#API_PutIntent_RequestSyntax) ** `true` に設定すると、新しく採番されたバージョンのインテントが作成されます。これは、`CreateIntentVersion` のオペレーションを呼び出すのと同じです。`createVersion` を指定していない場合、デフォルトは `false` です。 型: ブール値 必須: いいえ ** [description](#API_PutIntent_RequestSyntax) ** インテントの説明。 タイプ: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 必須: いいえ ** [dialogCodeHook](#API_PutIntent_RequestSyntax) ** ユーザー入力ごとに呼び出す Lambda 関数を指定します。この Lambda 関数を呼び出して、ユーザーのインタラクションをパーソナライズすることができます。 例えば、ボットがユーザーを John と判断したとします。Lambda 関数は、バックエンドのデータベースから John の情報を取得し、いくつかの値を事前に入力しているかもしれません。例えば、John がグルテンアレルギーであることがわかった場合、対応するインテントスロット `GlutenIntolerant` を true に設定することができます。John の電話番号を見つけて、対応するセッション属性を設定することもあります。 型: [CodeHook](API_CodeHook.md) オブジェクト 必須: いいえ ** [followUpPrompt](#API_PutIntent_RequestSyntax) ** これが定義されている場合、Amazon Lex はこのプロンプトを使用して、インテントが達成された後に追加のユーザーアクティビティを要求します。例えば、`OrderPizza` のインテントが達成された後、ユーザーに飲み物の注文を促すことができます。 Amazon Lex が実行するアクションは、ユーザーのレスポンスによって以下のように異なります。 + ユーザーが 「はい」と答えると、そのボット用に設定された明確なプロンプトが表示されます。 + ユーザーが 「はい」と答えた後、インテントをトリガーする発話を続けると、そのインテントの会話が始まります。 + ユーザーが「いいえ」と答えた場合、フォローアッププロンプトに設定されている拒否ステートメントで応答します。 + 発話が認識されない場合は、フォローアッププロンプトが再び繰り返されます。 `followUpPrompt` フィールドと `conclusionStatement` フィールドは相互に独立しています。指定できる値は 1 つだけです。 型: [FollowUpPrompt](API_FollowUpPrompt.md) オブジェクト 必須: いいえ ** [fulfillmentActivity](#API_PutIntent_RequestSyntax) ** 必須。インテントがどのように達成されるのかを説明します。例えば、ユーザーがピザを注文するためのすべての情報を提供した後、`fulfillmentActivity` はボットが地元のピザ店に注文する方法を定義します。 Amazon Lex がすべてのインテント情報をクライアントアプリケーションに返すように設定したり、インテントを処理する Lambda 関数を呼び出すように指示したりすることができます (例えば、ピザ屋に注文を出すなど)。 型: [FulfillmentActivity](API_FulfillmentActivity.md) オブジェクト 必須: いいえ ** [inputContexts](#API_PutIntent_RequestSyntax) ** Amazon Lex がユーザーとの会話の中でインテントを選択するためのアクティブなコンテキストをリストアップした `InputContext` オブジェクトの配列です。 型: [InputContext](API_InputContext.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 5 項目です。 必須: いいえ ** [kendraConfiguration](#API_PutIntent_RequestSyntax) ** `AMAZON.KendraSearchIntent` インテントを使って Amazon Kendra のインデックスに接続するために必要な設定情報です。詳細については、[「AMAZON.KendraSearchIntent」](https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html)を参照してください。 型: [KendraConfiguration](API_KendraConfiguration.md) オブジェクト 必須: いいえ ** [outputContexts](#API_PutIntent_RequestSyntax) ** `OutputContext` オブジェクトの配列で、インテントが達成されたときにアクティブになるコンテキストを列挙します。 型: [OutputContext](API_OutputContext.md) オブジェクトの配列 の配列メンバー: 最小数は 0 項目です。最大数は 10 項目です。 必須: いいえ ** [parentIntentSignature](#API_PutIntent_RequestSyntax) ** このインテントの基礎となる組み込みインテントの一意の識別子です。インテントの署名を見つけるには、*「Alexa Skills Kit」*の[「Standard Built-in Intents」](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents)(標準の組み込みインテント) を参照してください。 タイプ: 文字列 必須: いいえ ** [rejectionStatement](#API_PutIntent_RequestSyntax) ** ユーザーが `confirmationPrompt` で定義された質問に「いいえ」と答えた場合、Amazon Lex は、インテントがキャンセルされたことをこのステートメントの応答で確認します。 `rejectionStatement` と `confirmationPrompt` の両方を提供するか、両方とも提供しません。 型: [Statement](API_Statement.md) オブジェクト 必須: いいえ ** [sampleUtterances](#API_PutIntent_RequestSyntax) ** インテントを知らせるためにユーザーが言うかもしれない発話 (文字列) の配列。例えば、「\$1pizzaSize\$1 ピザが欲しい」、「\$1pizzaSize\$1 のピザを \$1数量\$1 つ注文する」などです。 各発話では、スロット名が中括弧で囲まれます。 型: 文字列の配列 配列メンバー: 最小数は 0 項目です。最大数は 1500 項目です。 長さの制限：最小長 1、最大長は 200 です。 必須: いいえ ** [slots](#API_PutIntent_RequestSyntax) ** インテントスロットの配列。実行時に、Amazon Lex は、スロットで定義されているプロンプトを使用して、必要なスロット値をユーザーから引き出します。詳細については、「[Amazon Lex: 仕組み](how-it-works.md)」を参照してください。 型: [Slot](API_Slot.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 100 項目です。 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "checksum": "string", "conclusionStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "confirmationPrompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "createdDate": number, "createVersion": boolean, "description": "string", "dialogCodeHook": { "messageVersion": "string", "uri": "string" }, "followUpPrompt": { "prompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "rejectionStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" } }, "fulfillmentActivity": { "codeHook": { "messageVersion": "string", "uri": "string" }, "type": "string" }, "inputContexts": [ { "name": "string" } ], "kendraConfiguration": { "kendraIndex": "string", "queryFilterString": "string", "role": "string" }, "lastUpdatedDate": number, "name": "string", "outputContexts": [ { "name": "string", "timeToLiveInSeconds": number, "turnsToLive": number } ], "parentIntentSignature": "string", "rejectionStatement": { "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" }, "sampleUtterances": [ "string" ], "slots": [ { "defaultValueSpec": { "defaultValueList": [ { "defaultValue": "string" } ] }, "description": "string", "name": "string", "obfuscationSetting": "string", "priority": number, "responseCard": "string", "sampleUtterances": [ "string" ], "slotConstraint": "string", "slotType": "string", "slotTypeVersion": "string", "valueElicitationPrompt": { "maxAttempts": number, "messages": [ { "content": "string", "contentType": "string", "groupNumber": number } ], "responseCard": "string" } } ], "version": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [checksum](#API_PutIntent_ResponseSyntax) ** 作成または更新されたインテントの `$LATEST` バージョンのチェックサム。 タイプ: 文字列 ** [conclusionStatement](#API_PutIntent_ResponseSyntax) ** `fulfillmentActivity` のインテントで指定された Lambda 関数がインテントを達成すると、Amazon Lex はこのステートメントをユーザーに伝えます。 型: [Statement](API_Statement.md) オブジェクト ** [confirmationPrompt](#API_PutIntent_ResponseSyntax) ** これがインテントに定義されている場合、Amazon Lex インテントを達成する前に、ユーザーにインテントの確認を促します。 型: [Prompt](API_Prompt.md) オブジェクト ** [createdDate](#API_PutIntent_ResponseSyntax) ** インテントが作成された日付。 型: タイムスタンプ ** [createVersion](#API_PutIntent_ResponseSyntax) ** 新しいバージョンのインテントが作成された場合の `True`。リクエストで `createVersion` フィールドが指定されていない場合は、レスポンスで `createVersion` フィールドが false に設定されます。 型: ブール値 ** [description](#API_PutIntent_ResponseSyntax) ** インテントの説明。 タイプ: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 ** [dialogCodeHook](#API_PutIntent_ResponseSyntax) ** これがインテントに定義されている場合、Amazon Lex は各ユーザー入力に対してこの Lambda 関数を呼び出します。 型: [CodeHook](API_CodeHook.md) オブジェクト ** [followUpPrompt](#API_PutIntent_ResponseSyntax) ** これがインテントに定義されている場合、Amazon Lex はこのプロンプトを使用して、インテントが達成された後に追加のユーザーアクティビティを要求します。 型: [FollowUpPrompt](API_FollowUpPrompt.md) オブジェクト ** [fulfillmentActivity](#API_PutIntent_ResponseSyntax) ** これがインテントに定義されている場合、Amazon Lex はこの Lambda 関数を呼び出し、インテントを達成するために、インテントをユーザーがインテントに要求します。 型: [FulfillmentActivity](API_FulfillmentActivity.md) オブジェクト ** [inputContexts](#API_PutIntent_ResponseSyntax) ** Amazon Lex がユーザーとの会話の中でインテントを選択するためのアクティブなコンテキストをリストアップした `InputContext` オブジェクトの配列です。 型: [InputContext](API_InputContext.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 5 項目です。 ** [kendraConfiguration](#API_PutIntent_ResponseSyntax) ** Amazon Kendra インデックスに接続し、`AMAZON.KendraSearchIntent` インテントを使用するために必要な設定情報 (項目がある場合)。 型: [KendraConfiguration](API_KendraConfiguration.md) オブジェクト ** [lastUpdatedDate](#API_PutIntent_ResponseSyntax) ** インテントが更新された日付。リソースを作成する場合、作成日と最終更新日は同じ日付になります。 型: タイムスタンプ ** [name](#API_PutIntent_ResponseSyntax) ** インテントの名前。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` ** [outputContexts](#API_PutIntent_ResponseSyntax) ** `OutputContext` オブジェクトの配列で、インテントが達成されたときにアクティブになるコンテキストを列挙します。 型: [OutputContext](API_OutputContext.md) オブジェクトの配列 の配列メンバー: 最小数は 0 項目です。最大数は 10 項目です。 ** [parentIntentSignature](#API_PutIntent_ResponseSyntax) ** このインテントの基礎となる組み込みインテントの一意の識別子です。 タイプ: 文字列 ** [rejectionStatement](#API_PutIntent_ResponseSyntax) ** `confirmationPrompt` で定義された質問にユーザーが「いいえ」と答えた場合、Amazon Lex はこのステートメントで、インテントがキャンセルされたことを確認します。 型: [Statement](API_Statement.md) オブジェクト ** [sampleUtterances](#API_PutIntent_ResponseSyntax) ** インテント用に構成されたサンプル発話の配列。 型: 文字列の配列 配列メンバー: 最小数は 0 項目です。最大数は 1500 項目です。 長さの制限：最小長 1、最大長は 200 です。 ** [slots](#API_PutIntent_ResponseSyntax) ** インテント用に設定されたインテントスロットの配列。 型: [Slot](API_Slot.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 100 項目です。 ** [version](#API_PutIntent_ResponseSyntax) ** インテントのバージョン。新しいインテントの場合、バージョンは常に `$LATEST` です。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `\$LATEST|[0-9]+` ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** PreconditionFailedException ** 変更しようとしているリソースのチェックサムがリクエストのチェックサムと一致しません。リソースのチェックサムを確認して、もう一度お試しください。 HTTP ステータスコード: 412 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/PutIntent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/PutIntent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/PutIntent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/PutIntent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/PutIntent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/PutIntent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/PutIntent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/PutIntent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/PutIntent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/PutIntent) # PutSlotType カスタムスロットタイプを作成するか、既存のカスタムスロットタイプを置き換えます。 カスタムスロットタイプを作成するには、スロットタイプの名前と、このタイプのスロットが引き受けることができる値の列挙値のセットを指定します。詳細については、「[Amazon Lex: 仕組み](how-it-works.md)」を参照してください。 既存のスロットタイプの名前を指定した場合、リクエストのフィールドはそのスロットタイプの `$LATEST` バージョンの既存の値を置き換えます。Amazon Lex は、リクエストで指定していないフィールドを削除します。必須フィールドに値を指定しない場合、Amazon Lex は例外をスローします。`$LATEST` バージョンのスロットタイプを更新すると、ボットがそのスロットタイプを含む `$LATEST` バージョンインテントを使用している場合、ボットの `status` フィールドが `NOT_BUILT` に設定されます。 このオペレーションには、`lex:PutSlotType` アクションに対する許可が必要です。 ## リクエストの構文 ``` PUT /slottypes/name/versions/$LATEST HTTP/1.1 Content-type: application/json { "checksum": "string", "createVersion": boolean, "description": "string", "enumerationValues": [ { "synonyms": [ "string" ], "value": "string" } ], "parentSlotTypeSignature": "string", "slotTypeConfigurations": [ { "regexConfiguration": { "pattern": "string" } } ], "valueSelectionStrategy": "string" } ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [name](#API_PutSlotType_RequestSyntax) ** スロットタイプの名前。キースペース名では、大文字と小文字は区別*されません*。 組み込みインテントネームと一致しないか、組み込みのインテントネームに「AMAZON」が含まれています。削除済み。例えば、`AMAZON.DATE` というスロットタイプが組み込まれているので、`DATE` というカスタムスロットタイプを作ることはできません。 組み込みスロットタイプの一覧については、*「Alexa Skills Kit」*の[「Slot Type Reference」](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference)(スロットタイプリファレンス) を参照してください。 長さの制限：最小長 1、最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [checksum](#API_PutSlotType_RequestSyntax) ** `$LATEST` バージョンの特定のリビジョンを識別します。 新しいスロットタイプを作成する場合は、`checksum` フィールドを空白にします。チェックサムを指定した場合、`BadRequestException` の例外が発生します。 スロットタイプを更新する場合は、`checksum` フィールドに `$LATEST` バージョンの最新リビジョンのチェックサムを設定します。` checksum` フィールドを指定しない場合や、チェックサムが `$LATEST` バージョンと一致しない場合は、`PreconditionFailedException` 例外が発生します。 タイプ: 文字列 必須: いいえ ** [createVersion](#API_PutSlotType_RequestSyntax) ** `true` に設定すると、新しく採番されたバージョンのスロットタイプが作成されます。これは、`CreateSlotTypeVersion` のオペレーションを呼び出すのと同じです。`createVersion` を指定していない場合、デフォルトは `false` です。 型: ブール値 必須: いいえ ** [description](#API_PutSlotType_RequestSyntax) ** スロットタイプの説明。 タイプ: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 必須: いいえ ** [enumerationValues](#API_PutSlotType_RequestSyntax) ** スロットタイプが取得できる値を定義する `EnumerationValue` オブジェクトのリスト。各値は、機械学習モデルがスロットを解決する値を学習するための追加の値である `synonyms` のリストを持つことができます。 正規表現スロットタイプは、列挙値を必要としません。他のすべてのスロットタイプには、列挙値のリストが必要です。 Amazon Lexは、スロットの値を解決する際に、最大 5 つの可能な値を含む解決リストを生成します。Lambda 関数を使用している場合は、この解決リストが関数に渡されます。Lambda 関数を使用していない場合は、ユーザーが入力した値を返すか、解決リストの最初の値をスロット値として返すかを選択できます。`valueSelectionStrategy` フィールドには、使用するオプションが表示されます。 型: [EnumerationValue](API_EnumerationValue.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 10000 項目です。 必須: いいえ ** [parentSlotTypeSignature](#API_PutSlotType_RequestSyntax) ** スロットタイプの親として使用される組み込みスロットタイプです。親スロットタイプを定義すると、新しいスロットタイプには親と同じ設定が適応されます。 `AMAZON.AlphaNumeric` のみサポートされています。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `^((AMAZON\.)_?|[A-Za-z]_?)+` 必須: いいえ ** [slotTypeConfigurations](#API_PutSlotType_RequestSyntax) ** 親組み込みスロットタイプを拡張する構成情報。構成は、親スロットタイプの設定に追加されます。 型: [SlotTypeConfiguration](API_SlotTypeConfiguration.md) オブジェクトの配列 の配列メンバー: 最小数は 0 項目です。最大数は 10 項目です。 必須: いいえ ** [valueSelectionStrategy](#API_PutSlotType_RequestSyntax) ** Amazon Lex がスロットタイプの値を返す際に使用するスロット解決方法を決定します。フィールドの値は次のいずれかになります。 + `ORIGINAL_VALUE` - ユーザー値がスロット値と似ている場合、ユーザーが入力した値を返します。 + `TOP_RESOLUTION` - スロットの解像度リストがある場合、解像度リストの最初の値をスロットタイプの値として返します。解像度リストがない場合、null が返されます。 `valueSelectionStrategy` を指定しなかった場合、デフォルトは `ORIGINAL_VALUE` です。 型: 文字列 有効な値：`ORIGINAL_VALUE | TOP_RESOLUTION` 必須：いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "checksum": "string", "createdDate": number, "createVersion": boolean, "description": "string", "enumerationValues": [ { "synonyms": [ "string" ], "value": "string" } ], "lastUpdatedDate": number, "name": "string", "parentSlotTypeSignature": "string", "slotTypeConfigurations": [ { "regexConfiguration": { "pattern": "string" } } ], "valueSelectionStrategy": "string", "version": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [checksum](#API_PutSlotType_ResponseSyntax) ** スロットタイプの `$LATEST` バージョンのチェックサム。 タイプ: 文字列 ** [createdDate](#API_PutSlotType_ResponseSyntax) ** スロットタイプが作成された日付。 型: タイムスタンプ ** [createVersion](#API_PutSlotType_ResponseSyntax) ** 新しいバージョンのスロットタイプが作成された場合の `True`。リクエストで `createVersion` フィールドが指定されていない場合は、レスポンスで `createVersion` フィールドが false に設定されます。 型: ブール値 ** [description](#API_PutSlotType_ResponseSyntax) ** スロットタイプの説明。 タイプ: 文字列 長さの制約: 最小長は 0 です。最大長は 200 です。 ** [enumerationValues](#API_PutSlotType_ResponseSyntax) ** スロットタイプが取得できる値を定義する `EnumerationValue` オブジェクトのリスト。 型: [EnumerationValue](API_EnumerationValue.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 10000 項目です。 ** [lastUpdatedDate](#API_PutSlotType_ResponseSyntax) ** スロットタイプが更新された日付。スロットタイプを作成する場合、作成日と最終更新日は同じです。 型: タイムスタンプ ** [name](#API_PutSlotType_ResponseSyntax) ** スロットタイプの名前。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `^([A-Za-z]_?)+$` ** [parentSlotTypeSignature](#API_PutSlotType_ResponseSyntax) ** スロットタイプの親として使用される組み込みスロットタイプです。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `^((AMAZON\.)_?|[A-Za-z]_?)+` ** [slotTypeConfigurations](#API_PutSlotType_ResponseSyntax) ** 親組み込みスロットタイプを拡張する構成情報。 型: [SlotTypeConfiguration](API_SlotTypeConfiguration.md) オブジェクトの配列 の配列メンバー: 最小数は 0 項目です。最大数は 10 項目です。 ** [valueSelectionStrategy](#API_PutSlotType_ResponseSyntax) ** Amazon Lex がスロットの値を決定するために使用するスロット解決ストラテジー。詳細については、「[PutSlotType](#API_PutSlotType)」を参照してください。 型: 文字列 有効な値：`ORIGINAL_VALUE | TOP_RESOLUTION` ** [version](#API_PutSlotType_ResponseSyntax) ** スロットタイプのバージョン。新しいスロットタイプの場合、バージョンは常に `$LATEST` となります。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `\$LATEST|[0-9]+` ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** PreconditionFailedException ** 変更しようとしているリソースのチェックサムがリクエストのチェックサムと一致しません。リソースのチェックサムを確認して、もう一度お試しください。 HTTP ステータスコード: 412 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/PutSlotType) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/PutSlotType) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/PutSlotType) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/PutSlotType) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/PutSlotType) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/PutSlotType) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/PutSlotType) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/PutSlotType) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/PutSlotType) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/PutSlotType) # 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](#API_StartImport_RequestSyntax) ** 同名の既存のリソースがある場合に、`StartImport` オペレーションが取るべきアクションを指定します。 + FAIL\$1ON\$1CONFLICT - インポートファイル内のリソースと既存のリソースが競合を起こした時点で、インポート作業を停止します。競合を起こしているリソース名は、`GetImport` オペレーションへのレスポンスの `failureReason` フィールドにあります。 OVERWRITE\$1LATEST - 既存のリソースとの競合があっても、インポートオペレーションは続行されます。既存のリソースの \$1LASTEST バージョンは、インポートファイルのデータで上書きされます。 型: 文字列 有効な値：`OVERWRITE_LATEST | FAIL_ON_CONFLICT` 必須: はい ** [payload](#API_StartImport_RequestSyntax) ** バイナリ形式の zip アーカイブ。アーカイブには、インポートするリソースを含む JSON ファイルが 1 つ含まれている必要があります。リソースは、`resourceType` フィールドで指定されたタイプと一致する必要があります。 型: Base64 でエンコードされたバイナリデータオブジェクト 必須: はい ** [resourceType](#API_StartImport_RequestSyntax) ** エクスポートするリソースの種類を指定します。また、各リソースは、依存しているリソースもエクスポートします。 + ボットは、依存性を持つインテントをエクスポートします。 + インテントは、依存するスロットタイプをエクスポートします。 型: 文字列 有効な値：`BOT | INTENT | SLOT_TYPE` 必須: はい ** [tags](#API_StartImport_RequestSyntax) ** インポートされたボットに追加するタグのリスト。タグを追加できるのは、ボットをインポートするときだけです。インテントまたはスロットタイプにタグを追加することはできません。 型: [Tag](API_Tag.md) オブジェクトの配列 配列メンバー: 最小数は 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](#API_StartImport_ResponseSyntax) ** インポートジョブがリクエストされた日時のタイムスタンプ。 型: タイムスタンプ ** [importId](#API_StartImport_ResponseSyntax) ** 特定のインポートジョブの識別子。 タイプ: 文字列 ** [importStatus](#API_StartImport_ResponseSyntax) ** インポートジョブのステータス。ステータスが `FAILED` の場合は、`GetImport` オペレーションで故障の原因を知ることができます。 型: 文字列 有効な値：`IN_PROGRESS | COMPLETE | FAILED` ** [mergeStrategy](#API_StartImport_ResponseSyntax) ** マージ競合が発生した場合に実行するアクション。 型: 文字列 有効な値：`OVERWRITE_LATEST | FAIL_ON_CONFLICT` ** [name](#API_StartImport_ResponseSyntax) ** インポートジョブに付けられた名前。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `[a-zA-Z_]+` ** [resourceType](#API_StartImport_ResponseSyntax) ** インポートするリソースのタイプ。 型: 文字列 有効な値：`BOT | INTENT | SLOT_TYPE` ** [tags](#API_StartImport_ResponseSyntax) ** インポートされたボットに追加されたタグのリスト。 型: [Tag](API_Tag.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ## 以下も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/StartImport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/StartImport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/StartImport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/StartImport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/StartImport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/StartImport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/StartImport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/StartImport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/StartImport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/StartImport) # StartMigration Amazon Lex V1 から Amazon Lex V2 へのボットの移行を開始します。Amazon Lex V2 の新機能を利用する場合は、ボットを移行します。 詳細については、*「Amazon Lex developer guide」*(Amazon Lex デベロッパーガイド) の[「Migrating a bot」](https://docs.aws.amazon.com/lex/latest/dg/migrate.html)(ボットの移行) を参照してください。 ## リクエストの構文 ``` POST /migrations HTTP/1.1 Content-type: application/json { "migrationStrategy": "string", "v1BotName": "string", "v1BotVersion": "string", "v2BotName": "string", "v2BotRole": "string" } ``` ## URI リクエストパラメータ リクエストでは URI パラメータを使用しません。 ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [migrationStrategy](#API_StartMigration_RequestSyntax) ** 移行を実行するために使用された戦略。 + `CREATE_NEW` - 新しい Amazon Lex V2 ボットを作成し、Amazon Lex V1 ボットをこの新しいボットに移行します。 + `UPDATE_EXISTING` - 既存の Amazon Lex V2 ボットのメタデータおよび移行されるロケールを上書きします。Amazon Lex V2 ボットの他のロケールは変更されません。ロケールが存在しない場合は、Amazon Lex V2 ボットに新しいロケールが作成されます。 型: 文字列 有効な値：`CREATE_NEW | UPDATE_EXISTING` 必須: はい ** [v1BotName](#API_StartMigration_RequestSyntax) ** Amazon Lex V2 に移行する Amazon Lex V1 ボットの名前。 タイプ: 文字列 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` 必須: はい ** [v1BotVersion](#API_StartMigration_RequestSyntax) ** Amazon Lex V2 に移行するボットのバージョン。`$LATEST` バージョンだけでなく、任意の番号のバージョンを移行することができます。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `\$LATEST|[0-9]+` 必須: はい ** [v2BotName](#API_StartMigration_RequestSyntax) ** Amazon Lex V1 ボットの移行先となる Amazon Lex V2 ボットの名前。 + Amazon Lex V2 のボットが存在しない場合は、`CREATE_NEW` の移行戦略を使用する必要があります。 + Amazon Lex V2 ボットが存在する場合、`UPDATE_EXISTING` 移行戦略を使用して Amazon Lex V2 ボットの内容を変更する必要があります。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 100 です。 パターン: `^([0-9a-zA-Z][_-]?)+$` 必須: はい ** [v2BotRole](#API_StartMigration_RequestSyntax) ** 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](#API_StartMigration_ResponseSyntax) ** Amazon Lex が移行に割り当てた一意の識別子。 タイプ: 文字列 長さの制限: 固定長は 10 です。 パターン: `^[0-9a-zA-Z]+$` ** [migrationStrategy](#API_StartMigration_ResponseSyntax) ** 移行を実行するために使用された戦略。 型: 文字列 有効な値：`CREATE_NEW | UPDATE_EXISTING` ** [migrationTimestamp](#API_StartMigration_ResponseSyntax) ** 移行が開始された日時。 型: タイムスタンプ ** [v1BotLocale](#API_StartMigration_ResponseSyntax) ** 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](#API_StartMigration_ResponseSyntax) ** Amazon Lex V2 に移行する Amazon Lex V1 ボットの名前。 タイプ: 文字列 長さの制限: 最小長は 2 です。最大長は 50 です。 パターン: `^([A-Za-z]_?)+$` ** [v1BotVersion](#API_StartMigration_ResponseSyntax) ** Amazon Lex V2 に移行するボットのバージョン。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `\$LATEST|[0-9]+` ** [v2BotId](#API_StartMigration_ResponseSyntax) ** Amazon Lex V2 ボットの一意の識別子。 タイプ: 文字列 長さの制限: 固定長は 10 です。 パターン: `^[0-9a-zA-Z]+$` ** [v2BotRole](#API_StartMigration_ResponseSyntax) ** 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 SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/StartMigration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/StartMigration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/StartMigration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/StartMigration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/StartMigration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/StartMigration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/StartMigration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/StartMigration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/StartMigration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/StartMigration) # TagResource 指定されたタグを、指定された リソースに追加します。タグキーがすでに存在する場合、既存のタグは新しいタグに置き換えられます。 ## リクエストの構文 ``` POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": [ { "key": "string", "value": "string" } ] } ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [resourceArn](#API_TagResource_RequestSyntax) ** タグを付けるボット、ボットエイリアス、ボットチャンネルの Amazon リソースネーム (ARN)。 長さの制限：最小長 1、最大長は 1011 です。 必須: はい ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [tags](#API_TagResource_RequestSyntax) ** リソースに追加するタグキーのリスト。タグキーがすでに存在する場合、既存のタグは新しいタグに置き換えられます。 型: [Tag](API_Tag.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。 必須: はい ## レスポンスの構文 ``` HTTP/1.1 204 ``` ## レスポンス要素 アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/TagResource) # UntagResource ボット、ボットエイリアス、ボットチャンネルからタグを削除します。 ## リクエストの構文 ``` DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [resourceArn](#API_UntagResource_RequestSyntax) ** タグを削除するリソースの Amazon リソースネーム (ARN)。 長さの制限：最小長 1、最大長は 1011 です。 必須: はい ** [tagKeys](#API_UntagResource_RequestSyntax) ** リソースから削除するタグキーのリスト。タグキーがリソースに存在しない場合、タグキーは無視されます。 配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。 長さの制限：最小長 1、最大長は 128 です。 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 204 ``` ## レスポンス要素 アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。 ## エラー ** BadRequestException ** リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。 HTTP ステータスコード: 400 ** ConflictException ** リクエストの処理中に競合が発生しました。リクエストを再試行してください。 HTTP ステータスコード: 409 ** InternalFailureException ** Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。 HTTP ステータスコード: 500 ** LimitExceededException ** リクエストが制限を超えました。リクエストを再試行してください。 HTTP ステータスコード: 429 ** NotFoundException ** リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/UntagResource) # Amazon Lex Runtime Service 次のアクションは、Amazon Lex Runtime Service でサポートされています + [DeleteSession](API_runtime_DeleteSession.md) + [GetSession](API_runtime_GetSession.md) + [PostContent](API_runtime_PostContent.md) + [PostText](API_runtime_PostText.md) + [PutSession](API_runtime_PutSession.md) # DeleteSession 指定されたボット、エイリアス、ユーザー ID のセッション情報を削除します。 ## リクエストの構文 ``` DELETE /bot/botName/alias/botAlias/user/userId/session HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [botAlias](#API_runtime_DeleteSession_RequestSyntax) ** セッションデータを含むボットに使用されるエイリアス。 必須: はい ** [botName](#API_runtime_DeleteSession_RequestSyntax) ** セッションデータを含むボットの名前。 必須: はい ** [userId](#API_runtime_DeleteSession_RequestSyntax) ** セッションデータに関連付けられているユーザーの識別子。 長さの制限: 最小長は 2 です。最大長は 100 です。 パターン: `[0-9a-zA-Z._:-]+` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "botAlias": "string", "botName": "string", "sessionId": "string", "userId": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [botAlias](#API_runtime_DeleteSession_ResponseSyntax) ** セッションデータに関連付けられたボットに使用されているエイリアス。 タイプ: 文字列 ** [botName](#API_runtime_DeleteSession_ResponseSyntax) ** セッションデータに関連付けられたボットの名前。 タイプ: 文字列 ** [sessionId](#API_runtime_DeleteSession_ResponseSyntax) ** セッションの一意の識別子。 タイプ: 文字列 ** [userId](#API_runtime_DeleteSession_ResponseSyntax) ** クライアントアプリケーションユーザーの ID。 タイプ: 文字列 長さの制限: 最小長は 2 です。最大長は 100 です。 パターン: `[0-9a-zA-Z._:-]+` ## エラー ** BadRequestException ** リクエストの検証に失敗したか、コンテキストに使用可能なメッセージがないか、ボットの構築が失敗もしくは進行中であるか、または構築されていない変更が含まれています。 HTTP ステータスコード: 400 ** ConflictException ** 2 つのクライアントが同じ AWS アカウント、Amazon Lex bot、ユーザー ID を使用しています。 HTTP ステータスコード: 409 ** InternalFailureException ** 内部サービスエラー。呼び出しを再試行します。 HTTP ステータスコード: 500 ** LimitExceededException ** 制限を超えました。 HTTP ステータスコード: 429 ** NotFoundException ** 参照するリソース (Amazon Lex bot やエイリアスなど) が見つかりません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/runtime.lex-2016-11-28/DeleteSession) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex-2016-11-28/DeleteSession) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/DeleteSession) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex-2016-11-28/DeleteSession) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/DeleteSession) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex-2016-11-28/DeleteSession) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex-2016-11-28/DeleteSession) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex-2016-11-28/DeleteSession) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex-2016-11-28/DeleteSession) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/DeleteSession) # GetSession 指定されたボット、エイリアス、ユーザー ID のセッション情報を返します。 ## リクエストの構文 ``` GET /bot/botName/alias/botAlias/user/userId/session/?checkpointLabelFilter=checkpointLabelFilter HTTP/1.1 ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [botAlias](#API_runtime_GetSession_RequestSyntax) ** セッションデータを含むボットに使用されるエイリアス。 必須: はい ** [botName](#API_runtime_GetSession_RequestSyntax) ** セッションデータを含むボットの名前。 必須: はい ** [checkpointLabelFilter](#API_runtime_GetSession_RequestSyntax) ** `recentIntentSummaryView` 構造体で返されるインテントをフィルタリングするための文字列。 フィルターを指定すると、`checkpointLabel` フィールドにその文字列が設定されているインテントのみが返されます。 長さの制限：最小長 1、最大長は 255 です。 パターン: `[a-zA-Z0-9-]+` ** [userId](#API_runtime_GetSession_RequestSyntax) ** クライアントアプリケーションユーザーの ID。Amazon Lex は、ユーザーとボットとの会話を識別するために使用します。 長さの制限: 最小長は 2 です。最大長は 100 です。 パターン: `[0-9a-zA-Z._:-]+` 必須: はい ## リクエストボディ リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "activeContexts": [ { "name": "string", "parameters": { "string" : "string" }, "timeToLive": { "timeToLiveInSeconds": number, "turnsToLive": number } } ], "dialogAction": { "fulfillmentState": "string", "intentName": "string", "message": "string", "messageFormat": "string", "slots": { "string" : "string" }, "slotToElicit": "string", "type": "string" }, "recentIntentSummaryView": [ { "checkpointLabel": "string", "confirmationStatus": "string", "dialogActionType": "string", "fulfillmentState": "string", "intentName": "string", "slots": { "string" : "string" }, "slotToElicit": "string" } ], "sessionAttributes": { "string" : "string" }, "sessionId": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [activeContexts](#API_runtime_GetSession_ResponseSyntax) ** セッションのアクティブコンテキストのリスト。コンテキストは、インテントが達成されたとき、または `PostContent`、`PostText`、`PutSession` のオペレーションを呼び出したときに設定できます。 コンテキストを使用して、あるインテントをフォローできるインテントを制御したり、アプリケーションの動作を変更したりすることができます。 型: [ActiveContext](API_runtime_ActiveContext.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 20 項目です。 ** [dialogAction](#API_runtime_GetSession_ResponseSyntax) ** ボットの現在の状態を示します。 型: [DialogAction](API_runtime_DialogAction.md) オブジェクト ** [recentIntentSummaryView](#API_runtime_GetSession_ResponseSyntax) ** セッションで使用されるインテントに関する情報の配列。配列には最大 3 つのサマリーを含めることができます。セッションで 3 つ以上のインテントが使用されている場合、`recentIntentSummaryView` オペレーションには最後に使用された 3 つのインテントに関する情報が含まれています。 リクエストに `checkpointLabelFilter` パラメータを設定した場合、配列には、指定されたラベルを持つインテントのみが含まれます。 型: [IntentSummary](API_runtime_IntentSummary.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 3 項目です。 ** [sessionAttributes](#API_runtime_GetSession_ResponseSyntax) ** セッション固有のコンテキスト情報を表すキーバリューのペアのマップ。Amazon Lex とクライアントアプリケーションの間で渡されるアプリケーション情報を含みます。 型: 文字列間のマッピング ** [sessionId](#API_runtime_GetSession_ResponseSyntax) ** セッションの一意の識別子。 タイプ: 文字列 ## エラー ** BadRequestException ** リクエストの検証に失敗したか、コンテキストに使用可能なメッセージがないか、ボットの構築が失敗もしくは進行中であるか、または構築されていない変更が含まれています。 HTTP ステータスコード: 400 ** InternalFailureException ** 内部サービスエラー。呼び出しを再試行します。 HTTP ステータスコード: 500 ** LimitExceededException ** 制限を超えました。 HTTP ステータスコード: 429 ** NotFoundException ** 参照するリソース (Amazon Lex bot やエイリアスなど) が見つかりません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/runtime.lex-2016-11-28/GetSession) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex-2016-11-28/GetSession) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/GetSession) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex-2016-11-28/GetSession) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/GetSession) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex-2016-11-28/GetSession) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex-2016-11-28/GetSession) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex-2016-11-28/GetSession) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex-2016-11-28/GetSession) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/GetSession) # PostContent ユーザー入力 (テキストまたは音声) を Amazon Lex に送信します。クライアントはこの API を使用して、実行時に Amazon Lex にテキストおよびオーディオリクエストを送信します。Amazon Lex は、ボット用に構築された機械学習モデルを使用してユーザー入力を解釈します。 `PostContent` オペレーションは 8kHz と 16kHz のオーディオ入力をサポートしています。8kHz オーディオを使用すると、電話オーディオアプリケーションで高い音声認識精度を実現できます。 レスポンスとして、Amazon Lex はユーザーに伝える次のメッセージを返します。次のメッセージ例を考えます。 + 「ピザが食べたい」というユーザーの入力に対して、Amazon Lex はスロットデータを引き出すメッセージをレスポンスとして返します (例えば、`PizzaSize`): 「どのサイズのピザをご希望ですか？」 + ユーザーがピザの注文情報をすべて入力すると、Amazon Lex はユーザーに確認のメッセージ「ピザを注文しますか？」を含むレスポンスを返すかもしれません。 + ユーザーが確認のプロンプトに「はい」と答えると、Amazon Lex は結果ステートメント「ありがとうございます。チーズピザが注文されました」を返します。 すべての Amazon Lex メッセージがユーザーからの応答を必要とするわけではありません。例えば、結果ステートメントはレスポンスを必要としません。メッセージの中には、「はい」か「いいえ」のどちらかのレスポンスしか必要ないものもあります。Amazon Lex は、`message` に加えて、適切なクライアントのユーザーインターフェースを表示するなど、クライアントの動作を強化するために使用できる、レスポンス内のメッセージに関する追加のコンテキストを提供します。次の例を考えます。 + メッセージがスロットデータを引き出すものであれば、Amazon Lex は次のようなコンテキスト情報を返します。 + `x-amz-lex-dialog-state` ヘッダーが `ElicitSlot` に設定されました + 現在のコンテキストのインテント名に `x-amz-lex-intent-name` ヘッダーが設定されました + `message` が情報を取得しているスロット名に `x-amz-lex-slot-to-elicit` ヘッダーが設定されました + インテントに設定されたスロットのマップとその現在の値に `x-amz-lex-slots` ヘッダーが設定されました + メッセージが確認プロンプトの場合、`x-amz-lex-dialog-state` ヘッダは `Confirmation` に設定され、`x-amz-lex-slot-to-elicit` ヘッダは省略されます。 + メッセージが、ユーザーのインテントが理解できないことを示す、インテントに設定された明確化プロンプトである場合、`x-amz-dialog-state` ヘッダは `ElicitIntent` に設定され、`x-amz-slot-to-elicit` ヘッダは省略されます。 さらに、Amazon Lex はまた、お客様の用途に合わせた `sessionAttributes` も返します。詳細については、[「Managing Conversation Context」](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html)(会話コンテキストの管理) を参照してください。 ## リクエストの構文 ``` POST /bot/botName/alias/botAlias/user/userId/content HTTP/1.1 x-amz-lex-session-attributes: sessionAttributes x-amz-lex-request-attributes: requestAttributes Content-Type: contentType Accept: accept x-amz-lex-active-contexts: activeContexts inputStream ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [accept](#API_runtime_PostContent_RequestSyntax) ** これは、`Accept` HTTP ヘッダーの値として渡します。 Amazon Lex がレスポンスで返すメッセージは、リクエストの `Accept` HTTP ヘッダー値に基づいたテキストまたは音声のどちらかです。 + 値が `text/plain; charset=utf-8` の場合、Amazon Lex はレスポンス内にテキストを返します。 + 値が `audio/` で始まっている場合、Amazon Lex はレスポンスで音声を返します。Amazon Lex は Amazon Polly を使ってスピーチを生成します (`Accept` ヘッダーで指定した設定を使用します)。例えば、値として `audio/mpeg` を指定した場合、Amazon Lex は MPEG 形式の音声を返します。 + 値が `audio/pcm` の場合、返される音声は `audio/pcm` で、16 ット、リトルエンディアン形式です。 + 受け入れ可能な値は以下の通りです。 + audio/mpeg + audio/ogg + audio/pcm + text/plain; charset=utf-8 + audio/\$1 (デフォルトは mpeg) ** [activeContexts](#API_runtime_PostContent_RequestSyntax) ** リクエストに対してアクティブなコンテクストのリスト。コンテキストは、以前のインテントが達成されたとき、またはリクエストにコンテキストが含まれているときに有効になります。 コンテキストのリストを指定しない場合、Amazon Lex はセッションの現在のコンテキストリストを使用します。空のリストを指定すると、セッションのすべてのコンテキストがクリアされます。 ** [botAlias](#API_runtime_PostContent_RequestSyntax) ** Amazon Lex ボットのエイリアス。 必須: はい ** [botName](#API_runtime_PostContent_RequestSyntax) ** Amazon Lex ボットのエイリアス。 必須: はい ** [contentType](#API_runtime_PostContent_RequestSyntax) ** これは、`Content-Type` HTTP ヘッダーの値として渡します。 オーディオ形式またはテキストを示します。ヘッダーの値は、次のプレフィクスのいずれかで始まる必要があります。 + PCM 形式の場合、オーディオデータはリトルエンディアンのバイトオーダーでなければなりません。 + audio/l16; rate=16000; channels=1 + audio/x-l16; sample-rate=16000; channel-count=1 + audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false + Opus 形式 + audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4 + テキスト形式 + text/plain; charset=utf-8 必須: はい ** [requestAttributes](#API_runtime_PostContent_RequestSyntax) ** これは、`x-amz-lex-request-attributes` HTTP ヘッダーの値として渡します。 クライアントアプリケーションと Amazon Lex の間で受け渡しされるリクエスト固有の情報。値は、文字列のキーと値を持つ JSON シリアライズされた Base64 エンコードされたマップでなければなりません。`requestAttributes` ヘッダーと `sessionAttributes` ヘッダーの合計サイズは 12KB に制限されています。 名前空間 `x-amz-lex:` は、特別な属性のために予約されています。プレフィックス `x-amz-lex:` を持つリクエスト属性を作成しないでください。 リクエスト属性の詳細については、[「Setting Requests Attributes」](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs)(リクエスト属性の設定) を参照してください。 ** [sessionAttributes](#API_runtime_PostContent_RequestSyntax) ** これは、`x-amz-lex-session-attributes` HTTP ヘッダーの値として渡します。 Amazon Lex とクライアントアプリケーションの間で渡されるアプリケーション固有の情報。値は、文字列のキーと値を持つ JSON シリアライズされた Base64 エンコードされたマップでなければなりません。`sessionAttributes` ヘッダーと `requestAttributes` ヘッダーの合計サイズは 12KB に制限されています。 詳細については、[「Setting Session Attributes」](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs) (セッション属性の設定) を参照してください。 ** [userId](#API_runtime_PostContent_RequestSyntax) ** クライアントアプリケーションユーザーの ID。Amazon Lex は、ユーザーとボットとの会話を識別するために使用します。実行時には、各リクエストに `userID` フィールドを含める必要があります。 アプリケーションに使用するユーザー ID を決定するには、以下の点を考慮してください。 + `userID` フィールドには、ユーザーの個人識別情報 (氏名、個人識別番号、その他のエンドユーザーの個人情報など) を含めることはできません。 + ユーザーがあるデバイスで会話を始め、別のデバイスで会話を続けたい場合は、ユーザー固有の識別子を使用します。 + 同じユーザーが 2 つの異なるデバイスで別々の会話ができるようにする場合は、デバイス固有の識別子を選択します。 + ユーザーは、同じボットの 2 つの異なるバージョンと、2 つの独立した会話をすることはできません。例えば、ユーザーは同じボットの PROD バージョンとベータ版と会話することはできません。例えば、テスト中に、ユーザーが 2 つの異なるバージョンと会話する必要があることが予想される場合は、ユーザー ID にボットエイリアスを含めて、2 つの会話を区切ります。 長さの制限: 最小長は 2 です。最大長は 100 です。 パターン: `[0-9a-zA-Z._:-]+` 必須: はい ## リクエストボディ リクエストは以下のバイナリデータを受け入れます。 ** [inputStream](#API_runtime_PostContent_RequestSyntax) ** `Content-Type` HTTP ヘッダーに記述された PCM または Opus オーディオ形式またはテキスト形式のユーザー入力。 オーディオデータを Amazon Lex にストリーミングすることもできますが、送信前にすべてのオーディオデータをキャプチャするローカルバッファを作成することもできます。一般的には、オーディオデータをローカルにバッファリングするよりも、ストリーミングした方がパフォーマンスが向上します。 必須: はい ## レスポンスの構文 ``` HTTP/1.1 200 Content-Type: contentType x-amz-lex-intent-name: intentName x-amz-lex-nlu-intent-confidence: nluIntentConfidence x-amz-lex-alternative-intents: alternativeIntents x-amz-lex-slots: slots x-amz-lex-session-attributes: sessionAttributes x-amz-lex-sentiment: sentimentResponse x-amz-lex-message: message x-amz-lex-encoded-message: encodedMessage x-amz-lex-message-format: messageFormat x-amz-lex-dialog-state: dialogState x-amz-lex-slot-to-elicit: slotToElicit x-amz-lex-input-transcript: inputTranscript x-amz-lex-encoded-input-transcript: encodedInputTranscript x-amz-lex-bot-version: botVersion x-amz-lex-session-id: sessionId x-amz-lex-active-contexts: activeContexts audioStream ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 レスポンスでは、以下の HTTP ヘッダーが返されます。 ** [activeContexts](#API_runtime_PostContent_ResponseSyntax) ** セッションのアクティブコンテキストのリスト。コンテキストは、インテントが達成されたとき、または `PostContent`、`PostText`、`PutSession` のオペレーションを呼び出したときに設定できます。 コンテキストを使用して、あるインテントをフォローできるインテントを制御したり、アプリケーションの動作を変更したりすることができます。 ** [alternativeIntents](#API_runtime_PostContent_ResponseSyntax) ** ユーザーのインテントに該当する可能性のある 1～4 つの代替インテント。 各選択肢には、そのインテントがユーザーのインテントがどれだけ一致しているかを示す Amazon Lex のスコアが含まれます。インテントは信頼スコアでソートされます。 ** [botVersion](#API_runtime_PostContent_ResponseSyntax) ** 会話にレスポンスしたボットのバージョンです。この情報を使用して、あるバージョンのボットのパフォーマンスが別のバージョンよりも優れているかどうかを判断できます。 長さの制限：最小長 1、最大長 64 パターン: `[0-9]+|\$LATEST` ** [contentType](#API_runtime_PostContent_ResponseSyntax) ** リクエストの `Accept` HTTP ヘッダーで指定されたコンテンツタイプ。 ** [dialogState](#API_runtime_PostContent_ResponseSyntax) ** ユーザーインタラクションの現在の状態を示します。Amazon Lex から、`dialogState` のような以下のいずれかの値が返されます。クライアントはオプションで、この情報を使用してユーザーインターフェイスをカスタマイズできます。 + `ElicitIntent` - Amazon Lex は、ユーザーのインテントを引き出したいと考えています。次の例を考えます。 例: ユーザーがインテントを発話します (「ピザを注文します」)。Amazon Lex がこの発話からユーザーのインテントを推測できない場合、このダイアログ状態を返します。 + `ConfirmIntent` - Amazon Lex は、「はい」か「いいえ」のレスポンスを待機しています。 例えば、Amazon Lex は、インテントを達成する前にユーザーの確認を求めます。ユーザーは、「はい」または「いいえ」という単純なレスポンスではなく、追加の情報をレスポンスすることがあります。例えば、「はい、でも厚めの生地のピザにしてください」や「いいえ、飲み物を注文したいです」などです。Amazon Lex は、そのような追加情報 (この例では、クラストタイプスロットの更新や、OrderPizza から OrderDrink へのインテント変更) を処理できます。 + `ElicitSlot` - Amazon Lex は、現在のインテントのためのスロット値を待機しています。 例えば、レスポンスで Amazon Lex が「ピザのサイズを教えてください」というメッセージを送信するとします。ユーザーは、スロットの値 (例:「ミディアム」) と答えるかもしれません。また、ユーザーはレスポンスの中で追加情報を提供することもできます (例:「ミディアムサイズの厚い生地のピザ」)。Amazon Lex は、このような追加情報を適切に処理できます。 + `Fulfilled` - Lambda 関数がインテントを正常に達成したことを伝えます。 + `ReadyForFulfillment` - クライアントがリクエストを達成する必要性を伝えます。 + `Failed` - ユーザーとの会話が失敗したことを伝えます。 これは、ユーザーがサービスからのプロンプトに適切なレスポンスを提供しない場合 (Amazon Lex がユーザーに特定の情報を促す回数を設定できます) や、Lambda 関数がインテントを達成できない場合など、さまざまな理由で発生します。 有効な値：`ElicitIntent | ConfirmIntent | ElicitSlot | Fulfilled | ReadyForFulfillment | Failed` ** [encodedInputTranscript](#API_runtime_PostContent_ResponseSyntax) ** リクエストの処理に使用されるテキストです。 入力がオーディオストリームであった場合、`encodedInputTranscript` フィールドにはオーディオストリームから抽出されたテキストが入ります。これは、インテントとスロット値を認識するために実際に処理されるテキストです。この情報を使用して、Amazon Lex が送信したオーディオを正しく処理しているかどうかを判断できます。 `encodedInputTranscript` フィールドは base-64 エンコードです。値を使用する前に、フィールドをデコードする必要があります。 ** [encodedMessage](#API_runtime_PostContent_ResponseSyntax) ** ユーザーに伝えるメッセージ。メッセージは、ボットの設定または Lambda 関数から送信できます。 インテントに Lambda 関数が設定されていない場合、または Lambda 関数が応答で `dialogAction.type` として `Delegate` を返した場合、Amazon Lex は次の行動を決定し、現在のインタラクションコンテキストに基づいてボットの設定から適切なメッセージを選択します。例えば、Amazon Lex がユーザー入力を理解できない場合、明確化プロンプトメッセージを使用します。 インテントを作成するときに、グループにメッセージを割り当てることができます。メッセージがグループに割り当てられている場合、Amazon Lex は各グループから 1 つのメッセージをレスポンスに返します。メッセージフィールドは、メッセージを含むエスケープされた JSON 文字列です。返される JSON 文字列の構造の詳細については、「[サポートされているメッセージ形式](howitworks-manage-prompts.md#msg-prompts-formats)」を参照してください。 Lambda 関数がメッセージを返した場合、Amazon Lex はそれをレスポンスでクライアントに渡します。 `encodedMessage` フィールドは base-64 エンコードです。値を使用する前に、フィールドをデコードする必要があります。 長さの制限：最小長 1、最大長は 1366 です。 ** [inputTranscript](#API_runtime_PostContent_ResponseSyntax) ** *このヘッダーは廃止されました。* リクエストの処理に使用されるテキストです。 このフィールドは、de-DE、en-AU、en-GB、en-US、es-419、es-ES、es-US、fr-CA、fr-FR、および it-IT ロケールでのみ使用できます。その他すべてのロケールでは、`inputTranscript` フィールドが null です。代わりに `encodedInputTranscript` のフィールドを使用する必要があります。 入力がオーディオストリームであった場合、`inputTranscript` フィールドにはオーディオストリームから抽出されたテキストが入ります。これは、インテントとスロット値を認識するために実際に処理されるテキストです。この情報を使用して、Amazon Lex が送信したオーディオを正しく処理しているかどうかを判断できます。 ** [intentName](#API_runtime_PostContent_ResponseSyntax) ** Amazon Lex が認識している現在のユーザーのインテント。 ** [message](#API_runtime_PostContent_ResponseSyntax) ** *このヘッダーは廃止されました。* このフィールドは、de-DE、en-AU、en-GB、en-US、es-419、es-ES、es-US、fr-CA、fr-FR、および it-IT ロケールでのみ使用できます。その他すべてのロケールでは、`message` フィールドが null です。代わりに `encodedMessage` のフィールドを使用する必要があります。 ユーザーに伝えるメッセージ。メッセージは、ボットの設定または Lambda 関数から送信できます。 インテントに Lambda 関数が設定されていない場合、または Lambda 関数が応答で `dialogAction.type` として `Delegate` を返した場合、Amazon Lex は次の行動を決定し、現在のインタラクションコンテキストに基づいてボットの設定から適切なメッセージを選択します。例えば、Amazon Lex がユーザー入力を理解できない場合、明確化プロンプトメッセージを使用します。 インテントを作成するときに、グループにメッセージを割り当てることができます。メッセージがグループに割り当てられている場合、Amazon Lex は各グループから 1 つのメッセージをレスポンスに返します。メッセージフィールドは、メッセージを含むエスケープされた JSON 文字列です。返される JSON 文字列の構造の詳細については、「[サポートされているメッセージ形式](howitworks-manage-prompts.md#msg-prompts-formats)」を参照してください。 Lambda 関数がメッセージを返した場合、Amazon Lex はそれをレスポンスでクライアントに渡します。 長さの制限: 最小長は 1 です。最大長は 1,024 です。 ** [messageFormat](#API_runtime_PostContent_ResponseSyntax) ** 応答メッセージの形式。次のいずれかの値になります。 + `PlainText` - メッセージには UTF-8 形式テキストが含まれています。 + `CustomPayload` - メッセージはクライアント向けのカスタム形式です。 + `SSML` - メッセージには音声出力のテキスト形式が含まれています。 + `Composite` - メッセージには、インテントの作成時にメッセージが割り当てられたグループからの 1 つ以上のメッセージを含むエスケープされた JSON オブジェクトが含まれています。 有効な値：`PlainText | CustomPayload | SSML | Composite` ** [nluIntentConfidence](#API_runtime_PostContent_ResponseSyntax) ** 返されたインテントがユーザーのインテントに合致するものであると Amazon Lex がどれだけ確信しているかを示すスコアを提供します。スコアは 0.0～1.0 の間です。 スコアは相対的なものであり、絶対的なものではありません。スコアは、Amazon Lex の改善により変更されることがあります。 ** [sentimentResponse](#API_runtime_PostContent_ResponseSyntax) ** 発話で表現されるセンチメント。 ボットがセンチメント分析のために Amazon Comprehend に発話を送信するように設定されている場合、このフィールドには分析の結果が含まれます。 ** [sessionAttributes](#API_runtime_PostContent_ResponseSyntax) ** セッション固有のコンテキスト情報を表すキーバリューのペアのマップ。 ** [sessionId](#API_runtime_PostContent_ResponseSyntax) ** セッションの一意の識別子。 ** [slots](#API_runtime_PostContent_ResponseSyntax) ** 会話中にユーザーの入力から検出されたゼロ以上のインテントスロット (名前と値のペア) Amazon Lex のマップ。フィールドは base-64 エンコードです。 Amazon Lex は、あるスロットに対して可能性の高い値を含む解決リストを作成します。返す値は、スロットタイプの作成時や更新時に選択された `valueSelectionStrategy` によって決まります。`valueSelectionStrategy` が `ORIGINAL_VALUE` に設定されている場合、ユーザーの値がスロットの値と類似していれば、ユーザーが提供した値が返されます。`valueSelectionStrategy` が `TOP_RESOLUTION` Amazon Lex に設定されている場合は、解決リストの最初の値を返し、解決リストがない場合は null を返します。`valueSelectionStrategy` を指定しなかった場合、デフォルトは `ORIGINAL_VALUE` です。 ** [slotToElicit](#API_runtime_PostContent_ResponseSyntax) ** `dialogState` の値が `ElicitSlot` の場合、Amazon Lex が値を引き出すスロットの名前を返します。 レスポンスは、HTTP 本文として以下を返します。 ** [audioStream](#API_runtime_PostContent_ResponseSyntax) ** ユーザーに伝えるプロンプトまたはステートメントです。これは、ボットの構成とコンテキストに基づいています。例えば、Amazon Lex がユーザーのインテントを理解できなかった場合、ボット用に設定された `clarificationPrompt` を送信します。インテントがフルフィルメントアクションを達成する前に確認が必要な場合は、`confirmationPrompt` を送信します。別の例: Lambda 関数がインテントを正常に達成し、ユーザーに伝えるメッセージを送信したとします。その後、Amazon Lex はそのメッセージをレスポンスに送信します。 ## エラー ** BadGatewayException ** Amazon Lex ボットがまだ構築中であるか、依存するサービス (Amazon Polly、AWS Lambda) の 1 つが内部サービスエラーで失敗したかのどちらかです。 HTTP ステータスコード: 502 ** BadRequestException ** リクエストの検証に失敗したか、コンテキストに使用可能なメッセージがないか、ボットの構築が失敗もしくは進行中であるか、または構築されていない変更が含まれています。 HTTP ステータスコード: 400 ** ConflictException ** 2 つのクライアントが同じ AWS アカウント、Amazon Lex bot、ユーザー ID を使用しています。 HTTP ステータスコード: 409 ** DependencyFailedException ** AWS Lambda や Amazon Polly などの依存関係にあるものが、例外を発生させました。例、 + Amazon Lex が Lambda 関数を呼び出すのに十分な権限を持っていない場合。 + Lambda 関数の実行に 30 秒以上かかる場合。 + フルフィルメントの Lambda 関数が、スロットの値を削除せずに `Delegate` ダイアログアクションを返す場合。 HTTP ステータスコード: 424 ** InternalFailureException ** 内部サービスエラー。呼び出しを再試行します。 HTTP ステータスコード: 500 ** LimitExceededException ** 制限を超えました。 HTTP ステータスコード: 429 ** LoopDetectedException ** この例外は使われません。 HTTP ステータスコード: 508 ** NotAcceptableException ** リクエストの accept ヘッダーに有効な値がありません。 HTTP ステータスコード: 406 ** NotFoundException ** 参照するリソース (Amazon Lex bot やエイリアスなど) が見つかりません。 HTTP ステータスコード: 404 ** RequestTimeoutException ** 入力音声が長すぎます。 HTTP ステータスコード: 408 ** UnsupportedMediaTypeException ** Content-Typeヘッダー (`PostContent` API) の値が無効です。 HTTP ステータスコード: 415 ## 例 ### 例 1 このリクエストでは、URI がボット (Traffic)、ボットのバージョン (\$1LATEST)、エンドユーザー名 (someuser) を特定しています。`Content-Type` ヘッダーは、本文内のオーディオ形式を識別します。Amazon Lex はまた、他の形式をサポートしています。必要に応じて、オーディオをある形式から別の形式に変換するために、オープンソースソフトウェアの SoX を使用することができます。`Accept` HTTP ヘッダーを追加することで、レスポンスを得るための形式を指定します。 レスポンスでは、`x-amz-lex-message` ヘッダーがAmazon Lex が返したレスポンスを示しています。そして、クライアントはこのレスポンスをユーザーに送ることができます。同じメッセージを、(リクエストに応じて) チャンクドエンコーディングによりオーディオ/MPEG形式で送信します。 #### リクエスト例 ``` "POST /bot/Traffic/alias/$LATEST/user/someuser/content HTTP/1.1[\r][\n]" "x-amz-lex-session-attributes: eyJ1c2VyTmFtZSI6IkJvYiJ9[\r][\n]" "Content-Type: audio/x-l16; channel-count=1; sample-rate=16000f[\r][\n]" "Accept: audio/mpeg[\r][\n]" "Host: runtime.lex.us-east-1.amazonaws.com[\r][\n]" "Authorization: AWS4-HMAC-SHA256 Credential=BLANKED_OUT/20161230/us-east-1/lex/aws4_request, SignedHeaders=accept;content-type;host;x-amz-content-sha256;x-amz-date;x-amz-lex-session-attributes, Signature=78ca5b54ea3f64a17ff7522de02cd90a9acd2365b45a9ce9b96ea105bb1c7ec2[\r][\n]" "X-Amz-Date: 20161230T181426Z[\r][\n]" "X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855[\r][\n]" "Transfer-Encoding: chunked[\r][\n]" "Connection: Keep-Alive[\r][\n]" "User-Agent: Apache-HttpClient/4.5.x (Java/1.8.0_112)[\r][\n]" "Accept-Encoding: gzip,deflate[\r][\n]" "[\r][\n]" "1000[\r][\n]" "[0x7][0x0][0x7][0x0][\n]" "[0x0][0x7][0x0][0xfc][0xff][\n]" "[0x0][\n]" … ``` #### レスポンス例 ``` "HTTP/1.1 200 OK[\r][\n]" "x-amzn-RequestId: cc8b34af-cebb-11e6-a35c-55f3a992f28d[\r][\n]" "x-amz-lex-message: Sorry, can you repeat that?[\r][\n]" "x-amz-lex-dialog-state: ElicitIntent[\r][\n]" "x-amz-lex-session-attributes: eyJ1c2VyTmFtZSI6IkJvYiJ9[\r][\n]" "Content-Type: audio/mpeg[\r][\n]" "Transfer-Encoding: chunked[\r][\n]" "Date: Fri, 30 Dec 2016 18:14:28 GMT[\r][\n]" "[\r][\n]" "2000[\r][\n]" "ID3[0x4][0x0][0x0][0x0][0x0][0x0]#TSSE[0x0][0x0][0x0][0xf][0x0][0x0][0x3]Lavf57.41.100[0x0][0x0][0x0][0x0][0x0][0x0][0x0][0x0][0x0][0x0][0x0][0xff][0xf3]`[0xc4][0x0][0x1b]{[0x8d][0xe8][0x1]C[0x18][0x1][0x0]J[0xe0]`b[0xdd][0xd1][0xb][0xfd][0x11][0xdf][0xfe]";[0xbb][0xbb][0x9f][0xee][0xee][0xee][0xee]|DDD/[0xff][0xff][0xff][0xff]www?D[0xf7]w^?[0xff][0xfa]h[0x88][0x85][0xfe][0x88][0x88][0x88][[0xa2]'[0xff][0xfa]"{[0x9f][0xe8][0x88]]D[0xeb][0xbb][0xbb][0xa2]!u[0xfd][0xdd][0xdf][0x88][0x94][0x0]F[0xef][0xa1]8[0x0][0x82]w[0x88]N[0x0][0x0][0x9b][0xbb][0xe8][0xe … ``` ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/runtime.lex-2016-11-28/PostContent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex-2016-11-28/PostContent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/PostContent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex-2016-11-28/PostContent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/PostContent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex-2016-11-28/PostContent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex-2016-11-28/PostContent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex-2016-11-28/PostContent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex-2016-11-28/PostContent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/PostContent) # PostText ユーザー入力 を Amazon Lex に送信します。クライアントアプリケーションは、この API を使用して、実行時に Amazon Lex にリクエストを送信できます。そして、Amazon Lex は、ボットのために構築した機械学習モデルを使って、ユーザーの入力を解釈します。 これに対して Amazon Lex は、次の `message` を返してユーザーに任意の `responseCard` を表示するように伝えます。次のメッセージ例を考えます。 + ユーザーが「ピザが食べたい」と入力した場合、Amazon Lex はスロットデータ (例えば、PizzaSize) を引き出すメッセージをレスポンスとして返すかもしれません。「どのサイズのピザをご希望ですか？」 + ユーザーがピザの注文情報をすべて提供した後、Amazon Lex はユーザーに確認のメッセージを含むレスポンスを返すかもしれません。「ピザの注文を続けますか？」 + ユーザーが確認のプロンプトに「はい」と答えた後、Amazon Lex は結果ステートメントを返します。「ありがとうございます。チーズピザが注文されました」 すべての Amazon Lex メッセージにユーザーの反応を必要なわけではありません。例えば、結果ステートメントはレスポンスが不要です。メッセージの中には、「はい」か「いいえ」のどちらかのレスポンスしか必要ないものもあります。Amazon Lex は、`message` に加えて、レスポンス内のメッセージに関する追加のコンテキストを提供します。例えば、適切なクライアントのユーザーインターフェースを表示するなど、クライアントの動作を強化するために使用することができます。これがレスポンスの`slotToElicit`、`dialogState`、`intentName`、`slots` の各フィールドです。次の例を考えます。 + メッセージがスロットデータを引き出すものであれば、Amazon Lex は次のようなコンテキスト情報を返します。 + `dialogState` が ElicitSlot に設定されました + `intentName` が現在のコンテキストのインテント名に設定されました + `message` が情報を取得するスロット名に `slotToElicit` が設定されました + `slots` がインテントに応じて設定された既知の値を持つスロットのマップに設定されました + メッセージが確認プロンプトの場合、`dialogState` には ConfirmIntent、`SlotToElicit` には null が設定されます。 + メッセージが、ユーザーのインテントが理解されていないことを示す明確化プロンプト (インテント用に設定されている) の場合、`dialogState` は ElicitIntent に設定され、`slotToElicit` は null に設定されます。 さらに、Amazon Lex では、お客様の用途に合わせた `sessionAttributes` も返します。詳細については、[「Managing Conversation Context」](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html)(会話コンテキストの管理) を参照してください。 ## リクエストの構文 ``` POST /bot/botName/alias/botAlias/user/userId/text HTTP/1.1 Content-type: application/json { "activeContexts": [ { "name": "string", "parameters": { "string" : "string" }, "timeToLive": { "timeToLiveInSeconds": number, "turnsToLive": number } } ], "inputText": "string", "requestAttributes": { "string" : "string" }, "sessionAttributes": { "string" : "string" } } ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [botAlias](#API_runtime_PostText_RequestSyntax) ** Amazon Lex ボットのエイリアス。 必須: はい ** [botName](#API_runtime_PostText_RequestSyntax) ** Amazon Lex ボットの名前。 必須: はい ** [userId](#API_runtime_PostText_RequestSyntax) ** クライアントアプリケーションユーザーの ID。Amazon Lex は、ユーザーとボットとの会話を識別するために使用します。実行時には、各リクエストに `userID` フィールドを含める必要があります。 アプリケーションに使用するユーザー ID を決定するには、以下の点を考慮してください。 + `userID` フィールドには、ユーザーの個人識別情報 (氏名、個人識別番号、その他のエンドユーザーの個人情報など) を含めることはできません。 + ユーザーがあるデバイスで会話を始め、別のデバイスで会話を続けたい場合は、ユーザー固有の識別子を使用します。 + 同じユーザーが 2 つの異なるデバイスで別々の会話ができるようにする場合は、デバイス固有の識別子を選択します。 + ユーザーは、同じボットの 2 つの異なるバージョンと、2 つの独立した会話をすることはできません。例えば、ユーザーは同じボットの PROD バージョンとベータ版と会話することはできません。例えば、テスト中に、ユーザーが 2 つの異なるバージョンと会話する必要があることが予想される場合は、ユーザー ID にボットエイリアスを含めて、2 つの会話を区切ります。 長さの制限: 最小長は 2 です。最大長は 100 です。 パターン: `[0-9a-zA-Z._:-]+` 必須: はい ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [activeContexts](#API_runtime_PostText_RequestSyntax) ** リクエストに対してアクティブなコンテキストのリスト。コンテキストは、以前のインテントが達成されたとき、またはリクエストにコンテキストが含まれているときに有効になります。 コンテキストのリストを指定しない場合、Amazon Lex はセッションの現在のコンテキストリストを使用します。空のリストを指定すると、セッションのすべてのコンテキストがクリアされます。 型: [ActiveContext](API_runtime_ActiveContext.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 20 項目です。 必須: いいえ ** [inputText](#API_runtime_PostText_RequestSyntax) ** ユーザーが入力したテキスト (Amazon Lex はこのテキストを解釈します)。 AWS CLI を使用している場合、`--input-text` パラメータに URL を渡すことはできません。代わりに `--cli-input-json` パラメータを使って URL を渡します。 タイプ: 文字列 長さの制限: 最小長は 1 です。最大長は 1,024 です。 必須: はい ** [requestAttributes](#API_runtime_PostText_RequestSyntax) ** クライアントアプリケーションと Amazon Lex の間で受け渡しされるリクエスト固有の情報。 名前空間 `x-amz-lex:` は、特別な属性のために予約されています。プレフィックス `x-amz-lex:` を持つリクエスト属性を作成しないでください。 リクエスト属性の詳細については、[「Setting Requests Attributes」](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs)(リクエスト属性の設定) を参照してください。 型: 文字列間のマッピング 必須: いいえ ** [sessionAttributes](#API_runtime_PostText_RequestSyntax) ** Amazon Lex とクライアントアプリケーションの間で渡されるアプリケーション固有の情報。 詳細については、[「Setting Session Attributes」](https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs)(リクエスト属性の設定) を参照してください。 型: 文字列間のマッピング 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "activeContexts": [ { "name": "string", "parameters": { "string" : "string" }, "timeToLive": { "timeToLiveInSeconds": number, "turnsToLive": number } } ], "alternativeIntents": [ { "intentName": "string", "nluIntentConfidence": { "score": number }, "slots": { "string" : "string" } } ], "botVersion": "string", "dialogState": "string", "intentName": "string", "message": "string", "messageFormat": "string", "nluIntentConfidence": { "score": number }, "responseCard": { "contentType": "string", "genericAttachments": [ { "attachmentLinkUrl": "string", "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subTitle": "string", "title": "string" } ], "version": "string" }, "sentimentResponse": { "sentimentLabel": "string", "sentimentScore": "string" }, "sessionAttributes": { "string" : "string" }, "sessionId": "string", "slots": { "string" : "string" }, "slotToElicit": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [activeContexts](#API_runtime_PostText_ResponseSyntax) ** セッションのアクティブコンテキストのリスト。コンテキストは、インテントが達成されたとき、または `PostContent`、`PostText`、`PutSession` のオペレーションを呼び出したときに設定できます。 コンテキストを使用して、あるインテントをフォローできるインテントを制御したり、アプリケーションの動作を変更したりすることができます。 型: [ActiveContext](API_runtime_ActiveContext.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 20 項目です。 ** [alternativeIntents](#API_runtime_PostText_ResponseSyntax) ** ユーザーのインテントに該当する可能性のある 1～4 つの代替インテント。 各選択肢には、そのインテントがユーザーのインテントがどれだけ一致しているかを示す Amazon Lex のスコアが含まれます。インテントは信頼スコアでソートされます。 型: [PredictedIntent](API_runtime_PredictedIntent.md) オブジェクトの配列 配列メンバー: 最大数は 4 項目です。 ** [botVersion](#API_runtime_PostText_ResponseSyntax) ** 会話にレスポンスしたボットのバージョンです。この情報を使用して、あるバージョンのボットのパフォーマンスが別のバージョンよりも優れているかどうかを判断できます。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長 64 パターン: `[0-9]+|\$LATEST` ** [dialogState](#API_runtime_PostText_ResponseSyntax) ** ユーザーインタラクションの現在の状態を示します。Amazon Lex から、`dialogState` のような以下のいずれかの値が返されます。クライアントはオプションで、この情報を使用してユーザーインターフェイスをカスタマイズできます。 + `ElicitIntent` - Amazon Lex は、ユーザーのインテントを引き出したいと考えています。 例: ユーザーがインテントを発話します (「ピザを注文します」)。Amazon Lex がこの発話からユーザーインテントを推測できない場合、この DialogState を返します。 + `ConfirmIntent` - Amazon Lex は、「はい」か「いいえ」のレスポンスを待機しています。 例えば、Amazon Lex は、インテントを達成する前にユーザーの確認を求めます。 単純な「はい」または「いいえ」ではなく、ユーザーは追加情報で応答する場合があります。例えば、「はい、でも厚い生地のピザにします」や「いいえ、飲み物を注文したいです」などです。Amazon Lex は、そのような追加情報を処理することができます (この例では、crust タイプスロットを更新したり、インテントを OrderPizza から OrderDrink に変更したりします)。 + `ElicitSlot` - Amazon Lex は、現在のインテントのスロット値を待機しています。 例えば、レスポンスで Amazon Lex が「ピザのサイズを教えてください」というメッセージが送信するとします。ユーザーは、スロットの値 (例:「ミディアム」) と答えるかもしれません。また、ユーザーはレスポンスの中で追加情報を提供することもできます (例:「ミディアムサイズの厚い生地のピザ」)。Amazon Lex は、このような追加情報を適切に処理できます。 + `Fulfilled` - インテントに設定された Lambda 関数が、正常にインテントを達成したことを伝えます。 + `ReadyForFulfillment` - クライアントがインテントを達成するために必要なことを伝えます。 + `Failed` - ユーザーとの会話が失敗したことを伝えます。 これは、ユーザーがサービスからのプロンプトに適切なレスポンスを提供しない場合 (Amazon Lex がユーザーに特定の情報を促す回数を設定できます) や、Lambda 関数がインテントを達成できない場合など、さまざまな理由で発生します。 型: 文字列 有効な値：`ElicitIntent | ConfirmIntent | ElicitSlot | Fulfilled | ReadyForFulfillment | Failed` ** [intentName](#API_runtime_PostText_ResponseSyntax) ** Amazon Lex が認識している現在のユーザーインテントです。 タイプ: 文字列 ** [message](#API_runtime_PostText_ResponseSyntax) ** ユーザーに伝えるメッセージ。メッセージは、ボットの設定または Lambda 関数から送信できます。 インテントに Lambda 関数が設定されていない場合、または Lambda 関数が `dialogAction.type` のその応答として `Delegate` を返した場合、Amazon Lex は次の行動を決定し、現在のインタラクションコンテキストに基づいてボットの構成から適切なメッセージを選択します。例えば、Amazon Lex がユーザー入力を理解できない場合、明確化プロンプトメッセージを使用します。 インテントを作成するときに、グループにメッセージを割り当てることができます。メッセージがグループに割り当てられている場合、Amazon Lex は各グループから 1 つのメッセージをレスポンスに返します。メッセージフィールドは、メッセージを含むエスケープされた JSON 文字列です。返される JSON 文字列の構造の詳細については、「[サポートされているメッセージ形式](howitworks-manage-prompts.md#msg-prompts-formats)」を参照してください。 Lambda 関数がメッセージを返した場合、Amazon Lex はそれをレスポンスでクライアントに渡します。 タイプ: 文字列 長さの制限: 最小長は 1 です。最大長は 1,024 です。 ** [messageFormat](#API_runtime_PostText_ResponseSyntax) ** 応答メッセージの形式。次のいずれかの値になります。 + `PlainText` - メッセージには UTF-8 形式テキストが含まれています。 + `CustomPayload` - メッセージは Lambda 関数で定義されるカスタム形式です。 + `SSML` - メッセージには音声出力のテキスト形式が含まれています。 + `Composite` - メッセージには、インテントの作成時にメッセージが割り当てられたグループからの 1 つ以上のメッセージを含むエスケープされた JSON オブジェクトが含まれています。 型: 文字列 有効な値：`PlainText | CustomPayload | SSML | Composite` ** [nluIntentConfidence](#API_runtime_PostText_ResponseSyntax) ** 返されたインテントがユーザーのインテントに合致するものであると Amazon Lex がどれだけ確信しているかを示すスコアを提供します。スコアは 0.0～1.0 の間です。詳細については、[「Confidence Scores」](https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html)(信頼スコア) を参照してください。 スコアは相対的なものであり、絶対的なものではありません。スコアは、Amazon Lex の改善により変更されることがあります。 型: [IntentConfidence](API_runtime_IntentConfidence.md) オブジェクト ** [responseCard](#API_runtime_PostText_ResponseSyntax) ** ユーザーが現在のプロンプトに応答するためのオプションを表します。レスポンスカードは、ボットの設定 (Amazon Lex コンソールで、スロットの横にある設定ボタンを選択) からも、コードフック (Lambda 関数) からもアクセスすることができます。 型: [ResponseCard](API_runtime_ResponseCard.md) オブジェクト ** [sentimentResponse](#API_runtime_PostText_ResponseSyntax) ** ある発話で表現されたセンチメント。 ボットがセンチメント分析のために Amazon Comprehend に発話を送信するように設定されている場合、このフィールドには分析の結果が含まれます。 型: [SentimentResponse](API_runtime_SentimentResponse.md) オブジェクト ** [sessionAttributes](#API_runtime_PostText_ResponseSyntax) ** セッション固有のコンテキスト情報を表すキーバリューのペアのマップ。 型: 文字列間のマッピング ** [sessionId](#API_runtime_PostText_ResponseSyntax) ** セッションの一意の識別子。 タイプ: 文字列 ** [slots](#API_runtime_PostText_ResponseSyntax) ** 会話中のユーザーの入力内容から Amazon Lex が検出したインテントスロット。 Amazon Lex は、あるスロットに対して可能性の高い値を含む解決リストを作成します。返す値は、スロットタイプの作成時や更新時に選択された `valueSelectionStrategy` によって決まります。`valueSelectionStrategy` が `ORIGINAL_VALUE` に設定されている場合、ユーザーの値がスロットの値と類似していれば、ユーザーが提供した値が返されます。`valueSelectionStrategy` が `TOP_RESOLUTION` Amazon Lex に設定されている場合は、解決リストの最初の値を返し、解決リストがない場合は null を返します。`valueSelectionStrategy` を指定しなかった場合、デフォルトは `ORIGINAL_VALUE` です。 型: 文字列間のマッピング ** [slotToElicit](#API_runtime_PostText_ResponseSyntax) ** `dialogState` の値が `ElicitSlot` の場合、Amazon Lex が値を引き出すスロットの名前を返します。 タイプ: 文字列 ## エラー ** BadGatewayException ** Amazon Lex ボットがまだ構築中であるか、依存するサービス (Amazon Polly、AWS Lambda) の 1 つが内部サービスエラーで失敗したかのどちらかです。 HTTP ステータスコード: 502 ** BadRequestException ** リクエストの検証に失敗したか、コンテキストに使用可能なメッセージがないか、ボットの構築が失敗もしくは進行中であるか、または構築されていない変更が含まれています。 HTTP ステータスコード: 400 ** ConflictException ** 2 つのクライアントが同じ AWS アカウント、Amazon Lex bot、ユーザー ID を使用しています。 HTTP ステータスコード: 409 ** DependencyFailedException ** AWS Lambda や Amazon Polly などの依存関係にあるものが、例外を発生させました。例、 + Amazon Lex が Lambda 関数を呼び出すのに十分な権限を持っていない場合。 + Lambda 関数の実行に 30 秒以上かかる場合。 + フルフィルメントの Lambda 関数が、スロットの値を削除せずに `Delegate` ダイアログアクションを返す場合。 HTTP ステータスコード: 424 ** InternalFailureException ** 内部サービスエラー。呼び出しを再試行します。 HTTP ステータスコード: 500 ** LimitExceededException ** 制限を超えました。 HTTP ステータスコード: 429 ** LoopDetectedException ** この例外は使われません。 HTTP ステータスコード: 508 ** NotFoundException ** 参照するリソース (Amazon Lex bot やエイリアスなど) が見つかりません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/runtime.lex-2016-11-28/PostText) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex-2016-11-28/PostText) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/PostText) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex-2016-11-28/PostText) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/PostText) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex-2016-11-28/PostText) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex-2016-11-28/PostText) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex-2016-11-28/PostText) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex-2016-11-28/PostText) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/PostText) # PutSession Amazon Lex ボットで新しいセッションを作成するか、既存のセッションを変更します。このオペレーションにより、アプリケーションでボットの状態を設定できるようになります。 詳細については、「[セッションの管理](https://docs.aws.amazon.com/lex/latest/dg/how-session-api.html)」を参照してください。 ## リクエストの構文 ``` POST /bot/botName/alias/botAlias/user/userId/session HTTP/1.1 Accept: accept Content-type: application/json { "activeContexts": [ { "name": "string", "parameters": { "string" : "string" }, "timeToLive": { "timeToLiveInSeconds": number, "turnsToLive": number } } ], "dialogAction": { "fulfillmentState": "string", "intentName": "string", "message": "string", "messageFormat": "string", "slots": { "string" : "string" }, "slotToElicit": "string", "type": "string" }, "recentIntentSummaryView": [ { "checkpointLabel": "string", "confirmationStatus": "string", "dialogActionType": "string", "fulfillmentState": "string", "intentName": "string", "slots": { "string" : "string" }, "slotToElicit": "string" } ], "sessionAttributes": { "string" : "string" } } ``` ## URI リクエストパラメータ リクエストでは、次の URI パラメータを使用します。 ** [accept](#API_runtime_PutSession_RequestSyntax) ** Amazon Lex がレスポンスで返すメッセージは、このフィールドの値に応じて、テキストまたは音声ベースになります。 + 値が `text/plain; charset=utf-8` の場合、Amazon Lex はレスポンス内にテキストを返します。 + 値が `audio/` で始まっている場合、Amazon Lex はレスポンスで音声を返します。Amazon Lex は Amazon Polly を使用して、指定された構成で音声を生成します。例えば、値として `audio/mpeg` を指定した場合、Amazon Lex は MPEG 形式の音声を返します。 + 値が `audio/pcm` の場合、返される音声は `audio/pcm` で、16 ット、リトルエンディアン形式です。 + 受け入れ可能な値は以下の通りです。 + `audio/mpeg` + `audio/ogg` + `audio/pcm` + `audio/*` (デフォルトは mpeg) + `text/plain; charset=utf-8` ** [botAlias](#API_runtime_PutSession_RequestSyntax) ** セッションデータを含むボットに使用されるエイリアス。 必須: はい ** [botName](#API_runtime_PutSession_RequestSyntax) ** セッションデータを含むボットの名前。 必須: はい ** [userId](#API_runtime_PutSession_RequestSyntax) ** クライアントアプリケーションユーザーの ID。Amazon Lex は、ユーザーとボットとの会話を識別するために使用します。 長さの制限: 最小長は 2 です。最大長は 100 です。 パターン: `[0-9a-zA-Z._:-]+` 必須: はい ## リクエストボディ リクエストは以下の JSON 形式のデータを受け入れます。 ** [activeContexts](#API_runtime_PutSession_RequestSyntax) ** リクエストに対してアクティブなコンテキストのリスト。コンテキストは、以前のインテントが達成されたとき、またはリクエストにコンテキストが含まれているときに有効になります。 コンテキストのリストを指定しない場合、Amazon Lex はセッションの現在のコンテキストリストを使用します。空のリストを指定すると、セッションのすべてのコンテキストがクリアされます。 型: [ActiveContext](API_runtime_ActiveContext.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 20 項目です。 必須: いいえ ** [dialogAction](#API_runtime_PutSession_RequestSyntax) ** 会話を成立させるために、ボットが取るべき次のアクションを設定します。 型: [DialogAction](API_runtime_DialogAction.md) オブジェクト 必須: いいえ ** [recentIntentSummaryView](#API_runtime_PutSession_RequestSyntax) ** ボットの最近のインテントのサマリー。インテントサマリービューを使って、インテントにチェックポイントラベルを設定したり、インテントの属性を変更したりすることができます。また、インテントサマリーオブジェクトをリストから削除したり、追加したりするのにも使用できます。 修正したり、リストに追加するインテントは、ボットにとって意味のあるものでなければなりません。例えば、インテント名はボットが検証できるインテントでなければなりません。有効な値を指定する必要があります: + `intentName` + スロットの名前 + `slotToElict` `PutSession` リクエストで `recentIntentSummaryView` パラメータを送信した場合、新しいサマリービューの内容が古いサマリービューに置き換わることになります。例えば、`GetSession` のリクエストがサマリービューで 3 つのインテントを返し、`PutSession` をサマリービューで 1 つのインテントで呼び出した場合、次に `GetSession` を呼び出しても 1 つのインテントしか返されません。 型: [IntentSummary](API_runtime_IntentSummary.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 3 項目です。 必須: いいえ ** [sessionAttributes](#API_runtime_PutSession_RequestSyntax) ** セッション固有のコンテキスト情報を表すキーバリューのペアのマップ。Amazon Lex とクライアントアプリケーションの間で渡されるアプリケーション情報を含みます。 型: 文字列間のマッピング 必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-Type: contentType x-amz-lex-intent-name: intentName x-amz-lex-slots: slots x-amz-lex-session-attributes: sessionAttributes x-amz-lex-message: message x-amz-lex-encoded-message: encodedMessage x-amz-lex-message-format: messageFormat x-amz-lex-dialog-state: dialogState x-amz-lex-slot-to-elicit: slotToElicit x-amz-lex-session-id: sessionId x-amz-lex-active-contexts: activeContexts audioStream ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 レスポンスでは、以下の HTTP ヘッダーが返されます。 ** [activeContexts](#API_runtime_PutSession_ResponseSyntax) ** セッションのアクティブコンテキストのリスト。 ** [contentType](#API_runtime_PutSession_ResponseSyntax) ** リクエストの `Accept` HTTP ヘッダーで指定されたコンテンツタイプ。 ** [dialogState](#API_runtime_PutSession_ResponseSyntax) ** + `ConfirmIntent` - Amazon Lex は、インテントを達成する前に、インテントを確認するために「はい」か「いいえ」のレスポンスを待機しています。 + `ElicitIntent` - Amazon Lex は、ユーザーのインテントを引き出したいと考えています。 + `ElicitSlot` - Amazon Lex は、現在のインテントのためのスロット値を想定しています。 + `Failed` - ユーザーとの会話が失敗したことを伝えます。これは、ユーザーがサービスからのプロンプトに適切なレスポンスを提供しない場合 (Amazon Lex がユーザーに特定の情報を促す回数を設定できます) や、Lambda 関数がインテントを達成できない場合など、さまざまな理由で発生します。 + `Fulfilled` - Lambda 関数がインテントを正常に達成したことを伝えます。 + `ReadyForFulfillment` - クライアントがインテントを達成する必要性を伝えます。 有効な値：`ElicitIntent | ConfirmIntent | ElicitSlot | Fulfilled | ReadyForFulfillment | Failed` ** [encodedMessage](#API_runtime_PutSession_ResponseSyntax) ** ユーザーに提示する次のメッセージ。 `encodedMessage` フィールドは base-64 エンコードです。値を使用する前に、フィールドをデコードする必要があります。 長さの制限：最小長 1、最大長は 1366 です。 ** [intentName](#API_runtime_PutSession_ResponseSyntax) ** 現在のインテントの名前。 ** [message](#API_runtime_PutSession_ResponseSyntax) ** *このヘッダーは廃止されました。* ユーザーに提示する次のメッセージ。 このフィールドは、de-DE、en-AU、en-GB、en-US、es-419、es-ES、es-US、fr-CA、fr-FR、および it-IT ロケールでのみ使用できます。その他すべてのロケールでは、`message` フィールドが null です。代わりに `encodedMessage` のフィールドを使用する必要があります。 長さの制限: 最小長は 1 です。最大長は 1,024 です。 ** [messageFormat](#API_runtime_PutSession_ResponseSyntax) ** 応答メッセージの形式。次のいずれかの値になります。 + `PlainText` - メッセージには UTF-8 形式テキストが含まれています。 + `CustomPayload` - メッセージはクライアント向けのカスタム形式です。 + `SSML` - メッセージには音声出力のテキスト形式が含まれています。 + `Composite` - メッセージには、インテントの作成時にメッセージが割り当てられたグループからの 1 つ以上のメッセージを含むエスケープされた JSON オブジェクトが含まれています。 有効な値：`PlainText | CustomPayload | SSML | Composite` ** [sessionAttributes](#API_runtime_PutSession_ResponseSyntax) ** セッション固有のコンテキスト情報を表すキーバリューのペアのマップ。 ** [sessionId](#API_runtime_PutSession_ResponseSyntax) ** セッションの一意の識別子。 ** [slots](#API_runtime_PutSession_ResponseSyntax) ** 会話中にユーザーの入力から検出されたゼロ以上のインテントスロット (名前と値のペア) Amazon Lex のマップ。 Amazon Lex は、あるスロットに対して可能性の高い値を含む解決リストを作成します。返す値は、スロットタイプの作成時や更新時に選択された `valueSelectionStrategy` によって決まります。`valueSelectionStrategy` が `ORIGINAL_VALUE` に設定されている場合、ユーザーの値がスロットの値と類似していれば、ユーザーが提供した値が返されます。`valueSelectionStrategy` が `TOP_RESOLUTION` Amazon Lex に設定されている場合は、解決リストの最初の値を返し、解決リストがない場合は null を返します。`valueSelectionStrategy` を指定しない場合、デフォルトは `ORIGINAL_VALUE` です。 ** [slotToElicit](#API_runtime_PutSession_ResponseSyntax) ** `dialogState` が `ElicitSlot` の場合、Amazon Lex が値を引き出しているスロットの名前を返します。 レスポンスは、HTTP 本文として以下を返します。 ** [audioStream](#API_runtime_PutSession_ResponseSyntax) ** ユーザーに伝えるメッセージのオーディオバージョン。 ## エラー ** BadGatewayException ** Amazon Lex ボットがまだ構築中であるか、依存するサービス (Amazon Polly、AWS Lambda) の 1 つが内部サービスエラーで失敗したかのどちらかです。 HTTP ステータスコード: 502 ** BadRequestException ** リクエストの検証に失敗したか、コンテキストに使用可能なメッセージがないか、ボットの構築が失敗もしくは進行中であるか、または構築されていない変更が含まれています。 HTTP ステータスコード: 400 ** ConflictException ** 2 つのクライアントが同じ AWS アカウント、Amazon Lex bot、ユーザー ID を使用しています。 HTTP ステータスコード: 409 ** DependencyFailedException ** AWS Lambda や Amazon Polly などの依存関係にあるものが、例外を発生させました。例、 + Amazon Lex が Lambda 関数を呼び出すのに十分な権限を持っていない場合。 + Lambda 関数の実行に 30 秒以上かかる場合。 + フルフィルメントの Lambda 関数が、スロットの値を削除せずに `Delegate` ダイアログアクションを返す場合。 HTTP ステータスコード: 424 ** InternalFailureException ** 内部サービスエラー。呼び出しを再試行します。 HTTP ステータスコード: 500 ** LimitExceededException ** 制限を超えました。 HTTP ステータスコード: 429 ** NotAcceptableException ** リクエストの accept ヘッダーに有効な値がありません。 HTTP ステータスコード: 406 ** NotFoundException ** 参照するリソース (Amazon Lex bot やエイリアスなど) が見つかりません。 HTTP ステータスコード: 404 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/runtime.lex-2016-11-28/PutSession) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/runtime.lex-2016-11-28/PutSession) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/PutSession) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/runtime.lex-2016-11-28/PutSession) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/PutSession) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/runtime.lex-2016-11-28/PutSession) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/runtime.lex-2016-11-28/PutSession) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/runtime.lex-2016-11-28/PutSession) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/runtime.lex-2016-11-28/PutSession) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/PutSession)