253 lines
8.4 KiB
Markdown
253 lines
8.4 KiB
Markdown
|
<!-- generated file, do not edit directly -->
|
||
|
|
|
||
|
|
# @aws-sdk/client-sso
|
||
|
|
|
||
|
|
## Description
|
||
|
|
|
||
|
|
AWS SDK for JavaScript SSO Client for Node.js, Browser and React Native.
|
||
|
|
|
||
|
|
<p>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.</p>
|
||
|
|
<note>
|
||
|
|
<p>Although AWS Single Sign-On was renamed, the <code>sso</code> and
|
||
|
|
<code>identitystore</code> API namespaces will continue to retain their original name for
|
||
|
|
backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p>
|
||
|
|
</note>
|
||
|
|
<p>This reference guide describes the IAM Identity Center Portal operations that you can call
|
||
|
|
programatically and includes detailed information on data types and errors.</p>
|
||
|
|
<note>
|
||
|
|
<p>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 <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
|
||
|
|
</note>
|
||
|
|
|
||
|
|
## 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 `ListAccountsCommand`:
|
||
|
|
|
||
|
|
```js
|
||
|
|
// ES5 example
|
||
|
|
const { SSOClient, ListAccountsCommand } = require("@aws-sdk/client-sso");
|
||
|
|
```
|
||
|
|
|
||
|
|
```ts
|
||
|
|
// ES6+ example
|
||
|
|
import { SSOClient, ListAccountsCommand } 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.
|
||
|
|
|
||
|
|
```js
|
||
|
|
// a client can be shared by different commands.
|
||
|
|
const client = new SSOClient({ region: "REGION" });
|
||
|
|
|
||
|
|
const params = {
|
||
|
|
/** input parameters */
|
||
|
|
};
|
||
|
|
const command = new ListAccountsCommand(params);
|
||
|
|
```
|
||
|
|
|
||
|
|
#### Async/await
|
||
|
|
|
||
|
|
We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
||
|
|
operator to wait for the promise returned by send operation as follows:
|
||
|
|
|
||
|
|
```js
|
||
|
|
// 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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
|
||
|
|
to execute send operation.
|
||
|
|
|
||
|
|
```js
|
||
|
|
client.send(command).then(
|
||
|
|
(data) => {
|
||
|
|
// process data.
|
||
|
|
},
|
||
|
|
(error) => {
|
||
|
|
// error handling.
|
||
|
|
}
|
||
|
|
);
|
||
|
|
```
|
||
|
|
|
||
|
|
Promises can also be called using `.catch()` and `.finally()` as follows:
|
||
|
|
|
||
|
|
```js
|
||
|
|
client
|
||
|
|
.send(command)
|
||
|
|
.then((data) => {
|
||
|
|
// process data.
|
||
|
|
})
|
||
|
|
.catch((error) => {
|
||
|
|
// error handling.
|
||
|
|
})
|
||
|
|
.finally(() => {
|
||
|
|
// finally.
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
#### Callbacks
|
||
|
|
|
||
|
|
We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
|
||
|
|
but they are supported by the send operation.
|
||
|
|
|
||
|
|
```js
|
||
|
|
// 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](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
|
||
|
|
|
||
|
|
```ts
|
||
|
|
import * as AWS from "@aws-sdk/client-sso";
|
||
|
|
const client = new AWS.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.
|
||
|
|
client.listAccounts(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).
|
||
|
|
|
||
|
|
```js
|
||
|
|
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](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
||
|
|
or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
|
||
|
|
- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
|
||
|
|
on AWS Developer Blog.
|
||
|
|
- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.
|
||
|
|
- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).
|
||
|
|
- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose).
|
||
|
|
|
||
|
|
To test your universal JavaScript code in Node.js, browser and react-native environments,
|
||
|
|
visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).
|
||
|
|
|
||
|
|
## 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](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
This SDK is distributed under the
|
||
|
|
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
|
||
|
|
see LICENSE for more information.
|
||
|
|
|
||
|
|
## Client Commands (Operations List)
|
||
|
|
|
||
|
|
<details>
|
||
|
|
<summary>
|
||
|
|
GetRoleCredentials
|
||
|
|
</summary>
|
||
|
|
|
||
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sso/command/GetRoleCredentialsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso/Interface/GetRoleCredentialsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso/Interface/GetRoleCredentialsCommandOutput/)
|
||
|
|
|
||
|
|
</details>
|
||
|
|
<details>
|
||
|
|
<summary>
|
||
|
|
ListAccountRoles
|
||
|
|
</summary>
|
||
|
|
|
||
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sso/command/ListAccountRolesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso/Interface/ListAccountRolesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso/Interface/ListAccountRolesCommandOutput/)
|
||
|
|
|
||
|
|
</details>
|
||
|
|
<details>
|
||
|
|
<summary>
|
||
|
|
ListAccounts
|
||
|
|
</summary>
|
||
|
|
|
||
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sso/command/ListAccountsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso/Interface/ListAccountsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso/Interface/ListAccountsCommandOutput/)
|
||
|
|
|
||
|
|
</details>
|
||
|
|
<details>
|
||
|
|
<summary>
|
||
|
|
Logout
|
||
|
|
</summary>
|
||
|
|
|
||
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sso/command/LogoutCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso/Interface/LogoutCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso/Interface/LogoutCommandOutput/)
|
||
|
|
|
||
|
|
</details>
|