notification_configurations

Creates, updates, deletes, gets or lists a notification_configurations resource.

Overview

Name	notification_configurations
Type	Resource
Id	aws.iot_managed_integrations.notification_configurations

Fields

The following fields are returned by SELECT queries:

get_notification_configuration

Name	Datatype	Description
created_at	string (date-time)	The timestamp value of when the notification configuration was created.
destination_name	string	The name of the destination for the notification configuration. (pattern: <code>[\p{L}\p{N} ._-]+</code>)
event_type	string	The type of event triggering a device notification to the customer-managed destination. (DEVICE_COMMAND, DEVICE_COMMAND_REQUEST, DEVICE_DISCOVERY_STATUS, DEVICE_EVENT, DEVICE_LIFE_CYCLE, DEVICE_STATE, DEVICE_OTA, DEVICE_WSS, CONNECTOR_ASSOCIATION, ACCOUNT_ASSOCIATION, CONNECTOR_ERROR_REPORT)
tags	object	A set of key/value pairs that are used to manage the notification configuration.
updated_at	string (date-time)	The timestamp value of when the notification configuration was last updated.

list_notification_configurations

Name	Datatype	Description
destination_name	string	The name of the destination for the notification configuration. (pattern: <code>[\p{L}\p{N} ._-]+</code>)
event_type	string	The type of event triggering a device notification to the customer-managed destination. (DEVICE_COMMAND, DEVICE_COMMAND_REQUEST, DEVICE_DISCOVERY_STATUS, DEVICE_EVENT, DEVICE_LIFE_CYCLE, DEVICE_STATE, DEVICE_OTA, DEVICE_WSS, CONNECTOR_ASSOCIATION, ACCOUNT_ASSOCIATION, CONNECTOR_ERROR_REPORT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_notification_configuration	select	event_type, region		Get a notification configuration for a specified event type.
list_notification_configurations	select	region	MaxResults, NextToken	List all notification configurations.
create_notification_configuration	insert	region, EventType, DestinationName		Creates a notification configuration. A configuration is a connection between an event type and a destination that you have already created.
update_notification_configuration	update	event_type, region, DestinationName		Update a notification configuration.
delete_notification_configuration	delete	event_type, region		Deletes a notification configuration.

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
event_type	string	The type of event triggering a device notification to the customer-managed destination.
region	string	AWS region (default: us-east-1)
MaxResults	integer	The maximum number of results to return at one time.
NextToken	string	A token that can be used to retrieve the next set of results.

SELECT examples

get_notification_configuration

Get a notification configuration for a specified event type.

SELECT
created_at,
destination_name,
event_type,
tags,
updated_at
FROM aws.iot_managed_integrations.notification_configurations
WHERE event_type = '{{ event_type }}' -- required
AND region = '{{ region }}' -- required
;

list_notification_configurations

List all notification configurations.

SELECT
destination_name,
event_type
FROM aws.iot_managed_integrations.notification_configurations
WHERE region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_notification_configuration

Creates a notification configuration. A configuration is a connection between an event type and a destination that you have already created.

INSERT INTO aws.iot_managed_integrations.notification_configurations (
EventType,
DestinationName,
ClientToken,
Tags,
region
)
SELECT 
'{{ EventType }}' /* required */,
'{{ DestinationName }}' /* required */,
'{{ ClientToken }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
event_type
;

Manifest

# Description fields are for documentation purposes
- name: notification_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the notification_configurations resource.
  - name: EventType
    value: "{{ EventType }}"
    valid_values: ['DEVICE_COMMAND', 'DEVICE_COMMAND_REQUEST', 'DEVICE_DISCOVERY_STATUS', 'DEVICE_EVENT', 'DEVICE_LIFE_CYCLE', 'DEVICE_STATE', 'DEVICE_OTA', 'DEVICE_WSS', 'CONNECTOR_ASSOCIATION', 'ACCOUNT_ASSOCIATION', 'CONNECTOR_ERROR_REPORT']
  - name: DestinationName
    value: "{{ DestinationName }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_notification_configuration

Update a notification configuration.

UPDATE aws.iot_managed_integrations.notification_configurations
SET 
DestinationName = '{{ DestinationName }}'
WHERE 
event_type = '{{ event_type }}' --required
AND region = '{{ region }}' --required
AND DestinationName = '{{ DestinationName }}' --required;

DELETE examples

delete_notification_configuration

Deletes a notification configuration.

DELETE FROM aws.iot_managed_integrations.notification_configurations
WHERE event_type = '{{ event_type }}' --required
AND region = '{{ region }}' --required
;