@aws-sdk/client-detective

Description

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

Detective uses machine learning and purpose-built visualizations to help you to analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by Amazon GuardDuty. The Detective API primarily supports the creation and management of behavior graphs. A behavior graph contains the extracted data from a set of member accounts, and is created and managed by an administrator account. To add a member account to the behavior graph, the administrator account sends an invitation to the account. When the account accepts the invitation, it becomes a member account in the behavior graph. Detective is also integrated with Organizations. The organization management account designates the Detective administrator account for the organization. That account becomes the administrator account for the organization behavior graph. The Detective administrator account is also the delegated administrator account for Detective in Organizations. The Detective administrator account can enable any organization account as a member account in the organization behavior graph. The organization accounts do not receive invitations. The Detective administrator account can also invite other accounts to the organization behavior graph. Every behavior graph is specific to a Region. You can only use the API to manage behavior graphs that belong to the Region that is associated with the currently selected endpoint. The administrator account for a behavior graph can use the Detective API to do the following: <ul> <li> Enable and disable Detective. Enabling Detective creates a new behavior graph. </li> <li> View the list of member accounts in a behavior graph. </li> <li> Add member accounts to a behavior graph. </li> <li> Remove member accounts from a behavior graph. </li> <li> Apply tags to a behavior graph. </li> </ul> The organization management account can use the Detective API to select the delegated administrator for Detective. The Detective administrator account for an organization can use the Detective API to do the following: <ul> <li> Perform all of the functions of an administrator account. </li> <li> Determine whether to automatically enable new organization accounts as member accounts in the organization behavior graph. </li> </ul> An invited member account can use the Detective API to do the following: <ul> <li> View the list of behavior graphs that they are invited to. </li> <li> Accept an invitation to contribute to a behavior graph. </li> <li> Decline an invitation to contribute to a behavior graph. </li> <li> Remove their account from a behavior graph. </li> </ul> All API actions are logged as CloudTrail events. See <a href="https://docs.aws.amazon.com/detective/latest/userguide/logging-using-cloudtrail.html">Logging Detective API Calls with CloudTrail</a>. <note> We replaced the term "master account" with the term "administrator account". An administrator account is used to centrally manage multiple accounts. In the case of Detective, the administrator account manages the accounts in their behavior graph. </note>

Installing

To install this package, use the CLI of your favorite package manager:

npm install @aws-sdk/client-detective
yarn add @aws-sdk/client-detective
pnpm add @aws-sdk/client-detective

Getting Started

Import

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

// ES5 example
const { DetectiveClient, ListGraphsCommand } = require("@aws-sdk/client-detective");

// ES6+ example
import { DetectiveClient, ListGraphsCommand } from "@aws-sdk/client-detective";

Usage

To send a request:

Instantiate a client with configuration (e.g. credentials, region).
- See docs/CLIENTS for configuration details.
- See @aws-sdk/config for additional options.
Instantiate a command with input parameters.
Call the send operation on the client, providing the command object as input.

const client = new DetectiveClient({ region: "REGION" });

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

Async/await

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

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

Promises

You can also use Promise chaining.

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

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

Detective extends DetectiveClient and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (DetectiveClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { Detective } from "@aws-sdk/client-detective";

const client = new Detective({ region: "REGION" });

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

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

// callbacks (not recommended).
client.listGraphs(params, (err, data) => {
  // process err and data.
});

Troubleshooting

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

try {
  const data = await 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 GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

Visit the 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-detective 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)

<details> <summary> AcceptInvitation </summary>