aws-sdk-notifications 1.1.0 → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-notifications/client.rb +803 -113
- data/lib/aws-sdk-notifications/client_api.rb +521 -0
- data/lib/aws-sdk-notifications/types.rb +1632 -390
- data/lib/aws-sdk-notifications.rb +1 -1
- data/sig/client.rbs +169 -0
- data/sig/types.rbs +299 -0
- metadata +2 -2
@@ -23,16 +23,91 @@ module Aws::Notifications
|
|
23
23
|
include Aws::Structure
|
24
24
|
end
|
25
25
|
|
26
|
+
# Provides detailed information about the dimensions used for
|
27
|
+
# aggregation.
|
28
|
+
#
|
29
|
+
# @!attribute [rw] summarization_dimensions
|
30
|
+
# Properties used to summarize aggregated events.
|
31
|
+
# @return [Array<Types::SummarizationDimensionDetail>]
|
32
|
+
#
|
33
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/AggregationDetail AWS API Documentation
|
34
|
+
#
|
35
|
+
class AggregationDetail < Struct.new(
|
36
|
+
:summarization_dimensions)
|
37
|
+
SENSITIVE = []
|
38
|
+
include Aws::Structure
|
39
|
+
end
|
40
|
+
|
41
|
+
# Key-value collection that indicate how notifications are grouped.
|
42
|
+
#
|
43
|
+
# @!attribute [rw] name
|
44
|
+
# Indicates the type of aggregation key.
|
45
|
+
# @return [String]
|
46
|
+
#
|
47
|
+
# @!attribute [rw] value
|
48
|
+
# Indicates the value associated with the aggregation key name.
|
49
|
+
# @return [String]
|
50
|
+
#
|
51
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/AggregationKey AWS API Documentation
|
52
|
+
#
|
53
|
+
class AggregationKey < Struct.new(
|
54
|
+
:name,
|
55
|
+
:value)
|
56
|
+
SENSITIVE = []
|
57
|
+
include Aws::Structure
|
58
|
+
end
|
59
|
+
|
60
|
+
# Provides additional information about the aggregation key.
|
61
|
+
#
|
62
|
+
# @!attribute [rw] event_count
|
63
|
+
# Indicates the number of events associated with the aggregation key.
|
64
|
+
# @return [Integer]
|
65
|
+
#
|
66
|
+
# @!attribute [rw] aggregated_by
|
67
|
+
# Indicates the criteria or rules by which notifications have been
|
68
|
+
# grouped together.
|
69
|
+
# @return [Array<Types::AggregationKey>]
|
70
|
+
#
|
71
|
+
# @!attribute [rw] aggregated_accounts
|
72
|
+
# Indicates the Amazon Web Services accounts in the aggregation key.
|
73
|
+
# @return [Types::SummarizationDimensionOverview]
|
74
|
+
#
|
75
|
+
# @!attribute [rw] aggregated_regions
|
76
|
+
# Indicates the Amazon Web Services Regions in the aggregation key.
|
77
|
+
# @return [Types::SummarizationDimensionOverview]
|
78
|
+
#
|
79
|
+
# @!attribute [rw] aggregated_organizational_units
|
80
|
+
# Indicates the collection of organizational units that are involved
|
81
|
+
# in the aggregation key.
|
82
|
+
# @return [Types::SummarizationDimensionOverview]
|
83
|
+
#
|
84
|
+
# @!attribute [rw] additional_summarization_dimensions
|
85
|
+
# List of additional dimensions used to group and summarize data.
|
86
|
+
# @return [Array<Types::SummarizationDimensionOverview>]
|
87
|
+
#
|
88
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/AggregationSummary AWS API Documentation
|
89
|
+
#
|
90
|
+
class AggregationSummary < Struct.new(
|
91
|
+
:event_count,
|
92
|
+
:aggregated_by,
|
93
|
+
:aggregated_accounts,
|
94
|
+
:aggregated_regions,
|
95
|
+
:aggregated_organizational_units,
|
96
|
+
:additional_summarization_dimensions)
|
97
|
+
SENSITIVE = []
|
98
|
+
include Aws::Structure
|
99
|
+
end
|
100
|
+
|
26
101
|
# @!attribute [rw] arn
|
27
102
|
# The Amazon Resource Name (ARN) of the Channel to associate with the
|
28
|
-
# NotificationConfiguration
|
103
|
+
# `NotificationConfiguration`.
|
29
104
|
#
|
30
|
-
# Supported ARNs include
|
31
|
-
#
|
105
|
+
# Supported ARNs include Chatbot, the Console Mobile Application, and
|
106
|
+
# notifications-contacts.
|
32
107
|
# @return [String]
|
33
108
|
#
|
34
109
|
# @!attribute [rw] notification_configuration_arn
|
35
|
-
# The ARN of the NotificationConfiguration to associate with the
|
110
|
+
# The ARN of the `NotificationConfiguration` to associate with the
|
36
111
|
# Channel.
|
37
112
|
# @return [String]
|
38
113
|
#
|
@@ -49,6 +124,57 @@ module Aws::Notifications
|
|
49
124
|
#
|
50
125
|
class AssociateChannelResponse < Aws::EmptyStructure; end
|
51
126
|
|
127
|
+
# @!attribute [rw] contact_identifier
|
128
|
+
# A unique value of an Account Contact Type to associate with the
|
129
|
+
# `ManagedNotificationConfiguration`.
|
130
|
+
# @return [String]
|
131
|
+
#
|
132
|
+
# @!attribute [rw] managed_notification_configuration_arn
|
133
|
+
# The Amazon Resource Name (ARN) of the
|
134
|
+
# `ManagedNotificationConfiguration` to associate with the Account
|
135
|
+
# Contact.
|
136
|
+
# @return [String]
|
137
|
+
#
|
138
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/AssociateManagedNotificationAccountContactRequest AWS API Documentation
|
139
|
+
#
|
140
|
+
class AssociateManagedNotificationAccountContactRequest < Struct.new(
|
141
|
+
:contact_identifier,
|
142
|
+
:managed_notification_configuration_arn)
|
143
|
+
SENSITIVE = []
|
144
|
+
include Aws::Structure
|
145
|
+
end
|
146
|
+
|
147
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/AssociateManagedNotificationAccountContactResponse AWS API Documentation
|
148
|
+
#
|
149
|
+
class AssociateManagedNotificationAccountContactResponse < Aws::EmptyStructure; end
|
150
|
+
|
151
|
+
# @!attribute [rw] channel_arn
|
152
|
+
# The Amazon Resource Name (ARN) of the Channel to associate with the
|
153
|
+
# `ManagedNotificationConfiguration`.
|
154
|
+
#
|
155
|
+
# Supported ARNs include Chatbot, the Console Mobile Application, and
|
156
|
+
# email (notifications-contacts).
|
157
|
+
# @return [String]
|
158
|
+
#
|
159
|
+
# @!attribute [rw] managed_notification_configuration_arn
|
160
|
+
# The Amazon Resource Name (ARN) of the
|
161
|
+
# `ManagedNotificationConfiguration` to associate with the additional
|
162
|
+
# Channel.
|
163
|
+
# @return [String]
|
164
|
+
#
|
165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/AssociateManagedNotificationAdditionalChannelRequest AWS API Documentation
|
166
|
+
#
|
167
|
+
class AssociateManagedNotificationAdditionalChannelRequest < Struct.new(
|
168
|
+
:channel_arn,
|
169
|
+
:managed_notification_configuration_arn)
|
170
|
+
SENSITIVE = []
|
171
|
+
include Aws::Structure
|
172
|
+
end
|
173
|
+
|
174
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/AssociateManagedNotificationAdditionalChannelResponse AWS API Documentation
|
175
|
+
#
|
176
|
+
class AssociateManagedNotificationAdditionalChannelResponse < Aws::EmptyStructure; end
|
177
|
+
|
52
178
|
# Updating or deleting a resource can cause an inconsistent state.
|
53
179
|
#
|
54
180
|
# @!attribute [rw] message
|
@@ -68,17 +194,18 @@ module Aws::Notifications
|
|
68
194
|
end
|
69
195
|
|
70
196
|
# @!attribute [rw] notification_configuration_arn
|
71
|
-
# The Amazon Resource Name (ARN) of the NotificationConfiguration
|
72
|
-
# associated with this EventRule
|
197
|
+
# The Amazon Resource Name (ARN) of the `NotificationConfiguration`
|
198
|
+
# associated with this `EventRule`.
|
73
199
|
# @return [String]
|
74
200
|
#
|
75
201
|
# @!attribute [rw] source
|
76
202
|
# The matched event source.
|
77
203
|
#
|
78
|
-
# Must match one of the valid EventBridge sources. Only
|
79
|
-
# sourced events are supported. For example,
|
80
|
-
# `aws.cloudwatch`. For more information, see [Event
|
81
|
-
# services][1] in the *Amazon
|
204
|
+
# Must match one of the valid EventBridge sources. Only Amazon Web
|
205
|
+
# Services service sourced events are supported. For example,
|
206
|
+
# `aws.ec2` and `aws.cloudwatch`. For more information, see [Event
|
207
|
+
# delivery from Amazon Web Services services][1] in the *Amazon
|
208
|
+
# EventBridge User Guide*.
|
82
209
|
#
|
83
210
|
#
|
84
211
|
#
|
@@ -89,9 +216,10 @@ module Aws::Notifications
|
|
89
216
|
# The event type to match.
|
90
217
|
#
|
91
218
|
# Must match one of the valid Amazon EventBridge event types. For
|
92
|
-
# example, EC2 Instance State-change Notification and
|
93
|
-
# Alarm State Change. For more information, see [Event
|
94
|
-
#
|
219
|
+
# example, EC2 Instance State-change Notification and Amazon
|
220
|
+
# CloudWatch Alarm State Change. For more information, see [Event
|
221
|
+
# delivery from Amazon Web Services services][1] in the *Amazon
|
222
|
+
# EventBridge User Guide*.
|
95
223
|
#
|
96
224
|
#
|
97
225
|
#
|
@@ -100,7 +228,7 @@ module Aws::Notifications
|
|
100
228
|
#
|
101
229
|
# @!attribute [rw] event_pattern
|
102
230
|
# An additional event pattern used to further filter the events this
|
103
|
-
# EventRule receives.
|
231
|
+
# `EventRule` receives.
|
104
232
|
#
|
105
233
|
# For more information, see [Amazon EventBridge event patterns][1] in
|
106
234
|
# the *Amazon EventBridge User Guide.*
|
@@ -111,7 +239,8 @@ module Aws::Notifications
|
|
111
239
|
# @return [String]
|
112
240
|
#
|
113
241
|
# @!attribute [rw] regions
|
114
|
-
# A list of
|
242
|
+
# A list of Amazon Web Services Regions that send events to this
|
243
|
+
# `EventRule`.
|
115
244
|
# @return [Array<String>]
|
116
245
|
#
|
117
246
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/CreateEventRuleRequest AWS API Documentation
|
@@ -131,12 +260,12 @@ module Aws::Notifications
|
|
131
260
|
# @return [String]
|
132
261
|
#
|
133
262
|
# @!attribute [rw] notification_configuration_arn
|
134
|
-
# The ARN of a NotificationConfiguration
|
263
|
+
# The ARN of a `NotificationConfiguration`.
|
135
264
|
# @return [String]
|
136
265
|
#
|
137
266
|
# @!attribute [rw] status_summary_by_region
|
138
|
-
# A list of an EventRule's status by Region. Regions are mapped to
|
139
|
-
# EventRuleStatusSummary
|
267
|
+
# A list of an `EventRule`'s status by Region. Regions are mapped to
|
268
|
+
# `EventRuleStatusSummary`.
|
140
269
|
# @return [Hash<String,Types::EventRuleStatusSummary>]
|
141
270
|
#
|
142
271
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/CreateEventRuleResponse AWS API Documentation
|
@@ -150,16 +279,16 @@ module Aws::Notifications
|
|
150
279
|
end
|
151
280
|
|
152
281
|
# @!attribute [rw] name
|
153
|
-
# The name of the NotificationConfiguration
|
282
|
+
# The name of the `NotificationConfiguration`. Supports RFC 3986's
|
154
283
|
# unreserved characters.
|
155
284
|
# @return [String]
|
156
285
|
#
|
157
286
|
# @!attribute [rw] description
|
158
|
-
# The description of the NotificationConfiguration
|
287
|
+
# The description of the `NotificationConfiguration`.
|
159
288
|
# @return [String]
|
160
289
|
#
|
161
290
|
# @!attribute [rw] aggregation_duration
|
162
|
-
# The aggregation preference of the NotificationConfiguration
|
291
|
+
# The aggregation preference of the `NotificationConfiguration`.
|
163
292
|
#
|
164
293
|
# * Values:
|
165
294
|
#
|
@@ -177,7 +306,7 @@ module Aws::Notifications
|
|
177
306
|
#
|
178
307
|
# * Don't aggregate notifications.
|
179
308
|
#
|
180
|
-
#
|
309
|
+
# ^
|
181
310
|
# @return [String]
|
182
311
|
#
|
183
312
|
# @!attribute [rw] tags
|
@@ -197,37 +326,11 @@ module Aws::Notifications
|
|
197
326
|
end
|
198
327
|
|
199
328
|
# @!attribute [rw] arn
|
200
|
-
# The Amazon Resource Name (ARN) of the
|
329
|
+
# The Amazon Resource Name (ARN) of the `NotificationConfiguration`.
|
201
330
|
# @return [String]
|
202
331
|
#
|
203
332
|
# @!attribute [rw] status
|
204
|
-
# The status of this NotificationConfiguration
|
205
|
-
#
|
206
|
-
# The status should always be `INACTIVE` when part of the
|
207
|
-
# CreateNotificationConfiguration response.
|
208
|
-
#
|
209
|
-
# * Values:
|
210
|
-
#
|
211
|
-
# * `ACTIVE`
|
212
|
-
#
|
213
|
-
# * All EventRules are `ACTIVE` and any call can be run.
|
214
|
-
#
|
215
|
-
# ^
|
216
|
-
# * `PARTIALLY_ACTIVE`
|
217
|
-
#
|
218
|
-
# * Some EventRules are `ACTIVE` and some are `INACTIVE`.
|
219
|
-
#
|
220
|
-
# * Any call can be run.
|
221
|
-
# * `INACTIVE`
|
222
|
-
#
|
223
|
-
# * All EventRules are `INACTIVE` and any call can be run.
|
224
|
-
#
|
225
|
-
# ^
|
226
|
-
# * `DELETING`
|
227
|
-
#
|
228
|
-
# * This NotificationConfiguration is being deleted.
|
229
|
-
#
|
230
|
-
# * Only `GET` and `LIST` calls can be run.
|
333
|
+
# The current status of this `NotificationConfiguration`.
|
231
334
|
# @return [String]
|
232
335
|
#
|
233
336
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/CreateNotificationConfigurationResponse AWS API Documentation
|
@@ -240,7 +343,7 @@ module Aws::Notifications
|
|
240
343
|
end
|
241
344
|
|
242
345
|
# @!attribute [rw] arn
|
243
|
-
# The Amazon Resource Name (ARN) of the EventRule to delete.
|
346
|
+
# The Amazon Resource Name (ARN) of the `EventRule` to delete.
|
244
347
|
# @return [String]
|
245
348
|
#
|
246
349
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DeleteEventRuleRequest AWS API Documentation
|
@@ -256,7 +359,7 @@ module Aws::Notifications
|
|
256
359
|
class DeleteEventRuleResponse < Aws::EmptyStructure; end
|
257
360
|
|
258
361
|
# @!attribute [rw] arn
|
259
|
-
# The Amazon Resource Name (ARN) of the NotificationConfiguration to
|
362
|
+
# The Amazon Resource Name (ARN) of the `NotificationConfiguration` to
|
260
363
|
# delete.
|
261
364
|
# @return [String]
|
262
365
|
#
|
@@ -273,7 +376,7 @@ module Aws::Notifications
|
|
273
376
|
class DeleteNotificationConfigurationResponse < Aws::EmptyStructure; end
|
274
377
|
|
275
378
|
# @!attribute [rw] notification_hub_region
|
276
|
-
# The
|
379
|
+
# The `NotificationConfiguration` Region.
|
277
380
|
# @return [String]
|
278
381
|
#
|
279
382
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DeregisterNotificationHubRequest AWS API Documentation
|
@@ -285,11 +388,11 @@ module Aws::Notifications
|
|
285
388
|
end
|
286
389
|
|
287
390
|
# @!attribute [rw] notification_hub_region
|
288
|
-
# The
|
391
|
+
# The `NotificationConfiguration` Region.
|
289
392
|
# @return [String]
|
290
393
|
#
|
291
394
|
# @!attribute [rw] status_summary
|
292
|
-
#
|
395
|
+
# `NotificationConfiguration` status information.
|
293
396
|
# @return [Types::NotificationHubStatusSummary]
|
294
397
|
#
|
295
398
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DeregisterNotificationHubResponse AWS API Documentation
|
@@ -320,12 +423,22 @@ module Aws::Notifications
|
|
320
423
|
include Aws::Structure
|
321
424
|
end
|
322
425
|
|
426
|
+
# @api private
|
427
|
+
#
|
428
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DisableNotificationsAccessForOrganizationRequest AWS API Documentation
|
429
|
+
#
|
430
|
+
class DisableNotificationsAccessForOrganizationRequest < Aws::EmptyStructure; end
|
431
|
+
|
432
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DisableNotificationsAccessForOrganizationResponse AWS API Documentation
|
433
|
+
#
|
434
|
+
class DisableNotificationsAccessForOrganizationResponse < Aws::EmptyStructure; end
|
435
|
+
|
323
436
|
# @!attribute [rw] arn
|
324
437
|
# The Amazon Resource Name (ARN) of the Channel to disassociate.
|
325
438
|
# @return [String]
|
326
439
|
#
|
327
440
|
# @!attribute [rw] notification_configuration_arn
|
328
|
-
# The ARN of the NotificationConfiguration to disassociate.
|
441
|
+
# The ARN of the `NotificationConfiguration` to disassociate.
|
329
442
|
# @return [String]
|
330
443
|
#
|
331
444
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DisassociateChannelRequest AWS API Documentation
|
@@ -341,42 +454,99 @@ module Aws::Notifications
|
|
341
454
|
#
|
342
455
|
class DisassociateChannelResponse < Aws::EmptyStructure; end
|
343
456
|
|
344
|
-
#
|
457
|
+
# @!attribute [rw] contact_identifier
|
458
|
+
# The unique value of an Account Contact Type to associate with the
|
459
|
+
# `ManagedNotificationConfiguration`.
|
460
|
+
# @return [String]
|
461
|
+
#
|
462
|
+
# @!attribute [rw] managed_notification_configuration_arn
|
463
|
+
# The Amazon Resource Name (ARN) of the
|
464
|
+
# `ManagedNotificationConfiguration` to associate with the Account
|
465
|
+
# Contact.
|
466
|
+
# @return [String]
|
467
|
+
#
|
468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DisassociateManagedNotificationAccountContactRequest AWS API Documentation
|
469
|
+
#
|
470
|
+
class DisassociateManagedNotificationAccountContactRequest < Struct.new(
|
471
|
+
:contact_identifier,
|
472
|
+
:managed_notification_configuration_arn)
|
473
|
+
SENSITIVE = []
|
474
|
+
include Aws::Structure
|
475
|
+
end
|
476
|
+
|
477
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DisassociateManagedNotificationAccountContactResponse AWS API Documentation
|
478
|
+
#
|
479
|
+
class DisassociateManagedNotificationAccountContactResponse < Aws::EmptyStructure; end
|
480
|
+
|
481
|
+
# @!attribute [rw] channel_arn
|
482
|
+
# The Amazon Resource Name (ARN) of the Channel to associate with the
|
483
|
+
# `ManagedNotificationConfiguration`.
|
484
|
+
# @return [String]
|
485
|
+
#
|
486
|
+
# @!attribute [rw] managed_notification_configuration_arn
|
487
|
+
# The Amazon Resource Name (ARN) of the Managed Notification
|
488
|
+
# Configuration to associate with the additional Channel.
|
489
|
+
# @return [String]
|
490
|
+
#
|
491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DisassociateManagedNotificationAdditionalChannelRequest AWS API Documentation
|
492
|
+
#
|
493
|
+
class DisassociateManagedNotificationAdditionalChannelRequest < Struct.new(
|
494
|
+
:channel_arn,
|
495
|
+
:managed_notification_configuration_arn)
|
496
|
+
SENSITIVE = []
|
497
|
+
include Aws::Structure
|
498
|
+
end
|
499
|
+
|
500
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/DisassociateManagedNotificationAdditionalChannelResponse AWS API Documentation
|
501
|
+
#
|
502
|
+
class DisassociateManagedNotificationAdditionalChannelResponse < Aws::EmptyStructure; end
|
503
|
+
|
504
|
+
# @api private
|
505
|
+
#
|
506
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/EnableNotificationsAccessForOrganizationRequest AWS API Documentation
|
507
|
+
#
|
508
|
+
class EnableNotificationsAccessForOrganizationRequest < Aws::EmptyStructure; end
|
509
|
+
|
510
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/EnableNotificationsAccessForOrganizationResponse AWS API Documentation
|
511
|
+
#
|
512
|
+
class EnableNotificationsAccessForOrganizationResponse < Aws::EmptyStructure; end
|
513
|
+
|
514
|
+
# Provides additional information about the current `EventRule` status.
|
345
515
|
#
|
346
516
|
# @!attribute [rw] status
|
347
|
-
# The status of the EventRule
|
517
|
+
# The status of the `EventRule`.
|
348
518
|
#
|
349
519
|
# * Values:
|
350
520
|
#
|
351
521
|
# * `ACTIVE`
|
352
522
|
#
|
353
|
-
# * The EventRule can process events.
|
523
|
+
# * The `EventRule` can process events.
|
354
524
|
#
|
355
525
|
# ^
|
356
526
|
# * `INACTIVE`
|
357
527
|
#
|
358
|
-
# * The EventRule may be unable to process events.
|
528
|
+
# * The `EventRule` may be unable to process events.
|
359
529
|
#
|
360
530
|
# ^
|
361
531
|
# * `CREATING`
|
362
532
|
#
|
363
|
-
# * The EventRule is being created.
|
533
|
+
# * The `EventRule` is being created.
|
364
534
|
#
|
365
535
|
# Only `GET` and `LIST` calls can be run.
|
366
536
|
# * `UPDATING`
|
367
537
|
#
|
368
|
-
# * The EventRule is being updated.
|
538
|
+
# * The `EventRule` is being updated.
|
369
539
|
#
|
370
540
|
# Only `GET` and `LIST` calls can be run.
|
371
541
|
# * `DELETING`
|
372
542
|
#
|
373
|
-
# * The EventRule is being deleted.
|
543
|
+
# * The `EventRule` is being deleted.
|
374
544
|
#
|
375
545
|
# Only `GET` and `LIST` calls can be run.
|
376
546
|
# @return [String]
|
377
547
|
#
|
378
548
|
# @!attribute [rw] reason
|
379
|
-
# A human-readable reason for EventRuleStatus
|
549
|
+
# A human-readable reason for `EventRuleStatus`.
|
380
550
|
# @return [String]
|
381
551
|
#
|
382
552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/EventRuleStatusSummary AWS API Documentation
|
@@ -388,28 +558,30 @@ module Aws::Notifications
|
|
388
558
|
include Aws::Structure
|
389
559
|
end
|
390
560
|
|
391
|
-
# Contains a complete list of fields related to an EventRule
|
561
|
+
# Contains a complete list of fields related to an `EventRule`.
|
392
562
|
#
|
393
563
|
# @!attribute [rw] arn
|
394
|
-
# The Amazon Resource Name (ARN) of the
|
564
|
+
# The Amazon Resource Name (ARN) of the `EventRule`. CloudFormation
|
565
|
+
# stack generates this ARN and then uses this ARN to associate with
|
566
|
+
# the `NotificationConfiguration`.
|
395
567
|
# @return [String]
|
396
568
|
#
|
397
569
|
# @!attribute [rw] notification_configuration_arn
|
398
|
-
# The ARN for the NotificationConfiguration associated with this
|
399
|
-
# EventRule
|
570
|
+
# The ARN for the `NotificationConfiguration` associated with this
|
571
|
+
# `EventRule`.
|
400
572
|
# @return [String]
|
401
573
|
#
|
402
574
|
# @!attribute [rw] creation_time
|
403
|
-
# The creation time of the
|
575
|
+
# The creation time of the `EventRule`.
|
404
576
|
# @return [Time]
|
405
577
|
#
|
406
578
|
# @!attribute [rw] source
|
407
|
-
# The
|
408
|
-
#
|
409
|
-
#
|
410
|
-
#
|
411
|
-
#
|
412
|
-
# services][1] in the
|
579
|
+
# The event source this rule should match with the EventBridge event
|
580
|
+
# sources. It must match with atleast one of the valid EventBridge
|
581
|
+
# event sources. Only Amazon Web Services service sourced events are
|
582
|
+
# supported. For example, `aws.ec2` and `aws.cloudwatch`. For more
|
583
|
+
# information, see [Event delivery from Amazon Web Services
|
584
|
+
# services][1] in the <i> Amazon EventBridge User Guide</i>.
|
413
585
|
#
|
414
586
|
#
|
415
587
|
#
|
@@ -417,12 +589,12 @@ module Aws::Notifications
|
|
417
589
|
# @return [String]
|
418
590
|
#
|
419
591
|
# @!attribute [rw] event_type
|
420
|
-
# The event type
|
421
|
-
#
|
422
|
-
#
|
423
|
-
#
|
424
|
-
#
|
425
|
-
#
|
592
|
+
# The event type this rule should match with the EventBridge events.
|
593
|
+
# It must match with atleast one of the valid EventBridge event types.
|
594
|
+
# For example, Amazon EC2 Instance State change Notification and
|
595
|
+
# Amazon CloudWatch State Change. For more information, see [Event
|
596
|
+
# delivery from Amazon Web Services services][1] in the <i> Amazon
|
597
|
+
# EventBridge User Guide</i>.
|
426
598
|
#
|
427
599
|
#
|
428
600
|
#
|
@@ -431,7 +603,7 @@ module Aws::Notifications
|
|
431
603
|
#
|
432
604
|
# @!attribute [rw] event_pattern
|
433
605
|
# An additional event pattern used to further filter the events this
|
434
|
-
# EventRule receives.
|
606
|
+
# `EventRule` receives.
|
435
607
|
#
|
436
608
|
# For more information, see [Amazon EventBridge event patterns][1] in
|
437
609
|
# the *Amazon EventBridge User Guide.*
|
@@ -442,22 +614,23 @@ module Aws::Notifications
|
|
442
614
|
# @return [String]
|
443
615
|
#
|
444
616
|
# @!attribute [rw] regions
|
445
|
-
# A list of
|
617
|
+
# A list of Amazon Web Services Regions that send events to this
|
618
|
+
# `EventRule`.
|
446
619
|
# @return [Array<String>]
|
447
620
|
#
|
448
621
|
# @!attribute [rw] managed_rules
|
449
622
|
# A list of Amazon EventBridge Managed Rule ARNs associated with this
|
450
|
-
# EventRule
|
623
|
+
# `EventRule`.
|
451
624
|
#
|
452
|
-
# <note markdown="1"> These are created by
|
453
|
-
#
|
625
|
+
# <note markdown="1"> These are created by User Notifications within your account so your
|
626
|
+
# `EventRules` can function.
|
454
627
|
#
|
455
628
|
# </note>
|
456
629
|
# @return [Array<String>]
|
457
630
|
#
|
458
631
|
# @!attribute [rw] status_summary_by_region
|
459
|
-
# A list of an EventRule's status by Region. Regions are mapped to
|
460
|
-
# EventRuleStatusSummary
|
632
|
+
# A list of an `EventRule`'s status by Region. Regions are mapped to
|
633
|
+
# `EventRuleStatusSummary`.
|
461
634
|
# @return [Hash<String,Types::EventRuleStatusSummary>]
|
462
635
|
#
|
463
636
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/EventRuleStructure AWS API Documentation
|
@@ -477,7 +650,7 @@ module Aws::Notifications
|
|
477
650
|
end
|
478
651
|
|
479
652
|
# @!attribute [rw] arn
|
480
|
-
# The Amazon Resource Name (ARN) of the EventRule to return.
|
653
|
+
# The Amazon Resource Name (ARN) of the `EventRule` to return.
|
481
654
|
# @return [String]
|
482
655
|
#
|
483
656
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetEventRuleRequest AWS API Documentation
|
@@ -493,20 +666,21 @@ module Aws::Notifications
|
|
493
666
|
# @return [String]
|
494
667
|
#
|
495
668
|
# @!attribute [rw] notification_configuration_arn
|
496
|
-
# The ARN of a NotificationConfiguration
|
669
|
+
# The ARN of a `NotificationConfiguration`.
|
497
670
|
# @return [String]
|
498
671
|
#
|
499
672
|
# @!attribute [rw] creation_time
|
500
|
-
# The date when the EventRule was created.
|
673
|
+
# The date when the `EventRule` was created.
|
501
674
|
# @return [Time]
|
502
675
|
#
|
503
676
|
# @!attribute [rw] source
|
504
677
|
# The matched event source.
|
505
678
|
#
|
506
|
-
# Must match one of the valid EventBridge sources. Only
|
507
|
-
# sourced events are supported. For example,
|
508
|
-
# `aws.cloudwatch`. For more information, see [Event
|
509
|
-
# services][1] in the *Amazon
|
679
|
+
# Must match one of the valid EventBridge sources. Only Amazon Web
|
680
|
+
# Services service sourced events are supported. For example,
|
681
|
+
# `aws.ec2` and `aws.cloudwatch`. For more information, see [Event
|
682
|
+
# delivery from Amazon Web Services services][1] in the *Amazon
|
683
|
+
# EventBridge User Guide*.
|
510
684
|
#
|
511
685
|
#
|
512
686
|
#
|
@@ -517,9 +691,10 @@ module Aws::Notifications
|
|
517
691
|
# The event type to match.
|
518
692
|
#
|
519
693
|
# Must match one of the valid Amazon EventBridge event types. For
|
520
|
-
# example, EC2 Instance State-change Notification and
|
521
|
-
# Alarm State Change. For more information, see [Event
|
522
|
-
#
|
694
|
+
# example, EC2 Instance State-change Notification and Amazon
|
695
|
+
# CloudWatch Alarm State Change. For more information, see [Event
|
696
|
+
# delivery from Amazon Web Services services][1] in the *Amazon
|
697
|
+
# EventBridge User Guide*.
|
523
698
|
#
|
524
699
|
#
|
525
700
|
#
|
@@ -528,7 +703,7 @@ module Aws::Notifications
|
|
528
703
|
#
|
529
704
|
# @!attribute [rw] event_pattern
|
530
705
|
# An additional event pattern used to further filter the events this
|
531
|
-
# EventRule receives.
|
706
|
+
# `EventRule` receives.
|
532
707
|
#
|
533
708
|
# For more information, see [Amazon EventBridge event patterns][1] in
|
534
709
|
# the *Amazon EventBridge User Guide.*
|
@@ -539,22 +714,23 @@ module Aws::Notifications
|
|
539
714
|
# @return [String]
|
540
715
|
#
|
541
716
|
# @!attribute [rw] regions
|
542
|
-
# A list of
|
717
|
+
# A list of Amazon Web Services Regions that send events to this
|
718
|
+
# `EventRule`.
|
543
719
|
# @return [Array<String>]
|
544
720
|
#
|
545
721
|
# @!attribute [rw] managed_rules
|
546
|
-
# A list of managed rules from EventBridge that are
|
547
|
-
#
|
722
|
+
# A list of managed rules from EventBridge that are associated with
|
723
|
+
# this `EventRule`.
|
548
724
|
#
|
549
|
-
# <note markdown="1"> These are created by
|
550
|
-
#
|
725
|
+
# <note markdown="1"> These are created by User Notifications within your account so this
|
726
|
+
# `EventRule` functions.
|
551
727
|
#
|
552
728
|
# </note>
|
553
729
|
# @return [Array<String>]
|
554
730
|
#
|
555
731
|
# @!attribute [rw] status_summary_by_region
|
556
|
-
# A list of an EventRule's status by Region. Regions are mapped to
|
557
|
-
# EventRuleStatusSummary
|
732
|
+
# A list of an `EventRule`'s status by Region. Regions are mapped to
|
733
|
+
# `EventRuleStatusSummary`.
|
558
734
|
# @return [Hash<String,Types::EventRuleStatusSummary>]
|
559
735
|
#
|
560
736
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetEventRuleResponse AWS API Documentation
|
@@ -574,14 +750,21 @@ module Aws::Notifications
|
|
574
750
|
end
|
575
751
|
|
576
752
|
# @!attribute [rw] arn
|
577
|
-
# The Amazon Resource Name (ARN) of the
|
578
|
-
# return.
|
753
|
+
# The Amazon Resource Name (ARN) of the
|
754
|
+
# `ManagedNotificationChildEvent` to return.
|
579
755
|
# @return [String]
|
580
756
|
#
|
581
|
-
#
|
757
|
+
# @!attribute [rw] locale
|
758
|
+
# The locale code of the language used for the retrieved
|
759
|
+
# `ManagedNotificationChildEvent`. The default locale is English
|
760
|
+
# `en_US`.
|
761
|
+
# @return [String]
|
582
762
|
#
|
583
|
-
|
584
|
-
|
763
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetManagedNotificationChildEventRequest AWS API Documentation
|
764
|
+
#
|
765
|
+
class GetManagedNotificationChildEventRequest < Struct.new(
|
766
|
+
:arn,
|
767
|
+
:locale)
|
585
768
|
SENSITIVE = []
|
586
769
|
include Aws::Structure
|
587
770
|
end
|
@@ -590,51 +773,157 @@ module Aws::Notifications
|
|
590
773
|
# The ARN of the resource.
|
591
774
|
# @return [String]
|
592
775
|
#
|
776
|
+
# @!attribute [rw] managed_notification_configuration_arn
|
777
|
+
# The Amazon Resource Name (ARN) of the
|
778
|
+
# `ManagedNotificationConfiguration` associated with the
|
779
|
+
# `ManagedNotificationChildEvent`.
|
780
|
+
# @return [String]
|
781
|
+
#
|
782
|
+
# @!attribute [rw] creation_time
|
783
|
+
# The creation time of the `ManagedNotificationChildEvent`.
|
784
|
+
# @return [Time]
|
785
|
+
#
|
786
|
+
# @!attribute [rw] content
|
787
|
+
# The content of the `ManagedNotificationChildEvent`.
|
788
|
+
# @return [Types::ManagedNotificationChildEvent]
|
789
|
+
#
|
790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetManagedNotificationChildEventResponse AWS API Documentation
|
791
|
+
#
|
792
|
+
class GetManagedNotificationChildEventResponse < Struct.new(
|
793
|
+
:arn,
|
794
|
+
:managed_notification_configuration_arn,
|
795
|
+
:creation_time,
|
796
|
+
:content)
|
797
|
+
SENSITIVE = []
|
798
|
+
include Aws::Structure
|
799
|
+
end
|
800
|
+
|
801
|
+
# @!attribute [rw] arn
|
802
|
+
# The Amazon Resource Name (ARN) of the
|
803
|
+
# `ManagedNotificationConfiguration` to return.
|
804
|
+
# @return [String]
|
805
|
+
#
|
806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetManagedNotificationConfigurationRequest AWS API Documentation
|
807
|
+
#
|
808
|
+
class GetManagedNotificationConfigurationRequest < Struct.new(
|
809
|
+
:arn)
|
810
|
+
SENSITIVE = []
|
811
|
+
include Aws::Structure
|
812
|
+
end
|
813
|
+
|
814
|
+
# @!attribute [rw] arn
|
815
|
+
# The ARN of the `ManagedNotificationConfiguration` resource.
|
816
|
+
# @return [String]
|
817
|
+
#
|
593
818
|
# @!attribute [rw] name
|
594
|
-
# The name of the
|
819
|
+
# The name of the `ManagedNotificationConfiguration`.
|
595
820
|
# @return [String]
|
596
821
|
#
|
597
822
|
# @!attribute [rw] description
|
598
|
-
# The description of the
|
823
|
+
# The description of the `ManagedNotificationConfiguration`.
|
599
824
|
# @return [String]
|
600
825
|
#
|
601
|
-
# @!attribute [rw]
|
602
|
-
# The
|
826
|
+
# @!attribute [rw] category
|
827
|
+
# The category of the `ManagedNotificationConfiguration`.
|
828
|
+
# @return [String]
|
603
829
|
#
|
604
|
-
#
|
605
|
-
#
|
830
|
+
# @!attribute [rw] sub_category
|
831
|
+
# The subCategory of the `ManagedNotificationConfiguration`.
|
832
|
+
# @return [String]
|
606
833
|
#
|
607
|
-
#
|
834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetManagedNotificationConfigurationResponse AWS API Documentation
|
608
835
|
#
|
609
|
-
|
836
|
+
class GetManagedNotificationConfigurationResponse < Struct.new(
|
837
|
+
:arn,
|
838
|
+
:name,
|
839
|
+
:description,
|
840
|
+
:category,
|
841
|
+
:sub_category)
|
842
|
+
SENSITIVE = []
|
843
|
+
include Aws::Structure
|
844
|
+
end
|
845
|
+
|
846
|
+
# @!attribute [rw] arn
|
847
|
+
# The Amazon Resource Name (ARN) of the `ManagedNotificationEvent` to
|
848
|
+
# return.
|
849
|
+
# @return [String]
|
610
850
|
#
|
611
|
-
#
|
851
|
+
# @!attribute [rw] locale
|
852
|
+
# The locale code of the language used for the retrieved
|
853
|
+
# `ManagedNotificationEvent`. The default locale is English `(en_US)`.
|
854
|
+
# @return [String]
|
612
855
|
#
|
613
|
-
#
|
614
|
-
# * `PARTIALLY_ACTIVE`
|
856
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetManagedNotificationEventRequest AWS API Documentation
|
615
857
|
#
|
616
|
-
|
858
|
+
class GetManagedNotificationEventRequest < Struct.new(
|
859
|
+
:arn,
|
860
|
+
:locale)
|
861
|
+
SENSITIVE = []
|
862
|
+
include Aws::Structure
|
863
|
+
end
|
864
|
+
|
865
|
+
# @!attribute [rw] arn
|
866
|
+
# The ARN of the resource.
|
867
|
+
# @return [String]
|
617
868
|
#
|
618
|
-
#
|
619
|
-
#
|
869
|
+
# @!attribute [rw] managed_notification_configuration_arn
|
870
|
+
# The ARN of the `ManagedNotificationConfiguration`.
|
871
|
+
# @return [String]
|
620
872
|
#
|
621
|
-
#
|
873
|
+
# @!attribute [rw] creation_time
|
874
|
+
# The creation time of the `ManagedNotificationEvent`.
|
875
|
+
# @return [Time]
|
622
876
|
#
|
623
|
-
#
|
624
|
-
#
|
877
|
+
# @!attribute [rw] content
|
878
|
+
# The content of the `ManagedNotificationEvent`.
|
879
|
+
# @return [Types::ManagedNotificationEvent]
|
625
880
|
#
|
626
|
-
#
|
627
|
-
# and `LIST` calls can be run.
|
881
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetManagedNotificationEventResponse AWS API Documentation
|
628
882
|
#
|
629
|
-
|
883
|
+
class GetManagedNotificationEventResponse < Struct.new(
|
884
|
+
:arn,
|
885
|
+
:managed_notification_configuration_arn,
|
886
|
+
:creation_time,
|
887
|
+
:content)
|
888
|
+
SENSITIVE = []
|
889
|
+
include Aws::Structure
|
890
|
+
end
|
891
|
+
|
892
|
+
# @!attribute [rw] arn
|
893
|
+
# The Amazon Resource Name (ARN) of the `NotificationConfiguration` to
|
894
|
+
# return.
|
895
|
+
# @return [String]
|
896
|
+
#
|
897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetNotificationConfigurationRequest AWS API Documentation
|
898
|
+
#
|
899
|
+
class GetNotificationConfigurationRequest < Struct.new(
|
900
|
+
:arn)
|
901
|
+
SENSITIVE = []
|
902
|
+
include Aws::Structure
|
903
|
+
end
|
904
|
+
|
905
|
+
# @!attribute [rw] arn
|
906
|
+
# The ARN of the resource.
|
907
|
+
# @return [String]
|
908
|
+
#
|
909
|
+
# @!attribute [rw] name
|
910
|
+
# The name of the `NotificationConfiguration`.
|
911
|
+
# @return [String]
|
912
|
+
#
|
913
|
+
# @!attribute [rw] description
|
914
|
+
# The description of the `NotificationConfiguration`.
|
915
|
+
# @return [String]
|
916
|
+
#
|
917
|
+
# @!attribute [rw] status
|
918
|
+
# The status of this `NotificationConfiguration`.
|
630
919
|
# @return [String]
|
631
920
|
#
|
632
921
|
# @!attribute [rw] creation_time
|
633
|
-
# The creation time of the NotificationConfiguration
|
922
|
+
# The creation time of the `NotificationConfiguration`.
|
634
923
|
# @return [Time]
|
635
924
|
#
|
636
925
|
# @!attribute [rw] aggregation_duration
|
637
|
-
# The aggregation preference of the NotificationConfiguration
|
926
|
+
# The aggregation preference of the `NotificationConfiguration`.
|
638
927
|
#
|
639
928
|
# * Values:
|
640
929
|
#
|
@@ -652,7 +941,7 @@ module Aws::Notifications
|
|
652
941
|
#
|
653
942
|
# * Don't aggregate notifications.
|
654
943
|
#
|
655
|
-
#
|
944
|
+
# ^
|
656
945
|
# @return [String]
|
657
946
|
#
|
658
947
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetNotificationConfigurationResponse AWS API Documentation
|
@@ -669,12 +958,12 @@ module Aws::Notifications
|
|
669
958
|
end
|
670
959
|
|
671
960
|
# @!attribute [rw] arn
|
672
|
-
# The Amazon Resource Name (ARN) of the NotificationEvent to return.
|
961
|
+
# The Amazon Resource Name (ARN) of the `NotificationEvent` to return.
|
673
962
|
# @return [String]
|
674
963
|
#
|
675
964
|
# @!attribute [rw] locale
|
676
965
|
# The locale code of the language used for the retrieved
|
677
|
-
# NotificationEvent
|
966
|
+
# `NotificationEvent`. The default locale is English `en_US`.
|
678
967
|
# @return [String]
|
679
968
|
#
|
680
969
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetNotificationEventRequest AWS API Documentation
|
@@ -691,15 +980,15 @@ module Aws::Notifications
|
|
691
980
|
# @return [String]
|
692
981
|
#
|
693
982
|
# @!attribute [rw] notification_configuration_arn
|
694
|
-
# The ARN of the NotificationConfiguration
|
983
|
+
# The ARN of the `NotificationConfiguration`.
|
695
984
|
# @return [String]
|
696
985
|
#
|
697
986
|
# @!attribute [rw] creation_time
|
698
|
-
# The creation time of the NotificationEvent
|
987
|
+
# The creation time of the `NotificationEvent`.
|
699
988
|
# @return [Time]
|
700
989
|
#
|
701
990
|
# @!attribute [rw] content
|
702
|
-
# The content of the NotificationEvent
|
991
|
+
# The content of the `NotificationEvent`.
|
703
992
|
# @return [Types::NotificationEvent]
|
704
993
|
#
|
705
994
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetNotificationEventResponse AWS API Documentation
|
@@ -713,6 +1002,25 @@ module Aws::Notifications
|
|
713
1002
|
include Aws::Structure
|
714
1003
|
end
|
715
1004
|
|
1005
|
+
# @api private
|
1006
|
+
#
|
1007
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetNotificationsAccessForOrganizationRequest AWS API Documentation
|
1008
|
+
#
|
1009
|
+
class GetNotificationsAccessForOrganizationRequest < Aws::EmptyStructure; end
|
1010
|
+
|
1011
|
+
# @!attribute [rw] notifications_access_for_organization
|
1012
|
+
# The `AccessStatus` of Service Trust Enablement for User
|
1013
|
+
# Notifications to Amazon Web Services Organizations.
|
1014
|
+
# @return [Types::NotificationsAccessForOrganization]
|
1015
|
+
#
|
1016
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/GetNotificationsAccessForOrganizationResponse AWS API Documentation
|
1017
|
+
#
|
1018
|
+
class GetNotificationsAccessForOrganizationResponse < Struct.new(
|
1019
|
+
:notifications_access_for_organization)
|
1020
|
+
SENSITIVE = []
|
1021
|
+
include Aws::Structure
|
1022
|
+
end
|
1023
|
+
|
716
1024
|
# Unexpected error during processing of request.
|
717
1025
|
#
|
718
1026
|
# @!attribute [rw] message
|
@@ -727,7 +1035,7 @@ module Aws::Notifications
|
|
727
1035
|
end
|
728
1036
|
|
729
1037
|
# @!attribute [rw] notification_configuration_arn
|
730
|
-
# The Amazon Resource Name (ARN) of the NotificationConfiguration
|
1038
|
+
# The Amazon Resource Name (ARN) of the `NotificationConfiguration`.
|
731
1039
|
# @return [String]
|
732
1040
|
#
|
733
1041
|
# @!attribute [rw] max_results
|
@@ -737,7 +1045,7 @@ module Aws::Notifications
|
|
737
1045
|
#
|
738
1046
|
# @!attribute [rw] next_token
|
739
1047
|
# The start token for paginated calls. Retrieved from the response of
|
740
|
-
# a previous ListNotificationEvents call. NextToken uses Base64
|
1048
|
+
# a previous ListNotificationEvents call. `NextToken` uses Base64
|
741
1049
|
# encoding.
|
742
1050
|
# @return [String]
|
743
1051
|
#
|
@@ -770,7 +1078,7 @@ module Aws::Notifications
|
|
770
1078
|
end
|
771
1079
|
|
772
1080
|
# @!attribute [rw] notification_configuration_arn
|
773
|
-
# The Amazon Resource Name (ARN) of the NotificationConfiguration
|
1081
|
+
# The Amazon Resource Name (ARN) of the `NotificationConfiguration`.
|
774
1082
|
# @return [String]
|
775
1083
|
#
|
776
1084
|
# @!attribute [rw] max_results
|
@@ -780,7 +1088,7 @@ module Aws::Notifications
|
|
780
1088
|
#
|
781
1089
|
# @!attribute [rw] next_token
|
782
1090
|
# The start token for paginated calls. Retrieved from the response of
|
783
|
-
# a previous ListEventRules call. Next token uses Base64 encoding.
|
1091
|
+
# a previous `ListEventRules` call. Next token uses Base64 encoding.
|
784
1092
|
# @return [String]
|
785
1093
|
#
|
786
1094
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListEventRulesRequest AWS API Documentation
|
@@ -799,7 +1107,7 @@ module Aws::Notifications
|
|
799
1107
|
# @return [String]
|
800
1108
|
#
|
801
1109
|
# @!attribute [rw] event_rules
|
802
|
-
# A list of EventRules
|
1110
|
+
# A list of `EventRules`.
|
803
1111
|
# @return [Array<Types::EventRuleStructure>]
|
804
1112
|
#
|
805
1113
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListEventRulesResponse AWS API Documentation
|
@@ -811,47 +1119,282 @@ module Aws::Notifications
|
|
811
1119
|
include Aws::Structure
|
812
1120
|
end
|
813
1121
|
|
814
|
-
# @!attribute [rw]
|
815
|
-
# The
|
1122
|
+
# @!attribute [rw] managed_notification_configuration_arn
|
1123
|
+
# The Amazon Resource Name (ARN) of the
|
1124
|
+
# `ManagedNotificationConfiguration` to match.
|
1125
|
+
# @return [String]
|
816
1126
|
#
|
817
|
-
#
|
818
|
-
#
|
819
|
-
#
|
820
|
-
#
|
1127
|
+
# @!attribute [rw] max_results
|
1128
|
+
# The maximum number of results to be returned in this call. Defaults
|
1129
|
+
# to 20.
|
1130
|
+
# @return [Integer]
|
821
1131
|
#
|
1132
|
+
# @!attribute [rw] next_token
|
1133
|
+
# The start token for paginated calls. Retrieved from the response of
|
1134
|
+
# a previous `ListManagedNotificationChannelAssociations` call.
|
1135
|
+
# @return [String]
|
822
1136
|
#
|
1137
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListManagedNotificationChannelAssociationsRequest AWS API Documentation
|
823
1138
|
#
|
824
|
-
|
1139
|
+
class ListManagedNotificationChannelAssociationsRequest < Struct.new(
|
1140
|
+
:managed_notification_configuration_arn,
|
1141
|
+
:max_results,
|
1142
|
+
:next_token)
|
1143
|
+
SENSITIVE = []
|
1144
|
+
include Aws::Structure
|
1145
|
+
end
|
1146
|
+
|
1147
|
+
# @!attribute [rw] next_token
|
1148
|
+
# A pagination token. If a non-null pagination token is returned in a
|
1149
|
+
# result, pass its value in another request to retrieve more entries.
|
825
1150
|
# @return [String]
|
826
1151
|
#
|
827
|
-
# @!attribute [rw]
|
828
|
-
#
|
1152
|
+
# @!attribute [rw] channel_associations
|
1153
|
+
# A list that contains the following information about a channel
|
1154
|
+
# association.
|
1155
|
+
# @return [Array<Types::ManagedNotificationChannelAssociationSummary>]
|
1156
|
+
#
|
1157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListManagedNotificationChannelAssociationsResponse AWS API Documentation
|
1158
|
+
#
|
1159
|
+
class ListManagedNotificationChannelAssociationsResponse < Struct.new(
|
1160
|
+
:next_token,
|
1161
|
+
:channel_associations)
|
1162
|
+
SENSITIVE = []
|
1163
|
+
include Aws::Structure
|
1164
|
+
end
|
1165
|
+
|
1166
|
+
# @!attribute [rw] aggregate_managed_notification_event_arn
|
1167
|
+
# The Amazon Resource Name (ARN) of the `ManagedNotificationEvent`.
|
1168
|
+
# @return [String]
|
1169
|
+
#
|
1170
|
+
# @!attribute [rw] start_time
|
1171
|
+
# The earliest time of events to return from this call.
|
1172
|
+
# @return [Time]
|
1173
|
+
#
|
1174
|
+
# @!attribute [rw] end_time
|
1175
|
+
# Latest time of events to return from this call.
|
1176
|
+
# @return [Time]
|
1177
|
+
#
|
1178
|
+
# @!attribute [rw] locale
|
1179
|
+
# The locale code of the language used for the retrieved
|
1180
|
+
# `NotificationEvent`. The default locale is English.`en_US`.
|
1181
|
+
# @return [String]
|
1182
|
+
#
|
1183
|
+
# @!attribute [rw] max_results
|
1184
|
+
# The maximum number of results to be returned in this call. Defaults
|
1185
|
+
# to 20.
|
1186
|
+
# @return [Integer]
|
1187
|
+
#
|
1188
|
+
# @!attribute [rw] related_account
|
1189
|
+
# The Amazon Web Services account ID associated with the Managed
|
1190
|
+
# Notification Child Events.
|
1191
|
+
# @return [String]
|
1192
|
+
#
|
1193
|
+
# @!attribute [rw] organizational_unit_id
|
1194
|
+
# The identifier of the Amazon Web Services Organizations
|
1195
|
+
# organizational unit (OU) associated with the Managed Notification
|
1196
|
+
# Child Events.
|
1197
|
+
# @return [String]
|
1198
|
+
#
|
1199
|
+
# @!attribute [rw] next_token
|
1200
|
+
# The start token for paginated calls. Retrieved from the response of
|
1201
|
+
# a previous ListManagedNotificationChannelAssociations call. Next
|
1202
|
+
# token uses Base64 encoding.
|
1203
|
+
# @return [String]
|
1204
|
+
#
|
1205
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListManagedNotificationChildEventsRequest AWS API Documentation
|
1206
|
+
#
|
1207
|
+
class ListManagedNotificationChildEventsRequest < Struct.new(
|
1208
|
+
:aggregate_managed_notification_event_arn,
|
1209
|
+
:start_time,
|
1210
|
+
:end_time,
|
1211
|
+
:locale,
|
1212
|
+
:max_results,
|
1213
|
+
:related_account,
|
1214
|
+
:organizational_unit_id,
|
1215
|
+
:next_token)
|
1216
|
+
SENSITIVE = []
|
1217
|
+
include Aws::Structure
|
1218
|
+
end
|
1219
|
+
|
1220
|
+
# @!attribute [rw] next_token
|
1221
|
+
# A pagination token. If a non-null pagination token is returned in a
|
1222
|
+
# result, pass its value in another request to retrieve more entries.
|
1223
|
+
# @return [String]
|
1224
|
+
#
|
1225
|
+
# @!attribute [rw] managed_notification_child_events
|
1226
|
+
# A pagination token. If a non-null pagination token is returned in a
|
1227
|
+
# result, pass its value in another request to retrieve more entries.
|
1228
|
+
# @return [Array<Types::ManagedNotificationChildEventOverview>]
|
1229
|
+
#
|
1230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListManagedNotificationChildEventsResponse AWS API Documentation
|
1231
|
+
#
|
1232
|
+
class ListManagedNotificationChildEventsResponse < Struct.new(
|
1233
|
+
:next_token,
|
1234
|
+
:managed_notification_child_events)
|
1235
|
+
SENSITIVE = []
|
1236
|
+
include Aws::Structure
|
1237
|
+
end
|
1238
|
+
|
1239
|
+
# @!attribute [rw] channel_identifier
|
1240
|
+
# The identifier or ARN of the notification channel to filter
|
1241
|
+
# configurations by.
|
1242
|
+
# @return [String]
|
1243
|
+
#
|
1244
|
+
# @!attribute [rw] max_results
|
1245
|
+
# The maximum number of results to be returned in this call. Defaults
|
1246
|
+
# to 20.
|
1247
|
+
# @return [Integer]
|
1248
|
+
#
|
1249
|
+
# @!attribute [rw] next_token
|
1250
|
+
# The start token for paginated calls. Retrieved from the response of
|
1251
|
+
# a previous ListManagedNotificationChannelAssociations call. Next
|
1252
|
+
# token uses Base64 encoding.
|
1253
|
+
# @return [String]
|
1254
|
+
#
|
1255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListManagedNotificationConfigurationsRequest AWS API Documentation
|
1256
|
+
#
|
1257
|
+
class ListManagedNotificationConfigurationsRequest < Struct.new(
|
1258
|
+
:channel_identifier,
|
1259
|
+
:max_results,
|
1260
|
+
:next_token)
|
1261
|
+
SENSITIVE = []
|
1262
|
+
include Aws::Structure
|
1263
|
+
end
|
1264
|
+
|
1265
|
+
# @!attribute [rw] next_token
|
1266
|
+
# A pagination token. If a non-null pagination token is returned in a
|
1267
|
+
# result, pass its value in another request to retrieve more entries.
|
1268
|
+
# @return [String]
|
1269
|
+
#
|
1270
|
+
# @!attribute [rw] managed_notification_configurations
|
1271
|
+
# A list of Managed Notification Configurations matching the request
|
1272
|
+
# criteria.
|
1273
|
+
# @return [Array<Types::ManagedNotificationConfigurationStructure>]
|
1274
|
+
#
|
1275
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListManagedNotificationConfigurationsResponse AWS API Documentation
|
1276
|
+
#
|
1277
|
+
class ListManagedNotificationConfigurationsResponse < Struct.new(
|
1278
|
+
:next_token,
|
1279
|
+
:managed_notification_configurations)
|
1280
|
+
SENSITIVE = []
|
1281
|
+
include Aws::Structure
|
1282
|
+
end
|
1283
|
+
|
1284
|
+
# @!attribute [rw] start_time
|
1285
|
+
# The earliest time of events to return from this call.
|
1286
|
+
# @return [Time]
|
1287
|
+
#
|
1288
|
+
# @!attribute [rw] end_time
|
1289
|
+
# Latest time of events to return from this call.
|
1290
|
+
# @return [Time]
|
1291
|
+
#
|
1292
|
+
# @!attribute [rw] locale
|
1293
|
+
# The locale code of the language used for the retrieved
|
1294
|
+
# NotificationEvent. The default locale is English (en\_US).
|
1295
|
+
# @return [String]
|
1296
|
+
#
|
1297
|
+
# @!attribute [rw] source
|
1298
|
+
# The Amazon Web Services service the event originates from. For
|
1299
|
+
# example aws.cloudwatch.
|
1300
|
+
# @return [String]
|
1301
|
+
#
|
1302
|
+
# @!attribute [rw] max_results
|
1303
|
+
# The maximum number of results to be returned in this call. Defaults
|
1304
|
+
# to 20.
|
1305
|
+
# @return [Integer]
|
1306
|
+
#
|
1307
|
+
# @!attribute [rw] next_token
|
1308
|
+
# The start token for paginated calls. Retrieved from the response of
|
1309
|
+
# a previous `ListManagedNotificationChannelAssociations` call. Next
|
1310
|
+
# token uses Base64 encoding.
|
1311
|
+
# @return [String]
|
1312
|
+
#
|
1313
|
+
# @!attribute [rw] organizational_unit_id
|
1314
|
+
# The Organizational Unit Id that an Amazon Web Services account
|
1315
|
+
# belongs to.
|
1316
|
+
# @return [String]
|
1317
|
+
#
|
1318
|
+
# @!attribute [rw] related_account
|
1319
|
+
# The Amazon Web Services account ID associated with the Managed
|
1320
|
+
# Notification Events.
|
1321
|
+
# @return [String]
|
1322
|
+
#
|
1323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListManagedNotificationEventsRequest AWS API Documentation
|
1324
|
+
#
|
1325
|
+
class ListManagedNotificationEventsRequest < Struct.new(
|
1326
|
+
:start_time,
|
1327
|
+
:end_time,
|
1328
|
+
:locale,
|
1329
|
+
:source,
|
1330
|
+
:max_results,
|
1331
|
+
:next_token,
|
1332
|
+
:organizational_unit_id,
|
1333
|
+
:related_account)
|
1334
|
+
SENSITIVE = []
|
1335
|
+
include Aws::Structure
|
1336
|
+
end
|
1337
|
+
|
1338
|
+
# @!attribute [rw] next_token
|
1339
|
+
# A pagination token. If a non-null pagination token is returned in a
|
1340
|
+
# result, pass its value in another request to retrieve more entries.
|
1341
|
+
# @return [String]
|
1342
|
+
#
|
1343
|
+
# @!attribute [rw] managed_notification_events
|
1344
|
+
# A list of Managed Notification Events matching the request criteria.
|
1345
|
+
# @return [Array<Types::ManagedNotificationEventOverview>]
|
1346
|
+
#
|
1347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListManagedNotificationEventsResponse AWS API Documentation
|
1348
|
+
#
|
1349
|
+
class ListManagedNotificationEventsResponse < Struct.new(
|
1350
|
+
:next_token,
|
1351
|
+
:managed_notification_events)
|
1352
|
+
SENSITIVE = []
|
1353
|
+
include Aws::Structure
|
1354
|
+
end
|
1355
|
+
|
1356
|
+
# @!attribute [rw] event_rule_source
|
1357
|
+
# The matched event source.
|
1358
|
+
#
|
1359
|
+
# Must match one of the valid EventBridge sources. Only Amazon Web
|
1360
|
+
# Services service sourced events are supported. For example,
|
1361
|
+
# `aws.ec2` and `aws.cloudwatch`. For more information, see [Event
|
1362
|
+
# delivery from Amazon Web Services services][1] in the *Amazon
|
1363
|
+
# EventBridge User Guide*.
|
1364
|
+
#
|
1365
|
+
#
|
1366
|
+
#
|
1367
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
|
1368
|
+
# @return [String]
|
1369
|
+
#
|
1370
|
+
# @!attribute [rw] channel_arn
|
1371
|
+
# The Amazon Resource Name (ARN) of the Channel to match.
|
829
1372
|
# @return [String]
|
830
1373
|
#
|
831
1374
|
# @!attribute [rw] status
|
832
|
-
# The NotificationConfiguration status to match.
|
1375
|
+
# The `NotificationConfiguration` status to match.
|
833
1376
|
#
|
834
1377
|
# * Values:
|
835
1378
|
#
|
836
1379
|
# * `ACTIVE`
|
837
1380
|
#
|
838
|
-
# * All EventRules are `ACTIVE` and any call can be run.
|
1381
|
+
# * All `EventRules` are `ACTIVE` and any call can be run.
|
839
1382
|
#
|
840
1383
|
# ^
|
841
1384
|
# * `PARTIALLY_ACTIVE`
|
842
1385
|
#
|
843
|
-
# * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any
|
844
|
-
# can be run.
|
1386
|
+
# * Some `EventRules` are `ACTIVE` and some are `INACTIVE`. Any
|
1387
|
+
# call can be run.
|
845
1388
|
#
|
846
1389
|
# * Any call can be run.
|
847
1390
|
# * `INACTIVE`
|
848
1391
|
#
|
849
|
-
# * All EventRules are `INACTIVE` and any call can be run.
|
1392
|
+
# * All `EventRules` are `INACTIVE` and any call can be run.
|
850
1393
|
#
|
851
1394
|
# ^
|
852
1395
|
# * `DELETING`
|
853
1396
|
#
|
854
|
-
# * This NotificationConfiguration is being deleted.
|
1397
|
+
# * This `NotificationConfiguration` is being deleted.
|
855
1398
|
#
|
856
1399
|
# * Only `GET` and `LIST` calls can be run.
|
857
1400
|
# @return [String]
|
@@ -863,7 +1406,7 @@ module Aws::Notifications
|
|
863
1406
|
#
|
864
1407
|
# @!attribute [rw] next_token
|
865
1408
|
# The start token for paginated calls. Retrieved from the response of
|
866
|
-
# a previous ListEventRules call. Next token uses Base64 encoding.
|
1409
|
+
# a previous `ListEventRules` call. Next token uses Base64 encoding.
|
867
1410
|
# @return [String]
|
868
1411
|
#
|
869
1412
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationConfigurationsRequest AWS API Documentation
|
@@ -883,153 +1426,811 @@ module Aws::Notifications
|
|
883
1426
|
# result, pass its value in another request to retrieve more entries.
|
884
1427
|
# @return [String]
|
885
1428
|
#
|
886
|
-
# @!attribute [rw] notification_configurations
|
887
|
-
# The NotificationConfigurations in the account.
|
888
|
-
# @return [Array<Types::NotificationConfigurationStructure>]
|
1429
|
+
# @!attribute [rw] notification_configurations
|
1430
|
+
# The `NotificationConfigurations` in the account.
|
1431
|
+
# @return [Array<Types::NotificationConfigurationStructure>]
|
1432
|
+
#
|
1433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationConfigurationsResponse AWS API Documentation
|
1434
|
+
#
|
1435
|
+
class ListNotificationConfigurationsResponse < Struct.new(
|
1436
|
+
:next_token,
|
1437
|
+
:notification_configurations)
|
1438
|
+
SENSITIVE = []
|
1439
|
+
include Aws::Structure
|
1440
|
+
end
|
1441
|
+
|
1442
|
+
# @!attribute [rw] start_time
|
1443
|
+
# The earliest time of events to return from this call.
|
1444
|
+
# @return [Time]
|
1445
|
+
#
|
1446
|
+
# @!attribute [rw] end_time
|
1447
|
+
# Latest time of events to return from this call.
|
1448
|
+
# @return [Time]
|
1449
|
+
#
|
1450
|
+
# @!attribute [rw] locale
|
1451
|
+
# The locale code of the language used for the retrieved
|
1452
|
+
# `NotificationEvent`. The default locale is English `(en_US)`.
|
1453
|
+
# @return [String]
|
1454
|
+
#
|
1455
|
+
# @!attribute [rw] source
|
1456
|
+
# The matched event source.
|
1457
|
+
#
|
1458
|
+
# Must match one of the valid EventBridge sources. Only Amazon Web
|
1459
|
+
# Services service sourced events are supported. For example,
|
1460
|
+
# `aws.ec2` and `aws.cloudwatch`. For more information, see [Event
|
1461
|
+
# delivery from Amazon Web Services services][1] in the *Amazon
|
1462
|
+
# EventBridge User Guide*.
|
1463
|
+
#
|
1464
|
+
#
|
1465
|
+
#
|
1466
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
|
1467
|
+
# @return [String]
|
1468
|
+
#
|
1469
|
+
# @!attribute [rw] include_child_events
|
1470
|
+
# Include aggregated child events in the result.
|
1471
|
+
# @return [Boolean]
|
1472
|
+
#
|
1473
|
+
# @!attribute [rw] aggregate_notification_event_arn
|
1474
|
+
# The Amazon Resource Name (ARN) of the
|
1475
|
+
# `aggregatedNotificationEventArn` to match.
|
1476
|
+
# @return [String]
|
1477
|
+
#
|
1478
|
+
# @!attribute [rw] max_results
|
1479
|
+
# The maximum number of results to be returned in this call. Defaults
|
1480
|
+
# to 20.
|
1481
|
+
# @return [Integer]
|
1482
|
+
#
|
1483
|
+
# @!attribute [rw] next_token
|
1484
|
+
# The start token for paginated calls. Retrieved from the response of
|
1485
|
+
# a previous `ListEventRules` call. Next token uses Base64 encoding.
|
1486
|
+
# @return [String]
|
1487
|
+
#
|
1488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationEventsRequest AWS API Documentation
|
1489
|
+
#
|
1490
|
+
class ListNotificationEventsRequest < Struct.new(
|
1491
|
+
:start_time,
|
1492
|
+
:end_time,
|
1493
|
+
:locale,
|
1494
|
+
:source,
|
1495
|
+
:include_child_events,
|
1496
|
+
:aggregate_notification_event_arn,
|
1497
|
+
:max_results,
|
1498
|
+
:next_token)
|
1499
|
+
SENSITIVE = []
|
1500
|
+
include Aws::Structure
|
1501
|
+
end
|
1502
|
+
|
1503
|
+
# @!attribute [rw] next_token
|
1504
|
+
# A pagination token. If a non-null pagination token is returned in a
|
1505
|
+
# result, pass its value in another request to retrieve more entries.
|
1506
|
+
# @return [String]
|
1507
|
+
#
|
1508
|
+
# @!attribute [rw] notification_events
|
1509
|
+
# The list of notification events.
|
1510
|
+
# @return [Array<Types::NotificationEventOverview>]
|
1511
|
+
#
|
1512
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationEventsResponse AWS API Documentation
|
1513
|
+
#
|
1514
|
+
class ListNotificationEventsResponse < Struct.new(
|
1515
|
+
:next_token,
|
1516
|
+
:notification_events)
|
1517
|
+
SENSITIVE = []
|
1518
|
+
include Aws::Structure
|
1519
|
+
end
|
1520
|
+
|
1521
|
+
# @!attribute [rw] max_results
|
1522
|
+
# The maximum number of records to list in a single response.
|
1523
|
+
# @return [Integer]
|
1524
|
+
#
|
1525
|
+
# @!attribute [rw] next_token
|
1526
|
+
# A pagination token. Set to null to start listing notification hubs
|
1527
|
+
# from the start.
|
1528
|
+
# @return [String]
|
1529
|
+
#
|
1530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationHubsRequest AWS API Documentation
|
1531
|
+
#
|
1532
|
+
class ListNotificationHubsRequest < Struct.new(
|
1533
|
+
:max_results,
|
1534
|
+
:next_token)
|
1535
|
+
SENSITIVE = []
|
1536
|
+
include Aws::Structure
|
1537
|
+
end
|
1538
|
+
|
1539
|
+
# @!attribute [rw] notification_hubs
|
1540
|
+
# The `NotificationHubs` in the account.
|
1541
|
+
# @return [Array<Types::NotificationHubOverview>]
|
1542
|
+
#
|
1543
|
+
# @!attribute [rw] next_token
|
1544
|
+
# A pagination token. If a non-null pagination token is returned in a
|
1545
|
+
# result, pass its value in another request to retrieve more entries.
|
1546
|
+
# @return [String]
|
1547
|
+
#
|
1548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationHubsResponse AWS API Documentation
|
1549
|
+
#
|
1550
|
+
class ListNotificationHubsResponse < Struct.new(
|
1551
|
+
:notification_hubs,
|
1552
|
+
:next_token)
|
1553
|
+
SENSITIVE = []
|
1554
|
+
include Aws::Structure
|
1555
|
+
end
|
1556
|
+
|
1557
|
+
# @!attribute [rw] arn
|
1558
|
+
# The Amazon Resource Name (ARN) to use to list tags.
|
1559
|
+
# @return [String]
|
1560
|
+
#
|
1561
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListTagsForResourceRequest AWS API Documentation
|
1562
|
+
#
|
1563
|
+
class ListTagsForResourceRequest < Struct.new(
|
1564
|
+
:arn)
|
1565
|
+
SENSITIVE = []
|
1566
|
+
include Aws::Structure
|
1567
|
+
end
|
1568
|
+
|
1569
|
+
# @!attribute [rw] tags
|
1570
|
+
# A list of tags for the specified ARN.
|
1571
|
+
# @return [Hash<String,String>]
|
1572
|
+
#
|
1573
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListTagsForResourceResponse AWS API Documentation
|
1574
|
+
#
|
1575
|
+
class ListTagsForResourceResponse < Struct.new(
|
1576
|
+
:tags)
|
1577
|
+
SENSITIVE = []
|
1578
|
+
include Aws::Structure
|
1579
|
+
end
|
1580
|
+
|
1581
|
+
# Provides a summary of channel associations for a managed notification
|
1582
|
+
# configuration.
|
1583
|
+
#
|
1584
|
+
# @!attribute [rw] channel_identifier
|
1585
|
+
# The unique identifier for the notification channel.
|
1586
|
+
# @return [String]
|
1587
|
+
#
|
1588
|
+
# @!attribute [rw] channel_type
|
1589
|
+
# The type of notification channel used for message delivery.
|
1590
|
+
#
|
1591
|
+
# * Values:
|
1592
|
+
#
|
1593
|
+
# * `ACCOUNT_CONTACT`
|
1594
|
+
#
|
1595
|
+
# * Delivers notifications to Account Managed contacts through the
|
1596
|
+
# User Notification Service.
|
1597
|
+
#
|
1598
|
+
# ^
|
1599
|
+
# * `MOBILE`
|
1600
|
+
#
|
1601
|
+
# * Delivers notifications through the Amazon Web Services Console
|
1602
|
+
# Mobile Application to mobile devices.
|
1603
|
+
#
|
1604
|
+
# ^
|
1605
|
+
# * `CHATBOT`
|
1606
|
+
#
|
1607
|
+
# * Delivers notifications through Chatbot to collaboration
|
1608
|
+
# platforms (Slack, Chime).
|
1609
|
+
#
|
1610
|
+
# ^
|
1611
|
+
# * `EMAIL`
|
1612
|
+
#
|
1613
|
+
# * Delivers notifications to email addresses.
|
1614
|
+
#
|
1615
|
+
# ^
|
1616
|
+
# @return [String]
|
1617
|
+
#
|
1618
|
+
# @!attribute [rw] override_option
|
1619
|
+
# Controls whether users can modify channel associations for a
|
1620
|
+
# notification configuration.
|
1621
|
+
#
|
1622
|
+
# * Values:
|
1623
|
+
#
|
1624
|
+
# * `ENABLED`
|
1625
|
+
#
|
1626
|
+
# * Users can associate or disassociate channels with the
|
1627
|
+
# notification configuration.
|
1628
|
+
#
|
1629
|
+
# ^
|
1630
|
+
# * `DISABLED`
|
1631
|
+
#
|
1632
|
+
# * Users cannot associate or disassociate channels with the
|
1633
|
+
# notification configuration.
|
1634
|
+
#
|
1635
|
+
# ^
|
1636
|
+
# @return [String]
|
1637
|
+
#
|
1638
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ManagedNotificationChannelAssociationSummary AWS API Documentation
|
1639
|
+
#
|
1640
|
+
class ManagedNotificationChannelAssociationSummary < Struct.new(
|
1641
|
+
:channel_identifier,
|
1642
|
+
:channel_type,
|
1643
|
+
:override_option)
|
1644
|
+
SENSITIVE = []
|
1645
|
+
include Aws::Structure
|
1646
|
+
end
|
1647
|
+
|
1648
|
+
# A ManagedNotificationChildEvent is a notification-focused
|
1649
|
+
# representation of an event. They contain semantic information used to
|
1650
|
+
# create aggregated or non-aggregated end-user notifications.
|
1651
|
+
#
|
1652
|
+
# @!attribute [rw] schema_version
|
1653
|
+
# The schema version of the Managed Notification Child Event.
|
1654
|
+
# @return [String]
|
1655
|
+
#
|
1656
|
+
# @!attribute [rw] id
|
1657
|
+
# The unique identifier for a Managed Notification Child Event.
|
1658
|
+
# @return [String]
|
1659
|
+
#
|
1660
|
+
# @!attribute [rw] message_components
|
1661
|
+
# Describes the components of a notification message.
|
1662
|
+
# @return [Types::MessageComponents]
|
1663
|
+
#
|
1664
|
+
# @!attribute [rw] source_event_detail_url
|
1665
|
+
# The source event URL.
|
1666
|
+
# @return [String]
|
1667
|
+
#
|
1668
|
+
# @!attribute [rw] source_event_detail_url_display_text
|
1669
|
+
# The detailed URL for the source event.
|
1670
|
+
# @return [String]
|
1671
|
+
#
|
1672
|
+
# @!attribute [rw] notification_type
|
1673
|
+
# The type of event causing the notification.
|
1674
|
+
#
|
1675
|
+
# * Values:
|
1676
|
+
#
|
1677
|
+
# * `ALERT`
|
1678
|
+
#
|
1679
|
+
# * A notification about an event where something was triggered,
|
1680
|
+
# initiated, reopened, deployed, or a threshold was breached.
|
1681
|
+
#
|
1682
|
+
# ^
|
1683
|
+
# * `WARNING`
|
1684
|
+
#
|
1685
|
+
# * A notification about an event where an issue is about to
|
1686
|
+
# arise. For example, something is approaching a threshold.
|
1687
|
+
#
|
1688
|
+
# ^
|
1689
|
+
# * `ANNOUNCEMENT`
|
1690
|
+
#
|
1691
|
+
# * A notification about an important event. For example, a step
|
1692
|
+
# in a workflow or escalation path or that a workflow was
|
1693
|
+
# updated.
|
1694
|
+
#
|
1695
|
+
# ^
|
1696
|
+
# * `INFORMATIONAL`
|
1697
|
+
#
|
1698
|
+
# * A notification about informational messages. For example,
|
1699
|
+
# recommendations, service announcements, or reminders.
|
1700
|
+
#
|
1701
|
+
# ^
|
1702
|
+
# @return [String]
|
1703
|
+
#
|
1704
|
+
# @!attribute [rw] event_status
|
1705
|
+
# The assesed nature of the event.
|
1706
|
+
#
|
1707
|
+
# * Values:
|
1708
|
+
#
|
1709
|
+
# * `HEALTHY`
|
1710
|
+
#
|
1711
|
+
# * All `EventRules` are `ACTIVE`.
|
1712
|
+
#
|
1713
|
+
# ^
|
1714
|
+
# * `UNHEALTHY`
|
1715
|
+
#
|
1716
|
+
# * Some `EventRules` are `ACTIVE` and some are `INACTIVE`.
|
1717
|
+
#
|
1718
|
+
# ^
|
1719
|
+
# @return [String]
|
1720
|
+
#
|
1721
|
+
# @!attribute [rw] aggregate_managed_notification_event_arn
|
1722
|
+
# The Amazon Resource Name (ARN) of the ManagedNotificationEvent that
|
1723
|
+
# is associated with this Managed Notification Child Event.
|
1724
|
+
# @return [String]
|
1725
|
+
#
|
1726
|
+
# @!attribute [rw] start_time
|
1727
|
+
# The notification event start time.
|
1728
|
+
# @return [Time]
|
1729
|
+
#
|
1730
|
+
# @!attribute [rw] end_time
|
1731
|
+
# The end time of the event.
|
1732
|
+
# @return [Time]
|
1733
|
+
#
|
1734
|
+
# @!attribute [rw] text_parts
|
1735
|
+
# A list of text values.
|
1736
|
+
# @return [Hash<String,Types::TextPartValue>]
|
1737
|
+
#
|
1738
|
+
# @!attribute [rw] organizational_unit_id
|
1739
|
+
# The Organizational Unit Id that an Amazon Web Services account
|
1740
|
+
# belongs to.
|
1741
|
+
# @return [String]
|
1742
|
+
#
|
1743
|
+
# @!attribute [rw] aggregation_detail
|
1744
|
+
# Provides detailed information about the dimensions used for event
|
1745
|
+
# summarization and aggregation.
|
1746
|
+
# @return [Types::AggregationDetail]
|
1747
|
+
#
|
1748
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ManagedNotificationChildEvent AWS API Documentation
|
1749
|
+
#
|
1750
|
+
class ManagedNotificationChildEvent < Struct.new(
|
1751
|
+
:schema_version,
|
1752
|
+
:id,
|
1753
|
+
:message_components,
|
1754
|
+
:source_event_detail_url,
|
1755
|
+
:source_event_detail_url_display_text,
|
1756
|
+
:notification_type,
|
1757
|
+
:event_status,
|
1758
|
+
:aggregate_managed_notification_event_arn,
|
1759
|
+
:start_time,
|
1760
|
+
:end_time,
|
1761
|
+
:text_parts,
|
1762
|
+
:organizational_unit_id,
|
1763
|
+
:aggregation_detail)
|
1764
|
+
SENSITIVE = []
|
1765
|
+
include Aws::Structure
|
1766
|
+
end
|
1767
|
+
|
1768
|
+
# Describes an overview and metadata for a
|
1769
|
+
# `ManagedNotificationChildEvent`.
|
1770
|
+
#
|
1771
|
+
# @!attribute [rw] arn
|
1772
|
+
# The Amazon Resource Name (ARN) of the
|
1773
|
+
# `ManagedNotificationChildEvent`.
|
1774
|
+
# @return [String]
|
1775
|
+
#
|
1776
|
+
# @!attribute [rw] managed_notification_configuration_arn
|
1777
|
+
# The Amazon Resource Name (ARN) of the
|
1778
|
+
# `ManagedNotificationConfiguration`.
|
1779
|
+
# @return [String]
|
1780
|
+
#
|
1781
|
+
# @!attribute [rw] related_account
|
1782
|
+
# The account that related to the `ManagedNotificationChildEvent`.
|
1783
|
+
# @return [String]
|
1784
|
+
#
|
1785
|
+
# @!attribute [rw] creation_time
|
1786
|
+
# The creation time of the `ManagedNotificationChildEvent`.
|
1787
|
+
# @return [Time]
|
1788
|
+
#
|
1789
|
+
# @!attribute [rw] child_event
|
1790
|
+
# The content of the `ManagedNotificationChildEvent`.
|
1791
|
+
# @return [Types::ManagedNotificationChildEventSummary]
|
1792
|
+
#
|
1793
|
+
# @!attribute [rw] aggregate_managed_notification_event_arn
|
1794
|
+
# The Amazon Resource Name (ARN) of the ManagedNotificationEvent that
|
1795
|
+
# is associated with this `ManagedNotificationChildEvent`.
|
1796
|
+
# @return [String]
|
1797
|
+
#
|
1798
|
+
# @!attribute [rw] organizational_unit_id
|
1799
|
+
# The Organizational Unit Id that an AWS account belongs to.
|
1800
|
+
# @return [String]
|
1801
|
+
#
|
1802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ManagedNotificationChildEventOverview AWS API Documentation
|
1803
|
+
#
|
1804
|
+
class ManagedNotificationChildEventOverview < Struct.new(
|
1805
|
+
:arn,
|
1806
|
+
:managed_notification_configuration_arn,
|
1807
|
+
:related_account,
|
1808
|
+
:creation_time,
|
1809
|
+
:child_event,
|
1810
|
+
:aggregate_managed_notification_event_arn,
|
1811
|
+
:organizational_unit_id)
|
1812
|
+
SENSITIVE = []
|
1813
|
+
include Aws::Structure
|
1814
|
+
end
|
1815
|
+
|
1816
|
+
# Describes a short summary and metadata for a
|
1817
|
+
# `ManagedNotificationChildEvent`.
|
1818
|
+
#
|
1819
|
+
# @!attribute [rw] schema_version
|
1820
|
+
# The schema version of the `ManagedNotificationChildEvent`.
|
1821
|
+
# @return [String]
|
1822
|
+
#
|
1823
|
+
# @!attribute [rw] source_event_metadata
|
1824
|
+
# Contains all event metadata present identically across all
|
1825
|
+
# `NotificationEvents`. All fields are present in Source Events via
|
1826
|
+
# Eventbridge.
|
1827
|
+
# @return [Types::ManagedSourceEventMetadataSummary]
|
1828
|
+
#
|
1829
|
+
# @!attribute [rw] message_components
|
1830
|
+
# Contains the headline message component.
|
1831
|
+
# @return [Types::MessageComponentsSummary]
|
1832
|
+
#
|
1833
|
+
# @!attribute [rw] aggregation_detail
|
1834
|
+
# Provides detailed information about the dimensions used for event
|
1835
|
+
# summarization and aggregation.
|
1836
|
+
# @return [Types::AggregationDetail]
|
1837
|
+
#
|
1838
|
+
# @!attribute [rw] event_status
|
1839
|
+
# The perceived nature of the event.
|
1840
|
+
#
|
1841
|
+
# * Values:
|
1842
|
+
#
|
1843
|
+
# * `HEALTHY`
|
1844
|
+
#
|
1845
|
+
# * All EventRules are `ACTIVE` and any call can be run.
|
1846
|
+
#
|
1847
|
+
# ^
|
1848
|
+
# * `UNHEALTHY`
|
1849
|
+
#
|
1850
|
+
# * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any call
|
1851
|
+
# can be run.
|
1852
|
+
#
|
1853
|
+
# ^
|
1854
|
+
# @return [String]
|
1855
|
+
#
|
1856
|
+
# @!attribute [rw] notification_type
|
1857
|
+
# The Type of the event causing this notification.
|
1858
|
+
#
|
1859
|
+
# * Values:
|
1860
|
+
#
|
1861
|
+
# * `ALERT`
|
1862
|
+
#
|
1863
|
+
# * A notification about an event where something was triggered,
|
1864
|
+
# initiated, reopened, deployed, or a threshold was breached.
|
1865
|
+
#
|
1866
|
+
# ^
|
1867
|
+
# * `WARNING`
|
1868
|
+
#
|
1869
|
+
# * A notification about an event where an issue is about to
|
1870
|
+
# arise. For example, something is approaching a threshold.
|
1871
|
+
#
|
1872
|
+
# ^
|
1873
|
+
# * `ANNOUNCEMENT`
|
1874
|
+
#
|
1875
|
+
# * A notification about an important event. For example, a step
|
1876
|
+
# in a workflow or escalation path or that a workflow was
|
1877
|
+
# updated.
|
1878
|
+
#
|
1879
|
+
# ^
|
1880
|
+
# * `INFORMATIONAL`
|
1881
|
+
#
|
1882
|
+
# * A notification about informational messages. For example,
|
1883
|
+
# recommendations, service announcements, or reminders.
|
1884
|
+
#
|
1885
|
+
# ^
|
1886
|
+
# @return [String]
|
1887
|
+
#
|
1888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ManagedNotificationChildEventSummary AWS API Documentation
|
1889
|
+
#
|
1890
|
+
class ManagedNotificationChildEventSummary < Struct.new(
|
1891
|
+
:schema_version,
|
1892
|
+
:source_event_metadata,
|
1893
|
+
:message_components,
|
1894
|
+
:aggregation_detail,
|
1895
|
+
:event_status,
|
1896
|
+
:notification_type)
|
1897
|
+
SENSITIVE = []
|
1898
|
+
include Aws::Structure
|
1899
|
+
end
|
1900
|
+
|
1901
|
+
# Describes the basic structure and properties of a
|
1902
|
+
# `ManagedNotificationConfiguration`.
|
1903
|
+
#
|
1904
|
+
# @!attribute [rw] arn
|
1905
|
+
# The Amazon Resource Name (ARN) of the
|
1906
|
+
# `ManagedNotificationConfiguration`.
|
1907
|
+
# @return [String]
|
1908
|
+
#
|
1909
|
+
# @!attribute [rw] name
|
1910
|
+
# The name of the `ManagedNotificationConfiguration`.
|
1911
|
+
# @return [String]
|
1912
|
+
#
|
1913
|
+
# @!attribute [rw] description
|
1914
|
+
# The description of the `ManagedNotificationConfiguration`.
|
1915
|
+
# @return [String]
|
1916
|
+
#
|
1917
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ManagedNotificationConfigurationStructure AWS API Documentation
|
1918
|
+
#
|
1919
|
+
class ManagedNotificationConfigurationStructure < Struct.new(
|
1920
|
+
:arn,
|
1921
|
+
:name,
|
1922
|
+
:description)
|
1923
|
+
SENSITIVE = []
|
1924
|
+
include Aws::Structure
|
1925
|
+
end
|
1926
|
+
|
1927
|
+
# A notification-focused representation of an event. They contain
|
1928
|
+
# semantic information used by AccountContacts or Additional Channels to
|
1929
|
+
# create end-user notifications.
|
1930
|
+
#
|
1931
|
+
# @!attribute [rw] schema_version
|
1932
|
+
# Version of the `ManagedNotificationEvent` schema.
|
1933
|
+
# @return [String]
|
1934
|
+
#
|
1935
|
+
# @!attribute [rw] id
|
1936
|
+
# Unique identifier for a `ManagedNotificationEvent`.
|
1937
|
+
# @return [String]
|
1938
|
+
#
|
1939
|
+
# @!attribute [rw] message_components
|
1940
|
+
# Describes the components of a notification message.
|
1941
|
+
# @return [Types::MessageComponents]
|
1942
|
+
#
|
1943
|
+
# @!attribute [rw] source_event_detail_url
|
1944
|
+
# URL defined by Source Service to be used by notification consumers
|
1945
|
+
# to get additional information about event.
|
1946
|
+
# @return [String]
|
1947
|
+
#
|
1948
|
+
# @!attribute [rw] source_event_detail_url_display_text
|
1949
|
+
# Text that needs to be hyperlinked with the sourceEventDetailUrl. For
|
1950
|
+
# example, the description of the sourceEventDetailUrl.
|
1951
|
+
# @return [String]
|
1952
|
+
#
|
1953
|
+
# @!attribute [rw] notification_type
|
1954
|
+
# The nature of the event causing this notification.
|
1955
|
+
#
|
1956
|
+
# * Values:
|
1957
|
+
#
|
1958
|
+
# * `ALERT`
|
1959
|
+
#
|
1960
|
+
# * A notification about an event where something was triggered,
|
1961
|
+
# initiated, reopened, deployed, or a threshold was breached.
|
1962
|
+
#
|
1963
|
+
# ^
|
1964
|
+
# * `WARNING`
|
1965
|
+
#
|
1966
|
+
# * A notification about an event where an issue is about to
|
1967
|
+
# arise. For example, something is approaching a threshold.
|
1968
|
+
#
|
1969
|
+
# ^
|
1970
|
+
# * `ANNOUNCEMENT`
|
1971
|
+
#
|
1972
|
+
# * A notification about an important event. For example, a step
|
1973
|
+
# in a workflow or escalation path or that a workflow was
|
1974
|
+
# updated.
|
1975
|
+
#
|
1976
|
+
# ^
|
1977
|
+
# * `INFORMATIONAL`
|
1978
|
+
#
|
1979
|
+
# * A notification about informational messages. For example,
|
1980
|
+
# recommendations, service announcements, or reminders.
|
1981
|
+
#
|
1982
|
+
# ^
|
1983
|
+
# @return [String]
|
1984
|
+
#
|
1985
|
+
# @!attribute [rw] event_status
|
1986
|
+
# The status of an event.
|
1987
|
+
#
|
1988
|
+
# * Values:
|
1989
|
+
#
|
1990
|
+
# * `HEALTHY`
|
1991
|
+
#
|
1992
|
+
# * All EventRules are `ACTIVE` and any call can be run.
|
1993
|
+
#
|
1994
|
+
# ^
|
1995
|
+
# * `UNHEALTHY`
|
1996
|
+
#
|
1997
|
+
# * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any call
|
1998
|
+
# can be run.
|
1999
|
+
#
|
2000
|
+
# ^
|
2001
|
+
# @return [String]
|
2002
|
+
#
|
2003
|
+
# @!attribute [rw] aggregation_event_type
|
2004
|
+
# The notifications aggregation type.
|
2005
|
+
# @return [String]
|
2006
|
+
#
|
2007
|
+
# @!attribute [rw] aggregation_summary
|
2008
|
+
# Provides additional information about the aggregation key.
|
2009
|
+
# @return [Types::AggregationSummary]
|
2010
|
+
#
|
2011
|
+
# @!attribute [rw] start_time
|
2012
|
+
# The earliest time of events to return from this call.
|
2013
|
+
# @return [Time]
|
2014
|
+
#
|
2015
|
+
# @!attribute [rw] end_time
|
2016
|
+
# The end time of the notification event.
|
2017
|
+
# @return [Time]
|
2018
|
+
#
|
2019
|
+
# @!attribute [rw] text_parts
|
2020
|
+
# A list of text values.
|
2021
|
+
# @return [Hash<String,Types::TextPartValue>]
|
2022
|
+
#
|
2023
|
+
# @!attribute [rw] organizational_unit_id
|
2024
|
+
# The Organizational Unit Id that an Amazon Web Services account
|
2025
|
+
# belongs to.
|
2026
|
+
# @return [String]
|
2027
|
+
#
|
2028
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ManagedNotificationEvent AWS API Documentation
|
2029
|
+
#
|
2030
|
+
class ManagedNotificationEvent < Struct.new(
|
2031
|
+
:schema_version,
|
2032
|
+
:id,
|
2033
|
+
:message_components,
|
2034
|
+
:source_event_detail_url,
|
2035
|
+
:source_event_detail_url_display_text,
|
2036
|
+
:notification_type,
|
2037
|
+
:event_status,
|
2038
|
+
:aggregation_event_type,
|
2039
|
+
:aggregation_summary,
|
2040
|
+
:start_time,
|
2041
|
+
:end_time,
|
2042
|
+
:text_parts,
|
2043
|
+
:organizational_unit_id)
|
2044
|
+
SENSITIVE = []
|
2045
|
+
include Aws::Structure
|
2046
|
+
end
|
2047
|
+
|
2048
|
+
# Describes an overview and metadata for a ManagedNotificationEvent.
|
2049
|
+
#
|
2050
|
+
# @!attribute [rw] arn
|
2051
|
+
# The Amazon Resource Name (ARN) of the ManagedNotificationEvent.
|
2052
|
+
# @return [String]
|
2053
|
+
#
|
2054
|
+
# @!attribute [rw] managed_notification_configuration_arn
|
2055
|
+
# The Amazon Resource Name (ARN) of the
|
2056
|
+
# `ManagedNotificationConfiguration`.
|
2057
|
+
# @return [String]
|
2058
|
+
#
|
2059
|
+
# @!attribute [rw] related_account
|
2060
|
+
# The account that related to the `ManagedNotificationEvent`.
|
2061
|
+
# @return [String]
|
2062
|
+
#
|
2063
|
+
# @!attribute [rw] creation_time
|
2064
|
+
# The creation time of the `ManagedNotificationEvent`.
|
2065
|
+
# @return [Time]
|
2066
|
+
#
|
2067
|
+
# @!attribute [rw] notification_event
|
2068
|
+
# A short summary of a `ManagedNotificationEvent`. This is only used
|
2069
|
+
# when listing managed notification events.
|
2070
|
+
# @return [Types::ManagedNotificationEventSummary]
|
2071
|
+
#
|
2072
|
+
# @!attribute [rw] aggregation_event_type
|
2073
|
+
# The notifications aggregation type.
|
2074
|
+
#
|
2075
|
+
# * Values:
|
2076
|
+
#
|
2077
|
+
# * `AGGREGATE`
|
2078
|
+
#
|
2079
|
+
# * The notification event is an aggregate notification. Aggregate
|
2080
|
+
# notifications summarize grouped events over a specified time
|
2081
|
+
# period.
|
2082
|
+
#
|
2083
|
+
# ^
|
2084
|
+
# * `CHILD`
|
2085
|
+
#
|
2086
|
+
# * Some `EventRules` are `ACTIVE` and some are `INACTIVE`. Any
|
2087
|
+
# call can be run.
|
2088
|
+
#
|
2089
|
+
# ^
|
2090
|
+
# * `NONE`
|
2091
|
+
#
|
2092
|
+
# * The notification isn't aggregated.
|
2093
|
+
#
|
2094
|
+
# ^
|
2095
|
+
# @return [String]
|
2096
|
+
#
|
2097
|
+
# @!attribute [rw] organizational_unit_id
|
2098
|
+
# The Organizational Unit Id that an Amazon Web Services account
|
2099
|
+
# belongs to.
|
2100
|
+
# @return [String]
|
889
2101
|
#
|
890
|
-
#
|
2102
|
+
# @!attribute [rw] aggregation_summary
|
2103
|
+
# Provides additional information about the aggregation key.
|
2104
|
+
# @return [Types::AggregationSummary]
|
891
2105
|
#
|
892
|
-
|
893
|
-
|
894
|
-
|
2106
|
+
# @!attribute [rw] aggregated_notification_regions
|
2107
|
+
# The list of the regions where the aggregated notifications in this
|
2108
|
+
# `NotificationEvent` originated.
|
2109
|
+
# @return [Array<String>]
|
2110
|
+
#
|
2111
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ManagedNotificationEventOverview AWS API Documentation
|
2112
|
+
#
|
2113
|
+
class ManagedNotificationEventOverview < Struct.new(
|
2114
|
+
:arn,
|
2115
|
+
:managed_notification_configuration_arn,
|
2116
|
+
:related_account,
|
2117
|
+
:creation_time,
|
2118
|
+
:notification_event,
|
2119
|
+
:aggregation_event_type,
|
2120
|
+
:organizational_unit_id,
|
2121
|
+
:aggregation_summary,
|
2122
|
+
:aggregated_notification_regions)
|
895
2123
|
SENSITIVE = []
|
896
2124
|
include Aws::Structure
|
897
2125
|
end
|
898
2126
|
|
899
|
-
#
|
900
|
-
#
|
901
|
-
# @return [Time]
|
2127
|
+
# A short summary of a `ManagedNotificationEvent`. This is only used
|
2128
|
+
# when listing managed notification events.
|
902
2129
|
#
|
903
|
-
# @!attribute [rw]
|
904
|
-
#
|
905
|
-
# @return [Time]
|
906
|
-
#
|
907
|
-
# @!attribute [rw] locale
|
908
|
-
# The locale code of the language used for the retrieved
|
909
|
-
# NotificationEvent. The default locale is English `(en_US)`.
|
2130
|
+
# @!attribute [rw] schema_version
|
2131
|
+
# The schema version of the `ManagedNotificationEvent`.
|
910
2132
|
# @return [String]
|
911
2133
|
#
|
912
|
-
# @!attribute [rw]
|
913
|
-
#
|
2134
|
+
# @!attribute [rw] source_event_metadata
|
2135
|
+
# Contains metadata about the event that caused the
|
2136
|
+
# `ManagedNotificationEvent`.
|
2137
|
+
# @return [Types::ManagedSourceEventMetadataSummary]
|
914
2138
|
#
|
915
|
-
#
|
916
|
-
#
|
917
|
-
#
|
918
|
-
# services][1] in the *Amazon EventBridge User Guide*.
|
2139
|
+
# @!attribute [rw] message_components
|
2140
|
+
# Contains the headline message component.
|
2141
|
+
# @return [Types::MessageComponentsSummary]
|
919
2142
|
#
|
2143
|
+
# @!attribute [rw] event_status
|
2144
|
+
# The managed notification event status.
|
920
2145
|
#
|
2146
|
+
# * Values:
|
921
2147
|
#
|
922
|
-
#
|
923
|
-
# @return [String]
|
2148
|
+
# * `HEALTHY`
|
924
2149
|
#
|
925
|
-
#
|
926
|
-
# Include aggregated child events in the result.
|
927
|
-
# @return [Boolean]
|
2150
|
+
# * All `EventRules` are `ACTIVE`.
|
928
2151
|
#
|
929
|
-
#
|
930
|
-
#
|
931
|
-
# to match.
|
932
|
-
# @return [String]
|
2152
|
+
# ^
|
2153
|
+
# * `UNHEALTHY`
|
933
2154
|
#
|
934
|
-
#
|
935
|
-
# The maximum number of results to be returned in this call. Defaults
|
936
|
-
# to 20.
|
937
|
-
# @return [Integer]
|
2155
|
+
# * Some `EventRules` are `ACTIVE` and some are `INACTIVE`.
|
938
2156
|
#
|
939
|
-
#
|
940
|
-
# The start token for paginated calls. Retrieved from the response of
|
941
|
-
# a previous ListEventRules call. Next token uses Base64 encoding.
|
2157
|
+
# ^
|
942
2158
|
# @return [String]
|
943
2159
|
#
|
944
|
-
#
|
2160
|
+
# @!attribute [rw] notification_type
|
2161
|
+
# The Type of event causing the notification.
|
945
2162
|
#
|
946
|
-
|
947
|
-
:start_time,
|
948
|
-
:end_time,
|
949
|
-
:locale,
|
950
|
-
:source,
|
951
|
-
:include_child_events,
|
952
|
-
:aggregate_notification_event_arn,
|
953
|
-
:max_results,
|
954
|
-
:next_token)
|
955
|
-
SENSITIVE = []
|
956
|
-
include Aws::Structure
|
957
|
-
end
|
958
|
-
|
959
|
-
# @!attribute [rw] next_token
|
960
|
-
# A pagination token. If a non-null pagination token is returned in a
|
961
|
-
# result, pass its value in another request to retrieve more entries.
|
962
|
-
# @return [String]
|
2163
|
+
# * Values:
|
963
2164
|
#
|
964
|
-
#
|
965
|
-
# The list of notification events.
|
966
|
-
# @return [Array<Types::NotificationEventOverview>]
|
2165
|
+
# * `ALERT`
|
967
2166
|
#
|
968
|
-
#
|
2167
|
+
# * A notification about an event where something was triggered,
|
2168
|
+
# initiated, reopened, deployed, or a threshold was breached.
|
969
2169
|
#
|
970
|
-
|
971
|
-
|
972
|
-
:notification_events)
|
973
|
-
SENSITIVE = []
|
974
|
-
include Aws::Structure
|
975
|
-
end
|
976
|
-
|
977
|
-
# @!attribute [rw] max_results
|
978
|
-
# The maximum number of records to list in a single response.
|
979
|
-
# @return [Integer]
|
2170
|
+
# ^
|
2171
|
+
# * `WARNING`
|
980
2172
|
#
|
981
|
-
#
|
982
|
-
#
|
983
|
-
# from the start.
|
984
|
-
# @return [String]
|
2173
|
+
# * A notification about an event where an issue is about to
|
2174
|
+
# arise. For example, something is approaching a threshold.
|
985
2175
|
#
|
986
|
-
#
|
2176
|
+
# ^
|
2177
|
+
# * `ANNOUNCEMENT`
|
987
2178
|
#
|
988
|
-
|
989
|
-
|
990
|
-
|
991
|
-
SENSITIVE = []
|
992
|
-
include Aws::Structure
|
993
|
-
end
|
994
|
-
|
995
|
-
# @!attribute [rw] notification_hubs
|
996
|
-
# The NotificationHubs in the account.
|
997
|
-
# @return [Array<Types::NotificationHubOverview>]
|
2179
|
+
# * A notification about an important event. For example, a step
|
2180
|
+
# in a workflow or escalation path or that a workflow was
|
2181
|
+
# updated.
|
998
2182
|
#
|
999
|
-
#
|
1000
|
-
#
|
1001
|
-
#
|
2183
|
+
# ^
|
2184
|
+
# * `INFORMATIONAL`
|
2185
|
+
#
|
2186
|
+
# * A notification about informational messages. For example,
|
2187
|
+
# recommendations, service announcements, or reminders.
|
2188
|
+
#
|
2189
|
+
# ^
|
1002
2190
|
# @return [String]
|
1003
2191
|
#
|
1004
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/
|
2192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ManagedNotificationEventSummary AWS API Documentation
|
1005
2193
|
#
|
1006
|
-
class
|
1007
|
-
:
|
1008
|
-
:
|
2194
|
+
class ManagedNotificationEventSummary < Struct.new(
|
2195
|
+
:schema_version,
|
2196
|
+
:source_event_metadata,
|
2197
|
+
:message_components,
|
2198
|
+
:event_status,
|
2199
|
+
:notification_type)
|
1009
2200
|
SENSITIVE = []
|
1010
2201
|
include Aws::Structure
|
1011
2202
|
end
|
1012
2203
|
|
1013
|
-
#
|
1014
|
-
#
|
2204
|
+
# A short summary and metadata for a managed notification event.
|
2205
|
+
#
|
2206
|
+
# @!attribute [rw] event_origin_region
|
2207
|
+
# The Region where the notification originated.
|
1015
2208
|
# @return [String]
|
1016
2209
|
#
|
1017
|
-
#
|
2210
|
+
# @!attribute [rw] source
|
2211
|
+
# The source service of the notification.
|
1018
2212
|
#
|
1019
|
-
|
1020
|
-
|
1021
|
-
|
1022
|
-
|
1023
|
-
|
1024
|
-
|
1025
|
-
# @!attribute [rw] tags
|
1026
|
-
# A list of tags for the specified ARN.
|
1027
|
-
# @return [Hash<String,String>]
|
2213
|
+
# Must match one of the valid EventBridge sources. Only Amazon Web
|
2214
|
+
# Services service sourced events are supported. For example,
|
2215
|
+
# `aws.ec2` and `aws.cloudwatch`. For more information, see [Event
|
2216
|
+
# delivery from Amazon Web Services services][1] in the *Amazon
|
2217
|
+
# EventBridge User Guide*.
|
1028
2218
|
#
|
1029
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListTagsForResourceResponse AWS API Documentation
|
1030
2219
|
#
|
1031
|
-
|
1032
|
-
|
2220
|
+
#
|
2221
|
+
# [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
|
2222
|
+
# @return [String]
|
2223
|
+
#
|
2224
|
+
# @!attribute [rw] event_type
|
2225
|
+
# The event Type of the notification.
|
2226
|
+
# @return [String]
|
2227
|
+
#
|
2228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ManagedSourceEventMetadataSummary AWS API Documentation
|
2229
|
+
#
|
2230
|
+
class ManagedSourceEventMetadataSummary < Struct.new(
|
2231
|
+
:event_origin_region,
|
2232
|
+
:source,
|
2233
|
+
:event_type)
|
1033
2234
|
SENSITIVE = []
|
1034
2235
|
include Aws::Structure
|
1035
2236
|
end
|
@@ -1045,7 +2246,7 @@ module Aws::Notifications
|
|
1045
2246
|
# @return [String]
|
1046
2247
|
#
|
1047
2248
|
# @!attribute [rw] url
|
1048
|
-
# The
|
2249
|
+
# The URL of the media.
|
1049
2250
|
# @return [String]
|
1050
2251
|
#
|
1051
2252
|
# @!attribute [rw] caption
|
@@ -1071,8 +2272,8 @@ module Aws::Notifications
|
|
1071
2272
|
# @return [String]
|
1072
2273
|
#
|
1073
2274
|
# @!attribute [rw] paragraph_summary
|
1074
|
-
# A paragraph long or multiple sentence summary. For example,
|
1075
|
-
#
|
2275
|
+
# A paragraph long or multiple sentence summary. For example, Chatbot
|
2276
|
+
# notifications.
|
1076
2277
|
# @return [String]
|
1077
2278
|
#
|
1078
2279
|
# @!attribute [rw] complete_description
|
@@ -1118,55 +2319,29 @@ module Aws::Notifications
|
|
1118
2319
|
# Contains the complete list of fields for a NotificationConfiguration.
|
1119
2320
|
#
|
1120
2321
|
# @!attribute [rw] arn
|
1121
|
-
# The Amazon Resource Name (ARN) of the
|
2322
|
+
# The Amazon Resource Name (ARN) of the `NotificationConfiguration`
|
2323
|
+
# resource.
|
1122
2324
|
# @return [String]
|
1123
2325
|
#
|
1124
2326
|
# @!attribute [rw] name
|
1125
|
-
# The name of the NotificationConfiguration
|
2327
|
+
# The name of the `NotificationConfiguration`. Supports RFC 3986's
|
1126
2328
|
# unreserved characters.
|
1127
2329
|
# @return [String]
|
1128
2330
|
#
|
1129
2331
|
# @!attribute [rw] description
|
1130
|
-
# The description of the NotificationConfiguration
|
2332
|
+
# The description of the `NotificationConfiguration`.
|
1131
2333
|
# @return [String]
|
1132
2334
|
#
|
1133
2335
|
# @!attribute [rw] status
|
1134
|
-
# The status of
|
1135
|
-
#
|
1136
|
-
# The status should always be INACTIVE when part of the
|
1137
|
-
# CreateNotificationConfiguration response.
|
1138
|
-
#
|
1139
|
-
# * Values:
|
1140
|
-
#
|
1141
|
-
# * `ACTIVE`
|
1142
|
-
#
|
1143
|
-
# * All EventRules are `ACTIVE` and any call can be run.
|
1144
|
-
#
|
1145
|
-
# ^
|
1146
|
-
# * `PARTIALLY_ACTIVE`
|
1147
|
-
#
|
1148
|
-
# * Some EventRules are `ACTIVE` and some are `INACTIVE`.
|
1149
|
-
#
|
1150
|
-
# * Any call can be run.
|
1151
|
-
# * `INACTIVE`
|
1152
|
-
#
|
1153
|
-
# * All EventRules are `INACTIVE` and any call can be run.
|
1154
|
-
#
|
1155
|
-
# ^
|
1156
|
-
# * `DELETING`
|
1157
|
-
#
|
1158
|
-
# * This NotificationConfiguration is being deleted. Only `GET`
|
1159
|
-
# and `LIST` calls can be run.
|
1160
|
-
#
|
1161
|
-
# * Only `GET` and `LIST` calls can be run.
|
2336
|
+
# The current status of the `NotificationConfiguration`.
|
1162
2337
|
# @return [String]
|
1163
2338
|
#
|
1164
2339
|
# @!attribute [rw] creation_time
|
1165
|
-
# The creation time of the
|
2340
|
+
# The creation time of the `NotificationConfiguration`.
|
1166
2341
|
# @return [Time]
|
1167
2342
|
#
|
1168
2343
|
# @!attribute [rw] aggregation_duration
|
1169
|
-
# The aggregation preference of the NotificationConfiguration
|
2344
|
+
# The aggregation preference of the `NotificationConfiguration`.
|
1170
2345
|
#
|
1171
2346
|
# * Values:
|
1172
2347
|
#
|
@@ -1184,7 +2359,7 @@ module Aws::Notifications
|
|
1184
2359
|
#
|
1185
2360
|
# * Don't aggregate notifications.
|
1186
2361
|
#
|
1187
|
-
#
|
2362
|
+
# ^
|
1188
2363
|
# @return [String]
|
1189
2364
|
#
|
1190
2365
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/NotificationConfigurationStructure AWS API Documentation
|
@@ -1200,7 +2375,7 @@ module Aws::Notifications
|
|
1200
2375
|
include Aws::Structure
|
1201
2376
|
end
|
1202
2377
|
|
1203
|
-
# A NotificationEvent is a notification-focused representation of an
|
2378
|
+
# A `NotificationEvent` is a notification-focused representation of an
|
1204
2379
|
# event. They contain semantic information used by Channels to create
|
1205
2380
|
# end-user notifications.
|
1206
2381
|
#
|
@@ -1209,7 +2384,7 @@ module Aws::Notifications
|
|
1209
2384
|
# @return [String]
|
1210
2385
|
#
|
1211
2386
|
# @!attribute [rw] id
|
1212
|
-
# The unique identifier for a NotificationEvent
|
2387
|
+
# The unique identifier for a `NotificationEvent`.
|
1213
2388
|
# @return [String]
|
1214
2389
|
#
|
1215
2390
|
# @!attribute [rw] source_event_metadata
|
@@ -1261,25 +2436,25 @@ module Aws::Notifications
|
|
1261
2436
|
# @return [String]
|
1262
2437
|
#
|
1263
2438
|
# @!attribute [rw] event_status
|
1264
|
-
# The
|
2439
|
+
# The assessed nature of the event.
|
1265
2440
|
#
|
1266
2441
|
# * Values:
|
1267
2442
|
#
|
1268
2443
|
# * `HEALTHY`
|
1269
2444
|
#
|
1270
|
-
# * All EventRules are `ACTIVE` and any call can be run.
|
2445
|
+
# * All `EventRules` are `ACTIVE` and any call can be run.
|
1271
2446
|
#
|
1272
2447
|
# ^
|
1273
2448
|
# * `UNHEALTHY`
|
1274
2449
|
#
|
1275
|
-
# * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any
|
1276
|
-
# can be run.
|
2450
|
+
# * Some `EventRules` are `ACTIVE` and some are `INACTIVE`. Any
|
2451
|
+
# call can be run.
|
1277
2452
|
#
|
1278
2453
|
# ^
|
1279
2454
|
# @return [String]
|
1280
2455
|
#
|
1281
2456
|
# @!attribute [rw] aggregation_event_type
|
1282
|
-
# The
|
2457
|
+
# The aggregation type of the `NotificationConfiguration`.
|
1283
2458
|
#
|
1284
2459
|
# * Values:
|
1285
2460
|
#
|
@@ -1292,8 +2467,8 @@ module Aws::Notifications
|
|
1292
2467
|
# ^
|
1293
2468
|
# * `CHILD`
|
1294
2469
|
#
|
1295
|
-
# * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any
|
1296
|
-
# can be run.
|
2470
|
+
# * Some `EventRules` are `ACTIVE` and some are `INACTIVE`. Any
|
2471
|
+
# call can be run.
|
1297
2472
|
#
|
1298
2473
|
# ^
|
1299
2474
|
# * `NONE`
|
@@ -1304,12 +2479,17 @@ module Aws::Notifications
|
|
1304
2479
|
# @return [String]
|
1305
2480
|
#
|
1306
2481
|
# @!attribute [rw] aggregate_notification_event_arn
|
1307
|
-
# If the value of aggregationEventType is not `NONE`, this is the
|
2482
|
+
# If the value of `aggregationEventType` is not `NONE`, this is the
|
1308
2483
|
# Amazon Resource Event (ARN) of the parent aggregate notification.
|
1309
2484
|
#
|
1310
2485
|
# This is omitted if notification isn't aggregated.
|
1311
2486
|
# @return [String]
|
1312
2487
|
#
|
2488
|
+
# @!attribute [rw] aggregation_summary
|
2489
|
+
# Provides additional information about how multiple notifications are
|
2490
|
+
# grouped.
|
2491
|
+
# @return [Types::AggregationSummary]
|
2492
|
+
#
|
1313
2493
|
# @!attribute [rw] start_time
|
1314
2494
|
# The notification event start time.
|
1315
2495
|
# @return [Time]
|
@@ -1339,6 +2519,7 @@ module Aws::Notifications
|
|
1339
2519
|
:event_status,
|
1340
2520
|
:aggregation_event_type,
|
1341
2521
|
:aggregate_notification_event_arn,
|
2522
|
+
:aggregation_summary,
|
1342
2523
|
:start_time,
|
1343
2524
|
:end_time,
|
1344
2525
|
:text_parts,
|
@@ -1347,7 +2528,7 @@ module Aws::Notifications
|
|
1347
2528
|
include Aws::Structure
|
1348
2529
|
end
|
1349
2530
|
|
1350
|
-
# Describes a short summary of a NotificationEvent
|
2531
|
+
# Describes a short summary of a `NotificationEvent`. This is only used
|
1351
2532
|
# when listing notification events.
|
1352
2533
|
#
|
1353
2534
|
# @!attribute [rw] arn
|
@@ -1355,26 +2536,26 @@ module Aws::Notifications
|
|
1355
2536
|
# @return [String]
|
1356
2537
|
#
|
1357
2538
|
# @!attribute [rw] notification_configuration_arn
|
1358
|
-
# The ARN of the NotificationConfiguration
|
2539
|
+
# The ARN of the `NotificationConfiguration`.
|
1359
2540
|
# @return [String]
|
1360
2541
|
#
|
1361
2542
|
# @!attribute [rw] related_account
|
1362
|
-
# The account name containing the NotificationHub
|
2543
|
+
# The account name containing the `NotificationHub`.
|
1363
2544
|
# @return [String]
|
1364
2545
|
#
|
1365
2546
|
# @!attribute [rw] creation_time
|
1366
|
-
# The creation time of the NotificationEvent
|
2547
|
+
# The creation time of the `NotificationEvent`.
|
1367
2548
|
# @return [Time]
|
1368
2549
|
#
|
1369
2550
|
# @!attribute [rw] notification_event
|
1370
|
-
# Refers to a NotificationEventSummary object.
|
2551
|
+
# Refers to a `NotificationEventSummary` object.
|
1371
2552
|
#
|
1372
|
-
# Similar in structure to `content` in the GetNotificationEvent
|
2553
|
+
# Similar in structure to `content` in the `GetNotificationEvent`
|
1373
2554
|
# response.
|
1374
2555
|
# @return [Types::NotificationEventSummary]
|
1375
2556
|
#
|
1376
2557
|
# @!attribute [rw] aggregation_event_type
|
1377
|
-
# The NotificationConfiguration's aggregation type.
|
2558
|
+
# The `NotificationConfiguration`'s aggregation type.
|
1378
2559
|
#
|
1379
2560
|
# * Values:
|
1380
2561
|
#
|
@@ -1387,8 +2568,8 @@ module Aws::Notifications
|
|
1387
2568
|
# ^
|
1388
2569
|
# * `CHILD`
|
1389
2570
|
#
|
1390
|
-
# * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any
|
1391
|
-
# can be run.
|
2571
|
+
# * Some `EventRules` are `ACTIVE` and some are `INACTIVE`. Any
|
2572
|
+
# call can be run.
|
1392
2573
|
#
|
1393
2574
|
# ^
|
1394
2575
|
# * `NONE`
|
@@ -1399,9 +2580,13 @@ module Aws::Notifications
|
|
1399
2580
|
# @return [String]
|
1400
2581
|
#
|
1401
2582
|
# @!attribute [rw] aggregate_notification_event_arn
|
1402
|
-
# The ARN of the aggregatedNotificationEventArn to match.
|
2583
|
+
# The ARN of the `aggregatedNotificationEventArn` to match.
|
1403
2584
|
# @return [String]
|
1404
2585
|
#
|
2586
|
+
# @!attribute [rw] aggregation_summary
|
2587
|
+
# Provides an aggregated summary data for notification events.
|
2588
|
+
# @return [Types::AggregationSummary]
|
2589
|
+
#
|
1405
2590
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/NotificationEventOverview AWS API Documentation
|
1406
2591
|
#
|
1407
2592
|
class NotificationEventOverview < Struct.new(
|
@@ -1411,12 +2596,13 @@ module Aws::Notifications
|
|
1411
2596
|
:creation_time,
|
1412
2597
|
:notification_event,
|
1413
2598
|
:aggregation_event_type,
|
1414
|
-
:aggregate_notification_event_arn
|
2599
|
+
:aggregate_notification_event_arn,
|
2600
|
+
:aggregation_summary)
|
1415
2601
|
SENSITIVE = []
|
1416
2602
|
include Aws::Structure
|
1417
2603
|
end
|
1418
2604
|
|
1419
|
-
# Describes a short summary and metadata for a
|
2605
|
+
# Describes a short summary and metadata for a `NotificationEvent`.
|
1420
2606
|
#
|
1421
2607
|
# @!attribute [rw] schema_version
|
1422
2608
|
# The schema version of the Notification Event.
|
@@ -1431,19 +2617,19 @@ module Aws::Notifications
|
|
1431
2617
|
# @return [Types::MessageComponentsSummary]
|
1432
2618
|
#
|
1433
2619
|
# @!attribute [rw] event_status
|
1434
|
-
#
|
2620
|
+
# Provides additional information about the current status of the
|
2621
|
+
# `NotificationEvent`.
|
1435
2622
|
#
|
1436
2623
|
# * Values:
|
1437
2624
|
#
|
1438
2625
|
# * `HEALTHY`
|
1439
2626
|
#
|
1440
|
-
# * All EventRules are `ACTIVE
|
2627
|
+
# * All `EventRules` are `ACTIVE`.
|
1441
2628
|
#
|
1442
2629
|
# ^
|
1443
2630
|
# * `UNHEALTHY`
|
1444
2631
|
#
|
1445
|
-
# * Some EventRules are `ACTIVE` and some are `INACTIVE`.
|
1446
|
-
# can be run.
|
2632
|
+
# * Some `EventRules` are `ACTIVE` and some are `INACTIVE`.
|
1447
2633
|
#
|
1448
2634
|
# ^
|
1449
2635
|
# @return [String]
|
@@ -1492,10 +2678,10 @@ module Aws::Notifications
|
|
1492
2678
|
include Aws::Structure
|
1493
2679
|
end
|
1494
2680
|
|
1495
|
-
# Describes an overview of a NotificationHub
|
2681
|
+
# Describes an overview of a `NotificationHub`.
|
1496
2682
|
#
|
1497
|
-
# A
|
1498
|
-
# Regions where you want to store, process and replicate your
|
2683
|
+
# A `NotificationConfiguration` is an account-level setting used to
|
2684
|
+
# select the Regions where you want to store, process and replicate your
|
1499
2685
|
# notifications.
|
1500
2686
|
#
|
1501
2687
|
# @!attribute [rw] notification_hub_region
|
@@ -1507,11 +2693,11 @@ module Aws::Notifications
|
|
1507
2693
|
# @return [Types::NotificationHubStatusSummary]
|
1508
2694
|
#
|
1509
2695
|
# @!attribute [rw] creation_time
|
1510
|
-
# The date and time the
|
2696
|
+
# The date and time the `NotificationHubOverview` was created.
|
1511
2697
|
# @return [Time]
|
1512
2698
|
#
|
1513
2699
|
# @!attribute [rw] last_activation_time
|
1514
|
-
# The most recent time this NotificationHub had an ACTIVE status.
|
2700
|
+
# The most recent time this `NotificationHub` had an `ACTIVE` status.
|
1515
2701
|
# @return [Time]
|
1516
2702
|
#
|
1517
2703
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/NotificationHubOverview AWS API Documentation
|
@@ -1525,36 +2711,38 @@ module Aws::Notifications
|
|
1525
2711
|
include Aws::Structure
|
1526
2712
|
end
|
1527
2713
|
|
1528
|
-
#
|
2714
|
+
# Provides additional information about the current `NotificationHub`
|
2715
|
+
# status.
|
1529
2716
|
#
|
1530
2717
|
# @!attribute [rw] status
|
1531
|
-
# Status information about the NotificationHub
|
2718
|
+
# Status information about the `NotificationHub`.
|
1532
2719
|
#
|
1533
2720
|
# * Values:
|
1534
2721
|
#
|
1535
2722
|
# * `ACTIVE`
|
1536
2723
|
#
|
1537
|
-
# * Incoming NotificationEvents are replicated to this
|
1538
|
-
# NotificationHub
|
2724
|
+
# * Incoming `NotificationEvents` are replicated to this
|
2725
|
+
# `NotificationHub`.
|
1539
2726
|
#
|
1540
2727
|
# ^
|
1541
2728
|
# * `REGISTERING`
|
1542
2729
|
#
|
1543
|
-
# * The
|
1544
|
-
# this status can't be
|
2730
|
+
# * The `NotificationConfiguration` is initializing. A
|
2731
|
+
# `NotificationConfiguration` with this status can't be
|
2732
|
+
# deregistered.
|
1545
2733
|
#
|
1546
2734
|
# ^
|
1547
2735
|
# * `DEREGISTERING`
|
1548
2736
|
#
|
1549
|
-
# * The
|
1550
|
-
# additional NotificationHubs in the same Region as a
|
1551
|
-
#
|
2737
|
+
# * The `NotificationConfiguration` is being deleted. You can't
|
2738
|
+
# register additional `NotificationHubs` in the same Region as a
|
2739
|
+
# `NotificationConfiguration` with this status.
|
1552
2740
|
#
|
1553
2741
|
# ^
|
1554
2742
|
# @return [String]
|
1555
2743
|
#
|
1556
2744
|
# @!attribute [rw] reason
|
1557
|
-
# An
|
2745
|
+
# An explanation for the current status.
|
1558
2746
|
# @return [String]
|
1559
2747
|
#
|
1560
2748
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/NotificationHubStatusSummary AWS API Documentation
|
@@ -1566,8 +2754,22 @@ module Aws::Notifications
|
|
1566
2754
|
include Aws::Structure
|
1567
2755
|
end
|
1568
2756
|
|
2757
|
+
# Orgs Service trust for User Notifications.
|
2758
|
+
#
|
2759
|
+
# @!attribute [rw] access_status
|
2760
|
+
# Access Status for the Orgs Service.
|
2761
|
+
# @return [String]
|
2762
|
+
#
|
2763
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/NotificationsAccessForOrganization AWS API Documentation
|
2764
|
+
#
|
2765
|
+
class NotificationsAccessForOrganization < Struct.new(
|
2766
|
+
:access_status)
|
2767
|
+
SENSITIVE = []
|
2768
|
+
include Aws::Structure
|
2769
|
+
end
|
2770
|
+
|
1569
2771
|
# @!attribute [rw] notification_hub_region
|
1570
|
-
# The Region of the NotificationHub
|
2772
|
+
# The Region of the `NotificationHub`.
|
1571
2773
|
# @return [String]
|
1572
2774
|
#
|
1573
2775
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/RegisterNotificationHubRequest AWS API Documentation
|
@@ -1579,11 +2781,12 @@ module Aws::Notifications
|
|
1579
2781
|
end
|
1580
2782
|
|
1581
2783
|
# @!attribute [rw] notification_hub_region
|
1582
|
-
# The Region of the NotificationHub
|
2784
|
+
# The Region of the `NotificationHub`.
|
1583
2785
|
# @return [String]
|
1584
2786
|
#
|
1585
2787
|
# @!attribute [rw] status_summary
|
1586
|
-
#
|
2788
|
+
# Provides additional information about the current
|
2789
|
+
# `NotificationConfiguration` status information.
|
1587
2790
|
# @return [Types::NotificationHubStatusSummary]
|
1588
2791
|
#
|
1589
2792
|
# @!attribute [rw] creation_time
|
@@ -1721,12 +2924,12 @@ module Aws::Notifications
|
|
1721
2924
|
# @return [String]
|
1722
2925
|
#
|
1723
2926
|
# @!attribute [rw] related_account
|
1724
|
-
# The
|
2927
|
+
# The primary Amazon Web Services account of `SourceEvent`.
|
1725
2928
|
# @return [String]
|
1726
2929
|
#
|
1727
2930
|
# @!attribute [rw] source
|
1728
|
-
# The
|
1729
|
-
# `aws.cloudwatch`.
|
2931
|
+
# The Amazon Web Services service the event originates from. For
|
2932
|
+
# example `aws.cloudwatch`.
|
1730
2933
|
# @return [String]
|
1731
2934
|
#
|
1732
2935
|
# @!attribute [rw] event_occurrence_time
|
@@ -1735,11 +2938,11 @@ module Aws::Notifications
|
|
1735
2938
|
# @return [Time]
|
1736
2939
|
#
|
1737
2940
|
# @!attribute [rw] event_type
|
1738
|
-
# The type of event. For example, an
|
2941
|
+
# The type of event. For example, an Amazon CloudWatch state change.
|
1739
2942
|
# @return [String]
|
1740
2943
|
#
|
1741
2944
|
# @!attribute [rw] related_resources
|
1742
|
-
# A list of resources related to this NotificationEvent
|
2945
|
+
# A list of resources related to this `NotificationEvent`.
|
1743
2946
|
# @return [Array<Types::Resource>]
|
1744
2947
|
#
|
1745
2948
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/SourceEventMetadata AWS API Documentation
|
@@ -1757,8 +2960,8 @@ module Aws::Notifications
|
|
1757
2960
|
include Aws::Structure
|
1758
2961
|
end
|
1759
2962
|
|
1760
|
-
# Contains metadata about the event that caused the NotificationEvent
|
1761
|
-
# For other specific values, see sourceEventMetadata
|
2963
|
+
# Contains metadata about the event that caused the `NotificationEvent`.
|
2964
|
+
# For other specific values, see `sourceEventMetadata`.
|
1762
2965
|
#
|
1763
2966
|
# @!attribute [rw] event_origin_region
|
1764
2967
|
# The Region where the notification originated.
|
@@ -1769,10 +2972,11 @@ module Aws::Notifications
|
|
1769
2972
|
# @!attribute [rw] source
|
1770
2973
|
# The matched event source.
|
1771
2974
|
#
|
1772
|
-
# Must match one of the valid EventBridge sources. Only
|
1773
|
-
# sourced events are supported. For example,
|
1774
|
-
# `aws.cloudwatch`. For more information, see [Event
|
1775
|
-
# services][1] in the *Amazon
|
2975
|
+
# Must match one of the valid EventBridge sources. Only Amazon Web
|
2976
|
+
# Services service sourced events are supported. For example,
|
2977
|
+
# `aws.ec2` and `aws.cloudwatch`. For more information, see [Event
|
2978
|
+
# delivery from Amazon Web Services services][1] in the *Amazon
|
2979
|
+
# EventBridge User Guide*.
|
1776
2980
|
#
|
1777
2981
|
#
|
1778
2982
|
#
|
@@ -1783,9 +2987,10 @@ module Aws::Notifications
|
|
1783
2987
|
# The event type to match.
|
1784
2988
|
#
|
1785
2989
|
# Must match one of the valid Amazon EventBridge event types. For
|
1786
|
-
# example, EC2 Instance State-change Notification and
|
1787
|
-
# Alarm State Change. For more information, see [Event
|
1788
|
-
#
|
2990
|
+
# example, EC2 Instance State-change Notification and Amazon
|
2991
|
+
# CloudWatch Alarm State Change. For more information, see [Event
|
2992
|
+
# delivery from Amazon Web Services services][1] in the *Amazon
|
2993
|
+
# EventBridge User Guide*.
|
1789
2994
|
#
|
1790
2995
|
#
|
1791
2996
|
#
|
@@ -1802,6 +3007,51 @@ module Aws::Notifications
|
|
1802
3007
|
include Aws::Structure
|
1803
3008
|
end
|
1804
3009
|
|
3010
|
+
# Provides detailed information about the dimensions used for event
|
3011
|
+
# summarization and aggregation.
|
3012
|
+
#
|
3013
|
+
# @!attribute [rw] name
|
3014
|
+
# The name of the SummarizationDimensionDetail.
|
3015
|
+
# @return [String]
|
3016
|
+
#
|
3017
|
+
# @!attribute [rw] value
|
3018
|
+
# Value of the property used to summarize aggregated events.
|
3019
|
+
# @return [String]
|
3020
|
+
#
|
3021
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/SummarizationDimensionDetail AWS API Documentation
|
3022
|
+
#
|
3023
|
+
class SummarizationDimensionDetail < Struct.new(
|
3024
|
+
:name,
|
3025
|
+
:value)
|
3026
|
+
SENSITIVE = []
|
3027
|
+
include Aws::Structure
|
3028
|
+
end
|
3029
|
+
|
3030
|
+
# Provides an overview of how data is summarized across different
|
3031
|
+
# dimensions.
|
3032
|
+
#
|
3033
|
+
# @!attribute [rw] name
|
3034
|
+
# Name of the summarization dimension.
|
3035
|
+
# @return [String]
|
3036
|
+
#
|
3037
|
+
# @!attribute [rw] count
|
3038
|
+
# Total number of occurrences for this dimension.
|
3039
|
+
# @return [Integer]
|
3040
|
+
#
|
3041
|
+
# @!attribute [rw] sample_values
|
3042
|
+
# Indicates the sample values found within the dimension.
|
3043
|
+
# @return [Array<String>]
|
3044
|
+
#
|
3045
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/SummarizationDimensionOverview AWS API Documentation
|
3046
|
+
#
|
3047
|
+
class SummarizationDimensionOverview < Struct.new(
|
3048
|
+
:name,
|
3049
|
+
:count,
|
3050
|
+
:sample_values)
|
3051
|
+
SENSITIVE = []
|
3052
|
+
include Aws::Structure
|
3053
|
+
end
|
3054
|
+
|
1805
3055
|
# @!attribute [rw] arn
|
1806
3056
|
# The Amazon Resource Name (ARN) to use to tag a resource.
|
1807
3057
|
# @return [String]
|
@@ -1833,7 +3083,7 @@ module Aws::Notifications
|
|
1833
3083
|
# @return [String]
|
1834
3084
|
#
|
1835
3085
|
# @!attribute [rw] display_text
|
1836
|
-
# A short single line description of the link. Must be
|
3086
|
+
# A short single line description of the link. Must be hyper-linked
|
1837
3087
|
# with the URL itself.
|
1838
3088
|
#
|
1839
3089
|
# Used for text parts with the type `URL`.
|
@@ -1909,12 +3159,12 @@ module Aws::Notifications
|
|
1909
3159
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
1910
3160
|
|
1911
3161
|
# @!attribute [rw] arn
|
1912
|
-
# The Amazon Resource Name (ARN) to use to update the EventRule
|
3162
|
+
# The Amazon Resource Name (ARN) to use to update the `EventRule`.
|
1913
3163
|
# @return [String]
|
1914
3164
|
#
|
1915
3165
|
# @!attribute [rw] event_pattern
|
1916
3166
|
# An additional event pattern used to further filter the events this
|
1917
|
-
# EventRule receives.
|
3167
|
+
# `EventRule` receives.
|
1918
3168
|
#
|
1919
3169
|
# For more information, see [Amazon EventBridge event patterns][1] in
|
1920
3170
|
# the *Amazon EventBridge User Guide.*
|
@@ -1925,7 +3175,8 @@ module Aws::Notifications
|
|
1925
3175
|
# @return [String]
|
1926
3176
|
#
|
1927
3177
|
# @!attribute [rw] regions
|
1928
|
-
# A list of
|
3178
|
+
# A list of Amazon Web Services Regions that sends events to this
|
3179
|
+
# `EventRule`.
|
1929
3180
|
# @return [Array<String>]
|
1930
3181
|
#
|
1931
3182
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/UpdateEventRuleRequest AWS API Documentation
|
@@ -1939,11 +3190,11 @@ module Aws::Notifications
|
|
1939
3190
|
end
|
1940
3191
|
|
1941
3192
|
# @!attribute [rw] arn
|
1942
|
-
# The Amazon Resource Name (ARN) to use to update the EventRule
|
3193
|
+
# The Amazon Resource Name (ARN) to use to update the `EventRule`.
|
1943
3194
|
# @return [String]
|
1944
3195
|
#
|
1945
3196
|
# @!attribute [rw] notification_configuration_arn
|
1946
|
-
# The ARN of the NotificationConfiguration
|
3197
|
+
# The ARN of the `NotificationConfiguration`.
|
1947
3198
|
# @return [String]
|
1948
3199
|
#
|
1949
3200
|
# @!attribute [rw] status_summary_by_region
|
@@ -1962,46 +3213,37 @@ module Aws::Notifications
|
|
1962
3213
|
|
1963
3214
|
# @!attribute [rw] arn
|
1964
3215
|
# The Amazon Resource Name (ARN) used to update the
|
1965
|
-
# NotificationConfiguration
|
3216
|
+
# `NotificationConfiguration`.
|
1966
3217
|
# @return [String]
|
1967
3218
|
#
|
1968
3219
|
# @!attribute [rw] name
|
1969
|
-
# The name of the NotificationConfiguration
|
3220
|
+
# The name of the `NotificationConfiguration`.
|
1970
3221
|
# @return [String]
|
1971
3222
|
#
|
1972
3223
|
# @!attribute [rw] description
|
1973
|
-
# The description of the NotificationConfiguration
|
3224
|
+
# The description of the `NotificationConfiguration`.
|
1974
3225
|
# @return [String]
|
1975
3226
|
#
|
1976
3227
|
# @!attribute [rw] aggregation_duration
|
1977
|
-
# The
|
1978
|
-
#
|
1979
|
-
# The status should always be `INACTIVE` when part of the
|
1980
|
-
# CreateNotificationConfiguration response.
|
3228
|
+
# The aggregation preference of the `NotificationConfiguration`.
|
1981
3229
|
#
|
1982
3230
|
# * Values:
|
1983
3231
|
#
|
1984
|
-
# * `
|
3232
|
+
# * `LONG`
|
1985
3233
|
#
|
1986
|
-
# *
|
3234
|
+
# * Aggregate notifications for long periods of time (12 hours).
|
1987
3235
|
#
|
1988
3236
|
# ^
|
1989
|
-
# * `
|
1990
|
-
#
|
1991
|
-
# * Some EventRules are `ACTIVE` and some are `INACTIVE`. Any call
|
1992
|
-
# can be run.
|
1993
|
-
#
|
1994
|
-
# * Any call can be run.
|
1995
|
-
# * `INACTIVE`
|
3237
|
+
# * `SHORT`
|
1996
3238
|
#
|
1997
|
-
# *
|
3239
|
+
# * Aggregate notifications for short periods of time (5 minutes).
|
1998
3240
|
#
|
1999
3241
|
# ^
|
2000
|
-
# * `
|
3242
|
+
# * `NONE`
|
2001
3243
|
#
|
2002
|
-
# *
|
3244
|
+
# * Don't aggregate notifications.
|
2003
3245
|
#
|
2004
|
-
#
|
3246
|
+
# ^
|
2005
3247
|
# @return [String]
|
2006
3248
|
#
|
2007
3249
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/UpdateNotificationConfigurationRequest AWS API Documentation
|
@@ -2016,7 +3258,7 @@ module Aws::Notifications
|
|
2016
3258
|
end
|
2017
3259
|
|
2018
3260
|
# @!attribute [rw] arn
|
2019
|
-
# The ARN used to update the NotificationConfiguration
|
3261
|
+
# The ARN used to update the `NotificationConfiguration`.
|
2020
3262
|
# @return [String]
|
2021
3263
|
#
|
2022
3264
|
# @see http://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/UpdateNotificationConfigurationResponse AWS API Documentation
|