@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 { GetMessagingStreamingConfigurationsRequest, GetMessagingStreamingConfigurationsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetMessagingStreamingConfigurationsCommand}.
8
10
  */
9
11
  export interface GetMessagingStreamingConfigurationsCommandInput extends GetMessagingStreamingConfigurationsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetMessagingStreamingConfigurationsCommand}.
13
17
  */
14
18
  export interface GetMessagingStreamingConfigurationsCommandOutput extends GetMessagingStreamingConfigurationsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves 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 GetMessagingStreamingConfigurationsCommandOutput extends GetMes
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetMessagingStreamingConfigurationsCommandInput - {@link GetMessagingStreamingConfigurationsCommandInput}
35
+ * @returns {@link GetMessagingStreamingConfigurationsCommandOutput}
29
36
  * @see {@link GetMessagingStreamingConfigurationsCommandInput} for command's `input` shape.
30
37
  * @see {@link GetMessagingStreamingConfigurationsCommandOutput} for command's `response` shape.
31
38
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -56,11 +63,20 @@ export interface GetMessagingStreamingConfigurationsCommandOutput extends GetMes
56
63
  export declare class GetMessagingStreamingConfigurationsCommand extends $Command<GetMessagingStreamingConfigurationsCommandInput, GetMessagingStreamingConfigurationsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
57
64
  readonly input: GetMessagingStreamingConfigurationsCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: GetMessagingStreamingConfigurationsCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetMessagingStreamingConfigurationsCommandInput, GetMessagingStreamingConfigurationsCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { ListChannelBansRequest, ListChannelBansResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListChannelBansCommand}.
8
10
  */
9
11
  export interface ListChannelBansCommandInput extends ListChannelBansRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListChannelBansCommand}.
13
17
  */
14
18
  export interface ListChannelBansCommandOutput extends ListChannelBansResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all the users banned from a particular 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 ListChannelBansCommandOutput extends ListChannelBansResponse, _
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param ListChannelBansCommandInput - {@link ListChannelBansCommandInput}
39
+ * @returns {@link ListChannelBansCommandOutput}
33
40
  * @see {@link ListChannelBansCommandInput} for command's `input` shape.
34
41
  * @see {@link ListChannelBansCommandOutput} for command's `response` shape.
35
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -57,11 +64,20 @@ export interface ListChannelBansCommandOutput extends ListChannelBansResponse, _
57
64
  export declare class ListChannelBansCommand extends $Command<ListChannelBansCommandInput, ListChannelBansCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
58
65
  readonly input: ListChannelBansCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: ListChannelBansCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelBansCommandInput, ListChannelBansCommandOutput>;
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 { ListChannelFlowsRequest, ListChannelFlowsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListChannelFlowsCommand}.
8
10
  */
9
11
  export interface ListChannelFlowsCommandInput extends ListChannelFlowsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListChannelFlowsCommand}.
13
17
  */
14
18
  export interface ListChannelFlowsCommandOutput extends ListChannelFlowsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a paginated lists of all the channel flows created under a single Chime. 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 ListChannelFlowsCommandOutput extends ListChannelFlowsResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListChannelFlowsCommandInput - {@link ListChannelFlowsCommandInput}
34
+ * @returns {@link ListChannelFlowsCommandOutput}
28
35
  * @see {@link ListChannelFlowsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListChannelFlowsCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ListChannelFlowsCommandOutput extends ListChannelFlowsResponse,
52
59
  export declare class ListChannelFlowsCommand extends $Command<ListChannelFlowsCommandInput, ListChannelFlowsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
53
60
  readonly input: ListChannelFlowsCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: ListChannelFlowsCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelFlowsCommandInput, ListChannelFlowsCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { ListChannelMembershipsRequest, ListChannelMembershipsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListChannelMembershipsCommand}.
8
10
  */
9
11
  export interface ListChannelMembershipsCommandInput extends ListChannelMembershipsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListChannelMembershipsCommand}.
13
17
  */
