Skip to content

Commit b98d358

Browse files
author
awstools
committed
feat(client-health): Adds metadata property to an AffectedEntity.
1 parent dc03b5b commit b98d358

File tree

10 files changed

+77
-29
lines changed

10 files changed

+77
-29
lines changed

Diff for: ‎clients/client-health/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ AWS SDK for JavaScript Health Client for Node.js, Browser and React Native.
1010

1111
<p>The Health API provides access to the Health information that appears in the
1212
<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>
1414
<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
1515
Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
1616
<code>SubscriptionRequiredException</code> error.</p>

Diff for: ‎clients/client-health/src/Health.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ export interface Health {
340340
* <fullname>Health</fullname>
341341
* <p>The Health API provides access to the Health information that appears in the
342342
* <a href="https://health.aws.amazon.com/health/home">Health Dashboard</a>. You can use
343-
* the API operations to get information about events that might affect your Amazon Web Services and resources.</p>
343+
* the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
344344
* <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
345345
* Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
346346
* <code>SubscriptionRequiredException</code> error.</p>

Diff for: ‎clients/client-health/src/HealthClient.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ export interface HealthClientResolvedConfig extends HealthClientResolvedConfigTy
327327
* <fullname>Health</fullname>
328328
* <p>The Health API provides access to the Health information that appears in the
329329
* <a href="https://health.aws.amazon.com/health/home">Health Dashboard</a>. You can use
330-
* the API operations to get information about events that might affect your Amazon Web Services and resources.</p>
330+
* the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
331331
* <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
332332
* Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
333333
* <code>SubscriptionRequiredException</code> error.</p>

Diff for: ‎clients/client-health/src/commands/DescribeAffectedEntitiesCommand.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE
3030
/**
3131
* <p>Returns a list of entities that have been affected by the specified events, based on the
3232
* specified filter criteria. Entities can refer to individual customer resources, groups of
33-
* customer resources, or any other construct, depending on the Amazon Web Service. Events that
33+
* customer resources, or any other construct, depending on the Amazon Web Services service. Events that
3434
* have impact beyond that of the affected entities, or where the extent of impact is unknown,
3535
* include at least one entity indicating this.</p>
3636
* <p>At least one event ARN is required.</p>
@@ -96,6 +96,9 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE
9696
* // tags: { // tagSet
9797
* // "<keys>": "STRING_VALUE",
9898
* // },
99+
* // entityMetadata: { // entityMetadata
100+
* // "<keys>": "STRING_VALUE",
101+
* // },
99102
* // },
100103
* // ],
101104
* // nextToken: "STRING_VALUE",

Diff for: ‎clients/client-health/src/commands/DescribeAffectedEntitiesForOrganizationCommand.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export interface DescribeAffectedEntitiesForOrganizationCommandOutput
4040
* <p>Returns a list of entities that have been affected by one or more events for one or more
4141
* accounts in your organization in Organizations, based on the filter criteria. Entities can refer
4242
* to individual customer resources, groups of customer resources, or any other construct,
43-
* depending on the Amazon Web Service.</p>
43+
* depending on the Amazon Web Services service.</p>
4444
* <p>At least one event Amazon Resource Name (ARN) and account ID are required.</p>
4545
* <p>Before you can call this operation, you must first enable Health to work with
4646
* 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
@@ -97,6 +97,9 @@ export interface DescribeAffectedEntitiesForOrganizationCommandOutput
9797
* // tags: { // tagSet
9898
* // "<keys>": "STRING_VALUE",
9999
* // },
100+
* // entityMetadata: { // entityMetadata
101+
* // "<keys>": "STRING_VALUE",
102+
* // },
100103
* // },
101104
* // ],
102105
* // failedSet: [ // DescribeAffectedEntitiesForOrganizationFailedSet

Diff for: ‎clients/client-health/src/commands/DescribeEventTypesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface DescribeEventTypesCommandOutput extends DescribeEventTypesRespo
2929

3030
/**
3131
* <p>Returns the event types that meet the specified filter criteria. You can use this API
32-
* 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>
32+
* 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>
3333
* <p>If you don't specify a filter criteria, the API operation returns all event types, in no
3434
* particular order. </p>
3535
* <note>

Diff for: ‎clients/client-health/src/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* <fullname>Health</fullname>
55
* <p>The Health API provides access to the Health information that appears in the
66
* <a href="https://health.aws.amazon.com/health/home">Health Dashboard</a>. You can use
7-
* the API operations to get information about events that might affect your Amazon Web Services and resources.</p>
7+
* the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
88
* <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
99
* Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
1010
* <code>SubscriptionRequiredException</code> error.</p>

Diff for: ‎clients/client-health/src/models/models_0.ts

+15-9
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,12 @@ export interface AffectedEntity {
109109
* @public
110110
*/
111111
tags?: Record<string, string> | undefined;
112+
113+
/**
114+
* <p>Additional metadata about the affected entity.</p>
115+
* @public
116+
*/
117+
entityMetadata?: Record<string, string> | undefined;
112118
}
113119

114120
/**
@@ -170,7 +176,7 @@ export interface DescribeAffectedAccountsForOrganizationResponse {
170176
affectedAccounts?: string[] | undefined;
171177

172178
/**
173-
* <p>This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.</p>
179+
* <p>This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.</p>
174180
* <ul>
175181
* <li>
176182
* <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the
@@ -715,7 +721,7 @@ export interface EventFilter {
715721
eventTypeCodes?: string[] | undefined;
716722

717723
/**
718-
* <p>The Amazon Web Services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
724+
* <p>The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
719725
* @public
720726
*/
721727
services?: string[] | undefined;
@@ -944,7 +950,7 @@ export interface Event {
944950
arn?: string | undefined;
945951

946952
/**
947-
* <p>The Amazon Web Service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
953+
* <p>The Amazon Web Services service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
948954
* @public
949955
*/
950956
service?: string | undefined;
@@ -1002,7 +1008,7 @@ export interface Event {
10021008
statusCode?: EventStatusCode | undefined;
10031009

10041010
/**
1005-
* <p>This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.</p>
1011+
* <p>This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.</p>
10061012
* <ul>
10071013
* <li>
10081014
* <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the
@@ -1290,7 +1296,7 @@ export interface OrganizationEventFilter {
12901296
awsAccountIds?: string[] | undefined;
12911297

12921298
/**
1293-
* <p>The Amazon Web Services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1299+
* <p>The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
12941300
* @public
12951301
*/
12961302
services?: string[] | undefined;
@@ -1415,7 +1421,7 @@ export interface OrganizationEvent {
14151421
arn?: string | undefined;
14161422

14171423
/**
1418-
* <p>The Amazon Web Service that is affected by the event, such as EC2 and RDS.</p>
1424+
* <p>The Amazon Web Services service that is affected by the event, such as EC2 and RDS.</p>
14191425
* @public
14201426
*/
14211427
service?: string | undefined;
@@ -1437,7 +1443,7 @@ export interface OrganizationEvent {
14371443
eventTypeCategory?: EventTypeCategory | undefined;
14381444

14391445
/**
1440-
* <p>This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.</p>
1446+
* <p>This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.</p>
14411447
* <ul>
14421448
* <li>
14431449
* <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the
@@ -1525,7 +1531,7 @@ export interface EventTypeFilter {
15251531
eventTypeCodes?: string[] | undefined;
15261532

15271533
/**
1528-
* <p>The Amazon Web Services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1534+
* <p>The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
15291535
* @public
15301536
*/
15311537
services?: string[] | undefined;
@@ -1590,7 +1596,7 @@ export interface DescribeEventTypesRequest {
15901596
*/
15911597
export interface EventType {
15921598
/**
1593-
* <p>The Amazon Web Service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1599+
* <p>The Amazon Web Services service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
15941600
* @public
15951601
*/
15961602
service?: string | undefined;

Diff for: ‎clients/client-health/src/protocols/Aws_json1_1.ts

+3
Original file line numberDiff line numberDiff line change
@@ -836,6 +836,7 @@ const de_AffectedEntity = (output: any, context: __SerdeContext): AffectedEntity
836836
return take(output, {
837837
awsAccountId: __expectString,
838838
entityArn: __expectString,
839+
entityMetadata: _json,
839840
entityUrl: __expectString,
840841
entityValue: __expectString,
841842
eventArn: __expectString,
@@ -981,6 +982,8 @@ const de_EntityList = (output: any, context: __SerdeContext): AffectedEntity[] =
981982
return retVal;
982983
};
983984

985+
// de_entityMetadata omitted.
986+
984987
// de_entityStatuses omitted.
985988

986989
/**

0 commit comments

Comments
 (0)