@aws-sdk/client-chime-sdk-messaging 3.296.0 → 3.297.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 (67) hide show
  1. package/dist-types/ChimeSDKMessaging.d.ts +51 -0
  2. package/dist-types/ChimeSDKMessagingClient.d.ts +24 -4
  3. package/dist-types/commands/AssociateChannelFlowCommand.d.ts +16 -0
  4. package/dist-types/commands/BatchCreateChannelMembershipCommand.d.ts +16 -0
  5. package/dist-types/commands/ChannelFlowCallbackCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateChannelBanCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateChannelCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateChannelFlowCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateChannelMembershipCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateChannelModeratorCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteChannelBanCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteChannelCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteChannelFlowCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteChannelMembershipCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteChannelMessageCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteChannelModeratorCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeChannelBanCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeChannelCommand.d.ts +16 -0
  20. package/dist-types/commands/DescribeChannelFlowCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeChannelMembershipCommand.d.ts +16 -0
  22. package/dist-types/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts +16 -0
  23. package/dist-types/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts +16 -0
  24. package/dist-types/commands/DescribeChannelModeratorCommand.d.ts +16 -0
  25. package/dist-types/commands/DisassociateChannelFlowCommand.d.ts +16 -0
  26. package/dist-types/commands/GetChannelMembershipPreferencesCommand.d.ts +16 -0
  27. package/dist-types/commands/GetChannelMessageCommand.d.ts +16 -0
  28. package/dist-types/commands/GetChannelMessageStatusCommand.d.ts +16 -0
  29. package/dist-types/commands/GetMessagingSessionEndpointCommand.d.ts +16 -0
  30. package/dist-types/commands/GetMessagingStreamingConfigurationsCommand.d.ts +16 -0
  31. package/dist-types/commands/ListChannelBansCommand.d.ts +16 -0
  32. package/dist-types/commands/ListChannelFlowsCommand.d.ts +16 -0
  33. package/dist-types/commands/ListChannelMembershipsCommand.d.ts +16 -0
  34. package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +16 -0
  35. package/dist-types/commands/ListChannelMessagesCommand.d.ts +16 -0
  36. package/dist-types/commands/ListChannelModeratorsCommand.d.ts +16 -0
  37. package/dist-types/commands/ListChannelsAssociatedWithChannelFlowCommand.d.ts +16 -0
  38. package/dist-types/commands/ListChannelsCommand.d.ts +16 -0
  39. package/dist-types/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts +16 -0
  40. package/dist-types/commands/ListSubChannelsCommand.d.ts +16 -0
  41. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  42. package/dist-types/commands/PutChannelMembershipPreferencesCommand.d.ts +16 -0
  43. package/dist-types/commands/PutMessagingStreamingConfigurationsCommand.d.ts +16 -0
  44. package/dist-types/commands/RedactChannelMessageCommand.d.ts +16 -0
  45. package/dist-types/commands/SearchChannelsCommand.d.ts +16 -0
  46. package/dist-types/commands/SendChannelMessageCommand.d.ts +16 -0
  47. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  48. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  49. package/dist-types/commands/UpdateChannelCommand.d.ts +16 -0
  50. package/dist-types/commands/UpdateChannelFlowCommand.d.ts +16 -0
  51. package/dist-types/commands/UpdateChannelMessageCommand.d.ts +16 -0
  52. package/dist-types/commands/UpdateChannelReadMarkerCommand.d.ts +16 -0
  53. package/dist-types/models/ChimeSDKMessagingServiceException.d.ts +2 -0
  54. package/dist-types/models/models_0.d.ts +355 -0
  55. package/dist-types/pagination/Interfaces.d.ts +3 -0
  56. package/dist-types/pagination/ListChannelBansPaginator.d.ts +3 -0
  57. package/dist-types/pagination/ListChannelFlowsPaginator.d.ts +3 -0
  58. package/dist-types/pagination/ListChannelMembershipsForAppInstanceUserPaginator.d.ts +3 -0
  59. package/dist-types/pagination/ListChannelMembershipsPaginator.d.ts +3 -0
  60. package/dist-types/pagination/ListChannelMessagesPaginator.d.ts +3 -0
  61. package/dist-types/pagination/ListChannelModeratorsPaginator.d.ts +3 -0
  62. package/dist-types/pagination/ListChannelsAssociatedWithChannelFlowPaginator.d.ts +3 -0
  63. package/dist-types/pagination/ListChannelsModeratedByAppInstanceUserPaginator.d.ts +3 -0
  64. package/dist-types/pagination/ListChannelsPaginator.d.ts +3 -0
  65. package/dist-types/pagination/ListSubChannelsPaginator.d.ts +3 -0
  66. package/dist-types/pagination/SearchChannelsPaginator.d.ts +3 -0
  67. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { CreateChannelBanRequest, CreateChannelBanResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateChannelBanCommand}.
