registerDomain method
- required String name,
- required String workflowExecutionRetentionPeriodInDays,
- String? description,
- List<
ResourceTag> ? tags,
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.
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.
May throw DomainAlreadyExistsFault. May throw LimitExceededFault. May throw OperationNotPermittedFault. May throw TooManyTagsFault.
Parameter 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
.
Parameter 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.
Parameter description
:
A text description of the domain.
Parameter tags
:
Tags to be added when registering a domain.
Tags may only contain unicode letters, digits, whitespace, or these
symbols: _ . : / = + - @
.
Implementation
Future<void> registerDomain({
required String name,
required String workflowExecutionRetentionPeriodInDays,
String? description,
List<ResourceTag>? tags,
}) async {
ArgumentError.checkNotNull(name, 'name');
_s.validateStringLength(
'name',
name,
1,
256,
isRequired: true,
);
ArgumentError.checkNotNull(workflowExecutionRetentionPeriodInDays,
'workflowExecutionRetentionPeriodInDays');
_s.validateStringLength(
'workflowExecutionRetentionPeriodInDays',
workflowExecutionRetentionPeriodInDays,
1,
8,
isRequired: true,
);
_s.validateStringLength(
'description',
description,
0,
1024,
);
final headers = <String, String>{
'Content-Type': 'application/x-amz-json-1.0',
'X-Amz-Target': 'SimpleWorkflowService.RegisterDomain'
};
await _protocol.send(
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
// TODO queryParams
headers: headers,
payload: {
'name': name,
'workflowExecutionRetentionPeriodInDays':
workflowExecutionRetentionPeriodInDays,
if (description != null) 'description': description,
if (tags != null) 'tags': tags,
},
);
}