@aws-sdk/client-chime-sdk-messaging 3.295.0 → 3.296.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/ChimeSDKMessaging.js +45 -0
  3. package/dist-cjs/commands/DeleteMessagingStreamingConfigurationsCommand.js +46 -0
  4. package/dist-cjs/commands/GetMessagingStreamingConfigurationsCommand.js +46 -0
  5. package/dist-cjs/commands/PutMessagingStreamingConfigurationsCommand.js +46 -0
  6. package/dist-cjs/commands/index.js +3 -0
  7. package/dist-cjs/endpoint/ruleset.js +3 -3
  8. package/dist-cjs/models/models_0.js +32 -3
  9. package/dist-cjs/protocols/Aws_restJson1.js +243 -2
  10. package/dist-es/ChimeSDKMessaging.js +45 -0
  11. package/dist-es/commands/DeleteMessagingStreamingConfigurationsCommand.js +42 -0
  12. package/dist-es/commands/GetMessagingStreamingConfigurationsCommand.js +42 -0
  13. package/dist-es/commands/PutMessagingStreamingConfigurationsCommand.js +42 -0
  14. package/dist-es/commands/index.js +3 -0
  15. package/dist-es/endpoint/ruleset.js +3 -3
  16. package/dist-es/models/models_0.js +23 -0
  17. package/dist-es/protocols/Aws_restJson1.js +235 -0
  18. package/dist-types/ChimeSDKMessaging.d.ts +25 -40
  19. package/dist-types/ChimeSDKMessagingClient.d.ts +5 -2
  20. package/dist-types/commands/AssociateChannelFlowCommand.d.ts +0 -1
  21. package/dist-types/commands/CreateChannelBanCommand.d.ts +0 -1
  22. package/dist-types/commands/CreateChannelCommand.d.ts +0 -2
  23. package/dist-types/commands/CreateChannelFlowCommand.d.ts +1 -3
  24. package/dist-types/commands/CreateChannelMembershipCommand.d.ts +0 -4
  25. package/dist-types/commands/CreateChannelModeratorCommand.d.ts +0 -2
  26. package/dist-types/commands/DeleteChannelBanCommand.d.ts +0 -1
  27. package/dist-types/commands/DeleteChannelCommand.d.ts +0 -1
  28. package/dist-types/commands/DeleteChannelMembershipCommand.d.ts +0 -1
  29. package/dist-types/commands/DeleteChannelMessageCommand.d.ts +0 -1
  30. package/dist-types/commands/DeleteChannelModeratorCommand.d.ts +0 -1
  31. package/dist-types/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +60 -0
  32. package/dist-types/commands/DescribeChannelBanCommand.d.ts +0 -2
  33. package/dist-types/commands/DescribeChannelCommand.d.ts +0 -2
  34. package/dist-types/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts +0 -1
  35. package/dist-types/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts +0 -1
  36. package/dist-types/commands/GetChannelMessageCommand.d.ts +0 -1
  37. package/dist-types/commands/GetChannelMessageStatusCommand.d.ts +0 -3
  38. package/dist-types/commands/GetMessagingStreamingConfigurationsCommand.d.ts +66 -0
  39. package/dist-types/commands/ListChannelBansCommand.d.ts +0 -1
  40. package/dist-types/commands/ListChannelMembershipsCommand.d.ts +0 -2
  41. package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +0 -1
  42. package/dist-types/commands/ListChannelsCommand.d.ts +0 -2
  43. package/dist-types/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts +0 -1
  44. package/dist-types/commands/PutMessagingStreamingConfigurationsCommand.d.ts +70 -0
  45. package/dist-types/commands/RedactChannelMessageCommand.d.ts +0 -1
  46. package/dist-types/commands/SendChannelMessageCommand.d.ts +0 -2
  47. package/dist-types/commands/UpdateChannelMessageCommand.d.ts +0 -1
  48. package/dist-types/commands/UpdateChannelReadMarkerCommand.d.ts +0 -1
  49. package/dist-types/commands/index.d.ts +3 -0
  50. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  51. package/dist-types/models/models_0.d.ts +75 -0
  52. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  53. package/dist-types/ts3.4/ChimeSDKMessaging.d.ts +69 -0
  54. package/dist-types/ts3.4/ChimeSDKMessagingClient.d.ts +18 -0
  55. package/dist-types/ts3.4/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +37 -0
  56. package/dist-types/ts3.4/commands/GetMessagingStreamingConfigurationsCommand.d.ts +41 -0
  57. package/dist-types/ts3.4/commands/PutMessagingStreamingConfigurationsCommand.d.ts +41 -0
  58. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  59. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  60. package/dist-types/ts3.4/models/models_0.d.ts +42 -0
  61. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  62. package/package.json +29 -29
@@ -21,6 +21,7 @@ import { DeleteChannelFlowCommandInput, DeleteChannelFlowCommandOutput } from ".
21
21
  import { DeleteChannelMembershipCommandInput, DeleteChannelMembershipCommandOutput } from "./commands/DeleteChannelMembershipCommand";
22
22
  import { DeleteChannelMessageCommandInput, DeleteChannelMessageCommandOutput } from "./commands/DeleteChannelMessageCommand";
23
23
  import { DeleteChannelModeratorCommandInput, DeleteChannelModeratorCommandOutput } from "./commands/DeleteChannelModeratorCommand";
24
+ import { DeleteMessagingStreamingConfigurationsCommandInput, DeleteMessagingStreamingConfigurationsCommandOutput } from "./commands/DeleteMessagingStreamingConfigurationsCommand";
24
25
  import { DescribeChannelBanCommandInput, DescribeChannelBanCommandOutput } from "./commands/DescribeChannelBanCommand";
25
26
  import { DescribeChannelCommandInput, DescribeChannelCommandOutput } from "./commands/DescribeChannelCommand";
26
27
  import { DescribeChannelFlowCommandInput, DescribeChannelFlowCommandOutput } from "./commands/DescribeChannelFlowCommand";
@@ -33,6 +34,7 @@ import { GetChannelMembershipPreferencesCommandInput, GetChannelMembershipPrefer
33
34
  import { GetChannelMessageCommandInput, GetChannelMessageCommandOutput } from "./commands/GetChannelMessageCommand";
34
35
  import { GetChannelMessageStatusCommandInput, GetChannelMessageStatusCommandOutput } from "./commands/GetChannelMessageStatusCommand";
35
36
  import { GetMessagingSessionEndpointCommandInput, GetMessagingSessionEndpointCommandOutput } from "./commands/GetMessagingSessionEndpointCommand";
37
+ import { GetMessagingStreamingConfigurationsCommandInput, GetMessagingStreamingConfigurationsCommandOutput } from "./commands/GetMessagingStreamingConfigurationsCommand";
36
38
  import { ListChannelBansCommandInput, ListChannelBansCommandOutput } from "./commands/ListChannelBansCommand";
37
39
  import { ListChannelFlowsCommandInput, ListChannelFlowsCommandOutput } from "./commands/ListChannelFlowsCommand";
38
40
  import { ListChannelMembershipsCommandInput, ListChannelMembershipsCommandOutput } from "./commands/ListChannelMembershipsCommand";
@@ -45,6 +47,7 @@ import { ListChannelsModeratedByAppInstanceUserCommandInput, ListChannelsModerat
45
47
  import { ListSubChannelsCommandInput, ListSubChannelsCommandOutput } from "./commands/ListSubChannelsCommand";
46
48
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
47
49
  import { PutChannelMembershipPreferencesCommandInput, PutChannelMembershipPreferencesCommandOutput } from "./commands/PutChannelMembershipPreferencesCommand";
50
+ import { PutMessagingStreamingConfigurationsCommandInput, PutMessagingStreamingConfigurationsCommandOutput } from "./commands/PutMessagingStreamingConfigurationsCommand";
48
51
  import { RedactChannelMessageCommandInput, RedactChannelMessageCommandOutput } from "./commands/RedactChannelMessageCommand";
49
52
  import { SearchChannelsCommandInput, SearchChannelsCommandOutput } from "./commands/SearchChannelsCommand";
50
53
  import { SendChannelMessageCommandInput, SendChannelMessageCommandOutput } from "./commands/SendChannelMessageCommand";
@@ -55,8 +58,8 @@ import { UpdateChannelFlowCommandInput, UpdateChannelFlowCommandOutput } from ".
55
58
  import { UpdateChannelMessageCommandInput, UpdateChannelMessageCommandOutput } from "./commands/UpdateChannelMessageCommand";
56
59
  import { UpdateChannelReadMarkerCommandInput, UpdateChannelReadMarkerCommandOutput } from "./commands/UpdateChannelReadMarkerCommand";
57
60
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
58
- export type ServiceInputTypes = AssociateChannelFlowCommandInput | BatchCreateChannelMembershipCommandInput | ChannelFlowCallbackCommandInput | CreateChannelBanCommandInput | CreateChannelCommandInput | CreateChannelFlowCommandInput | CreateChannelMembershipCommandInput | CreateChannelModeratorCommandInput | DeleteChannelBanCommandInput | DeleteChannelCommandInput | DeleteChannelFlowCommandInput | DeleteChannelMembershipCommandInput | DeleteChannelMessageCommandInput | DeleteChannelModeratorCommandInput | DescribeChannelBanCommandInput | DescribeChannelCommandInput | DescribeChannelFlowCommandInput | DescribeChannelMembershipCommandInput | DescribeChannelMembershipForAppInstanceUserCommandInput | DescribeChannelModeratedByAppInstanceUserCommandInput | DescribeChannelModeratorCommandInput | DisassociateChannelFlowCommandInput | GetChannelMembershipPreferencesCommandInput | GetChannelMessageCommandInput | GetChannelMessageStatusCommandInput | GetMessagingSessionEndpointCommandInput | ListChannelBansCommandInput | ListChannelFlowsCommandInput | ListChannelMembershipsCommandInput | ListChannelMembershipsForAppInstanceUserCommandInput | ListChannelMessagesCommandInput | ListChannelModeratorsCommandInput | ListChannelsAssociatedWithChannelFlowCommandInput | ListChannelsCommandInput | ListChannelsModeratedByAppInstanceUserCommandInput | ListSubChannelsCommandInput | ListTagsForResourceCommandInput | PutChannelMembershipPreferencesCommandInput | RedactChannelMessageCommandInput | SearchChannelsCommandInput | SendChannelMessageCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateChannelCommandInput | UpdateChannelFlowCommandInput | UpdateChannelMessageCommandInput | UpdateChannelReadMarkerCommandInput;
59
- export type ServiceOutputTypes = AssociateChannelFlowCommandOutput | BatchCreateChannelMembershipCommandOutput | ChannelFlowCallbackCommandOutput | CreateChannelBanCommandOutput | CreateChannelCommandOutput | CreateChannelFlowCommandOutput | CreateChannelMembershipCommandOutput | CreateChannelModeratorCommandOutput | DeleteChannelBanCommandOutput | DeleteChannelCommandOutput | DeleteChannelFlowCommandOutput | DeleteChannelMembershipCommandOutput | DeleteChannelMessageCommandOutput | DeleteChannelModeratorCommandOutput | DescribeChannelBanCommandOutput | DescribeChannelCommandOutput | DescribeChannelFlowCommandOutput | DescribeChannelMembershipCommandOutput | DescribeChannelMembershipForAppInstanceUserCommandOutput | DescribeChannelModeratedByAppInstanceUserCommandOutput | DescribeChannelModeratorCommandOutput | DisassociateChannelFlowCommandOutput | GetChannelMembershipPreferencesCommandOutput | GetChannelMessageCommandOutput | GetChannelMessageStatusCommandOutput | GetMessagingSessionEndpointCommandOutput | ListChannelBansCommandOutput | ListChannelFlowsCommandOutput | ListChannelMembershipsCommandOutput | ListChannelMembershipsForAppInstanceUserCommandOutput | ListChannelMessagesCommandOutput | ListChannelModeratorsCommandOutput | ListChannelsAssociatedWithChannelFlowCommandOutput | ListChannelsCommandOutput | ListChannelsModeratedByAppInstanceUserCommandOutput | ListSubChannelsCommandOutput | ListTagsForResourceCommandOutput | PutChannelMembershipPreferencesCommandOutput | RedactChannelMessageCommandOutput | SearchChannelsCommandOutput | SendChannelMessageCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateChannelCommandOutput | UpdateChannelFlowCommandOutput | UpdateChannelMessageCommandOutput | UpdateChannelReadMarkerCommandOutput;
61
+ export type ServiceInputTypes = AssociateChannelFlowCommandInput | BatchCreateChannelMembershipCommandInput | ChannelFlowCallbackCommandInput | CreateChannelBanCommandInput | CreateChannelCommandInput | CreateChannelFlowCommandInput | CreateChannelMembershipCommandInput | CreateChannelModeratorCommandInput | DeleteChannelBanCommandInput | DeleteChannelCommandInput | DeleteChannelFlowCommandInput | DeleteChannelMembershipCommandInput | DeleteChannelMessageCommandInput | DeleteChannelModeratorCommandInput | DeleteMessagingStreamingConfigurationsCommandInput | DescribeChannelBanCommandInput | DescribeChannelCommandInput | DescribeChannelFlowCommandInput | DescribeChannelMembershipCommandInput | DescribeChannelMembershipForAppInstanceUserCommandInput | DescribeChannelModeratedByAppInstanceUserCommandInput | DescribeChannelModeratorCommandInput | DisassociateChannelFlowCommandInput | GetChannelMembershipPreferencesCommandInput | GetChannelMessageCommandInput | GetChannelMessageStatusCommandInput | GetMessagingSessionEndpointCommandInput | GetMessagingStreamingConfigurationsCommandInput | ListChannelBansCommandInput | ListChannelFlowsCommandInput | ListChannelMembershipsCommandInput | ListChannelMembershipsForAppInstanceUserCommandInput | ListChannelMessagesCommandInput | ListChannelModeratorsCommandInput | ListChannelsAssociatedWithChannelFlowCommandInput | ListChannelsCommandInput | ListChannelsModeratedByAppInstanceUserCommandInput | ListSubChannelsCommandInput | ListTagsForResourceCommandInput | PutChannelMembershipPreferencesCommandInput | PutMessagingStreamingConfigurationsCommandInput | RedactChannelMessageCommandInput | SearchChannelsCommandInput | SendChannelMessageCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateChannelCommandInput | UpdateChannelFlowCommandInput | UpdateChannelMessageCommandInput | UpdateChannelReadMarkerCommandInput;
62
+ export type ServiceOutputTypes = AssociateChannelFlowCommandOutput | BatchCreateChannelMembershipCommandOutput | ChannelFlowCallbackCommandOutput | CreateChannelBanCommandOutput | CreateChannelCommandOutput | CreateChannelFlowCommandOutput | CreateChannelMembershipCommandOutput | CreateChannelModeratorCommandOutput | DeleteChannelBanCommandOutput | DeleteChannelCommandOutput | DeleteChannelFlowCommandOutput | DeleteChannelMembershipCommandOutput | DeleteChannelMessageCommandOutput | DeleteChannelModeratorCommandOutput | DeleteMessagingStreamingConfigurationsCommandOutput | DescribeChannelBanCommandOutput | DescribeChannelCommandOutput | DescribeChannelFlowCommandOutput | DescribeChannelMembershipCommandOutput | DescribeChannelMembershipForAppInstanceUserCommandOutput | DescribeChannelModeratedByAppInstanceUserCommandOutput | DescribeChannelModeratorCommandOutput | DisassociateChannelFlowCommandOutput | GetChannelMembershipPreferencesCommandOutput | GetChannelMessageCommandOutput | GetChannelMessageStatusCommandOutput | GetMessagingSessionEndpointCommandOutput | GetMessagingStreamingConfigurationsCommandOutput | ListChannelBansCommandOutput | ListChannelFlowsCommandOutput | ListChannelMembershipsCommandOutput | ListChannelMembershipsForAppInstanceUserCommandOutput | ListChannelMessagesCommandOutput | ListChannelModeratorsCommandOutput | ListChannelsAssociatedWithChannelFlowCommandOutput | ListChannelsCommandOutput | ListChannelsModeratedByAppInstanceUserCommandOutput | ListSubChannelsCommandOutput | ListTagsForResourceCommandOutput | PutChannelMembershipPreferencesCommandOutput | PutMessagingStreamingConfigurationsCommandOutput | RedactChannelMessageCommandOutput | SearchChannelsCommandOutput | SendChannelMessageCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateChannelCommandOutput | UpdateChannelFlowCommandOutput | UpdateChannelMessageCommandOutput | UpdateChannelReadMarkerCommandOutput;
60
63
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
61
64
  /**
62
65
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
@@ -16,7 +16,6 @@ export interface AssociateChannelFlowCommandOutput extends __MetadataBearer {
16
16
  /**
17
17
  * <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
18
18
  * <code>DisassociateChannelFlow</code> API.</p>
19
- *
20
19
  * <note>
21
20
  * <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>
22
21
  * of the user that makes the API call as the value in the header.</p>
@@ -20,7 +20,6 @@ export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse,
20
20
  * channels.</p>
21
21
  * <p>If you ban a user who is already part of a channel, that user is automatically kicked
22
22
  * from the channel.</p>
23
- *
24
23
  * <note>
25
24
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
26
25
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -15,11 +15,9 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
15
15
  }
16
16
  /**
17
17
  * <p>Creates a channel to which you can add users and send messages.</p>
18
- *
19
18
  * <p>
20
19
  * <b>Restriction</b>: You can't change a channel's
21
20
  * privacy.</p>
22
- *
23
21
  * <note>
24
22
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
25
23
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -18,8 +18,7 @@ export interface CreateChannelFlowCommandOutput extends CreateChannelFlowRespons
18
18
  * that perform actions on chat messages, such as stripping out profanity. You can associate
19
19
  * channel flows with channels, and the processors in the channel flow then take action on all
20
20
  * messages sent to that channel. This is a developer API.</p>
21
- *
22
- * <p>Channel flows process the following items:</p>
21
+ * <p>Channel flows process the following items:</p>
23
22
  * <ol>
24
23
  * <li>
25
24
  * <p>New and updated messages</p>
@@ -31,7 +30,6 @@ export interface CreateChannelFlowCommandOutput extends CreateChannelFlowRespons
31
30
  * <p>The Standard message type</p>
32
31
  * </li>
33
32
  * </ol>
34
- *
35
33
  * <note>
36
34
  * <p>Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to
37
35
  * <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>
@@ -16,7 +16,6 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
16
16
  /**
17
17
  * <p>Adds a user to a channel. The <code>InvitedBy</code> field in <code>ChannelMembership</code> is derived from the
18
18
  * request header. A channel member can:</p>
19
- *
20
19
  * <ul>
21
20
  * <li>
22
21
  * <p>List messages</p>
@@ -34,9 +33,7 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
34
33
  * <p>Leave the channel</p>
35
34
  * </li>
36
35
  * </ul>
37
- *
38
36
  * <p>Privacy settings impact this action as follows:</p>
39
- *
40
37
  * <ul>
41
38
  * <li>
42
39
  * <p>Public Channels: You do not need to be a member to list messages, but you must be
@@ -46,7 +43,6 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
46
43
  * <p>Private Channels: You must be a member to list or send messages.</p>
47
44
  * </li>
48
45
  * </ul>
49
- *
50
46
  * <note>
51
47
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
52
48
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -15,7 +15,6 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera
15
15
  }
16
16
  /**
17
17
  * <p>Creates a new <code>ChannelModerator</code>. A channel moderator can:</p>
18
- *
19
18
  * <ul>
20
19
  * <li>
21
20
  * <p>Add and remove other members of the channel.</p>
@@ -33,7 +32,6 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera
33
32
  * <p>List messages in the channel.</p>
34
33
  * </li>
35
34
  * </ul>
36
- *
37
35
  * <note>
38
36
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
39
37
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -15,7 +15,6 @@ export interface DeleteChannelBanCommandOutput extends __MetadataBearer {
15
15
  }
16
16
  /**
17
17
  * <p>Removes a user from a channel's ban list.</p>
18
- *
19
18
  * <note>
20
19
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
21
20
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -16,7 +16,6 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {
16
16
  /**
17
17
  * <p>Immediately makes a channel and its memberships inaccessible and marks them for
18
18
  * deletion. This is an irreversible process.</p>
19
- *
20
19
  * <note>
21
20
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
22
21
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -15,7 +15,6 @@ export interface DeleteChannelMembershipCommandOutput extends __MetadataBearer {
15
15
  }
16
16
  /**
17
17
  * <p>Removes a member from a channel.</p>
18
- *
19
18
  * <note>
20
19
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
21
20
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -17,7 +17,6 @@ export interface DeleteChannelMessageCommandOutput extends __MetadataBearer {
17
17
  * <p>Deletes a channel message. Only admins can perform this action. Deletion makes messages
18
18
  * inaccessible immediately. A background process deletes any revisions created by
19
19
  * <code>UpdateChannelMessage</code>.</p>
20
- *
21
20
  * <note>
22
21
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
23
22
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -15,7 +15,6 @@ export interface DeleteChannelModeratorCommandOutput extends __MetadataBearer {
15
15
  }
16
16
  /**
17
17
  * <p>Deletes a channel moderator.</p>
18
- *
19
18
  * <note>
20
19
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
21
20
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -0,0 +1,60 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
+ import { DeleteMessagingStreamingConfigurationsRequest } from "../models/models_0";
6
+ /**
7
+ * The input for {@link DeleteMessagingStreamingConfigurationsCommand}.
8
+ */
9
+ export interface DeleteMessagingStreamingConfigurationsCommandInput extends DeleteMessagingStreamingConfigurationsRequest {
10
+ }
11
+ /**
12
+ * The output of {@link DeleteMessagingStreamingConfigurationsCommand}.
13
+ */
14
+ export interface DeleteMessagingStreamingConfigurationsCommandOutput extends __MetadataBearer {
15
+ }
16
+ /**
17
+ * <p>Deletes the streaming configurations for an <code>AppInstance</code>. For more information, see
18
+ * <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the <i>Amazon Chime SDK Developer Guide</i>.</p>
19
+ * @example
20
+ * Use a bare-bones client and the command you need to make an API call.
21
+ * ```javascript
22
+ * import { ChimeSDKMessagingClient, DeleteMessagingStreamingConfigurationsCommand } from "@aws-sdk/client-chime-sdk-messaging"; // ES Modules import
23
+ * // const { ChimeSDKMessagingClient, DeleteMessagingStreamingConfigurationsCommand } = require("@aws-sdk/client-chime-sdk-messaging"); // CommonJS import
24
+ * const client = new ChimeSDKMessagingClient(config);
25
+ * const command = new DeleteMessagingStreamingConfigurationsCommand(input);
26
+ * const response = await client.send(command);
27
+ * ```
28
+ *
29
+ * @see {@link DeleteMessagingStreamingConfigurationsCommandInput} for command's `input` shape.
30
+ * @see {@link DeleteMessagingStreamingConfigurationsCommandOutput} for command's `response` shape.
31
+ * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
32
+ *
33
+ * @throws {@link ForbiddenException} (client fault)
34
+ * <p>The client is permanently forbidden from making the request.</p>
35
+ *
36
+ * @throws {@link ServiceFailureException} (server fault)
37
+ * <p>The service encountered an unexpected error.</p>
38
+ *
39
+ * @throws {@link ServiceUnavailableException} (server fault)
40
+ * <p>The service is currently unavailable.</p>
41
+ *
42
+ * @throws {@link ThrottledClientException} (client fault)
43
+ * <p>The client exceeded its request rate limit.</p>
44
+ *
45
+ * @throws {@link UnauthorizedClientException} (client fault)
46
+ * <p>The client is not currently authorized to make the request.</p>
47
+ *
48
+ *
49
+ */
50
+ export declare class DeleteMessagingStreamingConfigurationsCommand extends $Command<DeleteMessagingStreamingConfigurationsCommandInput, DeleteMessagingStreamingConfigurationsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
51
+ readonly input: DeleteMessagingStreamingConfigurationsCommandInput;
52
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ constructor(input: DeleteMessagingStreamingConfigurationsCommandInput);
54
+ /**
55
+ * @internal
56
+ */
57
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteMessagingStreamingConfigurationsCommandInput, DeleteMessagingStreamingConfigurationsCommandOutput>;
58
+ private serialize;
59
+ private deserialize;
60
+ }
@@ -15,9 +15,7 @@ export interface DescribeChannelBanCommandOutput extends DescribeChannelBanRespo
15
15
  }
16
16
  /**
17
17
  * <p>Returns the full details of a channel ban.</p>
18
- *
19
18
  * <note>
20
- *
21
19
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
22
20
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
23
21
  * the header.</p>
@@ -16,9 +16,7 @@ export interface DescribeChannelCommandOutput extends DescribeChannelResponse, _
16
16
  /**
17
17
  * <p>Returns the full details of a channel in an Amazon Chime
18
18
  * <code>AppInstance</code>.</p>
19
- *
20
19
  * <note>
21
- *
22
20
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
23
21
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
24
22
  * the header.</p>
@@ -16,7 +16,6 @@ export interface DescribeChannelMembershipForAppInstanceUserCommandOutput extend
16
16
  /**
17
17
  * <p> Returns the details of a channel based on the membership of the specified
18
18
  * <code>AppInstanceUser</code>.</p>
19
- *
20
19
  * <note>
21
20
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
22
21
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -16,7 +16,6 @@ export interface DescribeChannelModeratedByAppInstanceUserCommandOutput extends
16
16
  /**
17
17
  * <p>Returns the full details of a channel moderated by the specified
18
18
  * <code>AppInstanceUser</code>.</p>
19
- *
20
19
  * <note>
21
20
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
22
21
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -15,7 +15,6 @@ export interface GetChannelMessageCommandOutput extends GetChannelMessageRespons
15
15
  }
16
16
  /**
17
17
  * <p>Gets the full details of a channel message.</p>
18
- *
19
18
  * <note>
20
19
  * <p>The x-amz-chime-bearer request header is mandatory. Use the
21
20
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -16,9 +16,7 @@ export interface GetChannelMessageStatusCommandOutput extends GetChannelMessageS
16
16
  /**
17
17
  * <p>Gets message status for a specified <code>messageId</code>. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to
18
18
  * retrieving message status if the event was not received because a client wasn't connected to a websocket. </p>
19
- *
20
19
  * <p>Messages can have any one of these statuses.</p>
21
- *
22
20
  * <dl>
23
21
  * <dt>SENT</dt>
24
22
  * <dd>
@@ -37,7 +35,6 @@ export interface GetChannelMessageStatusCommandOutput extends GetChannelMessageS
37
35
  * <p>Messasge denied by the processor</p>
38
36
  * </dd>
39
37
  * </dl>
40
- *
41
38
  * <note>
42
39
  * <ul>
43
40
  * <li>
@@ -0,0 +1,66 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
+ import { GetMessagingStreamingConfigurationsRequest, GetMessagingStreamingConfigurationsResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link GetMessagingStreamingConfigurationsCommand}.
8
+ */
9
+ export interface GetMessagingStreamingConfigurationsCommandInput extends GetMessagingStreamingConfigurationsRequest {
10
+ }
11
+ /**
12
+ * The output of {@link GetMessagingStreamingConfigurationsCommand}.
13
+ */
14
+ export interface GetMessagingStreamingConfigurationsCommandOutput extends GetMessagingStreamingConfigurationsResponse, __MetadataBearer {
15
+ }
16
+ /**
17
+ * <p>Retrieves the data streaming configuration for an <code>AppInstance</code>. For more information, see
18
+ * <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the <i>Amazon Chime SDK Developer Guide</i>.</p>
19
+ * @example
20
+ * Use a bare-bones client and the command you need to make an API call.
21
+ * ```javascript
22
+ * import { ChimeSDKMessagingClient, GetMessagingStreamingConfigurationsCommand } from "@aws-sdk/client-chime-sdk-messaging"; // ES Modules import
23
+ * // const { ChimeSDKMessagingClient, GetMessagingStreamingConfigurationsCommand } = require("@aws-sdk/client-chime-sdk-messaging"); // CommonJS import
24
+ * const client = new ChimeSDKMessagingClient(config);
25
+ * const command = new GetMessagingStreamingConfigurationsCommand(input);
26
+ * const response = await client.send(command);
27
+ * ```
28
+ *
29
+ * @see {@link GetMessagingStreamingConfigurationsCommandInput} for command's `input` shape.
30
+ * @see {@link GetMessagingStreamingConfigurationsCommandOutput} for command's `response` shape.
31
+ * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
32
+ *
33
+ * @throws {@link BadRequestException} (client fault)
34
+ * <p>The input parameters don't match the service's restrictions.</p>
35
+ *
36
+ * @throws {@link ForbiddenException} (client fault)
37
+ * <p>The client is permanently forbidden from making the request.</p>
38
+ *
39
+ * @throws {@link NotFoundException} (client fault)
40
+ * <p>One or more of the resources in the request does not exist in the system.</p>
41
+ *
42
+ * @throws {@link ServiceFailureException} (server fault)
43
+ * <p>The service encountered an unexpected error.</p>
44
+ *
45
+ * @throws {@link ServiceUnavailableException} (server fault)
46
+ * <p>The service is currently unavailable.</p>
47
+ *
48
+ * @throws {@link ThrottledClientException} (client fault)
49
+ * <p>The client exceeded its request rate limit.</p>
50
+ *
51
+ * @throws {@link UnauthorizedClientException} (client fault)
52
+ * <p>The client is not currently authorized to make the request.</p>
53
+ *
54
+ *
55
+ */
56
+ export declare class GetMessagingStreamingConfigurationsCommand extends $Command<GetMessagingStreamingConfigurationsCommandInput, GetMessagingStreamingConfigurationsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
57
+ readonly input: GetMessagingStreamingConfigurationsCommandInput;
58
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ constructor(input: GetMessagingStreamingConfigurationsCommandInput);
60
+ /**
61
+ * @internal
62
+ */
63
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetMessagingStreamingConfigurationsCommandInput, GetMessagingStreamingConfigurationsCommandOutput>;
64
+ private serialize;
65
+ private deserialize;
66
+ }
@@ -15,7 +15,6 @@ export interface ListChannelBansCommandOutput extends ListChannelBansResponse, _
15
15
  }
16
16
  /**
17
17
  * <p>Lists all the users banned from a particular channel.</p>
18
- *
19
18
  * <note>
20
19
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
21
20
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -15,13 +15,11 @@ export interface ListChannelMembershipsCommandOutput extends ListChannelMembersh
15
15
  }
16
16
  /**
17
17
  * <p>Lists all channel memberships in a channel.</p>
18
- *
19
18
  * <note>
20
19
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
21
20
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
22
21
  * the header.</p>
23
22
  * </note>
24
- *
25
23
  * <p>If you want to list the channels to which a specific app instance user belongs, see the
26
24
  * <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html">ListChannelMembershipsForAppInstanceUser</a> API.</p>
27
25
  * @example
@@ -16,7 +16,6 @@ export interface ListChannelMembershipsForAppInstanceUserCommandOutput extends L
16
16
  /**
17
17
  * <p> Lists all channels that a particular <code>AppInstanceUser</code> is a part of. Only an
18
18
  * <code>AppInstanceAdmin</code> can call the API with a user ARN that is not their own. </p>
19
- *
20
19
  * <note>
21
20
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
22
21
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -16,7 +16,6 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
16
16
  /**
17
17
  * <p>Lists all Channels created under a single Chime App as a paginated list. You can specify
18
18
  * filters to narrow results.</p>
19
- *
20
19
  * <p class="title">
21
20
  * <b>Functionality & restrictions</b>
22
21
  * </p>
@@ -30,7 +29,6 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
30
29
  * list the private channels in an account.</p>
31
30
  * </li>
32
31
  * </ul>
33
- *
34
32
  * <note>
35
33
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
36
34
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -15,7 +15,6 @@ export interface ListChannelsModeratedByAppInstanceUserCommandOutput extends Lis
15
15
  }
16
16
  /**
17
17
  * <p>A list of the channels moderated by an <code>AppInstanceUser</code>.</p>
18
- *
19
18
  * <note>
20
19
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
21
20
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -0,0 +1,70 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
+ import { PutMessagingStreamingConfigurationsRequest, PutMessagingStreamingConfigurationsResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link PutMessagingStreamingConfigurationsCommand}.
8
+ */
9
+ export interface PutMessagingStreamingConfigurationsCommandInput extends PutMessagingStreamingConfigurationsRequest {
10
+ }
11
+ /**
12
+ * The output of {@link PutMessagingStreamingConfigurationsCommand}.
13
+ */
14
+ export interface PutMessagingStreamingConfigurationsCommandOutput extends PutMessagingStreamingConfigurationsResponse, __MetadataBearer {
15
+ }
16
+ /**
17
+ * <p>Sets the data streaming configuration for an <code>AppInstance</code>. For more information, see
18
+ * <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the <i>Amazon Chime SDK Developer Guide</i>.</p>
19
+ * @example
20
+ * Use a bare-bones client and the command you need to make an API call.
21
+ * ```javascript
22
+ * import { ChimeSDKMessagingClient, PutMessagingStreamingConfigurationsCommand } from "@aws-sdk/client-chime-sdk-messaging"; // ES Modules import
23
+ * // const { ChimeSDKMessagingClient, PutMessagingStreamingConfigurationsCommand } = require("@aws-sdk/client-chime-sdk-messaging"); // CommonJS import
24
+ * const client = new ChimeSDKMessagingClient(config);
25
+ * const command = new PutMessagingStreamingConfigurationsCommand(input);
26
+ * const response = await client.send(command);
27
+ * ```
28
+ *
29
+ * @see {@link PutMessagingStreamingConfigurationsCommandInput} for command's `input` shape.
30
+ * @see {@link PutMessagingStreamingConfigurationsCommandOutput} for command's `response` shape.
31
+ * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
32
+ *
33
+ * @throws {@link BadRequestException} (client fault)
34
+ * <p>The input parameters don't match the service's restrictions.</p>
35
+ *
36
+ * @throws {@link ConflictException} (client fault)
37
+ * <p>The request could not be processed because of conflict in the current state of the
38
+ * resource.</p>
39
+ *
40
+ * @throws {@link ForbiddenException} (client fault)
41
+ * <p>The client is permanently forbidden from making the request.</p>
42
+ *
43
+ * @throws {@link NotFoundException} (client fault)
44
+ * <p>One or more of the resources in the request does not exist in the system.</p>
45
+ *
46
+ * @throws {@link ServiceFailureException} (server fault)
47
+ * <p>The service encountered an unexpected error.</p>
48
+ *
49
+ * @throws {@link ServiceUnavailableException} (server fault)
50
+ * <p>The service is currently unavailable.</p>
51
+ *
52
+ * @throws {@link ThrottledClientException} (client fault)
53
+ * <p>The client exceeded its request rate limit.</p>
54
+ *
55
+ * @throws {@link UnauthorizedClientException} (client fault)
56
+ * <p>The client is not currently authorized to make the request.</p>
57
+ *
58
+ *
59
+ */
60
+ export declare class PutMessagingStreamingConfigurationsCommand extends $Command<PutMessagingStreamingConfigurationsCommandInput, PutMessagingStreamingConfigurationsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
61
+ readonly input: PutMessagingStreamingConfigurationsCommandInput;
62
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ constructor(input: PutMessagingStreamingConfigurationsCommandInput);
64
+ /**
65
+ * @internal
66
+ */
67
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutMessagingStreamingConfigurationsCommandInput, PutMessagingStreamingConfigurationsCommandOutput>;
68
+ private serialize;
69
+ private deserialize;
70
+ }
@@ -16,7 +16,6 @@ export interface RedactChannelMessageCommandOutput extends RedactChannelMessageR
16
16
  /**
17
17
  * <p>Redacts message content, but not metadata. The message exists in the back end, but the
18
18
  * action returns null content, and the state shows as redacted.</p>
19
- *
20
19
  * <note>
21
20
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
22
21
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -15,12 +15,10 @@ export interface SendChannelMessageCommandOutput extends SendChannelMessageRespo
15
15
  }
16
16
  /**
17
17
  * <p>Sends a message to a particular channel that the member is a part of.</p>
18
- *
19
18
  * <note>
20
19
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
21
20
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
22
21
  * the header.</p>
23
- *
24
22
  * <p>Also, <code>STANDARD</code> messages can contain 4KB of data and the 1KB of metadata.
25
23
  * <code>CONTROL</code> messages can contain 30 bytes of data and no metadata.</p>
26
24
  * </note>
@@ -15,7 +15,6 @@ export interface UpdateChannelMessageCommandOutput extends UpdateChannelMessageR
15
15
  }
16
16
  /**
17
17
  * <p>Updates the content of a message.</p>
18
- *
19
18
  * <note>
20
19
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
21
20
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -15,7 +15,6 @@ export interface UpdateChannelReadMarkerCommandOutput extends UpdateChannelReadM
15
15
  }
16
16
  /**
17
17
  * <p>The details of the time when a user last read messages in a channel.</p>
18
- *
19
18
  * <note>
20
19
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
21
20
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -12,6 +12,7 @@ export * from "./DeleteChannelFlowCommand";
12
12
  export * from "./DeleteChannelMembershipCommand";
13
13
  export * from "./DeleteChannelMessageCommand";
14
14
  export * from "./DeleteChannelModeratorCommand";
15
+ export * from "./DeleteMessagingStreamingConfigurationsCommand";
15
16
  export * from "./DescribeChannelBanCommand";
16
17
  export * from "./DescribeChannelCommand";
17
18
  export * from "./DescribeChannelFlowCommand";
@@ -24,6 +25,7 @@ export * from "./GetChannelMembershipPreferencesCommand";
24
25
  export * from "./GetChannelMessageCommand";
25
26
  export * from "./GetChannelMessageStatusCommand";
26
27
  export * from "./GetMessagingSessionEndpointCommand";
28
+ export * from "./GetMessagingStreamingConfigurationsCommand";
27
29
  export * from "./ListChannelBansCommand";
28
30
  export * from "./ListChannelFlowsCommand";
29
31
  export * from "./ListChannelMembershipsCommand";
@@ -36,6 +38,7 @@ export * from "./ListChannelsModeratedByAppInstanceUserCommand";
36
38
  export * from "./ListSubChannelsCommand";
37
39
  export * from "./ListTagsForResourceCommand";
38
40
  export * from "./PutChannelMembershipPreferencesCommand";
41
+ export * from "./PutMessagingStreamingConfigurationsCommand";
39
42
  export * from "./RedactChannelMessageCommand";
40
43
  export * from "./SearchChannelsCommand";
41
44
  export * from "./SendChannelMessageCommand";
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region: string;
15
+ Region?: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;