clients/client-health/README.md
AWS SDK for JavaScript Health Client for Node.js, Browser and React Native.
<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 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> <p>For API access, you need an access key ID and a secret access key. Use temporary credentials instead of long-term access keys when possible. Temporary credentials include an access key ID, a secret access key, and a security token that indicates when the credentials expire. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">Best practices for managing Amazon Web Services access keys</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the Health API operations. Health supports a multi-Region application architecture and has two regional endpoints in an active-passive configuration. You can use the high availability endpoint example to determine which Amazon Web Services Region is active, so that you can get the latest information from the API. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/health-api.html">Accessing the Health API</a> in the <i>Health User Guide</i>.</p> <p>For authentication of requests, Health uses the <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>.</p> <p>If your Amazon Web Services account is part of Organizations, you can use the Health organizational view feature. This feature provides a centralized view of Health events across all accounts in your organization. You can aggregate Health events in real time to identify accounts in your organization that are affected by an operational event or get notified of security vulnerabilities. Use the organizational view API operations to enable this feature and return event information. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating Health events</a> in the <i>Health User Guide</i>.</p> <note> <p>When you use the Health API operations to return Health events, see the following recommendations:</p> <ul> <li> <p>Use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode">eventScopeCode</a> parameter to specify whether to return Health events that are public or account-specific.</p> </li> <li> <p>Use pagination to view all events from the response. For example, if you call the <code>DescribeEventsForOrganization</code> operation to get all events in your organization, you might receive several page results. Specify the <code>nextToken</code> in the next request to return more results.</p> </li> </ul> </note>To install this package, use the CLI of your favorite package manager:
npm install @aws-sdk/client-healthyarn add @aws-sdk/client-healthpnpm add @aws-sdk/client-healthThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the HealthClient and
the commands you need, for example DescribeEventsCommand:
// ES5 example
const { HealthClient, DescribeEventsCommand } = require("@aws-sdk/client-health");
// ES6+ example
import { HealthClient, DescribeEventsCommand } from "@aws-sdk/client-health";
To send a request:
send operation on the client, providing the command object as input.const client = new HealthClient({ region: "REGION" });
const params = { /** input parameters */ };
const command = new DescribeEventsCommand(params);
We recommend using the await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
You can also use Promise chaining.
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
The aggregated client class is exported from the same package, but without the "Client" suffix.
Health extends HealthClient and additionally supports all operations, waiters, and paginators as methods.
This style may be familiar to you from the AWS SDK for JavaScript v2.
If you are bundling the AWS SDK, we recommend using only the bare-bones client (HealthClient).
More details are in the blog post on
modular packages in AWS SDK for JavaScript.
import { Health } from "@aws-sdk/client-health";
const client = new Health({ region: "REGION" });
// async/await.
try {
const data = await client.describeEvents(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.describeEvents(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks (not recommended).
client.describeEvents(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
See also docs/ERROR_HANDLING.
Please use these community resources for getting help. We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-health package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
Command API Reference / Input / Output
</details> <details> <summary> DescribeAffectedEntities </summary>Command API Reference / Input / Output
</details> <details> <summary> DescribeAffectedEntitiesForOrganization </summary>Command API Reference / Input / Output
</details> <details> <summary> DescribeEntityAggregates </summary>Command API Reference / Input / Output
</details> <details> <summary> DescribeEntityAggregatesForOrganization </summary>Command API Reference / Input / Output
</details> <details> <summary> DescribeEventAggregates </summary>Command API Reference / Input / Output
</details> <details> <summary> DescribeEventDetails </summary>Command API Reference / Input / Output
</details> <details> <summary> DescribeEventDetailsForOrganization </summary>Command API Reference / Input / Output
</details> <details> <summary> DescribeEvents </summary>Command API Reference / Input / Output
</details> <details> <summary> DescribeEventsForOrganization </summary>Command API Reference / Input / Output
</details> <details> <summary> DescribeEventTypes </summary>Command API Reference / Input / Output
</details> <details> <summary> DescribeHealthServiceStatusForOrganization </summary>Command API Reference / Input / Output
</details> <details> <summary> DisableHealthServiceAccessForOrganization </summary> </details> <details> <summary> EnableHealthServiceAccessForOrganization </summary> </details>