aws-sdk-health 1.20.0 → 1.21.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 +1 -1
- data/lib/aws-sdk-health/client.rb +360 -3
- data/lib/aws-sdk-health/client_api.rb +213 -0
- data/lib/aws-sdk-health/errors.rb +16 -0
- data/lib/aws-sdk-health/types.rb +602 -5
- metadata +2 -2
@@ -10,6 +10,22 @@ module Aws::Health
|
|
10
10
|
|
11
11
|
extend Aws::Errors::DynamicErrors
|
12
12
|
|
13
|
+
class ConcurrentModificationException < ServiceError
|
14
|
+
|
15
|
+
# @param [Seahorse::Client::RequestContext] context
|
16
|
+
# @param [String] message
|
17
|
+
# @param [Aws::Health::Types::ConcurrentModificationException] data
|
18
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
19
|
+
super(context, message, data)
|
20
|
+
end
|
21
|
+
|
22
|
+
# @return [String]
|
23
|
+
def message
|
24
|
+
@message || @data[:message]
|
25
|
+
end
|
26
|
+
|
27
|
+
end
|
28
|
+
|
13
29
|
class InvalidPaginationToken < ServiceError
|
14
30
|
|
15
31
|
# @param [Seahorse::Client::RequestContext] context
|
data/lib/aws-sdk-health/types.rb
CHANGED
@@ -29,6 +29,7 @@ module Aws::Health
|
|
29
29
|
# @return [String]
|
30
30
|
#
|
31
31
|
# @!attribute [rw] entity_url
|
32
|
+
# The URL of the affected entity.
|
32
33
|
# @return [String]
|
33
34
|
#
|
34
35
|
# @!attribute [rw] aws_account_id
|
@@ -62,6 +63,20 @@ module Aws::Health
|
|
62
63
|
include Aws::Structure
|
63
64
|
end
|
64
65
|
|
66
|
+
# EnableHealthServiceAccessForOrganization is already in progress. Wait
|
67
|
+
# for the action to complete before trying again. To get the current
|
68
|
+
# status, use the DescribeHealthServiceStatusForOrganization operation.
|
69
|
+
#
|
70
|
+
# @!attribute [rw] message
|
71
|
+
# @return [String]
|
72
|
+
#
|
73
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/ConcurrentModificationException AWS API Documentation
|
74
|
+
#
|
75
|
+
class ConcurrentModificationException < Struct.new(
|
76
|
+
:message)
|
77
|
+
include Aws::Structure
|
78
|
+
end
|
79
|
+
|
65
80
|
# A range of dates and times that is used by the EventFilter and
|
66
81
|
# EntityFilter objects. If `from` is set and `to` is set: match items
|
67
82
|
# where the timestamp (`startTime`, `endTime`, or `lastUpdatedTime`) is
|
@@ -94,6 +109,140 @@ module Aws::Health
|
|
94
109
|
include Aws::Structure
|
95
110
|
end
|
96
111
|
|
112
|
+
# @note When making an API call, you may pass DescribeAffectedAccountsForOrganizationRequest
|
113
|
+
# data as a hash:
|
114
|
+
#
|
115
|
+
# {
|
116
|
+
# event_arn: "eventArn", # required
|
117
|
+
# next_token: "nextToken",
|
118
|
+
# max_results: 1,
|
119
|
+
# }
|
120
|
+
#
|
121
|
+
# @!attribute [rw] event_arn
|
122
|
+
# The unique identifier for the event. Format:
|
123
|
+
# `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
|
124
|
+
# `. Example: `Example:
|
125
|
+
# arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
|
126
|
+
# @return [String]
|
127
|
+
#
|
128
|
+
# @!attribute [rw] next_token
|
129
|
+
# If the results of a search are large, only a portion of the results
|
130
|
+
# are returned, and a `nextToken` pagination token is returned in the
|
131
|
+
# response. To retrieve the next batch of results, reissue the search
|
132
|
+
# request and include the returned token. When all results have been
|
133
|
+
# returned, the response does not contain a pagination token value.
|
134
|
+
# @return [String]
|
135
|
+
#
|
136
|
+
# @!attribute [rw] max_results
|
137
|
+
# The maximum number of items to return in one batch, between 10 and
|
138
|
+
# 100, inclusive.
|
139
|
+
# @return [Integer]
|
140
|
+
#
|
141
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedAccountsForOrganizationRequest AWS API Documentation
|
142
|
+
#
|
143
|
+
class DescribeAffectedAccountsForOrganizationRequest < Struct.new(
|
144
|
+
:event_arn,
|
145
|
+
:next_token,
|
146
|
+
:max_results)
|
147
|
+
include Aws::Structure
|
148
|
+
end
|
149
|
+
|
150
|
+
# @!attribute [rw] affected_accounts
|
151
|
+
# A JSON set of elements of the affected accounts.
|
152
|
+
# @return [Array<String>]
|
153
|
+
#
|
154
|
+
# @!attribute [rw] next_token
|
155
|
+
# If the results of a search are large, only a portion of the results
|
156
|
+
# are returned, and a `nextToken` pagination token is returned in the
|
157
|
+
# response. To retrieve the next batch of results, reissue the search
|
158
|
+
# request and include the returned token. When all results have been
|
159
|
+
# returned, the response does not contain a pagination token value.
|
160
|
+
# @return [String]
|
161
|
+
#
|
162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedAccountsForOrganizationResponse AWS API Documentation
|
163
|
+
#
|
164
|
+
class DescribeAffectedAccountsForOrganizationResponse < Struct.new(
|
165
|
+
:affected_accounts,
|
166
|
+
:next_token)
|
167
|
+
include Aws::Structure
|
168
|
+
end
|
169
|
+
|
170
|
+
# @note When making an API call, you may pass DescribeAffectedEntitiesForOrganizationRequest
|
171
|
+
# data as a hash:
|
172
|
+
#
|
173
|
+
# {
|
174
|
+
# organization_entity_filters: [ # required
|
175
|
+
# {
|
176
|
+
# event_arn: "eventArn", # required
|
177
|
+
# aws_account_id: "accountId", # required
|
178
|
+
# },
|
179
|
+
# ],
|
180
|
+
# locale: "locale",
|
181
|
+
# next_token: "nextToken",
|
182
|
+
# max_results: 1,
|
183
|
+
# }
|
184
|
+
#
|
185
|
+
# @!attribute [rw] organization_entity_filters
|
186
|
+
# A JSON set of elements including the `awsAccountId` and the
|
187
|
+
# `eventArn`.
|
188
|
+
# @return [Array<Types::EventAccountFilter>]
|
189
|
+
#
|
190
|
+
# @!attribute [rw] locale
|
191
|
+
# The locale (language) to return information in. English (en) is the
|
192
|
+
# default and the only supported value at this time.
|
193
|
+
# @return [String]
|
194
|
+
#
|
195
|
+
# @!attribute [rw] next_token
|
196
|
+
# If the results of a search are large, only a portion of the results
|
197
|
+
# are returned, and a `nextToken` pagination token is returned in the
|
198
|
+
# response. To retrieve the next batch of results, reissue the search
|
199
|
+
# request and include the returned token. When all results have been
|
200
|
+
# returned, the response does not contain a pagination token value.
|
201
|
+
# @return [String]
|
202
|
+
#
|
203
|
+
# @!attribute [rw] max_results
|
204
|
+
# The maximum number of items to return in one batch, between 10 and
|
205
|
+
# 100, inclusive.
|
206
|
+
# @return [Integer]
|
207
|
+
#
|
208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedEntitiesForOrganizationRequest AWS API Documentation
|
209
|
+
#
|
210
|
+
class DescribeAffectedEntitiesForOrganizationRequest < Struct.new(
|
211
|
+
:organization_entity_filters,
|
212
|
+
:locale,
|
213
|
+
:next_token,
|
214
|
+
:max_results)
|
215
|
+
include Aws::Structure
|
216
|
+
end
|
217
|
+
|
218
|
+
# @!attribute [rw] entities
|
219
|
+
# A JSON set of elements including the `awsAccountId` and its
|
220
|
+
# `entityArn`, `entityValue` and its `entityArn`, `lastUpdatedTime`,
|
221
|
+
# `statusCode`, and `tags`.
|
222
|
+
# @return [Array<Types::AffectedEntity>]
|
223
|
+
#
|
224
|
+
# @!attribute [rw] failed_set
|
225
|
+
# A JSON set of elements of the failed response, including the
|
226
|
+
# `awsAccountId`, `errorMessage`, `errorName`, and `eventArn`.
|
227
|
+
# @return [Array<Types::OrganizationAffectedEntitiesErrorItem>]
|
228
|
+
#
|
229
|
+
# @!attribute [rw] next_token
|
230
|
+
# If the results of a search are large, only a portion of the results
|
231
|
+
# are returned, and a `nextToken` pagination token is returned in the
|
232
|
+
# response. To retrieve the next batch of results, reissue the search
|
233
|
+
# request and include the returned token. When all results have been
|
234
|
+
# returned, the response does not contain a pagination token value.
|
235
|
+
# @return [String]
|
236
|
+
#
|
237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedEntitiesForOrganizationResponse AWS API Documentation
|
238
|
+
#
|
239
|
+
class DescribeAffectedEntitiesForOrganizationResponse < Struct.new(
|
240
|
+
:entities,
|
241
|
+
:failed_set,
|
242
|
+
:next_token)
|
243
|
+
include Aws::Structure
|
244
|
+
end
|
245
|
+
|
97
246
|
# @note When making an API call, you may pass DescribeAffectedEntitiesRequest
|
98
247
|
# data as a hash:
|
99
248
|
#
|
@@ -300,6 +449,53 @@ module Aws::Health
|
|
300
449
|
include Aws::Structure
|
301
450
|
end
|
302
451
|
|
452
|
+
# @note When making an API call, you may pass DescribeEventDetailsForOrganizationRequest
|
453
|
+
# data as a hash:
|
454
|
+
#
|
455
|
+
# {
|
456
|
+
# organization_event_detail_filters: [ # required
|
457
|
+
# {
|
458
|
+
# event_arn: "eventArn", # required
|
459
|
+
# aws_account_id: "accountId", # required
|
460
|
+
# },
|
461
|
+
# ],
|
462
|
+
# locale: "locale",
|
463
|
+
# }
|
464
|
+
#
|
465
|
+
# @!attribute [rw] organization_event_detail_filters
|
466
|
+
# A set of JSON elements that includes the `awsAccountId` and the
|
467
|
+
# `eventArn`.
|
468
|
+
# @return [Array<Types::EventAccountFilter>]
|
469
|
+
#
|
470
|
+
# @!attribute [rw] locale
|
471
|
+
# The locale (language) to return information in. English (en) is the
|
472
|
+
# default and the only supported value at this time.
|
473
|
+
# @return [String]
|
474
|
+
#
|
475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventDetailsForOrganizationRequest AWS API Documentation
|
476
|
+
#
|
477
|
+
class DescribeEventDetailsForOrganizationRequest < Struct.new(
|
478
|
+
:organization_event_detail_filters,
|
479
|
+
:locale)
|
480
|
+
include Aws::Structure
|
481
|
+
end
|
482
|
+
|
483
|
+
# @!attribute [rw] successful_set
|
484
|
+
# Information about the events that could be retrieved.
|
485
|
+
# @return [Array<Types::OrganizationEventDetails>]
|
486
|
+
#
|
487
|
+
# @!attribute [rw] failed_set
|
488
|
+
# Error messages for any events that could not be retrieved.
|
489
|
+
# @return [Array<Types::OrganizationEventDetailsErrorItem>]
|
490
|
+
#
|
491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventDetailsForOrganizationResponse AWS API Documentation
|
492
|
+
#
|
493
|
+
class DescribeEventDetailsForOrganizationResponse < Struct.new(
|
494
|
+
:successful_set,
|
495
|
+
:failed_set)
|
496
|
+
include Aws::Structure
|
497
|
+
end
|
498
|
+
|
303
499
|
# @note When making an API call, you may pass DescribeEventDetailsRequest
|
304
500
|
# data as a hash:
|
305
501
|
#
|
@@ -414,6 +610,89 @@ module Aws::Health
|
|
414
610
|
include Aws::Structure
|
415
611
|
end
|
416
612
|
|
613
|
+
# @note When making an API call, you may pass DescribeEventsForOrganizationRequest
|
614
|
+
# data as a hash:
|
615
|
+
#
|
616
|
+
# {
|
617
|
+
# filter: {
|
618
|
+
# event_type_codes: ["eventType"],
|
619
|
+
# aws_account_ids: ["accountId"],
|
620
|
+
# services: ["service"],
|
621
|
+
# regions: ["region"],
|
622
|
+
# start_time: {
|
623
|
+
# from: Time.now,
|
624
|
+
# to: Time.now,
|
625
|
+
# },
|
626
|
+
# end_time: {
|
627
|
+
# from: Time.now,
|
628
|
+
# to: Time.now,
|
629
|
+
# },
|
630
|
+
# last_updated_time: {
|
631
|
+
# from: Time.now,
|
632
|
+
# to: Time.now,
|
633
|
+
# },
|
634
|
+
# entity_arns: ["entityArn"],
|
635
|
+
# entity_values: ["entityValue"],
|
636
|
+
# event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange, investigation
|
637
|
+
# event_status_codes: ["open"], # accepts open, closed, upcoming
|
638
|
+
# },
|
639
|
+
# next_token: "nextToken",
|
640
|
+
# max_results: 1,
|
641
|
+
# locale: "locale",
|
642
|
+
# }
|
643
|
+
#
|
644
|
+
# @!attribute [rw] filter
|
645
|
+
# Values to narrow the results returned.
|
646
|
+
# @return [Types::OrganizationEventFilter]
|
647
|
+
#
|
648
|
+
# @!attribute [rw] next_token
|
649
|
+
# If the results of a search are large, only a portion of the results
|
650
|
+
# are returned, and a `nextToken` pagination token is returned in the
|
651
|
+
# response. To retrieve the next batch of results, reissue the search
|
652
|
+
# request and include the returned token. When all results have been
|
653
|
+
# returned, the response does not contain a pagination token value.
|
654
|
+
# @return [String]
|
655
|
+
#
|
656
|
+
# @!attribute [rw] max_results
|
657
|
+
# The maximum number of items to return in one batch, between 10 and
|
658
|
+
# 100, inclusive.
|
659
|
+
# @return [Integer]
|
660
|
+
#
|
661
|
+
# @!attribute [rw] locale
|
662
|
+
# The locale (language) to return information in. English (en) is the
|
663
|
+
# default and the only supported value at this time.
|
664
|
+
# @return [String]
|
665
|
+
#
|
666
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventsForOrganizationRequest AWS API Documentation
|
667
|
+
#
|
668
|
+
class DescribeEventsForOrganizationRequest < Struct.new(
|
669
|
+
:filter,
|
670
|
+
:next_token,
|
671
|
+
:max_results,
|
672
|
+
:locale)
|
673
|
+
include Aws::Structure
|
674
|
+
end
|
675
|
+
|
676
|
+
# @!attribute [rw] events
|
677
|
+
# The events that match the specified filter criteria.
|
678
|
+
# @return [Array<Types::OrganizationEvent>]
|
679
|
+
#
|
680
|
+
# @!attribute [rw] next_token
|
681
|
+
# If the results of a search are large, only a portion of the results
|
682
|
+
# are returned, and a `nextToken` pagination token is returned in the
|
683
|
+
# response. To retrieve the next batch of results, reissue the search
|
684
|
+
# request and include the returned token. When all results have been
|
685
|
+
# returned, the response does not contain a pagination token value.
|
686
|
+
# @return [String]
|
687
|
+
#
|
688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEventsForOrganizationResponse AWS API Documentation
|
689
|
+
#
|
690
|
+
class DescribeEventsForOrganizationResponse < Struct.new(
|
691
|
+
:events,
|
692
|
+
:next_token)
|
693
|
+
include Aws::Structure
|
694
|
+
end
|
695
|
+
|
417
696
|
# @note When making an API call, you may pass DescribeEventsRequest
|
418
697
|
# data as a hash:
|
419
698
|
#
|
@@ -509,6 +788,20 @@ module Aws::Health
|
|
509
788
|
include Aws::Structure
|
510
789
|
end
|
511
790
|
|
791
|
+
# @!attribute [rw] health_service_access_status_for_organization
|
792
|
+
# Information about the status of enabling or disabling AWS Health
|
793
|
+
# Organizational View in your organization.
|
794
|
+
#
|
795
|
+
# Valid values are `ENABLED | DISABLED | PENDING`.
|
796
|
+
# @return [String]
|
797
|
+
#
|
798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeHealthServiceStatusForOrganizationResponse AWS API Documentation
|
799
|
+
#
|
800
|
+
class DescribeHealthServiceStatusForOrganizationResponse < Struct.new(
|
801
|
+
:health_service_access_status_for_organization)
|
802
|
+
include Aws::Structure
|
803
|
+
end
|
804
|
+
|
512
805
|
# The number of entities that are affected by one or more events.
|
513
806
|
# Returned by the DescribeEntityAggregates operation.
|
514
807
|
#
|
@@ -596,10 +889,7 @@ module Aws::Health
|
|
596
889
|
include Aws::Structure
|
597
890
|
end
|
598
891
|
|
599
|
-
# Summary information about an
|
600
|
-
# operation. The DescribeEventDetails operation also returns this
|
601
|
-
# information, as well as the EventDescription and additional event
|
602
|
-
# metadata.
|
892
|
+
# Summary information about an AWS Health event.
|
603
893
|
#
|
604
894
|
# @!attribute [rw] arn
|
605
895
|
# The unique identifier for the event. Format:
|
@@ -665,6 +955,38 @@ module Aws::Health
|
|
665
955
|
include Aws::Structure
|
666
956
|
end
|
667
957
|
|
958
|
+
# The values used to filter results from the
|
959
|
+
# DescribeEventDetailsForOrganization and
|
960
|
+
# DescribeAffectedEntitiesForOrganization operations.
|
961
|
+
#
|
962
|
+
# @note When making an API call, you may pass EventAccountFilter
|
963
|
+
# data as a hash:
|
964
|
+
#
|
965
|
+
# {
|
966
|
+
# event_arn: "eventArn", # required
|
967
|
+
# aws_account_id: "accountId", # required
|
968
|
+
# }
|
969
|
+
#
|
970
|
+
# @!attribute [rw] event_arn
|
971
|
+
# The unique identifier for the event. Format:
|
972
|
+
# `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
|
973
|
+
# `. Example: `Example:
|
974
|
+
# arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
|
975
|
+
# @return [String]
|
976
|
+
#
|
977
|
+
# @!attribute [rw] aws_account_id
|
978
|
+
# The 12-digit AWS account numbers that contains the affected
|
979
|
+
# entities.
|
980
|
+
# @return [String]
|
981
|
+
#
|
982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EventAccountFilter AWS API Documentation
|
983
|
+
#
|
984
|
+
class EventAccountFilter < Struct.new(
|
985
|
+
:event_arn,
|
986
|
+
:aws_account_id)
|
987
|
+
include Aws::Structure
|
988
|
+
end
|
989
|
+
|
668
990
|
# The number of events of each issue type. Returned by the
|
669
991
|
# DescribeEventAggregates operation.
|
670
992
|
#
|
@@ -799,7 +1121,7 @@ module Aws::Health
|
|
799
1121
|
#
|
800
1122
|
# @!attribute [rw] event_type_codes
|
801
1123
|
# A list of unique identifiers for event types. For example,
|
802
|
-
# `"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED"
|
1124
|
+
# `"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".`
|
803
1125
|
# @return [Array<String>]
|
804
1126
|
#
|
805
1127
|
# @!attribute [rw] services
|
@@ -945,6 +1267,281 @@ module Aws::Health
|
|
945
1267
|
include Aws::Structure
|
946
1268
|
end
|
947
1269
|
|
1270
|
+
# Error information returned when a
|
1271
|
+
# DescribeAffectedEntitiesForOrganization operation cannot find or
|
1272
|
+
# process a specific entity.
|
1273
|
+
#
|
1274
|
+
# @!attribute [rw] aws_account_id
|
1275
|
+
# The 12-digit AWS account numbers that contains the affected
|
1276
|
+
# entities.
|
1277
|
+
# @return [String]
|
1278
|
+
#
|
1279
|
+
# @!attribute [rw] event_arn
|
1280
|
+
# The unique identifier for the event. Format:
|
1281
|
+
# `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
|
1282
|
+
# `. Example: `Example:
|
1283
|
+
# arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
|
1284
|
+
# @return [String]
|
1285
|
+
#
|
1286
|
+
# @!attribute [rw] error_name
|
1287
|
+
# The name of the error.
|
1288
|
+
# @return [String]
|
1289
|
+
#
|
1290
|
+
# @!attribute [rw] error_message
|
1291
|
+
# The unique identifier for the event type. The format is
|
1292
|
+
# `AWS_SERVICE_DESCRIPTION`. For example,
|
1293
|
+
# `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`.
|
1294
|
+
# @return [String]
|
1295
|
+
#
|
1296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/OrganizationAffectedEntitiesErrorItem AWS API Documentation
|
1297
|
+
#
|
1298
|
+
class OrganizationAffectedEntitiesErrorItem < Struct.new(
|
1299
|
+
:aws_account_id,
|
1300
|
+
:event_arn,
|
1301
|
+
:error_name,
|
1302
|
+
:error_message)
|
1303
|
+
include Aws::Structure
|
1304
|
+
end
|
1305
|
+
|
1306
|
+
# Summary information about an event, returned by the
|
1307
|
+
# DescribeEventsForOrganization operation.
|
1308
|
+
#
|
1309
|
+
# @!attribute [rw] arn
|
1310
|
+
# The unique identifier for the event. Format:
|
1311
|
+
# `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
|
1312
|
+
# `. Example: `Example:
|
1313
|
+
# arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
|
1314
|
+
# @return [String]
|
1315
|
+
#
|
1316
|
+
# @!attribute [rw] service
|
1317
|
+
# The AWS service that is affected by the event. For example, EC2,
|
1318
|
+
# RDS.
|
1319
|
+
# @return [String]
|
1320
|
+
#
|
1321
|
+
# @!attribute [rw] event_type_code
|
1322
|
+
# The unique identifier for the event type. The format is
|
1323
|
+
# `AWS_SERVICE_DESCRIPTION`. For example,
|
1324
|
+
# `AWS_EC2_SYSTEM_MAINTENANCE_EVENT`.
|
1325
|
+
# @return [String]
|
1326
|
+
#
|
1327
|
+
# @!attribute [rw] event_type_category
|
1328
|
+
# The category of the event type.
|
1329
|
+
# @return [String]
|
1330
|
+
#
|
1331
|
+
# @!attribute [rw] region
|
1332
|
+
# The AWS Region name of the event.
|
1333
|
+
# @return [String]
|
1334
|
+
#
|
1335
|
+
# @!attribute [rw] start_time
|
1336
|
+
# The date and time that the event began.
|
1337
|
+
# @return [Time]
|
1338
|
+
#
|
1339
|
+
# @!attribute [rw] end_time
|
1340
|
+
# The date and time that the event ended.
|
1341
|
+
# @return [Time]
|
1342
|
+
#
|
1343
|
+
# @!attribute [rw] last_updated_time
|
1344
|
+
# The most recent date and time that the event was updated.
|
1345
|
+
# @return [Time]
|
1346
|
+
#
|
1347
|
+
# @!attribute [rw] status_code
|
1348
|
+
# The most recent status of the event. Possible values are `open`,
|
1349
|
+
# `closed`, and `upcoming`.
|
1350
|
+
# @return [String]
|
1351
|
+
#
|
1352
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/OrganizationEvent AWS API Documentation
|
1353
|
+
#
|
1354
|
+
class OrganizationEvent < Struct.new(
|
1355
|
+
:arn,
|
1356
|
+
:service,
|
1357
|
+
:event_type_code,
|
1358
|
+
:event_type_category,
|
1359
|
+
:region,
|
1360
|
+
:start_time,
|
1361
|
+
:end_time,
|
1362
|
+
:last_updated_time,
|
1363
|
+
:status_code)
|
1364
|
+
include Aws::Structure
|
1365
|
+
end
|
1366
|
+
|
1367
|
+
# Detailed information about an event. A combination of an Event object,
|
1368
|
+
# an EventDescription object, and additional metadata about the event.
|
1369
|
+
# Returned by the DescribeEventDetailsForOrganization operation.
|
1370
|
+
#
|
1371
|
+
# @!attribute [rw] aws_account_id
|
1372
|
+
# The 12-digit AWS account numbers that contains the affected
|
1373
|
+
# entities.
|
1374
|
+
# @return [String]
|
1375
|
+
#
|
1376
|
+
# @!attribute [rw] event
|
1377
|
+
# Summary information about an AWS Health event.
|
1378
|
+
# @return [Types::Event]
|
1379
|
+
#
|
1380
|
+
# @!attribute [rw] event_description
|
1381
|
+
# The detailed description of the event. Included in the information
|
1382
|
+
# returned by the DescribeEventDetails operation.
|
1383
|
+
# @return [Types::EventDescription]
|
1384
|
+
#
|
1385
|
+
# @!attribute [rw] event_metadata
|
1386
|
+
# Additional metadata about the event.
|
1387
|
+
# @return [Hash<String,String>]
|
1388
|
+
#
|
1389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/OrganizationEventDetails AWS API Documentation
|
1390
|
+
#
|
1391
|
+
class OrganizationEventDetails < Struct.new(
|
1392
|
+
:aws_account_id,
|
1393
|
+
:event,
|
1394
|
+
:event_description,
|
1395
|
+
:event_metadata)
|
1396
|
+
include Aws::Structure
|
1397
|
+
end
|
1398
|
+
|
1399
|
+
# Error information returned when a DescribeEventDetailsForOrganization
|
1400
|
+
# operation cannot find a specified event.
|
1401
|
+
#
|
1402
|
+
# @!attribute [rw] aws_account_id
|
1403
|
+
# Error information returned when a
|
1404
|
+
# DescribeEventDetailsForOrganization operation cannot find a
|
1405
|
+
# specified event.
|
1406
|
+
# @return [String]
|
1407
|
+
#
|
1408
|
+
# @!attribute [rw] event_arn
|
1409
|
+
# The unique identifier for the event. Format:
|
1410
|
+
# `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
|
1411
|
+
# `. Example: `Example:
|
1412
|
+
# arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456`
|
1413
|
+
# @return [String]
|
1414
|
+
#
|
1415
|
+
# @!attribute [rw] error_name
|
1416
|
+
# The name of the error.
|
1417
|
+
# @return [String]
|
1418
|
+
#
|
1419
|
+
# @!attribute [rw] error_message
|
1420
|
+
# A message that describes the error.
|
1421
|
+
# @return [String]
|
1422
|
+
#
|
1423
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/OrganizationEventDetailsErrorItem AWS API Documentation
|
1424
|
+
#
|
1425
|
+
class OrganizationEventDetailsErrorItem < Struct.new(
|
1426
|
+
:aws_account_id,
|
1427
|
+
:event_arn,
|
1428
|
+
:error_name,
|
1429
|
+
:error_message)
|
1430
|
+
include Aws::Structure
|
1431
|
+
end
|
1432
|
+
|
1433
|
+
# The values to filter results from the DescribeEventsForOrganization
|
1434
|
+
# operation.
|
1435
|
+
#
|
1436
|
+
# @note When making an API call, you may pass OrganizationEventFilter
|
1437
|
+
# data as a hash:
|
1438
|
+
#
|
1439
|
+
# {
|
1440
|
+
# event_type_codes: ["eventType"],
|
1441
|
+
# aws_account_ids: ["accountId"],
|
1442
|
+
# services: ["service"],
|
1443
|
+
# regions: ["region"],
|
1444
|
+
# start_time: {
|
1445
|
+
# from: Time.now,
|
1446
|
+
# to: Time.now,
|
1447
|
+
# },
|
1448
|
+
# end_time: {
|
1449
|
+
# from: Time.now,
|
1450
|
+
# to: Time.now,
|
1451
|
+
# },
|
1452
|
+
# last_updated_time: {
|
1453
|
+
# from: Time.now,
|
1454
|
+
# to: Time.now,
|
1455
|
+
# },
|
1456
|
+
# entity_arns: ["entityArn"],
|
1457
|
+
# entity_values: ["entityValue"],
|
1458
|
+
# event_type_categories: ["issue"], # accepts issue, accountNotification, scheduledChange, investigation
|
1459
|
+
# event_status_codes: ["open"], # accepts open, closed, upcoming
|
1460
|
+
# }
|
1461
|
+
#
|
1462
|
+
# @!attribute [rw] event_type_codes
|
1463
|
+
# A list of unique identifiers for event types. For example,
|
1464
|
+
# `"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".`
|
1465
|
+
# @return [Array<String>]
|
1466
|
+
#
|
1467
|
+
# @!attribute [rw] aws_account_ids
|
1468
|
+
# A list of 12-digit AWS account numbers that contains the affected
|
1469
|
+
# entities.
|
1470
|
+
# @return [Array<String>]
|
1471
|
+
#
|
1472
|
+
# @!attribute [rw] services
|
1473
|
+
# The AWS services associated with the event. For example, `EC2`,
|
1474
|
+
# `RDS`.
|
1475
|
+
# @return [Array<String>]
|
1476
|
+
#
|
1477
|
+
# @!attribute [rw] regions
|
1478
|
+
# A list of AWS Regions.
|
1479
|
+
# @return [Array<String>]
|
1480
|
+
#
|
1481
|
+
# @!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 items
|
1484
|
+
# where the timestamp (`startTime`, `endTime`, or `lastUpdatedTime`)
|
1485
|
+
# is between `from` and `to` inclusive. If `from` is set and `to` is
|
1486
|
+
# not set: match items where the timestamp value is equal to or after
|
1487
|
+
# `from`. If `from` is not set and `to` is set: match items where the
|
1488
|
+
# timestamp value is equal to or before `to`.
|
1489
|
+
# @return [Types::DateTimeRange]
|
1490
|
+
#
|
1491
|
+
# @!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 items
|
1494
|
+
# where the timestamp (`startTime`, `endTime`, or `lastUpdatedTime`)
|
1495
|
+
# is between `from` and `to` inclusive. If `from` is set and `to` is
|
1496
|
+
# not set: match items where the timestamp value is equal to or after
|
1497
|
+
# `from`. If `from` is not set and `to` is set: match items where the
|
1498
|
+
# timestamp value is equal to or before `to`.
|
1499
|
+
# @return [Types::DateTimeRange]
|
1500
|
+
#
|
1501
|
+
# @!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 items
|
1504
|
+
# where the timestamp (`startTime`, `endTime`, or `lastUpdatedTime`)
|
1505
|
+
# is between `from` and `to` inclusive. If `from` is set and `to` is
|
1506
|
+
# not set: match items where the timestamp value is equal to or after
|
1507
|
+
# `from`. If `from` is not set and `to` is set: match items where the
|
1508
|
+
# timestamp value is equal to or before `to`.
|
1509
|
+
# @return [Types::DateTimeRange]
|
1510
|
+
#
|
1511
|
+
# @!attribute [rw] entity_arns
|
1512
|
+
# REPLACEME
|
1513
|
+
# @return [Array<String>]
|
1514
|
+
#
|
1515
|
+
# @!attribute [rw] entity_values
|
1516
|
+
# A list of entity identifiers, such as EC2 instance IDs (i-34ab692e)
|
1517
|
+
# or EBS volumes (vol-426ab23e).
|
1518
|
+
# @return [Array<String>]
|
1519
|
+
#
|
1520
|
+
# @!attribute [rw] event_type_categories
|
1521
|
+
# REPLACEME
|
1522
|
+
# @return [Array<String>]
|
1523
|
+
#
|
1524
|
+
# @!attribute [rw] event_status_codes
|
1525
|
+
# A list of event status codes.
|
1526
|
+
# @return [Array<String>]
|
1527
|
+
#
|
1528
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/OrganizationEventFilter AWS API Documentation
|
1529
|
+
#
|
1530
|
+
class OrganizationEventFilter < Struct.new(
|
1531
|
+
:event_type_codes,
|
1532
|
+
:aws_account_ids,
|
1533
|
+
:services,
|
1534
|
+
:regions,
|
1535
|
+
:start_time,
|
1536
|
+
:end_time,
|
1537
|
+
:last_updated_time,
|
1538
|
+
:entity_arns,
|
1539
|
+
:entity_values,
|
1540
|
+
:event_type_categories,
|
1541
|
+
:event_status_codes)
|
1542
|
+
include Aws::Structure
|
1543
|
+
end
|
1544
|
+
|
948
1545
|
# The specified locale is not supported.
|
949
1546
|
#
|
950
1547
|
# @!attribute [rw] message
|