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

3.540.0 • Public • Published

@aws-sdk/client-chime-sdk-messaging

Description

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

The Amazon Chime SDK messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK identity APIs. For more information about the messaging APIs, see Amazon Chime SDK messaging.

Installing

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

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

Getting Started

Import

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

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

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 ChimeSDKMessagingClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListChannelFlowsCommand(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-sdk-messaging";
const client = new AWS.ChimeSDKMessaging({ region: "REGION" });

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

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

// callbacks.
client.listChannelFlows(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-sdk-messaging 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)

AssociateChannelFlow

Command API Reference / Input / Output

BatchCreateChannelMembership

Command API Reference / Input / Output

ChannelFlowCallback

Command API Reference / Input / Output

CreateChannel

Command API Reference / Input / Output

CreateChannelBan

Command API Reference / Input / Output

CreateChannelFlow

Command API Reference / Input / Output

CreateChannelMembership

Command API Reference / Input / Output

CreateChannelModerator

Command API Reference / Input / Output

DeleteChannel

Command API Reference / Input / Output

DeleteChannelBan

Command API Reference / Input / Output

DeleteChannelFlow

Command API Reference / Input / Output

DeleteChannelMembership

Command API Reference / Input / Output

DeleteChannelMessage

Command API Reference / Input / Output

DeleteChannelModerator

Command API Reference / Input / Output

DeleteMessagingStreamingConfigurations

Command API Reference / Input / Output

DescribeChannel

Command API Reference / Input / Output

DescribeChannelBan

Command API Reference / Input / Output

DescribeChannelFlow

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

DisassociateChannelFlow

Command API Reference / Input / Output

GetChannelMembershipPreferences

Command API Reference / Input / Output

GetChannelMessage

Command API Reference / Input / Output

GetChannelMessageStatus

Command API Reference / Input / Output

GetMessagingSessionEndpoint

Command API Reference / Input / Output

GetMessagingStreamingConfigurations

Command API Reference / Input / Output

ListChannelBans

Command API Reference / Input / Output

ListChannelFlows

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

ListChannelsAssociatedWithChannelFlow

Command API Reference / Input / Output

ListChannelsModeratedByAppInstanceUser

Command API Reference / Input / Output

ListSubChannels

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

PutChannelExpirationSettings

Command API Reference / Input / Output

PutChannelMembershipPreferences

Command API Reference / Input / Output

PutMessagingStreamingConfigurations

Command API Reference / Input / Output

RedactChannelMessage

Command API Reference / Input / Output

SearchChannels

Command API Reference / Input / Output

SendChannelMessage

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateChannel

Command API Reference / Input / Output

UpdateChannelFlow

Command API Reference / Input / Output

UpdateChannelMessage

Command API Reference / Input / Output

UpdateChannelReadMarker

Command API Reference / Input / Output

Readme

Keywords

none

Package Sidebar

Install

npm i @aws-sdk/client-chime-sdk-messaging

Weekly Downloads

105,648

Version

3.540.0

License

Apache-2.0

Unpacked Size

1.07 MB

Total Files

260

Last publish

Collaborators

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