@aws-sdk/client-chime-sdk-messaging 3.295.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 (96) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/ChimeSDKMessaging.js +45 -0
  3. package/dist-cjs/commands/DeleteMessagingStreamingConfigurationsCommand.js +46 -0
  4. package/dist-cjs/commands/GetMessagingStreamingConfigurationsCommand.js +46 -0
  5. package/dist-cjs/commands/PutMessagingStreamingConfigurationsCommand.js +46 -0
  6. package/dist-cjs/commands/index.js +3 -0
  7. package/dist-cjs/endpoint/ruleset.js +3 -3
  8. package/dist-cjs/models/models_0.js +32 -3
  9. package/dist-cjs/protocols/Aws_restJson1.js +243 -2
  10. package/dist-es/ChimeSDKMessaging.js +45 -0
  11. package/dist-es/commands/DeleteMessagingStreamingConfigurationsCommand.js +42 -0
  12. package/dist-es/commands/GetMessagingStreamingConfigurationsCommand.js +42 -0
  13. package/dist-es/commands/PutMessagingStreamingConfigurationsCommand.js +42 -0
  14. package/dist-es/commands/index.js +3 -0
  15. package/dist-es/endpoint/ruleset.js +3 -3
  16. package/dist-es/models/models_0.js +23 -0
  17. package/dist-es/protocols/Aws_restJson1.js +235 -0
  18. package/dist-types/ChimeSDKMessaging.d.ts +76 -40
  19. package/dist-types/ChimeSDKMessagingClient.d.ts +29 -6
  20. package/dist-types/commands/AssociateChannelFlowCommand.d.ts +16 -1
  21. package/dist-types/commands/BatchCreateChannelMembershipCommand.d.ts +16 -0
  22. package/dist-types/commands/ChannelFlowCallbackCommand.d.ts +16 -0
  23. package/dist-types/commands/CreateChannelBanCommand.d.ts +16 -1
  24. package/dist-types/commands/CreateChannelCommand.d.ts +16 -2
  25. package/dist-types/commands/CreateChannelFlowCommand.d.ts +17 -3
  26. package/dist-types/commands/CreateChannelMembershipCommand.d.ts +16 -4
  27. package/dist-types/commands/CreateChannelModeratorCommand.d.ts +16 -2
  28. package/dist-types/commands/DeleteChannelBanCommand.d.ts +16 -1
  29. package/dist-types/commands/DeleteChannelCommand.d.ts +16 -1
  30. package/dist-types/commands/DeleteChannelFlowCommand.d.ts +16 -0
  31. package/dist-types/commands/DeleteChannelMembershipCommand.d.ts +16 -1
  32. package/dist-types/commands/DeleteChannelMessageCommand.d.ts +16 -1
  33. package/dist-types/commands/DeleteChannelModeratorCommand.d.ts +16 -1
  34. package/dist-types/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +76 -0
  35. package/dist-types/commands/DescribeChannelBanCommand.d.ts +16 -2
  36. package/dist-types/commands/DescribeChannelCommand.d.ts +16 -2
  37. package/dist-types/commands/DescribeChannelFlowCommand.d.ts +16 -0
  38. package/dist-types/commands/DescribeChannelMembershipCommand.d.ts +16 -0
  39. package/dist-types/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts +16 -1
  40. package/dist-types/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts +16 -1
  41. package/dist-types/commands/DescribeChannelModeratorCommand.d.ts +16 -0
  42. package/dist-types/commands/DisassociateChannelFlowCommand.d.ts +16 -0
  43. package/dist-types/commands/GetChannelMembershipPreferencesCommand.d.ts +16 -0
  44. package/dist-types/commands/GetChannelMessageCommand.d.ts +16 -1
  45. package/dist-types/commands/GetChannelMessageStatusCommand.d.ts +16 -3
  46. package/dist-types/commands/GetMessagingSessionEndpointCommand.d.ts +16 -0
  47. package/dist-types/commands/GetMessagingStreamingConfigurationsCommand.d.ts +82 -0
  48. package/dist-types/commands/ListChannelBansCommand.d.ts +16 -1
  49. package/dist-types/commands/ListChannelFlowsCommand.d.ts +16 -0
  50. package/dist-types/commands/ListChannelMembershipsCommand.d.ts +16 -2
  51. package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +16 -1
  52. package/dist-types/commands/ListChannelMessagesCommand.d.ts +16 -0
  53. package/dist-types/commands/ListChannelModeratorsCommand.d.ts +16 -0
  54. package/dist-types/commands/ListChannelsAssociatedWithChannelFlowCommand.d.ts +16 -0
  55. package/dist-types/commands/ListChannelsCommand.d.ts +16 -2
  56. package/dist-types/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts +16 -1
  57. package/dist-types/commands/ListSubChannelsCommand.d.ts +16 -0
  58. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  59. package/dist-types/commands/PutChannelMembershipPreferencesCommand.d.ts +16 -0
  60. package/dist-types/commands/PutMessagingStreamingConfigurationsCommand.d.ts +86 -0
  61. package/dist-types/commands/RedactChannelMessageCommand.d.ts +16 -1
  62. package/dist-types/commands/SearchChannelsCommand.d.ts +16 -0
  63. package/dist-types/commands/SendChannelMessageCommand.d.ts +16 -2
  64. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  65. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  66. package/dist-types/commands/UpdateChannelCommand.d.ts +16 -0
  67. package/dist-types/commands/UpdateChannelFlowCommand.d.ts +16 -0
  68. package/dist-types/commands/UpdateChannelMessageCommand.d.ts +16 -1
  69. package/dist-types/commands/UpdateChannelReadMarkerCommand.d.ts +16 -1
  70. package/dist-types/commands/index.d.ts +3 -0
  71. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  72. package/dist-types/models/ChimeSDKMessagingServiceException.d.ts +2 -0
  73. package/dist-types/models/models_0.d.ts +430 -0
  74. package/dist-types/pagination/Interfaces.d.ts +3 -0
  75. package/dist-types/pagination/ListChannelBansPaginator.d.ts +3 -0
  76. package/dist-types/pagination/ListChannelFlowsPaginator.d.ts +3 -0
  77. package/dist-types/pagination/ListChannelMembershipsForAppInstanceUserPaginator.d.ts +3 -0
  78. package/dist-types/pagination/ListChannelMembershipsPaginator.d.ts +3 -0
  79. package/dist-types/pagination/ListChannelMessagesPaginator.d.ts +3 -0
  80. package/dist-types/pagination/ListChannelModeratorsPaginator.d.ts +3 -0
  81. package/dist-types/pagination/ListChannelsAssociatedWithChannelFlowPaginator.d.ts +3 -0
  82. package/dist-types/pagination/ListChannelsModeratedByAppInstanceUserPaginator.d.ts +3 -0
  83. package/dist-types/pagination/ListChannelsPaginator.d.ts +3 -0
  84. package/dist-types/pagination/ListSubChannelsPaginator.d.ts +3 -0
  85. package/dist-types/pagination/SearchChannelsPaginator.d.ts +3 -0
  86. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  87. package/dist-types/ts3.4/ChimeSDKMessaging.d.ts +69 -0
  88. package/dist-types/ts3.4/ChimeSDKMessagingClient.d.ts +18 -0
  89. package/dist-types/ts3.4/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +37 -0
  90. package/dist-types/ts3.4/commands/GetMessagingStreamingConfigurationsCommand.d.ts +41 -0
  91. package/dist-types/ts3.4/commands/PutMessagingStreamingConfigurationsCommand.d.ts +41 -0
  92. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  93. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  94. package/dist-types/ts3.4/models/models_0.d.ts +42 -0
  95. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  96. package/package.json +29 -29
