get_search_suggestions `async` ¶

get_search_suggestions(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    resource: Optional[ResourceType] = None,
    suggestion_query: Optional[SuggestionQuery] = None,
) -> GetSearchSuggestionsResponse

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.

Parameters:

resource (Optional[ResourceType], default: None ) –

The name of the SageMaker resource to search for.
suggestion_query (Optional[SuggestionQuery], default: None ) –

Limits the property names that are included in the response.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py

async def get_search_suggestions(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    resource: Optional["capo_sagemaker.types.resource_type.ResourceType"] = None,
    suggestion_query: Optional[
        "capo_sagemaker.types.suggestion_query.SuggestionQuery"
    ] = None,
) -> "capo_sagemaker.types.get_search_suggestions_response.GetSearchSuggestionsResponse":
    """<p>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 <code>Search</code> queries. Provides suggestions for <code>HyperParameters</code>, <code>Tags</code>, and <code>Metrics</code>.</p>

    Args:
        resource: <p>The name of the SageMaker resource to search for.</p>
        suggestion_query: <p>Limits the property names that are included in the response.</p>

    Raises:
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker.types.get_search_suggestions_request.GetSearchSuggestionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.get_search_suggestions_response.GetSearchSuggestionsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.get_search_suggestions

        (
            output,
            http_response,
        ) = await capo_sagemaker._operations.sage_maker.get_search_suggestions.async_get_search_suggestions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSearchSuggestions")
    )
    input_: capo_sagemaker.types.get_search_suggestions_request.GetSearchSuggestionsRequest = {}
    if resource is not None:
        input_["resource"] = resource
    if suggestion_query is not None:
        input_["suggestion_query"] = suggestion_query

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_search_suggestions async ¶

get_search_suggestions `async` ¶