@aws-sdk/client-sts

What is @aws-sdk/client-sts?

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).

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

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);
});

Other packages similar to @aws-sdk/client-sts

aws-sdk

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.

aws-amplify

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.

README

@aws-sdk/client-sts

Description

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 users. This guide provides descriptions of the STS API. For more information about using this service, see Temporary Security Credentials.

Installing

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

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

Getting Started

Import

The 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 GetCallerIdentityCommand:

// ES5 example
const { STSClient, GetCallerIdentityCommand } = require("@aws-sdk/client-sts");

// ES6+ example
import { STSClient, GetCallerIdentityCommand } from "@aws-sdk/client-sts";

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

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

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

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

// callbacks.
client.getCallerIdentity(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-sts 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)

AssumeRole

Command API Reference / Input / Output

AssumeRoleWithSAML

Command API Reference / Input / Output

AssumeRoleWithWebIdentity

Command API Reference / Input / Output

DecodeAuthorizationMessage

Command API Reference / Input / Output

GetAccessKeyInfo

Command API Reference / Input / Output

GetCallerIdentity

Command API Reference / Input / Output

GetFederationToken

Command API Reference / Input / Output

GetSessionToken

Command API Reference / Input / Output

Changelog

3.423.0 (2023-10-02)

Bug Fixes

• credential-provider-http: use alternate browser entry point (#5277) (a3f0754)
• middleware-sdk-ec2: fix presigning of boolean query param (#5278) (fa961c2)

Features

• client-bedrock-runtime: Add model timeout exception for InvokeModelWithResponseStream API and update validator for invoke model identifier. (b07fb6e)
• client-bedrock: Provisioned throughput feature with Amazon and third-party base models, and update validators for model identifier and taggable resource ARNs. (441ce01)
• client-ec2: Introducing Amazon EC2 R7iz instances with 3.9 GHz sustained all-core turbo frequency and deliver up to 20% better performance than previous generation z1d instances. (bd24ace)
• client-rds: Adds DefaultCertificateForNewLaunches field in the DescribeCertificates API response. (679fd29)
• client-sso: Fix FIPS Endpoints in aws-us-gov. (0b76346)
• client-sts: STS API updates for assumeRole (d233302)
• clients: update client endpoints as of 2023-10-02 (f5a47e7)