@aws-sdk/client-chime-sdk-messaging 3.296.0 → 3.298.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 (163) hide show
  1. package/README.md +8 -0
  2. package/dist-cjs/ChimeSDKMessaging.js +15 -0
  3. package/dist-cjs/commands/AssociateChannelFlowCommand.js +2 -3
  4. package/dist-cjs/commands/BatchCreateChannelMembershipCommand.js +1 -1
  5. package/dist-cjs/commands/ChannelFlowCallbackCommand.js +1 -1
  6. package/dist-cjs/commands/CreateChannelBanCommand.js +1 -1
  7. package/dist-cjs/commands/CreateChannelCommand.js +1 -1
  8. package/dist-cjs/commands/CreateChannelFlowCommand.js +1 -1
  9. package/dist-cjs/commands/CreateChannelMembershipCommand.js +1 -1
  10. package/dist-cjs/commands/CreateChannelModeratorCommand.js +1 -1
  11. package/dist-cjs/commands/DeleteChannelBanCommand.js +2 -3
  12. package/dist-cjs/commands/DeleteChannelCommand.js +2 -3
  13. package/dist-cjs/commands/DeleteChannelFlowCommand.js +2 -3
  14. package/dist-cjs/commands/DeleteChannelMembershipCommand.js +2 -3
  15. package/dist-cjs/commands/DeleteChannelMessageCommand.js +2 -3
  16. package/dist-cjs/commands/DeleteChannelModeratorCommand.js +2 -3
  17. package/dist-cjs/commands/DeleteMessagingStreamingConfigurationsCommand.js +2 -3
  18. package/dist-cjs/commands/DescribeChannelBanCommand.js +1 -1
  19. package/dist-cjs/commands/DescribeChannelCommand.js +1 -1
  20. package/dist-cjs/commands/DescribeChannelFlowCommand.js +1 -1
  21. package/dist-cjs/commands/DescribeChannelMembershipCommand.js +1 -1
  22. package/dist-cjs/commands/DescribeChannelMembershipForAppInstanceUserCommand.js +1 -1
  23. package/dist-cjs/commands/DescribeChannelModeratedByAppInstanceUserCommand.js +1 -1
  24. package/dist-cjs/commands/DescribeChannelModeratorCommand.js +1 -1
  25. package/dist-cjs/commands/DisassociateChannelFlowCommand.js +2 -3
  26. package/dist-cjs/commands/GetChannelMembershipPreferencesCommand.js +1 -1
  27. package/dist-cjs/commands/GetChannelMessageCommand.js +1 -1
  28. package/dist-cjs/commands/GetChannelMessageStatusCommand.js +2 -3
  29. package/dist-cjs/commands/GetMessagingSessionEndpointCommand.js +2 -3
  30. package/dist-cjs/commands/GetMessagingStreamingConfigurationsCommand.js +2 -3
  31. package/dist-cjs/commands/ListTagsForResourceCommand.js +1 -1
  32. package/dist-cjs/commands/PutChannelExpirationSettingsCommand.js +45 -0
  33. package/dist-cjs/commands/PutMessagingStreamingConfigurationsCommand.js +2 -3
  34. package/dist-cjs/commands/RedactChannelMessageCommand.js +2 -3
  35. package/dist-cjs/commands/SendChannelMessageCommand.js +1 -1
  36. package/dist-cjs/commands/TagResourceCommand.js +1 -1
  37. package/dist-cjs/commands/UntagResourceCommand.js +1 -1
  38. package/dist-cjs/commands/UpdateChannelCommand.js +1 -1
  39. package/dist-cjs/commands/UpdateChannelFlowCommand.js +1 -1
  40. package/dist-cjs/commands/UpdateChannelMessageCommand.js +1 -1
  41. package/dist-cjs/commands/UpdateChannelReadMarkerCommand.js +2 -3
  42. package/dist-cjs/commands/index.js +1 -0
  43. package/dist-cjs/models/models_0.js +12 -211
  44. package/dist-cjs/protocols/Aws_restJson1.js +107 -2
  45. package/dist-es/ChimeSDKMessaging.js +15 -0
  46. package/dist-es/commands/AssociateChannelFlowCommand.js +2 -3
  47. package/dist-es/commands/BatchCreateChannelMembershipCommand.js +2 -2
  48. package/dist-es/commands/ChannelFlowCallbackCommand.js +2 -2
  49. package/dist-es/commands/CreateChannelBanCommand.js +2 -2
  50. package/dist-es/commands/CreateChannelCommand.js +2 -2
  51. package/dist-es/commands/CreateChannelFlowCommand.js +2 -2
  52. package/dist-es/commands/CreateChannelMembershipCommand.js +2 -2
  53. package/dist-es/commands/CreateChannelModeratorCommand.js +2 -2
  54. package/dist-es/commands/DeleteChannelBanCommand.js +2 -3
  55. package/dist-es/commands/DeleteChannelCommand.js +2 -3
  56. package/dist-es/commands/DeleteChannelFlowCommand.js +2 -3
  57. package/dist-es/commands/DeleteChannelMembershipCommand.js +2 -3
  58. package/dist-es/commands/DeleteChannelMessageCommand.js +2 -3
  59. package/dist-es/commands/DeleteChannelModeratorCommand.js +2 -3
  60. package/dist-es/commands/DeleteMessagingStreamingConfigurationsCommand.js +2 -3
  61. package/dist-es/commands/DescribeChannelBanCommand.js +2 -2
  62. package/dist-es/commands/DescribeChannelCommand.js +2 -2
  63. package/dist-es/commands/DescribeChannelFlowCommand.js +2 -2
  64. package/dist-es/commands/DescribeChannelMembershipCommand.js +2 -2
  65. package/dist-es/commands/DescribeChannelMembershipForAppInstanceUserCommand.js +2 -2
  66. package/dist-es/commands/DescribeChannelModeratedByAppInstanceUserCommand.js +2 -2
  67. package/dist-es/commands/DescribeChannelModeratorCommand.js +2 -2
  68. package/dist-es/commands/DisassociateChannelFlowCommand.js +2 -3
  69. package/dist-es/commands/GetChannelMembershipPreferencesCommand.js +2 -2
  70. package/dist-es/commands/GetChannelMessageCommand.js +2 -2
  71. package/dist-es/commands/GetChannelMessageStatusCommand.js +2 -3
  72. package/dist-es/commands/GetMessagingSessionEndpointCommand.js +2 -3
  73. package/dist-es/commands/GetMessagingStreamingConfigurationsCommand.js +2 -3
  74. package/dist-es/commands/ListTagsForResourceCommand.js +2 -2
  75. package/dist-es/commands/PutChannelExpirationSettingsCommand.js +41 -0
  76. package/dist-es/commands/PutMessagingStreamingConfigurationsCommand.js +2 -3
  77. package/dist-es/commands/RedactChannelMessageCommand.js +2 -3
  78. package/dist-es/commands/SendChannelMessageCommand.js +2 -2
  79. package/dist-es/commands/TagResourceCommand.js +1 -1
  80. package/dist-es/commands/UntagResourceCommand.js +1 -1
  81. package/dist-es/commands/UpdateChannelCommand.js +2 -2
  82. package/dist-es/commands/UpdateChannelFlowCommand.js +2 -2
  83. package/dist-es/commands/UpdateChannelMessageCommand.js +2 -2
  84. package/dist-es/commands/UpdateChannelReadMarkerCommand.js +2 -3
  85. package/dist-es/commands/index.js +1 -0
  86. package/dist-es/models/models_0.js +10 -156
  87. package/dist-es/protocols/Aws_restJson1.js +102 -0
  88. package/dist-types/ChimeSDKMessaging.d.ts +151 -50
  89. package/dist-types/ChimeSDKMessagingClient.d.ts +27 -6
  90. package/dist-types/commands/AssociateChannelFlowCommand.d.ts +20 -2
  91. package/dist-types/commands/BatchCreateChannelMembershipCommand.d.ts +17 -1
  92. package/dist-types/commands/ChannelFlowCallbackCommand.d.ts +16 -0
  93. package/dist-types/commands/CreateChannelBanCommand.d.ts +17 -1
  94. package/dist-types/commands/CreateChannelCommand.d.ts +17 -1
  95. package/dist-types/commands/CreateChannelFlowCommand.d.ts +16 -0
  96. package/dist-types/commands/CreateChannelMembershipCommand.d.ts +20 -4
  97. package/dist-types/commands/CreateChannelModeratorCommand.d.ts +17 -1
  98. package/dist-types/commands/DeleteChannelBanCommand.d.ts +18 -2
  99. package/dist-types/commands/DeleteChannelCommand.d.ts +17 -1
  100. package/dist-types/commands/DeleteChannelFlowCommand.d.ts +16 -0
  101. package/dist-types/commands/DeleteChannelMembershipCommand.d.ts +16 -0
  102. package/dist-types/commands/DeleteChannelMessageCommand.d.ts +17 -1
  103. package/dist-types/commands/DeleteChannelModeratorCommand.d.ts +17 -1
  104. package/dist-types/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +16 -0
  105. package/dist-types/commands/DescribeChannelBanCommand.d.ts +17 -1
  106. package/dist-types/commands/DescribeChannelCommand.d.ts +17 -1
  107. package/dist-types/commands/DescribeChannelFlowCommand.d.ts +16 -0
  108. package/dist-types/commands/DescribeChannelMembershipCommand.d.ts +17 -1
  109. package/dist-types/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts +18 -2
  110. package/dist-types/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts +18 -2
  111. package/dist-types/commands/DescribeChannelModeratorCommand.d.ts +16 -0
  112. package/dist-types/commands/DisassociateChannelFlowCommand.d.ts +20 -2
  113. package/dist-types/commands/GetChannelMembershipPreferencesCommand.d.ts +26 -3
  114. package/dist-types/commands/GetChannelMessageCommand.d.ts +18 -2
  115. package/dist-types/commands/GetChannelMessageStatusCommand.d.ts +19 -1
  116. package/dist-types/commands/GetMessagingSessionEndpointCommand.d.ts +16 -0
  117. package/dist-types/commands/GetMessagingStreamingConfigurationsCommand.d.ts +16 -0
  118. package/dist-types/commands/ListChannelBansCommand.d.ts +18 -2
  119. package/dist-types/commands/ListChannelFlowsCommand.d.ts +16 -0
  120. package/dist-types/commands/ListChannelMembershipsCommand.d.ts +17 -1
  121. package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +19 -3
  122. package/dist-types/commands/ListChannelMessagesCommand.d.ts +18 -2
  123. package/dist-types/commands/ListChannelModeratorsCommand.d.ts +17 -1
  124. package/dist-types/commands/ListChannelsAssociatedWithChannelFlowCommand.d.ts +16 -0
  125. package/dist-types/commands/ListChannelsCommand.d.ts +17 -1
  126. package/dist-types/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts +17 -1
  127. package/dist-types/commands/ListSubChannelsCommand.d.ts +16 -0
  128. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  129. package/dist-types/commands/PutChannelExpirationSettingsCommand.d.ts +99 -0
  130. package/dist-types/commands/PutChannelMembershipPreferencesCommand.d.ts +26 -3
  131. package/dist-types/commands/PutMessagingStreamingConfigurationsCommand.d.ts +16 -0
  132. package/dist-types/commands/RedactChannelMessageCommand.d.ts +17 -1
  133. package/dist-types/commands/SearchChannelsCommand.d.ts +22 -1
  134. package/dist-types/commands/SendChannelMessageCommand.d.ts +17 -1
  135. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  136. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  137. package/dist-types/commands/UpdateChannelCommand.d.ts +17 -1
  138. package/dist-types/commands/UpdateChannelFlowCommand.d.ts +16 -0
  139. package/dist-types/commands/UpdateChannelMessageCommand.d.ts +17 -1
  140. package/dist-types/commands/UpdateChannelReadMarkerCommand.d.ts +17 -1
  141. package/dist-types/commands/index.d.ts +1 -0
  142. package/dist-types/models/ChimeSDKMessagingServiceException.d.ts +2 -0
  143. package/dist-types/models/models_0.d.ts +504 -250
  144. package/dist-types/pagination/Interfaces.d.ts +3 -0
  145. package/dist-types/pagination/ListChannelBansPaginator.d.ts +3 -0
  146. package/dist-types/pagination/ListChannelFlowsPaginator.d.ts +3 -0
  147. package/dist-types/pagination/ListChannelMembershipsForAppInstanceUserPaginator.d.ts +3 -0
  148. package/dist-types/pagination/ListChannelMembershipsPaginator.d.ts +3 -0
  149. package/dist-types/pagination/ListChannelMessagesPaginator.d.ts +3 -0
  150. package/dist-types/pagination/ListChannelModeratorsPaginator.d.ts +3 -0
  151. package/dist-types/pagination/ListChannelsAssociatedWithChannelFlowPaginator.d.ts +3 -0
  152. package/dist-types/pagination/ListChannelsModeratedByAppInstanceUserPaginator.d.ts +3 -0
  153. package/dist-types/pagination/ListChannelsPaginator.d.ts +3 -0
  154. package/dist-types/pagination/ListSubChannelsPaginator.d.ts +3 -0
  155. package/dist-types/pagination/SearchChannelsPaginator.d.ts +3 -0
  156. package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
  157. package/dist-types/ts3.4/ChimeSDKMessaging.d.ts +17 -0
  158. package/dist-types/ts3.4/ChimeSDKMessagingClient.d.ts +6 -0
  159. package/dist-types/ts3.4/commands/PutChannelExpirationSettingsCommand.d.ts +41 -0
  160. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  161. package/dist-types/ts3.4/models/models_0.d.ts +25 -155
  162. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  163. package/package.json +4 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { PutMessagingStreamingConfigurationsRequest, PutMessagingStreamingConfigurationsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutMessagingStreamingConfigurationsCommand}.
8
10
  */
9
11
  export interface PutMessagingStreamingConfigurationsCommandInput extends PutMessagingStreamingConfigurationsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutMessagingStreamingConfigurationsCommand}.
13
17
  */
14
18
  export interface PutMessagingStreamingConfigurationsCommandOutput extends PutMessagingStreamingConfigurationsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sets the data streaming configuration for an <code>AppInstance</code>. For more information, see
18
23
  * <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
24
  * @example
@@ -26,6 +31,8 @@ export interface PutMessagingStreamingConfigurationsCommandOutput extends PutMes
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param PutMessagingStreamingConfigurationsCommandInput - {@link PutMessagingStreamingConfigurationsCommandInput}
35
+ * @returns {@link PutMessagingStreamingConfigurationsCommandOutput}
29
36
  * @see {@link PutMessagingStreamingConfigurationsCommandInput} for command's `input` shape.
30
37
  * @see {@link PutMessagingStreamingConfigurationsCommandOutput} for command's `response` shape.
31
38
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -60,11 +67,20 @@ export interface PutMessagingStreamingConfigurationsCommandOutput extends PutMes
60
67
  export declare class PutMessagingStreamingConfigurationsCommand extends $Command<PutMessagingStreamingConfigurationsCommandInput, PutMessagingStreamingConfigurationsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
