Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetManagedNotificationEvent

Returns a specified ManagedNotificationEvent.

Request Syntax


GET /managed-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 ManagedNotificationEvent to return.

Pattern: arn:[-.a-z0-9]{1,63}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9\-]{3,64}/sub-category/[a-zA-Z0-9\-]{3,64}/event/[a-z0-9]{27}

Required: Yes

locale

The locale code of the language used for the retrieved ManagedNotificationEvent. The default locale is English (en_US).

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "content": { 
      "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
      },
      "endTime": "string",
      "eventStatus": "string",
      "id": "string",
      "messageComponents": { 
         "completeDescription": "string",
         "dimensions": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ],
         "headline": "string",
         "paragraphSummary": "string"
      },
      "notificationType": "string",
      "organizationalUnitId": "string",
      "schemaVersion": "string",
      "sourceEventDetailUrl": "string",
      "sourceEventDetailUrlDisplayText": "string",
      "startTime": "string",
      "textParts": { 
         "string" : { 
            "displayText": "string",
            "textByLocale": { 
               "string" : "string" 
            },
            "type": "string",
            "url": "string"
         }
      }
   },
   "creationTime": "string",
   "managedNotificationConfigurationArn": "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::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9\-]{3,64}/sub-category/[a-zA-Z0-9\-]{3,64}/event/[a-z0-9]{27}

content

The content of the ManagedNotificationEvent.

Type: ManagedNotificationEvent object

creationTime

The creation time of the ManagedNotificationEvent.

Type: Timestamp

managedNotificationConfigurationArn

The ARN of the ManagedNotificationConfiguration.

Type: String

Pattern: arn:[-.a-z0-9]{1,63}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9\-]{3,64}/sub-category/[a-zA-Z0-9\-]{3,64}

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.

resourceId: The ID of the resource that wasn't found.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

quotaCode: Identifies the quota that is being throttled.
retryAfterSeconds: The number of seconds a client should wait before retrying the request.
serviceCode: Identifies the service being throttled.

HTTP Status Code: 429

ValidationException

This exception is thrown when the notification event fails validation.

fieldList: The list of input fields that are invalid.
reason: The reason why your input is considered invalid.

HTTP Status Code: 400