Skip to content

Commit

Permalink
feat(client-health): Adds metadata property to an AffectedEntity.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Nov 21, 2024
1 parent dc03b5b commit b98d358
Show file tree
Hide file tree
Showing 10 changed files with 77 additions and 29 deletions.
2 changes: 1 addition & 1 deletion clients/client-health/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ AWS SDK for JavaScript Health Client for Node.js, Browser and React Native.

<p>The Health API provides access to the Health information that appears in the
<a href="https://health.aws.amazon.com/health/home">Health Dashboard</a>. You can use
the API operations to get information about events that might affect your Amazon Web Services and resources.</p>
the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
<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
Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
<code>SubscriptionRequiredException</code> error.</p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-health/src/Health.ts
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ export interface Health {
* <fullname>Health</fullname>
* <p>The Health API provides access to the Health information that appears in the
* <a href="https://health.aws.amazon.com/health/home">Health Dashboard</a>. You can use
* the API operations to get information about events that might affect your Amazon Web Services and resources.</p>
* the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
* <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
* Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
* <code>SubscriptionRequiredException</code> error.</p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-health/src/HealthClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ export interface HealthClientResolvedConfig extends HealthClientResolvedConfigTy
* <fullname>Health</fullname>
* <p>The Health API provides access to the Health information that appears in the
* <a href="https://health.aws.amazon.com/health/home">Health Dashboard</a>. You can use
* the API operations to get information about events that might affect your Amazon Web Services and resources.</p>
* the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
* <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
* Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
* <code>SubscriptionRequiredException</code> error.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE
/**
* <p>Returns a list of entities that have been affected by the specified events, based on the
* specified filter criteria. Entities can refer to individual customer resources, groups of
* customer resources, or any other construct, depending on the Amazon Web Service. Events that
* customer resources, or any other construct, depending on the Amazon Web Services service. Events that
* have impact beyond that of the affected entities, or where the extent of impact is unknown,
* include at least one entity indicating this.</p>
* <p>At least one event ARN is required.</p>
Expand Down Expand Up @@ -96,6 +96,9 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE
* // tags: { // tagSet
* // "<keys>": "STRING_VALUE",
* // },
* // entityMetadata: { // entityMetadata
* // "<keys>": "STRING_VALUE",
* // },
* // },
* // ],
* // nextToken: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export interface DescribeAffectedEntitiesForOrganizationCommandOutput
* <p>Returns a list of entities that have been affected by one or more events for one or more
* accounts in your organization in Organizations, based on the filter criteria. Entities can refer
* to individual customer resources, groups of customer resources, or any other construct,
* depending on the Amazon Web Service.</p>
* depending on the Amazon Web Services service.</p>
* <p>At least one event Amazon Resource Name (ARN) and account ID are required.</p>
* <p>Before you can call this operation, you must first enable Health to work with
* 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
Expand Down Expand Up @@ -97,6 +97,9 @@ export interface DescribeAffectedEntitiesForOrganizationCommandOutput
* // tags: { // tagSet
* // "<keys>": "STRING_VALUE",
* // },
* // entityMetadata: { // entityMetadata
* // "<keys>": "STRING_VALUE",
* // },
* // },
* // ],
* // failedSet: [ // DescribeAffectedEntitiesForOrganizationFailedSet
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface DescribeEventTypesCommandOutput extends DescribeEventTypesRespo

/**
* <p>Returns the event types that meet the specified filter criteria. You can use this API
* 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>
* 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>
* <p>If you don't specify a filter criteria, the API operation returns all event types, in no
* particular order. </p>
* <note>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-health/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* <fullname>Health</fullname>
* <p>The Health API provides access to the Health information that appears in the
* <a href="https://health.aws.amazon.com/health/home">Health Dashboard</a>. You can use
* the API operations to get information about events that might affect your Amazon Web Services and resources.</p>
* the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
* <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
* Amazon Web Services account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
* <code>SubscriptionRequiredException</code> error.</p>
Expand Down
24 changes: 15 additions & 9 deletions clients/client-health/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,12 @@ export interface AffectedEntity {
* @public
*/
tags?: Record<string, string> | undefined;

/**
* <p>Additional metadata about the affected entity.</p>
* @public
*/
entityMetadata?: Record<string, string> | undefined;
}

/**
Expand Down Expand Up @@ -170,7 +176,7 @@ export interface DescribeAffectedAccountsForOrganizationResponse {
affectedAccounts?: string[] | undefined;

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

/**
* <p>The Amazon Web Services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
* <p>The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
* @public
*/
services?: string[] | undefined;
Expand Down Expand Up @@ -944,7 +950,7 @@ export interface Event {
arn?: string | undefined;

/**
* <p>The Amazon Web Service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
* <p>The Amazon Web Services service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
* @public
*/
service?: string | undefined;
Expand Down Expand Up @@ -1002,7 +1008,7 @@ export interface Event {
statusCode?: EventStatusCode | undefined;

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

/**
* <p>The Amazon Web Services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
* <p>The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
* @public
*/
services?: string[] | undefined;
Expand Down Expand Up @@ -1415,7 +1421,7 @@ export interface OrganizationEvent {
arn?: string | undefined;

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

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

/**
* <p>The Amazon Web Services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
* <p>The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
* @public
*/
services?: string[] | undefined;
Expand Down Expand Up @@ -1590,7 +1596,7 @@ export interface DescribeEventTypesRequest {
*/
export interface EventType {
/**
* <p>The Amazon Web Service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
* <p>The Amazon Web Services service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
* @public
*/
service?: string | undefined;
Expand Down
3 changes: 3 additions & 0 deletions clients/client-health/src/protocols/Aws_json1_1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -836,6 +836,7 @@ const de_AffectedEntity = (output: any, context: __SerdeContext): AffectedEntity
return take(output, {
awsAccountId: __expectString,
entityArn: __expectString,
entityMetadata: _json,
entityUrl: __expectString,
entityValue: __expectString,
eventArn: __expectString,
Expand Down Expand Up @@ -981,6 +982,8 @@ const de_EntityList = (output: any, context: __SerdeContext): AffectedEntity[] =
return retVal;
};

// de_entityMetadata omitted.

// de_entityStatuses omitted.

/**
Expand Down
Loading

0 comments on commit b98d358

Please sign in to comment.