:doc:`IoT <../../iot>` / Client / update_topic_rule_destination

*****************************
update_topic_rule_destination
*****************************



.. py:method:: IoT.Client.update_topic_rule_destination(**kwargs)

  

  Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.

   

  Requires permission to access the `UpdateTopicRuleDestination <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`__ action.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/UpdateTopicRuleDestination>`_  


  **Request Syntax**
  ::

    response = client.update_topic_rule_destination(
        arn='string',
        status='ENABLED'|'IN_PROGRESS'|'DISABLED'|'ERROR'|'DELETING'
    )
    
  :type arn: string
  :param arn: **[REQUIRED]** 

    The ARN of the topic rule destination.

    

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

    The status of the topic rule destination. Valid values are:

      IN_PROGRESS  

    A topic rule destination was created but has not been confirmed. You can set ``status`` to ``IN_PROGRESS`` by calling ``UpdateTopicRuleDestination``. Calling ``UpdateTopicRuleDestination`` causes a new confirmation challenge to be sent to your confirmation endpoint.

      ENABLED  

    Confirmation was completed, and traffic to this destination is allowed. You can set ``status`` to ``DISABLED`` by calling ``UpdateTopicRuleDestination``.

      DISABLED  

    Confirmation was completed, and traffic to this destination is not allowed. You can set ``status`` to ``ENABLED`` by calling ``UpdateTopicRuleDestination``.

      ERROR  

    Confirmation could not be completed, for example if the confirmation timed out. You can call ``GetTopicRuleDestination`` for details about the error. You can set ``status`` to ``IN_PROGRESS`` by calling ``UpdateTopicRuleDestination``. Calling ``UpdateTopicRuleDestination`` causes a new confirmation challenge to be sent to your confirmation endpoint.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`IoT.Client.exceptions.InternalException`

  
  *   :py:class:`IoT.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoT.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`IoT.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`IoT.Client.exceptions.ConflictingResourceUpdateException`

  