8
10
  */
9
11
  export interface CreateChannelBanCommandInput extends CreateChannelBanRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateChannelBanCommand}.
13
17
  */
14
18
  export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Permanently bans a member from a channel. Moderators can't add banned members to a
18
23
  * channel. To undo a ban, you first have to <code>DeleteChannelBan</code>, and then
19
24
  * <code>CreateChannelMembership</code>. Bans are cleaned up when you delete users or
@@ -35,6 +40,8 @@ export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse,
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param CreateChannelBanCommandInput - {@link CreateChannelBanCommandInput}
44
+ * @returns {@link CreateChannelBanCommandOutput}
38
45
  * @see {@link CreateChannelBanCommandInput} for command's `input` shape.
39
46
  * @see {@link CreateChannelBanCommandOutput} for command's `response` shape.
40
47
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -69,11 +76,20 @@ export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse,
69
76
  export declare class CreateChannelBanCommand extends $Command<CreateChannelBanCommandInput, CreateChannelBanCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
70
77
  readonly input: CreateChannelBanCommandInput;
71
78
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
72
82
  constructor(input: CreateChannelBanCommandInput);
73
83
  /**
74
84
  * @internal
75
85
  */
76
86
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateChannelBanCommandInput, CreateChannelBanCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
77
90
  private serialize;
91
+ /**
92
+ * @internal
93
+ */
78
94
  private deserialize;
79
95
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { CreateChannelRequest, CreateChannelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateChannelCommand}.
8
10
  */
9
11
  export interface CreateChannelCommandInput extends CreateChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateChannelCommand}.
13
17
  */
14
18
  export interface CreateChannelCommandOutput extends CreateChannelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a channel to which you can add users and send messages.</p>
18
23
  * <p>
19
24
  * <b>Restriction</b>: You can't change a channel's
@@ -33,6 +38,8 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param CreateChannelCommandInput - {@link CreateChannelCommandInput}
42
+ * @returns {@link CreateChannelCommandOutput}
36
43
  * @see {@link CreateChannelCommandInput} for command's `input` shape.
37
44
  * @see {@link CreateChannelCommandOutput} for command's `response` shape.
38
45
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -67,11 +74,20 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
67
74
  export declare class CreateChannelCommand extends $Command<CreateChannelCommandInput, CreateChannelCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
68
75
  readonly input: CreateChannelCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: CreateChannelCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateChannelCommandInput, CreateChannelCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { CreateChannelFlowRequest, CreateChannelFlowResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateChannelFlowCommand}.
8
10
  */
9
11
  export interface CreateChannelFlowCommandInput extends CreateChannelFlowRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateChannelFlowCommand}.
13
17
  */
14
18
  export interface CreateChannelFlowCommandOutput extends CreateChannelFlowResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a channel flow, a container for processors. Processors are AWS Lambda functions
18
23
  * that perform actions on chat messages, such as stripping out profanity. You can associate
19
24
  * channel flows with channels, and the processors in the channel flow then take action on all
@@ -44,6 +49,8 @@ export interface CreateChannelFlowCommandOutput extends CreateChannelFlowRespons
44
49
  * const response = await client.send(command);
