GetSearchSuggestions
An auto-complete API for the search functionality in the SageMaker console. It returns
suggestions of possible matches for the property name to use in Search
queries. Provides suggestions for HyperParameters, Tags, and
Metrics.
Request Syntax
{
"Resource": "string",
"SuggestionQuery": {
"PropertyNameQuery": {
"PropertyNameHint": "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.
- Resource
-
The name of the SageMaker resource to search for.
Type: String
Valid Values:
TrainingJob | Experiment | ExperimentTrial | ExperimentTrialComponent | Endpoint | Model | ModelPackage | ModelPackageGroup | Pipeline | PipelineExecution | FeatureGroup | FeatureMetadata | Image | ImageVersion | Project | HyperParameterTuningJob | ModelCardRequired: Yes
- SuggestionQuery
-
Limits the property names that are included in the response.
Type: SuggestionQuery object
Required: No
Response Syntax
{
"PropertyNameSuggestions": [
{
"PropertyName": "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.
- PropertyNameSuggestions
-
A list of property names for a
Resourcethat match aSuggestionQuery.Type: Array of PropertyNameSuggestion objects
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:
