2025/09/02 - AWS User Notifications - 4 new5 updated api methods
Changes Added Org support for notifications: - `ListMemberAccounts` gets member accounts list, `AssociateOrganizationalUnit` links OU to notification configuration, `DisassociateOrganizationalUnit` removes OU from notification configuration, `ListOrganizationalUnits` shows OUs configured for notifications.
Returns a list of member accounts associated with a notification configuration.
See also: AWS API Documentation
Request Syntax
client.list_member_accounts(
notificationConfigurationArn='string',
maxResults=123,
nextToken='string',
memberAccount='string',
status='ACTIVE'|'PENDING'|'INACTIVE'|'CREATING'|'DELETING',
organizationalUnitId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the notification configuration used to filter the member accounts.
integer
The maximum number of results to return in a single call. Valid values are 1-100.
string
The token for the next page of results. Use the value returned in the previous response.
string
The member account identifier used to filter the results.
string
The status used to filter the member accounts.
string
The organizational unit ID used to filter the member accounts.
dict
Response Syntax
{
'memberAccounts': [
{
'notificationConfigurationArn': 'string',
'accountId': 'string',
'status': 'ACTIVE'|'PENDING'|'INACTIVE'|'CREATING'|'DELETING',
'statusReason': 'string',
'organizationalUnitId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
memberAccounts (list) --
The list of member accounts that match the specified criteria.
(dict) --
Contains information about a member account.
notificationConfigurationArn (string) --
The Amazon Resource Name (ARN) of the notification configuration associated with the member account.
accountId (string) --
The AWS account ID of the member account.
status (string) --
The current status of the member account.
statusReason (string) --
The reason for the current status of the member account.
organizationalUnitId (string) --
The unique identifier of the organizational unit containing the member account.
nextToken (string) --
The token to use for the next page of results.
Returns a list of organizational units associated with a notification configuration.
See also: AWS API Documentation
Request Syntax
client.list_organizational_units(
notificationConfigurationArn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the notification configuration used to filter the organizational units.
integer
The maximum number of organizational units to return in a single call. Valid values are 1-100.
string
The token for the next page of results. Use the value returned in the previous response.
dict
Response Syntax
{
'organizationalUnits': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
organizationalUnits (list) --
The list of organizational units that match the specified criteria.
(string) --
nextToken (string) --
The token to use for the next page of results. If there are no additional results, this value is null.
Removes the association between an organizational unit and a notification configuration.
See also: AWS API Documentation
Request Syntax
client.disassociate_organizational_unit(
organizationalUnitId='string',
notificationConfigurationArn='string'
)
string
[REQUIRED]
The unique identifier of the organizational unit to disassociate.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the notification configuration to disassociate from the organizational unit.
dict
Response Syntax
{}
Response Structure
(dict) --
Associates an organizational unit with a notification configuration.
See also: AWS API Documentation
Request Syntax
client.associate_organizational_unit(
organizationalUnitId='string',
notificationConfigurationArn='string'
)
string
[REQUIRED]
The unique identifier of the organizational unit to associate.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the notification configuration to associate with the organizational unit.
dict
Response Syntax
{}
Response Structure
(dict) --
{'subtype': 'ACCOUNT | ADMIN_MANAGED'}
Returns a specified NotificationConfiguration.
See also: AWS API Documentation
Request Syntax
client.get_notification_configuration(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the NotificationConfiguration to return.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'description': 'string',
'status': 'ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING',
'creationTime': datetime(2015, 1, 1),
'aggregationDuration': 'LONG'|'SHORT'|'NONE',
'subtype': 'ACCOUNT'|'ADMIN_MANAGED'
}
Response Structure
(dict) --
arn (string) --
The ARN of the resource.
name (string) --
The name of the NotificationConfiguration.
description (string) --
The description of the NotificationConfiguration.
status (string) --
The status of this NotificationConfiguration.
creationTime (datetime) --
The creation time of the NotificationConfiguration.
aggregationDuration (string) --
The aggregation preference of the NotificationConfiguration.
Values:
LONG
Aggregate notifications for long periods of time (12 hours).
SHORT
Aggregate notifications for short periods of time (5 minutes).
NONE
Don't aggregate notifications.
subtype (string) --
The subtype of the notification configuration returned in the response.
{'content': {'organizationalUnitId': 'string'}}
Returns a specified NotificationEvent.
See also: AWS API Documentation
Request Syntax
client.get_notification_event(
arn='string',
locale='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'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the NotificationEvent to return.
string
The locale code of the language used for the retrieved NotificationEvent. The default locale is English en_US.
dict
Response Syntax
{
'arn': 'string',
'notificationConfigurationArn': 'string',
'creationTime': datetime(2015, 1, 1),
'content': {
'schemaVersion': 'v1.0',
'id': 'string',
'sourceEventMetadata': {
'eventTypeVersion': 'string',
'sourceEventId': 'string',
'eventOriginRegion': 'string',
'relatedAccount': 'string',
'source': 'string',
'eventOccurrenceTime': datetime(2015, 1, 1),
'eventType': 'string',
'relatedResources': [
{
'id': 'string',
'arn': 'string',
'detailUrl': 'string',
'tags': [
'string',
]
},
]
},
'messageComponents': {
'headline': 'string',
'paragraphSummary': 'string',
'completeDescription': 'string',
'dimensions': [
{
'name': 'string',
'value': 'string'
},
]
},
'sourceEventDetailUrl': 'string',
'sourceEventDetailUrlDisplayText': 'string',
'notificationType': 'ALERT'|'WARNING'|'ANNOUNCEMENT'|'INFORMATIONAL',
'eventStatus': 'HEALTHY'|'UNHEALTHY',
'aggregationEventType': 'AGGREGATE'|'CHILD'|'NONE',
'aggregateNotificationEventArn': 'string',
'aggregationSummary': {
'eventCount': 123,
'aggregatedBy': [
{
'name': 'string',
'value': 'string'
},
],
'aggregatedAccounts': {
'name': 'string',
'count': 123,
'sampleValues': [
'string',
]
},
'aggregatedRegions': {
'name': 'string',
'count': 123,
'sampleValues': [
'string',
]
},
'aggregatedOrganizationalUnits': {
'name': 'string',
'count': 123,
'sampleValues': [
'string',
]
},
'additionalSummarizationDimensions': [
{
'name': 'string',
'count': 123,
'sampleValues': [
'string',
]
},
]
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'textParts': {
'string': {
'type': 'LOCALIZED_TEXT'|'PLAIN_TEXT'|'URL',
'displayText': 'string',
'textByLocale': {
'string': 'string'
},
'url': 'string'
}
},
'media': [
{
'mediaId': 'string',
'type': 'IMAGE',
'url': 'string',
'caption': 'string'
},
],
'organizationalUnitId': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The ARN of the resource.
notificationConfigurationArn (string) --
The ARN of the NotificationConfiguration.
creationTime (datetime) --
The creation time of the NotificationEvent.
content (dict) --
The content of the NotificationEvent.
schemaVersion (string) --
The schema version of the Notification Event.
id (string) --
The unique identifier for a NotificationEvent.
sourceEventMetadata (dict) --
The source event metadata.
eventTypeVersion (string) --
The version of the type of event.
sourceEventId (string) --
The source event id.
eventOriginRegion (string) --
The Region the event originated from.
relatedAccount (string) --
The primary Amazon Web Services account of SourceEvent.
source (string) --
The Amazon Web Services service the event originates from. For example aws.cloudwatch.
eventOccurrenceTime (datetime) --
The date and time the source event occurred. This is based on the Source Event.
eventType (string) --
The type of event. For example, an Amazon CloudWatch state change.
relatedResources (list) --
A list of resources related to this NotificationEvent.
(dict) --
A resource affected by or closely linked to an event.
id (string) --
The unique identifier for the resource.
At least one id or ARN is required.
arn (string) --
The Amazon Resource Name (ARN) of the resource. At least one id or ARN is required.
detailUrl (string) --
The URL to the resource's detail page. If a detail page URL is unavailable, it is the URL to an informational page that describes the resource's type.
tags (list) --
A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
(string) --
messageComponents (dict) --
Describes the components of a notification message.
headline (string) --
A sentence long summary. For example, titles or an email subject line.
paragraphSummary (string) --
A paragraph long or multiple sentence summary. For example, Amazon Q Developer in chat applications notifications.
completeDescription (string) --
A complete summary with all possible relevant information.
dimensions (list) --
A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.
(dict) --
The key-value pair of properties for an event.
name (string) --
The name of the dimension
value (string) --
The value of the dimension.
sourceEventDetailUrl (string) --
The source event URL.
sourceEventDetailUrlDisplayText (string) --
The detailed URL for the source event.
notificationType (string) --
The type of event causing the notification.
Values:
ALERT
A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.
WARNING
A notification about an event where an issue is about to arise. For example, something is approaching a threshold.
ANNOUNCEMENT
A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.
INFORMATIONAL
A notification about informational messages. For example, recommendations, service announcements, or reminders.
eventStatus (string) --
The assessed nature of the event.
Values:
HEALTHY
All EventRules are ACTIVE and any call can be run.
UNHEALTHY
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
aggregationEventType (string) --
The aggregation type of the NotificationConfiguration.
Values:
AGGREGATE
The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.
CHILD
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
NONE
The notification isn't aggregated.
aggregateNotificationEventArn (string) --
If the value of aggregationEventType is not NONE, this is the Amazon Resource Event (ARN) of the parent aggregate notification.
This is omitted if notification isn't aggregated.
aggregationSummary (dict) --
Provides additional information about how multiple notifications are grouped.
eventCount (integer) --
Indicates the number of events associated with the aggregation key.
aggregatedBy (list) --
Indicates the criteria or rules by which notifications have been grouped together.
(dict) --
Key-value collection that indicate how notifications are grouped.
name (string) --
Indicates the type of aggregation key.
value (string) --
Indicates the value associated with the aggregation key name.
aggregatedAccounts (dict) --
Indicates the Amazon Web Services accounts in the aggregation key.
name (string) --
Name of the summarization dimension.
count (integer) --
Total number of occurrences for this dimension.
sampleValues (list) --
Indicates the sample values found within the dimension.
(string) --
aggregatedRegions (dict) --
Indicates the Amazon Web Services Regions in the aggregation key.
name (string) --
Name of the summarization dimension.
count (integer) --
Total number of occurrences for this dimension.
sampleValues (list) --
Indicates the sample values found within the dimension.
(string) --
aggregatedOrganizationalUnits (dict) --
Indicates the collection of organizational units that are involved in the aggregation key.
name (string) --
Name of the summarization dimension.
count (integer) --
Total number of occurrences for this dimension.
sampleValues (list) --
Indicates the sample values found within the dimension.
(string) --
additionalSummarizationDimensions (list) --
List of additional dimensions used to group and summarize data.
(dict) --
Provides an overview of how data is summarized across different dimensions.
name (string) --
Name of the summarization dimension.
count (integer) --
Total number of occurrences for this dimension.
sampleValues (list) --
Indicates the sample values found within the dimension.
(string) --
startTime (datetime) --
The notification event start time.
endTime (datetime) --
The end time of the event.
textParts (dict) --
A list of text values.
(string) --
(dict) --
Describes text information objects containing fields that determine how text part objects are composed.
type (string) --
The type of text part. Determines the usage of all other fields and whether or not they're required.
displayText (string) --
A short single line description of the link. Must be hyper-linked with the URL itself.
Used for text parts with the type URL.
textByLocale (dict) --
A map of locales to the text in that locale.
(string) --
(string) --
url (string) --
The URL itself.
media (list) --
A list of media elements.
(dict) --
Describes a media element.
mediaId (string) --
The unique ID for the media.
type (string) --
The type of media.
url (string) --
The URL of the media.
caption (string) --
The caption of the media.
organizationalUnitId (string) --
The unique identifier of the organizational unit associated with the notification event.
{'notificationsAccessForOrganization': {'accessStatus': {'FAILED'}}}
Returns the AccessStatus of Service Trust Enablement for User Notifications and Amazon Web Services Organizations.
See also: AWS API Documentation
Request Syntax
client.get_notifications_access_for_organization()
dict
Response Syntax
{
'notificationsAccessForOrganization': {
'accessStatus': 'ENABLED'|'DISABLED'|'PENDING'|'FAILED'
}
}
Response Structure
(dict) --
notificationsAccessForOrganization (dict) --
The AccessStatus of Service Trust Enablement for User Notifications to Amazon Web Services Organizations.
accessStatus (string) --
Access Status for the Orgs Service.
{'subtype': 'ACCOUNT | ADMIN_MANAGED'}
Response {'notificationConfigurations': {'subtype': 'ACCOUNT | ADMIN_MANAGED'}}
Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).
See also: AWS API Documentation
Request Syntax
client.list_notification_configurations(
eventRuleSource='string',
channelArn='string',
status='ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING',
subtype='ACCOUNT'|'ADMIN_MANAGED',
maxResults=123,
nextToken='string'
)
string
The matched event source.
Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.
string
The Amazon Resource Name (ARN) of the Channel to match.
string
The NotificationConfiguration status to match.
Values:
ACTIVE
All EventRules are ACTIVE and any call can be run.
PARTIALLY_ACTIVE
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
Any call can be run.
INACTIVE
All EventRules are INACTIVE and any call can be run.
DELETING
This NotificationConfiguration is being deleted.
Only GET and LIST calls can be run.
string
The subtype used to filter the notification configurations in the request.
integer
The maximum number of results to be returned in this call. Defaults to 20.
string
The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.
dict
Response Syntax
{
'nextToken': 'string',
'notificationConfigurations': [
{
'arn': 'string',
'name': 'string',
'description': 'string',
'status': 'ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING',
'creationTime': datetime(2015, 1, 1),
'aggregationDuration': 'LONG'|'SHORT'|'NONE',
'subtype': 'ACCOUNT'|'ADMIN_MANAGED'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
notificationConfigurations (list) --
The NotificationConfigurations in the account.
(dict) --
Contains the complete list of fields for a NotificationConfiguration.
arn (string) --
The Amazon Resource Name (ARN) of the NotificationConfiguration resource.
name (string) --
The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.
description (string) --
The description of the NotificationConfiguration.
status (string) --
The current status of the NotificationConfiguration.
creationTime (datetime) --
The creation time of the NotificationConfiguration.
aggregationDuration (string) --
The aggregation preference of the NotificationConfiguration.
Values:
LONG
Aggregate notifications for long periods of time (12 hours).
SHORT
Aggregate notifications for short periods of time (5 minutes).
NONE
Don't aggregate notifications.
subtype (string) --
The subtype of the notification configuration.
{'organizationalUnitId': 'string'}
Response {'notificationEvents': {'organizationalUnitId': 'string'}}
Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).
See also: AWS API Documentation
Request Syntax
client.list_notification_events(
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
locale='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',
source='string',
includeChildEvents=True|False,
aggregateNotificationEventArn='string',
maxResults=123,
nextToken='string',
organizationalUnitId='string'
)
datetime
The earliest time of events to return from this call.
datetime
Latest time of events to return from this call.
string
The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US).
string
The matched event source.
Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.
boolean
Include aggregated child events in the result.
string
The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn to match.
integer
The maximum number of results to be returned in this call. Defaults to 20.
string
The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.
string
The unique identifier of the organizational unit used to filter notification events.
dict
Response Syntax
{
'nextToken': 'string',
'notificationEvents': [
{
'arn': 'string',
'notificationConfigurationArn': 'string',
'relatedAccount': 'string',
'creationTime': datetime(2015, 1, 1),
'notificationEvent': {
'schemaVersion': 'v1.0',
'sourceEventMetadata': {
'eventOriginRegion': 'string',
'source': 'string',
'eventType': 'string'
},
'messageComponents': {
'headline': 'string'
},
'eventStatus': 'HEALTHY'|'UNHEALTHY',
'notificationType': 'ALERT'|'WARNING'|'ANNOUNCEMENT'|'INFORMATIONAL'
},
'aggregationEventType': 'AGGREGATE'|'CHILD'|'NONE',
'aggregateNotificationEventArn': 'string',
'aggregationSummary': {
'eventCount': 123,
'aggregatedBy': [
{
'name': 'string',
'value': 'string'
},
],
'aggregatedAccounts': {
'name': 'string',
'count': 123,
'sampleValues': [
'string',
]
},
'aggregatedRegions': {
'name': 'string',
'count': 123,
'sampleValues': [
'string',
]
},
'aggregatedOrganizationalUnits': {
'name': 'string',
'count': 123,
'sampleValues': [
'string',
]
},
'additionalSummarizationDimensions': [
{
'name': 'string',
'count': 123,
'sampleValues': [
'string',
]
},
]
},
'organizationalUnitId': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
notificationEvents (list) --
The list of notification events.
(dict) --
Describes a short summary of a NotificationEvent. This is only used when listing notification events.
arn (string) --
The Amazon Resource Name (ARN) of the resource.
notificationConfigurationArn (string) --
The ARN of the NotificationConfiguration.
relatedAccount (string) --
The account name containing the NotificationHub.
creationTime (datetime) --
The creation time of the NotificationEvent.
notificationEvent (dict) --
Refers to a NotificationEventSummary object.
Similar in structure to content in the GetNotificationEvent response.
schemaVersion (string) --
The schema version of the Notification Event.
sourceEventMetadata (dict) --
The source event metadata.
eventOriginRegion (string) --
The Region where the notification originated.
Unavailable for aggregated notifications.
source (string) --
The matched event source.
Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.
eventType (string) --
The event type to match.
Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.
messageComponents (dict) --
The message components of a notification event.
headline (string) --
A sentence long summary. For example, titles or an email subject line.
eventStatus (string) --
Provides additional information about the current status of the NotificationEvent.
Values:
HEALTHY
All EventRules are ACTIVE.
UNHEALTHY
Some EventRules are ACTIVE and some are INACTIVE.
notificationType (string) --
The type of event causing the notification.
Values:
ALERT
A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.
WARNING
A notification about an event where an issue is about to arise. For example, something is approaching a threshold.
ANNOUNCEMENT
A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.
INFORMATIONAL
A notification about informational messages. For example, recommendations, service announcements, or reminders.
aggregationEventType (string) --
The NotificationConfiguration's aggregation type.
Values:
AGGREGATE
The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.
CHILD
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
NONE
The notification isn't aggregated.
aggregateNotificationEventArn (string) --
The ARN of the aggregatedNotificationEventArn to match.
aggregationSummary (dict) --
Provides an aggregated summary data for notification events.
eventCount (integer) --
Indicates the number of events associated with the aggregation key.
aggregatedBy (list) --
Indicates the criteria or rules by which notifications have been grouped together.
(dict) --
Key-value collection that indicate how notifications are grouped.
name (string) --
Indicates the type of aggregation key.
value (string) --
Indicates the value associated with the aggregation key name.
aggregatedAccounts (dict) --
Indicates the Amazon Web Services accounts in the aggregation key.
name (string) --
Name of the summarization dimension.
count (integer) --
Total number of occurrences for this dimension.
sampleValues (list) --
Indicates the sample values found within the dimension.
(string) --
aggregatedRegions (dict) --
Indicates the Amazon Web Services Regions in the aggregation key.
name (string) --
Name of the summarization dimension.
count (integer) --
Total number of occurrences for this dimension.
sampleValues (list) --
Indicates the sample values found within the dimension.
(string) --
aggregatedOrganizationalUnits (dict) --
Indicates the collection of organizational units that are involved in the aggregation key.
name (string) --
Name of the summarization dimension.
count (integer) --
Total number of occurrences for this dimension.
sampleValues (list) --
Indicates the sample values found within the dimension.
(string) --
additionalSummarizationDimensions (list) --
List of additional dimensions used to group and summarize data.
(dict) --
Provides an overview of how data is summarized across different dimensions.
name (string) --
Name of the summarization dimension.
count (integer) --
Total number of occurrences for this dimension.
sampleValues (list) --
Indicates the sample values found within the dimension.
(string) --
organizationalUnitId (string) --
The unique identifier of the organizational unit in the notification event overview.