[ aws . sagemaker ]

get-search-suggestions

Description

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.

Synopsis

  get-search-suggestions
--resource <value>
[--suggestion-query <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--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.

PropertyNameQuery -> (structure)

Defines a property name hint. Only property names that begin with the specified hint are included in the response.

PropertyNameHint -> (string)

Text that begins a property’s name.

Shorthand Syntax:

PropertyNameQuery={PropertyNameHint=string}

JSON Syntax:

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

PropertyNameSuggestions -> (list)

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

(structure)

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.