Skip to contents

Registers a new activity type along with its configuration settings in the specified domain

Source: R/swf_operations.R
swf_register_activity_type.Rd

Registers a new activity type along with its configuration settings in the specified domain.

See https://www.paws-r-sdk.com/docs/swf_register_activity_type/ for full documentation.

Usage

swf_register_activity_type(
  domain,
  name,
  version,
  description = NULL,
  defaultTaskStartToCloseTimeout = NULL,
  defaultTaskHeartbeatTimeout = NULL,
  defaultTaskList = NULL,
  defaultTaskPriority = NULL,
  defaultTaskScheduleToStartTimeout = NULL,
  defaultTaskScheduleToCloseTimeout = NULL
)

Arguments

domain

[required] The name of the domain in which this activity is to be registered.

name

[required] The name of the activity type within the domain.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (U+0000`-`U+001f | U+007f`-`U+009f). Also, it must not be the literal string arn.

version

[required] The version of the activity type.

The activity type consists of the name and version, the combination of which must be unique within the domain.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (U+0000`-`U+001f | U+007f`-`U+009f). Also, it must not be the literal string arn.

description

A textual description of the activity type.

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

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

defaultTaskHeartbeatTimeout

If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling record_activity_task_heartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. 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 duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

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 isn't provided when a task is scheduled through the ScheduleActivityTask Decision.

defaultTaskPriority

The default task priority to assign to the activity type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the in the Amazon SWF Developer Guide..

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

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

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

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.