@aws-sdk/client-health

Description

AWS SDK for JavaScript Health Client for Node.js, Browser and React Native.

Health

The Health API provides access to the Health information that appears in the
Health Dashboard. You can use
the API operations to get information about events that might affect your Amazon Web Services services and resources.

You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support 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
SubscriptionRequiredException error.

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 Best practices for managing
Amazon Web Services access keys in the Amazon Web Services General Reference.

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 Accessing the Health
API in the Health User Guide.

For authentication of requests, Health uses the Signature Version 4 Signing
Process.

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 Aggregating
Health events in the Health User Guide.

When you use the Health API operations to return Health events, see the
following recommendations:

• 
  

  Use the eventScopeCode parameter to specify whether to return Health
  events that are public or account-specific.

  
  


• 
  

  Use pagination to view all events from the response. For example, if you call
  the DescribeEventsForOrganization operation to get all events in your
  organization, you might receive several page results. Specify the
  nextToken in the next request to return more results.

  
  

Installing

To install this package, simply type add or install @aws-sdk/client-health
using your favorite package manager:
- npm install @aws-sdk/client-health
- yarn add @aws-sdk/client-health
- pnpm add @aws-sdk/client-health

Getting Started

$3

The 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:

``js
// ES5 example
const { HealthClient, DescribeEventsCommand } = require("@aws-sdk/client-health");
`

`ts
// ES6+ example
import { HealthClient, DescribeEventsCommand } from "@aws-sdk/client-health";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new HealthClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new DescribeEventsCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-health";
const client = new AWS.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.
client.describeEvents(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
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;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

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.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

DescribeAffectedAccountsForOrganization

Command API Reference / Input / Output

DescribeAffectedEntities

Command API Reference / Input / Output

DescribeAffectedEntitiesForOrganization

Command API Reference / Input / Output

DescribeEntityAggregates

Command API Reference / Input / Output

DescribeEntityAggregatesForOrganization

Command API Reference / Input / Output

DescribeEventAggregates

Command API Reference / Input / Output

DescribeEventDetails

Command API Reference / Input / Output

DescribeEventDetailsForOrganization

Command API Reference / Input / Output

DescribeEvents

Command API Reference / Input / Output

DescribeEventsForOrganization

Command API Reference / Input / Output

DescribeEventTypes

Command API Reference / Input / Output

DescribeHealthServiceStatusForOrganization

Command API Reference / Input / Output

DisableHealthServiceAccessForOrganization

Command API Reference / Input / Output

EnableHealthServiceAccessForOrganization

Command API Reference / Input / Output