UserNotifications ***************** Client ====== class UserNotifications.Client A low-level client representing AWS User Notifications The *Amazon Web Services User Notifications API Reference* provides descriptions, API request parameters, and the JSON response for each of the User Notification API actions. User Notification control plane APIs are currently available in US East (Virginia) - "us-east-1". GetNotificationEvent and ListNotificationEvents APIs are currently available in commercial partition Regions and only return notifications stored in the same Region in which they're called. The User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a notification hub in addition to US East (Virginia). import boto3 client = boto3.client('notifications') These are the available methods: * associate_channel * associate_managed_notification_account_contact * associate_managed_notification_additional_channel * can_paginate * close * create_event_rule * create_notification_configuration * delete_event_rule * delete_notification_configuration * deregister_notification_hub * disable_notifications_access_for_organization * disassociate_channel * disassociate_managed_notification_account_contact * disassociate_managed_notification_additional_channel * enable_notifications_access_for_organization * get_event_rule * get_managed_notification_child_event * get_managed_notification_configuration * get_managed_notification_event * get_notification_configuration * get_notification_event * get_notifications_access_for_organization * get_paginator * get_waiter * list_channels * list_event_rules * list_managed_notification_channel_associations * list_managed_notification_child_events * list_managed_notification_configurations * list_managed_notification_events * list_notification_configurations * list_notification_events * list_notification_hubs * list_tags_for_resource * register_notification_hub * tag_resource * untag_resource * update_event_rule * update_notification_configuration Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListChannels * ListEventRules * ListManagedNotificationChannelAssociations * ListManagedNotificationChildEvents * ListManagedNotificationConfigurations * ListManagedNotificationEvents * ListNotificationConfigurations * ListNotificationEvents * ListNotificationHubs UserNotifications / Paginator / ListEventRules ListEventRules ************** class UserNotifications.Paginator.ListEventRules paginator = client.get_paginator('list_event_rules') paginate(**kwargs) Creates an iterator that will paginate through responses from "UserNotifications.Client.list_event_rules()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( notificationConfigurationArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **notificationConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "NotificationConfiguration". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'eventRules': [ { 'arn': 'string', 'notificationConfigurationArn': 'string', 'creationTime': datetime(2015, 1, 1), 'source': 'string', 'eventType': 'string', 'eventPattern': 'string', 'regions': [ 'string', ], 'managedRules': [ 'string', ], 'statusSummaryByRegion': { 'string': { 'status': 'ACTIVE'|'INACTIVE'|'CREATING'|'UPDATING'|'DELETING', 'reason': 'string' } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **eventRules** *(list) --* A list of "EventRules". * *(dict) --* Contains a complete list of fields related to an "EventRule". * **arn** *(string) --* The Amazon Resource Name (ARN) of the "EventRule". CloudFormation stack generates this ARN and then uses this ARN to associate with the "NotificationConfiguration". * **notificationConfigurationArn** *(string) --* The ARN for the "NotificationConfiguration" associated with this "EventRule". * **creationTime** *(datetime) --* The creation time of the "EventRule". * **source** *(string) --* The event source this rule should match with the EventBridge event sources. It must match with atleast one of the valid EventBridge event 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 this rule should match with the EventBridge events. It must match with atleast one of the valid EventBridge event types. For example, Amazon EC2 Instance State change Notification and Amazon CloudWatch State Change. For more information, see Event delivery from Amazon Web Services services in the *Amazon EventBridge User Guide*. * **eventPattern** *(string) --* An additional event pattern used to further filter the events this "EventRule" receives. For more information, see Amazon EventBridge event patterns in the *Amazon EventBridge User Guide.* * **regions** *(list) --* A list of Amazon Web Services Regions that send events to this "EventRule". * *(string) --* * **managedRules** *(list) --* A list of Amazon EventBridge Managed Rule ARNs associated with this "EventRule". Note: These are created by User Notifications within your account so your "EventRules" can function. * *(string) --* * **statusSummaryByRegion** *(dict) --* A list of an "EventRule"'s status by Region. Regions are mapped to "EventRuleStatusSummary". * *(string) --* * *(dict) --* Provides additional information about the current "EventRule" status. * **status** *(string) --* The status of the "EventRule". * Values: * "ACTIVE" * The "EventRule" can process events. * "INACTIVE" * The "EventRule" may be unable to process events. * "CREATING" * The "EventRule" is being created. Only "GET" and "LIST" calls can be run. * "UPDATING" * The "EventRule" is being updated. Only "GET" and "LIST" calls can be run. * "DELETING" * The "EventRule" is being deleted. Only "GET" and "LIST" calls can be run. * **reason** *(string) --* A human-readable reason for "EventRuleStatus". * **NextToken** *(string) --* A token to resume pagination. UserNotifications / Paginator / ListChannels ListChannels ************ class UserNotifications.Paginator.ListChannels paginator = client.get_paginator('list_channels') paginate(**kwargs) Creates an iterator that will paginate through responses from "UserNotifications.Client.list_channels()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( notificationConfigurationArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **notificationConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "NotificationConfiguration". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'channels': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **channels** *(list) --* A list of Channels. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. UserNotifications / Paginator / ListManagedNotificationEvents ListManagedNotificationEvents ***************************** class UserNotifications.Paginator.ListManagedNotificationEvents paginator = client.get_paginator('list_managed_notification_events') paginate(**kwargs) Creates an iterator that will paginate through responses from "UserNotifications.Client.list_managed_notification_events()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( 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', organizationalUnitId='string', relatedAccount='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **startTime** (*datetime*) -- The earliest time of events to return from this call. * **endTime** (*datetime*) -- Latest time of events to return from this call. * **locale** (*string*) -- The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US). * **source** (*string*) -- The Amazon Web Services service the event originates from. For example aws.cloudwatch. * **organizationalUnitId** (*string*) -- The Organizational Unit Id that an Amazon Web Services account belongs to. * **relatedAccount** (*string*) -- The Amazon Web Services account ID associated with the Managed Notification Events. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { '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', ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **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) --* * **NextToken** *(string) --* A token to resume pagination. UserNotifications / Paginator / ListManagedNotificationConfigurations ListManagedNotificationConfigurations ************************************* class UserNotifications.Paginator.ListManagedNotificationConfigurations paginator = client.get_paginator('list_managed_notification_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from " UserNotifications.Client.list_managed_notification_configuratio ns()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( channelIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **channelIdentifier** (*string*) -- The identifier or ARN of the notification channel to filter configurations by. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'managedNotificationConfigurations': [ { 'arn': 'string', 'name': 'string', 'description': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **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". * **NextToken** *(string) --* A token to resume pagination. UserNotifications / Paginator / ListManagedNotificationChildEvents ListManagedNotificationChildEvents ********************************** class UserNotifications.Paginator.ListManagedNotificationChildEvents paginator = client.get_paginator('list_managed_notification_child_events') paginate(**kwargs) Creates an iterator that will paginate through responses from " UserNotifications.Client.list_managed_notification_child_events ()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( 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', relatedAccount='string', organizationalUnitId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **aggregateManagedNotificationEventArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "ManagedNotificationEvent". * **startTime** (*datetime*) -- The earliest time of events to return from this call. * **endTime** (*datetime*) -- Latest time of events to return from this call. * **locale** (*string*) -- The locale code of the language used for the retrieved "NotificationEvent". The default locale is English. "en_US". * **relatedAccount** (*string*) -- The Amazon Web Services account ID associated with the Managed Notification Child Events. * **organizationalUnitId** (*string*) -- The identifier of the Amazon Web Services Organizations organizational unit (OU) associated with the Managed Notification Child Events. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { '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' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **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. * **NextToken** *(string) --* A token to resume pagination. UserNotifications / Paginator / ListManagedNotificationChannelAssociations ListManagedNotificationChannelAssociations ****************************************** class UserNotifications.Paginator.ListManagedNotificationChannelAssociations paginator = client.get_paginator('list_managed_notification_channel_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from " UserNotifications.Client.list_managed_notification_channel_asso ciations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( managedNotificationConfigurationArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **managedNotificationConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "ManagedNotificationConfiguration" to match. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'channelAssociations': [ { 'channelIdentifier': 'string', 'channelType': 'MOBILE'|'CHATBOT'|'EMAIL'|'ACCOUNT_CONTACT', 'overrideOption': 'ENABLED'|'DISABLED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **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). * "EMAIL" * 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. * **NextToken** *(string) --* A token to resume pagination. UserNotifications / Paginator / ListNotificationConfigurations ListNotificationConfigurations ****************************** class UserNotifications.Paginator.ListNotificationConfigurations paginator = client.get_paginator('list_notification_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from "UserNotifications.Client.list_notification_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( eventRuleSource='string', channelArn='string', status='ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **eventRuleSource** (*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*. * **channelArn** (*string*) -- The Amazon Resource Name (ARN) of the Channel to match. * **status** (*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. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'notificationConfigurations': [ { 'arn': 'string', 'name': 'string', 'description': 'string', 'status': 'ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING', 'creationTime': datetime(2015, 1, 1), 'aggregationDuration': 'LONG'|'SHORT'|'NONE' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **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. * **NextToken** *(string) --* A token to resume pagination. UserNotifications / Paginator / ListNotificationHubs ListNotificationHubs ******************** class UserNotifications.Paginator.ListNotificationHubs paginator = client.get_paginator('list_notification_hubs') paginate(**kwargs) Creates an iterator that will paginate through responses from "UserNotifications.Client.list_notification_hubs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'notificationHubs': [ { 'notificationHubRegion': 'string', 'statusSummary': { 'status': 'ACTIVE'|'REGISTERING'|'DEREGISTERING'|'INACTIVE', 'reason': 'string' }, 'creationTime': datetime(2015, 1, 1), 'lastActivationTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **notificationHubs** *(list) --* The "NotificationHubs" in the account. * *(dict) --* Describes an overview of a "NotificationHub". A "NotificationConfiguration" is an account-level setting used to select the Regions where you want to store, process and replicate your notifications. * **notificationHubRegion** *(string) --* The Region of the resource. * **statusSummary** *(dict) --* The status summary of the resource. * **status** *(string) --* Status information about the "NotificationHub". * Values: * "ACTIVE" * Incoming "NotificationEvents" are replicated to this "NotificationHub". * "REGISTERING" * The "NotificationConfiguration" is initializing. A "NotificationConfiguration" with this status can't be deregistered. * "DEREGISTERING" * The "NotificationConfiguration" is being deleted. You can't register additional "NotificationHubs" in the same Region as a "NotificationConfiguration" with this status. * **reason** *(string) --* An explanation for the current status. * **creationTime** *(datetime) --* The date and time the "NotificationHubOverview" was created. * **lastActivationTime** *(datetime) --* The most recent time this "NotificationHub" had an "ACTIVE" status. * **NextToken** *(string) --* A token to resume pagination. UserNotifications / Paginator / ListNotificationEvents ListNotificationEvents ********************** class UserNotifications.Paginator.ListNotificationEvents paginator = client.get_paginator('list_notification_events') paginate(**kwargs) Creates an iterator that will paginate through responses from "UserNotifications.Client.list_notification_events()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( 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', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **startTime** (*datetime*) -- The earliest time of events to return from this call. * **endTime** (*datetime*) -- Latest time of events to return from this call. * **locale** (*string*) -- The locale code of the language used for the retrieved "NotificationEvent". The default locale is English "(en_US)". * **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*. * **includeChildEvents** (*boolean*) -- Include aggregated child events in the result. * **aggregateNotificationEventArn** (*string*) -- The Amazon Resource Name (ARN) of the "aggregatedNotificationEventArn" to match. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { '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', ] }, ] } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **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) --* * **NextToken** *(string) --* A token to resume pagination. UserNotifications / Client / delete_notification_configuration delete_notification_configuration ********************************* UserNotifications.Client.delete_notification_configuration(**kwargs) Deletes a "NotificationConfiguration". See also: AWS API Documentation **Request Syntax** response = client.delete_notification_configuration( arn='string' ) Parameters: **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "NotificationConfiguration" to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ConflictException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / get_paginator get_paginator ************* UserNotifications.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. UserNotifications / Client / list_notification_configurations list_notification_configurations ******************************** UserNotifications.Client.list_notification_configurations(**kwargs) Returns a list of abbreviated "NotificationConfigurations" according to specified filters, in reverse chronological order (newest first). See also: AWS API Documentation **Request Syntax** response = client.list_notification_configurations( eventRuleSource='string', channelArn='string', status='ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING', maxResults=123, nextToken='string' ) Parameters: * **eventRuleSource** (*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*. * **channelArn** (*string*) -- The Amazon Resource Name (ARN) of the Channel to match. * **status** (*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. * **maxResults** (*integer*) -- The maximum number of results to be returned in this call. Defaults to 20. * **nextToken** (*string*) -- The start token for paginated calls. Retrieved from the response of a previous "ListEventRules" call. Next token uses Base64 encoding. Return type: dict Returns: **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' }, ] } **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. **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" UserNotifications / Client / list_channels list_channels ************* UserNotifications.Client.list_channels(**kwargs) Returns a list of Channels for a "NotificationConfiguration". See also: AWS API Documentation **Request Syntax** response = client.list_channels( notificationConfigurationArn='string', maxResults=123, nextToken='string' ) Parameters: * **notificationConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "NotificationConfiguration". * **maxResults** (*integer*) -- The maximum number of results to be returned in this call. The default value is 20. * **nextToken** (*string*) -- The start token for paginated calls. Retrieved from the response of a previous ListNotificationEvents call. "NextToken" uses Base64 encoding. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'channels': [ '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. * **channels** *(list) --* A list of Channels. * *(string) --* **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / register_notification_hub register_notification_hub ************************* UserNotifications.Client.register_notification_hub(**kwargs) Registers a "NotificationConfiguration" in the specified Region. There is a maximum of one "NotificationConfiguration" per Region. You can have a maximum of 3 "NotificationHub" resources at a time. See also: AWS API Documentation **Request Syntax** response = client.register_notification_hub( notificationHubRegion='string' ) Parameters: **notificationHubRegion** (*string*) -- **[REQUIRED]** The Region of the "NotificationHub". Return type: dict Returns: **Response Syntax** { 'notificationHubRegion': 'string', 'statusSummary': { 'status': 'ACTIVE'|'REGISTERING'|'DEREGISTERING'|'INACTIVE', 'reason': 'string' }, 'creationTime': datetime(2015, 1, 1), 'lastActivationTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **notificationHubRegion** *(string) --* The Region of the "NotificationHub". * **statusSummary** *(dict) --* Provides additional information about the current "NotificationConfiguration" status information. * **status** *(string) --* Status information about the "NotificationHub". * Values: * "ACTIVE" * Incoming "NotificationEvents" are replicated to this "NotificationHub". * "REGISTERING" * The "NotificationConfiguration" is initializing. A "NotificationConfiguration" with this status can't be deregistered. * "DEREGISTERING" * The "NotificationConfiguration" is being deleted. You can't register additional "NotificationHubs" in the same Region as a "NotificationConfiguration" with this status. * **reason** *(string) --* An explanation for the current status. * **creationTime** *(datetime) --* The date the resource was created. * **lastActivationTime** *(datetime) --* The date the resource was last activated. **Exceptions** * "UserNotifications.Client.exceptions.ServiceQuotaExceededExcepti on" * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ConflictException" UserNotifications / Client / deregister_notification_hub deregister_notification_hub *************************** UserNotifications.Client.deregister_notification_hub(**kwargs) Deregisters a "NotificationConfiguration" in the specified Region. Note: You can't deregister the last "NotificationHub" in the account. "NotificationEvents" stored in the deregistered "NotificationConfiguration" are no longer be visible. Recreating a new "NotificationConfiguration" in the same Region restores access to those "NotificationEvents". See also: AWS API Documentation **Request Syntax** response = client.deregister_notification_hub( notificationHubRegion='string' ) Parameters: **notificationHubRegion** (*string*) -- **[REQUIRED]** The "NotificationConfiguration" Region. Return type: dict Returns: **Response Syntax** { 'notificationHubRegion': 'string', 'statusSummary': { 'status': 'ACTIVE'|'REGISTERING'|'DEREGISTERING'|'INACTIVE', 'reason': 'string' } } **Response Structure** * *(dict) --* * **notificationHubRegion** *(string) --* The "NotificationConfiguration" Region. * **statusSummary** *(dict) --* "NotificationConfiguration" status information. * **status** *(string) --* Status information about the "NotificationHub". * Values: * "ACTIVE" * Incoming "NotificationEvents" are replicated to this "NotificationHub". * "REGISTERING" * The "NotificationConfiguration" is initializing. A "NotificationConfiguration" with this status can't be deregistered. * "DEREGISTERING" * The "NotificationConfiguration" is being deleted. You can't register additional "NotificationHubs" in the same Region as a "NotificationConfiguration" with this status. * **reason** *(string) --* An explanation for the current status. **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ConflictException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / can_paginate can_paginate ************ UserNotifications.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. UserNotifications / Client / get_notification_event get_notification_event ********************** UserNotifications.Client.get_notification_event(**kwargs) Returns a specified "NotificationEvent". Warning: 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 *Amazon Web Services User Notifications User Guide*. See also: AWS API Documentation **Request Syntax** response = 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' ) Parameters: * **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "NotificationEvent" to return. * **locale** (*string*) -- The locale code of the language used for the retrieved "NotificationEvent". The default locale is English "en_US". Return type: dict Returns: **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. Note: Included dimensions, keys, and values are subject to change. * *(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. **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / disable_notifications_access_for_organization disable_notifications_access_for_organization ********************************************* UserNotifications.Client.disable_notifications_access_for_organization() Disables service trust between User Notifications and Amazon Web Services Organizations. See also: AWS API Documentation **Request Syntax** response = client.disable_notifications_access_for_organization() Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotifications.Client.exceptions.ServiceQuotaExceededExcepti on" * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ConflictException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / update_event_rule update_event_rule ***************** UserNotifications.Client.update_event_rule(**kwargs) Updates an existing "EventRule". See also: AWS API Documentation **Request Syntax** response = client.update_event_rule( arn='string', eventPattern='string', regions=[ 'string', ] ) Parameters: * **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) to use to update the "EventRule". * **eventPattern** (*string*) -- An additional event pattern used to further filter the events this "EventRule" receives. For more information, see Amazon EventBridge event patterns in the *Amazon EventBridge User Guide.* * **regions** (*list*) -- A list of Amazon Web Services Regions that sends events to this "EventRule". * *(string) --* Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'notificationConfigurationArn': 'string', 'statusSummaryByRegion': { 'string': { 'status': 'ACTIVE'|'INACTIVE'|'CREATING'|'UPDATING'|'DELETING', 'reason': 'string' } } } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) to use to update the "EventRule". * **notificationConfigurationArn** *(string) --* The ARN of the "NotificationConfiguration". * **statusSummaryByRegion** *(dict) --* The status of the action by Region. * *(string) --* * *(dict) --* Provides additional information about the current "EventRule" status. * **status** *(string) --* The status of the "EventRule". * Values: * "ACTIVE" * The "EventRule" can process events. * "INACTIVE" * The "EventRule" may be unable to process events. * "CREATING" * The "EventRule" is being created. Only "GET" and "LIST" calls can be run. * "UPDATING" * The "EventRule" is being updated. Only "GET" and "LIST" calls can be run. * "DELETING" * The "EventRule" is being deleted. Only "GET" and "LIST" calls can be run. * **reason** *(string) --* A human-readable reason for "EventRuleStatus". **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ConflictException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / create_notification_configuration create_notification_configuration ********************************* UserNotifications.Client.create_notification_configuration(**kwargs) Creates a new "NotificationConfiguration". See also: AWS API Documentation **Request Syntax** response = client.create_notification_configuration( name='string', description='string', aggregationDuration='LONG'|'SHORT'|'NONE', tags={ 'string': 'string' } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the "NotificationConfiguration". Supports RFC 3986's unreserved characters. * **description** (*string*) -- **[REQUIRED]** The description 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. * **tags** (*dict*) -- A map of tags assigned to a resource. A tag is a string-to- string map of key-value pairs. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'status': 'ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the "NotificationConfiguration". * **status** *(string) --* The current status of this "NotificationConfiguration". **Exceptions** * "UserNotifications.Client.exceptions.ServiceQuotaExceededExcepti on" * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ConflictException" UserNotifications / Client / list_tags_for_resource list_tags_for_resource ********************** UserNotifications.Client.list_tags_for_resource(**kwargs) Returns a list of tags for a specified Amazon Resource Name (ARN). For more information, see Tagging your Amazon Web Services resources in the *Tagging Amazon Web Services Resources User Guide*. Note: This is only supported for "NotificationConfigurations". See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( arn='string' ) Parameters: **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) to use to list tags. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* A list of tags for the specified ARN. * *(string) --* * *(string) --* **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / list_managed_notification_configurations list_managed_notification_configurations **************************************** UserNotifications.Client.list_managed_notification_configurations(**kwargs) 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** response = client.list_managed_notification_configurations( channelIdentifier='string', maxResults=123, nextToken='string' ) Parameters: * **channelIdentifier** (*string*) -- The identifier or ARN of the notification channel to filter configurations by. * **maxResults** (*integer*) -- The maximum number of results to be returned in this call. Defaults to 20. * **nextToken** (*string*) -- The start token for paginated calls. Retrieved from the response of a previous ListManagedNotificationChannelAssociations call. Next token uses Base64 encoding. Return type: dict Returns: **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". **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" UserNotifications / Client / list_event_rules list_event_rules **************** UserNotifications.Client.list_event_rules(**kwargs) Returns a list of "EventRules" according to specified filters, in reverse chronological order (newest first). See also: AWS API Documentation **Request Syntax** response = client.list_event_rules( notificationConfigurationArn='string', maxResults=123, nextToken='string' ) Parameters: * **notificationConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "NotificationConfiguration". * **maxResults** (*integer*) -- The maximum number of results to be returned in this call. The default value is 20. * **nextToken** (*string*) -- The start token for paginated calls. Retrieved from the response of a previous "ListEventRules" call. Next token uses Base64 encoding. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'eventRules': [ { 'arn': 'string', 'notificationConfigurationArn': 'string', 'creationTime': datetime(2015, 1, 1), 'source': 'string', 'eventType': 'string', 'eventPattern': 'string', 'regions': [ 'string', ], 'managedRules': [ 'string', ], 'statusSummaryByRegion': { 'string': { 'status': 'ACTIVE'|'INACTIVE'|'CREATING'|'UPDATING'|'DELETING', 'reason': '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. * **eventRules** *(list) --* A list of "EventRules". * *(dict) --* Contains a complete list of fields related to an "EventRule". * **arn** *(string) --* The Amazon Resource Name (ARN) of the "EventRule". CloudFormation stack generates this ARN and then uses this ARN to associate with the "NotificationConfiguration". * **notificationConfigurationArn** *(string) --* The ARN for the "NotificationConfiguration" associated with this "EventRule". * **creationTime** *(datetime) --* The creation time of the "EventRule". * **source** *(string) --* The event source this rule should match with the EventBridge event sources. It must match with atleast one of the valid EventBridge event 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 this rule should match with the EventBridge events. It must match with atleast one of the valid EventBridge event types. For example, Amazon EC2 Instance State change Notification and Amazon CloudWatch State Change. For more information, see Event delivery from Amazon Web Services services in the *Amazon EventBridge User Guide*. * **eventPattern** *(string) --* An additional event pattern used to further filter the events this "EventRule" receives. For more information, see Amazon EventBridge event patterns in the *Amazon EventBridge User Guide.* * **regions** *(list) --* A list of Amazon Web Services Regions that send events to this "EventRule". * *(string) --* * **managedRules** *(list) --* A list of Amazon EventBridge Managed Rule ARNs associated with this "EventRule". Note: These are created by User Notifications within your account so your "EventRules" can function. * *(string) --* * **statusSummaryByRegion** *(dict) --* A list of an "EventRule"'s status by Region. Regions are mapped to "EventRuleStatusSummary". * *(string) --* * *(dict) --* Provides additional information about the current "EventRule" status. * **status** *(string) --* The status of the "EventRule". * Values: * "ACTIVE" * The "EventRule" can process events. * "INACTIVE" * The "EventRule" may be unable to process events. * "CREATING" * The "EventRule" is being created. Only "GET" and "LIST" calls can be run. * "UPDATING" * The "EventRule" is being updated. Only "GET" and "LIST" calls can be run. * "DELETING" * The "EventRule" is being deleted. Only "GET" and "LIST" calls can be run. * **reason** *(string) --* A human-readable reason for "EventRuleStatus". **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / untag_resource untag_resource ************** UserNotifications.Client.untag_resource(**kwargs) Untags a resource with a specified Amazon Resource Name (ARN). For more information, see Tagging your Amazon Web Services resources in the *Tagging Amazon Web Services Resources User Guide*. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( arn='string', tagKeys=[ 'string', ] ) Parameters: * **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) to use to untag a resource. * **tagKeys** (*list*) -- **[REQUIRED]** The tag keys to use to untag a resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / associate_channel associate_channel ***************** UserNotifications.Client.associate_channel(**kwargs) Associates a delivery Channel with a particular "NotificationConfiguration". Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications- contacts). See also: AWS API Documentation **Request Syntax** response = client.associate_channel( arn='string', notificationConfigurationArn='string' ) Parameters: * **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Channel to associate with the "NotificationConfiguration". Supported ARNs include Chatbot, the Console Mobile Application, and notifications-contacts. * **notificationConfigurationArn** (*string*) -- **[REQUIRED]** The ARN of the "NotificationConfiguration" to associate with the Channel. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotifications.Client.exceptions.ServiceQuotaExceededExcepti on" * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ConflictException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / list_managed_notification_events list_managed_notification_events ******************************** UserNotifications.Client.list_managed_notification_events(**kwargs) 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** response = 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' ) Parameters: * **startTime** (*datetime*) -- The earliest time of events to return from this call. * **endTime** (*datetime*) -- Latest time of events to return from this call. * **locale** (*string*) -- The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US). * **source** (*string*) -- The Amazon Web Services service the event originates from. For example aws.cloudwatch. * **maxResults** (*integer*) -- The maximum number of results to be returned in this call. Defaults to 20. * **nextToken** (*string*) -- The start token for paginated calls. Retrieved from the response of a previous "ListManagedNotificationChannelAssociations" call. Next token uses Base64 encoding. * **organizationalUnitId** (*string*) -- The Organizational Unit Id that an Amazon Web Services account belongs to. * **relatedAccount** (*string*) -- The Amazon Web Services account ID associated with the Managed Notification Events. Return type: dict Returns: **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) --* **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" UserNotifications / Client / get_waiter get_waiter ********** UserNotifications.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" UserNotifications / Client / update_notification_configuration update_notification_configuration ********************************* UserNotifications.Client.update_notification_configuration(**kwargs) Updates a "NotificationConfiguration". See also: AWS API Documentation **Request Syntax** response = client.update_notification_configuration( arn='string', name='string', description='string', aggregationDuration='LONG'|'SHORT'|'NONE' ) Parameters: * **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) used to update the "NotificationConfiguration". * **name** (*string*) -- The name of the "NotificationConfiguration". * **description** (*string*) -- The description 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. Return type: dict Returns: **Response Syntax** { 'arn': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* The ARN used to update the "NotificationConfiguration". **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ConflictException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / disassociate_managed_notification_additional_channel disassociate_managed_notification_additional_channel **************************************************** UserNotifications.Client.disassociate_managed_notification_additional_channel(**kwargs) 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** response = client.disassociate_managed_notification_additional_channel( channelArn='string', managedNotificationConfigurationArn='string' ) Parameters: * **channelArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Channel to associate with the "ManagedNotificationConfiguration". * **managedNotificationConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Managed Notification Configuration to associate with the additional Channel. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / list_managed_notification_child_events list_managed_notification_child_events ************************************** UserNotifications.Client.list_managed_notification_child_events(**kwargs) 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** response = 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' ) Parameters: * **aggregateManagedNotificationEventArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "ManagedNotificationEvent". * **startTime** (*datetime*) -- The earliest time of events to return from this call. * **endTime** (*datetime*) -- Latest time of events to return from this call. * **locale** (*string*) -- The locale code of the language used for the retrieved "NotificationEvent". The default locale is English. "en_US". * **maxResults** (*integer*) -- The maximum number of results to be returned in this call. Defaults to 20. * **relatedAccount** (*string*) -- The Amazon Web Services account ID associated with the Managed Notification Child Events. * **organizationalUnitId** (*string*) -- The identifier of the Amazon Web Services Organizations organizational unit (OU) associated with the Managed Notification Child Events. * **nextToken** (*string*) -- The start token for paginated calls. Retrieved from the response of a previous ListManagedNotificationChannelAssociations call. Next token uses Base64 encoding. Return type: dict Returns: **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. **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" UserNotifications / Client / delete_event_rule delete_event_rule ***************** UserNotifications.Client.delete_event_rule(**kwargs) Deletes an "EventRule". See also: AWS API Documentation **Request Syntax** response = client.delete_event_rule( arn='string' ) Parameters: **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "EventRule" to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ConflictException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / list_notification_hubs list_notification_hubs ********************** UserNotifications.Client.list_notification_hubs(**kwargs) Returns a list of "NotificationHubs". See also: AWS API Documentation **Request Syntax** response = client.list_notification_hubs( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of records to list in a single response. * **nextToken** (*string*) -- A pagination token. Set to null to start listing notification hubs from the start. Return type: dict Returns: **Response Syntax** { 'notificationHubs': [ { 'notificationHubRegion': 'string', 'statusSummary': { 'status': 'ACTIVE'|'REGISTERING'|'DEREGISTERING'|'INACTIVE', 'reason': 'string' }, 'creationTime': datetime(2015, 1, 1), 'lastActivationTime': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **notificationHubs** *(list) --* The "NotificationHubs" in the account. * *(dict) --* Describes an overview of a "NotificationHub". A "NotificationConfiguration" is an account-level setting used to select the Regions where you want to store, process and replicate your notifications. * **notificationHubRegion** *(string) --* The Region of the resource. * **statusSummary** *(dict) --* The status summary of the resource. * **status** *(string) --* Status information about the "NotificationHub". * Values: * "ACTIVE" * Incoming "NotificationEvents" are replicated to this "NotificationHub". * "REGISTERING" * The "NotificationConfiguration" is initializing. A "NotificationConfiguration" with this status can't be deregistered. * "DEREGISTERING" * The "NotificationConfiguration" is being deleted. You can't register additional "NotificationHubs" in the same Region as a "NotificationConfiguration" with this status. * **reason** *(string) --* An explanation for the current status. * **creationTime** *(datetime) --* The date and time the "NotificationHubOverview" was created. * **lastActivationTime** *(datetime) --* The most recent time this "NotificationHub" had an "ACTIVE" status. * **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. **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" UserNotifications / Client / create_event_rule create_event_rule ***************** UserNotifications.Client.create_event_rule(**kwargs) Creates an EventRule that is associated with a specified "NotificationConfiguration". See also: AWS API Documentation **Request Syntax** response = client.create_event_rule( notificationConfigurationArn='string', source='string', eventType='string', eventPattern='string', regions=[ 'string', ] ) Parameters: * **notificationConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "NotificationConfiguration" associated with this "EventRule". * **source** (*string*) -- **[REQUIRED]** 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*) -- **[REQUIRED]** 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*. * **eventPattern** (*string*) -- An additional event pattern used to further filter the events this "EventRule" receives. For more information, see Amazon EventBridge event patterns in the *Amazon EventBridge User Guide.* * **regions** (*list*) -- **[REQUIRED]** A list of Amazon Web Services Regions that send events to this "EventRule". * *(string) --* Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'notificationConfigurationArn': 'string', 'statusSummaryByRegion': { 'string': { 'status': 'ACTIVE'|'INACTIVE'|'CREATING'|'UPDATING'|'DELETING', 'reason': 'string' } } } **Response Structure** * *(dict) --* * **arn** *(string) --* The ARN of the resource. * **notificationConfigurationArn** *(string) --* The ARN of a "NotificationConfiguration". * **statusSummaryByRegion** *(dict) --* A list of an "EventRule"'s status by Region. Regions are mapped to "EventRuleStatusSummary". * *(string) --* * *(dict) --* Provides additional information about the current "EventRule" status. * **status** *(string) --* The status of the "EventRule". * Values: * "ACTIVE" * The "EventRule" can process events. * "INACTIVE" * The "EventRule" may be unable to process events. * "CREATING" * The "EventRule" is being created. Only "GET" and "LIST" calls can be run. * "UPDATING" * The "EventRule" is being updated. Only "GET" and "LIST" calls can be run. * "DELETING" * The "EventRule" is being deleted. Only "GET" and "LIST" calls can be run. * **reason** *(string) --* A human-readable reason for "EventRuleStatus". **Exceptions** * "UserNotifications.Client.exceptions.ServiceQuotaExceededExcepti on" * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ConflictException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / enable_notifications_access_for_organization enable_notifications_access_for_organization ******************************************** UserNotifications.Client.enable_notifications_access_for_organization() Enables service trust between User Notifications and Amazon Web Services Organizations. See also: AWS API Documentation **Request Syntax** response = client.enable_notifications_access_for_organization() Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotifications.Client.exceptions.ServiceQuotaExceededExcepti on" * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ConflictException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / get_managed_notification_configuration get_managed_notification_configuration ************************************** UserNotifications.Client.get_managed_notification_configuration(**kwargs) Returns a specified "ManagedNotificationConfiguration". See also: AWS API Documentation **Request Syntax** response = client.get_managed_notification_configuration( arn='string' ) Parameters: **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "ManagedNotificationConfiguration" to return. Return type: dict Returns: **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". **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / get_managed_notification_event get_managed_notification_event ****************************** UserNotifications.Client.get_managed_notification_event(**kwargs) Returns a specified "ManagedNotificationEvent". See also: AWS API Documentation **Request Syntax** response = 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' ) Parameters: * **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "ManagedNotificationEvent" to return. * **locale** (*string*) -- The locale code of the language used for the retrieved "ManagedNotificationEvent". The default locale is English "(en_US)". Return type: dict Returns: **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. Note: Included dimensions, keys, and values are subject to change. * *(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. **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / get_notification_configuration get_notification_configuration ****************************** UserNotifications.Client.get_notification_configuration(**kwargs) Returns a specified "NotificationConfiguration". See also: AWS API Documentation **Request Syntax** response = client.get_notification_configuration( arn='string' ) Parameters: **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "NotificationConfiguration" to return. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'name': 'string', 'description': 'string', 'status': 'ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING', 'creationTime': datetime(2015, 1, 1), 'aggregationDuration': 'LONG'|'SHORT'|'NONE' } **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. **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / close close ***** UserNotifications.Client.close() Closes underlying endpoint connections. UserNotifications / Client / get_managed_notification_child_event get_managed_notification_child_event ************************************ UserNotifications.Client.get_managed_notification_child_event(**kwargs) Returns the child event of a specific given "ManagedNotificationEvent". See also: AWS API Documentation **Request Syntax** response = 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' ) Parameters: * **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "ManagedNotificationChildEvent" to return. * **locale** (*string*) -- The locale code of the language used for the retrieved "ManagedNotificationChildEvent". The default locale is English "en_US". Return type: dict Returns: **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. Note: Included dimensions, keys, and values are subject to change. * *(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. **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / get_event_rule get_event_rule ************** UserNotifications.Client.get_event_rule(**kwargs) Returns a specified "EventRule". See also: AWS API Documentation **Request Syntax** response = client.get_event_rule( arn='string' ) Parameters: **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "EventRule" to return. Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'notificationConfigurationArn': 'string', 'creationTime': datetime(2015, 1, 1), 'source': 'string', 'eventType': 'string', 'eventPattern': 'string', 'regions': [ 'string', ], 'managedRules': [ 'string', ], 'statusSummaryByRegion': { 'string': { 'status': 'ACTIVE'|'INACTIVE'|'CREATING'|'UPDATING'|'DELETING', 'reason': 'string' } } } **Response Structure** * *(dict) --* * **arn** *(string) --* The ARN of the resource. * **notificationConfigurationArn** *(string) --* The ARN of a "NotificationConfiguration". * **creationTime** *(datetime) --* The date when the "EventRule" was created. * **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*. * **eventPattern** *(string) --* An additional event pattern used to further filter the events this "EventRule" receives. For more information, see Amazon EventBridge event patterns in the *Amazon EventBridge User Guide.* * **regions** *(list) --* A list of Amazon Web Services Regions that send events to this "EventRule". * *(string) --* * **managedRules** *(list) --* A list of managed rules from EventBridge that are associated with this "EventRule". Note: These are created by User Notifications within your account so this "EventRule" functions. * *(string) --* * **statusSummaryByRegion** *(dict) --* A list of an "EventRule"'s status by Region. Regions are mapped to "EventRuleStatusSummary". * *(string) --* * *(dict) --* Provides additional information about the current "EventRule" status. * **status** *(string) --* The status of the "EventRule". * Values: * "ACTIVE" * The "EventRule" can process events. * "INACTIVE" * The "EventRule" may be unable to process events. * "CREATING" * The "EventRule" is being created. Only "GET" and "LIST" calls can be run. * "UPDATING" * The "EventRule" is being updated. Only "GET" and "LIST" calls can be run. * "DELETING" * The "EventRule" is being deleted. Only "GET" and "LIST" calls can be run. * **reason** *(string) --* A human-readable reason for "EventRuleStatus". **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / associate_managed_notification_account_contact associate_managed_notification_account_contact ********************************************** UserNotifications.Client.associate_managed_notification_account_contact(**kwargs) Associates an Account Contact with a particular "ManagedNotificationConfiguration". See also: AWS API Documentation **Request Syntax** response = client.associate_managed_notification_account_contact( contactIdentifier='ACCOUNT_PRIMARY'|'ACCOUNT_ALTERNATE_BILLING'|'ACCOUNT_ALTERNATE_OPERATIONS'|'ACCOUNT_ALTERNATE_SECURITY', managedNotificationConfigurationArn='string' ) Parameters: * **contactIdentifier** (*string*) -- **[REQUIRED]** A unique value of an Account Contact Type to associate with the "ManagedNotificationConfiguration". * **managedNotificationConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "ManagedNotificationConfiguration" to associate with the Account Contact. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotifications.Client.exceptions.ServiceQuotaExceededExcepti on" * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ConflictException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / get_notifications_access_for_organization get_notifications_access_for_organization ***************************************** UserNotifications.Client.get_notifications_access_for_organization() Returns the AccessStatus of Service Trust Enablement for User Notifications and Amazon Web Services Organizations. See also: AWS API Documentation **Request Syntax** response = client.get_notifications_access_for_organization() Return type: dict Returns: **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. **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" UserNotifications / Client / disassociate_managed_notification_account_contact disassociate_managed_notification_account_contact ************************************************* UserNotifications.Client.disassociate_managed_notification_account_contact(**kwargs) Disassociates an Account Contact with a particular "ManagedNotificationConfiguration". See also: AWS API Documentation **Request Syntax** response = client.disassociate_managed_notification_account_contact( contactIdentifier='ACCOUNT_PRIMARY'|'ACCOUNT_ALTERNATE_BILLING'|'ACCOUNT_ALTERNATE_OPERATIONS'|'ACCOUNT_ALTERNATE_SECURITY', managedNotificationConfigurationArn='string' ) Parameters: * **contactIdentifier** (*string*) -- **[REQUIRED]** The unique value of an Account Contact Type to associate with the "ManagedNotificationConfiguration". * **managedNotificationConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "ManagedNotificationConfiguration" to associate with the Account Contact. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ConflictException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / tag_resource tag_resource ************ UserNotifications.Client.tag_resource(**kwargs) Tags the resource with a tag key and value. For more information, see Tagging your Amazon Web Services resources in the *Tagging Amazon Web Services Resources User Guide*. Note: This is only supported for "NotificationConfigurations". See also: AWS API Documentation **Request Syntax** response = client.tag_resource( arn='string', tags={ 'string': 'string' } ) Parameters: * **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) to use to tag a resource. * **tags** (*dict*) -- **[REQUIRED]** A map of tags assigned to a resource. A tag is a string-to- string map of key-value pairs. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / list_notification_events list_notification_events ************************ UserNotifications.Client.list_notification_events(**kwargs) Returns a list of "NotificationEvents" according to specified filters, in reverse chronological order (newest first). Warning: User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents 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 *Amazon Web Services User Notifications User Guide*. See also: AWS API Documentation **Request Syntax** response = 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' ) Parameters: * **startTime** (*datetime*) -- The earliest time of events to return from this call. * **endTime** (*datetime*) -- Latest time of events to return from this call. * **locale** (*string*) -- The locale code of the language used for the retrieved "NotificationEvent". The default locale is English "(en_US)". * **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*. * **includeChildEvents** (*boolean*) -- Include aggregated child events in the result. * **aggregateNotificationEventArn** (*string*) -- The Amazon Resource Name (ARN) of the "aggregatedNotificationEventArn" to match. * **maxResults** (*integer*) -- The maximum number of results to be returned in this call. Defaults to 20. * **nextToken** (*string*) -- The start token for paginated calls. Retrieved from the response of a previous "ListEventRules" call. Next token uses Base64 encoding. Return type: dict Returns: **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) --* **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" UserNotifications / Client / disassociate_channel disassociate_channel ******************** UserNotifications.Client.disassociate_channel(**kwargs) Disassociates a Channel from a specified "NotificationConfiguration". Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications- contacts). See also: AWS API Documentation **Request Syntax** response = client.disassociate_channel( arn='string', notificationConfigurationArn='string' ) Parameters: * **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Channel to disassociate. * **notificationConfigurationArn** (*string*) -- **[REQUIRED]** The ARN of the "NotificationConfiguration" to disassociate. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / list_managed_notification_channel_associations list_managed_notification_channel_associations ********************************************** UserNotifications.Client.list_managed_notification_channel_associations(**kwargs) Returns a list of Account contacts and Channels associated with a "ManagedNotificationConfiguration", in paginated format. See also: AWS API Documentation **Request Syntax** response = client.list_managed_notification_channel_associations( managedNotificationConfigurationArn='string', maxResults=123, nextToken='string' ) Parameters: * **managedNotificationConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "ManagedNotificationConfiguration" to match. * **maxResults** (*integer*) -- The maximum number of results to be returned in this call. Defaults to 20. * **nextToken** (*string*) -- The start token for paginated calls. Retrieved from the response of a previous "ListManagedNotificationChannelAssociations" call. Return type: dict Returns: **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). * "EMAIL" * 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. **Exceptions** * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ResourceNotFoundException" UserNotifications / Client / associate_managed_notification_additional_channel associate_managed_notification_additional_channel ************************************************* UserNotifications.Client.associate_managed_notification_additional_channel(**kwargs) 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** response = client.associate_managed_notification_additional_channel( channelArn='string', managedNotificationConfigurationArn='string' ) Parameters: * **channelArn** (*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). * **managedNotificationConfigurationArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the "ManagedNotificationConfiguration" to associate with the additional Channel. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotifications.Client.exceptions.ServiceQuotaExceededExcepti on" * "UserNotifications.Client.exceptions.AccessDeniedException" * "UserNotifications.Client.exceptions.ValidationException" * "UserNotifications.Client.exceptions.InternalServerException" * "UserNotifications.Client.exceptions.ThrottlingException" * "UserNotifications.Client.exceptions.ConflictException" * "UserNotifications.Client.exceptions.ResourceNotFoundException"