AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Registers a new workflow type and its configuration settings in the specified domain.
The retention period for the workflow history is set by the RegisterDomain action.
If the type already exists, then a TypeAlreadyExists
fault is returned. You
cannot change the configuration settings of a workflow type once it is registered
and it must be registered as a new version.
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.
Constrain the following parameters by using a Condition
element with the appropriate
keys.
defaultTaskList.name
: String constraint. The key is swf:defaultTaskList.name
.
name
: String constraint. The key is swf:name
.
version
: String constraint. The key is swf:version
.
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginRegisterWorkflowType and EndRegisterWorkflowType.
Namespace: Amazon.SimpleWorkflow
Assembly: AWSSDK.SimpleWorkflow.dll
Version: 3.x.y.z
public abstract Task<RegisterWorkflowTypeResponse> RegisterWorkflowTypeAsync( RegisterWorkflowTypeRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the RegisterWorkflowType service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Exception | Condition |
---|---|
LimitExceededException | Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS. |
OperationNotPermittedException | Returned when the caller doesn't have sufficient permissions to invoke the action. |
TypeAlreadyExistsException | Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered. |
UnknownResourceException | Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5