@aws-sdk/client-guardduty

Description

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

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes
the following foundational data sources - VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event
logs, EKS audit logs, DNS logs, Amazon EBS volume data, runtime activity belonging to container workloads, such
as Amazon EKS, Amazon ECS (including Amazon Web Services Fargate), and Amazon EC2 instances.
It uses threat intelligence
feeds, such as lists of malicious IPs and domains, and machine learning to identify
unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment.
This can include issues like escalations of privileges, uses of exposed credentials, or
communication with malicious IPs, domains, or presence of malware on your Amazon EC2 instances
and container workloads. For example, GuardDuty can detect compromised EC2 instances and
container workloads serving malware, or mining bitcoin.

GuardDuty also monitors Amazon Web Services account access behavior for signs of compromise, such as
unauthorized infrastructure deployments like EC2 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 about the status of your Amazon Web Services environment by producing security
findings that you can view in the GuardDuty console or through Amazon EventBridge. For more
information, see the
Amazon
GuardDuty User Guide
.

Installing

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

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the GuardDutyClient and
the commands you need, for example ListDetectorsCommand:

``js
// ES5 example
const { GuardDutyClient, ListDetectorsCommand } = require("@aws-sdk/client-guardduty");
`

`ts
// ES6+ example
import { GuardDutyClient, ListDetectorsCommand } from "@aws-sdk/client-guardduty";
`

$3

To send a request, you:

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

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

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

#### Async/await

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

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

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

#### Promises

You can also use Promise chaining
to execute send operation.

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

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

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

#### Callbacks

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

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

#### v2 compatible style

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

`ts
import * as AWS from "@aws-sdk/client-guardduty";
const client = new AWS.GuardDuty({ region: "REGION" });

// async/await.
try {
const data = await client.listDetectors(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listDetectors(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listDetectors(params, (err, data) => {
// process err and data.
});
`

$3

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

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

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

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

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

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-guardduty` package is updated.
To contribute to client you can check our generate clients scripts.

License

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

Client Commands (Operations List)

AcceptAdministratorInvitation

Command API Reference / Input / Output

AcceptInvitation

Command API Reference / Input / Output

ArchiveFindings

Command API Reference / Input / Output

CreateDetector

Command API Reference / Input / Output

CreateFilter

Command API Reference / Input / Output

CreateIPSet

Command API Reference / Input / Output

CreateMalwareProtectionPlan

Command API Reference / Input / Output

CreateMembers

Command API Reference / Input / Output

CreatePublishingDestination

Command API Reference / Input / Output

CreateSampleFindings

Command API Reference / Input / Output

CreateThreatEntitySet

Command API Reference / Input / Output

CreateThreatIntelSet

Command API Reference / Input / Output

CreateTrustedEntitySet

Command API Reference / Input / Output

DeclineInvitations

Command API Reference / Input / Output

DeleteDetector

Command API Reference / Input / Output

DeleteFilter

Command API Reference / Input / Output

DeleteInvitations

Command API Reference / Input / Output

DeleteIPSet

Command API Reference / Input / Output

DeleteMalwareProtectionPlan

Command API Reference / Input / Output

DeleteMembers

Command API Reference / Input / Output

DeletePublishingDestination

Command API Reference / Input / Output

DeleteThreatEntitySet

Command API Reference / Input / Output

DeleteThreatIntelSet

Command API Reference / Input / Output

DeleteTrustedEntitySet

Command API Reference / Input / Output

DescribeMalwareScans

Command API Reference / Input / Output

DescribeOrganizationConfiguration

Command API Reference / Input / Output

DescribePublishingDestination

Command API Reference / Input / Output

DisableOrganizationAdminAccount

Command API Reference / Input / Output

DisassociateFromAdministratorAccount

Command API Reference / Input / Output

DisassociateFromMasterAccount

Command API Reference / Input / Output

DisassociateMembers

Command API Reference / Input / Output

EnableOrganizationAdminAccount

Command API Reference / Input / Output

GetAdministratorAccount

Command API Reference / Input / Output

GetCoverageStatistics

Command API Reference / Input / Output

GetDetector

Command API Reference / Input / Output

GetFilter

Command API Reference / Input / Output

GetFindings

Command API Reference / Input / Output

GetFindingsStatistics

Command API Reference / Input / Output

GetInvitationsCount

Command API Reference / Input / Output

GetIPSet

Command API Reference / Input / Output

GetMalwareProtectionPlan

Command API Reference / Input / Output

GetMalwareScan

Command API Reference / Input / Output

GetMalwareScanSettings

Command API Reference / Input / Output

GetMasterAccount

Command API Reference / Input / Output

GetMemberDetectors

Command API Reference / Input / Output

GetMembers

Command API Reference / Input / Output

GetOrganizationStatistics

Command API Reference / Input / Output

GetRemainingFreeTrialDays

Command API Reference / Input / Output

GetThreatEntitySet

Command API Reference / Input / Output

GetThreatIntelSet

Command API Reference / Input / Output

GetTrustedEntitySet

Command API Reference / Input / Output

GetUsageStatistics

Command API Reference / Input / Output

InviteMembers

Command API Reference / Input / Output

ListCoverage

Command API Reference / Input / Output

ListDetectors

Command API Reference / Input / Output

ListFilters

Command API Reference / Input / Output

ListFindings

Command API Reference / Input / Output

ListInvitations

Command API Reference / Input / Output

ListIPSets

Command API Reference / Input / Output

ListMalwareProtectionPlans

Command API Reference / Input / Output

ListMalwareScans

Command API Reference / Input / Output

ListMembers

Command API Reference / Input / Output

ListOrganizationAdminAccounts

Command API Reference / Input / Output

ListPublishingDestinations

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListThreatEntitySets

Command API Reference / Input / Output

ListThreatIntelSets

Command API Reference / Input / Output

ListTrustedEntitySets

Command API Reference / Input / Output

SendObjectMalwareScan

Command API Reference / Input / Output

StartMalwareScan

Command API Reference / Input / Output

StartMonitoringMembers

Command API Reference / Input / Output

StopMonitoringMembers

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UnarchiveFindings

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateDetector

Command API Reference / Input / Output

UpdateFilter

Command API Reference / Input / Output

UpdateFindingsFeedback

Command API Reference / Input / Output

UpdateIPSet

Command API Reference / Input / Output

UpdateMalwareProtectionPlan

Command API Reference / Input / Output

UpdateMalwareScanSettings

Command API Reference / Input / Output

UpdateMemberDetectors

Command API Reference / Input / Output

UpdateOrganizationConfiguration

Command API Reference / Input / Output

UpdatePublishingDestination

Command API Reference / Input / Output

UpdateThreatEntitySet

Command API Reference / Input / Output

UpdateThreatIntelSet

Command API Reference / Input / Output

UpdateTrustedEntitySet

Command API Reference / Input / Output