notification_configurations

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

Overview

Name	notification_configurations
Type	Resource
Id	aws.notifications.notification_configurations

Fields

The following fields are returned by SELECT queries:

get_notification_configuration

Name	Datatype	Description
name	string	The name of the NotificationConfiguration. (pattern: <code>[A-Za-z0-9_-]+</code>)
aggregation_duration	string	The aggregation preference of the NotificationConfiguration. Values: LONG Aggregate notifications for long periods of time (12 hours). SHORT Aggregate notifications for short periods of time (5 minutes). NONE Don't aggregate notifications. (LONG, SHORT, NONE)
arn	string	The ARN of the resource. (pattern: <code>arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}</code>)
creation_time	string (date-time)	The creation time of the NotificationConfiguration.
description	string	The description of the NotificationConfiguration. (pattern: <code>[^\u0001-\u001F\u007F-\u009F]*</code>)
status	string	The status of this NotificationConfiguration. (ACTIVE, PARTIALLY_ACTIVE, INACTIVE, DELETING)
subtype	string	The subtype of the notification configuration returned in the response. (ACCOUNT, ADMIN_MANAGED)

list_notification_configurations

Name	Datatype	Description
name	string	The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters. (pattern: <code>[A-Za-z0-9_-]+</code>)
aggregation_duration	string	The aggregation preference of the NotificationConfiguration. Values: LONG Aggregate notifications for long periods of time (12 hours). SHORT Aggregate notifications for short periods of time (5 minutes). NONE Don't aggregate notifications. (LONG, SHORT, NONE)
arn	string	The Amazon Resource Name (ARN) of the NotificationConfiguration resource. (pattern: <code>arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}</code>)
creation_time	string (date-time)	The creation time of the NotificationConfiguration.
description	string	The description of the NotificationConfiguration. (pattern: <code>[^\u0001-\u001F\u007F-\u009F]*</code>)
status	string	The current status of the NotificationConfiguration. (ACTIVE, PARTIALLY_ACTIVE, INACTIVE, DELETING)
subtype	string	The subtype of the notification configuration. (ACCOUNT, ADMIN_MANAGED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_notification_configuration	select	arn, region		Returns a specified NotificationConfiguration.
list_notification_configurations	select	region	eventRuleSource, channelArn, status, subtype, maxResults, nextToken	Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).
create_notification_configuration	insert	region, name, description		Creates a new NotificationConfiguration.
update_notification_configuration	update	arn, region		Updates a NotificationConfiguration.
delete_notification_configuration	delete	arn, region		Deletes a NotificationConfiguration.

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
arn	string	The Amazon Resource Name (ARN) of the NotificationConfiguration to delete.
region	string	AWS region (default: us-east-1)
channelArn	string	The Amazon Resource Name (ARN) of the Channel to match.
eventRuleSource	string	The matched event source. Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.
maxResults	integer	The maximum number of results to be returned in this call. Defaults to 20.
nextToken	string	The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.
status	string	The NotificationConfiguration status to match. Values: ACTIVE All EventRules are ACTIVE and any call can be run. PARTIALLY_ACTIVE Some EventRules are ACTIVE and some are INACTIVE. Any call can be run. Any call can be run. INACTIVE All EventRules are INACTIVE and any call can be run. DELETING This NotificationConfiguration is being deleted. Only GET and LIST calls can be run.
subtype	string	The subtype used to filter the notification configurations in the request.

SELECT examples

get_notification_configuration

Returns a specified NotificationConfiguration.

SELECT
name,
aggregation_duration,
arn,
creation_time,
description,
status,
subtype
FROM aws.notifications.notification_configurations
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
;

list_notification_configurations

Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).

SELECT
name,
aggregation_duration,
arn,
creation_time,
description,
status,
subtype
FROM aws.notifications.notification_configurations
WHERE region = '{{ region }}' -- required
AND eventRuleSource = '{{ eventRuleSource }}'
AND channelArn = '{{ channelArn }}'
AND status = '{{ status }}'
AND subtype = '{{ subtype }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_notification_configuration

Creates a new NotificationConfiguration.

INSERT INTO aws.notifications.notification_configurations (
name,
description,
aggregationDuration,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}' /* required */,
'{{ aggregationDuration }}',
'{{ tags }}',
'{{ region }}'
RETURNING
arn,
status
;

Manifest

# Description fields are for documentation purposes
- name: notification_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the notification_configurations resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: aggregationDuration
    value: "{{ aggregationDuration }}"
    valid_values: ['LONG', 'SHORT', 'NONE']
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_notification_configuration

Updates a NotificationConfiguration.

UPDATE aws.notifications.notification_configurations
SET 
name = '{{ name }}',
description = '{{ description }}',
aggregationDuration = '{{ aggregationDuration }}'
WHERE 
arn = '{{ arn }}' --required
AND region = '{{ region }}' --required
RETURNING
arn;

DELETE examples

delete_notification_configuration

Deletes a NotificationConfiguration.

DELETE FROM aws.notifications.notification_configurations
WHERE arn = '{{ arn }}' --required
AND region = '{{ region }}' --required
;