Returns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first).
Request Syntax
GET /managed-notification-events?endTime=endTime&locale=locale&maxResults=maxResults&nextToken=nextToken&organizationalUnitId=organizationalUnitId&relatedAccount=relatedAccount&source=source&startTime=startTime HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- endTime
-
Latest time of events to return from this call.
- locale
-
The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US).
Valid Values:
de_DE | en_CA | en_US | en_UK | es_ES | fr_CA | fr_FR | id_ID | it_IT | ja_JP | ko_KR | pt_BR | tr_TR | zh_CN | zh_TW - maxResults
-
The maximum number of results to be returned in this call. Defaults to 20.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
The start token for paginated calls. Retrieved from the response of a previous
ListManagedNotificationChannelAssociationscall. Next token uses Base64 encoding.Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern:
[\w+-/=]+ - organizationalUnitId
-
The Organizational Unit Id that an AWS account belongs to.
Pattern:
Root|ou-[0-9a-z]{4,32}-[a-z0-9]{8,32} -
The AWS account ID associated with the Managed Notification Events.
Pattern:
\d{12} - source
-
The AWS service the event originates from. For example aws.cloudwatch.
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern:
aws.([a-z0-9\-])+ - startTime
-
The earliest time of events to return from this call.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"managedNotificationEvents": [
{
"aggregatedNotificationRegions": [ "string" ],
"aggregationEventType": "string",
"aggregationSummary": {
"additionalSummarizationDimensions": [
{
"count": number,
"name": "string",
"sampleValues": [ "string" ]
}
],
"aggregatedAccounts": {
"count": number,
"name": "string",
"sampleValues": [ "string" ]
},
"aggregatedBy": [
{
"name": "string",
"value": "string"
}
],
"aggregatedOrganizationalUnits": {
"count": number,
"name": "string",
"sampleValues": [ "string" ]
},
"aggregatedRegions": {
"count": number,
"name": "string",
"sampleValues": [ "string" ]
},
"eventCount": number
},
"arn": "string",
"creationTime": "string",
"managedNotificationConfigurationArn": "string",
"notificationEvent": {
"eventStatus": "string",
"messageComponents": {
"headline": "string"
},
"notificationType": "string",
"schemaVersion": "string",
"sourceEventMetadata": {
"eventOriginRegion": "string",
"eventType": "string",
"source": "string"
}
},
"organizationalUnitId": "string",
"relatedAccount": "string"
}
],
"nextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- managedNotificationEvents
-
A list of Managed Notification Events matching the request criteria.
Type: Array of ManagedNotificationEventOverview objects
- nextToken
-
A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern:
[\w+-/=]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
User does not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
Unexpected error during processing of request.
HTTP Status Code: 500
- ThrottlingException
-
Request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
This exception is thrown when the notification event fails validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
