Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail event logs, and DNS logs. It uses threat intelligence feeds, such as lists of malicious IPs and domains, and machine learning to identify unexpected and potentially unauthorized and malicious activity within your AWS environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect compromised EC2 instances serving malware or mining bitcoin. It also monitors AWS account access behavior for signs of compromise, such as unauthorized infrastructure deployments, like instances deployed in a region that has never been used, or unusual API calls, like a password policy change to reduce password strength. GuardDuty informs you of the status of your AWS environment by producing security findings that you can view in the GuardDuty console or through Amazon CloudWatch events. For more information, see Amazon GuardDuty User Guide.
\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-guardduty-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(`GuardDutyClient`) and the commands you need, for example `AcceptInvitationCommand`:\n\n```javascript\n//JavaScript\nconst {\n GuardDutyClient\n} = require(\"@aws-sdk/client-guardduty-node/GuardDutyClient\");\nconst {\n AcceptInvitationCommand\n} = require(\"@aws-sdk/client-guardduty-node/commands/AcceptInvitationCommand\");\n```\n\n```javascript\n//TypeScript\nimport { GuardDutyClient } from \"@aws-sdk/client-guardduty-node/GuardDutyClient\";\nimport { AcceptInvitationCommand } from \"@aws-sdk/client-guardduty-node/commands/AcceptInvitationCommand\";\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 guardDuty = new GuardDutyClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n DetectorId: /**a string value*/,\n MasterId: /**a string value*/,\n InvitationId: /**a string value*/,\n};\nconst acceptInvitationCommand = new AcceptInvitationCommand(params);\nguardDuty.send(acceptInvitationCommand).then(data => {\n // do something\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 guardDuty.send(acceptInvitationCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nguardDuty.send(acceptInvitationCommand, (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-guardduty-node/GuardDuty\";\nconst guardDuty = new AWS.GuardDuty({ region: \"region\" });\nguardDuty.acceptInvitation(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 guardDuty.send(acceptInvitationCommand);\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-guardduty-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-guardduty-node has been renamed to @aws-sdk/client-guardduty. Please install the renamed package.","_npmVersion":"6.9.0","description":"Node SDK for Amazon GuardDuty","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/protocol-rest":"^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/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-guardduty-node_0.1.0-preview.3_1568909155470_0.05350629875853885","host":"s3://npm-registry-packages"}},"0.1.0-preview.4":{"name":"@aws-sdk/client-guardduty-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-guardduty-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":"62eff4c0fa442930a4d8927881124a40f70804b5","tarball":"https://registry.npmjs.org/@aws-sdk/client-guardduty-node/-/client-guardduty-node-0.1.0-preview.4.tgz","fileCount":1271,"integrity":"sha512-1D/9QsL1D32SGf9cK9KpvQ9apcLPED8rRDt7nmW9cZ5A7SgPE6gmbDdUxLrk9Quxz4LvJg8kcgEyVdt1VHx5WQ==","signatures":[{"sig":"MEUCIQDvLxmntaSqCAbKEwaA4hh2BN7wR7VxZVvNFogLCLafWQIgGAL58hk4ZpMzqR5DTcYZgvBPdEe+7wHFW7y6ymSVcAk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":680056,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJduNDkCRA9TVsSAnZWagAABtAP/RSbQ2LnSEIGNE/FaYoz\nu98nseM/CHmXSmWPXNPtvhm/psVcYEIC9ejwbyJrqhrdKneYi7SXvqAJggzg\nLQCn0WKyoRIPRf0Ud5psuWvlrzma09RmofJdXZ32w8JfDtaOT9vwN9QPmczM\nhQGO1t3PpLmASI0sh+9JkcyaO7uheCDH6P8Hrkm8V/f4D4HGsTVyMS8dT0Bq\nZ2koUTJW2sHZ9II1uBjQucUhKA0qYD8DVC3VcTRypwlyO0pA/5uZkJDaeTyo\nQSvobnfhODFKG7XyHx5TaIPf7qhsJBLEOdwiUV7Y7JiPM1xumPuhWfZR2mc2\nLP96fxPKAtbSBMdZN70vUcAxdRbPMgmsA854zI/+ym9bS/po+sGifuWi/kZa\nyDezC9DgebjoOIYLDx/MkDLxKaV4vidpTyru7KlraMJPmzmDFN6DX0VnBjsx\nWeYsfOE1d0boVBP+4I+jZs7hcFmoe5O1yHSwhB3NXJmUmmGMce+7Lhvbeq8t\nPkJr66mKJTNAuAlGxB0pxOYmpe6GfFnYWOjGlGf244HMvSshdTxPKxa/7gdS\nxbiJvDUIW8ZcYQO2Kbs6fXkM8Pq1ay8n+JjXIdzKt00Qo1mb5Y1sqkV82k+b\n2HUdO25FmczoJmcHjKGAB5RlbIncadu4PbW2T2FZlNrmNgLPKjWh7nEi63HX\nfu8C\r\n=9FTb\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-guardduty-node\n\n[](https://www.npmjs.com/package/@aws-sdk/client-guardduty-node)\n[](https://www.npmjs.com/package/@aws-sdk/client-guardduty-node)\n\n## Description\n\nAmazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail event logs, and DNS logs. It uses threat intelligence feeds, such as lists of malicious IPs and domains, and machine learning to identify unexpected and potentially unauthorized and malicious activity within your AWS environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect compromised EC2 instances serving malware or mining bitcoin. It also monitors AWS account access behavior for signs of compromise, such as unauthorized infrastructure deployments, like instances deployed in a region that has never been used, or unusual API calls, like a password policy change to reduce password strength. GuardDuty informs you of the status of your AWS environment by producing security findings that you can view in the GuardDuty console or through Amazon CloudWatch events. For more information, see Amazon GuardDuty User Guide.
\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-guardduty-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(`GuardDutyClient`) and the commands you need, for example `AcceptInvitationCommand`:\n\n```javascript\n//JavaScript\nconst {\n GuardDutyClient,\n AcceptInvitationCommand\n} = require(\"@aws-sdk/client-guardduty-node\");\n```\n\n```javascript\n//TypeScript\nimport {\n GuardDutyClient,\n AcceptInvitationCommand\n} from \"@aws-sdk/client-guardduty-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 guardDuty = new GuardDutyClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n DetectorId: /**a string value*/,\n MasterId: /**a string value*/,\n InvitationId: /**a string value*/,\n};\nconst acceptInvitationCommand = new AcceptInvitationCommand(params);\nguardDuty.send(acceptInvitationCommand).then(data => {\n // do something\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 guardDuty.send(acceptInvitationCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nguardDuty.send(acceptInvitationCommand, (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-guardduty-node\";\nconst guardDuty = new AWS.GuardDuty({ region: \"region\" });\nguardDuty.acceptInvitation(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 guardDuty.send(acceptInvitationCommand);\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-guardduty-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-guardduty-node has been renamed to @aws-sdk/client-guardduty. Please install the renamed package.","_npmVersion":"6.9.0","description":"Node SDK for Amazon GuardDuty","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/protocol-rest":"^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/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-guardduty-node_0.1.0-preview.4_1572393188437_0.7822936684268096","host":"s3://npm-registry-packages"}},"0.1.0-preview.5":{"name":"@aws-sdk/client-guardduty-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-guardduty-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":"33d4358773352acbb8e700feebf942866e128d15","tarball":"https://registry.npmjs.org/@aws-sdk/client-guardduty-node/-/client-guardduty-node-0.1.0-preview.5.tgz","fileCount":1271,"integrity":"sha512-gH0VgQ+HLwQKfakeNHmhQ+R6yMB4pCqyT939sEada4hWtQiY8sqDsOuTrPEXJZQlg0G+x7IdSPv98HfaE7dyQw==","signatures":[{"sig":"MEQCIBy1KXYhi6o7o0XMXMjiS/ggzDV5kqemM6ywgllB2katAiAlGuXxB6u3JLjq8LqYGd8e7wsdvt7XbzaQ9ZN4cfX5Mw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":680300,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdueQYCRA9TVsSAnZWagAAHyAP/3Rdpjz3J2yHQx9vT3cm\n8auHV9O0HrBrr2jStmReulg9Ajv+3xjMDST+2xzbEjDoYRs1r2iDcFDZnPRX\nF4IeGCrjw9yQAgzWIkJumV7hHyfruBLJy8bLjWHudmb4gZ9IsJmy4XcOR5fb\nmFs8FMQeQjPyqtIuJaYymBX+d9Y1T/OPwf186tZrpvnnCDWOH11qhLcEpSiA\nvYSYYXbVg3Rwd3d0TVpNjj5qBn+qe5TN1Las8xgyoFtQ/5XZ+odXIBiw3IWO\nt9Q+EMZ5Afu1PK2f7HhI/NAnPhp94eqA3sB0C1qask0I9EQLP8QLJjHjy/YB\nc5F0urxrNlHuK06OutTZmr6bgiBzwk+qGgmkYuo43aHQ1YqZfpXbAVv2KrRS\nWZDrwQwTaB1dDE74kpLF3Q3rnzMBFEBVF9MJ3RBJZJ9P2O1ApitCGPschdKJ\nSvyJsMXNMvzEcNqjZ4ICU5a1Uwv7zgy1cLd83cqC8J6gw2BHsvyHS8TJ4te6\n0Ny+JxVsY7uRETUQihwEuR/4CqoQkk8yUftSnJpgYGZDAl4wuBaqWkRvxaEu\nSeKQCtqV3WYNqqUIIlAp0WJ252FHHUPYLVAWPH6kVAPYh0CIY0j68GI3Prf6\n5X4ue5deY/NGeMgIZueZeFWeIVEb6eVsFnNkX9GHJhjonAA6WwJwNtEXvUZl\naj7N\r\n=X6ex\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-guardduty-node\n\n[](https://www.npmjs.com/package/@aws-sdk/client-guardduty-node)\n[](https://www.npmjs.com/package/@aws-sdk/client-guardduty-node)\n\n## Description\n\nAmazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail event logs, and DNS logs. It uses threat intelligence feeds, such as lists of malicious IPs and domains, and machine learning to identify unexpected and potentially unauthorized and malicious activity within your AWS environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect compromised EC2 instances serving malware or mining bitcoin. It also monitors AWS account access behavior for signs of compromise, such as unauthorized infrastructure deployments, like instances deployed in a region that has never been used, or unusual API calls, like a password policy change to reduce password strength. GuardDuty informs you of the status of your AWS environment by producing security findings that you can view in the GuardDuty console or through Amazon CloudWatch events. For more information, see Amazon GuardDuty User Guide.
\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-guardduty-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(`GuardDutyClient`) and the commands you need, for example `AcceptInvitationCommand`:\n\n```javascript\n//JavaScript\nconst {\n GuardDutyClient,\n AcceptInvitationCommand\n} = require(\"@aws-sdk/client-guardduty-node\");\n```\n\n```javascript\n//TypeScript\nimport {\n GuardDutyClient,\n AcceptInvitationCommand\n} from \"@aws-sdk/client-guardduty-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 guardDuty = new GuardDutyClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n DetectorId: /**a string value*/,\n MasterId: /**a string value*/,\n InvitationId: /**a string value*/,\n};\nconst acceptInvitationCommand = new AcceptInvitationCommand(params);\nguardDuty.send(acceptInvitationCommand).then(data => {\n // do something\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 guardDuty.send(acceptInvitationCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nguardDuty.send(acceptInvitationCommand, (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-guardduty-node\";\nconst guardDuty = new AWS.GuardDuty({ region: \"region\" });\nguardDuty.acceptInvitation(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 guardDuty.send(acceptInvitationCommand);\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-guardduty-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-guardduty-node has been renamed to @aws-sdk/client-guardduty. Please install the renamed package.","_npmVersion":"6.9.0","description":"Node SDK for Amazon GuardDuty","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/protocol-rest":"^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/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-guardduty-node_0.1.0-preview.5_1572463639988_0.9953663511810575","host":"s3://npm-registry-packages"}},"0.1.0-preview.6":{"name":"@aws-sdk/client-guardduty-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-guardduty-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":"5ab56d3757d40a6cabaab91dd13369dc3f5d905d","tarball":"https://registry.npmjs.org/@aws-sdk/client-guardduty-node/-/client-guardduty-node-0.1.0-preview.6.tgz","fileCount":1271,"integrity":"sha512-hqpArOSeBC1mwP01Cng7zMqnKOExUURD+v/nG7z6qUIuWUrV+ETDXmCriTZJVHNuXhAhJOdKCAPJyD9oUUIpMQ==","signatures":[{"sig":"MEYCIQCg8+RVwUumwq9C5fctC1QfW55N5vHtCqFYnBQsnXGrYQIhAKCmjgRioFsNfbMN8h4PCGBRuHf8X1SkgrBtGDxPwb74","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":680573,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd1FRZCRA9TVsSAnZWagAA3dYP/1fw1yAD15RMQuThOjjw\nukKadf3WLLSH0zP1TgAnU0YQsV4WffksFplxhdOMvpZz04Y0IMIY0RbxsuPL\nRWVxuOaZ6p3eZ5malLiq9JM1b6wEfMqf1VHtmGiYlkXTPKqvi/dcOWMHfO/E\nqOuFNqfYyNqp53AkabGhrn4AApkGiRubQBGp9GhGYfGmuqnslGEeMFxqY8FP\nTGrU0RC5VxCc6iq1oiEhg2loFd6wgrZp3qcCGbxk2TskcUhbEA6GvGdUelFs\nO/G043oYyWl4+LeLRiXxtG+Q5BF/n+z4ziTpRr0ZNl/H8k7rxk5Su03P2y2E\nWMtahvQiJAC0xEhEZWBFeIBFFwM0OLsbKbM8IUsM3wM2QzP7Y9DIQksm+ka0\nXQVTihjhv6cAqAzhjd2jXjAGFV3Z+2SUir3SIqvRVu6jLe2HnBvpgRyV6w6j\nE1RqZ0tfTWSrNcWOIs+pRPUgR3LVJp2CdSe+D2bZUh69dCxAizOo92ZGYn/h\nJE1trB5Aq2zGPaQygTikGLQXh4TBM2BNMGVcCgwEn/4sC0iZxzoSX76aycD6\nn5N3flc3DZT3iQ2dKLoIfkb5LSwWANvmvhltWhFQnjYhcOjiezfR79gV5UKl\nOCzAmXNzvVoI6yC9VVr6dPMGiFnTlhNQcj2B3/Rp5XXFlFdyoSBf3J4F51zP\nQIZp\r\n=Jd6/\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-guardduty-node\n\n[](https://www.npmjs.com/package/@aws-sdk/client-guardduty-node)\n[](https://www.npmjs.com/package/@aws-sdk/client-guardduty-node)\n\n## Description\n\nAmazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail event logs, and DNS logs. It uses threat intelligence feeds, such as lists of malicious IPs and domains, and machine learning to identify unexpected and potentially unauthorized and malicious activity within your AWS environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect compromised EC2 instances serving malware or mining bitcoin. It also monitors AWS account access behavior for signs of compromise, such as unauthorized infrastructure deployments, like instances deployed in a region that has never been used, or unusual API calls, like a password policy change to reduce password strength. GuardDuty informs you of the status of your AWS environment by producing security findings that you can view in the GuardDuty console or through Amazon CloudWatch events. For more information, see Amazon GuardDuty User Guide.
\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-guardduty-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(`GuardDutyClient`) and the commands you need, for example `AcceptInvitationCommand`:\n\n```javascript\n//JavaScript\nconst {\n GuardDutyClient,\n AcceptInvitationCommand\n} = require(\"@aws-sdk/client-guardduty-node\");\n```\n\n```javascript\n//TypeScript\nimport {\n GuardDutyClient,\n AcceptInvitationCommand\n} from \"@aws-sdk/client-guardduty-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 guardDuty = new GuardDutyClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n DetectorId: /**a string value*/,\n MasterId: /**a string value*/,\n InvitationId: /**a string value*/,\n};\nconst acceptInvitationCommand = new AcceptInvitationCommand(params);\nguardDuty.send(acceptInvitationCommand).then(data => {\n // do something\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 guardDuty.send(acceptInvitationCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\nguardDuty.send(acceptInvitationCommand, (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-guardduty-node\";\nconst guardDuty = new AWS.GuardDuty({ region: \"region\" });\nguardDuty.acceptInvitation(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 guardDuty.send(acceptInvitationCommand);\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-guardduty-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-guardduty-node has been renamed to @aws-sdk/client-guardduty. Please install the renamed package.","_npmVersion":"6.9.0","description":"Node SDK for Amazon GuardDuty","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/protocol-rest":"^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/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-guardduty-node_0.1.0-preview.6_1574196313425_0.6045896495463645","host":"s3://npm-registry-packages"}}},"time":{"created":"2019-09-09T17:52:10.769Z","modified":"2025-03-27T18:39:02.307Z","0.1.0-preview.2":"2019-09-09T17:52:11.196Z","0.1.0-preview.3":"2019-09-19T16:05:55.598Z","0.1.0-preview.4":"2019-10-29T23:53:08.622Z","0.1.0-preview.5":"2019-10-30T19:27:20.124Z","0.1.0-preview.6":"2019-11-19T20:45:13.583Z"},"author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","description":"Node SDK for Amazon GuardDuty","maintainers":[{"email":"osa-3p@amazon.com","name":"amzn-oss"},{"email":"aws-sdk-js-automation@amazon.com","name":"aws-sdk-bot"}],"readme":"","readmeFilename":""}