feat(client-chime-sdk-messaging): Amazon Chime SDK messaging customer…

…s can now manage streaming configuration for messaging data for archival and analysis.
aws · Mar 21, 2023 · edee457 · edee457
1 parent 20befeb
commit edee457
Show file tree

Hide file tree

Showing 38 changed files with 2,006 additions and 347 deletions.
diff --git a/clients/client-chime-sdk-messaging/README.md b/clients/client-chime-sdk-messaging/README.md
@@ -320,6 +320,14 @@ DeleteChannelModerator
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/classes/deletechannelmoderatorcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/deletechannelmoderatorcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/deletechannelmoderatorcommandoutput.html)
 
+</details>
+<details>
+<summary>
+DeleteMessagingStreamingConfigurations
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/classes/deletemessagingstreamingconfigurationscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/deletemessagingstreamingconfigurationscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/deletemessagingstreamingconfigurationscommandoutput.html)
+
 </details>
 <details>
 <summary>
@@ -416,6 +424,14 @@ GetMessagingSessionEndpoint
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/classes/getmessagingsessionendpointcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/getmessagingsessionendpointcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/getmessagingsessionendpointcommandoutput.html)
 
+</details>
+<details>
+<summary>
+GetMessagingStreamingConfigurations
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/classes/getmessagingstreamingconfigurationscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/getmessagingstreamingconfigurationscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/getmessagingstreamingconfigurationscommandoutput.html)
+
 </details>
 <details>
 <summary>
@@ -512,6 +528,14 @@ PutChannelMembershipPreferences
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/classes/putchannelmembershippreferencescommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/putchannelmembershippreferencescommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/putchannelmembershippreferencescommandoutput.html)
 
+</details>
+<details>
+<summary>
+PutMessagingStreamingConfigurations
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/classes/putmessagingstreamingconfigurationscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/putmessagingstreamingconfigurationscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-chime-sdk-messaging/interfaces/putmessagingstreamingconfigurationscommandoutput.html)
+
 </details>
 <details>
 <summary>

diff --git a/clients/client-chime-sdk-messaging/src/ChimeSDKMessaging.ts b/clients/client-chime-sdk-messaging/src/ChimeSDKMessaging.ts
diff --git a/clients/client-chime-sdk-messaging/src/ChimeSDKMessagingClient.ts b/clients/client-chime-sdk-messaging/src/ChimeSDKMessagingClient.ts
@@ -87,6 +87,10 @@ import {
   DeleteChannelModeratorCommandInput,
   DeleteChannelModeratorCommandOutput,
 } from "./commands/DeleteChannelModeratorCommand";
+import {
+  DeleteMessagingStreamingConfigurationsCommandInput,
+  DeleteMessagingStreamingConfigurationsCommandOutput,
+} from "./commands/DeleteMessagingStreamingConfigurationsCommand";
 import { DescribeChannelBanCommandInput, DescribeChannelBanCommandOutput } from "./commands/DescribeChannelBanCommand";
 import { DescribeChannelCommandInput, DescribeChannelCommandOutput } from "./commands/DescribeChannelCommand";
 import {
@@ -126,6 +130,10 @@ import {
   GetMessagingSessionEndpointCommandInput,
   GetMessagingSessionEndpointCommandOutput,
 } from "./commands/GetMessagingSessionEndpointCommand";
+import {
+  GetMessagingStreamingConfigurationsCommandInput,
+  GetMessagingStreamingConfigurationsCommandOutput,
+} from "./commands/GetMessagingStreamingConfigurationsCommand";
 import { ListChannelBansCommandInput, ListChannelBansCommandOutput } from "./commands/ListChannelBansCommand";
 import { ListChannelFlowsCommandInput, ListChannelFlowsCommandOutput } from "./commands/ListChannelFlowsCommand";
 import {
@@ -162,6 +170,10 @@ import {
   PutChannelMembershipPreferencesCommandInput,
   PutChannelMembershipPreferencesCommandOutput,
 } from "./commands/PutChannelMembershipPreferencesCommand";
+import {
+  PutMessagingStreamingConfigurationsCommandInput,
+  PutMessagingStreamingConfigurationsCommandOutput,
+} from "./commands/PutMessagingStreamingConfigurationsCommand";
 import {
   RedactChannelMessageCommandInput,
   RedactChannelMessageCommandOutput,
@@ -203,6 +215,7 @@ export type ServiceInputTypes =
   | DeleteChannelMembershipCommandInput
   | DeleteChannelMessageCommandInput
   | DeleteChannelModeratorCommandInput
+  | DeleteMessagingStreamingConfigurationsCommandInput
   | DescribeChannelBanCommandInput
   | DescribeChannelCommandInput
   | DescribeChannelFlowCommandInput
@@ -215,6 +228,7 @@ export type ServiceInputTypes =
   | GetChannelMessageCommandInput
   | GetChannelMessageStatusCommandInput
   | GetMessagingSessionEndpointCommandInput
+  | GetMessagingStreamingConfigurationsCommandInput
   | ListChannelBansCommandInput
   | ListChannelFlowsCommandInput
   | ListChannelMembershipsCommandInput
@@ -227,6 +241,7 @@ export type ServiceInputTypes =
   | ListSubChannelsCommandInput
   | ListTagsForResourceCommandInput
   | PutChannelMembershipPreferencesCommandInput
+  | PutMessagingStreamingConfigurationsCommandInput
   | RedactChannelMessageCommandInput
   | SearchChannelsCommandInput
   | SendChannelMessageCommandInput
@@ -252,6 +267,7 @@ export type ServiceOutputTypes =
   | DeleteChannelMembershipCommandOutput
   | DeleteChannelMessageCommandOutput
   | DeleteChannelModeratorCommandOutput
+  | DeleteMessagingStreamingConfigurationsCommandOutput
   | DescribeChannelBanCommandOutput
   | DescribeChannelCommandOutput
   | DescribeChannelFlowCommandOutput
@@ -264,6 +280,7 @@ export type ServiceOutputTypes =
   | GetChannelMessageCommandOutput
   | GetChannelMessageStatusCommandOutput
   | GetMessagingSessionEndpointCommandOutput
+  | GetMessagingStreamingConfigurationsCommandOutput
   | ListChannelBansCommandOutput
   | ListChannelFlowsCommandOutput
   | ListChannelMembershipsCommandOutput
@@ -276,6 +293,7 @@ export type ServiceOutputTypes =
   | ListSubChannelsCommandOutput
   | ListTagsForResourceCommandOutput
   | PutChannelMembershipPreferencesCommandOutput
+  | PutMessagingStreamingConfigurationsCommandOutput
   | RedactChannelMessageCommandOutput
   | SearchChannelsCommandOutput
   | SendChannelMessageCommandOutput

diff --git a/clients/client-chime-sdk-messaging/src/commands/AssociateChannelFlowCommand.ts b/clients/client-chime-sdk-messaging/src/commands/AssociateChannelFlowCommand.ts
@@ -36,7 +36,6 @@ export interface AssociateChannelFlowCommandOutput extends __MetadataBearer {}
 /**
  * <p>Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the
  *          <code>DisassociateChannelFlow</code> API.</p>
- *
  *          <note>
  *             <p>Only administrators or channel moderators can associate a channel flow. The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code>
  *          of the user that makes the API call as the value in the header.</p>

diff --git a/clients/client-chime-sdk-messaging/src/commands/CreateChannelBanCommand.ts b/clients/client-chime-sdk-messaging/src/commands/CreateChannelBanCommand.ts
@@ -45,7 +45,6 @@ export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse,
  *          channels.</p>
  *          <p>If you ban a user who is already part of a channel, that user is automatically kicked
  *          from the channel.</p>
- *
  *          <note>
  *             <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
  *                <code>AppInstanceUserArn</code> of the user that makes the API call as the value in

diff --git a/clients/client-chime-sdk-messaging/src/commands/CreateChannelCommand.ts b/clients/client-chime-sdk-messaging/src/commands/CreateChannelCommand.ts
@@ -40,11 +40,9 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
 
 /**
  * <p>Creates a channel to which you can add users and send messages.</p>
- *
  *          <p>
  *             <b>Restriction</b>: You can't change a channel's
  *          privacy.</p>
- *
  *          <note>
  *             <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
  *                <code>AppInstanceUserArn</code> of the user that makes the API call as the value in

diff --git a/clients/client-chime-sdk-messaging/src/commands/CreateChannelFlowCommand.ts b/clients/client-chime-sdk-messaging/src/commands/CreateChannelFlowCommand.ts
@@ -43,8 +43,7 @@ export interface CreateChannelFlowCommandOutput extends CreateChannelFlowRespons
  *          that perform actions on chat messages, such as stripping out profanity. You can associate
  *          channel flows with channels, and the processors in the channel flow then take action on all
  *          messages sent to that channel. This is a developer API.</p>
- *
- *            <p>Channel flows process the following items:</p>
+ *          <p>Channel flows process the following items:</p>
  *          <ol>
  *             <li>
  *                <p>New and updated messages</p>
@@ -56,7 +55,6 @@ export interface CreateChannelFlowCommandOutput extends CreateChannelFlowRespons
  *                <p>The Standard message type</p>
  *             </li>
  *          </ol>
- *
  *          <note>
  *             <p>Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to
  *            <a href="https://docs.aws.amazon.com/chime/latest/dg/using-the-messaging-sdk.html#msg-types">Message types</a> in the <i>Amazon Chime developer guide</i>.</p>

diff --git a/clients/client-chime-sdk-messaging/src/commands/CreateChannelMembershipCommand.ts b/clients/client-chime-sdk-messaging/src/commands/CreateChannelMembershipCommand.ts
@@ -41,7 +41,6 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
 /**
  * <p>Adds a user to a channel. The <code>InvitedBy</code> field in <code>ChannelMembership</code> is derived from the
  *          request header. A channel member can:</p>
- *
  *          <ul>
  *             <li>
  *                <p>List messages</p>
@@ -59,9 +58,7 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
  *                <p>Leave the channel</p>
  *             </li>
  *          </ul>
- *
  *          <p>Privacy settings impact this action as follows:</p>
- *
  *          <ul>
  *             <li>
  *                <p>Public Channels: You do not need to be a member to list messages, but you must be
@@ -71,7 +68,6 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
  *                <p>Private Channels: You must be a member to list or send messages.</p>
  *             </li>
  *          </ul>
- *
  *          <note>
  *             <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
  *                <code>AppInstanceUserArn</code> of the user that makes the API call as the value in

diff --git a/clients/client-chime-sdk-messaging/src/commands/CreateChannelModeratorCommand.ts b/clients/client-chime-sdk-messaging/src/commands/CreateChannelModeratorCommand.ts
@@ -40,7 +40,6 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera
 
 /**
  * <p>Creates a new <code>ChannelModerator</code>. A channel moderator can:</p>
- *
  *          <ul>
  *             <li>
  *                <p>Add and remove other members of the channel.</p>
@@ -58,7 +57,6 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera
  *                <p>List messages in the channel.</p>
  *             </li>
  *          </ul>
- *
  *          <note>
  *             <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
  *                <code>AppInstanceUserArn</code> of the user that makes the API call as the value in

diff --git a/clients/client-chime-sdk-messaging/src/commands/DeleteChannelBanCommand.ts b/clients/client-chime-sdk-messaging/src/commands/DeleteChannelBanCommand.ts
@@ -35,7 +35,6 @@ export interface DeleteChannelBanCommandOutput extends __MetadataBearer {}
 
 /**
  * <p>Removes a user from a channel's ban list.</p>
- *
  *          <note>
  *             <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
  *                <code>AppInstanceUserArn</code> of the user that makes the API call as the value in

diff --git a/clients/client-chime-sdk-messaging/src/commands/DeleteChannelCommand.ts b/clients/client-chime-sdk-messaging/src/commands/DeleteChannelCommand.ts
@@ -36,7 +36,6 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {}
 /**
  * <p>Immediately makes a channel and its memberships inaccessible and marks them for
  *          deletion. This is an irreversible process.</p>
- *
  *          <note>
  *             <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
  *                <code>AppInstanceUserArn</code> of the user that makes the API call as the value in

diff --git a/clients/client-chime-sdk-messaging/src/commands/DeleteChannelMembershipCommand.ts b/clients/client-chime-sdk-messaging/src/commands/DeleteChannelMembershipCommand.ts
@@ -35,7 +35,6 @@ export interface DeleteChannelMembershipCommandOutput extends __MetadataBearer {
 
 /**
  * <p>Removes a member from a channel.</p>
- *
  *          <note>
  *             <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
  *                <code>AppInstanceUserArn</code> of the user that makes the API call as the value in

diff --git a/clients/client-chime-sdk-messaging/src/commands/DeleteChannelMessageCommand.ts b/clients/client-chime-sdk-messaging/src/commands/DeleteChannelMessageCommand.ts
@@ -37,7 +37,6 @@ export interface DeleteChannelMessageCommandOutput extends __MetadataBearer {}
  * <p>Deletes a channel message. Only admins can perform this action. Deletion makes messages
  *          inaccessible immediately. A background process deletes any revisions created by
  *             <code>UpdateChannelMessage</code>.</p>
- *
  *          <note>
  *             <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
  *                <code>AppInstanceUserArn</code> of the user that makes the API call as the value in

diff --git a/clients/client-chime-sdk-messaging/src/commands/DeleteChannelModeratorCommand.ts b/clients/client-chime-sdk-messaging/src/commands/DeleteChannelModeratorCommand.ts
@@ -35,7 +35,6 @@ export interface DeleteChannelModeratorCommandOutput extends __MetadataBearer {}
 
 /**
  * <p>Deletes a channel moderator.</p>
- *
  *          <note>
  *             <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
  *                <code>AppInstanceUserArn</code> of the user that makes the API call as the value in