aws-sdk-health 1.27.0 → 1.28.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3bc8ae00dea99726d0d4eb8ddabdc9f76ddd8dab1dc8d84e618de5a10465b455
4
- data.tar.gz: f41bdd80e970f08668bcb3f7138997e6c3b6f05a191e98681ff39eb521406c5c
3
+ metadata.gz: 1d471d435fbec6b47f325f65c663d948c34ce267b6a002245f4d4e68af2a7e9f
4
+ data.tar.gz: 4a9fc5891f2c3bcbb9461a3c8e1f973972daa06e94e3e24b3a9fb0886d4be111
5
5
  SHA512:
6
- metadata.gz: 598c5d90ef9fb86c907d64e08d99a8cbdbc2749d6f66a5f05c032f12efc6c68739e57ac8744995bedf59916062d05e6b81d3939302f1bd4f9af3482b750fba6f
7
- data.tar.gz: b49cb72b5b8a3af3cfaef4ba2a87e46b0db6eb7272238912e2daabf5923040c9c9f40c98a8b3835ab47b5d60da033af2979aa41a0869093b0f109bdd3cb7bf41
6
+ metadata.gz: cd1fafd95f921c88370f8b3d1613f088b6d8152cc757ed2f2213a55adffc0464b63afc9f4acb64c72393b78d2484c14ee591c79a6df4dd4d45c40a05d80e1c8f
7
+ data.tar.gz: 7f8fc7b1e4aa458244aed80e5e25db1b79724da712fc4d59cf5093e68df5eb46698c104f36dff441b0232e3ff9ca04cf74f30f92daecc163897992baffac0776
@@ -47,6 +47,6 @@ require_relative 'aws-sdk-health/customizations'
47
47
  # @service
48
48
  module Aws::Health
49
49
 
50
- GEM_VERSION = '1.27.0'
50
+ GEM_VERSION = '1.28.0'
51
51
 
52
52
  end
@@ -323,13 +323,24 @@ module Aws::Health
323
323
  # @!group API Operations
324
324
 
325
325
  # Returns a list of accounts in the organization from AWS Organizations
326
- # that are affected by the provided event.
326
+ # that are affected by the provided event. For more information about
327
+ # the different types of AWS Health events, see [Event][1].
327
328
  #
328
329
  # Before you can call this operation, you must first enable AWS Health
329
330
  # to work with AWS Organizations. To do this, call the
330
- # EnableHealthServiceAccessForOrganization operation from your
331
+ # [EnableHealthServiceAccessForOrganization][2] operation from your
331
332
  # organization's master account.
332
333
  #
334
+ # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
335
+ # in the next request to return more results.
336
+ #
337
+ # </note>
338
+ #
339
+ #
340
+ #
341
+ # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html
342
+ # [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html
343
+ #
333
344
  # @option params [required, String] :event_arn
334
345
  # The unique identifier for the event. Format:
335
346
  # `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
@@ -389,6 +400,11 @@ module Aws::Health
389
400
  # At least one event ARN is required. Results are sorted by the
390
401
  # `lastUpdatedTime` of the entity, starting with the most recent.
391
402
  #
403
+ # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
404
+ # in the next request to return more results.
405
+ #
406
+ # </note>
407
+ #
392
408
  # @option params [required, Types::EntityFilter] :filter
393
409
  # Values to narrow the results returned. At least one event ARN is
394
410
  # required.
@@ -469,14 +485,24 @@ module Aws::Health
469
485
  # individual customer resources, groups of customer resources, or any
470
486
  # other construct, depending on the AWS service.
471
487
  #
472
- # At least one event ARN and account ID are required. Results are sorted
473
- # by the `lastUpdatedTime` of the entity, starting with the most recent.
488
+ # At least one event Amazon Resource Name (ARN) and account ID are
489
+ # required. Results are sorted by the `lastUpdatedTime` of the entity,
490
+ # starting with the most recent.
474
491
  #
475
492
  # Before you can call this operation, you must first enable AWS Health
476
493
  # to work with AWS Organizations. To do this, call the
477
- # EnableHealthServiceAccessForOrganization operation from your
494
+ # [EnableHealthServiceAccessForOrganization][1] operation from your
478
495
  # organization's master account.
479
496
  #
