get_destination

IoTWireless.Client.get_destination(**kwargs)

Gets information about a destination.

See also: AWS API Documentation

Request Syntax

response = client.get_destination(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the resource to get.

Return type
dict
Returns
Response Syntax
{
    'Arn': 'string',
    'Name': 'string',
    'Expression': 'string',
    'ExpressionType': 'RuleName'|'MqttTopic',
    'Description': 'string',
    'RoleArn': 'string'
}

Response Structure

  • (dict) --
    • Arn (string) --

      The Amazon Resource Name of the resource.

    • Name (string) --

      The name of the resource.

    • Expression (string) --

      The rule name or topic rule to send messages to.

    • ExpressionType (string) --

      The type of value in Expression .

    • 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.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException