@aws-sdk/client-chime-sdk-messaging 3.325.0 → 3.326.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.
- package/dist-types/commands/AssociateChannelFlowCommand.d.ts +4 -0
- package/dist-types/commands/BatchCreateChannelMembershipCommand.d.ts +27 -0
- package/dist-types/commands/ChannelFlowCallbackCommand.d.ts +7 -0
- package/dist-types/commands/CreateChannelBanCommand.d.ts +10 -0
- package/dist-types/commands/CreateChannelCommand.d.ts +6 -0
- package/dist-types/commands/CreateChannelFlowCommand.d.ts +6 -0
- package/dist-types/commands/CreateChannelMembershipCommand.d.ts +11 -0
- package/dist-types/commands/CreateChannelModeratorCommand.d.ts +10 -0
- package/dist-types/commands/DeleteChannelBanCommand.d.ts +4 -0
- package/dist-types/commands/DeleteChannelCommand.d.ts +4 -0
- package/dist-types/commands/DeleteChannelFlowCommand.d.ts +4 -0
- package/dist-types/commands/DeleteChannelMembershipCommand.d.ts +4 -0
- package/dist-types/commands/DeleteChannelMessageCommand.d.ts +4 -0
- package/dist-types/commands/DeleteChannelModeratorCommand.d.ts +4 -0
- package/dist-types/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +4 -0
- package/dist-types/commands/DescribeChannelBanCommand.d.ts +17 -0
- package/dist-types/commands/DescribeChannelCommand.d.ts +29 -0
- package/dist-types/commands/DescribeChannelFlowCommand.d.ts +24 -0
- package/dist-types/commands/DescribeChannelMembershipCommand.d.ts +20 -0
- package/dist-types/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts +20 -0
- package/dist-types/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts +15 -0
- package/dist-types/commands/DescribeChannelModeratorCommand.d.ts +17 -0
- package/dist-types/commands/DisassociateChannelFlowCommand.d.ts +4 -0
- package/dist-types/commands/GetChannelMembershipPreferencesCommand.d.ts +16 -0
- package/dist-types/commands/GetChannelMessageCommand.d.ts +34 -0
- package/dist-types/commands/GetChannelMessageStatusCommand.d.ts +9 -0
- package/dist-types/commands/GetMessagingSessionEndpointCommand.d.ts +8 -0
- package/dist-types/commands/GetMessagingStreamingConfigurationsCommand.d.ts +11 -0
- package/dist-types/commands/ListChannelBansCommand.d.ts +15 -0
- package/dist-types/commands/ListChannelFlowsCommand.d.ts +25 -0
- package/dist-types/commands/ListChannelMembershipsCommand.d.ts +15 -0
- package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +23 -0
- package/dist-types/commands/ListChannelMessagesCommand.d.ts +36 -0
- package/dist-types/commands/ListChannelModeratorsCommand.d.ts +15 -0
- package/dist-types/commands/ListChannelsAssociatedWithChannelFlowCommand.d.ts +15 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts +18 -0
- package/dist-types/commands/ListSubChannelsCommand.d.ts +13 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
- package/dist-types/commands/PutChannelExpirationSettingsCommand.d.ts +10 -0
- package/dist-types/commands/PutChannelMembershipPreferencesCommand.d.ts +16 -0
- package/dist-types/commands/PutMessagingStreamingConfigurationsCommand.d.ts +11 -0
- package/dist-types/commands/RedactChannelMessageCommand.d.ts +8 -0
- package/dist-types/commands/SearchChannelsCommand.d.ts +16 -0
- package/dist-types/commands/SendChannelMessageCommand.d.ts +12 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateChannelCommand.d.ts +6 -0
- package/dist-types/commands/UpdateChannelFlowCommand.d.ts +6 -0
- package/dist-types/commands/UpdateChannelMessageCommand.d.ts +12 -0
- package/dist-types/commands/UpdateChannelReadMarkerCommand.d.ts +6 -0
- package/package.json +3 -3
|
@@ -40,6 +40,8 @@ export interface AssociateChannelFlowCommandOutput extends __MetadataBearer {
|
|
|
40
40
|
* };
|
|
41
41
|
* const command = new AssociateChannelFlowCommand(input);
|
|
42
42
|
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
43
45
|
* ```
|
|
44
46
|
*
|
|
45
47
|
* @param AssociateChannelFlowCommandInput - {@link AssociateChannelFlowCommandInput}
|
|
@@ -73,6 +75,8 @@ export interface AssociateChannelFlowCommandOutput extends __MetadataBearer {
|
|
|
73
75
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
74
76
|
* <p>The client is not currently authorized to make the request.</p>
|
|
75
77
|
*
|
|
78
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
76
80
|
*
|
|
77
81
|
*/
|
|
78
82
|
export declare class AssociateChannelFlowCommand extends $Command<AssociateChannelFlowCommandInput, AssociateChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -37,6 +37,31 @@ export interface BatchCreateChannelMembershipCommandOutput extends BatchCreateCh
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new BatchCreateChannelMembershipCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // { // BatchCreateChannelMembershipResponse
|
|
41
|
+
* // BatchChannelMemberships: { // BatchChannelMemberships
|
|
42
|
+
* // InvitedBy: { // Identity
|
|
43
|
+
* // Arn: "STRING_VALUE",
|
|
44
|
+
* // Name: "STRING_VALUE",
|
|
45
|
+
* // },
|
|
46
|
+
* // Type: "DEFAULT" || "HIDDEN",
|
|
47
|
+
* // Members: [ // Members
|
|
48
|
+
* // {
|
|
49
|
+
* // Arn: "STRING_VALUE",
|
|
50
|
+
* // Name: "STRING_VALUE",
|
|
51
|
+
* // },
|
|
52
|
+
* // ],
|
|
53
|
+
* // ChannelArn: "STRING_VALUE",
|
|
54
|
+
* // SubChannelId: "STRING_VALUE",
|
|
55
|
+
* // },
|
|
56
|
+
* // Errors: [ // BatchCreateChannelMembershipErrors
|
|
57
|
+
* // { // BatchCreateChannelMembershipError
|
|
58
|
+
* // MemberArn: "STRING_VALUE",
|
|
59
|
+
* // ErrorCode: "BadRequest" || "Conflict" || "Forbidden" || "NotFound" || "PreconditionFailed" || "ResourceLimitExceeded" || "ServiceFailure" || "AccessDenied" || "ServiceUnavailable" || "Throttled" || "Throttling" || "Unauthorized" || "Unprocessable" || "VoiceConnectorGroupAssociationsExist" || "PhoneNumberAssociationsExist",
|
|
60
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // };
|
|
64
|
+
*
|
|
40
65
|
* ```
|
|
41
66
|
*
|
|
42
67
|
* @param BatchCreateChannelMembershipCommandInput - {@link BatchCreateChannelMembershipCommandInput}
|
|
@@ -69,6 +94,8 @@ export interface BatchCreateChannelMembershipCommandOutput extends BatchCreateCh
|
|
|
69
94
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
70
95
|
* <p>The client is not currently authorized to make the request.</p>
|
|
71
96
|
*
|
|
97
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
98
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
72
99
|
*
|
|
73
100
|
*/
|
|
74
101
|
export declare class BatchCreateChannelMembershipCommand extends $Command<BatchCreateChannelMembershipCommandInput, BatchCreateChannelMembershipCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -64,6 +64,11 @@ export interface ChannelFlowCallbackCommandOutput extends ChannelFlowCallbackRes
|
|
|
64
64
|
* };
|
|
65
65
|
* const command = new ChannelFlowCallbackCommand(input);
|
|
66
66
|
* const response = await client.send(command);
|
|
67
|
+
* // { // ChannelFlowCallbackResponse
|
|
68
|
+
* // ChannelArn: "STRING_VALUE",
|
|
69
|
+
* // CallbackId: "STRING_VALUE",
|
|
70
|
+
* // };
|
|
71
|
+
*
|
|
67
72
|
* ```
|
|
68
73
|
*
|
|
69
74
|
* @param ChannelFlowCallbackCommandInput - {@link ChannelFlowCallbackCommandInput}
|
|
@@ -94,6 +99,8 @@ export interface ChannelFlowCallbackCommandOutput extends ChannelFlowCallbackRes
|
|
|
94
99
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
95
100
|
* <p>The client is not currently authorized to make the request.</p>
|
|
96
101
|
*
|
|
102
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
103
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
97
104
|
*
|
|
98
105
|
*/
|
|
99
106
|
export declare class ChannelFlowCallbackCommand extends $Command<ChannelFlowCallbackCommandInput, ChannelFlowCallbackCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -43,6 +43,14 @@ export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse,
|
|
|
43
43
|
* };
|
|
44
44
|
* const command = new CreateChannelBanCommand(input);
|
|
45
45
|
* const response = await client.send(command);
|
|
46
|
+
* // { // CreateChannelBanResponse
|
|
47
|
+
* // ChannelArn: "STRING_VALUE",
|
|
48
|
+
* // Member: { // Identity
|
|
49
|
+
* // Arn: "STRING_VALUE",
|
|
50
|
+
* // Name: "STRING_VALUE",
|
|
51
|
+
* // },
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
46
54
|
* ```
|
|
47
55
|
*
|
|
48
56
|
* @param CreateChannelBanCommandInput - {@link CreateChannelBanCommandInput}
|
|
@@ -76,6 +84,8 @@ export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse,
|
|
|
76
84
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
77
85
|
* <p>The client is not currently authorized to make the request.</p>
|
|
78
86
|
*
|
|
87
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
79
89
|
*
|
|
80
90
|
*/
|
|
81
91
|
export declare class CreateChannelBanCommand extends $Command<CreateChannelBanCommandInput, CreateChannelBanCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -67,6 +67,10 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
|
|
|
67
67
|
* };
|
|
68
68
|
* const command = new CreateChannelCommand(input);
|
|
69
69
|
* const response = await client.send(command);
|
|
70
|
+
* // { // CreateChannelResponse
|
|
71
|
+
* // ChannelArn: "STRING_VALUE",
|
|
72
|
+
* // };
|
|
73
|
+
*
|
|
70
74
|
* ```
|
|
71
75
|
*
|
|
72
76
|
* @param CreateChannelCommandInput - {@link CreateChannelCommandInput}
|
|
@@ -100,6 +104,8 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
|
|
|
100
104
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
101
105
|
* <p>The client is not currently authorized to make the request.</p>
|
|
102
106
|
*
|
|
107
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
108
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
103
109
|
*
|
|
104
110
|
*/
|
|
105
111
|
export declare class CreateChannelCommand extends $Command<CreateChannelCommandInput, CreateChannelCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -71,6 +71,10 @@ export interface CreateChannelFlowCommandOutput extends CreateChannelFlowRespons
|
|
|
71
71
|
* };
|
|
72
72
|
* const command = new CreateChannelFlowCommand(input);
|
|
73
73
|
* const response = await client.send(command);
|
|
74
|
+
* // { // CreateChannelFlowResponse
|
|
75
|
+
* // ChannelFlowArn: "STRING_VALUE",
|
|
76
|
+
* // };
|
|
77
|
+
*
|
|
74
78
|
* ```
|
|
75
79
|
*
|
|
76
80
|
* @param CreateChannelFlowCommandInput - {@link CreateChannelFlowCommandInput}
|
|
@@ -104,6 +108,8 @@ export interface CreateChannelFlowCommandOutput extends CreateChannelFlowRespons
|
|
|
104
108
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
105
109
|
* <p>The client is not currently authorized to make the request.</p>
|
|
106
110
|
*
|
|
111
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
112
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
107
113
|
*
|
|
108
114
|
*/
|
|
109
115
|
export declare class CreateChannelFlowCommand extends $Command<CreateChannelFlowCommandInput, CreateChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -68,6 +68,15 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
|
|
|
68
68
|
* };
|
|
69
69
|
* const command = new CreateChannelMembershipCommand(input);
|
|
70
70
|
* const response = await client.send(command);
|
|
71
|
+
* // { // CreateChannelMembershipResponse
|
|
72
|
+
* // ChannelArn: "STRING_VALUE",
|
|
73
|
+
* // Member: { // Identity
|
|
74
|
+
* // Arn: "STRING_VALUE",
|
|
75
|
+
* // Name: "STRING_VALUE",
|
|
76
|
+
* // },
|
|
77
|
+
* // SubChannelId: "STRING_VALUE",
|
|
78
|
+
* // };
|
|
79
|
+
*
|
|
71
80
|
* ```
|
|
72
81
|
*
|
|
73
82
|
* @param CreateChannelMembershipCommandInput - {@link CreateChannelMembershipCommandInput}
|
|
@@ -104,6 +113,8 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
|
|
|
104
113
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
105
114
|
* <p>The client is not currently authorized to make the request.</p>
|
|
106
115
|
*
|
|
116
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
117
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
107
118
|
*
|
|
108
119
|
*/
|
|
109
120
|
export declare class CreateChannelMembershipCommand extends $Command<CreateChannelMembershipCommandInput, CreateChannelMembershipCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -55,6 +55,14 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera
|
|
|
55
55
|
* };
|
|
56
56
|
* const command = new CreateChannelModeratorCommand(input);
|
|
57
57
|
* const response = await client.send(command);
|
|
58
|
+
* // { // CreateChannelModeratorResponse
|
|
59
|
+
* // ChannelArn: "STRING_VALUE",
|
|
60
|
+
* // ChannelModerator: { // Identity
|
|
61
|
+
* // Arn: "STRING_VALUE",
|
|
62
|
+
* // Name: "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
58
66
|
* ```
|
|
59
67
|
*
|
|
60
68
|
* @param CreateChannelModeratorCommandInput - {@link CreateChannelModeratorCommandInput}
|
|
@@ -88,6 +96,8 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera
|
|
|
88
96
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
89
97
|
* <p>The client is not currently authorized to make the request.</p>
|
|
90
98
|
*
|
|
99
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
100
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
91
101
|
*
|
|
92
102
|
*/
|
|
93
103
|
export declare class CreateChannelModeratorCommand extends $Command<CreateChannelModeratorCommandInput, CreateChannelModeratorCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -38,6 +38,8 @@ export interface DeleteChannelBanCommandOutput extends __MetadataBearer {
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new DeleteChannelBanCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // {};
|
|
42
|
+
*
|
|
41
43
|
* ```
|
|
42
44
|
*
|
|
43
45
|
* @param DeleteChannelBanCommandInput - {@link DeleteChannelBanCommandInput}
|
|
@@ -64,6 +66,8 @@ export interface DeleteChannelBanCommandOutput extends __MetadataBearer {
|
|
|
64
66
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
65
67
|
* <p>The client is not currently authorized to make the request.</p>
|
|
66
68
|
*
|
|
69
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
67
71
|
*
|
|
68
72
|
*/
|
|
69
73
|
export declare class DeleteChannelBanCommand extends $Command<DeleteChannelBanCommandInput, DeleteChannelBanCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -38,6 +38,8 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new DeleteChannelCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // {};
|
|
42
|
+
*
|
|
41
43
|
* ```
|
|
42
44
|
*
|
|
43
45
|
* @param DeleteChannelCommandInput - {@link DeleteChannelCommandInput}
|
|
@@ -68,6 +70,8 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {
|
|
|
68
70
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
69
71
|
* <p>The client is not currently authorized to make the request.</p>
|
|
70
72
|
*
|
|
73
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
71
75
|
*
|
|
72
76
|
*/
|
|
73
77
|
export declare class DeleteChannelCommand extends $Command<DeleteChannelCommandInput, DeleteChannelCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -35,6 +35,8 @@ export interface DeleteChannelFlowCommandOutput extends __MetadataBearer {
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new DeleteChannelFlowCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // {};
|
|
39
|
+
*
|
|
38
40
|
* ```
|
|
39
41
|
*
|
|
40
42
|
* @param DeleteChannelFlowCommandInput - {@link DeleteChannelFlowCommandInput}
|
|
@@ -65,6 +67,8 @@ export interface DeleteChannelFlowCommandOutput extends __MetadataBearer {
|
|
|
65
67
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
66
68
|
* <p>The client is not currently authorized to make the request.</p>
|
|
67
69
|
*
|
|
70
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
68
72
|
*
|
|
69
73
|
*/
|
|
70
74
|
export declare class DeleteChannelFlowCommand extends $Command<DeleteChannelFlowCommandInput, DeleteChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -39,6 +39,8 @@ export interface DeleteChannelMembershipCommandOutput extends __MetadataBearer {
|
|
|
39
39
|
* };
|
|
40
40
|
* const command = new DeleteChannelMembershipCommand(input);
|
|
41
41
|
* const response = await client.send(command);
|
|
42
|
+
* // {};
|
|
43
|
+
*
|
|
42
44
|
* ```
|
|
43
45
|
*
|
|
44
46
|
* @param DeleteChannelMembershipCommandInput - {@link DeleteChannelMembershipCommandInput}
|
|
@@ -69,6 +71,8 @@ export interface DeleteChannelMembershipCommandOutput extends __MetadataBearer {
|
|
|
69
71
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
70
72
|
* <p>The client is not currently authorized to make the request.</p>
|
|
71
73
|
*
|
|
74
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
72
76
|
*
|
|
73
77
|
*/
|
|
74
78
|
export declare class DeleteChannelMembershipCommand extends $Command<DeleteChannelMembershipCommandInput, DeleteChannelMembershipCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -41,6 +41,8 @@ export interface DeleteChannelMessageCommandOutput extends __MetadataBearer {
|
|
|
41
41
|
* };
|
|
42
42
|
* const command = new DeleteChannelMessageCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
44
46
|
* ```
|
|
45
47
|
*
|
|
46
48
|
* @param DeleteChannelMessageCommandInput - {@link DeleteChannelMessageCommandInput}
|
|
@@ -67,6 +69,8 @@ export interface DeleteChannelMessageCommandOutput extends __MetadataBearer {
|
|
|
67
69
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
68
70
|
* <p>The client is not currently authorized to make the request.</p>
|
|
69
71
|
*
|
|
72
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
70
74
|
*
|
|
71
75
|
*/
|
|
72
76
|
export declare class DeleteChannelMessageCommand extends $Command<DeleteChannelMessageCommandInput, DeleteChannelMessageCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -38,6 +38,8 @@ export interface DeleteChannelModeratorCommandOutput extends __MetadataBearer {
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new DeleteChannelModeratorCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // {};
|
|
42
|
+
*
|
|
41
43
|
* ```
|
|
42
44
|
*
|
|
43
45
|
* @param DeleteChannelModeratorCommandInput - {@link DeleteChannelModeratorCommandInput}
|
|
@@ -64,6 +66,8 @@ export interface DeleteChannelModeratorCommandOutput extends __MetadataBearer {
|
|
|
64
66
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
65
67
|
* <p>The client is not currently authorized to make the request.</p>
|
|
66
68
|
*
|
|
69
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
67
71
|
*
|
|
68
72
|
*/
|
|
69
73
|
export declare class DeleteChannelModeratorCommand extends $Command<DeleteChannelModeratorCommandInput, DeleteChannelModeratorCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -32,6 +32,8 @@ export interface DeleteMessagingStreamingConfigurationsCommandOutput extends __M
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DeleteMessagingStreamingConfigurationsCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // {};
|
|
36
|
+
*
|
|
35
37
|
* ```
|
|
36
38
|
*
|
|
37
39
|
* @param DeleteMessagingStreamingConfigurationsCommandInput - {@link DeleteMessagingStreamingConfigurationsCommandInput}
|
|
@@ -58,6 +60,8 @@ export interface DeleteMessagingStreamingConfigurationsCommandOutput extends __M
|
|
|
58
60
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
59
61
|
* <p>The client is not currently authorized to make the request.</p>
|
|
60
62
|
*
|
|
63
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
64
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
61
65
|
*
|
|
62
66
|
*/
|
|
63
67
|
export declare class DeleteMessagingStreamingConfigurationsCommand extends $Command<DeleteMessagingStreamingConfigurationsCommandInput, DeleteMessagingStreamingConfigurationsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -38,6 +38,21 @@ export interface DescribeChannelBanCommandOutput extends DescribeChannelBanRespo
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new DescribeChannelBanCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // DescribeChannelBanResponse
|
|
42
|
+
* // ChannelBan: { // ChannelBan
|
|
43
|
+
* // Member: { // Identity
|
|
44
|
+
* // Arn: "STRING_VALUE",
|
|
45
|
+
* // Name: "STRING_VALUE",
|
|
46
|
+
* // },
|
|
47
|
+
* // ChannelArn: "STRING_VALUE",
|
|
48
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
49
|
+
* // CreatedBy: {
|
|
50
|
+
* // Arn: "STRING_VALUE",
|
|
51
|
+
* // Name: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // },
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
41
56
|
* ```
|
|
42
57
|
*
|
|
43
58
|
* @param DescribeChannelBanCommandInput - {@link DescribeChannelBanCommandInput}
|
|
@@ -67,6 +82,8 @@ export interface DescribeChannelBanCommandOutput extends DescribeChannelBanRespo
|
|
|
67
82
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
68
83
|
* <p>The client is not currently authorized to make the request.</p>
|
|
69
84
|
*
|
|
85
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
70
87
|
*
|
|
71
88
|
*/
|
|
72
89
|
export declare class DescribeChannelBanCommand extends $Command<DescribeChannelBanCommandInput, DescribeChannelBanCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -38,6 +38,33 @@ export interface DescribeChannelCommandOutput extends DescribeChannelResponse, _
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new DescribeChannelCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // DescribeChannelResponse
|
|
42
|
+
* // Channel: { // Channel
|
|
43
|
+
* // Name: "STRING_VALUE",
|
|
44
|
+
* // ChannelArn: "STRING_VALUE",
|
|
45
|
+
* // Mode: "UNRESTRICTED" || "RESTRICTED",
|
|
46
|
+
* // Privacy: "PUBLIC" || "PRIVATE",
|
|
47
|
+
* // Metadata: "STRING_VALUE",
|
|
48
|
+
* // CreatedBy: { // Identity
|
|
49
|
+
* // Arn: "STRING_VALUE",
|
|
50
|
+
* // Name: "STRING_VALUE",
|
|
51
|
+
* // },
|
|
52
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
53
|
+
* // LastMessageTimestamp: new Date("TIMESTAMP"),
|
|
54
|
+
* // LastUpdatedTimestamp: new Date("TIMESTAMP"),
|
|
55
|
+
* // ChannelFlowArn: "STRING_VALUE",
|
|
56
|
+
* // ElasticChannelConfiguration: { // ElasticChannelConfiguration
|
|
57
|
+
* // MaximumSubChannels: Number("int"), // required
|
|
58
|
+
* // TargetMembershipsPerSubChannel: Number("int"), // required
|
|
59
|
+
* // MinimumMembershipPercentage: Number("int"), // required
|
|
60
|
+
* // },
|
|
61
|
+
* // ExpirationSettings: { // ExpirationSettings
|
|
62
|
+
* // ExpirationDays: Number("int"), // required
|
|
63
|
+
* // ExpirationCriterion: "CREATED_TIMESTAMP" || "LAST_MESSAGE_TIMESTAMP", // required
|
|
64
|
+
* // },
|
|
65
|
+
* // },
|
|
66
|
+
* // };
|
|
67
|
+
*
|
|
41
68
|
* ```
|
|
42
69
|
*
|
|
43
70
|
* @param DescribeChannelCommandInput - {@link DescribeChannelCommandInput}
|
|
@@ -64,6 +91,8 @@ export interface DescribeChannelCommandOutput extends DescribeChannelResponse, _
|
|
|
64
91
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
65
92
|
* <p>The client is not currently authorized to make the request.</p>
|
|
66
93
|
*
|
|
94
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
67
96
|
*
|
|
68
97
|
*/
|
|
69
98
|
export declare class DescribeChannelCommand extends $Command<DescribeChannelCommandInput, DescribeChannelCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -31,6 +31,28 @@ export interface DescribeChannelFlowCommandOutput extends DescribeChannelFlowRes
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new DescribeChannelFlowCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // DescribeChannelFlowResponse
|
|
35
|
+
* // ChannelFlow: { // ChannelFlow
|
|
36
|
+
* // ChannelFlowArn: "STRING_VALUE",
|
|
37
|
+
* // Processors: [ // ProcessorList
|
|
38
|
+
* // { // Processor
|
|
39
|
+
* // Name: "STRING_VALUE", // required
|
|
40
|
+
* // Configuration: { // ProcessorConfiguration
|
|
41
|
+
* // Lambda: { // LambdaConfiguration
|
|
42
|
+
* // ResourceArn: "STRING_VALUE", // required
|
|
43
|
+
* // InvocationType: "ASYNC", // required
|
|
44
|
+
* // },
|
|
45
|
+
* // },
|
|
46
|
+
* // ExecutionOrder: Number("int"), // required
|
|
47
|
+
* // FallbackAction: "CONTINUE" || "ABORT", // required
|
|
48
|
+
* // },
|
|
49
|
+
* // ],
|
|
50
|
+
* // Name: "STRING_VALUE",
|
|
51
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
52
|
+
* // LastUpdatedTimestamp: new Date("TIMESTAMP"),
|
|
53
|
+
* // },
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
34
56
|
* ```
|
|
35
57
|
*
|
|
36
58
|
* @param DescribeChannelFlowCommandInput - {@link DescribeChannelFlowCommandInput}
|
|
@@ -57,6 +79,8 @@ export interface DescribeChannelFlowCommandOutput extends DescribeChannelFlowRes
|
|
|
57
79
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
58
80
|
* <p>The client is not currently authorized to make the request.</p>
|
|
59
81
|
*
|
|
82
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
60
84
|
*
|
|
61
85
|
*/
|
|
62
86
|
export declare class DescribeChannelFlowCommand extends $Command<DescribeChannelFlowCommandInput, DescribeChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -39,6 +39,24 @@ export interface DescribeChannelMembershipCommandOutput extends DescribeChannelM
|
|
|
39
39
|
* };
|
|
40
40
|
* const command = new DescribeChannelMembershipCommand(input);
|
|
41
41
|
* const response = await client.send(command);
|
|
42
|
+
* // { // DescribeChannelMembershipResponse
|
|
43
|
+
* // ChannelMembership: { // ChannelMembership
|
|
44
|
+
* // InvitedBy: { // Identity
|
|
45
|
+
* // Arn: "STRING_VALUE",
|
|
46
|
+
* // Name: "STRING_VALUE",
|
|
47
|
+
* // },
|
|
48
|
+
* // Type: "DEFAULT" || "HIDDEN",
|
|
49
|
+
* // Member: {
|
|
50
|
+
* // Arn: "STRING_VALUE",
|
|
51
|
+
* // Name: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // ChannelArn: "STRING_VALUE",
|
|
54
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
55
|
+
* // LastUpdatedTimestamp: new Date("TIMESTAMP"),
|
|
56
|
+
* // SubChannelId: "STRING_VALUE",
|
|
57
|
+
* // },
|
|
58
|
+
* // };
|
|
59
|
+
*
|
|
42
60
|
* ```
|
|
43
61
|
*
|
|
44
62
|
* @param DescribeChannelMembershipCommandInput - {@link DescribeChannelMembershipCommandInput}
|
|
@@ -68,6 +86,8 @@ export interface DescribeChannelMembershipCommandOutput extends DescribeChannelM
|
|
|
68
86
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
69
87
|
* <p>The client is not currently authorized to make the request.</p>
|
|
70
88
|
*
|
|
89
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
71
91
|
*
|
|
72
92
|
*/
|
|
73
93
|
export declare class DescribeChannelMembershipCommand extends $Command<DescribeChannelMembershipCommandInput, DescribeChannelMembershipCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -39,6 +39,24 @@ export interface DescribeChannelMembershipForAppInstanceUserCommandOutput extend
|
|
|
39
39
|
* };
|
|
40
40
|
* const command = new DescribeChannelMembershipForAppInstanceUserCommand(input);
|
|
41
41
|
* const response = await client.send(command);
|
|
42
|
+
* // { // DescribeChannelMembershipForAppInstanceUserResponse
|
|
43
|
+
* // ChannelMembership: { // ChannelMembershipForAppInstanceUserSummary
|
|
44
|
+
* // ChannelSummary: { // ChannelSummary
|
|
45
|
+
* // Name: "STRING_VALUE",
|
|
46
|
+
* // ChannelArn: "STRING_VALUE",
|
|
47
|
+
* // Mode: "UNRESTRICTED" || "RESTRICTED",
|
|
48
|
+
* // Privacy: "PUBLIC" || "PRIVATE",
|
|
49
|
+
* // Metadata: "STRING_VALUE",
|
|
50
|
+
* // LastMessageTimestamp: new Date("TIMESTAMP"),
|
|
51
|
+
* // },
|
|
52
|
+
* // AppInstanceUserMembershipSummary: { // AppInstanceUserMembershipSummary
|
|
53
|
+
* // Type: "DEFAULT" || "HIDDEN",
|
|
54
|
+
* // ReadMarkerTimestamp: new Date("TIMESTAMP"),
|
|
55
|
+
* // SubChannelId: "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // },
|
|
58
|
+
* // };
|
|
59
|
+
*
|
|
42
60
|
* ```
|
|
43
61
|
*
|
|
44
62
|
* @param DescribeChannelMembershipForAppInstanceUserCommandInput - {@link DescribeChannelMembershipForAppInstanceUserCommandInput}
|
|
@@ -65,6 +83,8 @@ export interface DescribeChannelMembershipForAppInstanceUserCommandOutput extend
|
|
|
65
83
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
66
84
|
* <p>The client is not currently authorized to make the request.</p>
|
|
67
85
|
*
|
|
86
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
68
88
|
*
|
|
69
89
|
*/
|
|
70
90
|
export declare class DescribeChannelMembershipForAppInstanceUserCommand extends $Command<DescribeChannelMembershipForAppInstanceUserCommandInput, DescribeChannelMembershipForAppInstanceUserCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -39,6 +39,19 @@ export interface DescribeChannelModeratedByAppInstanceUserCommandOutput extends
|
|
|
39
39
|
* };
|
|
40
40
|
* const command = new DescribeChannelModeratedByAppInstanceUserCommand(input);
|
|
41
41
|
* const response = await client.send(command);
|
|
42
|
+
* // { // DescribeChannelModeratedByAppInstanceUserResponse
|
|
43
|
+
* // Channel: { // ChannelModeratedByAppInstanceUserSummary
|
|
44
|
+
* // ChannelSummary: { // ChannelSummary
|
|
45
|
+
* // Name: "STRING_VALUE",
|
|
46
|
+
* // ChannelArn: "STRING_VALUE",
|
|
47
|
+
* // Mode: "UNRESTRICTED" || "RESTRICTED",
|
|
48
|
+
* // Privacy: "PUBLIC" || "PRIVATE",
|
|
49
|
+
* // Metadata: "STRING_VALUE",
|
|
50
|
+
* // LastMessageTimestamp: new Date("TIMESTAMP"),
|
|
51
|
+
* // },
|
|
52
|
+
* // },
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
42
55
|
* ```
|
|
43
56
|
*
|
|
44
57
|
* @param DescribeChannelModeratedByAppInstanceUserCommandInput - {@link DescribeChannelModeratedByAppInstanceUserCommandInput}
|
|
@@ -65,6 +78,8 @@ export interface DescribeChannelModeratedByAppInstanceUserCommandOutput extends
|
|
|
65
78
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
66
79
|
* <p>The client is not currently authorized to make the request.</p>
|
|
67
80
|
*
|
|
81
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
82
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
68
83
|
*
|
|
69
84
|
*/
|
|
70
85
|
export declare class DescribeChannelModeratedByAppInstanceUserCommand extends $Command<DescribeChannelModeratedByAppInstanceUserCommandInput, DescribeChannelModeratedByAppInstanceUserCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -38,6 +38,21 @@ export interface DescribeChannelModeratorCommandOutput extends DescribeChannelMo
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new DescribeChannelModeratorCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // DescribeChannelModeratorResponse
|
|
42
|
+
* // ChannelModerator: { // ChannelModerator
|
|
43
|
+
* // Moderator: { // Identity
|
|
44
|
+
* // Arn: "STRING_VALUE",
|
|
45
|
+
* // Name: "STRING_VALUE",
|
|
46
|
+
* // },
|
|
47
|
+
* // ChannelArn: "STRING_VALUE",
|
|
48
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
49
|
+
* // CreatedBy: {
|
|
50
|
+
* // Arn: "STRING_VALUE",
|
|
51
|
+
* // Name: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // },
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
41
56
|
* ```
|
|
42
57
|
*
|
|
43
58
|
* @param DescribeChannelModeratorCommandInput - {@link DescribeChannelModeratorCommandInput}
|
|
@@ -67,6 +82,8 @@ export interface DescribeChannelModeratorCommandOutput extends DescribeChannelMo
|
|
|
67
82
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
68
83
|
* <p>The client is not currently authorized to make the request.</p>
|
|
69
84
|
*
|
|
85
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
70
87
|
*
|
|
71
88
|
*/
|
|
72
89
|
export declare class DescribeChannelModeratorCommand extends $Command<DescribeChannelModeratorCommandInput, DescribeChannelModeratorCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -40,6 +40,8 @@ export interface DisassociateChannelFlowCommandOutput extends __MetadataBearer {
|
|
|
40
40
|
* };
|
|
41
41
|
* const command = new DisassociateChannelFlowCommand(input);
|
|
42
42
|
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
43
45
|
* ```
|
|
44
46
|
*
|
|
45
47
|
* @param DisassociateChannelFlowCommandInput - {@link DisassociateChannelFlowCommandInput}
|
|
@@ -73,6 +75,8 @@ export interface DisassociateChannelFlowCommandOutput extends __MetadataBearer {
|
|
|
73
75
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
74
76
|
* <p>The client is not currently authorized to make the request.</p>
|
|
75
77
|
*
|
|
78
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
76
80
|
*
|
|
77
81
|
*/
|
|
78
82
|
export declare class DisassociateChannelFlowCommand extends $Command<DisassociateChannelFlowCommandInput, DisassociateChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -42,6 +42,20 @@ export interface GetChannelMembershipPreferencesCommandOutput extends GetChannel
|
|
|
42
42
|
* };
|
|
43
43
|
* const command = new GetChannelMembershipPreferencesCommand(input);
|
|
44
44
|
* const response = await client.send(command);
|
|
45
|
+
* // { // GetChannelMembershipPreferencesResponse
|
|
46
|
+
* // ChannelArn: "STRING_VALUE",
|
|
47
|
+
* // Member: { // Identity
|
|
48
|
+
* // Arn: "STRING_VALUE",
|
|
49
|
+
* // Name: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // Preferences: { // ChannelMembershipPreferences
|
|
52
|
+
* // PushNotifications: { // PushNotificationPreferences
|
|
53
|
+
* // AllowNotifications: "ALL" || "NONE" || "FILTERED", // required
|
|
54
|
+
* // FilterRule: "STRING_VALUE",
|
|
55
|
+
* // },
|
|
56
|
+
* // },
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
45
59
|
* ```
|
|
46
60
|
*
|
|
47
61
|
* @param GetChannelMembershipPreferencesCommandInput - {@link GetChannelMembershipPreferencesCommandInput}
|
|
@@ -68,6 +82,8 @@ export interface GetChannelMembershipPreferencesCommandOutput extends GetChannel
|
|
|
68
82
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
69
83
|
* <p>The client is not currently authorized to make the request.</p>
|
|
70
84
|
*
|
|
85
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
71
87
|
*
|
|
72
88
|
*/
|
|
73
89
|
export declare class GetChannelMembershipPreferencesCommand extends $Command<GetChannelMembershipPreferencesCommandInput, GetChannelMembershipPreferencesCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|