497
+ # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
498
+ # in the next request to return more results.
499
+ #
500
+ # </note>
501
+ #
502
+ #
503
+ #
504
+ # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html
505
+ #
480
506
  # @option params [required, Array<Types::EventAccountFilter>] :organization_entity_filters
481
507
  # A JSON set of elements including the `awsAccountId` and the
482
508
  # `eventArn`.
@@ -584,6 +610,11 @@ module Aws::Health
584
610
  # change, and account notification). If no filter is specified, the
585
611
  # counts of all events in each category are returned.
586
612
  #
613
+ # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
614
+ # in the next request to return more results.
615
+ #
616
+ # </note>
617
+ #
587
618
  # @option params [Types::EventFilter] :filter
588
619
  # Values to narrow the results returned.
589
620
  #
@@ -667,15 +698,20 @@ module Aws::Health
667
698
  end
668
699
 
669
700
  # Returns detailed information about one or more specified events.
670
- # Information includes standard event data (region, service, and so on,
671
- # as returned by DescribeEvents), a detailed event description, and
701
+ # Information includes standard event data (Region, service, and so on,
702
+ # as returned by [DescribeEvents][1]), a detailed event description, and
672
703
  # possible additional metadata that depends upon the nature of the
673
- # event. Affected entities are not included; to retrieve those, use the
674
- # DescribeAffectedEntities operation.
704
+ # event. Affected entities are not included. To retrieve those, use the
705
+ # [DescribeAffectedEntities][2] operation.
675
706
  #
676
707
  # If a specified event cannot be retrieved, an error message is returned
677
708
  # for that event.
678
709
  #
710
+ #
711
+ #
712
+ # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html
713
+ # [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html
714
+ #
679
715
  # @option params [required, Array<String>] :event_arns
680
716
  # A list of event ARNs (unique identifiers). For example:
681
717
  # `"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456",
@@ -731,16 +767,40 @@ module Aws::Health
731
767
  # Returns detailed information about one or more specified events for
732
768
  # one or more accounts in your organization. Information includes
733
769
  # standard event data (Region, service, and so on, as returned by
734
- # DescribeEventsForOrganization, a detailed event description, and
770
+ # [DescribeEventsForOrganization][1]), a detailed event description, and
735
771
  # possible additional metadata that depends upon the nature of the
736
772
  # event. Affected entities are not included; to retrieve those, use the
737
- # DescribeAffectedEntitiesForOrganization operation.
773
+ # [DescribeAffectedEntitiesForOrganization][2] operation.
738
774
  #
739
775
  # Before you can call this operation, you must first enable AWS Health
740
776
  # to work with AWS Organizations. To do this, call the
741
- # EnableHealthServiceAccessForOrganization operation from your
777
+ # [EnableHealthServiceAccessForOrganization][3] operation from your
742
778
  # organization's master account.
743
779
  #
780
+ # When you call the `DescribeEventDetailsForOrganization` operation, you
781
+ # specify the `organizationEventDetailFilters` object in the request.
782
+ # Depending on the AWS Health event type, note the following
783
+ # differences:
784
+ #
785
+ # * If the event is public, the `awsAccountId` parameter must be empty.
786
+ # If you specify an account ID for a public event, then an error
787
+ # message is returned. That's because the event might apply to all
788
+ # AWS accounts and isn't specific to an account in your organization.
789
+ #
790
+ # * If the event is specific to an account, then you must specify the
791
+ # `awsAccountId` parameter in the request. If you don't specify an
792
+ # account ID, an error message returns because the event is specific
793
+ # to an AWS account in your organization.
794
+ #
795
+ # For more information, see [Event][4].
796
+ #
797
+ #
798
+ #
799
+ # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html
800
+ # [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html
801
+ # [3]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html
802
+ # [4]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html
803
+ #
744
804
  # @option params [required, Array<Types::EventAccountFilter>] :organization_event_detail_filters
745
805
  # A set of JSON elements that includes the `awsAccountId` and the
746
806
  # `eventArn`.
@@ -803,6 +863,11 @@ module Aws::Health
803
863
  # filter criteria are specified, all event types are returned, in no
804
864
  # particular order.
805
865
  #
866
+ # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
867
+ # in the next request to return more results.
868
+ #
869
+ # </note>
870
+ #
806
871
  # @option params [Types::EventTypeFilter] :filter
807
872
  # Values to narrow the results returned.
808
873
  #
@@ -862,10 +927,31 @@ module Aws::Health
862
927
  # criteria. Events are returned in a summary form and do not include the
863
928
  # detailed description, any additional metadata that depends on the
864
929
  # event type, or any affected resources. To retrieve that information,
865
- # use the DescribeEventDetails and DescribeAffectedEntities operations.
930
+ # use the [DescribeEventDetails][1] and [DescribeAffectedEntities][2]
931
+ # operations.
866
932
  #
867
933
  # If no filter criteria are specified, all events are returned. Results
868
- # are sorted by `lastModifiedTime`, starting with the most recent.
934
+ # are sorted by `lastModifiedTime`, starting with the most recent event.
935
+ #
936
+ # <note markdown="1"> * When you call the `DescribeEvents` operation and specify an entity
937
+ # for the `entityValues` parameter, AWS Health might return public
938
+ # events that aren't specific to that resource. For example, if you
939
+ # call `DescribeEvents` and specify an ID for an Amazon Elastic
940
+ # Compute Cloud (Amazon EC2) instance, AWS Health might return events
941
+ # that aren't specific to that resource or service. To get events
942
+ # that are specific to a service, use the `services` parameter in the
943
+ # `filter` object. For more information, see [Event][3].
944
+ #
945
+ # * This API operation uses pagination. Specify the `nextToken`
946
+ # parameter in the next request to return more results.
947
+ #
948
+ # </note>
949
+ #
950
+ #
951
+ #
952
+ # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html
953
+ # [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html
954
+ # [3]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html
869
955
  #
870
956
  # @option params [Types::EventFilter] :filter
871
957
  # Values to narrow the results returned.
@@ -960,22 +1046,42 @@ module Aws::Health
960
1046
  end
961
1047
 
962
1048
  # Returns information about events across your organization in AWS
963
- # Organizations, meeting the specified filter criteria. Events are
964
- # returned in a summary form and do not include the accounts impacted,
965
- # detailed description, any additional metadata that depends on the
966
- # event type, or any affected resources. To retrieve that information,
967
- # use the DescribeAffectedAccountsForOrganization,
968
- # DescribeEventDetailsForOrganization, and
969
- # DescribeAffectedEntitiesForOrganization operations.
1049
+ # Organizations. You can use the`filters` parameter to specify the
1050
+ # events that you want to return. Events are returned in a summary form
1051
+ # and don't include the affected accounts, detailed description, any
1052
+ # additional metadata that depends on the event type, or any affected
1053
+ # resources. To retrieve that information, use the following operations:
970
1054
  #
971
- # If no filter criteria are specified, all events across your
972
- # organization are returned. Results are sorted by `lastModifiedTime`,
973
- # starting with the most recent.
1055
+ # * [DescribeAffectedAccountsForOrganization][1]
974
1056
  #
975
- # Before you can call this operation, you must first enable Health to
976
- # work with AWS Organizations. To do this, call the
977
- # EnableHealthServiceAccessForOrganization operation from your
978
- # organization's master account.
1057
+ # * [DescribeEventDetailsForOrganization][2]
1058
+ #
1059
+ # * [DescribeAffectedEntitiesForOrganization][3]
1060
+ #
1061
+ # If you don't specify a `filter`, the `DescribeEventsForOrganizations`
1062
+ # returns all events across your organization. Results are sorted by
1063
+ # `lastModifiedTime`, starting with the most recent event.
1064
+ #
1065
+ # For more information about the different types of AWS Health events,
1066
+ # see [Event][4].
1067
+ #
1068
+ # Before you can call this operation, you must first enable AWS Health
1069
+ # to work with AWS Organizations. To do this, call the
1070
+ # [EnableHealthServiceAccessForOrganization][5] operation from your
1071
+ # organization's master AWS account.
1072
+ #
1073
+ # <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
1074
+ # in the next request to return more results.
1075
+ #
1076
+ # </note>
1077
+ #
1078
+ #
1079
+ #
1080
+ # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedAccountsForOrganization.html
1081
+ # [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html
1082
+ # [3]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html
1083
+ # [4]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html
1084
+ # [5]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html
979
1085
  #
980
1086
  # @option params [Types::OrganizationEventFilter] :filter
981
1087
  # Values to narrow the results returned.