@@ -4,19 +4,23 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DescribeChannelModeratedByAppInstanceUserRequest, DescribeChannelModeratedByAppInstanceUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeChannelModeratedByAppInstanceUserCommand}.
8
10
  */
9
11
  export interface DescribeChannelModeratedByAppInstanceUserCommandInput extends DescribeChannelModeratedByAppInstanceUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeChannelModeratedByAppInstanceUserCommand}.
13
17
  */
14
18
  export interface DescribeChannelModeratedByAppInstanceUserCommandOutput extends DescribeChannelModeratedByAppInstanceUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the full details of a channel moderated by the specified
18
23
  * <code>AppInstanceUser</code>.</p>
19
- *
20
24
  * <note>
21
25
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
22
26
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -32,6 +36,8 @@ export interface DescribeChannelModeratedByAppInstanceUserCommandOutput extends
32
36
  * const response = await client.send(command);
33
37
  * ```
34
38
  *
39
+ * @param DescribeChannelModeratedByAppInstanceUserCommandInput - {@link DescribeChannelModeratedByAppInstanceUserCommandInput}
40
+ * @returns {@link DescribeChannelModeratedByAppInstanceUserCommandOutput}
35
41
  * @see {@link DescribeChannelModeratedByAppInstanceUserCommandInput} for command's `input` shape.
36
42
  * @see {@link DescribeChannelModeratedByAppInstanceUserCommandOutput} for command's `response` shape.
37
43
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -59,11 +65,20 @@ export interface DescribeChannelModeratedByAppInstanceUserCommandOutput extends
59
65
  export declare class DescribeChannelModeratedByAppInstanceUserCommand extends $Command<DescribeChannelModeratedByAppInstanceUserCommandInput, DescribeChannelModeratedByAppInstanceUserCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
60
66
  readonly input: DescribeChannelModeratedByAppInstanceUserCommandInput;
61
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
62
71
  constructor(input: DescribeChannelModeratedByAppInstanceUserCommandInput);
63
72
  /**
64
73
  * @internal
65
74
  */
66
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeChannelModeratedByAppInstanceUserCommandInput, DescribeChannelModeratedByAppInstanceUserCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
67
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
68
83
  private deserialize;
69
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DescribeChannelModeratorRequest, DescribeChannelModeratorResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeChannelModeratorCommand}.
8
10
  */
9
11
  export interface DescribeChannelModeratorCommandInput extends DescribeChannelModeratorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeChannelModeratorCommand}.
13
17
  */
14
18
  export interface DescribeChannelModeratorCommandOutput extends DescribeChannelModeratorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the full details of a single ChannelModerator.</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 DescribeChannelModeratorCommandOutput extends DescribeChannelMo
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DescribeChannelModeratorCommandInput - {@link DescribeChannelModeratorCommandInput}
39
+ * @returns {@link DescribeChannelModeratorCommandOutput}
33
40
  * @see {@link DescribeChannelModeratorCommandInput} for command's `input` shape.
34
41
  * @see {@link DescribeChannelModeratorCommandOutput} for command's `response` shape.
35
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DescribeChannelModeratorCommandOutput extends DescribeChannelMo
60
67
  export declare class DescribeChannelModeratorCommand extends $Command<DescribeChannelModeratorCommandInput, DescribeChannelModeratorCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
61
68
  readonly input: DescribeChannelModeratorCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DescribeChannelModeratorCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeChannelModeratorCommandInput, DescribeChannelModeratorCommandOutput>;
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 { DisassociateChannelFlowRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisassociateChannelFlowCommand}.
8
10
  */
9
11
  export interface DisassociateChannelFlowCommandInput extends DisassociateChannelFlowRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisassociateChannelFlowCommand}.
13
17
  */
14
18
  export interface DisassociateChannelFlowCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disassociates a channel flow from all its channels. Once disassociated, all messages to
18
23
  * that channel stop going through the channel flow processor.</p>
19
24
  * <note>
@@ -30,6 +35,8 @@ export interface DisassociateChannelFlowCommandOutput extends __MetadataBearer {
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DisassociateChannelFlowCommandInput - {@link DisassociateChannelFlowCommandInput}
39
+ * @returns {@link DisassociateChannelFlowCommandOutput}
33
40
  * @see {@link DisassociateChannelFlowCommandInput} for command's `input` shape.
34
41
  * @see {@link DisassociateChannelFlowCommandOutput} for command's `response` shape.
35
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -64,11 +71,20 @@ export interface DisassociateChannelFlowCommandOutput extends __MetadataBearer {
64
71
  export declare class DisassociateChannelFlowCommand extends $Command<DisassociateChannelFlowCommandInput, DisassociateChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
65
72
  readonly input: DisassociateChannelFlowCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: DisassociateChannelFlowCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateChannelFlowCommandInput, DisassociateChannelFlowCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { GetChannelMembershipPreferencesRequest, GetChannelMembershipPreferencesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetChannelMembershipPreferencesCommand}.
8
10
  */
9
11
  export interface GetChannelMembershipPreferencesCommandInput extends GetChannelMembershipPreferencesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetChannelMembershipPreferencesCommand}.
13
17
  */
14
18
  export interface GetChannelMembershipPreferencesCommandOutput extends GetChannelMembershipPreferencesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the membership preferences of an <code>AppInstanceUser</code> for the specified channel. The <code>AppInstanceUser</code> must be a member of the channel.
18
23
  * Only the <code>AppInstanceUser</code> who owns the membership can retrieve preferences. Users in the <code>AppInstanceAdmin</code> and channel moderator roles can't retrieve preferences for other users.
19
24
  * Banned users can't retrieve membership preferences for the channel from which they are banned.</p>
@@ -27,6 +32,8 @@ export interface GetChannelMembershipPreferencesCommandOutput extends GetChannel
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetChannelMembershipPreferencesCommandInput - {@link GetChannelMembershipPreferencesCommandInput}
36
+ * @returns {@link GetChannelMembershipPreferencesCommandOutput}
30
37
  * @see {@link GetChannelMembershipPreferencesCommandInput} for command's `input` shape.
31
38
  * @see {@link GetChannelMembershipPreferencesCommandOutput} for command's `response` shape.
32
39
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -54,11 +61,20 @@ export interface GetChannelMembershipPreferencesCommandOutput extends GetChannel
54
61
  export declare class GetChannelMembershipPreferencesCommand extends $Command<GetChannelMembershipPreferencesCommandInput, GetChannelMembershipPreferencesCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
55
62
  readonly input: GetChannelMembershipPreferencesCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: GetChannelMembershipPreferencesCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetChannelMembershipPreferencesCommandInput, GetChannelMembershipPreferencesCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,18 +4,22 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { GetChannelMessageRequest, GetChannelMessageResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetChannelMessageCommand}.
8
10
  */
9
11
  export interface GetChannelMessageCommandInput extends GetChannelMessageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetChannelMessageCommand}.
13
17
  */
14
18
  export interface GetChannelMessageCommandOutput extends GetChannelMessageResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the full details of a channel message.</p>
18
- *
19
23
  * <note>
20
24
  * <p>The x-amz-chime-bearer request header is mandatory. Use the
21
25
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -31,6 +35,8 @@ export interface GetChannelMessageCommandOutput extends GetChannelMessageRespons
31
35
  * const response = await client.send(command);
32
36
  * ```
