@aws-sdk/client-macie

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

@aws-sdk/client-macie

Description

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

Amazon Macie Classic

Amazon Macie Classic has been discontinued and is no longer available.

A new Amazon Macie is now available with significant design improvements and additional features, at a lower price and in most Amazon Web Services Regions. We encourage you to take advantage of the new and improved features, and benefit from the reduced cost. To learn about features and pricing for the new Macie, see Amazon Macie. To learn how to use the new Macie, see the Amazon Macie User Guide.

Installing

To install the this package, simply type add or install @aws-sdk/client-macie using your favorite package manager:

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

Getting Started

Import

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

// ES5 example
const { MacieClient, ListS3ResourcesCommand } = require("@aws-sdk/client-macie");

// ES6+ example
import { MacieClient, ListS3ResourcesCommand } from "@aws-sdk/client-macie";

Usage

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.

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

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

Async/await

We recommend using 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.
}

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.

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

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

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.

// 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

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

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

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

// callbacks.
client.listS3Resources(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 the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.