Amazon Lex V2 を使用している場合は、代わりに Amazon Lex V2 ガイドを参照してください。
Amazon Lex V1 を使用している場合は、ボットを Amazon Lex V2 にアップグレードすることをお勧めします。V1 には新機能を追加されませんので、すべての新しいボットには V2 を使用することを強くお勧めします。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
GetBots
以下のようにボット情報を返します。
-
nameContainsフィールドを指定すると、名前に指定した文字列が含まれるすべてのボットの$LATESTバージョンの情報が応答に含まれます。 -
nameContainsフィールドを指定しなかった場合、このオペレーションでは、すべてのボットの$LATESTバージョンの情報が返されます。
このオペレーションには lex:GetBots アクションに対するアクセス許可が必要です。
リクエストの構文
GET /bots/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- maxResults
-
リクエストが返すレスポンスに含まれるボットの最大数。デフォルトは 10 です。
有効範囲: 最小値 は 1 です。最大値は 50 です。
- nameContains
-
ボット名にマッチする部分文字列。ボットの名前の一部が部分文字列と一致する場合、ボットが返されます。例えば、「xyz」は「xyzabc」と「abcxyz」の両方に一致します。
長さの制限: 最小長は 2 です。最大長は 50 です。
Pattern:
^([A-Za-z]_?)+$ - nextToken
-
ボットの次のページを取得するページ割りトークン。この呼び出しに対する応答が切り捨てられた場合、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
-
botMetadataオブジェクトの配列で、各ボットに 1 つのエントリがあります。型: BotMetadata オブジェクトの配列
- nextToken
-
レスポンスが切り捨てられる場合、次のリクエストでボットの次のページを取得するためのページ割りトークンが含まれます。
型: 文字列
エラー
- BadRequestException
-
リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。
HTTP ステータスコード：400
- InternalFailureException
-
Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。
HTTP ステータスコード：500
- LimitExceededException
-
リクエストが制限を超えました。リクエストを再試行してください。
HTTP ステータスコード: 429
- NotFoundException
-
リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。
HTTP ステータスコード: 404
その他の参照資料
言語固有の AWS SDK でこの API を使用する方法の詳細については、以下を参照してください。
