Amazon Lex V2 を使用している場合は、代わりに Amazon Lex V2 ガイドを参照してください。
Amazon Lex V1 を使用している場合は、ボットを Amazon Lex V2 にアップグレードすることをお勧めします。V1 には新機能を追加されませんので、すべての新しいボットには V2 を使用することを強くお勧めします。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
PutBotAlias
指定されたバージョンのボットのエイリアスを作成したり、指定されたボットのエイリアスを置き換えたりします。エイリアスが示すボットのバージョンを変更するには、エイリアスを置き換えます。エイリアスの詳細については、「バージョニングとエイリアス」を参照してください。
このオペレーションには、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 パラメータを使用します。
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- botVersion
-
ボットのバージョン。
型: 文字列
長さの制限:最小長は 1 です。最大長は 64 文字です。
パターン:
\$LATEST|[0-9]+
必須:はい
- checksum
-
$LATEST
バージョンの特定のリビジョンを識別します。新しいボットエイリアスを作成する場合は、
checksum
フィールドを空白にします。チェックサムを指定した場合、BadRequestException
の例外が発生します。ボットエイリアスを更新する場合は、
checksum
フィールドに$LATEST
バージョンの最新リビジョンのチェックサムを設定します。checksum
フィールドを指定しない場合や、チェックサムが$LATEST
バージョンと一致しない場合は、PreconditionFailedException
例外が発生します。タイプ: 文字列
必須: いいえ
- conversationLogs
-
エイリアスの会話ログの設定。
型: ConversationLogsRequest オブジェクト
必須: いいえ
- description
-
エイリアスの説明。
型: 文字列
長さの制限: 最小長は 0 です。最大長は 200 です。
必須: いいえ
-
ボットエイリアスに追加するタグのリスト。タグを追加できるのは、エイリアスを作成したときだけで、
PutBotAlias
オペレーションを使ってボットのエイリアスのタグを更新することはできません。タグを更新するには、TagResource
のオペレーションを使用します。型: Tag オブジェクトの配列
配列メンバー: 最小数は 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
-
エイリアスが指すボットの名前。
型: 文字列
長さの制限: 最小長は 2 です。最大長は 50 です。
Pattern:
^([A-Za-z]_?)+$
- botVersion
-
エイリアスが指すボットのバージョン。
型: 文字列
長さの制限:最小長は 1 です。最大長は 64 文字です。
パターン:
\$LATEST|[0-9]+
- checksum
-
現在のバージョンのエイリアスのチェックサム。
型: 文字列
- conversationLogs
-
Amazon Lex がエイリアスの会話ログをどのように使用するかを決定する設定。
型: ConversationLogsResponse オブジェクト
- createdDate
-
ボットエイリアスが作成された日付。
型: タイムスタンプ
- description
-
エイリアスの説明。
型: 文字列
長さの制限: 最小長は 0 です。最大長は 200 です。
- lastUpdatedDate
-
ボットエイリアスが更新された日付。リソースを作成する場合、作成日と最終更新日は同じ日付になります。
型: タイムスタンプ
- name
-
エイリアスの名前。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 100 です。
パターン:
^([A-Za-z]_?)+$
-
ボットに関連付けられているタグのリスト。
型: Tag オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。
エラー
- BadRequestException
-
リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。
HTTP ステータスコード:400
- ConflictException
-
リクエストの処理中に競合が発生しました。リクエストを再試行してください。
HTTP ステータスコード: 409
- InternalFailureException
-
Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。
HTTP ステータスコード:500
- LimitExceededException
-
リクエストが制限を超えました。リクエストを再試行してください。
HTTP ステータスコード: 429
- PreconditionFailedException
-
変更しようとしているリソースのチェックサムがリクエストのチェックサムと一致しません。リソースのチェックサムを確認して、もう一度お試しください。
HTTP ステータスコード: 412
その他の参照資料
言語固有の AWS SDK でこの API を使用する方法の詳細については、以下を参照してください。