@@ -1078,12 +1184,33 @@ module Aws::Health
1078
1184
  req.send_request(options)
1079
1185
  end
1080
1186
 
1081
- # Calling this operation disables Health from working with AWS
1082
- # Organizations. This does not remove the Service Linked Role (SLR) from
1083
- # the the master account in your organization. Use the IAM console, API,
1084
- # or AWS CLI to remove the SLR if desired. To call this operation, you
1085
- # must sign in as an IAM user, assume an IAM role, or sign in as the
1086
- # root user (not recommended) in the organization's master account.
1187
+ # Disables AWS Health from working with AWS Organizations. To call this
1188
+ # operation, you must sign in as an AWS Identity and Access Management
1189
+ # (IAM) user, assume an IAM role, or sign in as the root user (not
1190
+ # recommended) in the organization's master AWS account. For more
1191
+ # information, see [Aggregating AWS Health events][1] in the *AWS Health
1192
+ # User Guide*.
1193
+ #
1194
+ # This operation doesn't remove the service-linked role (SLR) from the
1195
+ # AWS master account in your organization. You must use the IAM console,
1196
+ # API, or AWS Command Line Interface (AWS CLI) to remove the SLR. For
1197
+ # more information, see [Deleting a Service-Linked Role][2] in the *IAM
1198
+ # User Guide*.
1199
+ #
1200
+ # <note markdown="1"> You can also disable the organizational feature by using the
1201
+ # Organizations [DisableAWSServiceAccess][3] API operation. After you
1202
+ # call this operation, AWS Health stops aggregating events for all other
1203
+ # AWS accounts in your organization. If you call the AWS Health API
1204
+ # operations for organizational view, AWS Health returns an error. AWS
1205
+ # Health continues to aggregate health events for your AWS account.
1206
+ #
1207
+ # </note>
1208
+ #
1209
+ #
1210
+ #
1211
+ # [1]: https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html
1212
+ # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role
1213
+ # [3]: https://docs.aws.amazon.com/organizations/latest/APIReference/API_DisableAWSServiceAccess.html
1087
1214
  #
1088
1215
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1089
1216
  #
@@ -1097,13 +1224,18 @@ module Aws::Health
1097
1224
  end
1098
1225
 
1099
1226
  # Calling this operation enables AWS Health to work with AWS
1100
- # Organizations. This applies a Service Linked Role (SLR) to the master
1101
- # account in the organization. To learn more about the steps in this
1102
- # process, visit enabling service access for AWS Health in AWS
1103
- # Organizations. To call this operation, you must sign in as an IAM
1104
- # user, assume an IAM role, or sign in as the root user (not
1227
+ # Organizations. This applies a service-linked role (SLR) to the master
1228
+ # account in the organization. To call this operation, you must sign in
1229
+ # as an IAM user, assume an IAM role, or sign in as the root user (not
1105
1230
  # recommended) in the organization's master account.
1106
1231
  #
1232
+ # For more information, see [Aggregating AWS Health events][1] in the
1233
+ # *AWS Health User Guide*.
1234
+ #
1235
+ #
1236
+ #
1237
+ # [1]: https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html
1238
+ #
1107
1239
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1108
1240
  #
1109
1241
  # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EnableHealthServiceAccessForOrganization AWS API Documentation
@@ -1128,7 +1260,7 @@ module Aws::Health
1128
1260
  params: params,
1129
1261
  config: config)
1130
1262
  context[:gem_name] = 'aws-sdk-health'
1131
- context[:gem_version] = '1.27.0'
1263
+ context[:gem_version] = '1.28.0'
1132
1264
  Seahorse::Client::Request.new(handlers, context)
1133
1265
  end
1134
1266
 
@@ -49,6 +49,10 @@ module Aws::Health
49
49
  #
50
50
  # @!attribute [rw] tags
51
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>
52
56
  # @return [Hash<String,String>]
53
57
  #
54
58
  # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/AffectedEntity AWS API Documentation
@@ -66,9 +70,15 @@ module Aws::Health
66
70
  include Aws::Structure
67
71
  end
68
72
 
69
- # EnableHealthServiceAccessForOrganization is already in progress. Wait
70
- # for the action to complete before trying again. To get the current
71
- # status, use the DescribeHealthServiceStatusForOrganization operation.
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
72
82
  #
73
83
  # @!attribute [rw] message
74
84
  # @return [String]
@@ -81,13 +91,18 @@ module Aws::Health
81
91
  include Aws::Structure
82
92
  end
83
93
 
84
- # A range of dates and times that is used by the EventFilter and
85
- # EntityFilter objects. If `from` is set and `to` is set: match items
86
- # where the timestamp (`startTime`, `endTime`, or `lastUpdatedTime`) is
87
- # between `from` and `to` inclusive. If `from` is set and `to` is not
88
- # set: match items where the timestamp value is equal to or after
89
- # `from`. If `from` is not set and `to` is set: match items where the
90
- # 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
91
106
  #
92
107
  # @note When making an API call, you may pass DateTimeRange
93
108
  # data as a hash:
@@ -158,6 +173,20 @@ module Aws::Health
158
173
  # @return [Array<String>]
159
174
  #
160
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.
161
190
  # @return [String]
162
191
  #
163
192
  # @!attribute [rw] next_token
@@ -230,7 +259,7 @@ module Aws::Health
230
259
  # @!attribute [rw] entities
231
260
  # A JSON set of elements including the `awsAccountId` and its
232
261
  # `entityArn`, `entityValue` and its `entityArn`, `lastUpdatedTime`,
233
- # `statusCode`, and `tags`.
262
+ # and `statusCode`.
234
263
  # @return [Array<Types::AffectedEntity>]
235
264
  #
236
265
  # @!attribute [rw] failed_set
@@ -833,7 +862,11 @@ module Aws::Health
833
862
  end
834
863
 
835
864
  # The number of entities that are affected by one or more events.
836
- # 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
837
870
  #
838
871
  # @!attribute [rw] event_arn
839
872
  # The unique identifier for the event. Format:
@@ -843,7 +876,7 @@ module Aws::Health
843
876
  # @return [String]
844
877
  #
845
878
  # @!attribute [rw] count
846
- # The number entities that match the criteria for the specified
879
+ # The number of entities that match the criteria for the specified
847
880
  # events.
848
881
  # @return [Integer]
849
882
  #
@@ -856,9 +889,13 @@ module Aws::Health
856
889
  include Aws::Structure
857
890
  end
858
891
 
859
- # The values to use to filter results from the DescribeAffectedEntities
892
+ # The values to use to filter results from the [EntityFilter][1]
860
893
  # operation.
861
894
  #
895
+ #
896
+ #
897
+ # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html
898
+ #
862
899
  # @note When making an API call, you may pass EntityFilter
863
900
  # data as a hash:
864
901
  #
@@ -901,6 +938,10 @@ module Aws::Health
901
938
  #
902
939
  # @!attribute [rw] tags
903
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>
904
945
  # @return [Array<Hash<String,String>>]
905
946
  #
906
947
  # @!attribute [rw] status_codes
@@ -923,6 +964,27 @@ module Aws::Health
923
964
 
924
965
  # Summary information about an AWS Health event.
925
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
+ #
926
988
  # @!attribute [rw] arn
927
989
  # The unique identifier for the event. Format:
928
990
  # `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
@@ -972,6 +1034,20 @@ module Aws::Health
972
1034
  # @return [String]
973
1035
  #
974
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.
975
1051
  # @return [String]
976
1052
  #
977
1053
  # @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/Event AWS API Documentation
@@ -993,8 +1069,13 @@ module Aws::Health
993
1069
  end
994
1070
 
995
1071
  # The values used to filter results from the
996
- # DescribeEventDetailsForOrganization and
997
- # 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
998
1079
  #
999
1080
  # @note When making an API call, you may pass EventAccountFilter
1000
1081
  # data as a hash:
@@ -1026,7 +1107,11 @@ module Aws::Health
1026
1107
  end
1027
1108
 
1028
1109
  # The number of events of each issue type. Returned by the
1029
- # DescribeEventAggregates operation.
1110
+ # [DescribeEventAggregates][1] operation.
1111
+ #
1112
+ #
1113
+ #
1114
+ # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html
1030
1115
  #
1031
1116
  # @!attribute [rw] aggregate_value
1032
1117
  # The issue type for the associated count.
@@ -1046,7 +1131,11 @@ module Aws::Health
1046
1131
  end
1047
1132
 
