list_destinations

list_destinations(**kwargs)

Lists the destinations registered to your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_destinations(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of results to return in this operation.
  • 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

{
    'NextToken': 'string',
    'DestinationList': [
        {
            'Arn': 'string',
            'Name': 'string',
            'ExpressionType': 'RuleName'|'MqttTopic',
            'Expression': 'string',
            'Description': 'string',
            'RoleArn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

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

    • DestinationList (list) --

      The list of destinations.

      • (dict) --

        Describes a destination.

        • Arn (string) --

          The Amazon Resource Name of the resource.

        • Name (string) --

          The name of the resource.

        • ExpressionType (string) --

          The type of value in Expression .

        • Expression (string) --

          The rule name or topic rule to send messages to.

        • Description (string) --

          The description of the resource.

        • RoleArn (string) --

          The ARN of the IAM Role that authorizes the destination.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException