notification_hubs

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

Overview

Name	notification_hubs
Type	Resource
Id	aws.notifications.notification_hubs

Fields

The following fields are returned by SELECT queries:

list_notification_hubs

Name	Datatype	Description
creation_time	string (date-time)	The date and time the NotificationHubOverview was created.
last_activation_time	string (date-time)	The most recent time this NotificationHub had an ACTIVE status.
notification_hub_region	string	The Region of the resource. (pattern: <code>([a-z]{1,2})-([a-z]{1,15}-)+([0-9])</code>)
status_summary	object	The status summary of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_notification_hubs	select	region	maxResults, nextToken	Returns a list of NotificationHubs.
register_notification_hub	insert	region, notificationHubRegion		Registers a NotificationConfiguration in the specified Region. There is a maximum of one NotificationConfiguration per Region. You can have a maximum of 3 NotificationHub resources at a time.
deregister_notification_hub	delete	notification_hub_region, region		Deregisters a NotificationConfiguration in the specified Region. You can't deregister the last NotificationHub in the account. NotificationEvents stored in the deregistered NotificationConfiguration are no longer be visible. Recreating a new NotificationConfiguration in the same Region restores access to those NotificationEvents.

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
notification_hub_region	string	The NotificationConfiguration Region.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of records to list in a single response.
nextToken	string	A pagination token. Set to null to start listing notification hubs from the start.

SELECT examples

list_notification_hubs

Returns a list of NotificationHubs.

SELECT
creation_time,
last_activation_time,
notification_hub_region,
status_summary
FROM aws.notifications.notification_hubs
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

register_notification_hub

Registers a NotificationConfiguration in the specified Region. There is a maximum of one NotificationConfiguration per Region. You can have a maximum of 3 NotificationHub resources at a time.

INSERT INTO aws.notifications.notification_hubs (
notificationHubRegion,
region
)
SELECT 
'{{ notificationHubRegion }}' /* required */,
'{{ region }}'
RETURNING
creation_time,
last_activation_time,
notification_hub_region,
status_summary
;

Manifest

# Description fields are for documentation purposes
- name: notification_hubs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the notification_hubs resource.
  - name: notificationHubRegion
    value: "{{ notificationHubRegion }}"

DELETE examples

deregister_notification_hub

Deregisters a NotificationConfiguration in the specified Region. You can't deregister the last NotificationHub in the account. NotificationEvents stored in the deregistered NotificationConfiguration are no longer be visible. Recreating a new NotificationConfiguration in the same Region restores access to those NotificationEvents.

DELETE FROM aws.notifications.notification_hubs
WHERE notification_hub_region = '{{ notification_hub_region }}' --required
AND region = '{{ region }}' --required
;