メッセージングデータのストリーミング

メッセージおよびチャネルイベントなどのデータをストリーム形式で受信するように AppInstance を設定できます。その後、そのデータにリアルタイムで対応することができます。現在、Amazon Chime SDK メッセージングは Kinesis ストリームのみをストリーム送信先として受け入れます。この機能で Kinesis ストリームを使用するには、以下の前提条件を満たす必要があります。

• Kinesis ストリームは AppInstance と同じ AWS アカウントに存在する必要があります。

• ストリームは AppInstance と同じリージョンに存在する必要があります。

• ストリーム名には chime-messaging- で始まるプレフィックスが付きます。

• 少なくとも 2 つのシャードを設定する必要があります。各シャードは 1 秒あたり最大 1 MB のデータを受信できるため、それに応じてストリームをスケールしてください。

• サーバー側の暗号化を有効にします。

Kinesis ストリームを設定するには

1. 前のセクションの前提条件を使用して 1 つ以上の Kinesis ストリームを作成し、ARN を取得します。呼び出し元に Amazon Chime 権限に加えて Kinesis 権限があることを確認します。

   以下の例は、AWS CLI を使用して 2 つのシャードを含む Kinesis ストリームを作成する方法、および SSE を有効にする方法を示しています。

   aws kinesis create-stream --stream-name chime-messaging-unique-name --shard-count 2

   aws kinesis start-stream-encryption --stream-name chime-messaging-unique-name --encryption-type KMS --key-id "alias/aws/kinesis"

2. PutMessagingStreamingConfigurations API を呼び出してストリーミングを設定します。

   2 つのデータタイプの一方または両方を設定でき、同じストリームまたは別々のストリームを選択できます。

   以下の例は、AWS CLI を使用して ChannelMessage および Channel データタイプをストリーミングするように appinstance を設定する方法を示しています。

   aws chime-sdk-messaging put-messaging-streaming-configurations --app-instance-arn app_instance_arn \
   --streaming-configurations DataType=ChannelMessage,ResourceArn=kinesis_data_stream_arn

   aws chime-sdk-messaging put-messaging-streaming-configurations --app-instance-arn app_instance_arn \
   --streaming-configurations DataType=Channel,ResourceArn=kinesis_data_stream_arn

   データタイプには以下のスコープがあります。

   DataType	生成されたイベントタイプ
   ChannelMessage	CREATE_CHANNEL_MESSAGE
   	REDACT_CHANNEL_MESSAGE
   	UPDATE_CHANNEL_MESSAGE
   	DELETE_CHANNEL_MESSAGE
   チャネル	CREATE_CHANNEL
   	CREATE_SUB_CHANNEL
   	UPDATE_CHANNEL
   	DELETE_CHANNEL
   	UPDATE_CHANNEL_EXPIRATION_SETTINGS
   	DELETE_SUB_CHANNEL
   	CREATE_CHANNEL_MEMBERSHIP
   	DELETE_CHANNEL_MEMBERSHIP
   	CREATE_CHANNEL_BAN
   	DELETE_CHANNEL_BAN
   	CREATE_CHANNEL_MODERATOR
   	DELETE_CHANNEL_MODERATOR

3. 設定した Kinesis ストリームからデータの読み取りを開始します。

   注記

   ストリーミングを設定する前に送信されたイベントは、Kinesis ストリームには送信されません。

データ形式

Kinesis は、EventType および Payload のフィールドを含む JSON 形式のレコードを出力します。ペイロード形式は EventType によって異なります。以下の表は、イベントタイプおよびそれに対応するペイロード形式を示しています。

EventType	ペイロード形式
CREATE_CHANNEL_MESSAGE	チャネルメッセージ
REDACT_CHANNEL_MESSAGE
UPDATE_CHANNEL_MESSAGE
DELETE_CHANNEL_MESSAGE
CREATE_CHANNEL	チャネル
UPDATE_CHANNEL
DELETE_CHANNEL
UPDATE_CHANNEL_EXPIRATION_SETTINGS
CREATE_CHANNEL_MEMBERSHIP	ChannelMembership
DELETE_CHANNEL_MEMBERSHIP
CREATE_CHANNEL_BAN	ChannelBan
DELETE_CHANNEL_BAN
CREATE_CHANNEL_MODERATOR	ChannelModerator
DELETE_CHANNEL_MODERATOR
CREATE_SUB_CHANNEL	channelARN SubChannelId
DELETE_SUB_CHANNEL