Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudSearch.DescribeSuggesters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Creating a Request

data DescribeSuggesters Source #

Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

See: newDescribeSuggesters smart constructor.

Constructors

DescribeSuggesters'
Fields deployed :: Maybe Bool Whether to display the deployed configuration (`true`) or include any pending changes (`false`). Defaults to `false`. suggesterNames :: Maybe [Text] The suggesters you want to describe. domainName :: Text The name of the domain you want to describe.

Instances

Instances details

Eq DescribeSuggesters Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters Methods (==) :: DescribeSuggesters -> DescribeSuggesters -> Bool # (/=) :: DescribeSuggesters -> DescribeSuggesters -> Bool #
Read DescribeSuggesters Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters Methods readsPrec :: Int -> ReadS DescribeSuggesters # readList :: ReadS [DescribeSuggesters] # readPrec :: ReadPrec DescribeSuggesters # readListPrec :: ReadPrec [DescribeSuggesters] #
Show DescribeSuggesters Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters Methods showsPrec :: Int -> DescribeSuggesters -> ShowS # show :: DescribeSuggesters -> String # showList :: [DescribeSuggesters] -> ShowS #
Generic DescribeSuggesters Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters Associated Types type Rep DescribeSuggesters :: Type -> Type # Methods from :: DescribeSuggesters -> Rep DescribeSuggesters x # to :: Rep DescribeSuggesters x -> DescribeSuggesters #
NFData DescribeSuggesters Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters Methods rnf :: DescribeSuggesters -> () #
Hashable DescribeSuggesters Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters Methods hashWithSalt :: Int -> DescribeSuggesters -> Int # hash :: DescribeSuggesters -> Int #
AWSRequest DescribeSuggesters Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters Associated Types type AWSResponse DescribeSuggesters # Methods request :: DescribeSuggesters -> Request DescribeSuggesters # response :: MonadResource m => Logger -> Service -> Proxy DescribeSuggesters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSuggesters))) #
ToHeaders DescribeSuggesters Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters Methods toHeaders :: DescribeSuggesters -> [Header] #
ToPath DescribeSuggesters Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters Methods toPath :: DescribeSuggesters -> ByteString #
ToQuery DescribeSuggesters Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters Methods toQuery :: DescribeSuggesters -> QueryString #
type Rep DescribeSuggesters Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters type Rep DescribeSuggesters = D1 ('MetaData "DescribeSuggesters" "Amazonka.CloudSearch.DescribeSuggesters" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "DescribeSuggesters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deployed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "suggesterNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DescribeSuggesters Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters type AWSResponse DescribeSuggesters = DescribeSuggestersResponse

newDescribeSuggesters Source #

Arguments

:: Text	`$sel:domainName:DescribeSuggesters'`
-> DescribeSuggesters

Create a value of DescribeSuggesters 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:deployed:DescribeSuggesters', describeSuggesters_deployed - Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

$sel:suggesterNames:DescribeSuggesters', describeSuggesters_suggesterNames - The suggesters you want to describe.

$sel:domainName:DescribeSuggesters', describeSuggesters_domainName - The name of the domain you want to describe.

Request Lenses

describeSuggesters_deployed :: Lens' DescribeSuggesters (Maybe Bool) Source #

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

describeSuggesters_suggesterNames :: Lens' DescribeSuggesters (Maybe [Text]) Source #

The suggesters you want to describe.

describeSuggesters_domainName :: Lens' DescribeSuggesters Text Source #

The name of the domain you want to describe.

Destructuring the Response

data DescribeSuggestersResponse Source #

The result of a DescribeSuggesters request.

See: newDescribeSuggestersResponse smart constructor.

Constructors

DescribeSuggestersResponse'
Fields httpStatus :: Int The response's http status code. suggesters :: [SuggesterStatus] The suggesters configured for the domain specified in the request.

Instances

Instances details

Eq DescribeSuggestersResponse Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters Methods (==) :: DescribeSuggestersResponse -> DescribeSuggestersResponse -> Bool # (/=) :: DescribeSuggestersResponse -> DescribeSuggestersResponse -> Bool #
Read DescribeSuggestersResponse Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters Methods readsPrec :: Int -> ReadS DescribeSuggestersResponse # readList :: ReadS [DescribeSuggestersResponse] # readPrec :: ReadPrec DescribeSuggestersResponse # readListPrec :: ReadPrec [DescribeSuggestersResponse] #
Show DescribeSuggestersResponse Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters Methods showsPrec :: Int -> DescribeSuggestersResponse -> ShowS # show :: DescribeSuggestersResponse -> String # showList :: [DescribeSuggestersResponse] -> ShowS #
Generic DescribeSuggestersResponse Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters Associated Types type Rep DescribeSuggestersResponse :: Type -> Type # Methods from :: DescribeSuggestersResponse -> Rep DescribeSuggestersResponse x # to :: Rep DescribeSuggestersResponse x -> DescribeSuggestersResponse #
NFData DescribeSuggestersResponse Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters Methods rnf :: DescribeSuggestersResponse -> () #
type Rep DescribeSuggestersResponse Source #
Instance details Defined in Amazonka.CloudSearch.DescribeSuggesters type Rep DescribeSuggestersResponse = D1 ('MetaData "DescribeSuggestersResponse" "Amazonka.CloudSearch.DescribeSuggesters" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "DescribeSuggestersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "suggesters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SuggesterStatus])))

newDescribeSuggestersResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeSuggestersResponse'`
-> DescribeSuggestersResponse

Create a value of DescribeSuggestersResponse 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:httpStatus:DescribeSuggestersResponse', describeSuggestersResponse_httpStatus - The response's http status code.

$sel:suggesters:DescribeSuggestersResponse', describeSuggestersResponse_suggesters - The suggesters configured for the domain specified in the request.

Response Lenses

describeSuggestersResponse_httpStatus :: Lens' DescribeSuggestersResponse Int Source #

The response's http status code.

describeSuggestersResponse_suggesters :: Lens' DescribeSuggestersResponse [SuggesterStatus] Source #

The suggesters configured for the domain specified in the request.