33
37
  *
38
+ * @param GetChannelMessageCommandInput - {@link GetChannelMessageCommandInput}
39
+ * @returns {@link GetChannelMessageCommandOutput}
34
40
  * @see {@link GetChannelMessageCommandInput} for command's `input` shape.
35
41
  * @see {@link GetChannelMessageCommandOutput} for command's `response` shape.
36
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -61,11 +67,20 @@ export interface GetChannelMessageCommandOutput extends GetChannelMessageRespons
61
67
  export declare class GetChannelMessageCommand extends $Command<GetChannelMessageCommandInput, GetChannelMessageCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
62
68
  readonly input: GetChannelMessageCommandInput;
63
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
64
73
  constructor(input: GetChannelMessageCommandInput);
65
74
  /**
66
75
  * @internal
67
76
  */
68
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetChannelMessageCommandInput, GetChannelMessageCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
69
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
70
85
  private deserialize;
71
86
  }
@@ -4,21 +4,24 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { GetChannelMessageStatusRequest, GetChannelMessageStatusResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetChannelMessageStatusCommand}.
8
10
  */
9
11
  export interface GetChannelMessageStatusCommandInput extends GetChannelMessageStatusRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetChannelMessageStatusCommand}.
13
17
  */
14
18
  export interface GetChannelMessageStatusCommandOutput extends GetChannelMessageStatusResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets message status for a specified <code>messageId</code>. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to
