amazonka-swf-1.4.5: Amazon Simple Workflow Service SDK.

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

Network.AWS.SWF.DescribeDomain

Contents

Description

Returns information about the specified domain, including description and status.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains. * Use an Action element to allow or deny permission to call this action. * You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

Synopsis

Creating a Request

describeDomain #

Arguments

:: Text

ddName

-> DescribeDomain 

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

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

  • ddName - The name of the domain to describe.

data DescribeDomain #

See: describeDomain smart constructor.

Instances

Eq DescribeDomain # 
Data DescribeDomain # 

Methods

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

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

toConstr :: DescribeDomain -> Constr #

dataTypeOf :: DescribeDomain -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeDomain # 
Show DescribeDomain # 
Generic DescribeDomain # 

Associated Types

type Rep DescribeDomain :: * -> * #

Hashable DescribeDomain # 
ToJSON DescribeDomain # 
NFData DescribeDomain # 

Methods

rnf :: DescribeDomain -> () #

AWSRequest DescribeDomain # 
ToQuery DescribeDomain # 
ToPath DescribeDomain # 
ToHeaders DescribeDomain # 
type Rep DescribeDomain # 
type Rep DescribeDomain = D1 (MetaData "DescribeDomain" "Network.AWS.SWF.DescribeDomain" "amazonka-swf-1.4.5-5efQTs2LdqG6LIeqZlvIEl" True) (C1 (MetaCons "DescribeDomain'" PrefixI True) (S1 (MetaSel (Just Symbol "_ddName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs DescribeDomain # 

Request Lenses

ddName :: Lens' DescribeDomain Text #

The name of the domain to describe.

Destructuring the Response

describeDomainResponse #

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

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

data DescribeDomainResponse #

Contains details of a domain.

See: describeDomainResponse smart constructor.

Instances

Eq DescribeDomainResponse # 
Data DescribeDomainResponse # 

Methods

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

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

toConstr :: DescribeDomainResponse -> Constr #

dataTypeOf :: DescribeDomainResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeDomainResponse # 
Show DescribeDomainResponse # 
Generic DescribeDomainResponse # 
NFData DescribeDomainResponse # 

Methods

rnf :: DescribeDomainResponse -> () #

type Rep DescribeDomainResponse # 
type Rep DescribeDomainResponse = D1 (MetaData "DescribeDomainResponse" "Network.AWS.SWF.DescribeDomain" "amazonka-swf-1.4.5-5efQTs2LdqG6LIeqZlvIEl" False) (C1 (MetaCons "DescribeDomainResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) ((:*:) (S1 (MetaSel (Just Symbol "_ddrsDomainInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DomainInfo)) (S1 (MetaSel (Just Symbol "_ddrsConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DomainConfiguration)))))

Response Lenses

ddrsResponseStatus :: Lens' DescribeDomainResponse Int #

  • - | The response status code.