managed_notification_configurations

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

Overview

Name	managed_notification_configurations
Type	Resource
Id	aws.notifications.managed_notification_configurations

Fields

The following fields are returned by SELECT queries:

get_managed_notification_configuration

Name	Datatype	Description
name	string	The name of the ManagedNotificationConfiguration. (pattern: <code>[A-Za-z0-9-]+</code>)
arn	string	The ARN of the ManagedNotificationConfiguration resource. (pattern: <code>arn:[-.a-z0-9]{1,63}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9-]{3,64}/sub-category/[a-zA-Z0-9-]{3,64}</code>)
category	string	The category of the ManagedNotificationConfiguration.
description	string	The description of the ManagedNotificationConfiguration. (pattern: <code>[^\u0001-\u001F\u007F-\u009F]*</code>)
sub_category	string	The subCategory of the ManagedNotificationConfiguration.

list_managed_notification_configurations

Name	Datatype	Description
name	string	The name of the ManagedNotificationConfiguration. (pattern: <code>[A-Za-z0-9-]+</code>)
arn	string	The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration. (pattern: <code>arn:[-.a-z0-9]{1,63}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9-]{3,64}/sub-category/[a-zA-Z0-9-]{3,64}</code>)
description	string	The description of the ManagedNotificationConfiguration. (pattern: <code>[^\u0001-\u001F\u007F-\u009F]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_managed_notification_configuration	select	arn, region		Returns a specified ManagedNotificationConfiguration.
list_managed_notification_configurations	select	region	channelIdentifier, maxResults, nextToken	Returns a list of Managed Notification Configurations according to specified filters, ordered by creation time in reverse chronological order (newest first).
associate_managed_notification_account_contact	update	contact_identifier, region, managedNotificationConfigurationArn		Associates an Account Contact with a particular ManagedNotificationConfiguration.
disassociate_managed_notification_account_contact	exec	contact_identifier, region, managedNotificationConfigurationArn		Disassociates an Account Contact with a particular ManagedNotificationConfiguration.

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 ManagedNotificationConfiguration to return.
contact_identifier	string	The unique value of an Account Contact Type to associate with the ManagedNotificationConfiguration.
region	string	AWS region (default: us-east-1)
channelIdentifier	string	The identifier or ARN of the notification channel to filter configurations by.
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 ListManagedNotificationChannelAssociations call. Next token uses Base64 encoding.

SELECT examples

get_managed_notification_configuration

Returns a specified ManagedNotificationConfiguration.

SELECT
name,
arn,
category,
description,
sub_category
FROM aws.notifications.managed_notification_configurations
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
;

list_managed_notification_configurations

Returns a list of Managed Notification Configurations according to specified filters, ordered by creation time in reverse chronological order (newest first).

SELECT
name,
arn,
description
FROM aws.notifications.managed_notification_configurations
WHERE region = '{{ region }}' -- required
AND channelIdentifier = '{{ channelIdentifier }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

associate_managed_notification_account_contact

Associates an Account Contact with a particular ManagedNotificationConfiguration.

UPDATE aws.notifications.managed_notification_configurations
SET 
managedNotificationConfigurationArn = '{{ managedNotificationConfigurationArn }}'
WHERE 
contact_identifier = '{{ contact_identifier }}' --required
AND region = '{{ region }}' --required
AND managedNotificationConfigurationArn = '{{ managedNotificationConfigurationArn }}' --required;

Lifecycle Methods

disassociate_managed_notification_account_contact

Disassociates an Account Contact with a particular ManagedNotificationConfiguration.

EXEC aws.notifications.managed_notification_configurations.disassociate_managed_notification_account_contact 
@contact_identifier='{{ contact_identifier }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"managedNotificationConfigurationArn": "{{ managedNotificationConfigurationArn }}"
}'
;