1048
1133
  # The detailed description of the event. Included in the information
1049
- # 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
1050
1139
  #
1051
1140
  # @!attribute [rw] latest_description
1052
1141
  # The most recent description of the event.
@@ -1060,9 +1149,15 @@ module Aws::Health
1060
1149
  include Aws::Structure
1061
1150
  end
1062
1151
 
1063
- # Detailed information about an event. A combination of an Event object,
1064
- # an EventDescription object, and additional metadata about the event.
1065
- # 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
1066
1161
  #
1067
1162
  # @!attribute [rw] event
1068
1163
  # Summary information about the event.
@@ -1086,9 +1181,13 @@ module Aws::Health
1086
1181
  include Aws::Structure
1087
1182
  end
1088
1183
 
1089
- # Error information returned when a DescribeEventDetails operation
1184
+ # Error information returned when a [DescribeEventDetails][1] operation
1090
1185
  # cannot find a specified event.
1091
1186
  #
1187
+ #
1188
+ #
1189
+ # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html
1190
+ #
1092
1191
  # @!attribute [rw] event_arn
1093
1192
  # The unique identifier for the event. Format:
1094
1193
  # `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
@@ -1114,8 +1213,13 @@ module Aws::Health
1114
1213
  include Aws::Structure
1115
1214
  end
1116
1215
 
1117
- # The values to use to filter results from the DescribeEvents and
1118
- # 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
1119
1223
  #
1120
1224
  # @note When making an API call, you may pass EventFilter
1121
1225
  # data as a hash:
@@ -1207,6 +1311,10 @@ module Aws::Health
1207
1311
  #
1208
1312
  # @!attribute [rw] tags
1209
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>
1210
1318
  # @return [Array<Hash<String,String>>]
1211
1319
  #
1212
1320
  # @!attribute [rw] event_status_codes
@@ -1264,9 +1372,13 @@ module Aws::Health
1264
1372
  include Aws::Structure
1265
1373
  end
1266
1374
 
1267
- # The values to use to filter results from the DescribeEventTypes
1375
+ # The values to use to filter results from the [DescribeEventTypes][1]
1268
1376
  # operation.
1269
1377
  #
1378
+ #
1379
+ #
1380
+ # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html
1381
+ #
1270
1382
  # @note When making an API call, you may pass EventTypeFilter
1271
1383
  # data as a hash:
1272
1384
  #
@@ -1314,9 +1426,13 @@ module Aws::Health
1314
1426
  end
1315
1427
 
1316
1428
  # Error information returned when a
1317
- # DescribeAffectedEntitiesForOrganization operation cannot find or
1429
+ # [DescribeAffectedEntitiesForOrganization][1] operation cannot find or
1318
1430
  # process a specific entity.
1319
1431
  #
1432
+ #
1433
+ #
1434
+ # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html
1435
+ #
1320
1436
  # @!attribute [rw] aws_account_id
1321
1437
  # The 12-digit AWS account numbers that contains the affected
1322
1438
  # entities.
@@ -1351,7 +1467,11 @@ module Aws::Health
1351
1467
  end
1352
1468
 
1353
1469
  # Summary information about an event, returned by the
1354
- # DescribeEventsForOrganization operation.
1470
+ # [DescribeEventsForOrganization][1] operation.
1471
+ #
1472
+ #
1473
+ #
1474
+ # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html
1355
1475
  #
1356
1476
  # @!attribute [rw] arn
1357
1477
  # The unique identifier for the event. Format:
@@ -1376,6 +1496,20 @@ module Aws::Health
1376
1496
  # @return [String]
1377
1497
  #
1378
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.
1379
1513
  # @return [String]
1380
1514
  #
1381
1515
  # @!attribute [rw] region
@@ -1416,9 +1550,16 @@ module Aws::Health
1416
1550
  include Aws::Structure
1417
1551
  end
1418
1552
 
1419
- # Detailed information about an event. A combination of an Event object,
1420
- # an EventDescription object, and additional metadata about the event.
1421
- # Returned by the DescribeEventDetailsForOrganization operation.
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
1422
1563
  #
1423
1564
  # @!attribute [rw] aws_account_id
1424
1565
  # The 12-digit AWS account numbers that contains the affected
@@ -1427,11 +1568,36 @@ module Aws::Health
1427
1568
  #