45
50
  * ```
46
51
  *
52
+ * @param CreateChannelFlowCommandInput - {@link CreateChannelFlowCommandInput}
53
+ * @returns {@link CreateChannelFlowCommandOutput}
47
54
  * @see {@link CreateChannelFlowCommandInput} for command's `input` shape.
48
55
  * @see {@link CreateChannelFlowCommandOutput} for command's `response` shape.
49
56
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -78,11 +85,20 @@ export interface CreateChannelFlowCommandOutput extends CreateChannelFlowRespons
78
85
  export declare class CreateChannelFlowCommand extends $Command<CreateChannelFlowCommandInput, CreateChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
79
86
  readonly input: CreateChannelFlowCommandInput;
80
87
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
81
91
  constructor(input: CreateChannelFlowCommandInput);
82
92
  /**
83
93
  * @internal
84
94
  */
85
95
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateChannelFlowCommandInput, CreateChannelFlowCommandOutput>;
96
+ /**
97
+ * @internal
98
+ */
86
99
  private serialize;
100
+ /**
101
+ * @internal
102
+ */
87
103
  private deserialize;
88
104
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { CreateChannelMembershipRequest, CreateChannelMembershipResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateChannelMembershipCommand}.
8
10
  */
9
11
  export interface CreateChannelMembershipCommandInput extends CreateChannelMembershipRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateChannelMembershipCommand}.
13
17
  */
14
18
  export interface CreateChannelMembershipCommandOutput extends CreateChannelMembershipResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds a user to a channel. The <code>InvitedBy</code> field in <code>ChannelMembership</code> is derived from the
18
23
  * request header. A channel member can:</p>
19
24
  * <ul>
@@ -58,6 +63,8 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
58
63
  * const response = await client.send(command);
59
64
  * ```
60
65
  *
66
+ * @param CreateChannelMembershipCommandInput - {@link CreateChannelMembershipCommandInput}
67
+ * @returns {@link CreateChannelMembershipCommandOutput}
61
68
  * @see {@link CreateChannelMembershipCommandInput} for command's `input` shape.
62
69
  * @see {@link CreateChannelMembershipCommandOutput} for command's `response` shape.
63
70
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -95,11 +102,20 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
95
102
  export declare class CreateChannelMembershipCommand extends $Command<CreateChannelMembershipCommandInput, CreateChannelMembershipCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
96
103
  readonly input: CreateChannelMembershipCommandInput;
97
104
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
105
+ /**
106
+ * @public
107
+ */
98
108
  constructor(input: CreateChannelMembershipCommandInput);
99
109
  /**
100
110
  * @internal
101
111
  */
102
112
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateChannelMembershipCommandInput, CreateChannelMembershipCommandOutput>;
113
+ /**
114
+ * @internal
115
+ */
103
116
  private serialize;
117
+ /**
118
+ * @internal
119
+ */
104
120
  private deserialize;
105
121
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { CreateChannelModeratorRequest, CreateChannelModeratorResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateChannelModeratorCommand}.
8
10
  */
9
11
  export interface CreateChannelModeratorCommandInput extends CreateChannelModeratorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateChannelModeratorCommand}.
13
17
  */
14
18
  export interface CreateChannelModeratorCommandOutput extends CreateChannelModeratorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new <code>ChannelModerator</code>. A channel moderator can:</p>
18
23
  * <ul>
19
24
  * <li>
@@ -47,6 +52,8 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera
47
52
  * const response = await client.send(command);
48
53
  * ```
49
54
  *
55
+ * @param CreateChannelModeratorCommandInput - {@link CreateChannelModeratorCommandInput}
56
+ * @returns {@link CreateChannelModeratorCommandOutput}
50
57
  * @see {@link CreateChannelModeratorCommandInput} for command's `input` shape.
51
58
  * @see {@link CreateChannelModeratorCommandOutput} for command's `response` shape.
52
59
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -81,11 +88,20 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera
81
88
  export declare class CreateChannelModeratorCommand extends $Command<CreateChannelModeratorCommandInput, CreateChannelModeratorCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
82
89
  readonly input: CreateChannelModeratorCommandInput;
83
90
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
91
+ /**
92
+ * @public
93
+ */
84
94
  constructor(input: CreateChannelModeratorCommandInput);
85
95
  /**
86
96
  * @internal
87
97
  */
88
98
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateChannelModeratorCommandInput, CreateChannelModeratorCommandOutput>;
99
+ /**
100
+ * @internal
101
+ */
89
102
  private serialize;
103
+ /**
104
+ * @internal
105
+ */
90
106
  private deserialize;
91
107
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DeleteChannelBanRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteChannelBanCommand}.
8
10
  */
9
11
  export interface DeleteChannelBanCommandInput extends DeleteChannelBanRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteChannelBanCommand}.
13
17
  */
14
18
  export interface DeleteChannelBanCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes a user from a channel's ban list.</p>
18
23
  * <note>
19
24
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
@@ -30,6 +35,8 @@ export interface DeleteChannelBanCommandOutput extends __MetadataBearer {
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DeleteChannelBanCommandInput - {@link DeleteChannelBanCommandInput}
39
+ * @returns {@link DeleteChannelBanCommandOutput}
33
40
  * @see {@link DeleteChannelBanCommandInput} for command's `input` shape.
34
41
  * @see {@link DeleteChannelBanCommandOutput} for command's `response` shape.
35
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -57,11 +64,20 @@ export interface DeleteChannelBanCommandOutput extends __MetadataBearer {
57
64
  export declare class DeleteChannelBanCommand extends $Command<DeleteChannelBanCommandInput, DeleteChannelBanCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
58
65
  readonly input: DeleteChannelBanCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: DeleteChannelBanCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteChannelBanCommandInput, DeleteChannelBanCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DeleteChannelRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteChannelCommand}.
8
10
  */
9
11
  export interface DeleteChannelCommandInput extends DeleteChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteChannelCommand}.
13
17
  */
14
18
  export interface DeleteChannelCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Immediately makes a channel and its memberships inaccessible and marks them for
18
23
  * deletion. This is an irreversible process.</p>
19
24
  * <note>
@@ -31,6 +36,8 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param DeleteChannelCommandInput - {@link DeleteChannelCommandInput}
40
+ * @returns {@link DeleteChannelCommandOutput}
34
41
  * @see {@link DeleteChannelCommandInput} for command's `input` shape.
35
42
  * @see {@link DeleteChannelCommandOutput} for command's `response` shape.
36
43
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -58,11 +65,20 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {
58
65
  export declare class DeleteChannelCommand extends $Command<DeleteChannelCommandInput, DeleteChannelCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
59
66
  readonly input: DeleteChannelCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: DeleteChannelCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteChannelCommandInput, DeleteChannelCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DeleteChannelFlowRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteChannelFlowCommand}.
8
10
  */
9
11
  export interface DeleteChannelFlowCommandInput extends DeleteChannelFlowRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteChannelFlowCommand}.
13
17
  */
14
18
  export interface DeleteChannelFlowCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a channel flow, an irreversible process. This is a developer API.</p>
18
23
  * <note>
19
24
  * <p> This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the
@@ -29,6 +34,8 @@ export interface DeleteChannelFlowCommandOutput extends __MetadataBearer {
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteChannelFlowCommandInput - {@link DeleteChannelFlowCommandInput}
38
+ * @returns {@link DeleteChannelFlowCommandOutput}
32
39
  * @see {@link DeleteChannelFlowCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteChannelFlowCommandOutput} for command's `response` shape.
34
41
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DeleteChannelFlowCommandOutput extends __MetadataBearer {
60
67
  export declare class DeleteChannelFlowCommand extends $Command<DeleteChannelFlowCommandInput, DeleteChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
61
68
  readonly input: DeleteChannelFlowCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DeleteChannelFlowCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteChannelFlowCommandInput, DeleteChannelFlowCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DeleteChannelMembershipRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteChannelMembershipCommand}.
8
10
  */
9
11
  export interface DeleteChannelMembershipCommandInput extends DeleteChannelMembershipRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteChannelMembershipCommand}.
13
17
  */
14
18
  export interface DeleteChannelMembershipCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes a member from a channel.</p>
18
23
  * <note>
19
24
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
@@ -30,6 +35,8 @@ export interface DeleteChannelMembershipCommandOutput extends __MetadataBearer {
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DeleteChannelMembershipCommandInput - {@link DeleteChannelMembershipCommandInput}
39
+ * @returns {@link DeleteChannelMembershipCommandOutput}
33
40
  * @see {@link DeleteChannelMembershipCommandInput} for command's `input` shape.
34
41
  * @see {@link DeleteChannelMembershipCommandOutput} for command's `response` shape.
35
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DeleteChannelMembershipCommandOutput extends __MetadataBearer {
61
68
  export declare class DeleteChannelMembershipCommand extends $Command<DeleteChannelMembershipCommandInput, DeleteChannelMembershipCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
62
69
  readonly input: DeleteChannelMembershipCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DeleteChannelMembershipCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteChannelMembershipCommandInput, DeleteChannelMembershipCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DeleteChannelMessageRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteChannelMessageCommand}.
8
10
  */
9
11
  export interface DeleteChannelMessageCommandInput extends DeleteChannelMessageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteChannelMessageCommand}.
13
17
  */
14
18
  export interface DeleteChannelMessageCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a channel message. Only admins can perform this action. Deletion makes messages
18
23
  * inaccessible immediately. A background process deletes any revisions created by
19
24
  * <code>UpdateChannelMessage</code>.</p>
@@ -32,6 +37,8 @@ export interface DeleteChannelMessageCommandOutput extends __MetadataBearer {
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param DeleteChannelMessageCommandInput - {@link DeleteChannelMessageCommandInput}
41
+ * @returns {@link DeleteChannelMessageCommandOutput}
35
42
  * @see {@link DeleteChannelMessageCommandInput} for command's `input` shape.
36
43
  * @see {@link DeleteChannelMessageCommandOutput} for command's `response` shape.
37
44
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -59,11 +66,20 @@ export interface DeleteChannelMessageCommandOutput extends __MetadataBearer {
59
66
  export declare class DeleteChannelMessageCommand extends $Command<DeleteChannelMessageCommandInput, DeleteChannelMessageCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
60
67
  readonly input: DeleteChannelMessageCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: DeleteChannelMessageCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteChannelMessageCommandInput, DeleteChannelMessageCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DeleteChannelModeratorRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteChannelModeratorCommand}.
8
10
  */
9
11
  export interface DeleteChannelModeratorCommandInput extends DeleteChannelModeratorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteChannelModeratorCommand}.
13
17
  */
14
18
  export interface DeleteChannelModeratorCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a channel moderator.</p>
18
23
  * <note>
19
24
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
@@ -30,6 +35,8 @@ export interface DeleteChannelModeratorCommandOutput extends __MetadataBearer {
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DeleteChannelModeratorCommandInput - {@link DeleteChannelModeratorCommandInput}
39
+ * @returns {@link DeleteChannelModeratorCommandOutput}
33
40
  * @see {@link DeleteChannelModeratorCommandInput} for command's `input` shape.
34
41
  * @see {@link DeleteChannelModeratorCommandOutput} for command's `response` shape.
35
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -57,11 +64,20 @@ export interface DeleteChannelModeratorCommandOutput extends __MetadataBearer {
57
64
  export declare class DeleteChannelModeratorCommand extends $Command<DeleteChannelModeratorCommandInput, DeleteChannelModeratorCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
58
65
  readonly input: DeleteChannelModeratorCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: DeleteChannelModeratorCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteChannelModeratorCommandInput, DeleteChannelModeratorCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DeleteMessagingStreamingConfigurationsRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteMessagingStreamingConfigurationsCommand}.
8
10
  */
9
11
  export interface DeleteMessagingStreamingConfigurationsCommandInput extends DeleteMessagingStreamingConfigurationsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteMessagingStreamingConfigurationsCommand}.
13
17
  */
14
18
  export interface DeleteMessagingStreamingConfigurationsCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the streaming configurations 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 DeleteMessagingStreamingConfigurationsCommandOutput extends __M
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteMessagingStreamingConfigurationsCommandInput - {@link DeleteMessagingStreamingConfigurationsCommandInput}
35
+ * @returns {@link DeleteMessagingStreamingConfigurationsCommandOutput}
29
36
  * @see {@link DeleteMessagingStreamingConfigurationsCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteMessagingStreamingConfigurationsCommandOutput} for command's `response` shape.
31
38
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DeleteMessagingStreamingConfigurationsCommandOutput extends __M
50
57
  export declare class DeleteMessagingStreamingConfigurationsCommand extends $Command<DeleteMessagingStreamingConfigurationsCommandInput, DeleteMessagingStreamingConfigurationsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
51
58
  readonly input: DeleteMessagingStreamingConfigurationsCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DeleteMessagingStreamingConfigurationsCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteMessagingStreamingConfigurationsCommandInput, DeleteMessagingStreamingConfigurationsCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }