Network.AWS.CloudSearch.DescribeSuggesters

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

describeSuggesters

Arguments

:: Text

dssDomainName

-> DescribeSuggesters

Creates a value of DescribeSuggesters with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dssDeployed
• dssSuggesterNames
• dssDomainName

data DescribeSuggesters

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: describeSuggesters smart constructor.

Instances

Eq DescribeSuggesters

Methods

(==) :: DescribeSuggesters -> DescribeSuggesters -> Bool

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

Data DescribeSuggesters

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeSuggesters -> c DescribeSuggesters

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeSuggesters

toConstr :: DescribeSuggesters -> Constr

dataTypeOf :: DescribeSuggesters -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeSuggesters)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeSuggesters)

gmapT :: (forall b. Data b => b -> b) -> DescribeSuggesters -> DescribeSuggesters

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeSuggesters -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeSuggesters -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeSuggesters -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeSuggesters -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeSuggesters -> m DescribeSuggesters

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeSuggesters -> m DescribeSuggesters

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeSuggesters -> m DescribeSuggesters

Read DescribeSuggesters

Methods

readsPrec :: Int -> ReadS DescribeSuggesters

readList :: ReadS [DescribeSuggesters]

readPrec :: ReadPrec DescribeSuggesters

readListPrec :: ReadPrec [DescribeSuggesters]

Show DescribeSuggesters

Methods

showsPrec :: Int -> DescribeSuggesters -> ShowS

show :: DescribeSuggesters -> String

showList :: [DescribeSuggesters] -> ShowS

Generic DescribeSuggesters

Associated Types

type Rep DescribeSuggesters :: * -> *

Methods

from :: DescribeSuggesters -> Rep DescribeSuggesters x

to :: Rep DescribeSuggesters x -> DescribeSuggesters

Hashable DescribeSuggesters

Methods

hashWithSalt :: Int -> DescribeSuggesters -> Int

hash :: DescribeSuggesters -> Int

NFData DescribeSuggesters

Methods

rnf :: DescribeSuggesters -> ()

AWSRequest DescribeSuggesters

Associated Types

type Rs DescribeSuggesters :: *

Methods

request :: DescribeSuggesters -> Request DescribeSuggesters

response :: MonadResource m => Logger -> Service -> Proxy * DescribeSuggesters -> ClientResponse -> m (Response DescribeSuggesters)

ToPath DescribeSuggesters

Methods

toPath :: DescribeSuggesters -> ByteString

ToHeaders DescribeSuggesters

Methods

toHeaders :: DescribeSuggesters -> [Header]

ToQuery DescribeSuggesters

Methods

toQuery :: DescribeSuggesters -> QueryString

type Rep DescribeSuggesters

type Rep DescribeSuggesters = D1 (MetaData "DescribeSuggesters" "Network.AWS.CloudSearch.DescribeSuggesters" "amazonka-cloudsearch-1.4.3-8jIA3omBRonH9H48gQAXGd" False) (C1 (MetaCons "DescribeSuggesters'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dssDeployed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_dssSuggesterNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_dssDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs DescribeSuggesters

type Rs DescribeSuggesters = DescribeSuggestersResponse

Request Lenses

dssDeployed :: Lens' DescribeSuggesters (Maybe Bool)

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

dssSuggesterNames :: Lens' DescribeSuggesters [Text]

The suggesters you want to describe.

dssDomainName :: Lens' DescribeSuggesters Text

The name of the domain you want to describe.

Destructuring the Response

describeSuggestersResponse

Arguments

:: Int

dssrsResponseStatus

-> DescribeSuggestersResponse

Creates a value of DescribeSuggestersResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dssrsResponseStatus
• dssrsSuggesters

data DescribeSuggestersResponse

The result of a DescribeSuggesters request.

See: describeSuggestersResponse smart constructor.

Instances

Eq DescribeSuggestersResponse

Methods

(==) :: DescribeSuggestersResponse -> DescribeSuggestersResponse -> Bool

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

Data DescribeSuggestersResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeSuggestersResponse -> c DescribeSuggestersResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeSuggestersResponse

toConstr :: DescribeSuggestersResponse -> Constr

dataTypeOf :: DescribeSuggestersResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeSuggestersResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeSuggestersResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeSuggestersResponse -> DescribeSuggestersResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeSuggestersResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeSuggestersResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeSuggestersResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeSuggestersResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeSuggestersResponse -> m DescribeSuggestersResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeSuggestersResponse -> m DescribeSuggestersResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeSuggestersResponse -> m DescribeSuggestersResponse

Read DescribeSuggestersResponse

Methods

readsPrec :: Int -> ReadS DescribeSuggestersResponse

readList :: ReadS [DescribeSuggestersResponse]

readPrec :: ReadPrec DescribeSuggestersResponse

readListPrec :: ReadPrec [DescribeSuggestersResponse]

Show DescribeSuggestersResponse

Methods

showsPrec :: Int -> DescribeSuggestersResponse -> ShowS

show :: DescribeSuggestersResponse -> String

showList :: [DescribeSuggestersResponse] -> ShowS

Generic DescribeSuggestersResponse

Associated Types

type Rep DescribeSuggestersResponse :: * -> *

Methods

from :: DescribeSuggestersResponse -> Rep DescribeSuggestersResponse x

to :: Rep DescribeSuggestersResponse x -> DescribeSuggestersResponse

NFData DescribeSuggestersResponse

Methods

rnf :: DescribeSuggestersResponse -> ()

type Rep DescribeSuggestersResponse

type Rep DescribeSuggestersResponse = D1 (MetaData "DescribeSuggestersResponse" "Network.AWS.CloudSearch.DescribeSuggesters" "amazonka-cloudsearch-1.4.3-8jIA3omBRonH9H48gQAXGd" False) (C1 (MetaCons "DescribeSuggestersResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dssrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_dssrsSuggesters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [SuggesterStatus]))))

Response Lenses

dssrsResponseStatus :: Lens' DescribeSuggestersResponse Int

The response status code.

dssrsSuggesters :: Lens' DescribeSuggestersResponse [SuggesterStatus]

The suggesters configured for the domain specified in the request.