{"_id":"@aws-sdk/client-health-browser","_rev":"19-102b39527a62df3e22a8c89679451ab1","name":"@aws-sdk/client-health-browser","dist-tags":{"latest":"0.1.0-preview.2","preview":"0.1.0-preview.6"},"versions":{"0.1.0-preview.2":{"name":"@aws-sdk/client-health-browser","version":"0.1.0-preview.2","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-health-browser@0.1.0-preview.2","maintainers":[{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"},{"name":"amzn-oss","email":"osa-3p@amazon.com"}],"dist":{"shasum":"c645002b2f11036b1add86ef20dae2701475bef0","tarball":"https://registry.npmjs.org/@aws-sdk/client-health-browser/-/client-health-browser-0.1.0-preview.2.tgz","fileCount":308,"integrity":"sha512-xCGIUtpBRRNNXI6CHZq/ox919gXrQrArWPKp5qOCD+U0eJxsYJiG3fJ0+Rp/N1OknmFx0HI7yjp4l5+sJW4M/A==","signatures":[{"sig":"MEUCIG8EfpJ27/DC/x5UUrAxnzLVEfFaj+QLFkaNNorDxkSEAiEA/PCVrlkjA2Sc8hRSLU6YgObrAn5zMbHSXpr+r80euMU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178352,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJddo6uCRA9TVsSAnZWagAAvp0P/1thgMx/Pu9OtPydNkBM\npxbipFfKFcrYWqRwN2bp6VBCcR8CD60RaZ7wKLnfLWcxzP8mmzgOyEXA/+VU\n1qY98eM3aW3NTfNsptwXjSUYlAadpDjnCnY5RKxsgpkrKG4dBzPpY3oQR2Fw\nWkyEyObZEIww80EVT6X3M32XR0ymHGq09z16U47Q8LanPL7X0U3i1TBH1NNP\nURrrZ4qzFD3hB8bPAbidyY/GvRxp9R3QAz+ZdiGXLZ1nO4Rb0GSfBbfkszvM\n1FOXo7AD0y2jC34QzGMrEY0iY2qJsqXTpqVmU3c+iSRR05N+QQ8wW80LJ079\neigN4emRTfIHR2E9JLja2tdSRWssEVG5sJ7iYULmiEEpPFPu5CbLT1rislku\n108tGVwnDN5n8CdaUBsdJAyM9U54IPKoY4nviVyfaG2Illji2Kf5g+UD6RQj\n57W7jr6QqGHgfuUWHoNU5YWP0+iItlfT+7956eShsDltPbaqoKXvMyxavSeF\nhbxQuwonx3XsfxaLm9UTia2Nm9rkUMh8r8STn583ok0bCYOuv41mjCDBppop\nu0N2ZkllEKMslByNVCXtXaq29X779MinKkFeMOkxR685t2SMI8jjH4dTxmWG\nOtLu6mJdIh69cUlCNOsGmLpJOwYqhwWuEl5vFBELQHV5gB/jzzJv+rB99g3C\n9DQn\r\n=fI/E\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-health-browser has been renamed to @aws-sdk/client-health. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for AWS Health APIs and Notifications","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.5","@aws-sdk/json-parser":"^0.1.0-preview.5","@aws-sdk/core-handler":"^0.1.0-preview.5","@aws-sdk/json-builder":"^0.1.0-preview.5","@aws-sdk/signature-v4":"^0.1.0-preview.6","@aws-sdk/config-resolver":"^0.1.0-preview.5","@aws-sdk/middleware-stack":"^0.1.0-preview.6","@aws-sdk/retry-middleware":"^0.1.0-preview.5","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.6","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.5","@aws-sdk/signing-middleware":"^0.1.0-preview.6","@aws-sdk/url-parser-browser":"^0.1.0-preview.5","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.6","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.6","@aws-sdk/stream-collector-browser":"^0.1.0-preview.5","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.5","@aws-sdk/middleware-header-default":"^0.1.0-preview.5"},"_hasShrinkwrap":false,"devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-health-browser_0.1.0-preview.2_1568050861650_0.7898179920825839","host":"s3://npm-registry-packages"}},"0.1.0-preview.3":{"name":"@aws-sdk/client-health-browser","version":"0.1.0-preview.3","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-health-browser@0.1.0-preview.3","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"cc7e51477e4c6d1e0e579f63e569af9c0a2fca5c","tarball":"https://registry.npmjs.org/@aws-sdk/client-health-browser/-/client-health-browser-0.1.0-preview.3.tgz","fileCount":308,"integrity":"sha512-rirTIcd0nbjLT8TNSLv1tvaEu3eEYuIr+br962Ejxf8Bvzs9AYvQk0tWj5KoG28QJGr47Imrz++BgX+3Er2dlw==","signatures":[{"sig":"MEYCIQC7b58XUMLmO8q9bDcOKpOpmkKXS1D/9qEJYgALLwst1wIhAIMfTm5H5uQW1zIojE4v6X8I1Y3bAx+U8PexqPT3MqLb","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178572,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdg6QuCRA9TVsSAnZWagAABJIQAI9aVES145M65FGKK8lA\nO07PHdmHmkwi/nJXZA3IwAawh1aCqtL+GSiOLKAlSEQhTmmRCc7warXulfTY\nPm28hVX+cSc6i8wWSr6iLf0i9cB6kidyTRQ3uJKBQvr4mAQNQj+/2P0Ux8St\nWTEu5XsQlL2KxWqEJXrGtrZ4Pc/R3ChP8PRhTWvYhakOAxU4smM/T3K1AEEn\nTeKbGd55lTv04nltUoTEW1qexW7ifw/T4AbRJG90BlepLSvOE3ptwMfUlVm+\nSjJffdFCnLZgwI9z2ImUMoSF1pjH22lr8a1oJLOFU3/eQfRpFxwV6P91z6MV\ng7x9z5vNwib6gCs7Ej10nOiFGzrsLt9FQ69E8um4drppOPnTDNl7WbEKwgwd\nbHxM0TG8mrF7mg7ILJh01kuA05axs4sFdU/SExjCHlHkotCNQkTxcRkl7Jww\nSRzge14CcuWFVI3deM4E8B9nvH9Slat5Si7OMidPapmI/wAMl2IqepIpbfOT\nLY2sFJwKicNpYvJNSDrn47aJ19vTsDIIq5UjFVw2ZlKdRkHZ0wIVbhdBcnmO\nbLEv4DqPu66mm7oplb6TH/NO6nmzXzeL26PKeEZ0ra0tSnJpYNPfnAe60te8\ncSjJ9TTWHEQzP8Ihadk+tePEJQK27bQVjzWBD8c+GWc8vrw6LGn36HBsFgfi\n4nd8\r\n=KUmp\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-health-browser\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-health-browser/preview.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-browser)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-health-browser.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-browser)\n\n## Description\n\n<fullname>AWS Health</fullname> <p>The AWS Health API provides programmatic access to the AWS Health information that is presented in the <a href=\"https://phd.aws.amazon.com/phd/home#/\">AWS Personal Health Dashboard</a>. You can get information about events that affect your AWS resources:</p> <ul> <li> <p> <a>DescribeEvents</a>: Summary information about events.</p> </li> <li> <p> <a>DescribeEventDetails</a>: Detailed information about one or more events.</p> </li> <li> <p> <a>DescribeAffectedEntities</a>: Information about AWS resources that are affected by one or more events.</p> </li> </ul> <p>In addition, these operations provide information about event types and summary counts of events or affected entities:</p> <ul> <li> <p> <a>DescribeEventTypes</a>: Information about the kinds of events that AWS Health tracks.</p> </li> <li> <p> <a>DescribeEventAggregates</a>: A count of the number of events that meet specified criteria.</p> </li> <li> <p> <a>DescribeEntityAggregates</a>: A count of the number of affected entities that meet specified criteria.</p> </li> </ul> <p>The Health API requires a Business or Enterprise support plan from <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>. Calling the Health API from an account that does not have a Business or Enterprise support plan causes a <code>SubscriptionRequiredException</code>. </p> <p>For authentication of requests, AWS 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>See the <a href=\"https://docs.aws.amazon.com/health/latest/ug/what-is-aws-health.html\">AWS Health User Guide</a> for information about how to use the API.</p> <p> <b>Service Endpoint</b> </p> <p>The HTTP endpoint for the AWS Health API is:</p> <ul> <li> <p>https://health.us-east-1.amazonaws.com </p> </li> </ul>\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-health-browser\n```\n\n## Getting Started\n\n### Import\n\nThe 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`:\n\n```javascript\n//JavaScript\nconst { HealthClient } = require(\"@aws-sdk/client-health-browser/HealthClient\");\nconst {\n  DescribeAffectedEntitiesCommand\n} = require(\"@aws-sdk/client-health-browser/commands/DescribeAffectedEntitiesCommand\");\n```\n\n```javascript\n//TypeScript\nimport { HealthClient } from \"@aws-sdk/client-health-browser/HealthClient\";\nimport { DescribeAffectedEntitiesCommand } from \"@aws-sdk/client-health-browser/commands/DescribeAffectedEntitiesCommand\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst health = new HealthClient({ region: \"region\" });\n//clients can be shared by different commands\nconst params = {\n  filter: {\n    /**an object specifying filter*/\n  }\n};\nconst describeAffectedEntitiesCommand = new DescribeAffectedEntitiesCommand(\n  params\n);\nhealth\n  .send(describeAffectedEntitiesCommand)\n  .then(data => {\n    // do something\n  })\n  .catch(error => {\n    // error handling\n  });\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n  const data = await health.send(describeAffectedEntitiesCommand);\n  // do something\n} catch (error) {\n  // error handling\n}\n```\n\n```javascript\n// callback\nhealth.send(describeAffectedEntitiesCommand, (err, data) => {\n  //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/@aws-sdk/client-health-browser/Health\";\nconst health = new AWS.Health({ region: \"region\" });\nhealth.describeAffectedEntities(params, (err, data) => {\n  //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n  const data = await health.send(describeAffectedEntitiesCommand);\n  // do something\n} catch (error) {\n  const metadata = error.$metadata;\n  console.log(\n    `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n  );\n  /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n    if(error.name === 'SomeServiceException') {\n        const value = error.specialKeyInException;\n    }\n*/\n}\n```\n\n## Getting Help\n\nPlease 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.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-health-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-health-browser has been renamed to @aws-sdk/client-health. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for AWS Health APIs and Notifications","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.5","@aws-sdk/json-parser":"^0.1.0-preview.5","@aws-sdk/core-handler":"^0.1.0-preview.5","@aws-sdk/json-builder":"^0.1.0-preview.5","@aws-sdk/signature-v4":"^0.1.0-preview.7","@aws-sdk/config-resolver":"^0.1.0-preview.5","@aws-sdk/middleware-stack":"^0.1.0-preview.6","@aws-sdk/retry-middleware":"^0.1.0-preview.5","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.6","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.5","@aws-sdk/signing-middleware":"^0.1.0-preview.7","@aws-sdk/url-parser-browser":"^0.1.0-preview.5","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.6","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.6","@aws-sdk/stream-collector-browser":"^0.1.0-preview.5","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.5","@aws-sdk/middleware-header-default":"^0.1.0-preview.5"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-health-browser_0.1.0-preview.3_1568908334229_0.07650858192676369","host":"s3://npm-registry-packages"}},"0.1.0-preview.4":{"name":"@aws-sdk/client-health-browser","version":"0.1.0-preview.4","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-health-browser@0.1.0-preview.4","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"b6fde9d264069bedcddc2b3d484fb49be51b830a","tarball":"https://registry.npmjs.org/@aws-sdk/client-health-browser/-/client-health-browser-0.1.0-preview.4.tgz","fileCount":308,"integrity":"sha512-Yz/ZFZhPx+xpdlvwNUo3l8XB2hbkQchDxRincWSHm4qcnJ7F4KLZ3roFD2wmlqsWdc45A8qMnE/Q1y2sLLj89A==","signatures":[{"sig":"MEUCIQDFyN/ve2q7YgSnTqSFDoC/RUtwM1y6jCi3C+3qglqdhAIgbPNLNtjVf2CEPmpgHE696CBmD7hlaRDVtKIpZWf9aR4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178595,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJduM6/CRA9TVsSAnZWagAACnQP/0771sp1z3zF8LBVDWde\ndwjlvmnrMPfDsUhYkEKD7IMt7CJjIrTrXGUq2cVchUcFDYsh8apOkihgSnI/\nA65h84TKEfCNapC1j6v5O/tvy86do96i0dvOFbMrMLHVON6uBGXH9WWTVyD8\nfWymmOJQDrx+qU81qXB/bJGHN4pIugewDmnb3kjNCEm71xFm4iVS3zzBm9e1\nd9d83TJ7uoEnsPt6F65Bk0w9dv6P78xTIt1B55ZqYx8ZoSXC8mm668DpeJ25\nc8JezWl8RTDEIih5pvyrmbTVW30f7hAKzhliMOhmO/3v2Z3bEnE4OD0AGYuQ\nK9LHkaCTASIZyzNYWBb9VMT9mbN96H2L2mtcz6TBVQOj13DlJX+RHIp8NzYY\nQRbJEC9IoqNdpeU8yC53DSfOdiQo8x2SKjl7DyYESRt193pW8Dglem6ez41i\nOVEygFofeMtSYs91z3wNk4ITmZ6ogzf8NzPftfZNqiSi5+5PJReOdweWQlUV\n+H50vCw2Dkk3DE0QR4UuSIEWHsUXugFjTudzoZwy7zkaE1XFRLki0/jtyx02\nx3xrFy6gOAeOoKy5PY6SyA7yf5YaK+pnUL7V9p3Qs/OfMTlm5k0HjqQdKDLO\nxDXhcacWiu0tklE0/LmVbNfHC+1jvFmwoHmCgOstracahaxPoqEwkRUmIdyH\niej8\r\n=lHsU\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-health-browser\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-health-browser/preview.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-browser)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-health-browser.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-browser)\n\n## Description\n\n<fullname>AWS Health</fullname> <p>The AWS Health API provides programmatic access to the AWS Health information that is presented in the <a href=\"https://phd.aws.amazon.com/phd/home#/\">AWS Personal Health Dashboard</a>. You can get information about events that affect your AWS resources:</p> <ul> <li> <p> <a>DescribeEvents</a>: Summary information about events.</p> </li> <li> <p> <a>DescribeEventDetails</a>: Detailed information about one or more events.</p> </li> <li> <p> <a>DescribeAffectedEntities</a>: Information about AWS resources that are affected by one or more events.</p> </li> </ul> <p>In addition, these operations provide information about event types and summary counts of events or affected entities:</p> <ul> <li> <p> <a>DescribeEventTypes</a>: Information about the kinds of events that AWS Health tracks.</p> </li> <li> <p> <a>DescribeEventAggregates</a>: A count of the number of events that meet specified criteria.</p> </li> <li> <p> <a>DescribeEntityAggregates</a>: A count of the number of affected entities that meet specified criteria.</p> </li> </ul> <p>The Health API requires a Business or Enterprise support plan from <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>. Calling the Health API from an account that does not have a Business or Enterprise support plan causes a <code>SubscriptionRequiredException</code>. </p> <p>For authentication of requests, AWS 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>See the <a href=\"https://docs.aws.amazon.com/health/latest/ug/what-is-aws-health.html\">AWS Health User Guide</a> for information about how to use the API.</p> <p> <b>Service Endpoint</b> </p> <p>The HTTP endpoint for the AWS Health API is:</p> <ul> <li> <p>https://health.us-east-1.amazonaws.com </p> </li> </ul>\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-health-browser\n```\n\n## Getting Started\n\n### Import\n\nThe 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`:\n\n```javascript\n//JavaScript\nconst {\n  HealthClient,\n  DescribeAffectedEntitiesCommand\n} = require(\"@aws-sdk/client-health-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n  HealthClient,\n  DescribeAffectedEntitiesCommand\n} from \"@aws-sdk/client-health-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst health = new HealthClient({ region: \"region\" });\n//clients can be shared by different commands\nconst params = {\n  filter: {\n    /**an object specifying filter*/\n  }\n};\nconst describeAffectedEntitiesCommand = new DescribeAffectedEntitiesCommand(\n  params\n);\nhealth\n  .send(describeAffectedEntitiesCommand)\n  .then(data => {\n    // do something\n  })\n  .catch(error => {\n    // error handling\n  });\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n  const data = await health.send(describeAffectedEntitiesCommand);\n  // do something\n} catch (error) {\n  // error handling\n}\n```\n\n```javascript\n// callback\nhealth.send(describeAffectedEntitiesCommand, (err, data) => {\n  //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-health-browser\";\nconst health = new AWS.Health({ region: \"region\" });\nhealth.describeAffectedEntities(params, (err, data) => {\n  //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n  const data = await health.send(describeAffectedEntitiesCommand);\n  // do something\n} catch (error) {\n  const metadata = error.$metadata;\n  console.log(\n    `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n  );\n  /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n    if(error.name === 'SomeServiceException') {\n        const value = error.specialKeyInException;\n    }\n*/\n}\n```\n\n## Getting Help\n\nPlease 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.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-health-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-health-browser has been renamed to @aws-sdk/client-health. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for AWS Health APIs and Notifications","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.6","@aws-sdk/json-parser":"^0.1.0-preview.6","@aws-sdk/core-handler":"^0.1.0-preview.6","@aws-sdk/json-builder":"^0.1.0-preview.6","@aws-sdk/signature-v4":"^0.1.0-preview.8","@aws-sdk/config-resolver":"^0.1.0-preview.6","@aws-sdk/middleware-stack":"^0.1.0-preview.7","@aws-sdk/retry-middleware":"^0.1.0-preview.6","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.7","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.6","@aws-sdk/signing-middleware":"^0.1.0-preview.8","@aws-sdk/url-parser-browser":"^0.1.0-preview.6","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.6","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.7","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.7","@aws-sdk/stream-collector-browser":"^0.1.0-preview.6","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.6","@aws-sdk/middleware-header-default":"^0.1.0-preview.6"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-health-browser_0.1.0-preview.4_1572392638955_0.45606021815593656","host":"s3://npm-registry-packages"}},"0.1.0-preview.5":{"name":"@aws-sdk/client-health-browser","version":"0.1.0-preview.5","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-health-browser@0.1.0-preview.5","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"81065352a18d08d87712bb9434c4ae4b9d838fb6","tarball":"https://registry.npmjs.org/@aws-sdk/client-health-browser/-/client-health-browser-0.1.0-preview.5.tgz","fileCount":308,"integrity":"sha512-tkGEje2AXklRQbZT31Xh6AdFa0qFyjaBPvcNVj8KrKmlZsQWFw3zLxkuAtYcYGsh/MsIup4SuaCXCpvvh2TBLw==","signatures":[{"sig":"MEQCIGtPaGuqttnZmfNBE50eTG2Y20u1jQJEVxTiH5GbwV80AiBy++P+TmdSGPQaoWWAyGCqi8ODoWryyl3hB5jwqgnHjQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178839,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdueGqCRA9TVsSAnZWagAAetQP/ioTc6MDMGsfWkGIiFeP\n/y4IwFMv6J33QAi1JkVUkIm374YsW+96GR1ms4aI7uEUihCHkv5Kr83d0iab\nExR7oi6y/14yqNLe96/z6F55ts/HG/8AcatE884LvZZccxno3u5Eti4imQ3J\nVBec3b9IgxWYLFndrr8Bqxxi5MANnQj2VeCwdc96P/WMd7WAi0s6Tf3eqKkx\nQhN2uOsZyHIkPhIdWu+PjGO2ZEjBMQYNiy7TGeVoyaKdwxDUkAOmTAMu5HTl\nkenIUYc08cEo7UiOsOMWorvKlJ8+I6nrPlh8pxi2zxcm4CJ+K5+7e8iZhDzO\n1Lb81bjDM+3aBeHK9+9w/zkGnmrYBiC/Q+Mly3vLQV0B6VGVaEk7zn3OSm5D\nU88k1Scw+3uJWMO6qhmxxDJhz5zN2AYInzt3DXfmN79+MmS34EIanVCAy5af\nM9Srm86PxrHU2SQSce7TafXsT+dpRRD9Kkq/R6AIH97SkhBt6hjjJ7qdDL+c\nziNbmyHPWCN4U8Zgs7S/G/LQANGBxLUkHi1p+BMk68wJuL13SDaS0MS8FF8T\n2mzqCKJWy0enKdeEIYWCqre5fMPTViylu3rAOMsUKevrqak95/U30l+A9WsG\nROTUc0Ce5JZ78B0lVJSYy7VaVj71Zm3hFwBw2gXE3QdR5UhoLsDUmZfzPrCn\nGkTJ\r\n=VHqx\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-health-browser\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-health-browser/preview.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-browser)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-health-browser.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-browser)\n\n## Description\n\n<fullname>AWS Health</fullname> <p>The AWS Health API provides programmatic access to the AWS Health information that is presented in the <a href=\"https://phd.aws.amazon.com/phd/home#/\">AWS Personal Health Dashboard</a>. You can get information about events that affect your AWS resources:</p> <ul> <li> <p> <a>DescribeEvents</a>: Summary information about events.</p> </li> <li> <p> <a>DescribeEventDetails</a>: Detailed information about one or more events.</p> </li> <li> <p> <a>DescribeAffectedEntities</a>: Information about AWS resources that are affected by one or more events.</p> </li> </ul> <p>In addition, these operations provide information about event types and summary counts of events or affected entities:</p> <ul> <li> <p> <a>DescribeEventTypes</a>: Information about the kinds of events that AWS Health tracks.</p> </li> <li> <p> <a>DescribeEventAggregates</a>: A count of the number of events that meet specified criteria.</p> </li> <li> <p> <a>DescribeEntityAggregates</a>: A count of the number of affected entities that meet specified criteria.</p> </li> </ul> <p>The Health API requires a Business or Enterprise support plan from <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>. Calling the Health API from an account that does not have a Business or Enterprise support plan causes a <code>SubscriptionRequiredException</code>. </p> <p>For authentication of requests, AWS 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>See the <a href=\"https://docs.aws.amazon.com/health/latest/ug/what-is-aws-health.html\">AWS Health User Guide</a> for information about how to use the API.</p> <p> <b>Service Endpoint</b> </p> <p>The HTTP endpoint for the AWS Health API is:</p> <ul> <li> <p>https://health.us-east-1.amazonaws.com </p> </li> </ul>\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-health-browser\n```\n\n## Getting Started\n\n### Import\n\nThe 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`:\n\n```javascript\n//JavaScript\nconst {\n  HealthClient,\n  DescribeAffectedEntitiesCommand\n} = require(\"@aws-sdk/client-health-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n  HealthClient,\n  DescribeAffectedEntitiesCommand\n} from \"@aws-sdk/client-health-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst health = new HealthClient({ region: \"region\" });\n//clients can be shared by different commands\nconst params = {\n  filter: {\n    /**an object specifying filter*/\n  }\n};\nconst describeAffectedEntitiesCommand = new DescribeAffectedEntitiesCommand(\n  params\n);\nhealth\n  .send(describeAffectedEntitiesCommand)\n  .then(data => {\n    // do something\n  })\n  .catch(error => {\n    // error handling\n  });\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n  const data = await health.send(describeAffectedEntitiesCommand);\n  // do something\n} catch (error) {\n  // error handling\n}\n```\n\n```javascript\n// callback\nhealth.send(describeAffectedEntitiesCommand, (err, data) => {\n  //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-health-browser\";\nconst health = new AWS.Health({ region: \"region\" });\nhealth.describeAffectedEntities(params, (err, data) => {\n  //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n  const data = await health.send(describeAffectedEntitiesCommand);\n  // do something\n} catch (error) {\n  const metadata = error.$metadata;\n  console.log(\n    `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n  );\n  /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n    if(error.name === 'SomeServiceException') {\n        const value = error.specialKeyInException;\n    }\n*/\n}\n```\n\n## Getting Help\n\nPlease 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.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-health-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-health-browser has been renamed to @aws-sdk/client-health. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for AWS Health APIs and Notifications","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.9","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.8","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.8","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.7","@aws-sdk/signing-middleware":"^0.1.0-preview.9","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.8","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-health-browser_0.1.0-preview.5_1572463018166_0.7727193268366559","host":"s3://npm-registry-packages"}},"0.1.0-preview.6":{"name":"@aws-sdk/client-health-browser","version":"0.1.0-preview.6","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-health-browser@0.1.0-preview.6","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"23bf8f63a1b4b3415f76b0ee8e4dd7da40fedbb0","tarball":"https://registry.npmjs.org/@aws-sdk/client-health-browser/-/client-health-browser-0.1.0-preview.6.tgz","fileCount":308,"integrity":"sha512-7kBZNA0o+DjY6SvmDZ+g2GCM3ZxtNowLHIjy9tb6TBmmuyb5jlbI+qI26bBWyyNc+Rxis+rA8nHAPSqHPLc0Gw==","signatures":[{"sig":"MEUCIFTae+ZVFW1zjUqvnKuDouS8AJ897y+tfrI7xCRIt3/sAiEA0ys/u2+HZIwBAXPZpo9EtX7AhMfX6CEh4uJ3lcgAGyE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":179109,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd1FNECRA9TVsSAnZWagAAfCsP+wRPG0k0qN9BWqIXspfY\nn3lfUbeODIbqsYtcdHRbl4u1h2xIYglD+v99Z5OGjzwH50KCUP4SmeGGbf3W\naHZBj+rcJSS3NSju1gC3zQiIjdBf9Yf5ucdgQpzoJ4Gk/f6tuEyOurM2kx1K\n6tKPol9EMlwwMILvWawS0bjsBTrHvSFBsTIE4eWljER3dPTgX9F9dvhoVx8b\n+TiQtgZfqs+S7ptVH8EfZsyAkqij8moCo3OgGeSDa6TDnOcvaSSdVBQ3Sqq9\n4/MZTI2lax3Cb1S8exxtaY8v61JmQBUn0RrkLjGXgSHpc3SCUCZoM4o4pIbg\nhXwxAy7LKO8+c7naELNP3xaezux27cjjtCz4jHEoQM2P7tbtsZVTuAziwqwV\n1hMpbihfp336gHth6I35IbD1+3x+xqqjmqU8E4Udis1B2E0Z3GKpgOnoAbKh\nnQNvk6QwdI5NUOGumnEvY/9GTawr71Jwvdw2lLK5sadehB+jcZXrnEBA4zKC\ngXYGCnKLVE7LHx4V1X2RKfzn7n8E/3s7qpkrdoXKuFAJw/LKPsm+FRgOSluf\nyBlpWa32C1pvQGB7Ms2mnLKnIV12M7YydJ8lkjJocrTLS8FD7M1M9MfopgZb\nUlEdH79LRCgzp/m/2BDHFLEPQNe4PZTCT+HbccULSxdbv9t/a5f0N5/Bja/f\nrq83\r\n=48bP\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-health-browser\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-health-browser/preview.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-browser)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-health-browser.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-browser)\n\n## Description\n\n<fullname>AWS Health</fullname> <p>The AWS Health API provides programmatic access to the AWS Health information that is presented in the <a href=\"https://phd.aws.amazon.com/phd/home#/\">AWS Personal Health Dashboard</a>. You can get information about events that affect your AWS resources:</p> <ul> <li> <p> <a>DescribeEvents</a>: Summary information about events.</p> </li> <li> <p> <a>DescribeEventDetails</a>: Detailed information about one or more events.</p> </li> <li> <p> <a>DescribeAffectedEntities</a>: Information about AWS resources that are affected by one or more events.</p> </li> </ul> <p>In addition, these operations provide information about event types and summary counts of events or affected entities:</p> <ul> <li> <p> <a>DescribeEventTypes</a>: Information about the kinds of events that AWS Health tracks.</p> </li> <li> <p> <a>DescribeEventAggregates</a>: A count of the number of events that meet specified criteria.</p> </li> <li> <p> <a>DescribeEntityAggregates</a>: A count of the number of affected entities that meet specified criteria.</p> </li> </ul> <p>The Health API requires a Business or Enterprise support plan from <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>. Calling the Health API from an account that does not have a Business or Enterprise support plan causes a <code>SubscriptionRequiredException</code>. </p> <p>For authentication of requests, AWS 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>See the <a href=\"https://docs.aws.amazon.com/health/latest/ug/what-is-aws-health.html\">AWS Health User Guide</a> for information about how to use the API.</p> <p> <b>Service Endpoint</b> </p> <p>The HTTP endpoint for the AWS Health API is:</p> <ul> <li> <p>https://health.us-east-1.amazonaws.com </p> </li> </ul>\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-health-browser\n```\n\n## Getting Started\n\n### Import\n\nThe 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`:\n\n```javascript\n//JavaScript\nconst {\n  HealthClient,\n  DescribeAffectedEntitiesCommand\n} = require(\"@aws-sdk/client-health-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n  HealthClient,\n  DescribeAffectedEntitiesCommand\n} from \"@aws-sdk/client-health-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst health = new HealthClient({ region: \"region\" });\n//clients can be shared by different commands\nconst params = {\n  filter: {\n    /**an object specifying filter*/\n  }\n};\nconst describeAffectedEntitiesCommand = new DescribeAffectedEntitiesCommand(\n  params\n);\nhealth\n  .send(describeAffectedEntitiesCommand)\n  .then(data => {\n    // do something\n  })\n  .catch(error => {\n    // error handling\n  });\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n  const data = await health.send(describeAffectedEntitiesCommand);\n  // do something\n} catch (error) {\n  // error handling\n}\n```\n\n```javascript\n// callback\nhealth.send(describeAffectedEntitiesCommand, (err, data) => {\n  //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-health-browser\";\nconst health = new AWS.Health({ region: \"region\" });\nhealth.describeAffectedEntities(params, (err, data) => {\n  //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n  const data = await health.send(describeAffectedEntitiesCommand);\n  // do something\n} catch (error) {\n  const metadata = error.$metadata;\n  console.log(\n    `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n  );\n  /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n    if(error.name === 'SomeServiceException') {\n        const value = error.specialKeyInException;\n    }\n*/\n}\n```\n\n## Getting Help\n\nPlease 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.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-health-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-health-browser has been renamed to @aws-sdk/client-health. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for AWS Health APIs and Notifications","directories":{},"_nodeVersion":"10.16.3","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.10","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.9","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.8","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.8","@aws-sdk/signing-middleware":"^0.1.0-preview.10","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.9","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-health-browser_0.1.0-preview.6_1574196036371_0.29241951747862305","host":"s3://npm-registry-packages"}}},"time":{"created":"2019-09-09T17:41:01.470Z","modified":"2025-03-27T18:43:11.433Z","0.1.0-preview.2":"2019-09-09T17:41:01.845Z","0.1.0-preview.3":"2019-09-19T15:52:14.405Z","0.1.0-preview.4":"2019-10-29T23:43:59.094Z","0.1.0-preview.5":"2019-10-30T19:16:58.381Z","0.1.0-preview.6":"2019-11-19T20:40:36.528Z"},"author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","description":"Browser SDK for AWS Health APIs and Notifications","maintainers":[{"email":"osa-3p@amazon.com","name":"amzn-oss"},{"email":"aws-sdk-js-automation@amazon.com","name":"aws-sdk-bot"}],"readme":"","readmeFilename":""}