$ cnpm install @aws-sdk/client-sso
AWS SDK for JavaScript SSO Client for Node.js, Browser and React Native.
AWS IAM Identity Center (successor to AWS Single Sign-On) Portal is a web service that makes it easy for you to assign user access to IAM Identity Center resources such as the AWS access portal. Users can get AWS account applications and roles assigned to them and get federated into the application.
<note>Although AWS Single Sign-On was renamed, the sso and
identitystore API namespaces will continue to retain their original name for
backward compatibility purposes. For more information, see IAM Identity Center rename.
This reference guide describes the IAM Identity Center Portal operations that you can call programatically and includes detailed information on data types and errors.
<note>AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
</note>To install this package, use the CLI of your favorite package manager:
npm install @aws-sdk/client-ssoyarn add @aws-sdk/client-ssopnpm add @aws-sdk/client-ssoThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SSOClient and
the commands you need, for example ListAccountsCommand:
// ES5 example
const { SSOClient, ListAccountsCommand } = require("@aws-sdk/client-sso");
// ES6+ example
import { SSOClient, ListAccountsCommand } from "@aws-sdk/client-sso";
To send a request:
send operation on the client, providing the command object as input.const client = new SSOClient({ region: "REGION" });
const params = { /** input parameters */ };
const command = new ListAccountsCommand(params);
We recommend using the 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.
}
You can also use Promise chaining.
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
The aggregated client class is exported from the same package, but without the "Client" suffix.
SSO extends SSOClient and additionally supports all operations, waiters, and paginators as methods.
This style may be familiar to you from the AWS SDK for JavaScript v2.
If you are bundling the AWS SDK, we recommend using only the bare-bones client (SSOClient).
More details are in the blog post on
modular packages in AWS SDK for JavaScript.
import { SSO } from "@aws-sdk/client-sso";
const client = new SSO({ region: "REGION" });
// async/await.
try {
const data = await client.listAccounts(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listAccounts(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks (not recommended).
client.listAccounts(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;
* }
*/
}
See also docs/ERROR_HANDLING.
Please use these community resources for getting help. We use 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-sso 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.
Copyright 2013 - present © cnpmjs.org | Home |