IoTWireless / Client / get_resource_event_configuration

get_resource_event_configuration#

IoTWireless.Client.get_resource_event_configuration(**kwargs)#

Get the event configuration for a particular resource identifier.

See also: AWS API Documentation

Request Syntax

response = client.get_resource_event_configuration(
    Identifier='string',
    IdentifierType='PartnerAccountId'|'DevEui'|'FuotaTaskId'|'GatewayEui'|'WirelessDeviceId'|'WirelessGatewayId',
    PartnerType='Sidewalk'
)
Parameters:

  • Identifier (string) –

    [REQUIRED]

    Resource identifier to opt in for event messaging.

  • IdentifierType (string) –

    [REQUIRED]

    Identifier type of the particular resource identifier for event configuration.

  • PartnerType (string) – Partner type of the resource if the identifier type is PartnerAccountId.

Return type:

dict

Returns:

Response Syntax

{
    'DeviceRegistrationState': {
        'Sidewalk': {
            'AmazonIdEventTopic': 'Enabled'|'Disabled'
        },
        'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
    },
    'Proximity': {
        'Sidewalk': {
            'AmazonIdEventTopic': 'Enabled'|'Disabled'
        },
        'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
    },
    'Join': {
        'LoRaWAN': {
            'DevEuiEventTopic': 'Enabled'|'Disabled'
        },
        'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
    },
    'ConnectionStatus': {
        'LoRaWAN': {
            'GatewayEuiEventTopic': 'Enabled'|'Disabled'
        },
        'WirelessGatewayIdEventTopic': 'Enabled'|'Disabled'
    },
    'MessageDeliveryStatus': {
        'Sidewalk': {
            'AmazonIdEventTopic': 'Enabled'|'Disabled'
        },
        'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
    }
}

Response Structure

  • (dict) –

    • DeviceRegistrationState (dict) –

      Event configuration for the device registration state event.

      • Sidewalk (dict) –

        Device registration state event configuration object for enabling or disabling Sidewalk related event topics.

        • AmazonIdEventTopic (string) –

          Denotes whether the Amazon ID event topic is enabled or disabled.

      • WirelessDeviceIdEventTopic (string) –

        Denotes whether the wireless device ID device registration state event topic is enabled or disabled.

    • Proximity (dict) –

      Event configuration for the proximity event.

      • Sidewalk (dict) –

        Proximity event configuration object for enabling or disabling Sidewalk related event topics.

        • AmazonIdEventTopic (string) –

          Denotes whether the Amazon ID event topic is enabled or disabled.

      • WirelessDeviceIdEventTopic (string) –

        Denotes whether the wireless device ID proximity event topic is enabled or disabled.

    • Join (dict) –

      Event configuration for the join event.

      • LoRaWAN (dict) –

        Join event configuration object for enabling or disabling LoRaWAN related event topics.

        • DevEuiEventTopic (string) –

          Denotes whether the Dev EUI join event topic is enabled or disabled.

      • WirelessDeviceIdEventTopic (string) –

        Denotes whether the wireless device ID join event topic is enabled or disabled.

    • ConnectionStatus (dict) –

      Event configuration for the connection status event.

      • LoRaWAN (dict) –

        Connection status event configuration object for enabling or disabling LoRaWAN related event topics.

        • GatewayEuiEventTopic (string) –

          Denotes whether the gateway EUI connection status event topic is enabled or disabled.

      • WirelessGatewayIdEventTopic (string) –

        Denotes whether the wireless gateway ID connection status event topic is enabled or disabled.

    • MessageDeliveryStatus (dict) –

      Event configuration for the message delivery status event.

      • Sidewalk (dict) –

        SidewalkEventNotificationConfigurations object, which is the event configuration object for Sidewalk-related event topics.

        • AmazonIdEventTopic (string) –

          Denotes whether the Amazon ID event topic is enabled or disabled.

      • WirelessDeviceIdEventTopic (string) –

        Denotes whether the wireless device ID message delivery status event topic is enabled or disabled.

Exceptions