@aws-sdk/client-cognito-identity

What is @aws-sdk/client-cognito-identity?

The @aws-sdk/client-cognito-identity package is part of the AWS SDK for JavaScript (v3) and provides a client for accessing the Amazon Cognito Identity service. This service enables you to create unique identities for your users and authenticate them with identity providers. With this package, developers can integrate their applications with the Cognito Identity service to manage user identities, authentication, and access control.

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

Creating a new identity pool

This feature allows developers to create a new identity pool. An identity pool is a store of user identity data specific to your account. The code sample demonstrates how to create an identity pool using the CognitoIdentityClient.

const { CognitoIdentityClient, CreateIdentityPoolCommand } = require('@aws-sdk/client-cognito-identity');

const client = new CognitoIdentityClient({ region: 'us-east-1' });
const command = new CreateIdentityPoolCommand({
  IdentityPoolName: 'MyIdentityPool',
  AllowUnauthenticatedIdentities: false
});

const response = await client.send(command);
console.log(response);

Retrieving identity pool roles

This feature enables the retrieval of roles associated with a specific identity pool. The code sample shows how to use the CognitoIdentityClient to fetch the roles for an identity pool.

const { CognitoIdentityClient, GetIdentityPoolRolesCommand } = require('@aws-sdk/client-cognito-identity');

const client = new CognitoIdentityClient({ region: 'us-east-1' });
const command = new GetIdentityPoolRolesCommand({
  IdentityPoolId: 'us-east-1:12345678-1234-1234-1234-123456789012'
});

const response = await client.send(command);
console.log(response);

Listing identities

This feature allows for listing the identities within an identity pool. The code sample demonstrates how to list identities in an identity pool, with a maximum number of results specified.

const { CognitoIdentityClient, ListIdentitiesCommand } = require('@aws-sdk/client-cognito-identity');

const client = new CognitoIdentityClient({ region: 'us-east-1' });
const command = new ListIdentitiesCommand({
  IdentityPoolId: 'us-east-1:12345678-1234-1234-1234-123456789012',
  MaxResults: 10
});

const response = await client.send(command);
console.log(response);

Other packages similar to @aws-sdk/client-cognito-identity

amazon-cognito-identity-js

The amazon-cognito-identity-js package provides authentication functionality for Amazon Cognito. It is focused more on the client-side interaction with Cognito User Pools, enabling sign-up, sign-in, and access to user information. Compared to @aws-sdk/client-cognito-identity, it is more specialized in handling user pool operations rather than managing identities and federated identities.

aws-amplify

AWS Amplify is a comprehensive framework that includes support for Cognito among other AWS services. It provides a higher-level abstraction for working with AWS services, including authentication and authorization via Amazon Cognito. While @aws-sdk/client-cognito-identity is more focused and granular, AWS Amplify offers a broader set of tools for building cloud-enabled applications, including but not limited to authentication.

README

@aws-sdk/client-cognito-identity

For SDK usage, please step to SDK reademe.