This package has been deprecated

Author message:

The package @aws-sdk/client-cognito-identity-provider-node has been renamed to @aws-sdk/client-cognito-identity-provider. Please install the renamed package.

@aws-sdk/client-cognito-identity-provider-node

Description

Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.

This API reference provides information about user pools in Amazon Cognito User Pools.

For more information, see the Amazon Cognito Documentation.

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-cognito-identity-provider-node

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(CognitoIdentityProviderClient) and the commands you need, for example AddCustomAttributesCommand:

//JavaScript
const {
  CognitoIdentityProviderClient
} = require("@aws-sdk/client-cognito-identity-provider-node/CognitoIdentityProviderClient");
const {
  AddCustomAttributesCommand
} = require("@aws-sdk/client-cognito-identity-provider-node/commands/AddCustomAttributesCommand");

//TypeScript
import { CognitoIdentityProviderClient } from "@aws-sdk/client-cognito-identity-provider-node/CognitoIdentityProviderClient";
import { AddCustomAttributesCommand } from "@aws-sdk/client-cognito-identity-provider-node/commands/AddCustomAttributesCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• 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 cognitoIdentityProvider = new CognitoIdentityProviderClient({region: 'region'});
//clients can be shared by different commands
const params = {
  UserPoolId: /**a string value*/,
  CustomAttributes: [ /**a list of structure*/ ],
};
const addCustomAttributesCommand = new AddCustomAttributesCommand(params);
cognitoIdentityProvider.send(addCustomAttributesCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await cognitoIdentityProvider.send(addCustomAttributesCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
cognitoIdentityProvider.send(addCustomAttributesCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-cognito-identity-provider-node/CognitoIdentityProvider";
const cognitoIdentityProvider = new AWS.CognitoIdentityProvider({
  region: "region"
});
cognitoIdentityProvider.addCustomAttributes(params, (err, data) => {
  //do something
});

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 cognitoIdentityProvider.send(addCustomAttributesCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cognito-identity-provider-node' package is updated. To contribute to SDK you can checkout our code generator package.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.