1428
1569
  # @!attribute [rw] event
1429
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
1430
1592
  # @return [Types::Event]
1431
1593
  #
1432
1594
  # @!attribute [rw] event_description
1433
1595
  # The detailed description of the event. Included in the information
1434
- # 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
1435
1601
  # @return [Types::EventDescription]
1436
1602
  #
1437
1603
  # @!attribute [rw] event_metadata
@@ -1449,13 +1615,22 @@ module Aws::Health
1449
1615
  include Aws::Structure
1450
1616
  end
1451
1617
 
1452
- # Error information returned when a DescribeEventDetailsForOrganization
1453
- # operation cannot find a specified event.
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
1454
1625
  #
1455
1626
  # @!attribute [rw] aws_account_id
1456
1627
  # Error information returned when a
1457
- # DescribeEventDetailsForOrganization operation cannot find a
1628
+ # [DescribeEventDetailsForOrganization][1] operation cannot find a
1458
1629
  # specified event.
1630
+ #
1631
+ #
1632
+ #
1633
+ # [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html
1459
1634
  # @return [String]
1460
1635
  #
1461
1636
  # @!attribute [rw] event_arn
@@ -1484,8 +1659,12 @@ module Aws::Health
1484
1659
  include Aws::Structure
1485
1660
  end
1486
1661
 
1487
- # The values to filter results from the DescribeEventsForOrganization
1488
- # 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
1489
1668
  #
1490
1669
  # @note When making an API call, you may pass OrganizationEventFilter
1491
1670
  # data as a hash:
@@ -1533,37 +1712,52 @@ module Aws::Health
1533
1712
  # @return [Array<String>]
1534
1713
  #
1535
1714
  # @!attribute [rw] start_time
1536
- # A range of dates and times that is used by the EventFilter and
1537
- # EntityFilter objects. If `from` is set and `to` is set: match items
1538
- # where the timestamp (`startTime`, `endTime`, or `lastUpdatedTime`)
1539
- # is between `from` and `to` inclusive. If `from` is set and `to` is
1540
- # not set: match items where the timestamp value is equal to or after
1541
- # `from`. If `from` is not set and `to` is set: match items where the
1542
- # 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
1543
1727
  # @return [Types::DateTimeRange]
1544
1728
  #
1545
1729
  # @!attribute [rw] end_time
1546
- # A range of dates and times that is used by the EventFilter and
1547
- # EntityFilter objects. If `from` is set and `to` is set: match items
1548
- # where the timestamp (`startTime`, `endTime`, or `lastUpdatedTime`)
1549
- # is between `from` and `to` inclusive. If `from` is set and `to` is
1550
- # not set: match items where the timestamp value is equal to or after
1551
- # `from`. If `from` is not set and `to` is set: match items where the
1552
- # 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
1553
1742
  # @return [Types::DateTimeRange]
1554
1743
  #
1555
1744
  # @!attribute [rw] last_updated_time
1556
- # A range of dates and times that is used by the EventFilter and
1557
- # EntityFilter objects. If `from` is set and `to` is set: match items
1558
- # where the timestamp (`startTime`, `endTime`, or `lastUpdatedTime`)
1559
- # is between `from` and `to` inclusive. If `from` is set and `to` is
1560
- # not set: match items where the timestamp value is equal to or after
1561
- # `from`. If `from` is not set and `to` is set: match items where the
1562
- # 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
1563
1757
  # @return [Types::DateTimeRange]
1564
1758
  #
1565
1759
  # @!attribute [rw] entity_arns
1566
- # REPLACEME
1760
+ # A list of entity ARNs (unique identifiers).
1567
1761
  # @return [Array<String>]
1568
1762
  #
1569
1763
  # @!attribute [rw] entity_values
@@ -1572,7 +1766,8 @@ module Aws::Health
1572
1766
  # @return [Array<String>]
1573
1767
  #
1574
1768
  # @!attribute [rw] event_type_categories
1575
- # REPLACEME
1769
+ # A list of event type category codes (issue, scheduledChange, or
1770
+ # accountNotification).
1576
1771
  # @return [Array<String>]
1577
1772
  #
1578
1773
  # @!attribute [rw] event_status_codes
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-health
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.27.0
4
+ version: 1.28.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-06-23 00:00:00.000000000 Z
11
+ date: 2020-08-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core