Registers a new activity type along with its configuration settings in the specified domain.
IMPORTANT: A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, 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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
C# |
public class RegisterActivityTypeRequest : AmazonWebServiceRequest
All Members | Constructors | Methods | Properties | ||
Icon | Member | Description | ||
---|---|---|---|---|
RegisterActivityTypeRequest()()()() | Initializes a new instance of the RegisterActivityTypeRequest class | |||
DefaultTaskHeartbeatTimeout |
If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling
RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden
when scheduling an activity task using the ScheduleActivityTaskDecision. If the activity worker subsequently attempts to
record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer
considers the activity task to be valid; the activity worker should clean up the activity task. The valid values are integers greater than
or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited
duration.
Constraints: | |||
DefaultTaskList |
If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list is
not provided when a task is scheduled through the ScheduleActivityTaskDecision.
| |||
DefaultTaskScheduleToCloseTimeout |
If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity
task using the ScheduleActivityTaskDecision. The valid values are integers greater than or equal to 0. An integer
value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
Constraints: | |||
DefaultTaskScheduleToStartTimeout |
If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default
can be overridden when scheduling an activity task using the ScheduleActivityTaskDecision. The valid values are integers
greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify
unlimited duration.
Constraints: | |||
DefaultTaskStartToCloseTimeout |
If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden
when scheduling an activity task using the ScheduleActivityTaskDecision. The valid values are integers greater than or equal
to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.
Constraints: | |||
Description |
A textual description of the activity type.
Constraints: | |||
Domain |
The name of the domain in which this activity is to be registered.
Constraints: | |||
Equals(Object) | (Inherited from Object.) | |||
GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) | |||
GetType()()()() | Gets the type of the current instance. (Inherited from Object.) | |||
Name |
The name of the activity type within the domain. 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".
Constraints: | |||
ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) | |||
Version |
The version of the activity type.
Constraints: | |||
WithDefaultTaskHeartbeatTimeout(String) | Obsolete.
Sets the DefaultTaskHeartbeatTimeout property
| |||
WithDefaultTaskList(TaskList) | Obsolete.
Sets the DefaultTaskList property
| |||
WithDefaultTaskScheduleToCloseTimeout(String) | Obsolete.
Sets the DefaultTaskScheduleToCloseTimeout property
| |||
WithDefaultTaskScheduleToStartTimeout(String) | Obsolete.
Sets the DefaultTaskScheduleToStartTimeout property
| |||
WithDefaultTaskStartToCloseTimeout(String) | Obsolete.
Sets the DefaultTaskStartToCloseTimeout property
| |||
WithDescription(String) | Obsolete.
Sets the Description property
| |||
WithDomain(String) | Obsolete.
Sets the Domain property
| |||
WithName(String) | Obsolete.
Sets the Name property
| |||
WithVersion(String) | Obsolete.
Sets the Version property
|
Object | ||
AmazonWebServiceRequest | ||
RegisterActivityTypeRequest |