aws-sdk-health 1.23.0 → 1.28.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-health.rb +3 -1
- data/lib/aws-sdk-health/client.rb +186 -44
- data/lib/aws-sdk-health/client_api.rb +7 -1
- data/lib/aws-sdk-health/errors.rb +2 -0
- data/lib/aws-sdk-health/resource.rb +2 -0
- data/lib/aws-sdk-health/types.rb +314 -63
- metadata +4 -4
data/lib/aws-sdk-health/types.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -47,6 +49,10 @@ module Aws::Health
|
|
47
49
|
#
|
48
50
|
# @!attribute [rw] tags
|
49
51
|
# A map of entity tags attached to the affected entity.
|
52
|
+
#
|
53
|
+
# <note markdown="1"> Currently, the `tags` property isn't supported.
|
54
|
+
#
|
55
|
+
# </note>
|
50
56
|
# @return [Hash<String,String>]
|
51
57
|
#
|
52
58
|
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/AffectedEntity AWS API Documentation
|
@@ -60,12 +66,19 @@ module Aws::Health
|
|
60
66
|
:last_updated_time,
|
61
67
|
:status_code,
|
62
68
|
:tags)
|
69
|
+
SENSITIVE = []
|
63
70
|
include Aws::Structure
|
64
71
|
end
|
65
72
|
|
66
|
-
# EnableHealthServiceAccessForOrganization is already in progress.
|
67
|
-
# for the action to complete before trying again. To get the
|
68
|
-
# status, use the
|
73
|
+
# [EnableHealthServiceAccessForOrganization][1] is already in progress.
|
74
|
+
# Wait for the action to complete before trying again. To get the
|
75
|
+
# current status, use the
|
76
|
+
# [DescribeHealthServiceStatusForOrganization][2] operation.
|
77
|
+
#
|
78
|
+
#
|
79
|
+
#
|
80
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html
|
81
|
+
# [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeHealthServiceStatusForOrganization.html
|
69
82
|
#
|
70
83
|
# @!attribute [rw] message
|
71
84
|
# @return [String]
|
@@ -74,16 +87,22 @@ module Aws::Health
|
|
74
87
|
#
|
75
88
|
class ConcurrentModificationException < Struct.new(
|
76
89
|
:message)
|
90
|
+
SENSITIVE = []
|
77
91
|
include Aws::Structure
|
78
92
|
end
|
79
93
|
|
80
|
-
# A range of dates and times that is used by the EventFilter and
|
81
|
-
# EntityFilter objects. If `from` is set and `to` is set: match
|
82
|
-
# where the timestamp (`startTime`, `endTime`, or
|
83
|
-
# between `from` and `to` inclusive. If `from` is
|
84
|
-
# set: match items where the timestamp value is
|
85
|
-
# `from`. If `from` is not set and `to` is set: match
|
86
|
-
# timestamp value is equal to or before `to`.
|
94
|
+
# A range of dates and times that is used by the [EventFilter][1] and
|
95
|
+
# [EntityFilter][2] objects. If `from` is set and `to` is set: match
|
96
|
+
# items where the timestamp (`startTime`, `endTime`, or
|
97
|
+
# `lastUpdatedTime`) is between `from` and `to` inclusive. If `from` is
|
98
|
+
# set and `to` is not set: match items where the timestamp value is
|
99
|
+
# equal to or after `from`. If `from` is not set and `to` is set: match
|
100
|
+
# items where the timestamp value is equal to or before `to`.
|
101
|
+
#
|
102
|
+
#
|
103
|
+
#
|
104
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html
|
105
|
+
# [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html
|
87
106
|
#
|
88
107
|
# @note When making an API call, you may pass DateTimeRange
|
89
108
|
# data as a hash:
|
@@ -106,6 +125,7 @@ module Aws::Health
|
|
106
125
|
class DateTimeRange < Struct.new(
|
107
126
|
:from,
|
108
127
|
:to)
|
128
|
+
SENSITIVE = []
|
109
129
|
include Aws::Structure
|
110
130
|
end
|
111
131
|
|
@@ -144,6 +164,7 @@ module Aws::Health
|
|
144
164
|
:event_arn,
|
145
165
|
:next_token,
|
146
166
|
:max_results)
|
167
|
+
SENSITIVE = []
|
147
168
|
include Aws::Structure
|
148
169
|
end
|
149
170
|
|
@@ -151,6 +172,23 @@ module Aws::Health
|
|
151
172
|
# A JSON set of elements of the affected accounts.
|
152
173
|
# @return [Array<String>]
|
153
174
|
#
|
175
|
+
# @!attribute [rw] event_scope_code
|
176
|
+
# This parameter specifies if the AWS Health event is a public AWS
|
177
|
+
# service event or an account-specific event.
|
178
|
+
#
|
179
|
+
# * If the `eventScopeCode` value is `PUBLIC`, then the
|
180
|
+
# `affectedAccounts` value is always empty.
|
181
|
+
#
|
182
|
+
# * If the `eventScopeCode` value is `ACCOUNT_SPECIFIC`, then the
|
183
|
+
# `affectedAccounts` value lists the affected AWS accounts in your
|
184
|
+
# organization. For example, if an event affects a service such as
|
185
|
+
# Amazon Elastic Compute Cloud and you have AWS accounts that use
|
186
|
+
# that service, those account IDs appear in the response.
|
187
|
+
#
|
188
|
+
# * If the `eventScopeCode` value is `NONE`, then the `eventArn` that
|
189
|
+
# you specified in the request is invalid or doesn't exist.
|
190
|
+
# @return [String]
|
191
|
+
#
|
154
192
|
# @!attribute [rw] next_token
|
155
193
|
# If the results of a search are large, only a portion of the results
|
156
194
|
# are returned, and a `nextToken` pagination token is returned in the
|
@@ -163,7 +201,9 @@ module Aws::Health
|
|
163
201
|
#
|
164
202
|
class DescribeAffectedAccountsForOrganizationResponse < Struct.new(
|
165
203
|
:affected_accounts,
|
204
|
+
:event_scope_code,
|
166
205
|
:next_token)
|
206
|
+
SENSITIVE = []
|
167
207
|
include Aws::Structure
|
168
208
|
end
|
169
209
|
|
@@ -174,7 +214,7 @@ module Aws::Health
|
|
174
214
|
# organization_entity_filters: [ # required
|
175
215
|
# {
|
176
216
|
# event_arn: "eventArn", # required
|
177
|
-
# aws_account_id: "accountId",
|
217
|
+
# aws_account_id: "accountId",
|
178
218
|
# },
|
179
219
|
# ],
|
180
220
|
# locale: "locale",
|
@@ -212,13 +252,14 @@ module Aws::Health
|
|
212
252
|
:locale,
|
213
253
|
:next_token,
|
214
254
|
:max_results)
|
255
|
+
SENSITIVE = []
|
215
256
|
include Aws::Structure
|
216
257
|
end
|
217
258
|
|
218
259
|
# @!attribute [rw] entities
|
219
260
|
# A JSON set of elements including the `awsAccountId` and its
|
220
261
|
# `entityArn`, `entityValue` and its `entityArn`, `lastUpdatedTime`,
|
221
|
-
#
|
262
|
+
# and `statusCode`.
|
222
263
|
# @return [Array<Types::AffectedEntity>]
|
223
264
|
#
|
224
265
|
# @!attribute [rw] failed_set
|
@@ -240,6 +281,7 @@ module Aws::Health
|
|
240
281
|
:entities,
|
241
282
|
:failed_set,
|
242
283
|
:next_token)
|
284
|
+
SENSITIVE = []
|
243
285
|
include Aws::Structure
|
244
286
|
end
|
245
287
|
|
@@ -299,6 +341,7 @@ module Aws::Health
|
|
299
341
|
:locale,
|
300
342
|
:next_token,
|
301
343
|
:max_results)
|
344
|
+
SENSITIVE = []
|
302
345
|
include Aws::Structure
|
303
346
|
end
|
304
347
|
|
@@ -319,6 +362,7 @@ module Aws::Health
|
|
319
362
|
class DescribeAffectedEntitiesResponse < Struct.new(
|
320
363
|
:entities,
|
321
364
|
:next_token)
|
365
|
+
SENSITIVE = []
|
322
366
|
include Aws::Structure
|
323
367
|
end
|
324
368
|
|
@@ -339,6 +383,7 @@ module Aws::Health
|
|
339
383
|
#
|
340
384
|
class DescribeEntityAggregatesRequest < Struct.new(
|
341
385
|
:event_arns)
|
386
|
+
SENSITIVE = []
|
342
387
|
include Aws::Structure
|
343
388
|
end
|
344
389
|
|
@@ -351,6 +396,7 @@ module Aws::Health
|
|
351
396
|
#
|
352
397
|
class DescribeEntityAggregatesResponse < Struct.new(
|
353
398
|
:entity_aggregates)
|
399
|
+
SENSITIVE = []
|
354
400
|
include Aws::Structure
|
355
401
|
end
|
356
402
|
|
@@ -425,6 +471,7 @@ module Aws::Health
|
|
425
471
|
:aggregate_field,
|
426
472
|
:max_results,
|
427
473
|
:next_token)
|
474
|
+
SENSITIVE = []
|
428
475
|
include Aws::Structure
|
429
476
|
end
|
430
477
|
|
@@ -446,6 +493,7 @@ module Aws::Health
|
|
446
493
|
class DescribeEventAggregatesResponse < Struct.new(
|
447
494
|
:event_aggregates,
|
448
495
|
:next_token)
|
496
|
+
SENSITIVE = []
|
449
497
|
include Aws::Structure
|
450
498
|
end
|
451
499
|
|
@@ -456,7 +504,7 @@ module Aws::Health
|
|
456
504
|
# organization_event_detail_filters: [ # required
|
457
505
|
# {
|
458
506
|
# event_arn: "eventArn", # required
|
459
|
-
# aws_account_id: "accountId",
|
507
|
+
# aws_account_id: "accountId",
|
460
508
|
# },
|
461
509
|
# ],
|
462
510
|
# locale: "locale",
|
@@ -477,6 +525,7 @@ module Aws::Health
|
|
477
525
|
class DescribeEventDetailsForOrganizationRequest < Struct.new(
|
478
526
|
:organization_event_detail_filters,
|
479
527
|
:locale)
|
528
|
+
SENSITIVE = []
|
480
529
|
include Aws::Structure
|
481
530
|
end
|
482
531
|
|
@@ -493,6 +542,7 @@ module Aws::Health
|
|
493
542
|
class DescribeEventDetailsForOrganizationResponse < Struct.new(
|
494
543
|
:successful_set,
|
495
544
|
:failed_set)
|
545
|
+
SENSITIVE = []
|
496
546
|
include Aws::Structure
|
497
547
|
end
|
498
548
|
|
@@ -520,6 +570,7 @@ module Aws::Health
|
|
520
570
|
class DescribeEventDetailsRequest < Struct.new(
|
521
571
|
:event_arns,
|
522
572
|
:locale)
|
573
|
+
SENSITIVE = []
|
523
574
|
include Aws::Structure
|
524
575
|
end
|
525
576
|
|
@@ -536,6 +587,7 @@ module Aws::Health
|
|
536
587
|
class DescribeEventDetailsResponse < Struct.new(
|
537
588
|
:successful_set,
|
538
589
|
:failed_set)
|
590
|
+
SENSITIVE = []
|
539
591
|
include Aws::Structure
|
540
592
|
end
|
541
593
|
|
@@ -582,6 +634,7 @@ module Aws::Health
|
|
582
634
|
:locale,
|
583
635
|
:next_token,
|
584
636
|
:max_results)
|
637
|
+
SENSITIVE = []
|
585
638
|
include Aws::Structure
|
586
639
|
end
|
587
640
|
|
@@ -607,6 +660,7 @@ module Aws::Health
|
|
607
660
|
class DescribeEventTypesResponse < Struct.new(
|
608
661
|
:event_types,
|
609
662
|
:next_token)
|
663
|
+
SENSITIVE = []
|
610
664
|
include Aws::Structure
|
611
665
|
end
|
612
666
|
|
@@ -670,6 +724,7 @@ module Aws::Health
|
|
670
724
|
:next_token,
|
671
725
|
:max_results,
|
672
726
|
:locale)
|
727
|
+
SENSITIVE = []
|
673
728
|
include Aws::Structure
|
674
729
|
end
|
675
730
|
|
@@ -690,6 +745,7 @@ module Aws::Health
|
|
690
745
|
class DescribeEventsForOrganizationResponse < Struct.new(
|
691
746
|
:events,
|
692
747
|
:next_token)
|
748
|
+
SENSITIVE = []
|
693
749
|
include Aws::Structure
|
694
750
|
end
|
695
751
|
|
@@ -765,6 +821,7 @@ module Aws::Health
|
|
765
821
|
:next_token,
|
766
822
|
:max_results,
|
767
823
|
:locale)
|
824
|
+
SENSITIVE = []
|
768
825
|
include Aws::Structure
|
769
826
|
end
|
770
827
|
|
@@ -785,6 +842,7 @@ module Aws::Health
|
|
785
842
|
class DescribeEventsResponse < Struct.new(
|
786
843
|
:events,
|
787
844
|
:next_token)
|
845
|
+
SENSITIVE = []
|
788
846
|
include Aws::Structure
|
789
847
|
end
|
790
848
|
|
@@ -799,11 +857,16 @@ module Aws::Health
|
|
799
857
|
#
|
800
858
|
class DescribeHealthServiceStatusForOrganizationResponse < Struct.new(
|
801
859
|
:health_service_access_status_for_organization)
|
860
|
+
SENSITIVE = []
|
802
861
|
include Aws::Structure
|
803
862
|
end
|
804
863
|
|
805
864
|
# The number of entities that are affected by one or more events.
|
806
|
-
# Returned by the DescribeEntityAggregates operation.
|
865
|
+
# Returned by the [DescribeEntityAggregates][1] operation.
|
866
|
+
#
|
867
|
+
#
|
868
|
+
#
|
869
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEntityAggregates.html
|
807
870
|
#
|
808
871
|
# @!attribute [rw] event_arn
|
809
872
|
# The unique identifier for the event. Format:
|
@@ -813,7 +876,7 @@ module Aws::Health
|
|
813
876
|
# @return [String]
|
814
877
|
#
|
815
878
|
# @!attribute [rw] count
|
816
|
-
# The number entities that match the criteria for the specified
|
879
|
+
# The number of entities that match the criteria for the specified
|
817
880
|
# events.
|
818
881
|
# @return [Integer]
|
819
882
|
#
|
@@ -822,12 +885,17 @@ module Aws::Health
|
|
822
885
|
class EntityAggregate < Struct.new(
|
823
886
|
:event_arn,
|
824
887
|
:count)
|
888
|
+
SENSITIVE = []
|
825
889
|
include Aws::Structure
|
826
890
|
end
|
827
891
|
|
828
|
-
# The values to use to filter results from the
|
892
|
+
# The values to use to filter results from the [EntityFilter][1]
|
829
893
|
# operation.
|
830
894
|
#
|
895
|
+
#
|
896
|
+
#
|
897
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html
|
898
|
+
#
|
831
899
|
# @note When making an API call, you may pass EntityFilter
|
832
900
|
# data as a hash:
|
833
901
|
#
|
@@ -870,6 +938,10 @@ module Aws::Health
|
|
870
938
|
#
|
871
939
|
# @!attribute [rw] tags
|
872
940
|
# A map of entity tags attached to the affected entity.
|
941
|
+
#
|
942
|
+
# <note markdown="1"> Currently, the `tags` property isn't supported.
|
943
|
+
#
|
944
|
+
# </note>
|
873
945
|
# @return [Array<Hash<String,String>>]
|
874
946
|
#
|
875
947
|
# @!attribute [rw] status_codes
|
@@ -886,11 +958,33 @@ module Aws::Health
|
|
886
958
|
:last_updated_times,
|
887
959
|
:tags,
|
888
960
|
:status_codes)
|
961
|
+
SENSITIVE = []
|
889
962
|
include Aws::Structure
|
890
963
|
end
|
891
964
|
|
892
965
|
# Summary information about an AWS Health event.
|
893
966
|
#
|
967
|
+
# AWS Health events can be public or account-specific:
|
968
|
+
#
|
969
|
+
# * *Public events* might be service events that are not specific to an
|
970
|
+
# AWS account. For example, if there is an issue with an AWS Region,
|
971
|
+
# AWS Health provides information about the event, even if you don't
|
972
|
+
# use services or resources in that Region.
|
973
|
+
#
|
974
|
+
# * *Account-specific* events are specific to either your AWS account or
|
975
|
+
# an account in your organization. For example, if there's an issue
|
976
|
+
# with Amazon Elastic Compute Cloud in a Region that you use, AWS
|
977
|
+
# Health provides information about the event and the affected
|
978
|
+
# resources in the account.
|
979
|
+
#
|
980
|
+
# You can determine if an event is public or account-specific by using
|
981
|
+
# the `eventScopeCode` parameter. For more information, see
|
982
|
+
# [eventScopeCode][1].
|
983
|
+
#
|
984
|
+
#
|
985
|
+
#
|
986
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode
|
987
|
+
#
|
894
988
|
# @!attribute [rw] arn
|
895
989
|
# The unique identifier for the event. Format:
|
896
990
|
# `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
|
@@ -939,6 +1033,23 @@ module Aws::Health
|
|
939
1033
|
# `closed`, and `upcoming`.
|
940
1034
|
# @return [String]
|
941
1035
|
#
|
1036
|
+
# @!attribute [rw] event_scope_code
|
1037
|
+
# This parameter specifies if the AWS Health event is a public AWS
|
1038
|
+
# service event or an account-specific event.
|
1039
|
+
#
|
1040
|
+
# * If the `eventScopeCode` value is `PUBLIC`, then the
|
1041
|
+
# `affectedAccounts` value is always empty.
|
1042
|
+
#
|
1043
|
+
# * If the `eventScopeCode` value is `ACCOUNT_SPECIFIC`, then the
|
1044
|
+
# `affectedAccounts` value lists the affected AWS accounts in your
|
1045
|
+
# organization. For example, if an event affects a service such as
|
1046
|
+
# Amazon Elastic Compute Cloud and you have AWS accounts that use
|
1047
|
+
# that service, those account IDs appear in the response.
|
1048
|
+
#
|
1049
|
+
# * If the `eventScopeCode` value is `NONE`, then the `eventArn` that
|
1050
|
+
# you specified in the request is invalid or doesn't exist.
|
1051
|
+
# @return [String]
|
1052
|
+
#
|
942
1053
|
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/Event AWS API Documentation
|
943
1054
|
#
|
944
1055
|
class Event < Struct.new(
|
@@ -951,20 +1062,27 @@ module Aws::Health
|
|
951
1062
|
:start_time,
|
952
1063
|
:end_time,
|
953
1064
|
:last_updated_time,
|
954
|
-
:status_code
|
1065
|
+
:status_code,
|
1066
|
+
:event_scope_code)
|
1067
|
+
SENSITIVE = []
|
955
1068
|
include Aws::Structure
|
956
1069
|
end
|
957
1070
|
|
958
1071
|
# The values used to filter results from the
|
959
|
-
# DescribeEventDetailsForOrganization and
|
960
|
-
# DescribeAffectedEntitiesForOrganization operations.
|
1072
|
+
# [DescribeEventDetailsForOrganization][1] and
|
1073
|
+
# [DescribeAffectedEntitiesForOrganization][2] operations.
|
1074
|
+
#
|
1075
|
+
#
|
1076
|
+
#
|
1077
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html
|
1078
|
+
# [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html
|
961
1079
|
#
|
962
1080
|
# @note When making an API call, you may pass EventAccountFilter
|
963
1081
|
# data as a hash:
|
964
1082
|
#
|
965
1083
|
# {
|
966
1084
|
# event_arn: "eventArn", # required
|
967
|
-
# aws_account_id: "accountId",
|
1085
|
+
# aws_account_id: "accountId",
|
968
1086
|
# }
|
969
1087
|
#
|
970
1088
|
# @!attribute [rw] event_arn
|
@@ -984,11 +1102,16 @@ module Aws::Health
|
|
984
1102
|
class EventAccountFilter < Struct.new(
|
985
1103
|
:event_arn,
|
986
1104
|
:aws_account_id)
|
1105
|
+
SENSITIVE = []
|
987
1106
|
include Aws::Structure
|
988
1107
|
end
|
989
1108
|
|
990
1109
|
# The number of events of each issue type. Returned by the
|
991
|
-
# DescribeEventAggregates operation.
|
1110
|
+
# [DescribeEventAggregates][1] operation.
|
1111
|
+
#
|
1112
|
+
#
|
1113
|
+
#
|
1114
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html
|
992
1115
|
#
|
993
1116
|
# @!attribute [rw] aggregate_value
|
994
1117
|
# The issue type for the associated count.
|
@@ -1003,11 +1126,16 @@ module Aws::Health
|
|
1003
1126
|
class EventAggregate < Struct.new(
|
1004
1127
|
:aggregate_value,
|
1005
1128
|
:count)
|
1129
|
+
SENSITIVE = []
|
1006
1130
|
include Aws::Structure
|
1007
1131
|
end
|
1008
1132
|
|
1009
1133
|
# The detailed description of the event. Included in the information
|
1010
|
-
# returned by the DescribeEventDetails operation.
|
1134
|
+
# returned by the [DescribeEventDetails][1] operation.
|
1135
|
+
#
|
1136
|
+
#
|
1137
|
+
#
|
1138
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html
|
1011
1139
|
#
|
1012
1140
|
# @!attribute [rw] latest_description
|
1013
1141
|
# The most recent description of the event.
|
@@ -1017,12 +1145,19 @@ module Aws::Health
|
|
1017
1145
|
#
|
1018
1146
|
class EventDescription < Struct.new(
|
1019
1147
|
:latest_description)
|
1148
|
+
SENSITIVE = []
|
1020
1149
|
include Aws::Structure
|
1021
1150
|
end
|
1022
1151
|
|
1023
|
-
# Detailed information about an event. A combination of an Event
|
1024
|
-
# an EventDescription object, and additional metadata about
|
1025
|
-
# Returned by the DescribeEventDetails operation.
|
1152
|
+
# Detailed information about an event. A combination of an [Event][1]
|
1153
|
+
# object, an [EventDescription][2] object, and additional metadata about
|
1154
|
+
# the event. Returned by the [DescribeEventDetails][3] operation.
|
1155
|
+
#
|
1156
|
+
#
|
1157
|
+
#
|
1158
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html
|
1159
|
+
# [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html
|
1160
|
+
# [3]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html
|
1026
1161
|
#
|
1027
1162
|
# @!attribute [rw] event
|
1028
1163
|
# Summary information about the event.
|
@@ -1042,12 +1177,17 @@ module Aws::Health
|
|
1042
1177
|
:event,
|
1043
1178
|
:event_description,
|
1044
1179
|
:event_metadata)
|
1180
|
+
SENSITIVE = []
|
1045
1181
|
include Aws::Structure
|
1046
1182
|
end
|
1047
1183
|
|
1048
|
-
# Error information returned when a DescribeEventDetails operation
|
1184
|
+
# Error information returned when a [DescribeEventDetails][1] operation
|
1049
1185
|
# cannot find a specified event.
|
1050
1186
|
#
|
1187
|
+
#
|
1188
|
+
#
|
1189
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html
|
1190
|
+
#
|
1051
1191
|
# @!attribute [rw] event_arn
|
1052
1192
|
# The unique identifier for the event. Format:
|
1053
1193
|
# `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
|
@@ -1069,11 +1209,17 @@ module Aws::Health
|
|
1069
1209
|
:event_arn,
|
1070
1210
|
:error_name,
|
1071
1211
|
:error_message)
|
1212
|
+
SENSITIVE = []
|
1072
1213
|
include Aws::Structure
|
1073
1214
|
end
|
1074
1215
|
|
1075
|
-
# The values to use to filter results from the DescribeEvents and
|
1076
|
-
# DescribeEventAggregates operations.
|
1216
|
+
# The values to use to filter results from the [DescribeEvents][1] and
|
1217
|
+
# [DescribeEventAggregates][2] operations.
|
1218
|
+
#
|
1219
|
+
#
|
1220
|
+
#
|
1221
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html
|
1222
|
+
# [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html
|
1077
1223
|
#
|
1078
1224
|
# @note When making an API call, you may pass EventFilter
|
1079
1225
|
# data as a hash:
|
@@ -1165,6 +1311,10 @@ module Aws::Health
|
|
1165
1311
|
#
|
1166
1312
|
# @!attribute [rw] tags
|
1167
1313
|
# A map of entity tags attached to the affected entity.
|
1314
|
+
#
|
1315
|
+
# <note markdown="1"> Currently, the `tags` property isn't supported.
|
1316
|
+
#
|
1317
|
+
# </note>
|
1168
1318
|
# @return [Array<Hash<String,String>>]
|
1169
1319
|
#
|
1170
1320
|
# @!attribute [rw] event_status_codes
|
@@ -1187,6 +1337,7 @@ module Aws::Health
|
|
1187
1337
|
:event_type_categories,
|
1188
1338
|
:tags,
|
1189
1339
|
:event_status_codes)
|
1340
|
+
SENSITIVE = []
|
1190
1341
|
include Aws::Structure
|
1191
1342
|
end
|
1192
1343
|
|
@@ -1217,12 +1368,17 @@ module Aws::Health
|
|
1217
1368
|
:service,
|
1218
1369
|
:code,
|
1219
1370
|
:category)
|
1371
|
+
SENSITIVE = []
|
1220
1372
|
include Aws::Structure
|
1221
1373
|
end
|
1222
1374
|
|
1223
|
-
# The values to use to filter results from the DescribeEventTypes
|
1375
|
+
# The values to use to filter results from the [DescribeEventTypes][1]
|
1224
1376
|
# operation.
|
1225
1377
|
#
|
1378
|
+
#
|
1379
|
+
#
|
1380
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html
|
1381
|
+
#
|
1226
1382
|
# @note When making an API call, you may pass EventTypeFilter
|
1227
1383
|
# data as a hash:
|
1228
1384
|
#
|
@@ -1252,6 +1408,7 @@ module Aws::Health
|
|
1252
1408
|
:event_type_codes,
|
1253
1409
|
:services,
|
1254
1410
|
:event_type_categories)
|
1411
|
+
SENSITIVE = []
|
1255
1412
|
include Aws::Structure
|
1256
1413
|
end
|
1257
1414
|
|
@@ -1264,13 +1421,18 @@ module Aws::Health
|
|
1264
1421
|
#
|
1265
1422
|
class InvalidPaginationToken < Struct.new(
|
1266
1423
|
:message)
|
1424
|
+
SENSITIVE = []
|
1267
1425
|
include Aws::Structure
|
1268
1426
|
end
|
1269
1427
|
|
1270
1428
|
# Error information returned when a
|
1271
|
-
# DescribeAffectedEntitiesForOrganization operation cannot find or
|
1429
|
+
# [DescribeAffectedEntitiesForOrganization][1] operation cannot find or
|
1272
1430
|
# process a specific entity.
|
1273
1431
|
#
|
1432
|
+
#
|
1433
|
+
#
|
1434
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html
|
1435
|
+
#
|
1274
1436
|
# @!attribute [rw] aws_account_id
|
1275
1437
|
# The 12-digit AWS account numbers that contains the affected
|
1276
1438
|
# entities.
|
@@ -1300,11 +1462,16 @@ module Aws::Health
|
|
1300
1462
|
:event_arn,
|
1301
1463
|
:error_name,
|
1302
1464
|
:error_message)
|
1465
|
+
SENSITIVE = []
|
1303
1466
|
include Aws::Structure
|
1304
1467
|
end
|
1305
1468
|
|
1306
1469
|
# Summary information about an event, returned by the
|
1307
|
-
# DescribeEventsForOrganization operation.
|
1470
|
+
# [DescribeEventsForOrganization][1] operation.
|
1471
|
+
#
|
1472
|
+
#
|
1473
|
+
#
|
1474
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html
|
1308
1475
|
#
|
1309
1476
|
# @!attribute [rw] arn
|
1310
1477
|
# The unique identifier for the event. Format:
|
@@ -1328,6 +1495,23 @@ module Aws::Health
|
|
1328
1495
|
# The category of the event type.
|
1329
1496
|
# @return [String]
|
1330
1497
|
#
|
1498
|
+
# @!attribute [rw] event_scope_code
|
1499
|
+
# This parameter specifies if the AWS Health event is a public AWS
|
1500
|
+
# service event or an account-specific event.
|
1501
|
+
#
|
1502
|
+
# * If the `eventScopeCode` value is `PUBLIC`, then the
|
1503
|
+
# `affectedAccounts` value is always empty.
|
1504
|
+
#
|
1505
|
+
# * If the `eventScopeCode` value is `ACCOUNT_SPECIFIC`, then the
|
1506
|
+
# `affectedAccounts` value lists the affected AWS accounts in your
|
1507
|
+
# organization. For example, if an event affects a service such as
|
1508
|
+
# Amazon Elastic Compute Cloud and you have AWS accounts that use
|
1509
|
+
# that service, those account IDs appear in the response.
|
1510
|
+
#
|
1511
|
+
# * If the `eventScopeCode` value is `NONE`, then the `eventArn` that
|
1512
|
+
# you specified in the request is invalid or doesn't exist.
|
1513
|
+
# @return [String]
|
1514
|
+
#
|
1331
1515
|
# @!attribute [rw] region
|
1332
1516
|
# The AWS Region name of the event.
|
1333
1517
|
# @return [String]
|
@@ -1356,17 +1540,26 @@ module Aws::Health
|
|
1356
1540
|
:service,
|
1357
1541
|
:event_type_code,
|
1358
1542
|
:event_type_category,
|
1543
|
+
:event_scope_code,
|
1359
1544
|
:region,
|
1360
1545
|
:start_time,
|
1361
1546
|
:end_time,
|
1362
1547
|
:last_updated_time,
|
1363
1548
|
:status_code)
|
1549
|
+
SENSITIVE = []
|
1364
1550
|
include Aws::Structure
|
1365
1551
|
end
|
1366
1552
|
|
1367
|
-
# Detailed information about an event. A combination of an Event
|
1368
|
-
# an EventDescription object, and additional metadata about
|
1369
|
-
# Returned by the DescribeEventDetailsForOrganization
|
1553
|
+
# Detailed information about an event. A combination of an [Event][1]
|
1554
|
+
# object, an [EventDescription][2] object, and additional metadata about
|
1555
|
+
# the event. Returned by the [DescribeEventDetailsForOrganization][3]
|
1556
|
+
# operation.
|
1557
|
+
#
|
1558
|
+
#
|
1559
|
+
#
|
1560
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html
|
1561
|
+
# [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html
|
1562
|
+
# [3]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html
|
1370
1563
|
#
|
1371
1564
|
# @!attribute [rw] aws_account_id
|
1372
1565
|
# The 12-digit AWS account numbers that contains the affected
|
@@ -1375,11 +1568,36 @@ module Aws::Health
|
|
1375
1568
|
#
|
1376
1569
|
# @!attribute [rw] event
|
1377
1570
|
# Summary information about an AWS Health event.
|
1571
|
+
#
|
1572
|
+
# AWS Health events can be public or account-specific:
|
1573
|
+
#
|
1574
|
+
# * *Public events* might be service events that are not specific to
|
1575
|
+
# an AWS account. For example, if there is an issue with an AWS
|
1576
|
+
# Region, AWS Health provides information about the event, even if
|
1577
|
+
# you don't use services or resources in that Region.
|
1578
|
+
#
|
1579
|
+
# * *Account-specific* events are specific to either your AWS account
|
1580
|
+
# or an account in your organization. For example, if there's an
|
1581
|
+
# issue with Amazon Elastic Compute Cloud in a Region that you use,
|
1582
|
+
# AWS Health provides information about the event and the affected
|
1583
|
+
# resources in the account.
|
1584
|
+
#
|
1585
|
+
# You can determine if an event is public or account-specific by using
|
1586
|
+
# the `eventScopeCode` parameter. For more information, see
|
1587
|
+
# [eventScopeCode][1].
|
1588
|
+
#
|
1589
|
+
#
|
1590
|
+
#
|
1591
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode
|
1378
1592
|
# @return [Types::Event]
|
1379
1593
|
#
|
1380
1594
|
# @!attribute [rw] event_description
|
1381
1595
|
# The detailed description of the event. Included in the information
|
1382
|
-
# returned by the DescribeEventDetails operation.
|
1596
|
+
# returned by the [DescribeEventDetails][1] operation.
|
1597
|
+
#
|
1598
|
+
#
|
1599
|
+
#
|
1600
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html
|
1383
1601
|
# @return [Types::EventDescription]
|
1384
1602
|
#
|
1385
1603
|
# @!attribute [rw] event_metadata
|
@@ -1393,16 +1611,26 @@ module Aws::Health
|
|
1393
1611
|
:event,
|
1394
1612
|
:event_description,
|
1395
1613
|
:event_metadata)
|
1614
|
+
SENSITIVE = []
|
1396
1615
|
include Aws::Structure
|
1397
1616
|
end
|
1398
1617
|
|
1399
|
-
# Error information returned when a
|
1400
|
-
# operation cannot find a
|
1618
|
+
# Error information returned when a
|
1619
|
+
# [DescribeEventDetailsForOrganization][1] operation cannot find a
|
1620
|
+
# specified event.
|
1621
|
+
#
|
1622
|
+
#
|
1623
|
+
#
|
1624
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html
|
1401
1625
|
#
|
1402
1626
|
# @!attribute [rw] aws_account_id
|
1403
1627
|
# Error information returned when a
|
1404
|
-
# DescribeEventDetailsForOrganization operation cannot find a
|
1628
|
+
# [DescribeEventDetailsForOrganization][1] operation cannot find a
|
1405
1629
|
# specified event.
|
1630
|
+
#
|
1631
|
+
#
|
1632
|
+
#
|
1633
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html
|
1406
1634
|
# @return [String]
|
1407
1635
|
#
|
1408
1636
|
# @!attribute [rw] event_arn
|
@@ -1427,11 +1655,16 @@ module Aws::Health
|
|
1427
1655
|
:event_arn,
|
1428
1656
|
:error_name,
|
1429
1657
|
:error_message)
|
1658
|
+
SENSITIVE = []
|
1430
1659
|
include Aws::Structure
|
1431
1660
|
end
|
1432
1661
|
|
1433
|
-
# The values to filter results from the
|
1434
|
-
# operation.
|
1662
|
+
# The values to filter results from the
|
1663
|
+
# [DescribeEventsForOrganization][1] operation.
|
1664
|
+
#
|
1665
|
+
#
|
1666
|
+
#
|
1667
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html
|
1435
1668
|
#
|
1436
1669
|
# @note When making an API call, you may pass OrganizationEventFilter
|
1437
1670
|
# data as a hash:
|
@@ -1479,37 +1712,52 @@ module Aws::Health
|
|
1479
1712
|
# @return [Array<String>]
|
1480
1713
|
#
|
1481
1714
|
# @!attribute [rw] start_time
|
1482
|
-
# A range of dates and times that is used by the EventFilter and
|
1483
|
-
# EntityFilter objects. If `from` is set and `to` is set: match
|
1484
|
-
# where the timestamp (`startTime`, `endTime`, or
|
1485
|
-
# is between `from` and `to` inclusive. If `from`
|
1486
|
-
# not set: match items where the timestamp value is
|
1487
|
-
# `from`. If `from` is not set and `to` is set:
|
1488
|
-
# timestamp value is equal to or before `to`.
|
1715
|
+
# A range of dates and times that is used by the [EventFilter][1] and
|
1716
|
+
# [EntityFilter][2] objects. If `from` is set and `to` is set: match
|
1717
|
+
# items where the timestamp (`startTime`, `endTime`, or
|
1718
|
+
# `lastUpdatedTime`) is between `from` and `to` inclusive. If `from`
|
1719
|
+
# is set and `to` is not set: match items where the timestamp value is
|
1720
|
+
# equal to or after `from`. If `from` is not set and `to` is set:
|
1721
|
+
# match items where the timestamp value is equal to or before `to`.
|
1722
|
+
#
|
1723
|
+
#
|
1724
|
+
#
|
1725
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html
|
1726
|
+
# [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html
|
1489
1727
|
# @return [Types::DateTimeRange]
|
1490
1728
|
#
|
1491
1729
|
# @!attribute [rw] end_time
|
1492
|
-
# A range of dates and times that is used by the EventFilter and
|
1493
|
-
# EntityFilter objects. If `from` is set and `to` is set: match
|
1494
|
-
# where the timestamp (`startTime`, `endTime`, or
|
1495
|
-
# is between `from` and `to` inclusive. If `from`
|
1496
|
-
# not set: match items where the timestamp value is
|
1497
|
-
# `from`. If `from` is not set and `to` is set:
|
1498
|
-
# timestamp value is equal to or before `to`.
|
1730
|
+
# A range of dates and times that is used by the [EventFilter][1] and
|
1731
|
+
# [EntityFilter][2] objects. If `from` is set and `to` is set: match
|
1732
|
+
# items where the timestamp (`startTime`, `endTime`, or
|
1733
|
+
# `lastUpdatedTime`) is between `from` and `to` inclusive. If `from`
|
1734
|
+
# is set and `to` is not set: match items where the timestamp value is
|
1735
|
+
# equal to or after `from`. If `from` is not set and `to` is set:
|
1736
|
+
# match items where the timestamp value is equal to or before `to`.
|
1737
|
+
#
|
1738
|
+
#
|
1739
|
+
#
|
1740
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html
|
1741
|
+
# [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html
|
1499
1742
|
# @return [Types::DateTimeRange]
|
1500
1743
|
#
|
1501
1744
|
# @!attribute [rw] last_updated_time
|
1502
|
-
# A range of dates and times that is used by the EventFilter and
|
1503
|
-
# EntityFilter objects. If `from` is set and `to` is set: match
|
1504
|
-
# where the timestamp (`startTime`, `endTime`, or
|
1505
|
-
# is between `from` and `to` inclusive. If `from`
|
1506
|
-
# not set: match items where the timestamp value is
|
1507
|
-
# `from`. If `from` is not set and `to` is set:
|
1508
|
-
# timestamp value is equal to or before `to`.
|
1745
|
+
# A range of dates and times that is used by the [EventFilter][1] and
|
1746
|
+
# [EntityFilter][2] objects. If `from` is set and `to` is set: match
|
1747
|
+
# items where the timestamp (`startTime`, `endTime`, or
|
1748
|
+
# `lastUpdatedTime`) is between `from` and `to` inclusive. If `from`
|
1749
|
+
# is set and `to` is not set: match items where the timestamp value is
|
1750
|
+
# equal to or after `from`. If `from` is not set and `to` is set:
|
1751
|
+
# match items where the timestamp value is equal to or before `to`.
|
1752
|
+
#
|
1753
|
+
#
|
1754
|
+
#
|
1755
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html
|
1756
|
+
# [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html
|
1509
1757
|
# @return [Types::DateTimeRange]
|
1510
1758
|
#
|
1511
1759
|
# @!attribute [rw] entity_arns
|
1512
|
-
#
|
1760
|
+
# A list of entity ARNs (unique identifiers).
|
1513
1761
|
# @return [Array<String>]
|
1514
1762
|
#
|
1515
1763
|
# @!attribute [rw] entity_values
|
@@ -1518,7 +1766,8 @@ module Aws::Health
|
|
1518
1766
|
# @return [Array<String>]
|
1519
1767
|
#
|
1520
1768
|
# @!attribute [rw] event_type_categories
|
1521
|
-
#
|
1769
|
+
# A list of event type category codes (issue, scheduledChange, or
|
1770
|
+
# accountNotification).
|
1522
1771
|
# @return [Array<String>]
|
1523
1772
|
#
|
1524
1773
|
# @!attribute [rw] event_status_codes
|
@@ -1539,6 +1788,7 @@ module Aws::Health
|
|
1539
1788
|
:entity_values,
|
1540
1789
|
:event_type_categories,
|
1541
1790
|
:event_status_codes)
|
1791
|
+
SENSITIVE = []
|
1542
1792
|
include Aws::Structure
|
1543
1793
|
end
|
1544
1794
|
|
@@ -1551,6 +1801,7 @@ module Aws::Health
|
|
1551
1801
|
#
|
1552
1802
|
class UnsupportedLocale < Struct.new(
|
1553
1803
|
:message)
|
1804
|
+
SENSITIVE = []
|
1554
1805
|
include Aws::Structure
|
1555
1806
|
end
|
1556
1807
|
|