update_topic_rule_destination

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

See also: AWS API Documentation

Request Syntax

response = client.update_topic_rule_destination(
    arn='string',
    status='ENABLED'|'IN_PROGRESS'|'DISABLED'|'ERROR'|'DELETING'
)
Parameters
  • arn (string) --

    [REQUIRED]

    The ARN of the topic rule destination.

  • status (string) --

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoT.Client.exceptions.InternalException
  • IoT.Client.exceptions.InvalidRequestException
  • IoT.Client.exceptions.ServiceUnavailableException
  • IoT.Client.exceptions.UnauthorizedException
  • IoT.Client.exceptions.ConflictingResourceUpdateException