This package has been deprecated

Author message:

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

@aws-sdk/client-connect-node

Description

The Amazon Connect API Reference provides descriptions, syntax, and usage examples for each of the Amazon Connect actions, data types, parameters, and errors. Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Throttling limits for the Amazon Connect API operations:

For the GetMetricData and GetCurrentMetricData operations, a RateLimit of 5 per second, and a BurstLimit of 8 per second.

For all other operations, a RateLimit of 2 per second, and a BurstLimit of 5 per second.

You can request an increase to the throttling limits by submitting a Amazon Connect service limits increase form. You must be signed in to your AWS account to access the form.

Installing

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

npm install @aws-sdk/client-connect-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(ConnectClient) and the commands you need, for example CreateUserCommand:

//JavaScript
const { ConnectClient } = require("@aws-sdk/client-connect-node/ConnectClient");
const {
  CreateUserCommand
} = require("@aws-sdk/client-connect-node/commands/CreateUserCommand");

//TypeScript
import { ConnectClient } from "@aws-sdk/client-connect-node/ConnectClient";
import { CreateUserCommand } from "@aws-sdk/client-connect-node/commands/CreateUserCommand";

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 connect = new ConnectClient({region: 'region'});
//clients can be shared by different commands
const params = {
  Username: /**a string value*/,
  PhoneConfig: { /**an object specifying PhoneConfig*/ },
  SecurityProfileIds: [ /**a list of string*/ ],
  RoutingProfileId: /**a string value*/,
  InstanceId: /**a string value*/,
};
const createUserCommand = new CreateUserCommand(params);
connect.send(createUserCommand).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 connect.send(createUserCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
connect.send(createUserCommand, (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-connect-node/Connect";
const connect = new AWS.Connect({ region: "region" });
connect.createUser(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 connect.send(createUserCommand);
  // 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-connect-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.