Copyright	(c) 2013-2021 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

Amazonka.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

data RegisterDomain Source #

See: newRegisterDomain smart constructor.

Constructors

RegisterDomain'

Fields

description :: Maybe Text
A text description of the domain.
tags :: Maybe [ResourceTag]
Tags to be added when registering a domain.
Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.
name :: 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 be the literal string arn.
workflowExecutionRetentionPeriodInDays :: 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.

Instances

Instances details

Eq RegisterDomain Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Methods (==) :: RegisterDomain -> RegisterDomain -> Bool # (/=) :: RegisterDomain -> RegisterDomain -> Bool #
Read RegisterDomain Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Methods readsPrec :: Int -> ReadS RegisterDomain # readList :: ReadS [RegisterDomain] # readPrec :: ReadPrec RegisterDomain # readListPrec :: ReadPrec [RegisterDomain] #
Show RegisterDomain Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Methods showsPrec :: Int -> RegisterDomain -> ShowS # show :: RegisterDomain -> String # showList :: [RegisterDomain] -> ShowS #
Generic RegisterDomain Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Associated Types type Rep RegisterDomain :: Type -> Type # Methods from :: RegisterDomain -> Rep RegisterDomain x # to :: Rep RegisterDomain x -> RegisterDomain #
NFData RegisterDomain Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Methods rnf :: RegisterDomain -> () #
Hashable RegisterDomain Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Methods hashWithSalt :: Int -> RegisterDomain -> Int # hash :: RegisterDomain -> Int #
ToJSON RegisterDomain Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Methods toJSON :: RegisterDomain -> Value # toEncoding :: RegisterDomain -> Encoding # toJSONList :: [RegisterDomain] -> Value # toEncodingList :: [RegisterDomain] -> Encoding #
AWSRequest RegisterDomain Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Associated Types type AWSResponse RegisterDomain # Methods request :: RegisterDomain -> Request RegisterDomain # response :: MonadResource m => Logger -> Service -> Proxy RegisterDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterDomain))) #
ToHeaders RegisterDomain Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Methods toHeaders :: RegisterDomain -> [Header] #
ToPath RegisterDomain Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Methods toPath :: RegisterDomain -> ByteString #
ToQuery RegisterDomain Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Methods toQuery :: RegisterDomain -> QueryString #
type Rep RegisterDomain Source #
Instance details Defined in Amazonka.SWF.RegisterDomain type Rep RegisterDomain = D1 ('MetaData "RegisterDomain" "Amazonka.SWF.RegisterDomain" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "RegisterDomain'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceTag]))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workflowExecutionRetentionPeriodInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse RegisterDomain Source #
Instance details Defined in Amazonka.SWF.RegisterDomain type AWSResponse RegisterDomain = RegisterDomainResponse

newRegisterDomain Source #

Arguments

:: Text	`$sel:name:RegisterDomain'`
-> Text	`$sel:workflowExecutionRetentionPeriodInDays:RegisterDomain'`
-> RegisterDomain

Create a value of RegisterDomain with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:RegisterDomain', registerDomain_description - A text description of the domain.

$sel:tags:RegisterDomain', registerDomain_tags - Tags to be added when registering a domain.

Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

$sel:name:RegisterDomain', registerDomain_name - 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 be the literal string arn.

$sel:workflowExecutionRetentionPeriodInDays:RegisterDomain', registerDomain_workflowExecutionRetentionPeriodInDays - 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.

Request Lenses

registerDomain_description :: Lens' RegisterDomain (Maybe Text) Source #

A text description of the domain.

registerDomain_tags :: Lens' RegisterDomain (Maybe [ResourceTag]) Source #

Tags to be added when registering a domain.

Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

registerDomain_name :: Lens' RegisterDomain Text Source #

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 be the literal string arn.

registerDomain_workflowExecutionRetentionPeriodInDays :: Lens' RegisterDomain Text Source #

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

data RegisterDomainResponse Source #

See: newRegisterDomainResponse smart constructor.

Constructors

RegisterDomainResponse'

Instances

Instances details

Eq RegisterDomainResponse Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Methods (==) :: RegisterDomainResponse -> RegisterDomainResponse -> Bool # (/=) :: RegisterDomainResponse -> RegisterDomainResponse -> Bool #
Read RegisterDomainResponse Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Methods readsPrec :: Int -> ReadS RegisterDomainResponse # readList :: ReadS [RegisterDomainResponse] # readPrec :: ReadPrec RegisterDomainResponse # readListPrec :: ReadPrec [RegisterDomainResponse] #
Show RegisterDomainResponse Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Methods showsPrec :: Int -> RegisterDomainResponse -> ShowS # show :: RegisterDomainResponse -> String # showList :: [RegisterDomainResponse] -> ShowS #
Generic RegisterDomainResponse Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Associated Types type Rep RegisterDomainResponse :: Type -> Type # Methods from :: RegisterDomainResponse -> Rep RegisterDomainResponse x # to :: Rep RegisterDomainResponse x -> RegisterDomainResponse #
NFData RegisterDomainResponse Source #
Instance details Defined in Amazonka.SWF.RegisterDomain Methods rnf :: RegisterDomainResponse -> () #
type Rep RegisterDomainResponse Source #
Instance details Defined in Amazonka.SWF.RegisterDomain type Rep RegisterDomainResponse = D1 ('MetaData "RegisterDomainResponse" "Amazonka.SWF.RegisterDomain" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "RegisterDomainResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newRegisterDomainResponse :: RegisterDomainResponse Source #

Create a value of RegisterDomainResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.