@aws-sdk/client-chime
TypeScript icon, indicating that this package has built-in type declarations

3.699.0 • Public • Published

@aws-sdk/client-chime

Description

AWS SDK for JavaScript Chime Client for Node.js, Browser and React Native.

Most of these APIs are no longer supported and will not be updated. We recommend using the latest versions in the Amazon Chime SDK API reference, in the Amazon Chime SDK.

Using the latest versions requires migrating to dedicated namespaces. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

The Amazon Chime application programming interface (API) is designed so administrators can perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. 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 for Amazon Chime. We recommend using an AWS SDK or the AWS CLI. The page for each API action contains a See Also section that includes links to information about using the action 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 APIs

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 Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.

Installing

To install this package, simply type add or install @aws-sdk/client-chime using your favorite package manager:

  • npm install @aws-sdk/client-chime
  • yarn add @aws-sdk/client-chime
  • pnpm add @aws-sdk/client-chime

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the ChimeClient and the commands you need, for example ListAccountsCommand:

// ES5 example
const { ChimeClient, ListAccountsCommand } = require("@aws-sdk/client-chime");
// ES6+ example
import { ChimeClient, ListAccountsCommand } from "@aws-sdk/client-chime";

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.
// a client can be shared by different commands.
const client = new ChimeClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListAccountsCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// 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 to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// 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

import * as AWS from "@aws-sdk/client-chime";
const client = new AWS.Chime({ region: "REGION" });

