2024/11/22 - AWS User Notifications - 21 new api methods
Changes This release adds support for AWS User Notifications. You can now configure and view notifications from AWS services in a central location using the AWS SDK.
Returns a specified NotificationConfiguration.
See also: AWS API Documentation
Request Syntax
client.get_notification_configuration(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the NotificationConfiguration to return.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'description': 'string',
'status': 'ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING',
'creationTime': datetime(2015, 1, 1),
'aggregationDuration': 'LONG'|'SHORT'|'NONE'
}
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.
The status should always be INACTIVE when part of the CreateNotificationConfiguration response.
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.
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.
Only GET and LIST calls can be run.
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. No delay in delivery.
Returns a specified EventRule.
See also: AWS API Documentation
Request Syntax
client.get_event_rule(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the EventRule to return.
dict
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 AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from AWS 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 AWS CloudWatch Alarm State Change. For more information, see Event delivery from AWS 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 AWS Regions that send events to this EventRule.
(string) --
managedRules (list) --
A list of managed rules from EventBridge that are are associated with this EventRule.
(string) --
statusSummaryByRegion (dict) --
A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.
(string) --
(dict) --
Describes EventRule status information.
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.
Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).
See also: AWS API Documentation
Request Syntax
client.list_notification_configurations(
eventRuleSource='string',
channelArn='string',
status='ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING',
maxResults=123,
nextToken='string'
)
string
The matched event source.
Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
string
The Amazon Resource Name (ARN) of the Channel to match.
string
The NotificationConfiguration status to match.
Values:
ACTIVE
All EventRules are ACTIVE and any call can be run.
PARTIALLY_ACTIVE
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
Any call can be run.
INACTIVE
All EventRules are INACTIVE and any call can be run.
DELETING
This NotificationConfiguration is being deleted.
Only GET and LIST calls can be run.
integer
The maximum number of results to be returned in this call. Defaults to 20.
string
The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.
dict
Response Syntax
{
'nextToken': 'string',
'notificationConfigurations': [
{
'arn': 'string',
'name': 'string',
'description': 'string',
'status': 'ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING',
'creationTime': datetime(2015, 1, 1),
'aggregationDuration': 'LONG'|'SHORT'|'NONE'
},
]
}
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 resource.
name (string) --
The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.
description (string) --
The description of the NotificationConfiguration.
status (string) --
The status of this NotificationConfiguration.
The status should always be INACTIVE when part of the CreateNotificationConfiguration response.
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.
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.
Only GET and LIST calls can be run.
creationTime (datetime) --
The creation time of the resource.
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. No delay in delivery.
Deregisters a NotificationHub in the specified Region.
See also: AWS API Documentation
Request Syntax
client.deregister_notification_hub(
notificationHubRegion='string'
)
string
[REQUIRED]
The NotificationHub Region.
dict
Response Syntax
{
'notificationHubRegion': 'string',
'statusSummary': {
'status': 'ACTIVE'|'REGISTERING'|'DEREGISTERING'|'INACTIVE',
'reason': 'string'
}
}
Response Structure
(dict) --
notificationHubRegion (string) --
The NotificationHub Region.
statusSummary (dict) --
NotificationHub status information.
status (string) --
Status information about the NotificationHub.
Values:
ACTIVE
Incoming NotificationEvents are replicated to this NotificationHub.
REGISTERING
The NotificationHub is initializing. A NotificationHub with this status can't be deregistered.
DEREGISTERING
The NotificationHub is being deleted. You can't register additional NotificationHubs in the same Region as a NotificationHub with this status.
reason (string) --
An Explanation for the current status.
Returns a list of Channels for a NotificationConfiguration.
See also: AWS API Documentation
Request Syntax
client.list_channels(
notificationConfigurationArn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the NotificationConfiguration.
integer
The maximum number of results to be returned in this call. The default value is 20.
string
The start token for paginated calls. Retrieved from the response of a previous ListNotificationEvents call. NextToken uses Base64 encoding.
dict
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) --
Associates a delivery Channel with a particular NotificationConfiguration. Supported Channels include AWS Chatbot, the AWS Console Mobile Application, and emails (notifications-contacts).
See also: AWS API Documentation
Request Syntax
client.associate_channel(
arn='string',
notificationConfigurationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Channel to associate with the NotificationConfiguration.
Supported ARNs include AWS Chatbot, the Console Mobile Application, and notifications-contacts.
string
[REQUIRED]
The ARN of the NotificationConfiguration to associate with the Channel.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a new NotificationConfiguration.
See also: AWS API Documentation
Request Syntax
client.create_notification_configuration(
name='string',
description='string',
aggregationDuration='LONG'|'SHORT'|'NONE',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.
string
[REQUIRED]
The description of the NotificationConfiguration.
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. No delay in delivery.
dict
A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'status': 'ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the the resource.
status (string) --
The status of this NotificationConfiguration.
The status should always be INACTIVE when part of the CreateNotificationConfiguration response.
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.
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.
Deletes an EventRule.
See also: AWS API Documentation
Request Syntax
client.delete_event_rule(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the EventRule to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Tags the resource with a tag key and value.
For more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
arn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) to use to tag a resource.
dict
[REQUIRED]
A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Updates an existing EventRule.
See also: AWS API Documentation
Request Syntax
client.update_event_rule(
arn='string',
eventPattern='string',
regions=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) to use to update the EventRule.
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.
list
A list of AWS Regions that sends events to this EventRule.
(string) --
dict
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) --
Describes EventRule status information.
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.
Deletes a NotificationConfiguration.
See also: AWS API Documentation
Request Syntax
client.delete_notification_configuration(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the NotificationConfiguration to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).
See also: AWS API Documentation
Request Syntax
client.list_notification_events(
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
locale='de_DE'|'en_CA'|'en_US'|'en_UK'|'es_ES'|'fr_CA'|'fr_FR'|'id_ID'|'it_IT'|'ja_JP'|'ko_KR'|'pt_BR'|'tr_TR'|'zh_CN'|'zh_TW',
source='string',
includeChildEvents=True|False,
aggregateNotificationEventArn='string',
maxResults=123,
nextToken='string'
)
datetime
The earliest time of events to return from this call.
datetime
Latest time of events to return from this call.
string
The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US).
string
The matched event source.
Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
boolean
Include aggregated child events in the result.
string
The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn to match.
integer
The maximum number of results to be returned in this call. Defaults to 20.
string
The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.
dict
Response Syntax
{
'nextToken': 'string',
'notificationEvents': [
{
'arn': 'string',
'notificationConfigurationArn': 'string',
'relatedAccount': 'string',
'creationTime': datetime(2015, 1, 1),
'notificationEvent': {
'schemaVersion': 'v1.0',
'sourceEventMetadata': {
'eventOriginRegion': 'string',
'source': 'string',
'eventType': 'string'
},
'messageComponents': {
'headline': 'string'
},
'eventStatus': 'HEALTHY'|'UNHEALTHY',
'notificationType': 'ALERT'|'WARNING'|'ANNOUNCEMENT'|'INFORMATIONAL'
},
'aggregationEventType': 'AGGREGATE'|'CHILD'|'NONE',
'aggregateNotificationEventArn': 'string'
},
]
}
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 AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from AWS 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 AWS CloudWatch Alarm State Change. For more information, see Event delivery from AWS 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) --
The notification event status.
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 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.
Registers a NotificationHub in the specified Region.
There is a maximum of one NotificationHub per Region. You can have a maximum of 3 NotificationHubs at a time.
See also: AWS API Documentation
Request Syntax
client.register_notification_hub(
notificationHubRegion='string'
)
string
[REQUIRED]
The Region of the NotificationHub.
dict
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) --
NotificationHub status information.
status (string) --
Status information about the NotificationHub.
Values:
ACTIVE
Incoming NotificationEvents are replicated to this NotificationHub.
REGISTERING
The NotificationHub is initializing. A NotificationHub with this status can't be deregistered.
DEREGISTERING
The NotificationHub is being deleted. You can't register additional NotificationHubs in the same Region as a NotificationHub 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.
Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).
See also: AWS API Documentation
Request Syntax
client.list_event_rules(
notificationConfigurationArn='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the NotificationConfiguration.
integer
The maximum number of results to be returned in this call. The default value is 20.
string
The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.
dict
Response Syntax
{
'nextToken': 'string',
'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 resource.
notificationConfigurationArn (string) --
The ARN for the NotificationConfiguration associated with this EventRule.
creationTime (datetime) --
The creation time of the resource.
source (string) --
The matched event source.
Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from AWS 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 AWS CloudWatch Alarm State Change. For more information, see Event delivery from AWS 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 AWS Regions that send events to this EventRule.
(string) --
managedRules (list) --
A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.
(string) --
statusSummaryByRegion (dict) --
A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.
(string) --
(dict) --
Describes EventRule status information.
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.
Returns a list of NotificationHubs.
See also: AWS API Documentation
Request Syntax
client.list_notification_hubs(
maxResults=123,
nextToken='string'
)
integer
The maximum number of records to list in a single response.
string
A pagination token. Set to null to start listing notification hubs from the start.
dict
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 NotificationHub 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 NotificationHub is initializing. A NotificationHub with this status can't be deregistered.
DEREGISTERING
The NotificationHub is being deleted. You can't register additional NotificationHubs in the same Region as a NotificationHub with this status.
reason (string) --
An Explanation for the current status.
creationTime (datetime) --
The date and time the resource 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.
Untags a resource with a specified Amazon Resource Name (ARN).
For more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
arn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) to use to untag a resource.
list
[REQUIRED]
The tag keys to use to untag a resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Returns a specified NotificationEvent.
See also: AWS API Documentation
Request Syntax
client.get_notification_event(
arn='string',
locale='de_DE'|'en_CA'|'en_US'|'en_UK'|'es_ES'|'fr_CA'|'fr_FR'|'id_ID'|'it_IT'|'ja_JP'|'ko_KR'|'pt_BR'|'tr_TR'|'zh_CN'|'zh_TW'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the NotificationEvent to return.
string
The locale code of the language used for the retrieved NotificationEvent. The default locale is English en_US.
dict
Response Syntax
{
'arn': 'string',
'notificationConfigurationArn': 'string',
'creationTime': datetime(2015, 1, 1),
'content': {
'schemaVersion': 'v1.0',
'id': 'string',
'sourceEventMetadata': {
'eventTypeVersion': 'string',
'sourceEventId': 'string',
'eventOriginRegion': 'string',
'relatedAccount': 'string',
'source': 'string',
'eventOccurrenceTime': datetime(2015, 1, 1),
'eventType': 'string',
'relatedResources': [
{
'id': 'string',
'arn': 'string',
'detailUrl': 'string',
'tags': [
'string',
]
},
]
},
'messageComponents': {
'headline': 'string',
'paragraphSummary': 'string',
'completeDescription': 'string',
'dimensions': [
{
'name': 'string',
'value': 'string'
},
]
},
'sourceEventDetailUrl': 'string',
'sourceEventDetailUrlDisplayText': 'string',
'notificationType': 'ALERT'|'WARNING'|'ANNOUNCEMENT'|'INFORMATIONAL',
'eventStatus': 'HEALTHY'|'UNHEALTHY',
'aggregationEventType': 'AGGREGATE'|'CHILD'|'NONE',
'aggregateNotificationEventArn': 'string',
'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 AWS account of Source Event
source (string) --
The AWS servvice 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 AWS 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, AWS Chatbot notifications.
completeDescription (string) --
A complete summary with all possible relevant information.
dimensions (list) --
A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.
(dict) --
The key-value pair of properties for an event.
name (string) --
The name of the dimension
value (string) --
The value of the dimension.
sourceEventDetailUrl (string) --
The source event URL.
sourceEventDetailUrlDisplayText (string) --
The detailed URL for the source event.
notificationType (string) --
The type of event causing the notification.
Values:
ALERT
A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.
WARNING
A notification about an event where an issue is about to arise. For example, something is approaching a threshold.
ANNOUNCEMENT
A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.
INFORMATIONAL
A notification about informational messages. For example, recommendations, service announcements, or reminders.
eventStatus (string) --
The assesed nature of the event.
Values:
HEALTHY
All EventRules are ACTIVE and any call can be run.
UNHEALTHY
Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.
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) --
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.
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 hyperlinked 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.
Disassociates a Channel from a specified NotificationConfiguration. Supported Channels include AWS Chatbot, the AWS Console Mobile Application, and emails (notifications-contacts).
See also: AWS API Documentation
Request Syntax
client.disassociate_channel(
arn='string',
notificationConfigurationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Channel to disassociate.
string
[REQUIRED]
The ARN of the NotificationConfiguration to disassociate.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates an EventRule that is associated with a specified Notification Configuration.
See also: AWS API Documentation
Request Syntax
client.create_event_rule(
notificationConfigurationArn='string',
source='string',
eventType='string',
eventPattern='string',
regions=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the NotificationConfiguration associated with this EventRule.
string
[REQUIRED]
The matched event source.
Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
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 AWS CloudWatch Alarm State Change. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
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.
list
[REQUIRED]
A list of AWS Regions that send events to this EventRule.
(string) --
dict
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) --
Describes EventRule status information.
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.
Updates a NotificationConfiguration.
See also: AWS API Documentation
Request Syntax
client.update_notification_configuration(
arn='string',
name='string',
description='string',
aggregationDuration='LONG'|'SHORT'|'NONE'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) used to update the NotificationConfiguration.
string
The name of the NotificationConfiguration.
string
The description of the NotificationConfiguration.
string
The status of this NotificationConfiguration.
The status should always be INACTIVE when part of the CreateNotificationConfiguration response.
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.
dict
Response Syntax
{
'arn': 'string'
}
Response Structure
(dict) --
arn (string) --
The ARN used to update the NotificationConfiguration.
Returns a list of tags for a specified Amazon Resource Name (ARN).
For more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) to use to list tags.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
A list of tags for the specified ARN.
(string) --
(string) --