@aws-sdk/client-health 3.696.0 → 3.699.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.
package/README.md CHANGED
@@ -10,7 +10,7 @@ AWS SDK for JavaScript Health Client for Node.js, Browser and React Native.
10
10
 
11
11
  <p>The Health API provides access to the Health information that appears in the
12
12
  <a href="https://health.aws.amazon.com/health/home">Health Dashboard</a>. You can use
13
- the API operations to get information about events that might affect your Amazon Web Services and resources.</p>
13
+ the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
14
14
  <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health API. If you call the Health API from an
15
15
  Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
16
16
  <code>SubscriptionRequiredException</code> error.</p>
package/dist-cjs/index.js CHANGED
@@ -699,6 +699,7 @@ var de_AffectedEntity = /* @__PURE__ */ __name((output, context) => {
699
699
  return (0, import_smithy_client.take)(output, {
700
700
  awsAccountId: import_smithy_client.expectString,
701
701
  entityArn: import_smithy_client.expectString,
702
+ entityMetadata: import_smithy_client._json,
702
703
  entityUrl: import_smithy_client.expectString,
703
704
  entityValue: import_smithy_client.expectString,
704
705
  eventArn: import_smithy_client.expectString,
@@ -403,6 +403,7 @@ const de_AffectedEntity = (output, context) => {
403
403
  return take(output, {
404
404
  awsAccountId: __expectString,
405
405
  entityArn: __expectString,
406
+ entityMetadata: _json,
406
407
  entityUrl: __expectString,
407
408
  entityValue: __expectString,
408
409
  eventArn: __expectString,
@@ -112,7 +112,7 @@ export interface Health {
112
112
  * <fullname>Health</fullname>
113
113
  * <p>The Health API provides access to the Health information that appears in the
114
114
  * <a href="https://health.aws.amazon.com/health/home">Health Dashboard</a>. You can use
115
- * the API operations to get information about events that might affect your Amazon Web Services and resources.</p>
115
+ * the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
116
116
  * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health API. If you call the Health API from an
117
117
  * Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
118
118
  * <code>SubscriptionRequiredException</code> error.</p>
@@ -168,7 +168,7 @@ export interface HealthClientResolvedConfig extends HealthClientResolvedConfigTy
168
168
  * <fullname>Health</fullname>
169
169
  * <p>The Health API provides access to the Health information that appears in the
170
170
  * <a href="https://health.aws.amazon.com/health/home">Health Dashboard</a>. You can use
171
- * the API operations to get information about events that might affect your Amazon Web Services and resources.</p>
171
+ * the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
172
172
  * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health API. If you call the Health API from an
173
173
  * Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
174
174
  * <code>SubscriptionRequiredException</code> error.</p>
@@ -29,7 +29,7 @@ declare const DescribeAffectedEntitiesCommand_base: {
29
29
  /**
30
30
  * <p>Returns a list of entities that have been affected by the specified events, based on the
31
31
  * specified filter criteria. Entities can refer to individual customer resources, groups of
32
- * customer resources, or any other construct, depending on the Amazon Web Service. Events that
32
+ * customer resources, or any other construct, depending on the Amazon Web Services service. Events that
33
33
  * have impact beyond that of the affected entities, or where the extent of impact is unknown,
34
34
  * include at least one entity indicating this.</p>
35
35
  * <p>At least one event ARN is required.</p>
@@ -95,6 +95,9 @@ declare const DescribeAffectedEntitiesCommand_base: {
95
95
  * // tags: { // tagSet
96
96
  * // "<keys>": "STRING_VALUE",
97
97
  * // },
98
+ * // entityMetadata: { // entityMetadata
99
+ * // "<keys>": "STRING_VALUE",
100
+ * // },
98
101
  * // },
99
102
  * // ],
100
103
  * // nextToken: "STRING_VALUE",
@@ -30,7 +30,7 @@ declare const DescribeAffectedEntitiesForOrganizationCommand_base: {
30
30
  * <p>Returns a list of entities that have been affected by one or more events for one or more
31
31
  * accounts in your organization in Organizations, based on the filter criteria. Entities can refer
32
32
  * to individual customer resources, groups of customer resources, or any other construct,
33
- * depending on the Amazon Web Service.</p>
33
+ * depending on the Amazon Web Services service.</p>
34
34
  * <p>At least one event Amazon Resource Name (ARN) and account ID are required.</p>
35
35
  * <p>Before you can call this operation, you must first enable Health to work with
36
36
  * Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> operation from your organization's
@@ -87,6 +87,9 @@ declare const DescribeAffectedEntitiesForOrganizationCommand_base: {
87
87
  * // tags: { // tagSet
88
88
  * // "<keys>": "STRING_VALUE",
89
89
  * // },
90
+ * // entityMetadata: { // entityMetadata
91
+ * // "<keys>": "STRING_VALUE",
92
+ * // },
90
93
  * // },
91
94
  * // ],
92
95
  * // failedSet: [ // DescribeAffectedEntitiesForOrganizationFailedSet
@@ -28,7 +28,7 @@ declare const DescribeEventTypesCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Returns the event types that meet the specified filter criteria. You can use this API
31
- * operation to find information about the Health event, such as the category, Amazon Web Service, and event code. The metadata for each event appears in the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html">EventType</a> object. </p>
31
+ * operation to find information about the Health event, such as the category, Amazon Web Services service, and event code. The metadata for each event appears in the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html">EventType</a> object. </p>
32
32
  * <p>If you don't specify a filter criteria, the API operation returns all event types, in no
33
33
  * particular order. </p>
34
34
  * <note>
@@ -2,7 +2,7 @@
2
2
  * <fullname>Health</fullname>
3
3
  * <p>The Health API provides access to the Health information that appears in the
4
4
  * <a href="https://health.aws.amazon.com/health/home">Health Dashboard</a>. You can use
5
- * the API operations to get information about events that might affect your Amazon Web Services and resources.</p>
5
+ * the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
6
6
  * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health API. If you call the Health API from an
7
7
  * Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
8
8
  * <code>SubscriptionRequiredException</code> error.</p>
@@ -94,6 +94,11 @@ export interface AffectedEntity {
94
94
  * @public
95
95
  */
96
96
  tags?: Record<string, string> | undefined;
97
+ /**
98
+ * <p>Additional metadata about the affected entity.</p>
99
+ * @public
100
+ */
101
+ entityMetadata?: Record<string, string> | undefined;
97
102
  }
98
103
  /**
99
104
  * @public
@@ -148,7 +153,7 @@ export interface DescribeAffectedAccountsForOrganizationResponse {
148
153
  */
149
154
  affectedAccounts?: string[] | undefined;
150
155
  /**
151
- * <p>This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.</p>
156
+ * <p>This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.</p>
152
157
  * <ul>
153
158
  * <li>
154
159
  * <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the
@@ -624,7 +629,7 @@ export interface EventFilter {
624
629
  */
625
630
  eventTypeCodes?: string[] | undefined;
626
631
  /**
627
- * <p>The Amazon Web Services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
632
+ * <p>The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
628
633
  * @public
629
634
  */
630
635
  services?: string[] | undefined;
@@ -828,7 +833,7 @@ export interface Event {
828
833
  */
829
834
  arn?: string | undefined;
830
835
  /**
831
- * <p>The Amazon Web Service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
836
+ * <p>The Amazon Web Services service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
832
837
  * @public
833
838
  */
834
839
  service?: string | undefined;
@@ -877,7 +882,7 @@ export interface Event {
877
882
  */
878
883
  statusCode?: EventStatusCode | undefined;
879
884
  /**
880
- * <p>This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.</p>
885
+ * <p>This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.</p>
881
886
  * <ul>
882
887
  * <li>
883
888
  * <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the
@@ -1138,7 +1143,7 @@ export interface OrganizationEventFilter {
1138
1143
  */
1139
1144
  awsAccountIds?: string[] | undefined;
1140
1145
  /**
1141
- * <p>The Amazon Web Services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1146
+ * <p>The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1142
1147
  * @public
1143
1148
  */
1144
1149
  services?: string[] | undefined;
@@ -1249,7 +1254,7 @@ export interface OrganizationEvent {
1249
1254
  */
1250
1255
  arn?: string | undefined;
1251
1256
  /**
1252
- * <p>The Amazon Web Service that is affected by the event, such as EC2 and RDS.</p>
1257
+ * <p>The Amazon Web Services service that is affected by the event, such as EC2 and RDS.</p>
1253
1258
  * @public
1254
1259
  */
1255
1260
  service?: string | undefined;
@@ -1268,7 +1273,7 @@ export interface OrganizationEvent {
1268
1273
  */
1269
1274
  eventTypeCategory?: EventTypeCategory | undefined;
1270
1275
  /**
1271
- * <p>This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.</p>
1276
+ * <p>This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.</p>
1272
1277
  * <ul>
1273
1278
  * <li>
1274
1279
  * <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the
@@ -1347,7 +1352,7 @@ export interface EventTypeFilter {
1347
1352
  */
1348
1353
  eventTypeCodes?: string[] | undefined;
1349
1354
  /**
1350
- * <p>The Amazon Web Services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1355
+ * <p>The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1351
1356
  * @public
1352
1357
  */
1353
1358
  services?: string[] | undefined;
@@ -1406,7 +1411,7 @@ export interface DescribeEventTypesRequest {
1406
1411
  */
1407
1412
  export interface EventType {
1408
1413
  /**
1409
- * <p>The Amazon Web Service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1414
+ * <p>The Amazon Web Services service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1410
1415
  * @public
1411
1416
  */
1412
1417
  service?: string | undefined;
@@ -23,6 +23,7 @@ export interface AffectedEntity {
23
23
  lastUpdatedTime?: Date | undefined;
24
24
  statusCode?: EntityStatusCode | undefined;
25
25
  tags?: Record<string, string> | undefined;
26
+ entityMetadata?: Record<string, string> | undefined;
26
27
  }
27
28
  export interface DescribeAffectedAccountsForOrganizationRequest {
28
29
  eventArn: string | undefined;
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.696.0",
4
+ "version": "3.699.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-health",
@@ -20,10 +20,10 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/client-sso-oidc": "3.696.0",
24
- "@aws-sdk/client-sts": "3.696.0",
23
+ "@aws-sdk/client-sso-oidc": "3.699.0",
24
+ "@aws-sdk/client-sts": "3.699.0",
25
25
  "@aws-sdk/core": "3.696.0",
26
- "@aws-sdk/credential-provider-node": "3.696.0",
26
+ "@aws-sdk/credential-provider-node": "3.699.0",
27
27
  "@aws-sdk/middleware-host-header": "3.696.0",
28
28
  "@aws-sdk/middleware-logger": "3.696.0",
29
29
  "@aws-sdk/middleware-recursion-detection": "3.696.0",