amazonka-cloudsearch-1.6.0: Amazon CloudSearch SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudSearch.DescribeExpressions

Contents

Description

Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions 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 Configuring Expressions in the Amazon CloudSearch Developer Guide .

Synopsis

Creating a Request

describeExpressions Source #

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

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

  • deDeployed - Whether to display the deployed configuration (true ) or include any pending changes (false ). Defaults to false .
  • deExpressionNames - Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.
  • deDomainName - The name of the domain you want to describe.

data DescribeExpressions Source #

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

See: describeExpressions smart constructor.

Instances

Eq DescribeExpressions Source # 
Data DescribeExpressions Source # 

Methods

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

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

toConstr :: DescribeExpressions -> Constr #

dataTypeOf :: DescribeExpressions -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeExpressions -> DescribeExpressions #

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

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

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

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

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

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

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

Read DescribeExpressions Source # 
Show DescribeExpressions Source # 
Generic DescribeExpressions Source # 
Hashable DescribeExpressions Source # 
NFData DescribeExpressions Source # 

Methods

rnf :: DescribeExpressions -> () #

AWSRequest DescribeExpressions Source # 
ToHeaders DescribeExpressions Source # 
ToPath DescribeExpressions Source # 
ToQuery DescribeExpressions Source # 
type Rep DescribeExpressions Source # 
type Rep DescribeExpressions = D1 * (MetaData "DescribeExpressions" "Network.AWS.CloudSearch.DescribeExpressions" "amazonka-cloudsearch-1.6.0-FqLbtgWX59z7wIOS2Mnl98" False) (C1 * (MetaCons "DescribeExpressions'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_deDeployed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_deExpressionNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_deDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))
type Rs DescribeExpressions Source # 

Request Lenses

deDeployed :: Lens' DescribeExpressions (Maybe Bool) Source #

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

deExpressionNames :: Lens' DescribeExpressions [Text] Source #

Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

deDomainName :: Lens' DescribeExpressions Text Source #

The name of the domain you want to describe.

Destructuring the Response

describeExpressionsResponse Source #

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

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

data DescribeExpressionsResponse Source #

The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.

See: describeExpressionsResponse smart constructor.

Instances

Eq DescribeExpressionsResponse Source # 
Data DescribeExpressionsResponse Source # 

Methods

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

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

toConstr :: DescribeExpressionsResponse -> Constr #

dataTypeOf :: DescribeExpressionsResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeExpressionsResponse -> DescribeExpressionsResponse #

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

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

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

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

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

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

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

Read DescribeExpressionsResponse Source # 
Show DescribeExpressionsResponse Source # 
Generic DescribeExpressionsResponse Source # 
NFData DescribeExpressionsResponse Source # 
type Rep DescribeExpressionsResponse Source # 
type Rep DescribeExpressionsResponse = D1 * (MetaData "DescribeExpressionsResponse" "Network.AWS.CloudSearch.DescribeExpressions" "amazonka-cloudsearch-1.6.0-FqLbtgWX59z7wIOS2Mnl98" False) (C1 * (MetaCons "DescribeExpressionsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_drsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_drsExpressions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [ExpressionStatus]))))

Response Lenses

drsExpressions :: Lens' DescribeExpressionsResponse [ExpressionStatus] Source #

The expressions configured for the domain.