list_notifications

list_notifications(**kwargs)

Returns a list of all Audit Manager notifications.

See also: AWS API Documentation

Request Syntax

response = client.list_notifications(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The pagination token that's used to fetch the next set of results.
  • maxResults (integer) -- Represents the maximum number of results on a page or for an API request call.
Return type

dict

Returns

Response Syntax

{
    'notifications': [
        {
            'id': 'string',
            'assessmentId': 'string',
            'assessmentName': 'string',
            'controlSetId': 'string',
            'controlSetName': 'string',
            'description': 'string',
            'eventTime': datetime(2015, 1, 1),
            'source': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • notifications (list) --

      The returned list of notifications.

      • (dict) --

        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 (datetime) --

          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.

Exceptions

  • AuditManager.Client.exceptions.AccessDeniedException
  • AuditManager.Client.exceptions.ValidationException
  • AuditManager.Client.exceptions.InternalServerException