Skip to content

Get Search Suggestions

sagemaker_get_search_suggestions R Documentation

An auto-complete API for the search functionality in the SageMaker console

Description

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.

Usage

sagemaker_get_search_suggestions(Resource, SuggestionQuery)

Arguments

Resource

[required] The name of the SageMaker resource to search for.

SuggestionQuery

Limits the property names that are included in the response.

Value

A list with the following syntax:

list(
  PropertyNameSuggestions = list(
    list(
      PropertyName = "string"
    )
  )
)

Request syntax

svc$get_search_suggestions(
  Resource = "TrainingJob"|"Experiment"|"ExperimentTrial"|"ExperimentTrialComponent"|"Endpoint"|"Model"|"ModelPackage"|"ModelPackageGroup"|"Pipeline"|"PipelineExecution"|"FeatureGroup"|"FeatureMetadata"|"Image"|"ImageVersion"|"Project"|"HyperParameterTuningJob"|"ModelCard",
  SuggestionQuery = list(
    PropertyNameQuery = list(
      PropertyNameHint = "string"
    )
  )
)