18
23
  * retrieving message status if the event was not received because a client wasn't connected to a websocket. </p>
19
- *
20
24
  * <p>Messages can have any one of these statuses.</p>
21
- *
22
25
  * <dl>
23
26
  * <dt>SENT</dt>
24
27
  * <dd>
@@ -37,7 +40,6 @@ export interface GetChannelMessageStatusCommandOutput extends GetChannelMessageS
37
40
  * <p>Messasge denied by the processor</p>
38
41
  * </dd>
39
42
  * </dl>
40
- *
41
43
  * <note>
42
44
  * <ul>
43
45
  * <li>
@@ -61,6 +63,8 @@ export interface GetChannelMessageStatusCommandOutput extends GetChannelMessageS
61
63
  * const response = await client.send(command);
62
64
  * ```
63
65
  *
66
+ * @param GetChannelMessageStatusCommandInput - {@link GetChannelMessageStatusCommandInput}
67
+ * @returns {@link GetChannelMessageStatusCommandOutput}
64
68
  * @see {@link GetChannelMessageStatusCommandInput} for command's `input` shape.
65
69
  * @see {@link GetChannelMessageStatusCommandOutput} for command's `response` shape.
66
70
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -88,11 +92,20 @@ export interface GetChannelMessageStatusCommandOutput extends GetChannelMessageS
88
92
  export declare class GetChannelMessageStatusCommand extends $Command<GetChannelMessageStatusCommandInput, GetChannelMessageStatusCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
89
93
  readonly input: GetChannelMessageStatusCommandInput;
90
94
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
95
+ /**
96
+ * @public
97
+ */
91
98
  constructor(input: GetChannelMessageStatusCommandInput);
92
99
  /**
93
100
  * @internal
94
101
  */
95
102
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetChannelMessageStatusCommandInput, GetChannelMessageStatusCommandOutput>;
103
+ /**
104
+ * @internal
105
+ */
96
106
  private serialize;
107
+ /**
108
+ * @internal
109
+ */
97
110
  private deserialize;
98
111
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { GetMessagingSessionEndpointRequest, GetMessagingSessionEndpointResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetMessagingSessionEndpointCommand}.
8
10
  */
9
11
  export interface GetMessagingSessionEndpointCommandInput extends GetMessagingSessionEndpointRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetMessagingSessionEndpointCommand}.
13
17
  */
14
18
  export interface GetMessagingSessionEndpointCommandOutput extends GetMessagingSessionEndpointResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>The details of the endpoint for the messaging session.</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 GetMessagingSessionEndpointCommandOutput extends GetMessagingSe
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetMessagingSessionEndpointCommandInput - {@link GetMessagingSessionEndpointCommandInput}
34
+ * @returns {@link GetMessagingSessionEndpointCommandOutput}
28
35
  * @see {@link GetMessagingSessionEndpointCommandInput} for command's `input` shape.
29
36
  * @see {@link GetMessagingSessionEndpointCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetMessagingSessionEndpointCommandOutput extends GetMessagingSe
49
56
  export declare class GetMessagingSessionEndpointCommand extends $Command<GetMessagingSessionEndpointCommandInput, GetMessagingSessionEndpointCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
50
57
  readonly input: GetMessagingSessionEndpointCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetMessagingSessionEndpointCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetMessagingSessionEndpointCommandInput, GetMessagingSessionEndpointCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -0,0 +1,82 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
+ import { GetMessagingStreamingConfigurationsRequest, GetMessagingStreamingConfigurationsResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link GetMessagingStreamingConfigurationsCommand}.
10
+ */
11
+ export interface GetMessagingStreamingConfigurationsCommandInput extends GetMessagingStreamingConfigurationsRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link GetMessagingStreamingConfigurationsCommand}.
17
+ */
18
+ export interface GetMessagingStreamingConfigurationsCommandOutput extends GetMessagingStreamingConfigurationsResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Retrieves the data streaming configuration for an <code>AppInstance</code>. For more information, see
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>
24
+ * @example
25
+ * Use a bare-bones client and the command you need to make an API call.
26
+ * ```javascript
27
+ * import { ChimeSDKMessagingClient, GetMessagingStreamingConfigurationsCommand } from "@aws-sdk/client-chime-sdk-messaging"; // ES Modules import
28
+ * // const { ChimeSDKMessagingClient, GetMessagingStreamingConfigurationsCommand } = require("@aws-sdk/client-chime-sdk-messaging"); // CommonJS import
29
+ * const client = new ChimeSDKMessagingClient(config);
30
+ * const command = new GetMessagingStreamingConfigurationsCommand(input);
31
+ * const response = await client.send(command);
32
+ * ```
33
+ *
34
+ * @param GetMessagingStreamingConfigurationsCommandInput - {@link GetMessagingStreamingConfigurationsCommandInput}
35
+ * @returns {@link GetMessagingStreamingConfigurationsCommandOutput}
36
+ * @see {@link GetMessagingStreamingConfigurationsCommandInput} for command's `input` shape.
37
+ * @see {@link GetMessagingStreamingConfigurationsCommandOutput} for command's `response` shape.
38
+ * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
39
+ *
40
+ * @throws {@link BadRequestException} (client fault)
41
+ * <p>The input parameters don't match the service's restrictions.</p>
42
+ *
43
+ * @throws {@link ForbiddenException} (client fault)
44
+ * <p>The client is permanently forbidden from making the request.</p>
45
+ *
46
+ * @throws {@link NotFoundException} (client fault)
47
+ * <p>One or more of the resources in the request does not exist in the system.</p>
48
+ *
49
+ * @throws {@link ServiceFailureException} (server fault)
50
+ * <p>The service encountered an unexpected error.</p>
51
+ *
52
+ * @throws {@link ServiceUnavailableException} (server fault)
53
+ * <p>The service is currently unavailable.</p>
54
+ *
55
+ * @throws {@link ThrottledClientException} (client fault)
56
+ * <p>The client exceeded its request rate limit.</p>
57
+ *
58
+ * @throws {@link UnauthorizedClientException} (client fault)
59
+ * <p>The client is not currently authorized to make the request.</p>
60
+ *
61
+ *
62
+ */
63
+ export declare class GetMessagingStreamingConfigurationsCommand extends $Command<GetMessagingStreamingConfigurationsCommandInput, GetMessagingStreamingConfigurationsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
64
+ readonly input: GetMessagingStreamingConfigurationsCommandInput;
65
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
69
+ constructor(input: GetMessagingStreamingConfigurationsCommandInput);
70
+ /**
71
+ * @internal
72
+ */
73
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetMessagingStreamingConfigurationsCommandInput, GetMessagingStreamingConfigurationsCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
77
+ private serialize;
78
+ /**
79
+ * @internal
80
+ */
81
+ private deserialize;
82
+ }
@@ -4,18 +4,22 @@ 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
- *
19
23
  * <note>
20
24
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
21
25
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -31,6 +35,8 @@ export interface ListChannelBansCommandOutput extends ListChannelBansResponse, _
31
35
  * const response = await client.send(command);
32
36
  * ```
