本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
ListVocabularies
提供符合指定準則的自訂詞彙清單。如果未指定準,則會傳回所有自訂詞彙。
若要取得有關特定自訂字彙的詳細資訊,請使用該GetVocabulary作業。
請求語法
{
"MaxResults": number
,
"NameContains": "string
",
"NextToken": "string
",
"StateEquals": "string
"
}
請求參數
如需所有動作共用參數的相關資訊,請參閱一般參數。
請求接受採用 JSON 格式的下列資料。
- MaxResults
-
每頁結果中要傳回的自訂詞彙數目上限。如果結果少於您指定的值,則只會傳回實際結果。如果您未指定值,則會使用預設值為 5。
類型:整數
有效範圍:最小值為 1。最大值為 100。
必要:否
- NameContains
-
僅傳回包含指定字串的自訂字彙。搜尋不區分大小寫。
類型:String
長度限制:長度下限為 1。長度上限為 200。
模式:
^[0-9a-zA-Z._-]+
必要:否
- NextToken
-
如果您的
ListVocabularies
請求返回的結果超過了可以顯示的數量,NextToken
則會在響應中顯示一個關聯的字符串。要獲取結果的下一頁,請複製此字符串並重複您的請求,NextToken
包括複製的字符串的值。視需要重複此步驟以檢視所有結果。類型:String
長限制:上限為 8192。
模式:
.+
必要:否
- StateEquals
-
僅傳回具有指定狀態的自訂字彙。詞彙按創建日期排序,最新的詞彙優先。如果不包括
StateEquals
,則退還所有自定義醫學詞彙。類型:String
有效值:
PENDING | READY | FAILED
必要:否
回應語法
{
"NextToken": "string",
"Status": "string",
"Vocabularies": [
{
"LanguageCode": "string",
"LastModifiedTime": number,
"VocabularyName": "string",
"VocabularyState": "string"
}
]
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- NextToken
-
如
NextToken
果您的回應中存在,則表示並非顯示所有結果。若要檢視下一組結果,請在結果輸出中複製與NextToken
參數相關聯的字串,然後再次執行要求,包括NextToken
複製字串的值。視需要重複此步驟以檢視所有結果。類型:String
長限制:上限為 8192。
模式:
.+
- Status
-
列出所有具有在請求中指定狀態的自訂字彙。詞彙按創建日期排序,最新的詞彙優先。
類型:String
有效值:
PENDING | READY | FAILED
- Vocabularies
-
提供與您要求中指定條件相符之自訂字彙的相關資訊。
類型:VocabularyInfo 物件陣列
錯誤
如需所有動作常見的錯誤相關資訊,請參閱常見錯誤。
- BadRequestException
-
您的要求未通過一或多個驗證測試。當您嘗試刪除的實體不存在或處於非終端狀態(例如
IN PROGRESS
)時,可能會發生這種情況。如需詳資訊,請參閱例外訊息欄位。HTTP 狀態碼:400
- InternalFailureException
-
發生內部錯誤。檢查錯誤訊息,更正問題,然後再試一次您的要求。
HTTP 狀態碼:500
- LimitExceededException
-
您可能傳送太多要求,或輸入檔案太長。請先等候再重試要求,或使用較小的檔案再試一次。
HTTP 狀態碼:400
另請參閱
如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: