指定された条件に基づいて、すべてのホットワードライブラリの情報を取得します。
操作説明
操作の説明
この操作は、ユーザーによって作成されたすべてのホットワードライブラリのリストを照会します。
Name パラメーターを使用してあいまい検索できます。ページネーションと時間範囲のフィルタリングがサポートされています。
デフォルトでは、結果は作成時刻の降順でソートされます。SortBy パラメーターを使用してソート方法を調整できます。
リクエストごとに返されるレコードの最大数は 100 です。デフォルト値は 10 です。
NextToken パラメーターを使用して、データをページ単位で読み取れます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ice:ListHotwordLibraries |
list |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| NextToken |
string |
任意 |
読み取りを開始する位置。 |
****73f33c91-d59383e8280b**** |
| PageNo |
integer |
任意 |
ページ番号。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。 |
10 |
| SortBy |
string |
任意 |
ソートパラメーター。デフォルトでは、結果は作成時刻の降順でソートされます。 |
CreationTime:Desc |
| Name |
string |
任意 |
ホットワードライブラリの名前。 |
Hotword library name |
| UsageScenario |
string |
任意 |
ホットワードライブラリのシナリオ。有効な値:
|
ASR |
| StartTime |
string |
任意 |
フィルタリングの開始時刻。時刻は ISO 8601 フォーマットで、協定世界時 (UTC) (Z で終わる) を使用します。 |
2020-12-26T04:11:10Z |
| EndTime |
string |
任意 |
フィルタリングの終了時刻。時刻は ISO 8601 フォーマットで、協定世界時 (UTC) (Z で終わる) を使用します。 |
2020-12-26T04:11:10Z |
| MaxResults |
integer |
任意 |
現在のリクエストに対して返されるレコードの最大数。 最大値: 100。デフォルト値: 10。 |
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンススキーマ。 |
||
| RequestId |
string |
リクエスト ID。 |
****9262E3DA-07FA-4862-FCBB6BC61D08***** |
| NextToken |
string |
現在の呼び出しで読み取りを行った位置。空の値は、すべてのデータの読み取りが完了したことを示します。 |
CBB6BC61D08 |
| MaxResults |
integer |
返されるホットワードライブラリ情報レコードの最大数。 |
10 |
| TotalCount |
integer |
ホットワードライブラリの総数。 |
20 |
| HotwordLibraryList |
array<object> |
ホットワードライブラリのリスト。 |
|
|
object |
|||
| Description |
string |
説明。最大長は 200 文字です。 |
Hotword library for celebrities |
| UsageScenario |
string |
ホットワードライブラリのシナリオ。有効な値:
|
ASR |
| ModifiedTime |
string |
変更時刻。時刻は ISO 8601 フォーマットで、協定世界時 (UTC) (Z で終わる) を使用します。 |
2017-01-11T12:00:00Z |
| CreationTime |
string |
作成時刻。時刻は ISO 8601 フォーマットで、協定世界時 (UTC) (Z で終わる) を使用します。 |
2017-01-11T12:00:00Z |
| HotwordLibraryId |
string |
ホットワードライブラリの ID。 |
a93b91141c0f422fa114af203f8b**** |
| Name |
string |
ホットワードライブラリの名前。 |
my_hotwords |
例
成功レスポンス
JSONJSON
{
"RequestId": "****9262E3DA-07FA-4862-FCBB6BC61D08*****",
"NextToken": "CBB6BC61D08",
"MaxResults": 10,
"TotalCount": 20,
"HotwordLibraryList": [
{
"Description": "Lexicon containing celebrity names",
"UsageScenario": "ASR",
"ModifiedTime": "2017-01-11T12:00:00Z\n",
"CreationTime": "2017-01-11T12:00:00Z",
"HotwordLibraryId": "a93b91141c0f422fa114af203f8b****",
"Name": "my_hotwords"
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。