ListHotwordLibraries API Overview - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Operation description

Get information about all hotword libraries that you created.
The API supports fuzzy search by Name, filtering by creation time range, and pagination.
By default, the results are sorted by creation time in descending order. You can set SortBy to change the sorting order.
The maximum number of entries returned for each request is 100. Default value: 10.
Use NextToken for pagination.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:ListHotwordLibraries

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results.	**73f33c91-d59383e8280b**
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Valid values: 1 to 100.	10
SortBy	string	No	The sorting order. By default, the query results are sorted by creation time in descending order.	CreationTime:Desc
Name	string	No	The name of the hotword library.	Hotword library usage name
UsageScenario	string	No	The usage scenario of the hotword library. Valid values: ASR: Automatic Speech Recognition StructuredMediaAssets: structured media analysis VideoTranslation: Video translation. This field cannot be modified after the hotword library is created.	ASR
StartTime	string	No	The beginning of the time range to query.	2020-12-26T04:11:10Z
EndTime	string	No	The end of the time range to query.	2020-12-26T04:11:10Z
MaxResults	integer	No	The maximum number of entries to return. Default value: 10. Valid values: 1 to 100.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	**9262E3DA-07FA-4862-FCBB6BC61D08***
NextToken	string	A pagination token that can be used in the next request to retrieve a new page of results. If it is empty, all results are returned.	CBB6BC61D08
MaxResults	integer	The maximum number of hotword libraries that can be returned.	10
TotalCount	integer	The total number of hotword libraries.	20
HotwordLibraryList	array<object>	The hotword libraries.
	object
Description	string	The description of the hotword library. It can be up to 200 characters in length.	Vocabulary library for celebrities
UsageScenario	string	The usage scenario of the hotword library. Valid values: ASR: Automatic Speech Recognition StructuredMediaAssets: structured media analysis VideoTranslation: Video translation This field cannot be modified after the hotword library is created.	ASR
ModifiedTime	string	The time when the hotword library was last modified.	2017-01-11T12:00:00Z
CreationTime	string	The time when the hotword library was created.	2017-01-11T12:00:00Z
HotwordLibraryId	string	The ID of the hotword library.	a93b91141c0f422fa114af203f8b****
Name	string	The name of the hotword library.	my_hotwords

Examples

Success response

JSON format

{
  "RequestId": "****9262E3DA-07FA-4862-FCBB6BC61D08*****",
  "NextToken": "CBB6BC61D08",
  "MaxResults": 10,
  "TotalCount": 20,
  "HotwordLibraryList": [
    {
      "Description": "Vocabulary library for celebrities",
      "UsageScenario": "ASR",
      "ModifiedTime": "2017-01-11T12:00:00Z\n",
      "CreationTime": "2017-01-11T12:00:00Z",
      "HotwordLibraryId": "a93b91141c0f422fa114af203f8b****",
      "Name": "my_hotwords"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.