:doc:`SWF <../../swf>` / Client / register_activity_type

**********************
register_activity_type
**********************



.. py:method:: SWF.Client.register_activity_type(**kwargs)

  

  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. 

    
    * ``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 <https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html>`__ in the *Amazon SWF Developer Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/swf-2012-01-25/RegisterActivityType>`_  


  **Request Syntax**
  ::

    response = client.register_activity_type(
        domain='string',
        name='string',
        version='string',
        description='string',
        defaultTaskStartToCloseTimeout='string',
        defaultTaskHeartbeatTimeout='string',
        defaultTaskList={
            'name': 'string'
        },
        defaultTaskPriority='string',
        defaultTaskScheduleToStartTimeout='string',
        defaultTaskScheduleToCloseTimeout='string'
    )
    
  :type domain: string
  :param domain: **[REQUIRED]** 

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

    

  
  :type name: string
  :param 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 ( ``\u0000-\u001f`` | ``\u007f-\u009f``). Also, it must *not* be the literal string ``arn``.

    

  
  :type version: string
  :param version: **[REQUIRED]** 

    The 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 contain a ``:`` (colon), ``/`` (slash), ``|`` (vertical bar), or any control characters ( ``\u0000-\u001f`` | ``\u007f-\u009f``). Also, it must *not* be the literal string ``arn``.

    

  
  :type description: string
  :param description: 

    A textual description of the activity type.

    

  
  :type defaultTaskStartToCloseTimeout: string
  :param 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.

    

  
  :type defaultTaskHeartbeatTimeout: string
  :param 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 ``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.

    

  
  :type defaultTaskList: dict
  :param 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.

    

  
    - **name** *(string) --* **[REQUIRED]** 

      The name of the task list.

      

    
  
  :type defaultTaskPriority: string
  :param 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 <https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html>`__ in the in the *Amazon SWF Developer Guide*..

    

  
  :type defaultTaskScheduleToStartTimeout: string
  :param 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.

    

  
  :type defaultTaskScheduleToCloseTimeout: string
  :param 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.

    

  
  
  :returns: None
  **Exceptions**
  
  *   :py:class:`SWF.Client.exceptions.TypeAlreadyExistsFault`

  
  *   :py:class:`SWF.Client.exceptions.LimitExceededFault`

  
  *   :py:class:`SWF.Client.exceptions.UnknownResourceFault`

  
  *   :py:class:`SWF.Client.exceptions.OperationNotPermittedFault`

  