list_topic_rule_destinations

list_topic_rule_destinations(**kwargs)

Lists all the topic rule destinations in your Amazon Web Services account.

Requires permission to access the ListTopicRuleDestinations action.

See also: AWS API Documentation

Request Syntax

response = client.list_topic_rule_destinations(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results to return at one time.
  • nextToken (string) -- To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
Return type

dict

Returns

Response Syntax

{
    'destinationSummaries': [
        {
            'arn': 'string',
            'status': 'ENABLED'|'IN_PROGRESS'|'DISABLED'|'ERROR'|'DELETING',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'statusReason': 'string',
            'httpUrlSummary': {
                'confirmationUrl': 'string'
            },
            'vpcDestinationSummary': {
                'subnetIds': [
                    'string',
                ],
                'securityGroups': [
                    'string',
                ],
                'vpcId': 'string',
                'roleArn': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • destinationSummaries (list) --

      Information about a topic rule destination.

      • (dict) --

        Information about the topic rule destination.

        • arn (string) --

          The topic rule destination ARN.

        • status (string) --

          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.

        • createdAt (datetime) --

          The date and time when the topic rule destination was created.

        • lastUpdatedAt (datetime) --

          The date and time when the topic rule destination was last updated.

        • statusReason (string) --

          The reason the topic rule destination is in the current status.

        • httpUrlSummary (dict) --

          Information about the HTTP URL.

          • confirmationUrl (string) --

            The URL used to confirm ownership of or access to the HTTP topic rule destination URL.

        • vpcDestinationSummary (dict) --

          Information about the virtual private cloud (VPC) connection.

          • subnetIds (list) --

            The subnet IDs of the VPC destination.

            • (string) --
          • securityGroups (list) --

            The security groups of the VPC destination.

            • (string) --
          • vpcId (string) --

            The ID of the VPC.

          • roleArn (string) --

            The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).

    • nextToken (string) --

      The token to use to get the next set of results, or null if there are no additional results.

Exceptions

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