@aws-sdk/client-health-node

Description

AWS Health

The AWS Health API provides programmatic access to the AWS Health information that is presented in the AWS Personal Health Dashboard. You can get information about events that affect your AWS resources:

DescribeEvents: Summary information about events.
DescribeEventDetails: Detailed information about one or more events.
DescribeAffectedEntities: Information about AWS resources that are affected by one or more events.

In addition, these operations provide information about event types and summary counts of events or affected entities:

DescribeEventTypes: Information about the kinds of events that AWS Health tracks.
DescribeEventAggregates: A count of the number of events that meet specified criteria.
DescribeEntityAggregates: A count of the number of affected entities that meet specified criteria.

The Health API requires a Business or Enterprise support plan from AWS Support. Calling the Health API from an account that does not have a Business or Enterprise support plan causes a SubscriptionRequiredException.

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

See the AWS Health User Guide for information about how to use the API.

Service Endpoint

The HTTP endpoint for the AWS Health API is:

https://health.us-east-1.amazonaws.com

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-health-node

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(HealthClient) and the commands you need, for example DescribeAffectedEntitiesCommand:

//JavaScript
const { HealthClient } = require("@aws-sdk/client-health-node/HealthClient");
const {
  DescribeAffectedEntitiesCommand
} = require("@aws-sdk/client-health-node/commands/DescribeAffectedEntitiesCommand");

//TypeScript
import { HealthClient } from "@aws-sdk/client-health-node/HealthClient";
import { DescribeAffectedEntitiesCommand } from "@aws-sdk/client-health-node/commands/DescribeAffectedEntitiesCommand";

Usage

To send a request, you:

Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
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.

const health = new HealthClient({ region: "region" });
//clients can be shared by different commands
const params = {
  filter: {
    /**an object specifying filter*/
  }
};
const describeAffectedEntitiesCommand = new DescribeAffectedEntitiesCommand(
  params
);
health
  .send(describeAffectedEntitiesCommand)
  .then(data => {
    // do something
  })
  .catch(error => {
    // error handling
  });

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await health.send(describeAffectedEntitiesCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
health.send(describeAffectedEntitiesCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-health-node/Health";
const health = new AWS.Health({ region: "region" });
health.describeAffectedEntities(params, (err, data) => {
  //do something
});

Troubleshooting

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 health.send(describeAffectedEntitiesCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

Ask a question on StackOverflow and tag it with aws-sdk-js
Come join the AWS JavaScript community on gitter
If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-health-node' package is updated. To contribute to SDK you can checkout our code generator package.

License

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