Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.CloudSearch.DescribeExpressions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 .

Creating a Request

describeExpressions #

Arguments

:: Text	`deDomainName`
-> DescribeExpressions

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 #

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 #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions Methods (==) :: DescribeExpressions -> DescribeExpressions -> Bool # (/=) :: DescribeExpressions -> DescribeExpressions -> Bool #
Data DescribeExpressions #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions 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 #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions Methods readsPrec :: Int -> ReadS DescribeExpressions # readList :: ReadS [DescribeExpressions] # readPrec :: ReadPrec DescribeExpressions # readListPrec :: ReadPrec [DescribeExpressions] #
Show DescribeExpressions #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions Methods showsPrec :: Int -> DescribeExpressions -> ShowS # show :: DescribeExpressions -> String # showList :: [DescribeExpressions] -> ShowS #
Generic DescribeExpressions #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions Associated Types type Rep DescribeExpressions :: * -> * # Methods from :: DescribeExpressions -> Rep DescribeExpressions x # to :: Rep DescribeExpressions x -> DescribeExpressions #
Hashable DescribeExpressions #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions Methods hashWithSalt :: Int -> DescribeExpressions -> Int # hash :: DescribeExpressions -> Int #
AWSRequest DescribeExpressions #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions Associated Types type Rs DescribeExpressions :: * # Methods request :: DescribeExpressions -> Request DescribeExpressions # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeExpressions -> ClientResponse -> m (Response DescribeExpressions) #
ToHeaders DescribeExpressions #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions Methods toHeaders :: DescribeExpressions -> [Header] #
ToPath DescribeExpressions #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions Methods toPath :: DescribeExpressions -> ByteString #
ToQuery DescribeExpressions #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions Methods toQuery :: DescribeExpressions -> QueryString #
NFData DescribeExpressions #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions Methods rnf :: DescribeExpressions -> () #
type Rep DescribeExpressions #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions type Rep DescribeExpressions = D1 (MetaData "DescribeExpressions" "Network.AWS.CloudSearch.DescribeExpressions" "amazonka-cloudsearch-1.6.0-C9KDnoOihM1BDmnzNS5XoR" False) (C1 (MetaCons "DescribeExpressions'" PrefixI True) (S1 (MetaSel (Just "_deDeployed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 (MetaSel (Just "_deExpressionNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: S1 (MetaSel (Just "_deDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs DescribeExpressions #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions type Rs DescribeExpressions = DescribeExpressionsResponse

Request Lenses

deDeployed :: Lens' DescribeExpressions (Maybe Bool) #

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

deExpressionNames :: Lens' DescribeExpressions [Text] #

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

deDomainName :: Lens' DescribeExpressions Text #

The name of the domain you want to describe.

Destructuring the Response

describeExpressionsResponse #

Arguments

:: Int	`drsResponseStatus`
-> DescribeExpressionsResponse

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:

drsResponseStatus - -- | The response status code.
drsExpressions - The expressions configured for the domain.

data DescribeExpressionsResponse #

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

See: describeExpressionsResponse smart constructor.

Instances

Eq DescribeExpressionsResponse #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions Methods (==) :: DescribeExpressionsResponse -> DescribeExpressionsResponse -> Bool # (/=) :: DescribeExpressionsResponse -> DescribeExpressionsResponse -> Bool #
Data DescribeExpressionsResponse #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions 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 #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions Methods readsPrec :: Int -> ReadS DescribeExpressionsResponse # readList :: ReadS [DescribeExpressionsResponse] # readPrec :: ReadPrec DescribeExpressionsResponse # readListPrec :: ReadPrec [DescribeExpressionsResponse] #
Show DescribeExpressionsResponse #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions Methods showsPrec :: Int -> DescribeExpressionsResponse -> ShowS # show :: DescribeExpressionsResponse -> String # showList :: [DescribeExpressionsResponse] -> ShowS #
Generic DescribeExpressionsResponse #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions Associated Types type Rep DescribeExpressionsResponse :: * -> * # Methods from :: DescribeExpressionsResponse -> Rep DescribeExpressionsResponse x # to :: Rep DescribeExpressionsResponse x -> DescribeExpressionsResponse #
NFData DescribeExpressionsResponse #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions Methods rnf :: DescribeExpressionsResponse -> () #
type Rep DescribeExpressionsResponse #
Instance details Defined in Network.AWS.CloudSearch.DescribeExpressions type Rep DescribeExpressionsResponse = D1 (MetaData "DescribeExpressionsResponse" "Network.AWS.CloudSearch.DescribeExpressions" "amazonka-cloudsearch-1.6.0-C9KDnoOihM1BDmnzNS5XoR" False) (C1 (MetaCons "DescribeExpressionsResponse'" PrefixI True) (S1 (MetaSel (Just "_drsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_drsExpressions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [ExpressionStatus])))

Response Lenses

drsResponseStatus :: Lens' DescribeExpressionsResponse Int #

- | The response status code.

drsExpressions :: Lens' DescribeExpressionsResponse [ExpressionStatus] #

The expressions configured for the domain.