IoT / Client / get_topic_rule_destination

get_topic_rule_destination#

IoT.Client.get_topic_rule_destination(**kwargs)#

Gets information about a topic rule destination.

Requires permission to access the GetTopicRuleDestination action.

See also: AWS API Documentation

Request Syntax

response = client.get_topic_rule_destination(
    arn='string'
)
Parameters:

arn (string) –

[REQUIRED]

The ARN of the topic rule destination.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • topicRuleDestination (dict) –

      The topic rule destination.

      • arn (string) –

        The topic rule destination URL.

      • 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) –

        Additional details or reason why the topic rule destination is in the current status.

      • httpUrlProperties (dict) –

        Properties of the HTTP URL.

        • confirmationUrl (string) –

          The URL used to confirm the HTTP topic rule destination URL.

      • vpcProperties (dict) –

        Properties of 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).

Exceptions