33
37
  *
38
+ * @param ListChannelBansCommandInput - {@link ListChannelBansCommandInput}
39
+ * @returns {@link ListChannelBansCommandOutput}
34
40
  * @see {@link ListChannelBansCommandInput} for command's `input` shape.
35
41
  * @see {@link ListChannelBansCommandOutput} for command's `response` shape.
36
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -58,11 +64,20 @@ export interface ListChannelBansCommandOutput extends ListChannelBansResponse, _
58
64
  export declare class ListChannelBansCommand extends $Command<ListChannelBansCommandInput, ListChannelBansCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
59
65
  readonly input: ListChannelBansCommandInput;
60
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
61
70
  constructor(input: ListChannelBansCommandInput);
62
71
  /**
63
72
  * @internal
64
73
  */
65
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelBansCommandInput, ListChannelBansCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
66
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
67
82
  private deserialize;
68
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,24 +4,27 @@ 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
- *
19
23
  * <note>
20
24
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
21
25
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
22
26
  * the header.</p>
23
27
  * </note>
24
- *
25
28
  * <p>If you want to list the channels to which a specific app instance user belongs, see the
26
29
  * <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html">ListChannelMembershipsForAppInstanceUser</a> API.</p>
27
30
  * @example
@@ -34,6 +37,8 @@ export interface ListChannelMembershipsCommandOutput extends ListChannelMembersh
34
37
  * const response = await client.send(command);
35
38
  * ```
36
39
  *
40
+ * @param ListChannelMembershipsCommandInput - {@link ListChannelMembershipsCommandInput}
41
+ * @returns {@link ListChannelMembershipsCommandOutput}
37
42
  * @see {@link ListChannelMembershipsCommandInput} for command's `input` shape.
38
43
  * @see {@link ListChannelMembershipsCommandOutput} for command's `response` shape.
39
44
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -61,11 +66,20 @@ export interface ListChannelMembershipsCommandOutput extends ListChannelMembersh
61
66
  export declare class ListChannelMembershipsCommand extends $Command<ListChannelMembershipsCommandInput, ListChannelMembershipsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
62
67
  readonly input: ListChannelMembershipsCommandInput;
63
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
64
72
  constructor(input: ListChannelMembershipsCommandInput);
65
73
  /**
66
74
  * @internal
67
75
  */
68
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChannelMembershipsCommandInput, ListChannelMembershipsCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
69
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
70
84
  private deserialize;
71
85
  }