Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: CC-BY-SA-4.0

An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.

{
   "[Resource](#SageMaker-GetSearchSuggestions-request-Resource)": "string",
   "[SuggestionQuery](#SageMaker-GetSearchSuggestions-request-SuggestionQuery)": { 
      "[PropertyNameQuery](API_SuggestionQuery.md#SageMaker-Type-SuggestionQuery-PropertyNameQuery)": { 
         "[PropertyNameHint](API_PropertyNameQuery.md#SageMaker-Type-PropertyNameQuery-PropertyNameHint)": "string"
      }
   }
}

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 Amazon SageMaker resource to Search for. The only valid Resource value is TrainingJob.
Type: String
Valid Values:TrainingJob
Required: Yes

** SuggestionQuery ** Limits the property names that are included in the response.
Type: SuggestionQuery object
Required: No

{
   "[PropertyNameSuggestions](#SageMaker-GetSearchSuggestions-response-PropertyNameSuggestions)": [ 
      { 
         "[PropertyName](API_PropertyNameSuggestion.md#SageMaker-Type-PropertyNameSuggestion-PropertyName)": "string"
      }
   ]
}

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 Resource that match a SuggestionQuery.
Type: Array of PropertyNameSuggestion objects

For information about the errors that are common to all actions, see Common Errors.

For more information about using this API in one of the language-specific AWS SDKs, see the following: + AWS Command Line Interface + AWS SDK for .NET + AWS SDK for C++ + AWS SDK for Go + AWS SDK for Go - Pilot + AWS SDK for Java + AWS SDK for JavaScript + AWS SDK for PHP V3 + AWS SDK for Python + AWS SDK for Ruby V2