notifications

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

Overview

Name	notifications
Type	Resource
Id	aws.datazone.notifications

Fields

The following fields are returned by SELECT queries:

list_notifications

Name	Datatype	Description
action_link	string	The action link included in the notification.
creation_timestamp	string (date-time)	The timestamp of when a notification was created.
domain_identifier	string	The identifier of a Amazon DataZone domain in which the notification exists. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
identifier	string	The identifier of the notification. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
last_updated_timestamp	string (date-time)	The timestamp of when the notification was last updated.
message	string	The message included in the notification.
metadata	object	The metadata included in the notification.
status	string	The status included in the notification. (ACTIVE, INACTIVE)
title_	string	The title of the notification.
topic	object	The topic of the notification.
type_	string	The type of the notification. (TASK, EVENT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_notifications	select	domain_identifier, type, region	afterTimestamp, beforeTimestamp, subjects, taskStatus, maxResults, nextToken	Lists all Amazon DataZone notifications.

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
domain_identifier	string	The identifier of the Amazon DataZone domain.
region	string	AWS region (default: us-east-1)
type	string	The type of notifications.
afterTimestamp	string (date-time)	The time after which you want to list notifications.
beforeTimestamp	string (date-time)	The time before which you want to list notifications.
maxResults	integer	The maximum number of notifications to return in a single call to ListNotifications. When the number of notifications to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListNotifications to list the next set of notifications.
nextToken	string	When the number of notifications is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notifications, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotifications to list the next set of notifications.
subjects	array	The subjects of notifications.
taskStatus	string	The task status of notifications.

SELECT examples

list_notifications

Lists all Amazon DataZone notifications.

SELECT
action_link,
creation_timestamp,
domain_identifier,
identifier,
last_updated_timestamp,
message,
metadata,
status,
title_,
topic,
type_
FROM aws.datazone.notifications
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND type = '{{ type }}' -- required
AND region = '{{ region }}' -- required
AND afterTimestamp = '{{ afterTimestamp }}'
AND beforeTimestamp = '{{ beforeTimestamp }}'
AND subjects = '{{ subjects }}'
AND taskStatus = '{{ taskStatus }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;