61
68
  readonly input: PutMessagingStreamingConfigurationsCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: PutMessagingStreamingConfigurationsCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutMessagingStreamingConfigurationsCommandInput, PutMessagingStreamingConfigurationsCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,21 +4,26 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { RedactChannelMessageRequest, RedactChannelMessageResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RedactChannelMessageCommand}.
8
10
  */
9
11
  export interface RedactChannelMessageCommandInput extends RedactChannelMessageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RedactChannelMessageCommand}.
13
17
  */
14
18
  export interface RedactChannelMessageCommandOutput extends RedactChannelMessageResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Redacts message content, but not metadata. The message exists in the back end, but the
18
23
  * action returns null content, and the state shows as redacted.</p>
19
24
  * <note>
20
25
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
21
- * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
26
+ * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
22
27
  * the header.</p>
23
28
  * </note>
24
29
  * @example
@@ -31,6 +36,8 @@ export interface RedactChannelMessageCommandOutput extends RedactChannelMessageR
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param RedactChannelMessageCommandInput - {@link RedactChannelMessageCommandInput}
40
+ * @returns {@link RedactChannelMessageCommandOutput}
34
41
  * @see {@link RedactChannelMessageCommandInput} for command's `input` shape.
35
42
  * @see {@link RedactChannelMessageCommandOutput} for command's `response` shape.
36
43
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -62,11 +69,20 @@ export interface RedactChannelMessageCommandOutput extends RedactChannelMessageR
62
69
  export declare class RedactChannelMessageCommand extends $Command<RedactChannelMessageCommandInput, RedactChannelMessageCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
63
70
  readonly input: RedactChannelMessageCommandInput;
64
71
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
65
75
  constructor(input: RedactChannelMessageCommandInput);
66
76
  /**
67
77
  * @internal
68
78
  */
69
79
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RedactChannelMessageCommandInput, RedactChannelMessageCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
70
83
  private serialize;
84
+ /**
85
+ * @internal
86
+ */
71
87
  private deserialize;
72
88
  }
@@ -4,17 +4,27 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { SearchChannelsRequest, SearchChannelsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SearchChannelsCommand}.
8
10
  */
9
11
  export interface SearchChannelsCommandInput extends SearchChannelsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SearchChannelsCommand}.
13
17
  */
14
18
  export interface SearchChannelsCommandOutput extends SearchChannelsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
17
- * <p>Allows <code>ChimeBearer</code> to search channels by channel members. AppInstanceUsers can search across the channels that they belong to. AppInstanceAdmins can search across all channels.</p>
21
+ * @public
22
+ * <p>Allows the <code>ChimeBearer</code> to search channels by channel members. Users or bots can search
23
+ * across the channels that they belong to. Users in the <code>AppInstanceAdmin</code> role can search across
24
+ * all channels.</p>
25
+ * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
26
+ * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
27
+ * the header.</p>
18
28
  * @example
19
29
  * Use a bare-bones client and the command you need to make an API call.
20
30
  * ```javascript
@@ -25,6 +35,8 @@ export interface SearchChannelsCommandOutput extends SearchChannelsResponse, __M
25
35
  * const response = await client.send(command);
26
36
  * ```
27
37
  *
38
+ * @param SearchChannelsCommandInput - {@link SearchChannelsCommandInput}
39
+ * @returns {@link SearchChannelsCommandOutput}
28
40
  * @see {@link SearchChannelsCommandInput} for command's `input` shape.
29
41
  * @see {@link SearchChannelsCommandOutput} for command's `response` shape.
30
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -52,11 +64,20 @@ export interface SearchChannelsCommandOutput extends SearchChannelsResponse, __M
52
64
  export declare class SearchChannelsCommand extends $Command<SearchChannelsCommandInput, SearchChannelsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
53
65
  readonly input: SearchChannelsCommandInput;
54
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
55
70
  constructor(input: SearchChannelsCommandInput);
56
71
  /**
57
72
  * @internal
58
73
  */
59
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchChannelsCommandInput, SearchChannelsCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
60
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
61
82
  private deserialize;
62
83
  }
@@ -4,20 +4,25 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { SendChannelMessageRequest, SendChannelMessageResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SendChannelMessageCommand}.
8
10
  */
9
11
  export interface SendChannelMessageCommandInput extends SendChannelMessageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SendChannelMessageCommand}.
13
17
  */
14
18
  export interface SendChannelMessageCommandOutput extends SendChannelMessageResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sends a message to a particular channel that the member is a part of.</p>
18
23
  * <note>
19
24
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
20
- * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
25
+ * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
21
26
  * the header.</p>
22
27
  * <p>Also, <code>STANDARD</code> messages can contain 4KB of data and the 1KB of metadata.
23
28
  * <code>CONTROL</code> messages can contain 30 bytes of data and no metadata.</p>
@@ -32,6 +37,8 @@ export interface SendChannelMessageCommandOutput extends SendChannelMessageRespo
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param SendChannelMessageCommandInput - {@link SendChannelMessageCommandInput}
41
+ * @returns {@link SendChannelMessageCommandOutput}
35
42
  * @see {@link SendChannelMessageCommandInput} for command's `input` shape.
36
43
  * @see {@link SendChannelMessageCommandOutput} for command's `response` shape.
37
44
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -63,11 +70,20 @@ export interface SendChannelMessageCommandOutput extends SendChannelMessageRespo
63
70
  export declare class SendChannelMessageCommand extends $Command<SendChannelMessageCommandInput, SendChannelMessageCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
64
71
  readonly input: SendChannelMessageCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: SendChannelMessageCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendChannelMessageCommandInput, SendChannelMessageCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { TagResourceRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Applies the specified tags to the specified Amazon Chime SDK messaging resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
34
+ * @returns {@link TagResourceCommandOutput}
28
35
  * @see {@link TagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -55,11 +62,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
55
62
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
56
63
  readonly input: TagResourceCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: TagResourceCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { UntagResourceRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes the specified tags from the specified Amazon Chime SDK messaging resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
34
+ * @returns {@link UntagResourceCommandOutput}
28
35
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
52
59
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
53
60
  readonly input: UntagResourceCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: UntagResourceCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,22 +4,27 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { UpdateChannelRequest, UpdateChannelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateChannelCommand}.
8
10
  */
9
11
  export interface UpdateChannelCommandInput extends UpdateChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateChannelCommand}.
13
17
  */
14
18
  export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Update a channel's attributes.</p>
18
23
  * <p>
19
24
  * <b>Restriction</b>: You can't change a channel's privacy. </p>
20
25
  * <note>
21
26
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
22
- * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
27
+ * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
23
28
  * the header.</p>
24
29
  * </note>
25
30
  * @example
@@ -32,6 +37,8 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param UpdateChannelCommandInput - {@link UpdateChannelCommandInput}
41
+ * @returns {@link UpdateChannelCommandOutput}
35
42
  * @see {@link UpdateChannelCommandInput} for command's `input` shape.
36
43
  * @see {@link UpdateChannelCommandOutput} for command's `response` shape.
37
44
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -63,11 +70,20 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met
63
70
  export declare class UpdateChannelCommand extends $Command<UpdateChannelCommandInput, UpdateChannelCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
64
71
  readonly input: UpdateChannelCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: UpdateChannelCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateChannelCommandInput, UpdateChannelCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { UpdateChannelFlowRequest, UpdateChannelFlowResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateChannelFlowCommand}.
8
10
  */
9
11
  export interface UpdateChannelFlowCommandInput extends UpdateChannelFlowRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateChannelFlowCommand}.
13
17
  */
14
18
  export interface UpdateChannelFlowCommandOutput extends UpdateChannelFlowResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates channel flow attributes. This is a developer API.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateChannelFlowCommandOutput extends UpdateChannelFlowRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateChannelFlowCommandInput - {@link UpdateChannelFlowCommandInput}
34
+ * @returns {@link UpdateChannelFlowCommandOutput}
28
35
  * @see {@link UpdateChannelFlowCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateChannelFlowCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -56,11 +63,20 @@ export interface UpdateChannelFlowCommandOutput extends UpdateChannelFlowRespons
56
63
  export declare class UpdateChannelFlowCommand extends $Command<UpdateChannelFlowCommandInput, UpdateChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
57
64
  readonly input: UpdateChannelFlowCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: UpdateChannelFlowCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateChannelFlowCommandInput, UpdateChannelFlowCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,20 +4,25 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { UpdateChannelMessageRequest, UpdateChannelMessageResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateChannelMessageCommand}.
8
10
  */
9
11
  export interface UpdateChannelMessageCommandInput extends UpdateChannelMessageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateChannelMessageCommand}.
13
17
  */
14
18
  export interface UpdateChannelMessageCommandOutput extends UpdateChannelMessageResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the content of a message.</p>
18
23
  * <note>
19
24
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
20
- * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
25
+ * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
21
26
  * the header.</p>
22
27
  * </note>
23
28
  * @example
@@ -30,6 +35,8 @@ export interface UpdateChannelMessageCommandOutput extends UpdateChannelMessageR
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param UpdateChannelMessageCommandInput - {@link UpdateChannelMessageCommandInput}
39
+ * @returns {@link UpdateChannelMessageCommandOutput}
33
40
  * @see {@link UpdateChannelMessageCommandInput} for command's `input` shape.
34
41
  * @see {@link UpdateChannelMessageCommandOutput} for command's `response` shape.
35
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -61,11 +68,20 @@ export interface UpdateChannelMessageCommandOutput extends UpdateChannelMessageR
61
68
  export declare class UpdateChannelMessageCommand extends $Command<UpdateChannelMessageCommandInput, UpdateChannelMessageCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
62
69
  readonly input: UpdateChannelMessageCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: UpdateChannelMessageCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateChannelMessageCommandInput, UpdateChannelMessageCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,20 +4,25 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { UpdateChannelReadMarkerRequest, UpdateChannelReadMarkerResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateChannelReadMarkerCommand}.
8
10
  */
9
11
  export interface UpdateChannelReadMarkerCommandInput extends UpdateChannelReadMarkerRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateChannelReadMarkerCommand}.
13
17
  */
14
18
  export interface UpdateChannelReadMarkerCommandOutput extends UpdateChannelReadMarkerResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>The details of the time when a user last read messages in a channel.</p>
18
23
  * <note>
19
24
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
20
- * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
25
+ * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
21
26
  * the header.</p>
22
27
  * </note>
23
28
  * @example
@@ -30,6 +35,8 @@ export interface UpdateChannelReadMarkerCommandOutput extends UpdateChannelReadM
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param UpdateChannelReadMarkerCommandInput - {@link UpdateChannelReadMarkerCommandInput}
39
+ * @returns {@link UpdateChannelReadMarkerCommandOutput}
33
40
  * @see {@link UpdateChannelReadMarkerCommandInput} for command's `input` shape.
34
41
  * @see {@link UpdateChannelReadMarkerCommandOutput} for command's `response` shape.
35
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -61,11 +68,20 @@ export interface UpdateChannelReadMarkerCommandOutput extends UpdateChannelReadM
61
68
  export declare class UpdateChannelReadMarkerCommand extends $Command<UpdateChannelReadMarkerCommandInput, UpdateChannelReadMarkerCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
62
69
  readonly input: UpdateChannelReadMarkerCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: UpdateChannelReadMarkerCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateChannelReadMarkerCommandInput, UpdateChannelReadMarkerCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -37,6 +37,7 @@ export * from "./ListChannelsCommand";
37
37
  export * from "./ListChannelsModeratedByAppInstanceUserCommand";
38
38
  export * from "./ListSubChannelsCommand";
39
39
  export * from "./ListTagsForResourceCommand";
40
+ export * from "./PutChannelExpirationSettingsCommand";
40
41
  export * from "./PutChannelMembershipPreferencesCommand";
41
42
  export * from "./PutMessagingStreamingConfigurationsCommand";
42
43
  export * from "./RedactChannelMessageCommand";
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from ChimeSDKMessaging service.
4
6
  */
5
7
  export declare class ChimeSDKMessagingServiceException extends __ServiceException {