@aws-sdk/client-sso
![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-sso.svg)
Description
AWS SDK for JavaScript SSO Client for Node.js, Browser and React Native.
AWS Single Sign-On Portal is a web service that makes it easy for you to assign user
access to AWS SSO resources such as the user portal. Users can get AWS account applications
and roles assigned to them and get federated into the application.
For general information about AWS SSO, see What is AWS
Single Sign-On? in the AWS SSO User Guide.
This API reference guide describes the AWS SSO Portal operations that you can call
programatically and includes detailed information on data types and errors.
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 AWS SSO and other AWS services. For more
information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
Installing
To install the this package, simply type add or install @aws-sdk/client-sso
using your favorite package manager:
npm install @aws-sdk/client-sso
yarn add @aws-sdk/client-sso
pnpm add @aws-sdk/client-sso
Getting Started
Import
The 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 GetRoleCredentialsCommand
:
const { SSOClient, GetRoleCredentialsCommand } = require("@aws-sdk/client-sso");
import { SSOClient, GetRoleCredentialsCommand } from "@aws-sdk/client-sso";
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 SSOClient({ region: "REGION" });
const params = {
};
const command = new GetRoleCredentialsCommand(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-sso";
const client = new AWS.SSO({ region: "REGION" });
try {
const data = client.getRoleCredentials(params);
} catch (error) {
}
client
.getRoleCredentials(params)
.then((data) => {
})
.catch((error) => {
});
client.getRoleCredentials(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-sso
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.