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.SWF.RegisterDomain

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Registers a new domain.

Access Control

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

You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.
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 doesn't 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 is set to OPERATION_NOT_PERMITTED . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide .

Creating a Request

registerDomain #

Arguments

:: Text	`rdName`
-> Text	`rdWorkflowExecutionRetentionPeriodInDays`
-> RegisterDomain

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

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

rdDescription - A text description of the domain.
rdName - Name of the domain to register. The name must be unique in the region that the domain is registered in. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f-u009f ). Also, it must not contain the literal string arn .
rdWorkflowExecutionRetentionPeriodInDays - The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn't available in the results of visibility calls. If you pass the value NONE or 0 (zero), then the workflow execution history isn't retained. As soon as the workflow execution completes, the execution record and its history are deleted. The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide .

data RegisterDomain #

See: registerDomain smart constructor.

Instances

Eq RegisterDomain #
Instance details Defined in Network.AWS.SWF.RegisterDomain Methods (==) :: RegisterDomain -> RegisterDomain -> Bool # (/=) :: RegisterDomain -> RegisterDomain -> Bool #
Data RegisterDomain #
Instance details Defined in Network.AWS.SWF.RegisterDomain Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterDomain -> c RegisterDomain # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterDomain # toConstr :: RegisterDomain -> Constr # dataTypeOf :: RegisterDomain -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RegisterDomain) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterDomain) # gmapT :: (forall b. Data b => b -> b) -> RegisterDomain -> RegisterDomain # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterDomain -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterDomain -> r # gmapQ :: (forall d. Data d => d -> u) -> RegisterDomain -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterDomain -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterDomain -> m RegisterDomain # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterDomain -> m RegisterDomain # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterDomain -> m RegisterDomain #
Read RegisterDomain #
Instance details Defined in Network.AWS.SWF.RegisterDomain Methods readsPrec :: Int -> ReadS RegisterDomain # readList :: ReadS [RegisterDomain] # readPrec :: ReadPrec RegisterDomain # readListPrec :: ReadPrec [RegisterDomain] #
Show RegisterDomain #
Instance details Defined in Network.AWS.SWF.RegisterDomain Methods showsPrec :: Int -> RegisterDomain -> ShowS # show :: RegisterDomain -> String # showList :: [RegisterDomain] -> ShowS #
Generic RegisterDomain #
Instance details Defined in Network.AWS.SWF.RegisterDomain Associated Types type Rep RegisterDomain :: * -> * # Methods from :: RegisterDomain -> Rep RegisterDomain x # to :: Rep RegisterDomain x -> RegisterDomain #
Hashable RegisterDomain #
Instance details Defined in Network.AWS.SWF.RegisterDomain Methods hashWithSalt :: Int -> RegisterDomain -> Int # hash :: RegisterDomain -> Int #
ToJSON RegisterDomain #
Instance details Defined in Network.AWS.SWF.RegisterDomain Methods toJSON :: RegisterDomain -> Value # toEncoding :: RegisterDomain -> Encoding # toJSONList :: [RegisterDomain] -> Value # toEncodingList :: [RegisterDomain] -> Encoding #
AWSRequest RegisterDomain #
Instance details Defined in Network.AWS.SWF.RegisterDomain Associated Types type Rs RegisterDomain :: * # Methods request :: RegisterDomain -> Request RegisterDomain # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy RegisterDomain -> ClientResponse -> m (Response RegisterDomain) #
ToHeaders RegisterDomain #
Instance details Defined in Network.AWS.SWF.RegisterDomain Methods toHeaders :: RegisterDomain -> [Header] #
ToPath RegisterDomain #
Instance details Defined in Network.AWS.SWF.RegisterDomain Methods toPath :: RegisterDomain -> ByteString #
ToQuery RegisterDomain #
Instance details Defined in Network.AWS.SWF.RegisterDomain Methods toQuery :: RegisterDomain -> QueryString #
NFData RegisterDomain #
Instance details Defined in Network.AWS.SWF.RegisterDomain Methods rnf :: RegisterDomain -> () #
type Rep RegisterDomain #
Instance details Defined in Network.AWS.SWF.RegisterDomain type Rep RegisterDomain = D1 (MetaData "RegisterDomain" "Network.AWS.SWF.RegisterDomain" "amazonka-swf-1.6.0-1h41zhaEbfa3Fk0SeWaXFv" False) (C1 (MetaCons "RegisterDomain'" PrefixI True) (S1 (MetaSel (Just "_rdDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_rdName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_rdWorkflowExecutionRetentionPeriodInDays") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs RegisterDomain #
Instance details Defined in Network.AWS.SWF.RegisterDomain type Rs RegisterDomain = RegisterDomainResponse

Request Lenses

rdDescription :: Lens' RegisterDomain (Maybe Text) #

A text description of the domain.

rdName :: Lens' RegisterDomain Text #

Name of the domain to register. The name must be unique in the region that the domain is registered in. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f-u009f ). Also, it must not contain the literal string arn .

rdWorkflowExecutionRetentionPeriodInDays :: Lens' RegisterDomain Text #

The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn't available in the results of visibility calls. If you pass the value NONE or 0 (zero), then the workflow execution history isn't retained. As soon as the workflow execution completes, the execution record and its history are deleted. The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide .

Destructuring the Response

registerDomainResponse :: RegisterDomainResponse #

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

data RegisterDomainResponse #

See: registerDomainResponse smart constructor.

Instances

Eq RegisterDomainResponse #
Instance details Defined in Network.AWS.SWF.RegisterDomain Methods (==) :: RegisterDomainResponse -> RegisterDomainResponse -> Bool # (/=) :: RegisterDomainResponse -> RegisterDomainResponse -> Bool #
Data RegisterDomainResponse #
Instance details Defined in Network.AWS.SWF.RegisterDomain Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterDomainResponse -> c RegisterDomainResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterDomainResponse # toConstr :: RegisterDomainResponse -> Constr # dataTypeOf :: RegisterDomainResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RegisterDomainResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterDomainResponse) # gmapT :: (forall b. Data b => b -> b) -> RegisterDomainResponse -> RegisterDomainResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterDomainResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterDomainResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> RegisterDomainResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterDomainResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterDomainResponse -> m RegisterDomainResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterDomainResponse -> m RegisterDomainResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterDomainResponse -> m RegisterDomainResponse #
Read RegisterDomainResponse #
Instance details Defined in Network.AWS.SWF.RegisterDomain Methods readsPrec :: Int -> ReadS RegisterDomainResponse # readList :: ReadS [RegisterDomainResponse] # readPrec :: ReadPrec RegisterDomainResponse # readListPrec :: ReadPrec [RegisterDomainResponse] #
Show RegisterDomainResponse #
Instance details Defined in Network.AWS.SWF.RegisterDomain Methods showsPrec :: Int -> RegisterDomainResponse -> ShowS # show :: RegisterDomainResponse -> String # showList :: [RegisterDomainResponse] -> ShowS #
Generic RegisterDomainResponse #
Instance details Defined in Network.AWS.SWF.RegisterDomain Associated Types type Rep RegisterDomainResponse :: * -> * # Methods from :: RegisterDomainResponse -> Rep RegisterDomainResponse x # to :: Rep RegisterDomainResponse x -> RegisterDomainResponse #
NFData RegisterDomainResponse #
Instance details Defined in Network.AWS.SWF.RegisterDomain Methods rnf :: RegisterDomainResponse -> () #
type Rep RegisterDomainResponse #
Instance details Defined in Network.AWS.SWF.RegisterDomain type Rep RegisterDomainResponse = D1 (MetaData "RegisterDomainResponse" "Network.AWS.SWF.RegisterDomain" "amazonka-swf-1.6.0-1h41zhaEbfa3Fk0SeWaXFv" False) (C1 (MetaCons "RegisterDomainResponse'" PrefixI False) (U1 :: * -> *))