403 lines
18 KiB
Markdown
403 lines
18 KiB
Markdown
<!-- generated file, do not edit directly -->
|
|
|
|
# @aws-sdk/client-cognito-identity
|
|
|
|
## Description
|
|
|
|
AWS SDK for JavaScript CognitoIdentity Client for Node.js, Browser and React Native.
|
|
|
|
<fullname>Amazon Cognito Federated Identities</fullname>
|
|
|
|
<p>Amazon Cognito Federated Identities is a web service that delivers scoped temporary
|
|
credentials to mobile devices and other untrusted environments. It uniquely identifies a
|
|
device and supplies the user with a consistent identity over the lifetime of an
|
|
application.</p>
|
|
<p>Using Amazon Cognito Federated Identities, you can enable authentication with one or
|
|
more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon
|
|
Cognito user pool, and you can also choose to support unauthenticated access from your app.
|
|
Cognito delivers a unique identifier for each user and acts as an OpenID token provider
|
|
trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS
|
|
credentials.</p>
|
|
<p>For a description of the authentication flow from the Amazon Cognito Developer Guide
|
|
see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication Flow</a>.</p>
|
|
<p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated Identities</a>.</p>
|
|
|
|
## Installing
|
|
|
|
To install the this package, simply type add or install @aws-sdk/client-cognito-identity
|
|
using your favorite package manager:
|
|
|
|
- `npm install @aws-sdk/client-cognito-identity`
|
|
- `yarn add @aws-sdk/client-cognito-identity`
|
|
- `pnpm add @aws-sdk/client-cognito-identity`
|
|
|
|
## Getting Started
|
|
|
|
### Import
|
|
|
|
The AWS SDK is modulized by clients and commands.
|
|
To send a request, you only need to import the `CognitoIdentityClient` and
|
|
the commands you need, for example `ListIdentityPoolsCommand`:
|
|
|
|
```js
|
|
// ES5 example
|
|
const { CognitoIdentityClient, ListIdentityPoolsCommand } = require("@aws-sdk/client-cognito-identity");
|
|
```
|
|
|
|
```ts
|
|
// ES6+ example
|
|
import { CognitoIdentityClient, ListIdentityPoolsCommand } from "@aws-sdk/client-cognito-identity";
|
|
```
|
|
|
|
### 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 CognitoIdentityClient({ region: "REGION" });
|
|
|
|
const params = {
|
|
/** input parameters */
|
|
};
|
|
const command = new ListIdentityPoolsCommand(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-cognito-identity";
|
|
const client = new AWS.CognitoIdentity({ region: "REGION" });
|
|
|
|
// async/await.
|
|
try {
|
|
const data = await client.listIdentityPools(params);
|
|
// process data.
|
|
} catch (error) {
|
|
// error handling.
|
|
}
|
|
|
|
// Promises.
|
|
client
|
|
.listIdentityPools(params)
|
|
.then((data) => {
|
|
// process data.
|
|
})
|
|
.catch((error) => {
|
|
// error handling.
|
|
});
|
|
|
|
// callbacks.
|
|
client.listIdentityPools(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-cognito-identity` 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>
|
|
CreateIdentityPool
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/CreateIdentityPoolCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/CreateIdentityPoolCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/CreateIdentityPoolCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
DeleteIdentities
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/DeleteIdentitiesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/DeleteIdentitiesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/DeleteIdentitiesCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
DeleteIdentityPool
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/DeleteIdentityPoolCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/DeleteIdentityPoolCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/DeleteIdentityPoolCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
DescribeIdentity
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/DescribeIdentityCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/DescribeIdentityCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/DescribeIdentityCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
DescribeIdentityPool
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/DescribeIdentityPoolCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/DescribeIdentityPoolCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/DescribeIdentityPoolCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
GetCredentialsForIdentity
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/GetCredentialsForIdentityCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/GetCredentialsForIdentityCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/GetCredentialsForIdentityCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
GetId
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/GetIdCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/GetIdCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/GetIdCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
GetIdentityPoolRoles
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/GetIdentityPoolRolesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/GetIdentityPoolRolesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/GetIdentityPoolRolesCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
GetOpenIdToken
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/GetOpenIdTokenCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/GetOpenIdTokenCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/GetOpenIdTokenCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
GetOpenIdTokenForDeveloperIdentity
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/GetOpenIdTokenForDeveloperIdentityCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/GetOpenIdTokenForDeveloperIdentityCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/GetOpenIdTokenForDeveloperIdentityCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
GetPrincipalTagAttributeMap
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/GetPrincipalTagAttributeMapCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/GetPrincipalTagAttributeMapCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/GetPrincipalTagAttributeMapCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
ListIdentities
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/ListIdentitiesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/ListIdentitiesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/ListIdentitiesCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
ListIdentityPools
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/ListIdentityPoolsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/ListIdentityPoolsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/ListIdentityPoolsCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
ListTagsForResource
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/ListTagsForResourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/ListTagsForResourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/ListTagsForResourceCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
LookupDeveloperIdentity
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/LookupDeveloperIdentityCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/LookupDeveloperIdentityCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/LookupDeveloperIdentityCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
MergeDeveloperIdentities
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/MergeDeveloperIdentitiesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/MergeDeveloperIdentitiesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/MergeDeveloperIdentitiesCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
SetIdentityPoolRoles
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/SetIdentityPoolRolesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/SetIdentityPoolRolesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/SetIdentityPoolRolesCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
SetPrincipalTagAttributeMap
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/SetPrincipalTagAttributeMapCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/SetPrincipalTagAttributeMapCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/SetPrincipalTagAttributeMapCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
TagResource
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/TagResourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/TagResourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/TagResourceCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
UnlinkDeveloperIdentity
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/UnlinkDeveloperIdentityCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/UnlinkDeveloperIdentityCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/UnlinkDeveloperIdentityCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
UnlinkIdentity
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/UnlinkIdentityCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/UnlinkIdentityCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/UnlinkIdentityCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
UntagResource
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/UntagResourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/UntagResourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/UntagResourceCommandOutput/)
|
|
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
UpdateIdentityPool
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/UpdateIdentityPoolCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/UpdateIdentityPoolCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cognito-identity/Interface/UpdateIdentityPoolCommandOutput/)
|
|
|
|
</details>
|