@aws-sdk/client-docdb

Description

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

Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud. With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.

Installing

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

• npm install @aws-sdk/client-docdb
• yarn add @aws-sdk/client-docdb
• pnpm add @aws-sdk/client-docdb

Getting Started

Import

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

// ES5 example
const { DocDBClient, ListTagsForResourceCommand } = require("@aws-sdk/client-docdb");

// ES6+ example
import { DocDBClient, ListTagsForResourceCommand } from "@aws-sdk/client-docdb";

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 DocDBClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListTagsForResourceCommand(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-docdb";
const client = new AWS.DocDB({ region: "REGION" });

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

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

// callbacks.
client.listTagsForResource(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.

• 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-docdb 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)

AddSourceIdentifierToSubscription

Command API Reference / Input / Output

AddTagsToResource

Command API Reference / Input / Output

ApplyPendingMaintenanceAction

Command API Reference / Input / Output

CopyDBClusterParameterGroup

Command API Reference / Input / Output

CopyDBClusterSnapshot

Command API Reference / Input / Output

CreateDBCluster

Command API Reference / Input / Output

CreateDBClusterParameterGroup

Command API Reference / Input / Output

CreateDBClusterSnapshot

Command API Reference / Input / Output

CreateDBInstance

Command API Reference / Input / Output

CreateDBSubnetGroup

Command API Reference / Input / Output

CreateEventSubscription

Command API Reference / Input / Output

CreateGlobalCluster

Command API Reference / Input / Output

DeleteDBCluster

Command API Reference / Input / Output

DeleteDBClusterParameterGroup

Command API Reference / Input / Output

DeleteDBClusterSnapshot

Command API Reference / Input / Output

DeleteDBInstance

Command API Reference / Input / Output

DeleteDBSubnetGroup

Command API Reference / Input / Output

DeleteEventSubscription

Command API Reference / Input / Output

DeleteGlobalCluster

Command API Reference / Input / Output

DescribeCertificates

Command API Reference / Input / Output

DescribeDBClusterParameterGroups

Command API Reference / Input / Output

DescribeDBClusterParameters

Command API Reference / Input / Output

DescribeDBClusters

Command API Reference / Input / Output

DescribeDBClusterSnapshotAttributes

Command API Reference / Input / Output

DescribeDBClusterSnapshots

Command API Reference / Input / Output

DescribeDBEngineVersions

Command API Reference / Input / Output

DescribeDBInstances

Command API Reference / Input / Output

DescribeDBSubnetGroups

Command API Reference / Input / Output

DescribeEngineDefaultClusterParameters

Command API Reference / Input / Output

DescribeEventCategories

Command API Reference / Input / Output

DescribeEvents

Command API Reference / Input / Output

DescribeEventSubscriptions

Command API Reference / Input / Output

DescribeGlobalClusters

Command API Reference / Input / Output

DescribeOrderableDBInstanceOptions

Command API Reference / Input / Output

DescribePendingMaintenanceActions

Command API Reference / Input / Output

FailoverDBCluster

Command API Reference / Input / Output

FailoverGlobalCluster

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ModifyDBCluster

Command API Reference / Input / Output

ModifyDBClusterParameterGroup

Command API Reference / Input / Output

ModifyDBClusterSnapshotAttribute

Command API Reference / Input / Output

ModifyDBInstance

Command API Reference / Input / Output

ModifyDBSubnetGroup

Command API Reference / Input / Output

ModifyEventSubscription

Command API Reference / Input / Output

ModifyGlobalCluster

Command API Reference / Input / Output

RebootDBInstance

Command API Reference / Input / Output

RemoveFromGlobalCluster

Command API Reference / Input / Output

RemoveSourceIdentifierFromSubscription

Command API Reference / Input / Output

RemoveTagsFromResource

Command API Reference / Input / Output

ResetDBClusterParameterGroup

Command API Reference / Input / Output

RestoreDBClusterFromSnapshot

Command API Reference / Input / Output

RestoreDBClusterToPointInTime

Command API Reference / Input / Output

StartDBCluster

Command API Reference / Input / Output

StopDBCluster

Command API Reference / Input / Output

SwitchoverGlobalCluster

Command API Reference / Input / Output