ListModelMetadata
Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.
Request Syntax
{
"MaxResults": number,
"NextToken": "string",
"SearchExpression": {
"Filters": [
{
"Name": "string",
"Value": "string"
}
]
}
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
The maximum number of models to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
If the response to a previous
ListModelMetadataResponserequest was truncated, the response includes a NextToken. To retrieve the next set of model metadata, use the token in the next request.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*Required: No
- SearchExpression
-
One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive.
Type: ModelMetadataSearchExpression object
Required: No
Response Syntax
{
"ModelMetadataSummaries": [
{
"Domain": "string",
"Framework": "string",
"FrameworkVersion": "string",
"Model": "string",
"Task": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ModelMetadataSummaries
-
A structure that holds model metadata.
Type: Array of ModelMetadataSummary objects
- NextToken
-
A token for getting the next set of recommendations, if there are any.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