// async/await.
try {
  const data = await client.listAccounts(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listAccounts(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.listAccounts(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).

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.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-chime package is updated. To contribute to client you can check our generate clients scripts.

License

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

Client Commands (Operations List)

AssociatePhoneNumbersWithVoiceConnector

Command API Reference / Input / Output

AssociatePhoneNumbersWithVoiceConnectorGroup

Command API Reference / Input / Output

AssociatePhoneNumberWithUser

Command API Reference / Input / Output

AssociateSigninDelegateGroupsWithAccount

Command API Reference / Input / Output

BatchCreateAttendee

Command API Reference / Input / Output

BatchCreateChannelMembership

Command API Reference / Input / Output

BatchCreateRoomMembership

Command API Reference / Input / Output

BatchDeletePhoneNumber

Command API Reference / Input / Output

BatchSuspendUser

Command API Reference / Input / Output

BatchUnsuspendUser

Command API Reference / Input / Output

BatchUpdatePhoneNumber

Command API Reference / Input / Output

BatchUpdateUser

Command API Reference / Input / Output

CreateAccount

Command API Reference / Input / Output

CreateAppInstance

Command API Reference / Input / Output

CreateAppInstanceAdmin

Command API Reference / Input / Output

CreateAppInstanceUser

Command API Reference / Input / Output

CreateAttendee

Command API Reference / Input / Output

CreateBot

Command API Reference / Input / Output

CreateChannel

Command API Reference / Input / Output

CreateChannelBan

Command API Reference / Input / Output

CreateChannelMembership

Command API Reference / Input / Output

CreateChannelModerator

Command API Reference / Input / Output

CreateMediaCapturePipeline

Command API Reference / Input / Output

CreateMeeting

Command API Reference / Input / Output

CreateMeetingDialOut

Command API Reference / Input / Output

CreateMeetingWithAttendees

Command API Reference / Input / Output

CreatePhoneNumberOrder

Command API Reference / Input / Output

CreateProxySession

Command API Reference / Input / Output

CreateRoom

Command API Reference / Input / Output

CreateRoomMembership

Command API Reference / Input / Output

CreateSipMediaApplication

Command API Reference / Input / Output

CreateSipMediaApplicationCall

Command API Reference / Input / Output

CreateSipRule

Command API Reference / Input / Output

CreateUser

Command API Reference / Input / Output

CreateVoiceConnector

Command API Reference / Input / Output

CreateVoiceConnectorGroup

Command API Reference / Input / Output

DeleteAccount

Command API Reference / Input / Output

DeleteAppInstance

Command API Reference / Input / Output

DeleteAppInstanceAdmin

Command API Reference / Input / Output

DeleteAppInstanceStreamingConfigurations

Command API Reference / Input / Output

DeleteAppInstanceUser

Command API Reference / Input / Output

DeleteAttendee

Command API Reference / Input / Output

DeleteChannel

Command API Reference / Input / Output

DeleteChannelBan

Command API Reference / Input / Output

DeleteChannelMembership

Command API Reference / Input / Output

DeleteChannelMessage

Command API Reference / Input / Output

DeleteChannelModerator

Command API Reference / Input / Output

DeleteEventsConfiguration

Command API Reference / Input / Output

DeleteMediaCapturePipeline

Command API Reference / Input / Output

DeleteMeeting

Command API Reference / Input / Output

DeletePhoneNumber

Command API Reference / Input / Output

DeleteProxySession

Command API Reference / Input / Output

DeleteRoom

Command API Reference / Input / Output

DeleteRoomMembership

Command API Reference / Input / Output

DeleteSipMediaApplication

Command API Reference / Input / Output

DeleteSipRule

Command API Reference / Input / Output

DeleteVoiceConnector

Command API Reference / Input / Output

DeleteVoiceConnectorEmergencyCallingConfiguration

Command API Reference / Input / Output

DeleteVoiceConnectorGroup

Command API Reference / Input / Output

DeleteVoiceConnectorOrigination

Command API Reference / Input / Output

DeleteVoiceConnectorProxy

Command API Reference / Input / Output

DeleteVoiceConnectorStreamingConfiguration

Command API Reference / Input / Output

DeleteVoiceConnectorTermination

Command API Reference / Input / Output

DeleteVoiceConnectorTerminationCredentials

Command API Reference / Input / Output

DescribeAppInstance

Command API Reference / Input / Output

DescribeAppInstanceAdmin

Command API Reference / Input / Output

DescribeAppInstanceUser

Command API Reference / Input / Output

DescribeChannel

Command API Reference / Input / Output

DescribeChannelBan

Command API Reference / Input / Output

DescribeChannelMembership

Command API Reference / Input / Output

DescribeChannelMembershipForAppInstanceUser

Command API Reference / Input / Output

DescribeChannelModeratedByAppInstanceUser

Command API Reference / Input / Output

DescribeChannelModerator

Command API Reference / Input / Output

DisassociatePhoneNumberFromUser

Command API Reference / Input / Output

DisassociatePhoneNumbersFromVoiceConnector

Command API Reference / Input / Output

DisassociatePhoneNumbersFromVoiceConnectorGroup

Command API Reference / Input / Output

DisassociateSigninDelegateGroupsFromAccount

Command API Reference / Input / Output

GetAccount

Command API Reference / Input / Output

GetAccountSettings

Command API Reference / Input / Output

GetAppInstanceRetentionSettings

Command API Reference / Input / Output

GetAppInstanceStreamingConfigurations

Command API Reference / Input / Output

GetAttendee

Command API Reference / Input / Output

GetBot

Command API Reference / Input / Output

GetChannelMessage

Command API Reference / Input / Output

GetEventsConfiguration

Command API Reference / Input / Output

GetGlobalSettings

Command API Reference / Input / Output

GetMediaCapturePipeline

Command API Reference / Input / Output

GetMeeting

Command API Reference / Input / Output

GetMessagingSessionEndpoint

Command API Reference / Input / Output

GetPhoneNumber

Command API Reference / Input / Output

GetPhoneNumberOrder

Command API Reference / Input / Output

GetPhoneNumberSettings

Command API Reference / Input / Output

GetProxySession

Command API Reference / Input / Output

GetRetentionSettings

Command API Reference / Input / Output

GetRoom

Command API Reference / Input / Output

GetSipMediaApplication

Command API Reference / Input / Output

GetSipMediaApplicationLoggingConfiguration

Command API Reference / Input / Output

GetSipRule

Command API Reference / Input / Output

GetUser

Command API Reference / Input / Output

GetUserSettings

Command API Reference / Input / Output

GetVoiceConnector

Command API Reference / Input / Output

GetVoiceConnectorEmergencyCallingConfiguration

Command API Reference / Input / Output

GetVoiceConnectorGroup

Command API Reference / Input / Output

GetVoiceConnectorLoggingConfiguration

Command API Reference / Input / Output

GetVoiceConnectorOrigination

Command API Reference / Input / Output

GetVoiceConnectorProxy

Command API Reference / Input / Output

GetVoiceConnectorStreamingConfiguration

Command API Reference / Input / Output

GetVoiceConnectorTermination

Command API Reference / Input / Output

GetVoiceConnectorTerminationHealth

Command API Reference / Input / Output

InviteUsers

Command API Reference / Input / Output

ListAccounts

Command API Reference / Input / Output

ListAppInstanceAdmins

Command API Reference / Input / Output

ListAppInstances

Command API Reference / Input / Output

ListAppInstanceUsers

Command API Reference / Input / Output

ListAttendees

Command API Reference / Input / Output

ListAttendeeTags

Command API Reference / Input / Output

ListBots

Command API Reference / Input / Output

ListChannelBans

Command API Reference / Input / Output

ListChannelMemberships

Command API Reference / Input / Output

ListChannelMembershipsForAppInstanceUser

Command API Reference / Input / Output

ListChannelMessages

Command API Reference / Input / Output

ListChannelModerators

Command API Reference / Input / Output

ListChannels

Command API Reference / Input / Output

ListChannelsModeratedByAppInstanceUser

Command API Reference / Input / Output

ListMediaCapturePipelines

Command API Reference / Input / Output

ListMeetings

Command API Reference / Input / Output

ListMeetingTags

Command API Reference / Input / Output

ListPhoneNumberOrders

Command API Reference / Input / Output

ListPhoneNumbers

Command API Reference / Input / Output

ListProxySessions

Command API Reference / Input / Output

ListRoomMemberships

Command API Reference / Input / Output

ListRooms

Command API Reference / Input / Output

ListSipMediaApplications

Command API Reference / Input / Output

ListSipRules

Command API Reference / Input / Output

ListSupportedPhoneNumberCountries

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListUsers

Command API Reference / Input / Output

ListVoiceConnectorGroups

Command API Reference / Input / Output

ListVoiceConnectors

Command API Reference / Input / Output

ListVoiceConnectorTerminationCredentials

Command API Reference / Input / Output

LogoutUser

Command API Reference / Input / Output

PutAppInstanceRetentionSettings

Command API Reference / Input / Output

PutAppInstanceStreamingConfigurations

Command API Reference / Input / Output

PutEventsConfiguration

Command API Reference / Input / Output

PutRetentionSettings

Command API Reference / Input / Output

PutSipMediaApplicationLoggingConfiguration

Command API Reference / Input / Output

PutVoiceConnectorEmergencyCallingConfiguration

Command API Reference / Input / Output

PutVoiceConnectorLoggingConfiguration

Command API Reference / Input / Output

PutVoiceConnectorOrigination

Command API Reference / Input / Output

PutVoiceConnectorProxy

Command API Reference / Input / Output

PutVoiceConnectorStreamingConfiguration

Command API Reference / Input / Output

PutVoiceConnectorTermination

Command API Reference / Input / Output

PutVoiceConnectorTerminationCredentials

Command API Reference / Input / Output

RedactChannelMessage

Command API Reference / Input / Output

RedactConversationMessage

Command API Reference / Input / Output

RedactRoomMessage

Command API Reference / Input / Output

RegenerateSecurityToken

Command API Reference / Input / Output

ResetPersonalPIN

Command API Reference / Input / Output

RestorePhoneNumber

Command API Reference / Input / Output

SearchAvailablePhoneNumbers

Command API Reference / Input / Output

SendChannelMessage

Command API Reference / Input / Output

StartMeetingTranscription

Command API Reference / Input / Output

StopMeetingTranscription

Command API Reference / Input / Output

TagAttendee

Command API Reference / Input / Output

TagMeeting

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagAttendee

Command API Reference / Input / Output

UntagMeeting

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateAccount

Command API Reference / Input / Output

UpdateAccountSettings

Command API Reference / Input / Output

UpdateAppInstance

Command API Reference / Input / Output

UpdateAppInstanceUser

Command API Reference / Input / Output

UpdateBot

Command API Reference / Input / Output

UpdateChannel

Command API Reference / Input / Output

UpdateChannelMessage

Command API Reference / Input / Output

UpdateChannelReadMarker

Command API Reference / Input / Output

UpdateGlobalSettings

Command API Reference / Input / Output

UpdatePhoneNumber

Command API Reference / Input / Output

UpdatePhoneNumberSettings

Command API Reference / Input / Output

UpdateProxySession

Command API Reference / Input / Output

UpdateRoom

Command API Reference / Input / Output

UpdateRoomMembership

Command API Reference / Input / Output

UpdateSipMediaApplication

Command API Reference / Input / Output

UpdateSipMediaApplicationCall

Command API Reference / Input / Output

UpdateSipRule

Command API Reference / Input / Output

UpdateUser

Command API Reference / Input / Output

UpdateUserSettings

Command API Reference / Input / Output

UpdateVoiceConnector

Command API Reference / Input / Output

UpdateVoiceConnectorGroup

Command API Reference / Input / Output

ValidateE911Address

Command API Reference / Input / Output

Readme

Keywords

none

Package Sidebar

Install

npm i @aws-sdk/client-chime

Weekly Downloads

20,986

Version

3.699.0

License

Apache-2.0

Unpacked Size

3.53 MB

Total Files

728

Last publish

Collaborators

  • mattsb42-aws
  • kuhe
  • amzn-oss
  • aws-sdk-bot
  • trivikr-aws