AWS IoT Device Defender  v1.0.0
AWS IoT Device Defender Client Library
Constants

Constants defined in the AWS IoT Device Defender Client Library. More...

Macros

#define DEFENDER_THINGNAME_MAX_LENGTH   128U
 Maximum length of a thing's name as permitted by AWS IoT Core.
 
#define DEFENDER_REPORT_MIN_PERIOD_SECONDS   300
 Minimum period between 2 consecutive defender reports sent by the device. More...
 
#define DEFENDER_REPORT_HEADER_KEY   DEFENDER_REPORT_SELECT_KEY( "header", "hed" )
 "header" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_HEADER_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_HEADER_KEY )
 Length of the "header" key in the defender report.
 
#define DEFENDER_REPORT_METRICS_KEY   DEFENDER_REPORT_SELECT_KEY( "metrics", "met" )
 "metrics" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_METRICS_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_METRICS_KEY )
 Length of the "metrics" key in the defender report.
 
#define DEFENDER_REPORT_ID_KEY   DEFENDER_REPORT_SELECT_KEY( "report_id", "rid" )
 "report_id" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_ID_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_ID_KEY )
 Length of the "report_id" key in the defender report.
 
#define DEFENDER_REPORT_VERSION_KEY   DEFENDER_REPORT_SELECT_KEY( "version", "v" )
 "version" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_VERSION_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_VERSION_KEY )
 Length of the "version" key in the defender report.
 
#define DEFENDER_REPORT_TCP_CONNECTIONS_KEY   DEFENDER_REPORT_SELECT_KEY( "tcp_connections", "tc" )
 "tcp_connections" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_TCP_CONNECTIONS_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_TCP_CONNECTIONS_KEY )
 Length of the "tcp_connections" key in the defender report.
 
#define DEFENDER_REPORT_ESTABLISHED_CONNECTIONS_KEY   DEFENDER_REPORT_SELECT_KEY( "established_connections", "ec" )
 "established_connections" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_ESTABLISHED_CONNECTIONS_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_ESTABLISHED_CONNECTIONS_KEY )
 Length of the "established_connections" key in the defender report.
 
#define DEFENDER_REPORT_CONNECTIONS_KEY   DEFENDER_REPORT_SELECT_KEY( "connections", "cs" )
 "connections" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_CONNECTIONS_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_CONNECTIONS_KEY )
 Length of the "connections" key in the defender report.
 
#define DEFENDER_REPORT_REMOTE_ADDR_KEY   DEFENDER_REPORT_SELECT_KEY( "remote_addr", "rad" )
 "remote_addr" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_REMOTE_ADDR_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_REMOTE_ADDR_KEY )
 Length of the "remote_addr" key in the defender report.
 
#define DEFENDER_REPORT_LOCAL_PORT_KEY   DEFENDER_REPORT_SELECT_KEY( "local_port", "lp" )
 "local_port" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_LOCAL_PORT_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_LOCAL_PORT_KEY )
 Length of the "local_port" key in the defender report.
 
#define DEFENDER_REPORT_LOCAL_INTERFACE_KEY   DEFENDER_REPORT_SELECT_KEY( "local_interface", "li" )
 "local_interface" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_LOCAL_INTERFACE_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_LOCAL_INTERFACE_KEY )
 Length of the "local_interface" key in the defender report.
 
#define DEFENDER_REPORT_TOTAL_KEY   DEFENDER_REPORT_SELECT_KEY( "total", "t" )
 "total" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_TOTAL_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_TOTAL_KEY )
 Length of the "total" key in the defender report.
 
#define DEFENDER_REPORT_TCP_LISTENING_PORTS_KEY   DEFENDER_REPORT_SELECT_KEY( "listening_tcp_ports", "tp" )
 "listening_tcp_ports" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_TCP_LISTENING_PORTS_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_TCP_LISTENING_PORTS_KEY )
 Length of the "listening_tcp_ports" key in the defender report.
 
#define DEFENDER_REPORT_PORTS_KEY   DEFENDER_REPORT_SELECT_KEY( "ports", "pts" )
 "ports" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_PORTS_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_PORTS_KEY )
 Length of the "ports" key in the defender report.
 
#define DEFENDER_REPORT_PORT_KEY   DEFENDER_REPORT_SELECT_KEY( "port", "pt" )
 "port" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_PORT_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_PORT_KEY )
 Length of the "port" key in the defender report.
 
#define DEFENDER_REPORT_INTERFACE_KEY   DEFENDER_REPORT_SELECT_KEY( "interface", "if" )
 "interface" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_INTERFACE_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_INTERFACE_KEY )
 Length of the "interface" key in the defender report.
 
#define DEFENDER_REPORT_UDP_LISTENING_PORTS_KEY   DEFENDER_REPORT_SELECT_KEY( "listening_udp_ports", "up" )
 "listening_udp_ports" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_UDP_LISTENING_PORTS_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_UDP_LISTENING_PORTS_KEY )
 Length of the "listening_udp_ports" key in the defender report.
 
#define DEFENDER_REPORT_NETWORK_STATS_KEY   DEFENDER_REPORT_SELECT_KEY( "network_stats", "ns" )
 "network_stats" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_NETWORK_STATS_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_NETWORK_STATS_KEY )
 Length of the "network_stats" key in the defender report.
 
#define DEFENDER_REPORT_BYTES_IN_KEY   DEFENDER_REPORT_SELECT_KEY( "bytes_in", "bi" )
 "bytes_in" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_BYTES_IN_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_BYTES_IN_KEY )
 Length of the "bytes_in" key in the defender report.
 
#define DEFENDER_REPORT_BYTES_OUT_KEY   DEFENDER_REPORT_SELECT_KEY( "bytes_out", "bo" )
 "bytes_out" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_BYTES_OUT_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_BYTES_OUT_KEY )
 Length of the "bytes_out" key in the defender report.
 
#define DEFENDER_REPORT_PKTS_IN_KEY   DEFENDER_REPORT_SELECT_KEY( "packets_in", "pi" )
 "packets_in" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_PKTS_IN_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_PKTS_IN_KEY )
 Length of the "packets_in" key in the defender report.
 
#define DEFENDER_REPORT_PKTS_OUT_KEY   DEFENDER_REPORT_SELECT_KEY( "packets_out", "po" )
 "packets_out" key in the defender report.
 
#define DEFENDER_REPORT_LENGTH_PKS_OUT_KEY   STRING_LITERAL_LENGTH( DEFENDER_REPORT_LENGTH_PKS_OUT_KEY )
 Length of the "packets_out" key in the defender report.
 

Detailed Description

Constants defined in the AWS IoT Device Defender Client Library.

Macro Definition Documentation

◆ DEFENDER_REPORT_MIN_PERIOD_SECONDS

#define DEFENDER_REPORT_MIN_PERIOD_SECONDS   300

Minimum period between 2 consecutive defender reports sent by the device.

This is as per AWS IoT Device Defender Service reference.