14
18
  export interface ListChannelMembershipsCommandOutput extends ListChannelMembershipsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all channel memberships in a channel.</p>
18
23
  * <note>
19
24
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
@@ -32,6 +37,8 @@ export interface ListChannelMembershipsCommandOutput extends ListChannelMembersh
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param ListChannelMembershipsCommandInput - {@link ListChannelMembershipsCommandInput}
41
+ * @returns {@link ListChannelMembershipsCommandOutput}
35
42
  * @see {@link ListChannelMembershipsCommandInput} for command's `input` shape.
36
43
  * @see {@link ListChannelMembershipsCommandOutput} for command's `response` shape.
37
44
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -59,11 +66,20 @@ export interface ListChannelMembershipsCommandOutput extends ListChannelMembersh
59
66
  export declare class ListChannelMembershipsCommand extends $Command<ListChannelMembershipsCommandInput, ListChannelMembershipsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
60
67
  readonly input: ListChannelMembershipsCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: ListChannelMembershipsCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelMembershipsCommandInput, ListChannelMembershipsCommandOutput>;
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 { ListChannelMembershipsForAppInstanceUserRequest, ListChannelMembershipsForAppInstanceUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListChannelMembershipsForAppInstanceUserCommand}.
8
10
  */
9
11
  export interface ListChannelMembershipsForAppInstanceUserCommandInput extends ListChannelMembershipsForAppInstanceUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListChannelMembershipsForAppInstanceUserCommand}.
13
17
  */
14
18
  export interface ListChannelMembershipsForAppInstanceUserCommandOutput extends ListChannelMembershipsForAppInstanceUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Lists all channels that a particular <code>AppInstanceUser</code> is a part of. Only an
18
23
  * <code>AppInstanceAdmin</code> can call the API with a user ARN that is not their own. </p>
19
24
  * <note>
@@ -31,6 +36,8 @@ export interface ListChannelMembershipsForAppInstanceUserCommandOutput extends L
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param ListChannelMembershipsForAppInstanceUserCommandInput - {@link ListChannelMembershipsForAppInstanceUserCommandInput}
40
+ * @returns {@link ListChannelMembershipsForAppInstanceUserCommandOutput}
34
41
  * @see {@link ListChannelMembershipsForAppInstanceUserCommandInput} for command's `input` shape.
35
42
  * @see {@link ListChannelMembershipsForAppInstanceUserCommandOutput} for command's `response` shape.
36
43
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -58,11 +65,20 @@ export interface ListChannelMembershipsForAppInstanceUserCommandOutput extends L
58
65
  export declare class ListChannelMembershipsForAppInstanceUserCommand extends $Command<ListChannelMembershipsForAppInstanceUserCommandInput, ListChannelMembershipsForAppInstanceUserCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
59
66
  readonly input: ListChannelMembershipsForAppInstanceUserCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: ListChannelMembershipsForAppInstanceUserCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelMembershipsForAppInstanceUserCommandInput, ListChannelMembershipsForAppInstanceUserCommandOutput>;
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 { ListChannelMessagesRequest, ListChannelMessagesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListChannelMessagesCommand}.
8
10
  */
9
11
  export interface ListChannelMessagesCommandInput extends ListChannelMessagesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListChannelMessagesCommand}.
13
17
  */
14
18
  export interface ListChannelMessagesCommandOutput extends ListChannelMessagesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List all the messages in a channel. Returns a paginated list of
18
23
  * <code>ChannelMessages</code>. By default, sorted by creation timestamp in descending
19
24
  * order.</p>
@@ -35,6 +40,8 @@ export interface ListChannelMessagesCommandOutput extends ListChannelMessagesRes
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param ListChannelMessagesCommandInput - {@link ListChannelMessagesCommandInput}
44
+ * @returns {@link ListChannelMessagesCommandOutput}
38
45
  * @see {@link ListChannelMessagesCommandInput} for command's `input` shape.
39
46
  * @see {@link ListChannelMessagesCommandOutput} for command's `response` shape.
