2025/01/17 - AWS User Notifications - 14 new2 updated api methods
Changes Added support for Managed Notifications, integration with AWS Organization and added aggregation summaries for Aggregate Notifications
Returns the child event of a specific given ManagedNotificationEvent.
See also: AWS API Documentation
Request Syntax
client.get_managed_notification_child_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 ManagedNotificationChildEvent to return.
string
The locale code of the language used for the retrieved ManagedNotificationChildEvent. The default locale is English en_US.
dict
Response Syntax
{
'arn': 'string',
'managedNotificationConfigurationArn': 'string',
'creationTime': datetime(2015, 1, 1),
'content': {
'schemaVersion': 'v1.0',
'id': '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',
'aggregateManagedNotificationEventArn': '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'
}
},
'organizationalUnitId': 'string',
'aggregationDetail': {
'summarizationDimensions': [
{
'name': 'string',
'value': 'string'
},
]
}
}
}
Response Structure
(dict) --
arn (string) --
The ARN of the resource.
managedNotificationConfigurationArn (string) --
The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration associated with the ManagedNotificationChildEvent.
creationTime (datetime) --
The creation time of the ManagedNotificationChildEvent.
content (dict) --
The content of the ManagedNotificationChildEvent.
schemaVersion (string) --
The schema version of the Managed Notification Child Event.
id (string) --
The unique identifier for a Managed Notification Child Event.
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, Chatbot 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 assesed nature of the event.
Values:
HEALTHY
All EventRules are ACTIVE.
UNHEALTHY
Some EventRules are ACTIVE and some are INACTIVE.
aggregateManagedNotificationEventArn (string) --
The Amazon Resource Name (ARN) of the ManagedNotificationEvent that is associated with this Managed Notification Child Event.
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.
organizationalUnitId (string) --
The Organizational Unit Id that an Amazon Web Services account belongs to.
aggregationDetail (dict) --
Provides detailed information about the dimensions used for event summarization and aggregation.
summarizationDimensions (list) --
Properties used to summarize aggregated events.
(dict) --
Provides detailed information about the dimensions used for event summarization and aggregation.
name (string) --
The name of the SummarizationDimensionDetail.
value (string) --
Value of the property used to summarize aggregated events.
Returns a list of Account contacts and Channels associated with a ManagedNotificationConfiguration, in paginated format.
See also: AWS API Documentation
Request Syntax
client.list_managed_notification_channel_associations(
managedNotificationConfigurationArn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration 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 ListManagedNotificationChannelAssociations call.
dict
Response Syntax
{
'nextToken': 'string',
'channelAssociations': [
{
'channelIdentifier': 'string',
'channelType': 'MOBILE'|'CHATBOT'|'EMAIL'|'ACCOUNT_CONTACT',
'overrideOption': 'ENABLED'|'DISABLED'
},
]
}
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.
channelAssociations (list) --
A list that contains the following information about a channel association.
(dict) --
Provides a summary of channel associations for a managed notification configuration.
channelIdentifier (string) --
The unique identifier for the notification channel.
channelType (string) --
The type of notification channel used for message delivery.
Values:
ACCOUNT_CONTACT
Delivers notifications to Account Managed contacts through the User Notification Service.
MOBILE
Delivers notifications through the Amazon Web Services Console Mobile Application to mobile devices.
CHATBOT
Delivers notifications through Chatbot to collaboration platforms (Slack, Chime).
Delivers notifications to email addresses.
overrideOption (string) --
Controls whether users can modify channel associations for a notification configuration.
Values:
ENABLED
Users can associate or disassociate channels with the notification configuration.
DISABLED
Users cannot associate or disassociate channels with the notification configuration.
Returns a specified ManagedNotificationEvent.
See also: AWS API Documentation
Request Syntax
client.get_managed_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 ManagedNotificationEvent to return.
string
The locale code of the language used for the retrieved ManagedNotificationEvent. The default locale is English (en_US).
dict
Response Syntax
{
'arn': 'string',
'managedNotificationConfigurationArn': 'string',
'creationTime': datetime(2015, 1, 1),
'content': {
'schemaVersion': 'v1.0',
'id': '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',
'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'
}
},
'organizationalUnitId': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The ARN of the resource.
managedNotificationConfigurationArn (string) --
The ARN of the ManagedNotificationConfiguration.
creationTime (datetime) --
The creation time of the ManagedNotificationEvent.
content (dict) --
The content of the ManagedNotificationEvent.
schemaVersion (string) --
Version of the ManagedNotificationEvent schema.
id (string) --
Unique identifier for a ManagedNotificationEvent.
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, Chatbot 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) --
URL defined by Source Service to be used by notification consumers to get additional information about event.
sourceEventDetailUrlDisplayText (string) --
Text that needs to be hyperlinked with the sourceEventDetailUrl. For example, the description of the sourceEventDetailUrl.
notificationType (string) --
The nature of the event causing this 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 status of an 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 notifications aggregation type.
aggregationSummary (dict) --
Provides additional information about the aggregation key.
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 earliest time of events to return from this call.
endTime (datetime) --
The end time of the notification 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.
organizationalUnitId (string) --
The Organizational Unit Id that an Amazon Web Services account belongs to.
Disassociates an additional Channel from a particular ManagedNotificationConfiguration.
Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).
See also: AWS API Documentation
Request Syntax
client.disassociate_managed_notification_additional_channel(
channelArn='string',
managedNotificationConfigurationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Channel to associate with the ManagedNotificationConfiguration.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Managed Notification Configuration to associate with the additional Channel.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns a list of ManagedNotificationChildEvents for a specified aggregate ManagedNotificationEvent, ordered by creation time in reverse chronological order (newest first).
See also: AWS API Documentation
Request Syntax
client.list_managed_notification_child_events(
aggregateManagedNotificationEventArn='string',
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',
maxResults=123,
relatedAccount='string',
organizationalUnitId='string',
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the ManagedNotificationEvent.
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.
integer
The maximum number of results to be returned in this call. Defaults to 20.
string
The Amazon Web Services account ID associated with the Managed Notification Child Events.
string
The identifier of the Amazon Web Services Organizations organizational unit (OU) associated with the Managed Notification Child Events.
string
The start token for paginated calls. Retrieved from the response of a previous ListManagedNotificationChannelAssociations call. Next token uses Base64 encoding.
dict
Response Syntax
{
'nextToken': 'string',
'managedNotificationChildEvents': [
{
'arn': 'string',
'managedNotificationConfigurationArn': 'string',
'relatedAccount': 'string',
'creationTime': datetime(2015, 1, 1),
'childEvent': {
'schemaVersion': 'v1.0',
'sourceEventMetadata': {
'eventOriginRegion': 'string',
'source': 'string',
'eventType': 'string'
},
'messageComponents': {
'headline': 'string'
},
'aggregationDetail': {
'summarizationDimensions': [
{
'name': 'string',
'value': 'string'
},
]
},
'eventStatus': 'HEALTHY'|'UNHEALTHY',
'notificationType': 'ALERT'|'WARNING'|'ANNOUNCEMENT'|'INFORMATIONAL'
},
'aggregateManagedNotificationEventArn': '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.
managedNotificationChildEvents (list) --
A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
(dict) --
Describes an overview and metadata for a ManagedNotificationChildEvent.
arn (string) --
The Amazon Resource Name (ARN) of the ManagedNotificationChildEvent.
managedNotificationConfigurationArn (string) --
The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration.
relatedAccount (string) --
The account that related to the ManagedNotificationChildEvent.
creationTime (datetime) --
The creation time of the ManagedNotificationChildEvent.
childEvent (dict) --
The content of the ManagedNotificationChildEvent.
schemaVersion (string) --
The schema version of the ManagedNotificationChildEvent.
sourceEventMetadata (dict) --
Contains all event metadata present identically across all NotificationEvents. All fields are present in Source Events via Eventbridge.
eventOriginRegion (string) --
The Region where the notification originated.
source (string) --
The source service of the notification.
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 of the notification.
messageComponents (dict) --
Contains the headline message component.
headline (string) --
A sentence long summary. For example, titles or an email subject line.
aggregationDetail (dict) --
Provides detailed information about the dimensions used for event summarization and aggregation.
summarizationDimensions (list) --
Properties used to summarize aggregated events.
(dict) --
Provides detailed information about the dimensions used for event summarization and aggregation.
name (string) --
The name of the SummarizationDimensionDetail.
value (string) --
Value of the property used to summarize aggregated events.
eventStatus (string) --
The perceived 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.
notificationType (string) --
The Type of the event causing this 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.
aggregateManagedNotificationEventArn (string) --
The Amazon Resource Name (ARN) of the ManagedNotificationEvent that is associated with this ManagedNotificationChildEvent.
organizationalUnitId (string) --
The Organizational Unit Id that an AWS account belongs to.
Returns a specified ManagedNotificationConfiguration.
See also: AWS API Documentation
Request Syntax
client.get_managed_notification_configuration(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to return.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'description': 'string',
'category': 'string',
'subCategory': 'string'
}
Response Structure
(dict) --
arn (string) --
The ARN of the ManagedNotificationConfiguration resource.
name (string) --
The name of the ManagedNotificationConfiguration.
description (string) --
The description of the ManagedNotificationConfiguration.
category (string) --
The category of the ManagedNotificationConfiguration.
subCategory (string) --
The subCategory of the ManagedNotificationConfiguration.
Disassociates an Account Contact with a particular ManagedNotificationConfiguration.
See also: AWS API Documentation
Request Syntax
client.disassociate_managed_notification_account_contact(
contactIdentifier='ACCOUNT_PRIMARY'|'ACCOUNT_ALTERNATE_BILLING'|'ACCOUNT_ALTERNATE_OPERATIONS'|'ACCOUNT_ALTERNATE_SECURITY',
managedNotificationConfigurationArn='string'
)
string
[REQUIRED]
The unique value of an Account Contact Type to associate with the ManagedNotificationConfiguration.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to associate with the Account Contact.
dict
Response Syntax
{}
Response Structure
(dict) --
Enables service trust between User Notifications and Amazon Web Services Organizations.
See also: AWS API Documentation
Request Syntax
client.enable_notifications_access_for_organization()
dict
Response Syntax
{}
Response Structure
(dict) --
Disables service trust between User Notifications and Amazon Web Services Organizations.
See also: AWS API Documentation
Request Syntax
client.disable_notifications_access_for_organization()
dict
Response Syntax
{}
Response Structure
(dict) --
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'
}
}
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.
Returns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first).
See also: AWS API Documentation
Request Syntax
client.list_managed_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',
maxResults=123,
nextToken='string',
organizationalUnitId='string',
relatedAccount='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 Amazon Web Services service the event originates from. For example aws.cloudwatch.
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 ListManagedNotificationChannelAssociations call. Next token uses Base64 encoding.
string
The Organizational Unit Id that an Amazon Web Services account belongs to.
string
The Amazon Web Services account ID associated with the Managed Notification Events.
dict
Response Syntax
{
'nextToken': 'string',
'managedNotificationEvents': [
{
'arn': 'string',
'managedNotificationConfigurationArn': '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',
'organizationalUnitId': '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',
]
},
]
},
'aggregatedNotificationRegions': [
'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.
managedNotificationEvents (list) --
A list of Managed Notification Events matching the request criteria.
(dict) --
Describes an overview and metadata for a ManagedNotificationEvent.
arn (string) --
The Amazon Resource Name (ARN) of the ManagedNotificationEvent.
managedNotificationConfigurationArn (string) --
The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration.
relatedAccount (string) --
The account that related to the ManagedNotificationEvent.
creationTime (datetime) --
The creation time of the ManagedNotificationEvent.
notificationEvent (dict) --
A short summary of a ManagedNotificationEvent. This is only used when listing managed notification events.
schemaVersion (string) --
The schema version of the ManagedNotificationEvent.
sourceEventMetadata (dict) --
Contains metadata about the event that caused the ManagedNotificationEvent.
eventOriginRegion (string) --
The Region where the notification originated.
source (string) --
The source service of the notification.
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 of the notification.
messageComponents (dict) --
Contains the headline message component.
headline (string) --
A sentence long summary. For example, titles or an email subject line.
eventStatus (string) --
The managed notification event status.
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 notifications 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.
organizationalUnitId (string) --
The Organizational Unit Id that an Amazon Web Services account belongs to.
aggregationSummary (dict) --
Provides additional information about the aggregation key.
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) --
aggregatedNotificationRegions (list) --
The list of the regions where the aggregated notifications in this NotificationEvent originated.
(string) --
Associates an additional Channel with a particular ManagedNotificationConfiguration.
Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).
See also: AWS API Documentation
Request Syntax
client.associate_managed_notification_additional_channel(
channelArn='string',
managedNotificationConfigurationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Channel to associate with the ManagedNotificationConfiguration.
Supported ARNs include Chatbot, the Console Mobile Application, and email (notifications-contacts).
string
[REQUIRED]
The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to associate with the additional Channel.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns a list of Managed Notification Configurations according to specified filters, ordered by creation time in reverse chronological order (newest first).
See also: AWS API Documentation
Request Syntax
client.list_managed_notification_configurations(
channelIdentifier='string',
maxResults=123,
nextToken='string'
)
string
The identifier or ARN of the notification channel to filter configurations by.
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 ListManagedNotificationChannelAssociations call. Next token uses Base64 encoding.
dict
Response Syntax
{
'nextToken': 'string',
'managedNotificationConfigurations': [
{
'arn': 'string',
'name': 'string',
'description': '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.
managedNotificationConfigurations (list) --
A list of Managed Notification Configurations matching the request criteria.
(dict) --
Describes the basic structure and properties of a ManagedNotificationConfiguration.
arn (string) --
The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration.
name (string) --
The name of the ManagedNotificationConfiguration.
description (string) --
The description of the ManagedNotificationConfiguration.
Associates an Account Contact with a particular ManagedNotificationConfiguration.
See also: AWS API Documentation
Request Syntax
client.associate_managed_notification_account_contact(
contactIdentifier='ACCOUNT_PRIMARY'|'ACCOUNT_ALTERNATE_BILLING'|'ACCOUNT_ALTERNATE_OPERATIONS'|'ACCOUNT_ALTERNATE_SECURITY',
managedNotificationConfigurationArn='string'
)
string
[REQUIRED]
A unique value of an Account Contact Type to associate with the ManagedNotificationConfiguration.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to associate with the Account Contact.
dict
Response Syntax
{}
Response Structure
(dict) --
{'content': {'aggregationSummary': {'additionalSummarizationDimensions': [{'count': 'integer',
'name': 'string',
'sampleValues': ['string']}],
'aggregatedAccounts': {'count': 'integer',
'name': 'string',
'sampleValues': ['string']},
'aggregatedBy': [{'name': 'string',
'value': 'string'}],
'aggregatedOrganizationalUnits': {'count': 'integer',
'name': 'string',
'sampleValues': ['string']},
'aggregatedRegions': {'count': 'integer',
'name': 'string',
'sampleValues': ['string']},
'eventCount': 'integer'}}}
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'
},
]
}
}
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, Chatbot 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.
{'notificationEvents': {'aggregationSummary': {'additionalSummarizationDimensions': [{'count': 'integer',
'name': 'string',
'sampleValues': ['string']}],
'aggregatedAccounts': {'count': 'integer',
'name': 'string',
'sampleValues': ['string']},
'aggregatedBy': [{'name': 'string',
'value': 'string'}],
'aggregatedOrganizationalUnits': {'count': 'integer',
'name': 'string',
'sampleValues': ['string']},
'aggregatedRegions': {'count': 'integer',
'name': 'string',
'sampleValues': ['string']},
'eventCount': 'integer'}}}
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'
)
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.
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',
]
},
]
}
},
]
}
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) --