:doc:`SageMaker <../../sagemaker>` / Client / get_search_suggestions

**********************
get_search_suggestions
**********************



.. py:method:: SageMaker.Client.get_search_suggestions(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/GetSearchSuggestions>`_  


  **Request Syntax**
  ::

    response = client.get_search_suggestions(
        Resource='TrainingJob'|'Experiment'|'ExperimentTrial'|'ExperimentTrialComponent'|'Endpoint'|'Model'|'ModelPackage'|'ModelPackageGroup'|'Pipeline'|'PipelineExecution'|'FeatureGroup'|'FeatureMetadata'|'Image'|'ImageVersion'|'Project'|'HyperParameterTuningJob'|'ModelCard'|'PipelineVersion',
        SuggestionQuery={
            'PropertyNameQuery': {
                'PropertyNameHint': 'string'
            }
        }
    )
    
  :type Resource: string
  :param Resource: **[REQUIRED]** 

    The name of the SageMaker resource to search for.

    

  
  :type SuggestionQuery: dict
  :param SuggestionQuery: 

    Limits the property names that are included in the response.

    

  
    - **PropertyNameQuery** *(dict) --* 

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

      

    
      - **PropertyNameHint** *(string) --* **[REQUIRED]** 

        Text that begins a property's name.

        

      
    
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'PropertyNameSuggestions': [
              {
                  'PropertyName': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **PropertyNameSuggestions** *(list) --* 

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

        
        

        - *(dict) --* 

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

            
      
    
  