40
47
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -62,11 +69,20 @@ export interface ListChannelMessagesCommandOutput extends ListChannelMessagesRes
62
69
  export declare class ListChannelMessagesCommand extends $Command<ListChannelMessagesCommandInput, ListChannelMessagesCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
63
70
  readonly input: ListChannelMessagesCommandInput;
64
71
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
65
75
  constructor(input: ListChannelMessagesCommandInput);
66
76
  /**
67
77
  * @internal
68
78
  */
69
79
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelMessagesCommandInput, ListChannelMessagesCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
70
83
  private serialize;
84
+ /**
85
+ * @internal
86
+ */
71
87
  private deserialize;
72
88
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { ListChannelModeratorsRequest, ListChannelModeratorsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListChannelModeratorsCommand}.
8
10
  */
9
11
  export interface ListChannelModeratorsCommandInput extends ListChannelModeratorsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListChannelModeratorsCommand}.
13
17
  */
14
18
  export interface ListChannelModeratorsCommandOutput extends ListChannelModeratorsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all the moderators for 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 ListChannelModeratorsCommandOutput extends ListChannelModerator
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param ListChannelModeratorsCommandInput - {@link ListChannelModeratorsCommandInput}
39
+ * @returns {@link ListChannelModeratorsCommandOutput}
33
40
  * @see {@link ListChannelModeratorsCommandInput} for command's `input` shape.
34
41
  * @see {@link ListChannelModeratorsCommandOutput} for command's `response` shape.
35
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -57,11 +64,20 @@ export interface ListChannelModeratorsCommandOutput extends ListChannelModerator
57
64
  export declare class ListChannelModeratorsCommand extends $Command<ListChannelModeratorsCommandInput, ListChannelModeratorsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
58
65
  readonly input: ListChannelModeratorsCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: ListChannelModeratorsCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelModeratorsCommandInput, ListChannelModeratorsCommandOutput>;
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 { ListChannelsAssociatedWithChannelFlowRequest, ListChannelsAssociatedWithChannelFlowResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListChannelsAssociatedWithChannelFlowCommand}.
8
10
  */
9
11
  export interface ListChannelsAssociatedWithChannelFlowCommandInput extends ListChannelsAssociatedWithChannelFlowRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListChannelsAssociatedWithChannelFlowCommand}.
13
17
  */
14
18
  export interface ListChannelsAssociatedWithChannelFlowCommandOutput extends ListChannelsAssociatedWithChannelFlowResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. 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 ListChannelsAssociatedWithChannelFlowCommandOutput extends List
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListChannelsAssociatedWithChannelFlowCommandInput - {@link ListChannelsAssociatedWithChannelFlowCommandInput}
34
+ * @returns {@link ListChannelsAssociatedWithChannelFlowCommandOutput}
28
35
  * @see {@link ListChannelsAssociatedWithChannelFlowCommandInput} for command's `input` shape.
29
36
  * @see {@link ListChannelsAssociatedWithChannelFlowCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ListChannelsAssociatedWithChannelFlowCommandOutput extends List
52
59
  export declare class ListChannelsAssociatedWithChannelFlowCommand extends $Command<ListChannelsAssociatedWithChannelFlowCommandInput, ListChannelsAssociatedWithChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
53
60
  readonly input: ListChannelsAssociatedWithChannelFlowCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: ListChannelsAssociatedWithChannelFlowCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelsAssociatedWithChannelFlowCommandInput, ListChannelsAssociatedWithChannelFlowCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { ListChannelsRequest, ListChannelsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListChannelsCommand}.
8
10
  */
9
11
  export interface ListChannelsCommandInput extends ListChannelsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListChannelsCommand}.
13
17
  */
14
18
  export interface ListChannelsCommandOutput extends ListChannelsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all Channels created under a single Chime App as a paginated list. You can specify
18
23
  * filters to narrow results.</p>
19
24
  * <p class="title">
