@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 awssecretsmanager-feedback@amazon.com, 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
:
const { SecretsManagerClient, ListSecretsCommand } = require("@aws-sdk/client-secrets-manager");
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.
const client = new SecretsManagerClient({ region: "REGION" });
const params = {
};
const command = new ListSecretsCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} 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) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, 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" });
try {
const data = await client.listSecrets(params);
} catch (error) {
}
client
.listSecrets(params)
.then((data) => {
})
.catch((error) => {
});
client.listSecrets(params, (err, 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);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
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.
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