Amazon Lex V2 を使用している場合は、代わりに Amazon Lex V2 ガイドを参照してください。
Amazon Lex V1 を使用している場合は、ボットを Amazon Lex V2 にアップグレードすることをお勧めします。V1 には新機能を追加されませんので、すべての新しいボットには V2 を使用することを強くお勧めします。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
GetBotChannelAssociation
Amazon Lex ボットとメッセージングプラットフォームの間の関連付けに関する情報を返します。
このオペレーションには、lex:GetBotChannelAssociation
アクションに対する許可が必要です。
リクエストの構文
GET /bots/botName
/aliases/aliasName
/channels/name
HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- aliasName
-
この関連付けが作成されている Amazon Lex ボットの特定のバージョンを指すエイリアス。
長さの制限:最小長は 1 です。最大長は 100 です。
パターン:
^([A-Za-z]_?)+$
必須:はい
- botName
-
Amazon Lex ボットの名前。
長さの制限: 最小長は 2 です。最大長は 50 です。
Pattern:
^([A-Za-z]_?)+$
必須:はい
- name
-
ボットとチャンネル間の関連付けの名前。名前は、大文字と小文字が区別されます。
長さの制限:最小長は 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
-
この関連付けが作成されている Amazon Lex ボットの特定のバージョンを指すエイリアス。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 100 です。
パターン:
^([A-Za-z]_?)+$
- botConfiguration
-
メッセージングプラットフォームが Amazon Lex ボットと通信するために必要な情報を提供します。
型: 文字列間のマッピング
マップエントリ: 10 の項目の最大数。
- botName
-
Amazon Lex ボットの名前。
型: 文字列
長さの制限: 最小長は 2 です。最大長は 50 です。
Pattern:
^([A-Za-z]_?)+$
- createdDate
-
ボットとチャンネルの関連付けが作成された日付。
型: タイムスタンプ
- description
-
ボットとチャンネル間の関連付けの説明。
型: 文字列
長さの制限: 最小長は 0 です。最大長は 200 です。
- failureReason
-
status
がFAILED
の場合、Amazon Lex は関連性の作成に失敗した理由を提示します。型: 文字列
- name
-
ボットとチャンネル間の関連付けの名前。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 100 です。
パターン:
^([A-Za-z]_?)+$
- status
-
ボットチャンネルのステータス。
-
CREATED
- チャンネルが作成され、使用可能な状態です。 -
IN_PROGRESS
- チャンネルの作成中。 -
FAILED
- チャンネルの作成中にエラーが発生しました。失敗の原因については、「failureReason
」フィールドを参照してください。
型: 文字列
有効な値:
IN_PROGRESS | CREATED | FAILED
-
- type
-
メッセージングプラットフォームのタイプ。
型: 文字列
有効な値:
Facebook | Slack | Twilio-Sms | Kik
エラー
- BadRequestException
-
リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。
HTTP ステータスコード:400
- InternalFailureException
-
Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。
HTTP ステータスコード:500
- LimitExceededException
-
リクエストが制限を超えました。リクエストを再試行してください。
HTTP ステータスコード: 429
- NotFoundException
-
リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。
HTTP ステータスコード: 404
その他の参照資料
言語固有の AWS SDK でこの API を使用する方法の詳細については、以下を参照してください。