aws-sdk-health 1.26.1 → 1.31.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 +5 -2
- data/lib/aws-sdk-health/client.rb +196 -47
- data/lib/aws-sdk-health/client_api.rb +2 -0
- 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 +298 -59
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 12a45ae5c9ddb154b6da4b6f1ad97ed3e18a0beffbf84cfbc0d35ac52329ed98
|
4
|
+
data.tar.gz: '0808148d2c0f15aa47a9eb134aa9de4c8288ca52fc43a8b63f0745c9586910c1'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1aa96e37b0997111bd15b4f336110479d3e72f419ebd0931a9171eecbfd78a8ebeea861227a83714edce3932a3172d53786e72c63298e277d16fffcae7935006
|
7
|
+
data.tar.gz: d7a9d5392d420b329613a1cebf71be9d77a2a2e5e1bfc2adf09fa729529a563ebd01012319de4094cad45ef54cdb4adef0ff7cf2fdfcd6e0cad8fdf7f5ffa25f
|
data/lib/aws-sdk-health.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:
|
@@ -5,6 +7,7 @@
|
|
5
7
|
#
|
6
8
|
# WARNING ABOUT GENERATED CODE
|
7
9
|
|
10
|
+
|
8
11
|
require 'aws-sdk-core'
|
9
12
|
require 'aws-sigv4'
|
10
13
|
|
@@ -42,9 +45,9 @@ require_relative 'aws-sdk-health/customizations'
|
|
42
45
|
#
|
43
46
|
# See {Errors} for more information.
|
44
47
|
#
|
45
|
-
#
|
48
|
+
# @!group service
|
46
49
|
module Aws::Health
|
47
50
|
|
48
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.31.0'
|
49
52
|
|
50
53
|
end
|
@@ -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:
|
@@ -83,13 +85,28 @@ module Aws::Health
|
|
83
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
84
86
|
# credentials.
|
85
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
86
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
87
103
|
# from an EC2 IMDS on an EC2 instance.
|
88
104
|
#
|
89
|
-
# * `Aws::
|
90
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
91
107
|
#
|
92
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
93
110
|
#
|
94
111
|
# When `:credentials` are not configured directly, the following
|
95
112
|
# locations will be searched for credentials:
|
@@ -99,10 +116,10 @@ module Aws::Health
|
|
99
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
100
117
|
# * `~/.aws/credentials`
|
101
118
|
# * `~/.aws/config`
|
102
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
103
|
-
# very aggressive. Construct and pass an instance of
|
104
|
-
# `Aws::InstanceProfileCredentails`
|
105
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
106
123
|
#
|
107
124
|
# @option options [required, String] :region
|
108
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -321,13 +338,24 @@ module Aws::Health
|
|
321
338
|
# @!group API Operations
|
322
339
|
|
323
340
|
# Returns a list of accounts in the organization from AWS Organizations
|
324
|
-
# that are affected by the provided event.
|
341
|
+
# that are affected by the provided event. For more information about
|
342
|
+
# the different types of AWS Health events, see [Event][1].
|
325
343
|
#
|
326
344
|
# Before you can call this operation, you must first enable AWS Health
|
327
345
|
# to work with AWS Organizations. To do this, call the
|
328
|
-
# EnableHealthServiceAccessForOrganization operation from your
|
346
|
+
# [EnableHealthServiceAccessForOrganization][2] operation from your
|
329
347
|
# organization's master account.
|
330
348
|
#
|
349
|
+
# <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
|
350
|
+
# in the next request to return more results.
|
351
|
+
#
|
352
|
+
# </note>
|
353
|
+
#
|
354
|
+
#
|
355
|
+
#
|
356
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html
|
357
|
+
# [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html
|
358
|
+
#
|
331
359
|
# @option params [required, String] :event_arn
|
332
360
|
# The unique identifier for the event. Format:
|
333
361
|
# `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
|
@@ -387,6 +415,11 @@ module Aws::Health
|
|
387
415
|
# At least one event ARN is required. Results are sorted by the
|
388
416
|
# `lastUpdatedTime` of the entity, starting with the most recent.
|
389
417
|
#
|
418
|
+
# <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
|
419
|
+
# in the next request to return more results.
|
420
|
+
#
|
421
|
+
# </note>
|
422
|
+
#
|
390
423
|
# @option params [required, Types::EntityFilter] :filter
|
391
424
|
# Values to narrow the results returned. At least one event ARN is
|
392
425
|
# required.
|
@@ -467,14 +500,24 @@ module Aws::Health
|
|
467
500
|
# individual customer resources, groups of customer resources, or any
|
468
501
|
# other construct, depending on the AWS service.
|
469
502
|
#
|
470
|
-
# At least one event ARN and account ID are
|
471
|
-
# by the `lastUpdatedTime` of the entity,
|
503
|
+
# At least one event Amazon Resource Name (ARN) and account ID are
|
504
|
+
# required. Results are sorted by the `lastUpdatedTime` of the entity,
|
505
|
+
# starting with the most recent.
|
472
506
|
#
|
473
507
|
# Before you can call this operation, you must first enable AWS Health
|
474
508
|
# to work with AWS Organizations. To do this, call the
|
475
|
-
# EnableHealthServiceAccessForOrganization operation from your
|
509
|
+
# [EnableHealthServiceAccessForOrganization][1] operation from your
|
476
510
|
# organization's master account.
|
477
511
|
#
|
512
|
+
# <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
|
513
|
+
# in the next request to return more results.
|
514
|
+
#
|
515
|
+
# </note>
|
516
|
+
#
|
517
|
+
#
|
518
|
+
#
|
519
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html
|
520
|
+
#
|
478
521
|
# @option params [required, Array<Types::EventAccountFilter>] :organization_entity_filters
|
479
522
|
# A JSON set of elements including the `awsAccountId` and the
|
480
523
|
# `eventArn`.
|
@@ -582,6 +625,11 @@ module Aws::Health
|
|
582
625
|
# change, and account notification). If no filter is specified, the
|
583
626
|
# counts of all events in each category are returned.
|
584
627
|
#
|
628
|
+
# <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
|
629
|
+
# in the next request to return more results.
|
630
|
+
#
|
631
|
+
# </note>
|
632
|
+
#
|
585
633
|
# @option params [Types::EventFilter] :filter
|
586
634
|
# Values to narrow the results returned.
|
587
635
|
#
|
@@ -665,15 +713,20 @@ module Aws::Health
|
|
665
713
|
end
|
666
714
|
|
667
715
|
# Returns detailed information about one or more specified events.
|
668
|
-
# Information includes standard event data (
|
669
|
-
# as returned by DescribeEvents), a detailed event description, and
|
716
|
+
# Information includes standard event data (Region, service, and so on,
|
717
|
+
# as returned by [DescribeEvents][1]), a detailed event description, and
|
670
718
|
# possible additional metadata that depends upon the nature of the
|
671
|
-
# event. Affected entities are not included
|
672
|
-
# DescribeAffectedEntities operation.
|
719
|
+
# event. Affected entities are not included. To retrieve those, use the
|
720
|
+
# [DescribeAffectedEntities][2] operation.
|
673
721
|
#
|
674
722
|
# If a specified event cannot be retrieved, an error message is returned
|
675
723
|
# for that event.
|
676
724
|
#
|
725
|
+
#
|
726
|
+
#
|
727
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html
|
728
|
+
# [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html
|
729
|
+
#
|
677
730
|
# @option params [required, Array<String>] :event_arns
|
678
731
|
# A list of event ARNs (unique identifiers). For example:
|
679
732
|
# `"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456",
|
@@ -729,16 +782,40 @@ module Aws::Health
|
|
729
782
|
# Returns detailed information about one or more specified events for
|
730
783
|
# one or more accounts in your organization. Information includes
|
731
784
|
# standard event data (Region, service, and so on, as returned by
|
732
|
-
# DescribeEventsForOrganization, a detailed event description, and
|
785
|
+
# [DescribeEventsForOrganization][1]), a detailed event description, and
|
733
786
|
# possible additional metadata that depends upon the nature of the
|
734
787
|
# event. Affected entities are not included; to retrieve those, use the
|
735
|
-
# DescribeAffectedEntitiesForOrganization operation.
|
788
|
+
# [DescribeAffectedEntitiesForOrganization][2] operation.
|
736
789
|
#
|
737
790
|
# Before you can call this operation, you must first enable AWS Health
|
738
791
|
# to work with AWS Organizations. To do this, call the
|
739
|
-
# EnableHealthServiceAccessForOrganization operation from your
|
792
|
+
# [EnableHealthServiceAccessForOrganization][3] operation from your
|
740
793
|
# organization's master account.
|
741
794
|
#
|
795
|
+
# When you call the `DescribeEventDetailsForOrganization` operation, you
|
796
|
+
# specify the `organizationEventDetailFilters` object in the request.
|
797
|
+
# Depending on the AWS Health event type, note the following
|
798
|
+
# differences:
|
799
|
+
#
|
800
|
+
# * If the event is public, the `awsAccountId` parameter must be empty.
|
801
|
+
# If you specify an account ID for a public event, then an error
|
802
|
+
# message is returned. That's because the event might apply to all
|
803
|
+
# AWS accounts and isn't specific to an account in your organization.
|
804
|
+
#
|
805
|
+
# * If the event is specific to an account, then you must specify the
|
806
|
+
# `awsAccountId` parameter in the request. If you don't specify an
|
807
|
+
# account ID, an error message returns because the event is specific
|
808
|
+
# to an AWS account in your organization.
|
809
|
+
#
|
810
|
+
# For more information, see [Event][4].
|
811
|
+
#
|
812
|
+
#
|
813
|
+
#
|
814
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html
|
815
|
+
# [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html
|
816
|
+
# [3]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html
|
817
|
+
# [4]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html
|
818
|
+
#
|
742
819
|
# @option params [required, Array<Types::EventAccountFilter>] :organization_event_detail_filters
|
743
820
|
# A set of JSON elements that includes the `awsAccountId` and the
|
744
821
|
# `eventArn`.
|
@@ -801,6 +878,11 @@ module Aws::Health
|
|
801
878
|
# filter criteria are specified, all event types are returned, in no
|
802
879
|
# particular order.
|
803
880
|
#
|
881
|
+
# <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
|
882
|
+
# in the next request to return more results.
|
883
|
+
#
|
884
|
+
# </note>
|
885
|
+
#
|
804
886
|
# @option params [Types::EventTypeFilter] :filter
|
805
887
|
# Values to narrow the results returned.
|
806
888
|
#
|
@@ -860,10 +942,31 @@ module Aws::Health
|
|
860
942
|
# criteria. Events are returned in a summary form and do not include the
|
861
943
|
# detailed description, any additional metadata that depends on the
|
862
944
|
# event type, or any affected resources. To retrieve that information,
|
863
|
-
# use the DescribeEventDetails and DescribeAffectedEntities
|
945
|
+
# use the [DescribeEventDetails][1] and [DescribeAffectedEntities][2]
|
946
|
+
# operations.
|
864
947
|
#
|
865
948
|
# If no filter criteria are specified, all events are returned. Results
|
866
|
-
# are sorted by `lastModifiedTime`, starting with the most recent.
|
949
|
+
# are sorted by `lastModifiedTime`, starting with the most recent event.
|
950
|
+
#
|
951
|
+
# <note markdown="1"> * When you call the `DescribeEvents` operation and specify an entity
|
952
|
+
# for the `entityValues` parameter, AWS Health might return public
|
953
|
+
# events that aren't specific to that resource. For example, if you
|
954
|
+
# call `DescribeEvents` and specify an ID for an Amazon Elastic
|
955
|
+
# Compute Cloud (Amazon EC2) instance, AWS Health might return events
|
956
|
+
# that aren't specific to that resource or service. To get events
|
957
|
+
# that are specific to a service, use the `services` parameter in the
|
958
|
+
# `filter` object. For more information, see [Event][3].
|
959
|
+
#
|
960
|
+
# * This API operation uses pagination. Specify the `nextToken`
|
961
|
+
# parameter in the next request to return more results.
|
962
|
+
#
|
963
|
+
# </note>
|
964
|
+
#
|
965
|
+
#
|
966
|
+
#
|
967
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html
|
968
|
+
# [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html
|
969
|
+
# [3]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html
|
867
970
|
#
|
868
971
|
# @option params [Types::EventFilter] :filter
|
869
972
|
# Values to narrow the results returned.
|
@@ -958,22 +1061,42 @@ module Aws::Health
|
|
958
1061
|
end
|
959
1062
|
|
960
1063
|
# Returns information about events across your organization in AWS
|
961
|
-
# Organizations
|
962
|
-
#
|
963
|
-
#
|
964
|
-
# event type, or any affected
|
965
|
-
# use the
|
966
|
-
# DescribeEventDetailsForOrganization, and
|
967
|
-
# DescribeAffectedEntitiesForOrganization operations.
|
1064
|
+
# Organizations. You can use the`filters` parameter to specify the
|
1065
|
+
# events that you want to return. Events are returned in a summary form
|
1066
|
+
# and don't include the affected accounts, detailed description, any
|
1067
|
+
# additional metadata that depends on the event type, or any affected
|
1068
|
+
# resources. To retrieve that information, use the following operations:
|
968
1069
|
#
|
969
|
-
#
|
970
|
-
# organization are returned. Results are sorted by `lastModifiedTime`,
|
971
|
-
# starting with the most recent.
|
1070
|
+
# * [DescribeAffectedAccountsForOrganization][1]
|
972
1071
|
#
|
973
|
-
#
|
974
|
-
#
|
975
|
-
#
|
976
|
-
#
|
1072
|
+
# * [DescribeEventDetailsForOrganization][2]
|
1073
|
+
#
|
1074
|
+
# * [DescribeAffectedEntitiesForOrganization][3]
|
1075
|
+
#
|
1076
|
+
# If you don't specify a `filter`, the `DescribeEventsForOrganizations`
|
1077
|
+
# returns all events across your organization. Results are sorted by
|
1078
|
+
# `lastModifiedTime`, starting with the most recent event.
|
1079
|
+
#
|
1080
|
+
# For more information about the different types of AWS Health events,
|
1081
|
+
# see [Event][4].
|
1082
|
+
#
|
1083
|
+
# Before you can call this operation, you must first enable AWS Health
|
1084
|
+
# to work with AWS Organizations. To do this, call the
|
1085
|
+
# [EnableHealthServiceAccessForOrganization][5] operation from your
|
1086
|
+
# organization's master AWS account.
|
1087
|
+
#
|
1088
|
+
# <note markdown="1"> This API operation uses pagination. Specify the `nextToken` parameter
|
1089
|
+
# in the next request to return more results.
|
1090
|
+
#
|
1091
|
+
# </note>
|
1092
|
+
#
|
1093
|
+
#
|
1094
|
+
#
|
1095
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedAccountsForOrganization.html
|
1096
|
+
# [2]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html
|
1097
|
+
# [3]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html
|
1098
|
+
# [4]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html
|
1099
|
+
# [5]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html
|
977
1100
|
#
|
978
1101
|
# @option params [Types::OrganizationEventFilter] :filter
|
979
1102
|
# Values to narrow the results returned.
|
@@ -1076,12 +1199,33 @@ module Aws::Health
|
|
1076
1199
|
req.send_request(options)
|
1077
1200
|
end
|
1078
1201
|
|
1079
|
-
#
|
1080
|
-
#
|
1081
|
-
#
|
1082
|
-
#
|
1083
|
-
#
|
1084
|
-
#
|
1202
|
+
# Disables AWS Health from working with AWS Organizations. To call this
|
1203
|
+
# operation, you must sign in as an AWS Identity and Access Management
|
1204
|
+
# (IAM) user, assume an IAM role, or sign in as the root user (not
|
1205
|
+
# recommended) in the organization's master AWS account. For more
|
1206
|
+
# information, see [Aggregating AWS Health events][1] in the *AWS Health
|
1207
|
+
# User Guide*.
|
1208
|
+
#
|
1209
|
+
# This operation doesn't remove the service-linked role (SLR) from the
|
1210
|
+
# AWS master account in your organization. You must use the IAM console,
|
1211
|
+
# API, or AWS Command Line Interface (AWS CLI) to remove the SLR. For
|
1212
|
+
# more information, see [Deleting a Service-Linked Role][2] in the *IAM
|
1213
|
+
# User Guide*.
|
1214
|
+
#
|
1215
|
+
# <note markdown="1"> You can also disable the organizational feature by using the
|
1216
|
+
# Organizations [DisableAWSServiceAccess][3] API operation. After you
|
1217
|
+
# call this operation, AWS Health stops aggregating events for all other
|
1218
|
+
# AWS accounts in your organization. If you call the AWS Health API
|
1219
|
+
# operations for organizational view, AWS Health returns an error. AWS
|
1220
|
+
# Health continues to aggregate health events for your AWS account.
|
1221
|
+
#
|
1222
|
+
# </note>
|
1223
|
+
#
|
1224
|
+
#
|
1225
|
+
#
|
1226
|
+
# [1]: https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html
|
1227
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role
|
1228
|
+
# [3]: https://docs.aws.amazon.com/organizations/latest/APIReference/API_DisableAWSServiceAccess.html
|
1085
1229
|
#
|
1086
1230
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1087
1231
|
#
|
@@ -1095,13 +1239,18 @@ module Aws::Health
|
|
1095
1239
|
end
|
1096
1240
|
|
1097
1241
|
# Calling this operation enables AWS Health to work with AWS
|
1098
|
-
# Organizations. This applies a
|
1099
|
-
# account in the organization. To
|
1100
|
-
#
|
1101
|
-
# Organizations. To call this operation, you must sign in as an IAM
|
1102
|
-
# user, assume an IAM role, or sign in as the root user (not
|
1242
|
+
# Organizations. This applies a service-linked role (SLR) to the master
|
1243
|
+
# account in the organization. To call this operation, you must sign in
|
1244
|
+
# as an IAM user, assume an IAM role, or sign in as the root user (not
|
1103
1245
|
# recommended) in the organization's master account.
|
1104
1246
|
#
|
1247
|
+
# For more information, see [Aggregating AWS Health events][1] in the
|
1248
|
+
# *AWS Health User Guide*.
|
1249
|
+
#
|
1250
|
+
#
|
1251
|
+
#
|
1252
|
+
# [1]: https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html
|
1253
|
+
#
|
1105
1254
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1106
1255
|
#
|
1107
1256
|
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/EnableHealthServiceAccessForOrganization AWS API Documentation
|
@@ -1126,7 +1275,7 @@ module Aws::Health
|
|
1126
1275
|
params: params,
|
1127
1276
|
config: config)
|
1128
1277
|
context[:gem_name] = 'aws-sdk-health'
|
1129
|
-
context[:gem_version] = '1.
|
1278
|
+
context[:gem_version] = '1.31.0'
|
1130
1279
|
Seahorse::Client::Request.new(handlers, context)
|
1131
1280
|
end
|
1132
1281
|
|
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
|
|
@@ -152,6 +173,20 @@ module Aws::Health
|
|
152
173
|
# @return [Array<String>]
|
153
174
|
#
|
154
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.
|
155
190
|
# @return [String]
|
156
191
|
#
|
157
192
|
# @!attribute [rw] next_token
|
@@ -168,6 +203,7 @@ module Aws::Health
|
|
168
203
|
:affected_accounts,
|
169
204
|
:event_scope_code,
|
170
205
|
:next_token)
|
206
|
+
SENSITIVE = []
|
171
207
|
include Aws::Structure
|
172
208
|
end
|
173
209
|
|
@@ -216,13 +252,14 @@ module Aws::Health
|
|
216
252
|
:locale,
|
217
253
|
:next_token,
|
218
254
|
:max_results)
|
255
|
+
SENSITIVE = []
|
219
256
|
include Aws::Structure
|
220
257
|
end
|
221
258
|
|
222
259
|
# @!attribute [rw] entities
|
223
260
|
# A JSON set of elements including the `awsAccountId` and its
|
224
261
|
# `entityArn`, `entityValue` and its `entityArn`, `lastUpdatedTime`,
|
225
|
-
#
|
262
|
+
# and `statusCode`.
|
226
263
|
# @return [Array<Types::AffectedEntity>]
|
227
264
|
#
|
228
265
|
# @!attribute [rw] failed_set
|
@@ -244,6 +281,7 @@ module Aws::Health
|
|
244
281
|
:entities,
|
245
282
|
:failed_set,
|
246
283
|
:next_token)
|
284
|
+
SENSITIVE = []
|
247
285
|
include Aws::Structure
|
248
286
|
end
|
249
287
|
|
@@ -303,6 +341,7 @@ module Aws::Health
|
|
303
341
|
:locale,
|
304
342
|
:next_token,
|
305
343
|
:max_results)
|
344
|
+
SENSITIVE = []
|
306
345
|
include Aws::Structure
|
307
346
|
end
|
308
347
|
|
@@ -323,6 +362,7 @@ module Aws::Health
|
|
323
362
|
class DescribeAffectedEntitiesResponse < Struct.new(
|
324
363
|
:entities,
|
325
364
|
:next_token)
|
365
|
+
SENSITIVE = []
|
326
366
|
include Aws::Structure
|
327
367
|
end
|
328
368
|
|
@@ -343,6 +383,7 @@ module Aws::Health
|
|
343
383
|
#
|
344
384
|
class DescribeEntityAggregatesRequest < Struct.new(
|
345
385
|
:event_arns)
|
386
|
+
SENSITIVE = []
|
346
387
|
include Aws::Structure
|
347
388
|
end
|
348
389
|
|
@@ -355,6 +396,7 @@ module Aws::Health
|
|
355
396
|
#
|
356
397
|
class DescribeEntityAggregatesResponse < Struct.new(
|
357
398
|
:entity_aggregates)
|
399
|
+
SENSITIVE = []
|
358
400
|
include Aws::Structure
|
359
401
|
end
|
360
402
|
|
@@ -429,6 +471,7 @@ module Aws::Health
|
|
429
471
|
:aggregate_field,
|
430
472
|
:max_results,
|
431
473
|
:next_token)
|
474
|
+
SENSITIVE = []
|
432
475
|
include Aws::Structure
|
433
476
|
end
|
434
477
|
|
@@ -450,6 +493,7 @@ module Aws::Health
|
|
450
493
|
class DescribeEventAggregatesResponse < Struct.new(
|
451
494
|
:event_aggregates,
|
452
495
|
:next_token)
|
496
|
+
SENSITIVE = []
|
453
497
|
include Aws::Structure
|
454
498
|
end
|
455
499
|
|
@@ -481,6 +525,7 @@ module Aws::Health
|
|
481
525
|
class DescribeEventDetailsForOrganizationRequest < Struct.new(
|
482
526
|
:organization_event_detail_filters,
|
483
527
|
:locale)
|
528
|
+
SENSITIVE = []
|
484
529
|
include Aws::Structure
|
485
530
|
end
|
486
531
|
|
@@ -497,6 +542,7 @@ module Aws::Health
|
|
497
542
|
class DescribeEventDetailsForOrganizationResponse < Struct.new(
|
498
543
|
:successful_set,
|
499
544
|
:failed_set)
|
545
|
+
SENSITIVE = []
|
500
546
|
include Aws::Structure
|
501
547
|
end
|
502
548
|
|
@@ -524,6 +570,7 @@ module Aws::Health
|
|
524
570
|
class DescribeEventDetailsRequest < Struct.new(
|
525
571
|
:event_arns,
|
526
572
|
:locale)
|
573
|
+
SENSITIVE = []
|
527
574
|
include Aws::Structure
|
528
575
|
end
|
529
576
|
|
@@ -540,6 +587,7 @@ module Aws::Health
|
|
540
587
|
class DescribeEventDetailsResponse < Struct.new(
|
541
588
|
:successful_set,
|
542
589
|
:failed_set)
|
590
|
+
SENSITIVE = []
|
543
591
|
include Aws::Structure
|
544
592
|
end
|
545
593
|
|
@@ -586,6 +634,7 @@ module Aws::Health
|
|
586
634
|
:locale,
|
587
635
|
:next_token,
|
588
636
|
:max_results)
|
637
|
+
SENSITIVE = []
|
589
638
|
include Aws::Structure
|
590
639
|
end
|
591
640
|
|
@@ -611,6 +660,7 @@ module Aws::Health
|
|
611
660
|
class DescribeEventTypesResponse < Struct.new(
|
612
661
|
:event_types,
|
613
662
|
:next_token)
|
663
|
+
SENSITIVE = []
|
614
664
|
include Aws::Structure
|
615
665
|
end
|
616
666
|
|
@@ -674,6 +724,7 @@ module Aws::Health
|
|
674
724
|
:next_token,
|
675
725
|
:max_results,
|
676
726
|
:locale)
|
727
|
+
SENSITIVE = []
|
677
728
|
include Aws::Structure
|
678
729
|
end
|
679
730
|
|
@@ -694,6 +745,7 @@ module Aws::Health
|
|
694
745
|
class DescribeEventsForOrganizationResponse < Struct.new(
|
695
746
|
:events,
|
696
747
|
:next_token)
|
748
|
+
SENSITIVE = []
|
697
749
|
include Aws::Structure
|
698
750
|
end
|
699
751
|
|
@@ -769,6 +821,7 @@ module Aws::Health
|
|
769
821
|
:next_token,
|
770
822
|
:max_results,
|
771
823
|
:locale)
|
824
|
+
SENSITIVE = []
|
772
825
|
include Aws::Structure
|
773
826
|
end
|
774
827
|
|
@@ -789,6 +842,7 @@ module Aws::Health
|
|
789
842
|
class DescribeEventsResponse < Struct.new(
|
790
843
|
:events,
|
791
844
|
:next_token)
|
845
|
+
SENSITIVE = []
|
792
846
|
include Aws::Structure
|
793
847
|
end
|
794
848
|
|
@@ -803,11 +857,16 @@ module Aws::Health
|
|
803
857
|
#
|
804
858
|
class DescribeHealthServiceStatusForOrganizationResponse < Struct.new(
|
805
859
|
:health_service_access_status_for_organization)
|
860
|
+
SENSITIVE = []
|
806
861
|
include Aws::Structure
|
807
862
|
end
|
808
863
|
|
809
864
|
# The number of entities that are affected by one or more events.
|
810
|
-
# 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
|
811
870
|
#
|
812
871
|
# @!attribute [rw] event_arn
|
813
872
|
# The unique identifier for the event. Format:
|
@@ -817,7 +876,7 @@ module Aws::Health
|
|
817
876
|
# @return [String]
|
818
877
|
#
|
819
878
|
# @!attribute [rw] count
|
820
|
-
# The number entities that match the criteria for the specified
|
879
|
+
# The number of entities that match the criteria for the specified
|
821
880
|
# events.
|
822
881
|
# @return [Integer]
|
823
882
|
#
|
@@ -826,12 +885,17 @@ module Aws::Health
|
|
826
885
|
class EntityAggregate < Struct.new(
|
827
886
|
:event_arn,
|
828
887
|
:count)
|
888
|
+
SENSITIVE = []
|
829
889
|
include Aws::Structure
|
830
890
|
end
|
831
891
|
|
832
|
-
# The values to use to filter results from the
|
892
|
+
# The values to use to filter results from the [EntityFilter][1]
|
833
893
|
# operation.
|
834
894
|
#
|
895
|
+
#
|
896
|
+
#
|
897
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html
|
898
|
+
#
|
835
899
|
# @note When making an API call, you may pass EntityFilter
|
836
900
|
# data as a hash:
|
837
901
|
#
|
@@ -874,6 +938,10 @@ module Aws::Health
|
|
874
938
|
#
|
875
939
|
# @!attribute [rw] tags
|
876
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>
|
877
945
|
# @return [Array<Hash<String,String>>]
|
878
946
|
#
|
879
947
|
# @!attribute [rw] status_codes
|
@@ -890,11 +958,33 @@ module Aws::Health
|
|
890
958
|
:last_updated_times,
|
891
959
|
:tags,
|
892
960
|
:status_codes)
|
961
|
+
SENSITIVE = []
|
893
962
|
include Aws::Structure
|
894
963
|
end
|
895
964
|
|
896
965
|
# Summary information about an AWS Health event.
|
897
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
|
+
#
|
898
988
|
# @!attribute [rw] arn
|
899
989
|
# The unique identifier for the event. Format:
|
900
990
|
# `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
|
@@ -944,6 +1034,20 @@ module Aws::Health
|
|
944
1034
|
# @return [String]
|
945
1035
|
#
|
946
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.
|
947
1051
|
# @return [String]
|
948
1052
|
#
|
949
1053
|
# @see http://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/Event AWS API Documentation
|
@@ -960,12 +1064,18 @@ module Aws::Health
|
|
960
1064
|
:last_updated_time,
|
961
1065
|
:status_code,
|
962
1066
|
:event_scope_code)
|
1067
|
+
SENSITIVE = []
|
963
1068
|
include Aws::Structure
|
964
1069
|
end
|
965
1070
|
|
966
1071
|
# The values used to filter results from the
|
967
|
-
# DescribeEventDetailsForOrganization and
|
968
|
-
# 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
|
969
1079
|
#
|
970
1080
|
# @note When making an API call, you may pass EventAccountFilter
|
971
1081
|
# data as a hash:
|
@@ -992,11 +1102,16 @@ module Aws::Health
|
|
992
1102
|
class EventAccountFilter < Struct.new(
|
993
1103
|
:event_arn,
|
994
1104
|
:aws_account_id)
|
1105
|
+
SENSITIVE = []
|
995
1106
|
include Aws::Structure
|
996
1107
|
end
|
997
1108
|
|
998
1109
|
# The number of events of each issue type. Returned by the
|
999
|
-
# DescribeEventAggregates operation.
|
1110
|
+
# [DescribeEventAggregates][1] operation.
|
1111
|
+
#
|
1112
|
+
#
|
1113
|
+
#
|
1114
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html
|
1000
1115
|
#
|
1001
1116
|
# @!attribute [rw] aggregate_value
|
1002
1117
|
# The issue type for the associated count.
|
@@ -1011,11 +1126,16 @@ module Aws::Health
|
|
1011
1126
|
class EventAggregate < Struct.new(
|
1012
1127
|
:aggregate_value,
|
1013
1128
|
:count)
|
1129
|
+
SENSITIVE = []
|
1014
1130
|
include Aws::Structure
|
1015
1131
|
end
|
1016
1132
|
|
1017
1133
|
# The detailed description of the event. Included in the information
|
1018
|
-
# 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
|
1019
1139
|
#
|
1020
1140
|
# @!attribute [rw] latest_description
|
1021
1141
|
# The most recent description of the event.
|
@@ -1025,12 +1145,19 @@ module Aws::Health
|
|
1025
1145
|
#
|
1026
1146
|
class EventDescription < Struct.new(
|
1027
1147
|
:latest_description)
|
1148
|
+
SENSITIVE = []
|
1028
1149
|
include Aws::Structure
|
1029
1150
|
end
|
1030
1151
|
|
1031
|
-
# Detailed information about an event. A combination of an Event
|
1032
|
-
# an EventDescription object, and additional metadata about
|
1033
|
-
# 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
|
1034
1161
|
#
|
1035
1162
|
# @!attribute [rw] event
|
1036
1163
|
# Summary information about the event.
|
@@ -1050,12 +1177,17 @@ module Aws::Health
|
|
1050
1177
|
:event,
|
1051
1178
|
:event_description,
|
1052
1179
|
:event_metadata)
|
1180
|
+
SENSITIVE = []
|
1053
1181
|
include Aws::Structure
|
1054
1182
|
end
|
1055
1183
|
|
1056
|
-
# Error information returned when a DescribeEventDetails operation
|
1184
|
+
# Error information returned when a [DescribeEventDetails][1] operation
|
1057
1185
|
# cannot find a specified event.
|
1058
1186
|
#
|
1187
|
+
#
|
1188
|
+
#
|
1189
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html
|
1190
|
+
#
|
1059
1191
|
# @!attribute [rw] event_arn
|
1060
1192
|
# The unique identifier for the event. Format:
|
1061
1193
|
# `arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
|
@@ -1077,11 +1209,17 @@ module Aws::Health
|
|
1077
1209
|
:event_arn,
|
1078
1210
|
:error_name,
|
1079
1211
|
:error_message)
|
1212
|
+
SENSITIVE = []
|
1080
1213
|
include Aws::Structure
|
1081
1214
|
end
|
1082
1215
|
|
1083
|
-
# The values to use to filter results from the DescribeEvents and
|
1084
|
-
# 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
|
1085
1223
|
#
|
1086
1224
|
# @note When making an API call, you may pass EventFilter
|
1087
1225
|
# data as a hash:
|
@@ -1173,6 +1311,10 @@ module Aws::Health
|
|
1173
1311
|
#
|
1174
1312
|
# @!attribute [rw] tags
|
1175
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>
|
1176
1318
|
# @return [Array<Hash<String,String>>]
|
1177
1319
|
#
|
1178
1320
|
# @!attribute [rw] event_status_codes
|
@@ -1195,6 +1337,7 @@ module Aws::Health
|
|
1195
1337
|
:event_type_categories,
|
1196
1338
|
:tags,
|
1197
1339
|
:event_status_codes)
|
1340
|
+
SENSITIVE = []
|
1198
1341
|
include Aws::Structure
|
1199
1342
|
end
|
1200
1343
|
|
@@ -1225,12 +1368,17 @@ module Aws::Health
|
|
1225
1368
|
:service,
|
1226
1369
|
:code,
|
1227
1370
|
:category)
|
1371
|
+
SENSITIVE = []
|
1228
1372
|
include Aws::Structure
|
1229
1373
|
end
|
1230
1374
|
|
1231
|
-
# The values to use to filter results from the DescribeEventTypes
|
1375
|
+
# The values to use to filter results from the [DescribeEventTypes][1]
|
1232
1376
|
# operation.
|
1233
1377
|
#
|
1378
|
+
#
|
1379
|
+
#
|
1380
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html
|
1381
|
+
#
|
1234
1382
|
# @note When making an API call, you may pass EventTypeFilter
|
1235
1383
|
# data as a hash:
|
1236
1384
|
#
|
@@ -1260,6 +1408,7 @@ module Aws::Health
|
|
1260
1408
|
:event_type_codes,
|
1261
1409
|
:services,
|
1262
1410
|
:event_type_categories)
|
1411
|
+
SENSITIVE = []
|
1263
1412
|
include Aws::Structure
|
1264
1413
|
end
|
1265
1414
|
|
@@ -1272,13 +1421,18 @@ module Aws::Health
|
|
1272
1421
|
#
|
1273
1422
|
class InvalidPaginationToken < Struct.new(
|
1274
1423
|
:message)
|
1424
|
+
SENSITIVE = []
|
1275
1425
|
include Aws::Structure
|
1276
1426
|
end
|
1277
1427
|
|
1278
1428
|
# Error information returned when a
|
1279
|
-
# DescribeAffectedEntitiesForOrganization operation cannot find or
|
1429
|
+
# [DescribeAffectedEntitiesForOrganization][1] operation cannot find or
|
1280
1430
|
# process a specific entity.
|
1281
1431
|
#
|
1432
|
+
#
|
1433
|
+
#
|
1434
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html
|
1435
|
+
#
|
1282
1436
|
# @!attribute [rw] aws_account_id
|
1283
1437
|
# The 12-digit AWS account numbers that contains the affected
|
1284
1438
|
# entities.
|
@@ -1308,11 +1462,16 @@ module Aws::Health
|
|
1308
1462
|
:event_arn,
|
1309
1463
|
:error_name,
|
1310
1464
|
:error_message)
|
1465
|
+
SENSITIVE = []
|
1311
1466
|
include Aws::Structure
|
1312
1467
|
end
|
1313
1468
|
|
1314
1469
|
# Summary information about an event, returned by the
|
1315
|
-
# DescribeEventsForOrganization operation.
|
1470
|
+
# [DescribeEventsForOrganization][1] operation.
|
1471
|
+
#
|
1472
|
+
#
|
1473
|
+
#
|
1474
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html
|
1316
1475
|
#
|
1317
1476
|
# @!attribute [rw] arn
|
1318
1477
|
# The unique identifier for the event. Format:
|
@@ -1337,6 +1496,20 @@ module Aws::Health
|
|
1337
1496
|
# @return [String]
|
1338
1497
|
#
|
1339
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.
|
1340
1513
|
# @return [String]
|
1341
1514
|
#
|
1342
1515
|
# @!attribute [rw] region
|
@@ -1373,12 +1546,20 @@ module Aws::Health
|
|
1373
1546
|
:end_time,
|
1374
1547
|
:last_updated_time,
|
1375
1548
|
:status_code)
|
1549
|
+
SENSITIVE = []
|
1376
1550
|
include Aws::Structure
|
1377
1551
|
end
|
1378
1552
|
|
1379
|
-
# Detailed information about an event. A combination of an Event
|
1380
|
-
# an EventDescription object, and additional metadata about
|
1381
|
-
# 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
|
1382
1563
|
#
|
1383
1564
|
# @!attribute [rw] aws_account_id
|
1384
1565
|
# The 12-digit AWS account numbers that contains the affected
|
@@ -1387,11 +1568,36 @@ module Aws::Health
|
|
1387
1568
|
#
|
1388
1569
|
# @!attribute [rw] event
|
1389
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
|
1390
1592
|
# @return [Types::Event]
|
1391
1593
|
#
|
1392
1594
|
# @!attribute [rw] event_description
|
1393
1595
|
# The detailed description of the event. Included in the information
|
1394
|
-
# 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
|
1395
1601
|
# @return [Types::EventDescription]
|
1396
1602
|
#
|
1397
1603
|
# @!attribute [rw] event_metadata
|
@@ -1405,16 +1611,26 @@ module Aws::Health
|
|
1405
1611
|
:event,
|
1406
1612
|
:event_description,
|
1407
1613
|
:event_metadata)
|
1614
|
+
SENSITIVE = []
|
1408
1615
|
include Aws::Structure
|
1409
1616
|
end
|
1410
1617
|
|
1411
|
-
# Error information returned when a
|
1412
|
-
# 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
|
1413
1625
|
#
|
1414
1626
|
# @!attribute [rw] aws_account_id
|
1415
1627
|
# Error information returned when a
|
1416
|
-
# DescribeEventDetailsForOrganization operation cannot find a
|
1628
|
+
# [DescribeEventDetailsForOrganization][1] operation cannot find a
|
1417
1629
|
# specified event.
|
1630
|
+
#
|
1631
|
+
#
|
1632
|
+
#
|
1633
|
+
# [1]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html
|
1418
1634
|
# @return [String]
|
1419
1635
|
#
|
1420
1636
|
# @!attribute [rw] event_arn
|
@@ -1439,11 +1655,16 @@ module Aws::Health
|
|
1439
1655
|
:event_arn,
|
1440
1656
|
:error_name,
|
1441
1657
|
:error_message)
|
1658
|
+
SENSITIVE = []
|
1442
1659
|
include Aws::Structure
|
1443
1660
|
end
|
1444
1661
|
|
1445
|
-
# The values to filter results from the
|
1446
|
-
# 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
|
1447
1668
|
#
|
1448
1669
|
# @note When making an API call, you may pass OrganizationEventFilter
|
1449
1670
|
# data as a hash:
|
@@ -1491,37 +1712,52 @@ module Aws::Health
|
|
1491
1712
|
# @return [Array<String>]
|
1492
1713
|
#
|
1493
1714
|
# @!attribute [rw] start_time
|
1494
|
-
# A range of dates and times that is used by the EventFilter and
|
1495
|
-
# EntityFilter objects. If `from` is set and `to` is set: match
|
1496
|
-
# where the timestamp (`startTime`, `endTime`, or
|
1497
|
-
# is between `from` and `to` inclusive. If `from`
|
1498
|
-
# not set: match items where the timestamp value is
|
1499
|
-
# `from`. If `from` is not set and `to` is set:
|
1500
|
-
# 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
|
1501
1727
|
# @return [Types::DateTimeRange]
|
1502
1728
|
#
|
1503
1729
|
# @!attribute [rw] end_time
|
1504
|
-
# A range of dates and times that is used by the EventFilter and
|
1505
|
-
# EntityFilter objects. If `from` is set and `to` is set: match
|
1506
|
-
# where the timestamp (`startTime`, `endTime`, or
|
1507
|
-
# is between `from` and `to` inclusive. If `from`
|
1508
|
-
# not set: match items where the timestamp value is
|
1509
|
-
# `from`. If `from` is not set and `to` is set:
|
1510
|
-
# 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
|
1511
1742
|
# @return [Types::DateTimeRange]
|
1512
1743
|
#
|
1513
1744
|
# @!attribute [rw] last_updated_time
|
1514
|
-
# A range of dates and times that is used by the EventFilter and
|
1515
|
-
# EntityFilter objects. If `from` is set and `to` is set: match
|
1516
|
-
# where the timestamp (`startTime`, `endTime`, or
|
1517
|
-
# is between `from` and `to` inclusive. If `from`
|
1518
|
-
# not set: match items where the timestamp value is
|
1519
|
-
# `from`. If `from` is not set and `to` is set:
|
1520
|
-
# 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
|
1521
1757
|
# @return [Types::DateTimeRange]
|
1522
1758
|
#
|
1523
1759
|
# @!attribute [rw] entity_arns
|
1524
|
-
#
|
1760
|
+
# A list of entity ARNs (unique identifiers).
|
1525
1761
|
# @return [Array<String>]
|
1526
1762
|
#
|
1527
1763
|
# @!attribute [rw] entity_values
|
@@ -1530,7 +1766,8 @@ module Aws::Health
|
|
1530
1766
|
# @return [Array<String>]
|
1531
1767
|
#
|
1532
1768
|
# @!attribute [rw] event_type_categories
|
1533
|
-
#
|
1769
|
+
# A list of event type category codes (issue, scheduledChange, or
|
1770
|
+
# accountNotification).
|
1534
1771
|
# @return [Array<String>]
|
1535
1772
|
#
|
1536
1773
|
# @!attribute [rw] event_status_codes
|
@@ -1551,6 +1788,7 @@ module Aws::Health
|
|
1551
1788
|
:entity_values,
|
1552
1789
|
:event_type_categories,
|
1553
1790
|
:event_status_codes)
|
1791
|
+
SENSITIVE = []
|
1554
1792
|
include Aws::Structure
|
1555
1793
|
end
|
1556
1794
|
|
@@ -1563,6 +1801,7 @@ module Aws::Health
|
|
1563
1801
|
#
|
1564
1802
|
class UnsupportedLocale < Struct.new(
|
1565
1803
|
:message)
|
1804
|
+
SENSITIVE = []
|
1566
1805
|
include Aws::Structure
|
1567
1806
|
end
|
1568
1807
|
|
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.
|
4
|
+
version: 1.31.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-
|
11
|
+
date: 2020-09-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.109.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.109.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|