Amazonka.SageMaker.GetSearchSuggestions

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.

Creating a Request

data GetSearchSuggestions

See: newGetSearchSuggestions smart constructor.

Constructors

GetSearchSuggestions'

Fields

• suggestionQuery :: Maybe SuggestionQuery

  Limits the property names that are included in the response.

• resource :: ResourceType

  The name of the Amazon SageMaker resource to search for.

Instances

ToJSON GetSearchSuggestions

Defined in Amazonka.SageMaker.GetSearchSuggestions

Methods

toJSON :: GetSearchSuggestions -> Value

toEncoding :: GetSearchSuggestions -> Encoding

toJSONList :: [GetSearchSuggestions] -> Value

toEncodingList :: [GetSearchSuggestions] -> Encoding

ToHeaders GetSearchSuggestions

Defined in Amazonka.SageMaker.GetSearchSuggestions

Methods

toHeaders :: GetSearchSuggestions -> [Header]

ToPath GetSearchSuggestions

Defined in Amazonka.SageMaker.GetSearchSuggestions

Methods

toPath :: GetSearchSuggestions -> ByteString

ToQuery GetSearchSuggestions

Defined in Amazonka.SageMaker.GetSearchSuggestions

Methods

toQuery :: GetSearchSuggestions -> QueryString

AWSRequest GetSearchSuggestions

Defined in Amazonka.SageMaker.GetSearchSuggestions

Associated Types

type AWSResponse GetSearchSuggestions

Methods

request :: (Service -> Service) -> GetSearchSuggestions -> Request GetSearchSuggestions

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetSearchSuggestions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSearchSuggestions)))

Generic GetSearchSuggestions

Defined in Amazonka.SageMaker.GetSearchSuggestions

Associated Types

type Rep GetSearchSuggestions :: Type -> Type

Methods

from :: GetSearchSuggestions -> Rep GetSearchSuggestions x

to :: Rep GetSearchSuggestions x -> GetSearchSuggestions

Read GetSearchSuggestions

Defined in Amazonka.SageMaker.GetSearchSuggestions

Methods

readsPrec :: Int -> ReadS GetSearchSuggestions

readList :: ReadS [GetSearchSuggestions]

readPrec :: ReadPrec GetSearchSuggestions

readListPrec :: ReadPrec [GetSearchSuggestions]

Show GetSearchSuggestions

Defined in Amazonka.SageMaker.GetSearchSuggestions

Methods

showsPrec :: Int -> GetSearchSuggestions -> ShowS

show :: GetSearchSuggestions -> String

showList :: [GetSearchSuggestions] -> ShowS

NFData GetSearchSuggestions

Defined in Amazonka.SageMaker.GetSearchSuggestions

Methods

rnf :: GetSearchSuggestions -> ()

Eq GetSearchSuggestions

Defined in Amazonka.SageMaker.GetSearchSuggestions

Methods

(==) :: GetSearchSuggestions -> GetSearchSuggestions -> Bool

(/=) :: GetSearchSuggestions -> GetSearchSuggestions -> Bool

Hashable GetSearchSuggestions

Defined in Amazonka.SageMaker.GetSearchSuggestions

Methods

hashWithSalt :: Int -> GetSearchSuggestions -> Int

hash :: GetSearchSuggestions -> Int

type AWSResponse GetSearchSuggestions

Defined in Amazonka.SageMaker.GetSearchSuggestions

type AWSResponse GetSearchSuggestions = GetSearchSuggestionsResponse

type Rep GetSearchSuggestions

Defined in Amazonka.SageMaker.GetSearchSuggestions

