{"_id":"@aws-sdk/client-health-node","_rev":"18-9f1032dbbd735b0805646782cf8f3103","name":"@aws-sdk/client-health-node","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-node","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-node@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":"5d9a23e892c3b9845699b11bcf5001e7287a1f93","tarball":"https://registry.npmjs.org/@aws-sdk/client-health-node/-/client-health-node-0.1.0-preview.2.tgz","fileCount":308,"integrity":"sha512-h0/q01xloPV38lHg7gsdvfmO6urKh4FKP/xEck9tH+eAv6huHUwEU/1P4oBS7MuxwQHP9rgHnh5qMHqCPDn7rQ==","signatures":[{"sig":"MEUCIEAM1dRibWylarj6XYueeH3KETaOYxnrdIxgubekIjLUAiEA6/NLNlhc3Txdjk5evyzPd4PnRfv1u7iG1ijAF6Vt/0I=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":180046,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJddpFHCRA9TVsSAnZWagAA26YP/Axr2EtCJ+4iGwTloZfa\neObZEAXA4APayAOYqidn+h6nl+lTO1p2xqpPQ87P38Wk/zAy9p1DRDIbreYH\nUEed6WyChZ6YQuKi97PnnqtqQvvuqntulUpm5k1bGeRNxPl+Ztv3CHckPcma\ndcRf3d4CN7TQq8lzhQaBXXvu8yMDqWaKaLaPNhBKzvT6gD8BB+Yr7qoCVscU\nTHYJVxP2XY8RlSrrnRUHtQ19T5Z1xvyiIlm3o0gc4BEpuLhxx7s3LRtgO2Ce\n+YL+MEJjVaqsozBk11OnSm2u7aWBvo8Kc2lfi38Gpf2S2o/pZ0Ha652CYSUn\ncdVVhj54voq0s0F2r6LQnAqpKOEsZvOhYLTl9uOdcBp9N/CWhJ68P3cVisiT\nfduT/NHArfdRSTZvepKCm9ru1AZRX+QHMc/2EUjztIoRgkuU63xinnZuyprZ\nmK2wsSlfJ7CbcLjm9lJK6gghfEO/X5ep/dFKxuXmBmyWbloqnkOcsouVxJ3Y\nQ5z30a7i3UTbbmQSAMU3GcwOvYpQ4FTwx633PB47Gqc6EX09eToYRfV/XfT0\nKd1qpzin1bEU0u/VozOtb2kltj1LYjn8ugC23+ZW/2opMJHzdk5f2SCe9fYe\nXCb7AMNm+8B3IVIqOP43WATq/M0lZgglEocp2BPS9zqRxbEE1XZ0jKEksoGH\noXP9\r\n=EOSl\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":"npm run pretest && node ./test/smoke/index.spec.js","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-node has been renamed to @aws-sdk/client-health. Please install the renamed package.","_npmVersion":"6.9.0","description":"Node 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/hash-node":"^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/util-utf8-node":"^0.1.0-preview.3","@aws-sdk/config-resolver":"^0.1.0-preview.5","@aws-sdk/region-provider":"^0.1.0-preview.5","@aws-sdk/url-parser-node":"^0.1.0-preview.5","@aws-sdk/middleware-stack":"^0.1.0-preview.6","@aws-sdk/retry-middleware":"^0.1.0-preview.5","@aws-sdk/util-base64-node":"^0.1.0-preview.3","@aws-sdk/node-http-handler":"^0.1.0-preview.6","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.6","@aws-sdk/signing-middleware":"^0.1.0-preview.6","@aws-sdk/util-user-agent-node":"^0.1.0-preview.6","@aws-sdk/middleware-serializer":"^0.1.0-preview.5","@aws-sdk/stream-collector-node":"^0.1.0-preview.5","@aws-sdk/util-body-length-node":"^0.1.0-preview.4","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.6","@aws-sdk/credential-provider-node":"^0.1.0-preview.6","@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","@types/node":"^10.0.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-health-node_0.1.0-preview.2_1568051527245_0.09807185944962238","host":"s3://npm-registry-packages"}},"0.1.0-preview.3":{"name":"@aws-sdk/client-health-node","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-node@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":"88d0c29f51a87bc1452635e91ecc7ab1a0889004","tarball":"https://registry.npmjs.org/@aws-sdk/client-health-node/-/client-health-node-0.1.0-preview.3.tgz","fileCount":308,"integrity":"sha512-NnS1nOE2gHL2ZXBTKL1e7RB2iqVm2i4tbVVJCZ5l9MbQkO3d5R410X+A6s1TG+Yo7TYSr4plbfxem6bWPcMoDQ==","signatures":[{"sig":"MEQCIGonZIyTDbGV4wqczMVDQ3QBxFafH6R2LIEGFHVUbdGSAiAmQ46ulQIvw6UoezjMQYhxqFXAWBRURecxfHkkKSPlPQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178264,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdg6d9CRA9TVsSAnZWagAAp3kP/0UG88bLfq2IH/X2L4Fv\n5iT1Zp2WdjmCFMMS2GN3QhbfITigNz6ao372aySoRD6uDh16obbUUt/PmibI\nD6OrZ1lYkitIqHanVO1ZG4WnSmRDUiwiLMlq1Kw3/3C8LyXwrxs/7p/BGvhn\nT5tlIRo4nXBrZlsySx1nWxd8KwJVg2eZ57+TXU4FzSONcYXfjUOWJ0BSwNob\nTQoBYZBC5QH+fJgVumhDKthwVjeN5cat5qh/werW5v18WE+S9qnXoYz4/IwW\nU36A4pCBHjLN0H7DN2+va8F/r88WVE9y9lUvQIp/ry33aBg1sUQ1uN7mswkm\nsWAHDud8Vw2pMZLrfJ+YyoQjb/gA5UlBgbOi/NqH3oJB4ipa0e9+nrx5P4hO\nuDQBTdkjzs2i5YYDg3Ff0Yrx4+keZ/vYYYO8sI2ZNGquHjC1volkb017qz2+\nIO3CzlgaENd6lcBf9OfupLOtW13NTk36oGLdOQrqDJI2ttmSxcBJBHwFjASj\nu1fJ27yHB807NQgTnQxNNyuJAJfM4/3yt6V4MOX2PFkbRwQUurMw7UXM2mCx\nAsmmB/AZ1XV4Q4X9IqI08jtofLcQcFmfbD1jf+FVTxnKru7/D6/AT3vFzzeS\nsRbTxIeWwXeMnG8Y2BH1O+wxeywJW3BkpJpm2s6NfvaGM656Vj1Copo5QIcX\nzZ6u\r\n=oxRD\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-health-node\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-health-node/preview.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-node)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-health-node.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-node)\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-node\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-node/HealthClient\");\nconst {\n  DescribeAffectedEntitiesCommand\n} = require(\"@aws-sdk/client-health-node/commands/DescribeAffectedEntitiesCommand\");\n```\n\n```javascript\n//TypeScript\nimport { HealthClient } from \"@aws-sdk/client-health-node/HealthClient\";\nimport { DescribeAffectedEntitiesCommand } from \"@aws-sdk/client-health-node/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-node/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-node' 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":"npm run pretest && node ./test/smoke/index.spec.js","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-node has been renamed to @aws-sdk/client-health. Please install the renamed package.","_npmVersion":"6.9.0","description":"Node 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/hash-node":"^0.1.0-preview.6","@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/util-utf8-node":"^0.1.0-preview.4","@aws-sdk/config-resolver":"^0.1.0-preview.5","@aws-sdk/region-provider":"^0.1.0-preview.5","@aws-sdk/url-parser-node":"^0.1.0-preview.6","@aws-sdk/middleware-stack":"^0.1.0-preview.6","@aws-sdk/retry-middleware":"^0.1.0-preview.5","@aws-sdk/util-base64-node":"^0.1.0-preview.4","@aws-sdk/node-http-handler":"^0.1.0-preview.6","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.6","@aws-sdk/signing-middleware":"^0.1.0-preview.7","@aws-sdk/util-user-agent-node":"^0.1.0-preview.7","@aws-sdk/middleware-serializer":"^0.1.0-preview.5","@aws-sdk/stream-collector-node":"^0.1.0-preview.6","@aws-sdk/util-body-length-node":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.6","@aws-sdk/credential-provider-node":"^0.1.0-preview.7","@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","@types/node":"^10.0.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-health-node_0.1.0-preview.3_1568909180839_0.013730931112364342","host":"s3://npm-registry-packages"}},"0.1.0-preview.4":{"name":"@aws-sdk/client-health-node","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-node@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":"37af9cdba03969f8e279e8db1520cdefd70f90fe","tarball":"https://registry.npmjs.org/@aws-sdk/client-health-node/-/client-health-node-0.1.0-preview.4.tgz","fileCount":308,"integrity":"sha512-uovCBucfozcwb31UKxoYClyTDBWTWZDbhNaZo8buRy64WrN9S86HT/hBaLdeKcyGtN/80mA/s5Bx2r0ucXsRgg==","signatures":[{"sig":"MEUCIEJefFrM+9god0VNK9uzUUSNQ8cPKioZ0Tbjln7vL59VAiEA7r/5oE4E8xitZyXXGnpzhFOIbrInHtnSkFTqvfPnqZs=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178293,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJduND0CRA9TVsSAnZWagAAljEP/Ai2sjR2MSme9nRIM5W2\nxyQUE/te9opa+wbMhSagKHxrJbBhLFjYEraY8hL+TQH3PtAmiM229//n/jhY\ntQQ5f1agUbbd89C51seA018pjbyFdt1zvQ/m2haRx1Bpdfzi7KKcHu2TIr9E\nErIAKk9B3VigWaMKyzgTddmruZmhD1wB/QDOqCXt0ZoPJRb72kOZpIM1bHj3\ntNrTS/K3hYDYk88B+w7j5tle1CMKnkBEk/GWsvUwsVfAAlKJmnU40AyhO0cH\nBYFDAZTPK0OXkbwLZlfrLhb0G/f0pGIXjx+k2xCYNwaU32no/adEAarsg6EI\niLQKsX/dqw9Jxub9ELn1PeQ0j+8h5/TBdmSeXjKieLUiVeaIgQkUAN0aBHOH\nCm7JYiSfd7CtbR8iI9t981FKBsT/r0c/q1IPA+8X1hGjg6qwY5jV0owPhJ6o\nWUvAwe9Ph3wxuAMM0R+FO/mZXponLhyOyGo5r86a390Xis56dnlWNCbYbMIq\nDlROHaImDj91bM3NVcZf00bwe4pvUXGpFJvVDYabnysWGz1S9QeQ7YhoFAit\nDrHOdWDoA13uPOi254AnyErONYImYDvJV8bY7bW+Dp7LovHtpV6HjC41cZVe\n1sX+3B3zWb6cxO7rrPxsK/Cv36Bpl4phgnroE12jpRjXtt3/+qf6YkVmSH7x\nYT0o\r\n=7cEj\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-health-node\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-health-node/preview.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-node)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-health-node.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-node)\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-node\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-node\");\n```\n\n```javascript\n//TypeScript\nimport {\n  HealthClient,\n  DescribeAffectedEntitiesCommand\n} from \"@aws-sdk/client-health-node\";\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-node\";\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-node' 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":"npm run pretest && node ./test/smoke/index.spec.js","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-node has been renamed to @aws-sdk/client-health. Please install the renamed package.","_npmVersion":"6.9.0","description":"Node 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/hash-node":"^0.1.0-preview.7","@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/util-utf8-node":"^0.1.0-preview.4","@aws-sdk/config-resolver":"^0.1.0-preview.6","@aws-sdk/region-provider":"^0.1.0-preview.6","@aws-sdk/url-parser-node":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.7","@aws-sdk/retry-middleware":"^0.1.0-preview.6","@aws-sdk/util-base64-node":"^0.1.0-preview.4","@aws-sdk/node-http-handler":"^0.1.0-preview.7","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.7","@aws-sdk/signing-middleware":"^0.1.0-preview.8","@aws-sdk/util-user-agent-node":"^0.1.0-preview.8","@aws-sdk/middleware-serializer":"^0.1.0-preview.6","@aws-sdk/stream-collector-node":"^0.1.0-preview.7","@aws-sdk/util-body-length-node":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.7","@aws-sdk/credential-provider-node":"^0.1.0-preview.8","@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","@types/node":"^10.0.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-health-node_0.1.0-preview.4_1572393203544_0.33433702356696826","host":"s3://npm-registry-packages"}},"0.1.0-preview.5":{"name":"@aws-sdk/client-health-node","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-node@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":"12e70560d36fa3b418a6a84e4ed7a7b64ab78c3d","tarball":"https://registry.npmjs.org/@aws-sdk/client-health-node/-/client-health-node-0.1.0-preview.5.tgz","fileCount":308,"integrity":"sha512-szR08+/B4RC9lwngyXnwEfJXJbZD7oTLnVBcTPvrU+rzVc5rnJ3A3Nu8HYEPphs/h4NXdejVnfGrgB2MjkojoQ==","signatures":[{"sig":"MEUCIQDAb098+4Y2OQWZWHlUVzTPDGD4bAbQVlnpJNcDntVvNAIgHbO0dZbyKdXkaGZNDWM50Z2DJrLSAPdlLD2HDGM9fqw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178537,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdueQpCRA9TVsSAnZWagAAKIcP/3QYd9IS5p4wtB4aeiy/\n2tzDBOkVq/J0v2D5AEyIy/AH2rgB0OC84+M0wht/T8bIMdEkMXX3J5tlA9bK\nXfnXHpZtzjPUnC5OfaW+DArQBw13uCMVEWwQqUXPRuLUmrj5Qx1Dd+rlOd9s\nSvkTvLZ9seSHhKzv7F7R+vUM4Qt0J8aUuJ8cZDhdks8NOcEJFeCMjRvk3XYl\npIiTyXhwGSRwGtD3wT7mL7jqPzM33+7nTTiFLsdSlArSccK7TQI9sk0uUXEX\nvEEfHpAsV/6qQ5hXGSyS8piesTtP2IvA4IlvcirWEnJ+1dal21sYQE0mPbdT\nxJVx/KxZ1snpAr22ySWI0F6WZKn3PFQ8ZpztyWa2oQIMNVlMUwCmujKqNQ5r\n3vfrExjgKbkU/qyUYX92G+diQT1Moen4Ke8Mpe+e/ZQCJ25wuYw322o7pH1H\nO33G+fwwi4kNKzFExtHDSD+u4rYgUO4fGHlxQ1suUdh2j35a6ewZkA93HH6H\ny7PltIzB4x1YBaZq2RvoA+ykjF8ldojFKsHEzyyRtUomHrLgs7mTpLHWNGyq\n82ZXXMyFBw4S0bbahlxIrErkOorXQwXHHw4m8tM00uRv2ZLYMiclsypXEjgd\nDsjJSzn/UePVKBD/zj17QFvYYmAxjYlngbmwg/J8yxHa65l3VVIBsixh+Hsc\n2y7A\r\n=iRYj\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-health-node\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-health-node/preview.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-node)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-health-node.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-node)\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-node\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-node\");\n```\n\n```javascript\n//TypeScript\nimport {\n  HealthClient,\n  DescribeAffectedEntitiesCommand\n} from \"@aws-sdk/client-health-node\";\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-node\";\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-node' 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":"npm run pretest && node ./test/smoke/index.spec.js","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-node has been renamed to @aws-sdk/client-health. Please install the renamed package.","_npmVersion":"6.9.0","description":"Node 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/hash-node":"^0.1.0-preview.8","@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/util-utf8-node":"^0.1.0-preview.4","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/region-provider":"^0.1.0-preview.7","@aws-sdk/url-parser-node":"^0.1.0-preview.8","@aws-sdk/middleware-stack":"^0.1.0-preview.8","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-sdk/util-base64-node":"^0.1.0-preview.4","@aws-sdk/node-http-handler":"^0.1.0-preview.8","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.8","@aws-sdk/signing-middleware":"^0.1.0-preview.9","@aws-sdk/util-user-agent-node":"^0.1.0-preview.9","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/stream-collector-node":"^0.1.0-preview.8","@aws-sdk/util-body-length-node":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/credential-provider-node":"^0.1.0-preview.9","@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","@types/node":"^10.0.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-health-node_0.1.0-preview.5_1572463656648_0.9031876530848992","host":"s3://npm-registry-packages"}},"0.1.0-preview.6":{"name":"@aws-sdk/client-health-node","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-node@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":"e3a70a1eed98d9fe020ec429ccd2f77498e3f111","tarball":"https://registry.npmjs.org/@aws-sdk/client-health-node/-/client-health-node-0.1.0-preview.6.tgz","fileCount":308,"integrity":"sha512-YCGdwS7Jf8SxaCW68/wzTh3rPLSwUM/VCKEPvHQIkc1Ij7fbzqT3asxi+nUt5SmLLRKuVEdfUr+RkCLb7kJNnw==","signatures":[{"sig":"MEUCIDCuq0zVbDL6DHTzEEiJoQdh7ouJeg1E85J3U/nCH5EFAiEAwbelW5KKi/GG+C3imjLONTphd1c3k1mo8vgLh0w0kjQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":178809,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd1FRYCRA9TVsSAnZWagAA6ZMQAI7d7tvWSdwllx685xJC\nPWJ2dCggLS7moTu4vcrMQuVZ4pRQ1HQOot22Ut4tKyxoVSkEgqAZ50kfakMt\nP398Ik/ARUQgFOIl5nBIt2Bjt5q0SxKK9RRsNi+XIjNtwvj8X0cQ/7eYeTUV\n2W4uJxMnG3OVg24AO+jfmmS/yZhg5zqAyAbG6wjencJETu6PqNPUBBihbSU1\njYW9R1cA3GKLtcIyXIe1VS2UpwEj+/I2o6lazxygqiHNp27jMrMzsJc+9T6E\nMtdXUnopjOpQRQGp0U7M1K6OoN7kXZ0R7LePChX/sQ/N9ejWTDcRjT0t7Y+j\nlJSeinSrFdq9rJUFYOnsdtlK6cCIDL4Oc/eOc7w46LnsotfiThU809CMJ4AR\n9GshJyZ9o4A5JxfPrePp8D1YuMvB1MmyWQmS7/J6CBKeiGV4FVYd+CUeZ0Rm\nXa8zU8mYmvmJZkCGRQq5q4DkYDiMrMrOolWYBuCkA1iNDHbJMC5YoNSYqhkV\nXA7SK08IEsWbuu7KjnDvlLrer9C//W0/s2aU4TUNHIOqQaWbTJQ8GrtUs2e3\n7g0lenCEkVBhjWey46sIXeZJM/iHjmvqGisQWFDsDE/GQ0xaXrnmFBIfovCU\nx6dfPP6z3dzPC3brlWSKXDG3ppIIUh2eXtswyuC6LTDWVyJXEVVejI7iFL8B\n2voe\r\n=bEQ9\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-health-node\n\n[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-health-node/preview.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-node)\n[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-health-node.svg)](https://www.npmjs.com/package/@aws-sdk/client-health-node)\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-node\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-node\");\n```\n\n```javascript\n//TypeScript\nimport {\n  HealthClient,\n  DescribeAffectedEntitiesCommand\n} from \"@aws-sdk/client-health-node\";\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-node\";\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-node' 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":"npm run pretest && node ./test/smoke/index.spec.js","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-node has been renamed to @aws-sdk/client-health. Please install the renamed package.","_npmVersion":"6.9.0","description":"Node 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/hash-node":"^0.1.0-preview.8","@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/util-utf8-node":"^0.1.0-preview.4","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/region-provider":"^0.1.0-preview.7","@aws-sdk/url-parser-node":"^0.1.0-preview.8","@aws-sdk/middleware-stack":"^0.1.0-preview.9","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-sdk/util-base64-node":"^0.1.0-preview.4","@aws-sdk/node-http-handler":"^0.1.0-preview.8","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.8","@aws-sdk/signing-middleware":"^0.1.0-preview.10","@aws-sdk/util-user-agent-node":"^0.1.0-preview.10","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/stream-collector-node":"^0.1.0-preview.9","@aws-sdk/util-body-length-node":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/credential-provider-node":"^0.1.0-preview.10","@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","@types/node":"^10.0.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-health-node_0.1.0-preview.6_1574196312423_0.532104893019548","host":"s3://npm-registry-packages"}}},"time":{"created":"2019-09-09T17:52:07.072Z","modified":"2025-03-27T18:39:05.142Z","0.1.0-preview.2":"2019-09-09T17:52:07.411Z","0.1.0-preview.3":"2019-09-19T16:06:20.988Z","0.1.0-preview.4":"2019-10-29T23:53:23.687Z","0.1.0-preview.5":"2019-10-30T19:27:36.841Z","0.1.0-preview.6":"2019-11-19T20:45:12.535Z"},"author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","description":"Node 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":""}