This package has been deprecated

Author message:

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

@aws-sdk/client-chime-node

Description

The Amazon Chime API (application programming interface) is designed for administrators to use to perform key tasks, such as creating and managing Amazon Chime accounts and users. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.

Using an AWS SDK

You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.

Using the AWS CLI

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.

Using REST API

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Control Access to the Amazon Chime Console in the Amazon Chime Administration Guide.

Installing

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

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

//JavaScript
const { ChimeClient } = require("@aws-sdk/client-chime-node/ChimeClient");
const {
  AssociatePhoneNumberWithUserCommand
} = require("@aws-sdk/client-chime-node/commands/AssociatePhoneNumberWithUserCommand");

//TypeScript
import { ChimeClient } from "@aws-sdk/client-chime-node/ChimeClient";
import { AssociatePhoneNumberWithUserCommand } from "@aws-sdk/client-chime-node/commands/AssociatePhoneNumberWithUserCommand";

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 chime = new ChimeClient({region: 'region'});
//clients can be shared by different commands
const params = {
  AccountId: /**a string value*/,
  UserId: /**a string value*/,
  E164PhoneNumber: /**a string value*/,
};
const associatePhoneNumberWithUserCommand = new AssociatePhoneNumberWithUserCommand(params);
chime.send(associatePhoneNumberWithUserCommand).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 chime.send(associatePhoneNumberWithUserCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
chime.send(associatePhoneNumberWithUserCommand, (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-chime-node/Chime";
const chime = new AWS.Chime({ region: "region" });
chime.associatePhoneNumberWithUser(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 chime.send(associatePhoneNumberWithUserCommand);
  // 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-chime-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.