IoTWireless / Client / list_event_configurations

list_event_configurations

IoTWireless.Client.list_event_configurations(**kwargs)

List event configurations where at least one event topic has been enabled.

See also: AWS API Documentation

Request Syntax

response = client.list_event_configurations(
    ResourceType='FuotaTask'|'SidewalkAccount'|'WirelessDevice'|'WirelessGateway',
    MaxResults=123,
    NextToken='string'
)

Parameters:

• ResourceType (string) –

  [REQUIRED]

  Resource type to filter event configurations.

• 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',
    'EventConfigurationsList': [
        {
            'Identifier': 'string',
            'IdentifierType': 'PartnerAccountId'|'DevEui'|'FuotaTaskId'|'GatewayEui'|'WirelessDeviceId'|'WirelessGatewayId',
            'PartnerType': 'Sidewalk',
            'Events': {
                '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) –

  • 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.

  • EventConfigurationsList (list) –

    Event configurations of all events for a single resource.

    • (dict) –

      Event configuration object for a single resource.

      • Identifier (string) –

        Resource identifier opted in for event messaging.

      • IdentifierType (string) –

        Identifier type of the particular resource identifier for event configuration.

      • PartnerType (string) –

        Partner type of the resource if the identifier type is PartnerAccountId.

      • Events (dict) –

        Object of all event configurations and the status of the event topics.

        • DeviceRegistrationState (dict) –

          Device registration state event configuration for an event configuration item.

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

          Proximity event configuration for an event configuration item.

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

          Join event configuration for an event configuration item.

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

          Connection status event configuration for an event configuration item.

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

          Message delivery status event configuration for an event configuration item.

          • 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

• IoTWireless.Client.exceptions.ValidationException

• IoTWireless.Client.exceptions.AccessDeniedException

• IoTWireless.Client.exceptions.ThrottlingException

• IoTWireless.Client.exceptions.InternalServerException