@@ -44,6 +49,8 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
44
49
  * const response = await client.send(command);
45
50
  * ```
46
51
  *
52
+ * @param ListChannelsCommandInput - {@link ListChannelsCommandInput}
53
+ * @returns {@link ListChannelsCommandOutput}
47
54
  * @see {@link ListChannelsCommandInput} for command's `input` shape.
48
55
  * @see {@link ListChannelsCommandOutput} for command's `response` shape.
49
56
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -71,11 +78,20 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
71
78
  export declare class ListChannelsCommand extends $Command<ListChannelsCommandInput, ListChannelsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
72
79
  readonly input: ListChannelsCommandInput;
73
80
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
81
+ /**
82
+ * @public
83
+ */
74
84
  constructor(input: ListChannelsCommandInput);
75
85
  /**
76
86
  * @internal
77
87
  */
78
88
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelsCommandInput, ListChannelsCommandOutput>;
89
+ /**
90
+ * @internal
91
+ */
79
92
  private serialize;
93
+ /**
94
+ * @internal
95
+ */
80
96
  private deserialize;
81
97
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { ListChannelsModeratedByAppInstanceUserRequest, ListChannelsModeratedByAppInstanceUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListChannelsModeratedByAppInstanceUserCommand}.
8
10
  */
9
11
  export interface ListChannelsModeratedByAppInstanceUserCommandInput extends ListChannelsModeratedByAppInstanceUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListChannelsModeratedByAppInstanceUserCommand}.
13
17
  */
14
18
  export interface ListChannelsModeratedByAppInstanceUserCommandOutput extends ListChannelsModeratedByAppInstanceUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>A list of the channels moderated by an <code>AppInstanceUser</code>.</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 ListChannelsModeratedByAppInstanceUserCommandOutput extends Lis
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param ListChannelsModeratedByAppInstanceUserCommandInput - {@link ListChannelsModeratedByAppInstanceUserCommandInput}
39
+ * @returns {@link ListChannelsModeratedByAppInstanceUserCommandOutput}
33
40
  * @see {@link ListChannelsModeratedByAppInstanceUserCommandInput} for command's `input` shape.
34
41
  * @see {@link ListChannelsModeratedByAppInstanceUserCommandOutput} for command's `response` shape.
35
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -57,11 +64,20 @@ export interface ListChannelsModeratedByAppInstanceUserCommandOutput extends Lis
57
64
  export declare class ListChannelsModeratedByAppInstanceUserCommand extends $Command<ListChannelsModeratedByAppInstanceUserCommandInput, ListChannelsModeratedByAppInstanceUserCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
58
65
  readonly input: ListChannelsModeratedByAppInstanceUserCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: ListChannelsModeratedByAppInstanceUserCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelsModeratedByAppInstanceUserCommandInput, ListChannelsModeratedByAppInstanceUserCommandOutput>;
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 { ListSubChannelsRequest, ListSubChannelsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListSubChannelsCommand}.
8
10
  */
9
11
  export interface ListSubChannelsCommandInput extends ListSubChannelsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListSubChannelsCommand}.
13
17
  */
14
18
  export interface ListSubChannelsCommandOutput extends ListSubChannelsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.</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 ListSubChannelsCommandOutput extends ListSubChannelsResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListSubChannelsCommandInput - {@link ListSubChannelsCommandInput}
34
+ * @returns {@link ListSubChannelsCommandOutput}
28
35
  * @see {@link ListSubChannelsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListSubChannelsCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ListSubChannelsCommandOutput extends ListSubChannelsResponse, _
52
59
  export declare class ListSubChannelsCommand extends $Command<ListSubChannelsCommandInput, ListSubChannelsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
53
60
  readonly input: ListSubChannelsCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: ListSubChannelsCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSubChannelsCommandInput, ListSubChannelsCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the tags applied to an 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 ListTagsForResourceCommandOutput extends ListTagsForResourceRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
52
59
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
53
60
  readonly input: ListTagsForResourceCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: ListTagsForResourceCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }