resource_event_configurations
Creates, updates, deletes, gets or lists a resource_event_configurations resource.
Overview
| Name | resource_event_configurations |
| Type | Resource |
| Id | aws.iotwireless.resource_event_configurations |
Fields
The following fields are returned by SELECT queries:
- get_resource_event_configuration
| Name | Datatype | Description |
|---|---|---|
connection_status | object | Event configuration for the connection status event. |
device_registration_state | object | Event configuration for the device registration state event. |
join | object | Event configuration for the join event. |
message_delivery_status | object | Event configuration for the message delivery status event. |
proximity | object | Event configuration for the proximity event. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_resource_event_configuration | select | identifier, identifierType, region | partnerType | Get the event configuration for a particular resource identifier. |
update_resource_event_configuration | update | identifier, identifierType, region | partnerType | Update the event configuration for a particular resource identifier. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
identifier | string | Resource identifier to opt in for event messaging. |
identifierType | string | Identifier type of the particular resource identifier for event configuration. |
region | string | AWS region (default: us-east-1) |
partnerType | string | Partner type of the resource if the identifier type is PartnerAccountId |
SELECT examples
- get_resource_event_configuration
Get the event configuration for a particular resource identifier.
SELECT
connection_status,
device_registration_state,
join,
message_delivery_status,
proximity
FROM aws.iotwireless.resource_event_configurations
WHERE identifier = '{{ identifier }}' -- required
AND identifierType = '{{ identifierType }}' -- required
AND region = '{{ region }}' -- required
AND partnerType = '{{ partnerType }}'
;
UPDATE examples
- update_resource_event_configuration
Update the event configuration for a particular resource identifier.
UPDATE aws.iotwireless.resource_event_configurations
SET
DeviceRegistrationState = '{{ DeviceRegistrationState }}',
Proximity = '{{ Proximity }}',
Join = '{{ Join }}',
ConnectionStatus = '{{ ConnectionStatus }}',
MessageDeliveryStatus = '{{ MessageDeliveryStatus }}'
WHERE
identifier = '{{ identifier }}' --required
AND identifierType = '{{ identifierType }}' --required
AND region = '{{ region }}' --required
AND partnerType = '{{ partnerType}}';