
register-activity-type
**********************


DESCRIPTION
===========

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

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

* "--default-task-list" : String constraint. The key is
  "swf:defaultTaskList.name" .

* "--name" : String constraint. The key is "swf:name" .

* "--activity-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 .


SYNOPSIS
========

   aws swf register-activity-type
     --domain <value>
     --name <value>
     --activity-version <value>
     [--default-task-schedule-to-start-timeout <value>]
     [--default-task-heartbeat-timeout <value>]
     [--default-task-start-to-close-timeout <value>]
     [--default-task-schedule-to-close-timeout <value>]
     [--default-task-list <value>]
     [--description <value>]


REQUIRED PARAMETERS
===================

"--domain"  (string)
   The --name of the --domain in which this activity is to be
   registered.

"--name"  (string)
   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.

"--activity-version"  (string)
   The --activity-version of the activity type.

   Note: The activity type consists of the --name and version, the
     combination of which must be unique 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.


OPTIONAL PARAMETERS
===================

"--default-task-schedule-to-start-timeout"  (string)
   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 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.

"--default-task-heartbeat-timeout"  (string)
   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 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.

"--default-task-start-to-close-timeout"  (string)
   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 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.

"--default-task-schedule-to-close-timeout"  (string)
   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 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.

"--default-task-list"  (structure)
   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
   "ScheduleActivityTask"   Decision .

   "name"  (string)

   *Parameter Syntax*

      {
        "name": "string"
      }

"--description"  (string)
   A textual --description of the activity type.
