@aws-sdk/client-health 3.40.0 → 3.45.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -34,7 +34,7 @@ export interface AffectedEntity {
34
34
  */
35
35
  entityUrl?: string;
36
36
  /**
37
- * <p>The 12-digit AWS account number that contains the affected entity.</p>
37
+ * <p>The 12-digit Amazon Web Services account number that contains the affected entity.</p>
38
38
  */
39
39
  awsAccountId?: string;
40
40
  /**
@@ -103,7 +103,7 @@ export interface DescribeAffectedAccountsForOrganizationResponse {
103
103
  */
104
104
  affectedAccounts?: string[];
105
105
  /**
106
- * <p>This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event.</p>
106
+ * <p>This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.</p>
107
107
  * <ul>
108
108
  * <li>
109
109
  * <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the
@@ -111,9 +111,9 @@ export interface DescribeAffectedAccountsForOrganizationResponse {
111
111
  * </li>
112
112
  * <li>
113
113
  * <p>If the <code>eventScopeCode</code> value is <code>ACCOUNT_SPECIFIC</code>, then
114
- * the <code>affectedAccounts</code> value lists the affected AWS accounts in your
114
+ * the <code>affectedAccounts</code> value lists the affected Amazon Web Services accounts in your
115
115
  * organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you
116
- * have AWS accounts that use that service, those account IDs appear in the
116
+ * have Amazon Web Services accounts that use that service, those account IDs appear in the
117
117
  * response.</p>
118
118
  * </li>
119
119
  * <li>
@@ -178,8 +178,7 @@ export declare namespace DateTimeRange {
178
178
  const filterSensitiveLog: (obj: DateTimeRange) => any;
179
179
  }
180
180
  /**
181
- * <p>The values to use to filter results from the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html">EntityFilter</a>
182
- * operation.</p>
181
+ * <p>The values to use to filter results from the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html">DescribeAffectedEntities</a> operation.</p>
183
182
  */
184
183
  export interface EntityFilter {
185
184
  /**
@@ -296,7 +295,7 @@ export interface EventAccountFilter {
296
295
  */
297
296
  eventArn: string | undefined;
298
297
  /**
299
- * <p>The 12-digit AWS account numbers that contains the affected entities.</p>
298
+ * <p>The 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
300
299
  */
301
300
  awsAccountId?: string;
302
301
  }
@@ -340,7 +339,7 @@ export declare namespace DescribeAffectedEntitiesForOrganizationRequest {
340
339
  */
341
340
  export interface OrganizationAffectedEntitiesErrorItem {
342
341
  /**
343
- * <p>The 12-digit AWS account numbers that contains the affected entities.</p>
342
+ * <p>The 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
344
343
  */
345
344
  awsAccountId?: string;
346
345
  /**
@@ -478,15 +477,15 @@ export interface EventFilter {
478
477
  */
479
478
  eventTypeCodes?: string[];
480
479
  /**
481
- * <p>The AWS services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
480
+ * <p>The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
482
481
  */
483
482
  services?: string[];
484
483
  /**
485
- * <p>A list of AWS Regions.</p>
484
+ * <p>A list of Amazon Web Services Regions.</p>
486
485
  */
487
486
  regions?: string[];
488
487
  /**
489
- * <p>A list of AWS Availability Zones.</p>
488
+ * <p>A list of Amazon Web Services Availability Zones.</p>
490
489
  */
491
490
  availabilityZones?: string[];
492
491
  /**
@@ -511,8 +510,9 @@ export interface EventFilter {
511
510
  */
512
511
  entityValues?: string[];
513
512
  /**
514
- * <p>A list of event type category codes (<code>issue</code>, <code>scheduledChange</code>,
515
- * or <code>accountNotification</code>).</p>
513
+ * <p>A list of event type category codes. Possible values are
514
+ * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
515
+ * the <code>investigation</code> value isn't supported at this time.</p>
516
516
  */
517
517
  eventTypeCategories?: (EventTypeCategory | string)[];
518
518
  /**
@@ -648,22 +648,22 @@ export declare namespace EventDetailsErrorItem {
648
648
  const filterSensitiveLog: (obj: EventDetailsErrorItem) => any;
649
649
  }
650
650
  /**
651
- * <p>Summary information about an AWS Health event.</p>
652
- * <p>AWS Health events can be public or account-specific:</p>
651
+ * <p>Summary information about an Health event.</p>
652
+ * <p>Health events can be public or account-specific:</p>
653
653
  * <ul>
654
654
  * <li>
655
655
  * <p>
656
656
  * <i>Public events</i> might be service events that are not specific
657
- * to an AWS account. For example, if there is an issue with an AWS Region,
658
- * AWS Health provides information about the event, even if you don't use services or
657
+ * to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region,
658
+ * Health provides information about the event, even if you don't use services or
659
659
  * resources in that Region.</p>
660
660
  * </li>
661
661
  * <li>
662
662
  * <p>
663
- * <i>Account-specific</i> events are specific to either your AWS
664
- * account or an account in your organization. For example, if there's an issue with
665
- * Amazon Elastic Compute Cloud in a Region that you use, AWS Health provides information about the event
666
- * and the affected resources in the account.</p>
663
+ * <i>Account-specific</i> events are specific to either your
664
+ * Amazon Web Services account or an account in your organization. For example, if there's an issue
665
+ * with Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the
666
+ * event and the affected resources in the account.</p>
667
667
  * </li>
668
668
  * </ul>
669
669
  * <p>You can determine if an event is public or account-specific by using the
@@ -682,7 +682,7 @@ export interface Event {
682
682
  */
683
683
  arn?: string;
684
684
  /**
685
- * <p>The AWS service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
685
+ * <p>The Amazon Web Services service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
686
686
  */
687
687
  service?: string;
688
688
  /**
@@ -691,16 +691,17 @@ export interface Event {
691
691
  */
692
692
  eventTypeCode?: string;
693
693
  /**
694
- * <p>The category of the event. Possible values are <code>issue</code>,
695
- * <code>scheduledChange</code>, and <code>accountNotification</code>.</p>
694
+ * <p>A list of event type category codes. Possible values are
695
+ * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
696
+ * the <code>investigation</code> value isn't supported at this time.</p>
696
697
  */
697
698
  eventTypeCategory?: EventTypeCategory | string;
698
699
  /**
699
- * <p>The AWS Region name of the event.</p>
700
+ * <p>The Amazon Web Services Region name of the event.</p>
700
701
  */
701
702
  region?: string;
702
703
  /**
703
- * <p>The AWS Availability Zone of the event. For example, us-east-1a.</p>
704
+ * <p>The Amazon Web Services Availability Zone of the event. For example, us-east-1a.</p>
704
705
  */
705
706
  availabilityZone?: string;
706
707
  /**
@@ -721,7 +722,7 @@ export interface Event {
721
722
  */
722
723
  statusCode?: EventStatusCode | string;
723
724
  /**
724
- * <p>This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event.</p>
725
+ * <p>This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.</p>
725
726
  * <ul>
726
727
  * <li>
727
728
  * <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the
@@ -729,9 +730,9 @@ export interface Event {
729
730
  * </li>
730
731
  * <li>
731
732
  * <p>If the <code>eventScopeCode</code> value is <code>ACCOUNT_SPECIFIC</code>, then
732
- * the <code>affectedAccounts</code> value lists the affected AWS accounts in your
733
+ * the <code>affectedAccounts</code> value lists the affected Amazon Web Services accounts in your
733
734
  * organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you
734
- * have AWS accounts that use that service, those account IDs appear in the
735
+ * have Amazon Web Services accounts that use that service, those account IDs appear in the
735
736
  * response.</p>
736
737
  * </li>
737
738
  * <li>
@@ -851,17 +852,17 @@ export interface OrganizationEventDetailsErrorItem {
851
852
  errorName?: string;
852
853
  /**
853
854
  * <p>A message that describes the error.</p>
854
- * <p>If you call the <code>DescribeEventDetailsForOrganization</code>
855
- * operation and receive one of the following errors, follow the recommendations in the message:</p>
855
+ * <p>If you call the <code>DescribeEventDetailsForOrganization</code> operation and receive one of the following errors, follow the recommendations in the message:</p>
856
856
  * <ul>
857
857
  * <li>
858
- * <p>We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an AWS account ID in the request.</p>
858
+ * <p>We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an Amazon Web Services account ID in the request.</p>
859
859
  * </li>
860
860
  * <li>
861
- * <p>We couldn't find an account specific event for the specified AWS account. To find an event that is public, you must enter a null value for the AWS account ID in the request.</p>
861
+ * <p>We couldn't find an account specific event for the specified Amazon Web Services account. To find an event that is public, you must enter a null value for the Amazon Web Services account ID in the request.</p>
862
862
  * </li>
863
863
  * <li>
864
- * <p>Your AWS account doesn't include the AWS Support plan required to use the AWS Health API. You must have either a Business or Enterprise Support plan.</p>
864
+ * <p>Your Amazon Web Services account doesn't include the Amazon Web Services Support plan required to use the
865
+ * Health API. You must have either a Business, Enterprise On-Ramp, or Enterprise Support plan.</p>
865
866
  * </li>
866
867
  * </ul>
867
868
  */
@@ -879,26 +880,26 @@ export declare namespace OrganizationEventDetailsErrorItem {
879
880
  */
880
881
  export interface OrganizationEventDetails {
881
882
  /**
882
- * <p>The 12-digit AWS account numbers that contains the affected entities.</p>
883
+ * <p>The 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
883
884
  */
884
885
  awsAccountId?: string;
885
886
  /**
886
- * <p>Summary information about an AWS Health event.</p>
887
- * <p>AWS Health events can be public or account-specific:</p>
887
+ * <p>Summary information about an Health event.</p>
888
+ * <p>Health events can be public or account-specific:</p>
888
889
  * <ul>
889
890
  * <li>
890
891
  * <p>
891
892
  * <i>Public events</i> might be service events that are not specific
892
- * to an AWS account. For example, if there is an issue with an AWS Region,
893
- * AWS Health provides information about the event, even if you don't use services or
893
+ * to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region,
894
+ * Health provides information about the event, even if you don't use services or
894
895
  * resources in that Region.</p>
895
896
  * </li>
896
897
  * <li>
897
898
  * <p>
898
- * <i>Account-specific</i> events are specific to either your AWS
899
- * account or an account in your organization. For example, if there's an issue with
900
- * Amazon Elastic Compute Cloud in a Region that you use, AWS Health provides information about the event
901
- * and the affected resources in the account.</p>
899
+ * <i>Account-specific</i> events are specific to either your
900
+ * Amazon Web Services account or an account in your organization. For example, if there's an issue
901
+ * with Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the
902
+ * event and the affected resources in the account.</p>
902
903
  * </li>
903
904
  * </ul>
904
905
  * <p>You can determine if an event is public or account-specific by using the
@@ -995,15 +996,15 @@ export interface OrganizationEventFilter {
995
996
  */
996
997
  eventTypeCodes?: string[];
997
998
  /**
998
- * <p>A list of 12-digit AWS account numbers that contains the affected entities.</p>
999
+ * <p>A list of 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
999
1000
  */
1000
1001
  awsAccountIds?: string[];
1001
1002
  /**
1002
- * <p>The AWS services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1003
+ * <p>The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1003
1004
  */
1004
1005
  services?: string[];
1005
1006
  /**
1006
- * <p>A list of AWS Regions.</p>
1007
+ * <p>A list of Amazon Web Services Regions.</p>
1007
1008
  */
1008
1009
  regions?: string[];
1009
1010
  /**
@@ -1045,7 +1046,9 @@ export interface OrganizationEventFilter {
1045
1046
  */
1046
1047
  entityValues?: string[];
1047
1048
  /**
1048
- * <p>A list of event type category codes (issue, scheduledChange, or accountNotification).</p>
1049
+ * <p>A list of event type category codes. Possible values are
1050
+ * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
1051
+ * the <code>investigation</code> value isn't supported at this time.</p>
1049
1052
  */
1050
1053
  eventTypeCategories?: (EventTypeCategory | string)[];
1051
1054
  /**
@@ -1102,7 +1105,7 @@ export interface OrganizationEvent {
1102
1105
  */
1103
1106
  arn?: string;
1104
1107
  /**
1105
- * <p>The AWS service that is affected by the event, such as EC2 and RDS.</p>
1108
+ * <p>The Amazon Web Services service that is affected by the event, such as EC2 and RDS.</p>
1106
1109
  */
1107
1110
  service?: string;
1108
1111
  /**
@@ -1112,11 +1115,13 @@ export interface OrganizationEvent {
1112
1115
  */
1113
1116
  eventTypeCode?: string;
1114
1117
  /**
1115
- * <p>The category of the event type.</p>
1118
+ * <p>A list of event type category codes. Possible values are
1119
+ * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
1120
+ * the <code>investigation</code> value isn't supported at this time.</p>
1116
1121
  */
1117
1122
  eventTypeCategory?: EventTypeCategory | string;
1118
1123
  /**
1119
- * <p>This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event.</p>
1124
+ * <p>This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.</p>
1120
1125
  * <ul>
1121
1126
  * <li>
1122
1127
  * <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the
@@ -1124,9 +1129,9 @@ export interface OrganizationEvent {
1124
1129
  * </li>
1125
1130
  * <li>
1126
1131
  * <p>If the <code>eventScopeCode</code> value is <code>ACCOUNT_SPECIFIC</code>, then
1127
- * the <code>affectedAccounts</code> value lists the affected AWS accounts in your
1132
+ * the <code>affectedAccounts</code> value lists the affected Amazon Web Services accounts in your
1128
1133
  * organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you
1129
- * have AWS accounts that use that service, those account IDs appear in the
1134
+ * have Amazon Web Services accounts that use that service, those account IDs appear in the
1130
1135
  * response.</p>
1131
1136
  * </li>
1132
1137
  * <li>
@@ -1138,7 +1143,7 @@ export interface OrganizationEvent {
1138
1143
  */
1139
1144
  eventScopeCode?: EventScopeCode | string;
1140
1145
  /**
1141
- * <p>The AWS Region name of the event.</p>
1146
+ * <p>The Amazon Web Services Region name of the event.</p>
1142
1147
  */
1143
1148
  region?: string;
1144
1149
  /**
@@ -1194,12 +1199,13 @@ export interface EventTypeFilter {
1194
1199
  */
1195
1200
  eventTypeCodes?: string[];
1196
1201
  /**
1197
- * <p>The AWS services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1202
+ * <p>The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1198
1203
  */
1199
1204
  services?: string[];
1200
1205
  /**
1201
- * <p>A list of event type category codes (<code>issue</code>, <code>scheduledChange</code>,
1202
- * or <code>accountNotification</code>).</p>
1206
+ * <p>A list of event type category codes. Possible values are
1207
+ * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
1208
+ * the <code>investigation</code> value isn't supported at this time.</p>
1203
1209
  */
1204
1210
  eventTypeCategories?: (EventTypeCategory | string)[];
1205
1211
  }
@@ -1237,20 +1243,20 @@ export declare namespace DescribeEventTypesRequest {
1237
1243
  const filterSensitiveLog: (obj: DescribeEventTypesRequest) => any;
1238
1244
  }
1239
1245
  /**
1240
- * <p>Contains the metadata about a type of event that is reported by AWS Health. The
1246
+ * <p>Contains the metadata about a type of event that is reported by Health. The
1241
1247
  * <code>EventType</code> shows the category, service, and the event type code of the
1242
1248
  * event. For example, an <code>issue</code> might be the category, <code>EC2</code> the
1243
1249
  * service, and <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code> the event type code.</p>
1244
1250
  * <p>You can use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html">DescribeEventTypes</a> API operation to return this information
1245
1251
  * about an event.</p>
1246
1252
  * <p>You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or
1247
- * take action when AWS Health delivers a specific event to your AWS account. For more
1248
- * information, see <a href="https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html">Monitor for AWS Health events with Amazon CloudWatch Events</a> in the
1249
- * <i>AWS Health User Guide</i>.</p>
1253
+ * take action when Health delivers a specific event to your Amazon Web Services account. For more
1254
+ * information, see <a href="https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html">Monitor for Health events with Amazon CloudWatch Events</a> in the
1255
+ * <i>Health User Guide</i>.</p>
1250
1256
  */
1251
1257
  export interface EventType {
1252
1258
  /**
1253
- * <p>The AWS service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1259
+ * <p>The Amazon Web Services service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1254
1260
  */
1255
1261
  service?: string;
1256
1262
  /**
@@ -1259,8 +1265,9 @@ export interface EventType {
1259
1265
  */
1260
1266
  code?: string;
1261
1267
  /**
1262
- * <p>A list of event type category codes (<code>issue</code>, <code>scheduledChange</code>,
1263
- * or <code>accountNotification</code>).</p>
1268
+ * <p>A list of event type category codes. Possible values are
1269
+ * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
1270
+ * the <code>investigation</code> value isn't supported at this time.</p>
1264
1271
  */
1265
1272
  category?: EventTypeCategory | string;
1266
1273
  }
@@ -1297,8 +1304,8 @@ export declare namespace DescribeEventTypesResponse {
1297
1304
  }
1298
1305
  export interface DescribeHealthServiceStatusForOrganizationResponse {
1299
1306
  /**
1300
- * <p>Information about the status of enabling or disabling AWS Health Organizational View in
1301
- * your organization.</p>
1307
+ * <p>Information about the status of enabling or disabling the Health organizational
1308
+ * view feature in your organization.</p>
1302
1309
  * <p>Valid values are <code>ENABLED | DISABLED | PENDING</code>. </p>
1303
1310
  */
1304
1311
  healthServiceAccessStatusForOrganization?: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-health",
3
3
  "description": "AWS SDK for JavaScript Health Client for Node.js, Browser and React Native",
4
- "version": "3.40.0",
4
+ "version": "3.45.0",
5
5
  "scripts": {
6
6
  "build": "yarn build:cjs && yarn build:es && yarn build:types",
7
7
  "build:cjs": "tsc -p tsconfig.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "2.0.0",
23
23
  "@aws-crypto/sha256-js": "2.0.0",
24
- "@aws-sdk/client-sts": "3.40.0",
25
- "@aws-sdk/config-resolver": "3.40.0",
26
- "@aws-sdk/credential-provider-node": "3.40.0",
24
+ "@aws-sdk/client-sts": "3.45.0",
25
+ "@aws-sdk/config-resolver": "3.45.0",
26
+ "@aws-sdk/credential-provider-node": "3.45.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.40.0",
28
28
  "@aws-sdk/hash-node": "3.40.0",
29
29
  "@aws-sdk/invalid-dependency": "3.40.0",
@@ -32,13 +32,13 @@
32
32
  "@aws-sdk/middleware-logger": "3.40.0",
33
33
  "@aws-sdk/middleware-retry": "3.40.0",
34
34
  "@aws-sdk/middleware-serde": "3.40.0",
35
- "@aws-sdk/middleware-signing": "3.40.0",
35
+ "@aws-sdk/middleware-signing": "3.45.0",
36
36
  "@aws-sdk/middleware-stack": "3.40.0",
37
37
  "@aws-sdk/middleware-user-agent": "3.40.0",
38
38
  "@aws-sdk/node-config-provider": "3.40.0",
39
39
  "@aws-sdk/node-http-handler": "3.40.0",
40
40
  "@aws-sdk/protocol-http": "3.40.0",
41
- "@aws-sdk/smithy-client": "3.40.0",
41
+ "@aws-sdk/smithy-client": "3.41.0",
42
42
  "@aws-sdk/types": "3.40.0",
43
43
  "@aws-sdk/url-parser": "3.40.0",
44
44
  "@aws-sdk/util-base64-browser": "3.37.0",