@aws-sdk/client-sts
Advanced tools
AWS SDK for JavaScript Sts Client for Node.js, Browser and React Native
The @aws-sdk/client-sts package is a modular AWS SDK for JavaScript clients for AWS Security Token Service (STS). It allows developers to interact with the STS service, enabling them to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users).
AssumeRole
AssumeRole allows you to request temporary security credentials for a role. This is useful for scenarios where you need to grant access to your AWS resources to users or systems without AWS accounts.
const { STSClient, AssumeRoleCommand } = require('@aws-sdk/client-sts');
const client = new STSClient({ region: 'us-west-2' });
const command = new AssumeRoleCommand({
RoleArn: 'arn:aws:iam::123456789012:role/demo',
RoleSessionName: 'session1'
});
client.send(command).then((response) => {
console.log(response.Credentials);
});GetSessionToken
GetSessionToken is used to retrieve a session token for use with AWS services. This is typically used when you have an IAM user and you want to create a temporary session with enhanced security, such as MFA.
const { STSClient, GetSessionTokenCommand } = require('@aws-sdk/client-sts');
const client = new STSClient({ region: 'us-west-2' });
const command = new GetSessionTokenCommand({
DurationSeconds: 3600
});
client.send(command).then((response) => {
console.log(response.Credentials);
});AssumeRoleWithWebIdentity
AssumeRoleWithWebIdentity allows you to request temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider.
const { STSClient, AssumeRoleWithWebIdentityCommand } = require('@aws-sdk/client-sts');
const client = new STSClient({ region: 'us-west-2' });
const command = new AssumeRoleWithWebIdentityCommand({
RoleArn: 'arn:aws:iam::123456789012:role/demo',
RoleSessionName: 'web-identity-session',
WebIdentityToken: 'token'
});
client.send(command).then((response) => {
console.log(response.Credentials);
});The 'aws-sdk' package is the older version of the AWS SDK for JavaScript. It includes the STS service client as well, but it is not modular like the '@aws-sdk/client-sts' package. The 'aws-sdk' package includes all AWS services in one large bundle, which can result in larger bundle sizes for front-end projects.
The 'aws-amplify' package is a library designed to help developers build cloud-enabled applications with AWS. While it provides higher-level abstractions for authentication and authorization, it also allows for direct interaction with AWS services, including STS, through the Auth module. It is more opinionated and integrates with other AWS Amplify features.
AWS SDK for JavaScript STS Client for Node.js, Browser and React Native.
Security Token Service
Security Token Service (STS) enables you to request temporary, limited-privilege credentials for Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more information about using this service, see Temporary Security Credentials.
To install the this package, simply type add or install @aws-sdk/client-sts using your favorite package manager:
npm install @aws-sdk/client-stsyarn add @aws-sdk/client-stspnpm add @aws-sdk/client-stsThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the STSClient and
the commands you need, for example AssumeRoleCommand:
// ES5 example
const { STSClient, AssumeRoleCommand } = require("@aws-sdk/client-sts");
// ES6+ example
import { STSClient, AssumeRoleCommand } from "@aws-sdk/client-sts";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new STSClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new AssumeRoleCommand(params);
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.
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.
});
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.
});
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-sts";
const client = new AWS.STS({ region: "REGION" });
// async/await.
try {
const data = await client.assumeRole(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.assumeRole(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.assumeRole(params, (err, data) => {
// process err and data.
});
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;
* }
*/
}
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.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-sts package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.309.0 (2023-04-07)
FAQs
AWS SDK for JavaScript Sts Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-sts receives a total of 3,968,336 weekly downloads. As such, @aws-sdk/client-sts popularity was classified as popular.
We found that @aws-sdk/client-sts demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.