type Rep GetSearchSuggestions = D1 ('MetaData "GetSearchSuggestions" "Amazonka.SageMaker.GetSearchSuggestions" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "GetSearchSuggestions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "suggestionQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SuggestionQuery)) :*: S1 ('MetaSel ('Just "resource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceType)))

newGetSearchSuggestions

Arguments

:: ResourceType

$sel:resource:GetSearchSuggestions'

-> GetSearchSuggestions

Create a value of GetSearchSuggestions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:suggestionQuery:GetSearchSuggestions', getSearchSuggestions_suggestionQuery - Limits the property names that are included in the response.

$sel:resource:GetSearchSuggestions', getSearchSuggestions_resource - The name of the Amazon SageMaker resource to search for.

Request Lenses

getSearchSuggestions_suggestionQuery :: Lens' GetSearchSuggestions (Maybe SuggestionQuery)

Limits the property names that are included in the response.

getSearchSuggestions_resource :: Lens' GetSearchSuggestions ResourceType

The name of the Amazon SageMaker resource to search for.

Destructuring the Response

data GetSearchSuggestionsResponse

See: newGetSearchSuggestionsResponse smart constructor.

Constructors

GetSearchSuggestionsResponse'

Fields

• propertyNameSuggestions :: Maybe [PropertyNameSuggestion]

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetSearchSuggestionsResponse

Defined in Amazonka.SageMaker.GetSearchSuggestions

Associated Types

type Rep GetSearchSuggestionsResponse :: Type -> Type

Methods

from :: GetSearchSuggestionsResponse -> Rep GetSearchSuggestionsResponse x

to :: Rep GetSearchSuggestionsResponse x -> GetSearchSuggestionsResponse

Read GetSearchSuggestionsResponse

Defined in Amazonka.SageMaker.GetSearchSuggestions

Methods

readsPrec :: Int -> ReadS GetSearchSuggestionsResponse

readList :: ReadS [GetSearchSuggestionsResponse]

readPrec :: ReadPrec GetSearchSuggestionsResponse

readListPrec :: ReadPrec [GetSearchSuggestionsResponse]

Show GetSearchSuggestionsResponse

Defined in Amazonka.SageMaker.GetSearchSuggestions

Methods

showsPrec :: Int -> GetSearchSuggestionsResponse -> ShowS

show :: GetSearchSuggestionsResponse -> String

showList :: [GetSearchSuggestionsResponse] -> ShowS

NFData GetSearchSuggestionsResponse

Defined in Amazonka.SageMaker.GetSearchSuggestions

Methods

rnf :: GetSearchSuggestionsResponse -> ()

Eq GetSearchSuggestionsResponse

Defined in Amazonka.SageMaker.GetSearchSuggestions

Methods

(==) :: GetSearchSuggestionsResponse -> GetSearchSuggestionsResponse -> Bool

(/=) :: GetSearchSuggestionsResponse -> GetSearchSuggestionsResponse -> Bool

type Rep GetSearchSuggestionsResponse

Defined in Amazonka.SageMaker.GetSearchSuggestions

type Rep GetSearchSuggestionsResponse = D1 ('MetaData "GetSearchSuggestionsResponse" "Amazonka.SageMaker.GetSearchSuggestions" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "GetSearchSuggestionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "propertyNameSuggestions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PropertyNameSuggestion])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetSearchSuggestionsResponse

Arguments

:: Int

$sel:httpStatus:GetSearchSuggestionsResponse'

-> GetSearchSuggestionsResponse

Create a value of GetSearchSuggestionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:propertyNameSuggestions:GetSearchSuggestionsResponse', getSearchSuggestionsResponse_propertyNameSuggestions - A list of property names for a Resource that match a SuggestionQuery.

$sel:httpStatus:GetSearchSuggestionsResponse', getSearchSuggestionsResponse_httpStatus - The response's http status code.

Response Lenses

getSearchSuggestionsResponse_propertyNameSuggestions :: Lens' GetSearchSuggestionsResponse (Maybe [PropertyNameSuggestion])

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

getSearchSuggestionsResponse_httpStatus :: Lens' GetSearchSuggestionsResponse Int

The response's http status code.