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