@aws-sdk/client-secrets-manager

What is @aws-sdk/client-secrets-manager?

The @aws-sdk/client-secrets-manager package is a client library for interacting with AWS Secrets Manager service. It allows developers to manage secrets needed in their applications without hardcoding sensitive information. The package provides functionalities such as creating, reading, updating, and deleting secrets, as well as retrieving the current value of a secret.

What are @aws-sdk/client-secrets-manager's main functionalities?

Create a Secret

This code sample demonstrates how to create a new secret in AWS Secrets Manager.

const { SecretsManagerClient, CreateSecretCommand } = require('@aws-sdk/client-secrets-manager');

const client = new SecretsManagerClient({ region: 'your-region' });
const command = new CreateSecretCommand({
  Name: 'MyTestSecret',
  SecretString: 'MySecretValue'
});

const run = async () => {
  try {
    const data = await client.send(command);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
};

run();

Retrieve a Secret Value

This code sample shows how to retrieve the current value of a secret stored in AWS Secrets Manager.

const { SecretsManagerClient, GetSecretValueCommand } = require('@aws-sdk/client-secrets-manager');

const client = new SecretsManagerClient({ region: 'your-region' });
const command = new GetSecretValueCommand({
  SecretId: 'MyTestSecret'
});

const run = async () => {
  try {
    const data = await client.send(command);
    console.log(data.SecretString);
  } catch (error) {
    console.error(error);
  }
};

run();

Update a Secret

This code sample illustrates how to update the value of an existing secret in AWS Secrets Manager.

const { SecretsManagerClient, UpdateSecretCommand } = require('@aws-sdk/client-secrets-manager');

const client = new SecretsManagerClient({ region: 'your-region' });
const command = new UpdateSecretCommand({
  SecretId: 'MyTestSecret',
  SecretString: 'NewSecretValue'
});

const run = async () => {
  try {
    const data = await client.send(command);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
};

run();

Other packages similar to @aws-sdk/client-secrets-manager

node-vault

node-vault is a client library for HashiCorp Vault, a tool for managing secrets. While @aws-sdk/client-secrets-manager is specifically designed for AWS Secrets Manager, node-vault is used for interacting with Vault by HashiCorp. Both provide similar functionalities in terms of secrets management but are intended for different secret storage services.

azure-keyvault-secrets

azure-keyvault-secrets is a client library for managing secrets in Azure Key Vault. Similar to @aws-sdk/client-secrets-manager, it allows for creating, retrieving, updating, and deleting secrets. The main difference lies in the cloud provider, with azure-keyvault-secrets being specific to Azure's ecosystem.

README

@aws-sdk/client-secrets-manager

Description

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

Amazon Web Services Secrets Manager

Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.

This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the Amazon Web Services Secrets Manager User Guide.

API Version

This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.

For a list of endpoints, see Amazon Web Services Secrets Manager endpoints.

Support and Feedback for Amazon Web Services Secrets Manager

We welcome your feedback. Send your comments to [e-mail], or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more information about the Amazon Web Services Discussion Forums, see Forums Help.

Logging API Requests

Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information that's collected by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services CloudTrail, see Logging Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.

Installing

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

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

Getting Started

Import

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

// ES5 example
const { SecretsManagerClient, ListSecretsCommand } = require("@aws-sdk/client-secrets-manager");

// ES6+ example
import { SecretsManagerClient, ListSecretsCommand } from "@aws-sdk/client-secrets-manager";

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

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

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

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

// callbacks.
client.listSecrets(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-secrets-manager 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)

BatchGetSecretValue

Command API Reference / Input / Output

CancelRotateSecret

Command API Reference / Input / Output

CreateSecret

Command API Reference / Input / Output

DeleteResourcePolicy

Command API Reference / Input / Output

DeleteSecret

Command API Reference / Input / Output

DescribeSecret

Command API Reference / Input / Output

GetRandomPassword

Command API Reference / Input / Output

GetResourcePolicy

Command API Reference / Input / Output

GetSecretValue

Command API Reference / Input / Output

ListSecrets

Command API Reference / Input / Output

ListSecretVersionIds

Command API Reference / Input / Output

PutResourcePolicy

Command API Reference / Input / Output

PutSecretValue

Command API Reference / Input / Output

RemoveRegionsFromReplication

Command API Reference / Input / Output

ReplicateSecretToRegions

Command API Reference / Input / Output

RestoreSecret

Command API Reference / Input / Output

RotateSecret

Command API Reference / Input / Output

StopReplicationToReplica

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateSecret

Command API Reference / Input / Output

UpdateSecretVersionStage

Command API Reference / Input / Output

ValidateResourcePolicy

Command API Reference / Input / Output

Changelog

3.572.0 (2024-05-08)

Features

• client-cognito-identity-provider: Add EXTERNAL_PROVIDER enum value to UserStatusType. (0189ee3)
• client-ec2: Adding Precision Hardware Clock (PHC) to public API DescribeInstanceTypes (711a8ff)
• client-ecr: This release adds pull through cache rules support for GitLab container registry in Amazon ECR. (a05338f)
• client-polly: Add new engine - generative - that builds the most expressive conversational voices. (daf6bd4)
• client-sqs: This release adds MessageSystemAttributeNames to ReceiveMessageRequest to replace AttributeNames. (35284e8)
• clients: update client endpoints as of 2024-05-08 (1e71a11)