Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . sagemaker ]



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 .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--resource <value>
[--suggestion-query <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--resource (string)

The name of the Amazon SageMaker resource to Search for.

Possible values:

  • TrainingJob
  • Experiment
  • ExperimentTrial
  • ExperimentTrialComponent

--suggestion-query (structure)

Limits the property names that are included in the response.

Shorthand Syntax:


JSON Syntax:

  "PropertyNameQuery": {
    "PropertyNameHint": "string"

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


PropertyNameSuggestions -> (list)

A list of property names for a Resource that match a SuggestionQuery .


A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.

PropertyName -> (string)

A suggested property name based on what you entered in the search textbox in the Amazon SageMaker console.