[ aws . auditmanager ]

list-notifications

Description

Returns a list of all Audit Manager notifications.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-notifications
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--next-token (string)

The pagination token that’s used to fetch the next set of results.

--max-results (integer)

Represents the maximum number of results on a page or for an API request call.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

notifications -> (list)

The returned list of notifications.

(structure)

The notification that informs a user of an update in Audit Manager. For example, this includes the notification that’s sent when a control set is delegated for review.

id -> (string)

The unique identifier for the notification.

assessmentId -> (string)

The identifier for the assessment.

assessmentName -> (string)

The name of the related assessment.

controlSetId -> (string)

The identifier for the control set.

controlSetName -> (string)

Specifies the name of the control set that the notification is about.

description -> (string)

The description of the notification.

eventTime -> (timestamp)

The time when the notification was sent.

source -> (string)

The sender of the notification.

nextToken -> (string)

The pagination token that’s used to fetch the next set of results.