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

***********************
deprecate_activity_type
***********************



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

  

  Deprecates the specified *activity type*. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated continue to run.

   

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

    
    * ``activityType.name``: String constraint. The key is ``swf:activityType.name``.
     
    * ``activityType.version``: String constraint. The key is ``swf:activityType.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/DeprecateActivityType>`_  


  **Request Syntax**
  ::

    response = client.deprecate_activity_type(
        domain='string',
        activityType={
            'name': 'string',
            'version': 'string'
        }
    )
    
  :type domain: string
  :param domain: **[REQUIRED]** 

    The name of the domain in which the activity type is registered.

    

  
  :type activityType: dict
  :param activityType: **[REQUIRED]** 

    The activity type to deprecate.

    

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

      The name of this activity.

       

      .. note::

        

        The combination of activity type name and version must be unique within a domain.

        

      

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

      The version of this activity.

       

      .. note::

        

        The combination of activity type name and version must be unique with in a domain.

        

      

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

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

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

  