GetNotificationEvent
Returns a specified NotificationEvent.
Important
User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. GetNotificationEvent only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the AWS User Notifications User Guide.
Request Syntax
GET /notification-events/arn?locale=locale HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- arn
-
The Amazon Resource Name (ARN) of the NotificationEvent to return.
Pattern:
arn:[-.a-z0-9]{1,63}:notifications:[-.a-z0-9]{1,63}:[0-9]{12}:configuration/[a-z0-9]{27}/event/[a-z0-9]{27}Required: Yes
- 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
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"content": {
"aggregateNotificationEventArn": "string",
"aggregationEventType": "string",
"endTime": "string",
"eventStatus": "string",
"id": "string",
"media": [
{
"caption": "string",
"mediaId": "string",
"type": "string",
"url": "string"
}
],
"messageComponents": {
"completeDescription": "string",
"dimensions": [
{
"name": "string",
"value": "string"
}
],
"headline": "string",
"paragraphSummary": "string"
},
"notificationType": "string",
"schemaVersion": "string",
"sourceEventDetailUrl": "string",
"sourceEventDetailUrlDisplayText": "string",
"sourceEventMetadata": {
"eventOccurrenceTime": "string",
"eventOriginRegion": "string",
"eventType": "string",
"eventTypeVersion": "string",
"relatedAccount": "string",
"relatedResources": [
{
"arn": "string",
"detailUrl": "string",
"id": "string",
"tags": [ "string" ]
}
],
"source": "string",
"sourceEventId": "string"
},
"startTime": "string",
"textParts": {
"string" : {
"displayText": "string",
"textByLocale": {
"string" : "string"
},
"type": "string",
"url": "string"
}
}
},
"creationTime": "string",
"notificationConfigurationArn": "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.
- arn
-
The ARN of the resource.
Type: String
Pattern:
arn:[-.a-z0-9]{1,63}:notifications:[-.a-z0-9]{1,63}:[0-9]{12}:configuration/[a-z0-9]{27}/event/[a-z0-9]{27} - content
-
The content of the NotificationEvent.
Type: NotificationEvent object
- creationTime
-
The creation time of the NotificationEvent.
Type: Timestamp
- notificationConfigurationArn
-
The ARN of the NotificationConfiguration.
Type: String
Pattern:
arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}
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
- ResourceNotFoundException
-
Request references a resource which does not exist.
HTTP Status Code: 404
- 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:
