amazonka-swf- Amazon Simple Workflow Service SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <>
Portabilitynon-portable (GHC extensions)
Safe HaskellNone




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

See: AWS API Reference for RegisterDomain.


Creating a Request

registerDomain Source

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:

Request Lenses

rdDescription :: Lens' RegisterDomain (Maybe Text) Source

A text description of the domain.

rdName :: 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 contain the literal string quotarnquot.

rdWorkflowExecutionRetentionPeriodInDays :: 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 is not available in the results of visibility calls.

If you pass the value NONE or '0' (zero), then the workflow execution history will not be 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 Source

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