Skip to content

List Notifications

datazone_list_notifications R Documentation

Lists all Amazon DataZone notifications

Description

Lists all Amazon DataZone notifications.

Usage

datazone_list_notifications(domainIdentifier, type, afterTimestamp,
  beforeTimestamp, subjects, taskStatus, maxResults, nextToken)

Arguments

domainIdentifier

[required] The identifier of the Amazon DataZone domain.

type

[required] The type of notifications.

afterTimestamp

The time after which you want to list notifications.

beforeTimestamp

The time before which you want to list notifications.

subjects

The subjects of notifications.

taskStatus

The task status of notifications.

maxResults

The maximum number of notifications to return in a single call to list_notifications. 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 list_notifications to list the next set of notifications.

nextToken

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 list_notifications to list the next set of notifications.

Value

A list with the following syntax:

list(
  notifications = list(
    list(
      identifier = "string",
      domainIdentifier = "string",
      type = "TASK"|"EVENT",
      topic = list(
        subject = "string",
        resource = list(
          type = "PROJECT",
          id = "string",
          name = "string"
        ),
        role = "PROJECT_OWNER"|"PROJECT_CONTRIBUTOR"|"PROJECT_VIEWER"|"DOMAIN_OWNER"|"PROJECT_SUBSCRIBER"
      ),
      title = "string",
      message = "string",
      status = "ACTIVE"|"INACTIVE",
      actionLink = "string",
      creationTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      metadata = list(
        "string"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_notifications(
  domainIdentifier = "string",
  type = "TASK"|"EVENT",
  afterTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  beforeTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  subjects = list(
    "string"
  ),
  taskStatus = "ACTIVE"|"INACTIVE",
  maxResults = 123,
  nextToken = "string"
)