@aws-sdk/client-chime-sdk-messaging 3.325.0 → 3.327.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 +7 -7
|
@@ -39,6 +39,38 @@ export interface GetChannelMessageCommandOutput extends GetChannelMessageRespons
|
|
|
39
39
|
* };
|
|
40
40
|
* const command = new GetChannelMessageCommand(input);
|
|
41
41
|
* const response = await client.send(command);
|
|
42
|
+
* // { // GetChannelMessageResponse
|
|
43
|
+
* // ChannelMessage: { // ChannelMessage
|
|
44
|
+
* // ChannelArn: "STRING_VALUE",
|
|
45
|
+
* // MessageId: "STRING_VALUE",
|
|
46
|
+
* // Content: "STRING_VALUE",
|
|
47
|
+
* // Metadata: "STRING_VALUE",
|
|
48
|
+
* // Type: "STANDARD" || "CONTROL",
|
|
49
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
50
|
+
* // LastEditedTimestamp: new Date("TIMESTAMP"),
|
|
51
|
+
* // LastUpdatedTimestamp: new Date("TIMESTAMP"),
|
|
52
|
+
* // Sender: { // Identity
|
|
53
|
+
* // Arn: "STRING_VALUE",
|
|
54
|
+
* // Name: "STRING_VALUE",
|
|
55
|
+
* // },
|
|
56
|
+
* // Redacted: true || false,
|
|
57
|
+
* // Persistence: "PERSISTENT" || "NON_PERSISTENT",
|
|
58
|
+
* // Status: { // ChannelMessageStatusStructure
|
|
59
|
+
* // Value: "SENT" || "PENDING" || "FAILED" || "DENIED",
|
|
60
|
+
* // Detail: "STRING_VALUE",
|
|
61
|
+
* // },
|
|
62
|
+
* // MessageAttributes: { // MessageAttributeMap
|
|
63
|
+
* // "<keys>": { // MessageAttributeValue
|
|
64
|
+
* // StringValues: [ // MessageAttributeStringValues
|
|
65
|
+
* // "STRING_VALUE",
|
|
66
|
+
* // ],
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // SubChannelId: "STRING_VALUE",
|
|
70
|
+
* // ContentType: "STRING_VALUE",
|
|
71
|
+
* // },
|
|
72
|
+
* // };
|
|
73
|
+
*
|
|
42
74
|
* ```
|
|
43
75
|
*
|
|
44
76
|
* @param GetChannelMessageCommandInput - {@link GetChannelMessageCommandInput}
|
|
@@ -68,6 +100,8 @@ export interface GetChannelMessageCommandOutput extends GetChannelMessageRespons
|
|
|
68
100
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
69
101
|
* <p>The client is not currently authorized to make the request.</p>
|
|
70
102
|
*
|
|
103
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
104
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
71
105
|
*
|
|
72
106
|
*/
|
|
73
107
|
export declare class GetChannelMessageCommand extends $Command<GetChannelMessageCommandInput, GetChannelMessageCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -69,6 +69,13 @@ export interface GetChannelMessageStatusCommandOutput extends GetChannelMessageS
|
|
|
69
69
|
* };
|
|
70
70
|
* const command = new GetChannelMessageStatusCommand(input);
|
|
71
71
|
* const response = await client.send(command);
|
|
72
|
+
* // { // GetChannelMessageStatusResponse
|
|
73
|
+
* // Status: { // ChannelMessageStatusStructure
|
|
74
|
+
* // Value: "SENT" || "PENDING" || "FAILED" || "DENIED",
|
|
75
|
+
* // Detail: "STRING_VALUE",
|
|
76
|
+
* // },
|
|
77
|
+
* // };
|
|
78
|
+
*
|
|
72
79
|
* ```
|
|
73
80
|
*
|
|
74
81
|
* @param GetChannelMessageStatusCommandInput - {@link GetChannelMessageStatusCommandInput}
|
|
@@ -95,6 +102,8 @@ export interface GetChannelMessageStatusCommandOutput extends GetChannelMessageS
|
|
|
95
102
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
96
103
|
* <p>The client is not currently authorized to make the request.</p>
|
|
97
104
|
*
|
|
105
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
106
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
98
107
|
*
|
|
99
108
|
*/
|
|
100
109
|
export declare class GetChannelMessageStatusCommand extends $Command<GetChannelMessageStatusCommandInput, GetChannelMessageStatusCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -29,6 +29,12 @@ export interface GetMessagingSessionEndpointCommandOutput extends GetMessagingSe
|
|
|
29
29
|
* const input = {};
|
|
30
30
|
* const command = new GetMessagingSessionEndpointCommand(input);
|
|
31
31
|
* const response = await client.send(command);
|
|
32
|
+
* // { // GetMessagingSessionEndpointResponse
|
|
33
|
+
* // Endpoint: { // MessagingSessionEndpoint
|
|
34
|
+
* // Url: "STRING_VALUE",
|
|
35
|
+
* // },
|
|
36
|
+
* // };
|
|
37
|
+
*
|
|
32
38
|
* ```
|
|
33
39
|
*
|
|
34
40
|
* @param GetMessagingSessionEndpointCommandInput - {@link GetMessagingSessionEndpointCommandInput}
|
|
@@ -52,6 +58,8 @@ export interface GetMessagingSessionEndpointCommandOutput extends GetMessagingSe
|
|
|
52
58
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
53
59
|
* <p>The client is not currently authorized to make the request.</p>
|
|
54
60
|
*
|
|
61
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
62
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
55
63
|
*
|
|
56
64
|
*/
|
|
57
65
|
export declare class GetMessagingSessionEndpointCommand extends $Command<GetMessagingSessionEndpointCommandInput, GetMessagingSessionEndpointCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -32,6 +32,15 @@ export interface GetMessagingStreamingConfigurationsCommandOutput extends GetMes
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new GetMessagingStreamingConfigurationsCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // GetMessagingStreamingConfigurationsResponse
|
|
36
|
+
* // StreamingConfigurations: [ // StreamingConfigurationList
|
|
37
|
+
* // { // StreamingConfiguration
|
|
38
|
+
* // DataType: "Channel" || "ChannelMessage", // required
|
|
39
|
+
* // ResourceArn: "STRING_VALUE", // required
|
|
40
|
+
* // },
|
|
41
|
+
* // ],
|
|
42
|
+
* // };
|
|
43
|
+
*
|
|
35
44
|
* ```
|
|
36
45
|
*
|
|
37
46
|
* @param GetMessagingStreamingConfigurationsCommandInput - {@link GetMessagingStreamingConfigurationsCommandInput}
|
|
@@ -61,6 +70,8 @@ export interface GetMessagingStreamingConfigurationsCommandOutput extends GetMes
|
|
|
61
70
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
62
71
|
* <p>The client is not currently authorized to make the request.</p>
|
|
63
72
|
*
|
|
73
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
64
75
|
*
|
|
65
76
|
*/
|
|
66
77
|
export declare class GetMessagingStreamingConfigurationsCommand extends $Command<GetMessagingStreamingConfigurationsCommandInput, GetMessagingStreamingConfigurationsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -39,6 +39,19 @@ export interface ListChannelBansCommandOutput extends ListChannelBansResponse, _
|
|
|
39
39
|
* };
|
|
40
40
|
* const command = new ListChannelBansCommand(input);
|
|
41
41
|
* const response = await client.send(command);
|
|
42
|
+
* // { // ListChannelBansResponse
|
|
43
|
+
* // ChannelArn: "STRING_VALUE",
|
|
44
|
+
* // NextToken: "STRING_VALUE",
|
|
45
|
+
* // ChannelBans: [ // ChannelBanSummaryList
|
|
46
|
+
* // { // ChannelBanSummary
|
|
47
|
+
* // Member: { // Identity
|
|
48
|
+
* // Arn: "STRING_VALUE",
|
|
49
|
+
* // Name: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // },
|
|
52
|
+
* // ],
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
42
55
|
* ```
|
|
43
56
|
*
|
|
44
57
|
* @param ListChannelBansCommandInput - {@link ListChannelBansCommandInput}
|
|
@@ -65,6 +78,8 @@ export interface ListChannelBansCommandOutput extends ListChannelBansResponse, _
|
|
|
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 ListChannelBansCommand extends $Command<ListChannelBansCommandInput, ListChannelBansCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -33,6 +33,29 @@ export interface ListChannelFlowsCommandOutput extends ListChannelFlowsResponse,
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new ListChannelFlowsCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // ListChannelFlowsResponse
|
|
37
|
+
* // ChannelFlows: [ // ChannelFlowSummaryList
|
|
38
|
+
* // { // ChannelFlowSummary
|
|
39
|
+
* // ChannelFlowArn: "STRING_VALUE",
|
|
40
|
+
* // Name: "STRING_VALUE",
|
|
41
|
+
* // Processors: [ // ProcessorList
|
|
42
|
+
* // { // Processor
|
|
43
|
+
* // Name: "STRING_VALUE", // required
|
|
44
|
+
* // Configuration: { // ProcessorConfiguration
|
|
45
|
+
* // Lambda: { // LambdaConfiguration
|
|
46
|
+
* // ResourceArn: "STRING_VALUE", // required
|
|
47
|
+
* // InvocationType: "ASYNC", // required
|
|
48
|
+
* // },
|
|
49
|
+
* // },
|
|
50
|
+
* // ExecutionOrder: Number("int"), // required
|
|
51
|
+
* // FallbackAction: "CONTINUE" || "ABORT", // required
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // },
|
|
55
|
+
* // ],
|
|
56
|
+
* // NextToken: "STRING_VALUE",
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
36
59
|
* ```
|
|
37
60
|
*
|
|
38
61
|
* @param ListChannelFlowsCommandInput - {@link ListChannelFlowsCommandInput}
|
|
@@ -59,6 +82,8 @@ export interface ListChannelFlowsCommandOutput extends ListChannelFlowsResponse,
|
|
|
59
82
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
60
83
|
* <p>The client is not currently authorized to make the request.</p>
|
|
61
84
|
*
|
|
85
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
62
87
|
*
|
|
63
88
|
*/
|
|
64
89
|
export declare class ListChannelFlowsCommand extends $Command<ListChannelFlowsCommandInput, ListChannelFlowsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -43,6 +43,19 @@ export interface ListChannelMembershipsCommandOutput extends ListChannelMembersh
|
|
|
43
43
|
* };
|
|
44
44
|
* const command = new ListChannelMembershipsCommand(input);
|
|
45
45
|
* const response = await client.send(command);
|
|
46
|
+
* // { // ListChannelMembershipsResponse
|
|
47
|
+
* // ChannelArn: "STRING_VALUE",
|
|
48
|
+
* // ChannelMemberships: [ // ChannelMembershipSummaryList
|
|
49
|
+
* // { // ChannelMembershipSummary
|
|
50
|
+
* // Member: { // Identity
|
|
51
|
+
* // Arn: "STRING_VALUE",
|
|
52
|
+
* // Name: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // },
|
|
55
|
+
* // ],
|
|
56
|
+
* // NextToken: "STRING_VALUE",
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
46
59
|
* ```
|
|
47
60
|
*
|
|
48
61
|
* @param ListChannelMembershipsCommandInput - {@link ListChannelMembershipsCommandInput}
|
|
@@ -69,6 +82,8 @@ export interface ListChannelMembershipsCommandOutput extends ListChannelMembersh
|
|
|
69
82
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
70
83
|
* <p>The client is not currently authorized to make the request.</p>
|
|
71
84
|
*
|
|
85
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
72
87
|
*
|
|
73
88
|
*/
|
|
74
89
|
export declare class ListChannelMembershipsCommand extends $Command<ListChannelMembershipsCommandInput, ListChannelMembershipsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -40,6 +40,27 @@ export interface ListChannelMembershipsForAppInstanceUserCommandOutput extends L
|
|
|
40
40
|
* };
|
|
41
41
|
* const command = new ListChannelMembershipsForAppInstanceUserCommand(input);
|
|
42
42
|
* const response = await client.send(command);
|
|
43
|
+
* // { // ListChannelMembershipsForAppInstanceUserResponse
|
|
44
|
+
* // ChannelMemberships: [ // ChannelMembershipForAppInstanceUserSummaryList
|
|
45
|
+
* // { // ChannelMembershipForAppInstanceUserSummary
|
|
46
|
+
* // ChannelSummary: { // ChannelSummary
|
|
47
|
+
* // Name: "STRING_VALUE",
|
|
48
|
+
* // ChannelArn: "STRING_VALUE",
|
|
49
|
+
* // Mode: "UNRESTRICTED" || "RESTRICTED",
|
|
50
|
+
* // Privacy: "PUBLIC" || "PRIVATE",
|
|
51
|
+
* // Metadata: "STRING_VALUE",
|
|
52
|
+
* // LastMessageTimestamp: new Date("TIMESTAMP"),
|
|
53
|
+
* // },
|
|
54
|
+
* // AppInstanceUserMembershipSummary: { // AppInstanceUserMembershipSummary
|
|
55
|
+
* // Type: "DEFAULT" || "HIDDEN",
|
|
56
|
+
* // ReadMarkerTimestamp: new Date("TIMESTAMP"),
|
|
57
|
+
* // SubChannelId: "STRING_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // NextToken: "STRING_VALUE",
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
43
64
|
* ```
|
|
44
65
|
*
|
|
45
66
|
* @param ListChannelMembershipsForAppInstanceUserCommandInput - {@link ListChannelMembershipsForAppInstanceUserCommandInput}
|
|
@@ -66,6 +87,8 @@ export interface ListChannelMembershipsForAppInstanceUserCommandOutput extends L
|
|
|
66
87
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
67
88
|
* <p>The client is not currently authorized to make the request.</p>
|
|
68
89
|
*
|
|
90
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
91
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
69
92
|
*
|
|
70
93
|
*/
|
|
71
94
|
export declare class ListChannelMembershipsForAppInstanceUserCommand extends $Command<ListChannelMembershipsForAppInstanceUserCommandInput, ListChannelMembershipsForAppInstanceUserCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -48,6 +48,40 @@ export interface ListChannelMessagesCommandOutput extends ListChannelMessagesRes
|
|
|
48
48
|
* };
|
|
49
49
|
* const command = new ListChannelMessagesCommand(input);
|
|
50
50
|
* const response = await client.send(command);
|
|
51
|
+
* // { // ListChannelMessagesResponse
|
|
52
|
+
* // ChannelArn: "STRING_VALUE",
|
|
53
|
+
* // NextToken: "STRING_VALUE",
|
|
54
|
+
* // ChannelMessages: [ // ChannelMessageSummaryList
|
|
55
|
+
* // { // ChannelMessageSummary
|
|
56
|
+
* // MessageId: "STRING_VALUE",
|
|
57
|
+
* // Content: "STRING_VALUE",
|
|
58
|
+
* // Metadata: "STRING_VALUE",
|
|
59
|
+
* // Type: "STANDARD" || "CONTROL",
|
|
60
|
+
* // CreatedTimestamp: new Date("TIMESTAMP"),
|
|
61
|
+
* // LastUpdatedTimestamp: new Date("TIMESTAMP"),
|
|
62
|
+
* // LastEditedTimestamp: new Date("TIMESTAMP"),
|
|
63
|
+
* // Sender: { // Identity
|
|
64
|
+
* // Arn: "STRING_VALUE",
|
|
65
|
+
* // Name: "STRING_VALUE",
|
|
66
|
+
* // },
|
|
67
|
+
* // Redacted: true || false,
|
|
68
|
+
* // Status: { // ChannelMessageStatusStructure
|
|
69
|
+
* // Value: "SENT" || "PENDING" || "FAILED" || "DENIED",
|
|
70
|
+
* // Detail: "STRING_VALUE",
|
|
71
|
+
* // },
|
|
72
|
+
* // MessageAttributes: { // MessageAttributeMap
|
|
73
|
+
* // "<keys>": { // MessageAttributeValue
|
|
74
|
+
* // StringValues: [ // MessageAttributeStringValues
|
|
75
|
+
* // "STRING_VALUE",
|
|
76
|
+
* // ],
|
|
77
|
+
* // },
|
|
78
|
+
* // },
|
|
79
|
+
* // ContentType: "STRING_VALUE",
|
|
80
|
+
* // },
|
|
81
|
+
* // ],
|
|
82
|
+
* // SubChannelId: "STRING_VALUE",
|
|
83
|
+
* // };
|
|
84
|
+
*
|
|
51
85
|
* ```
|
|
52
86
|
*
|
|
53
87
|
* @param ListChannelMessagesCommandInput - {@link ListChannelMessagesCommandInput}
|
|
@@ -74,6 +108,8 @@ export interface ListChannelMessagesCommandOutput extends ListChannelMessagesRes
|
|
|
74
108
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
75
109
|
* <p>The client is not currently authorized to make the request.</p>
|
|
76
110
|
*
|
|
111
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
112
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
77
113
|
*
|
|
78
114
|
*/
|
|
79
115
|
export declare class ListChannelMessagesCommand extends $Command<ListChannelMessagesCommandInput, ListChannelMessagesCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -39,6 +39,19 @@ export interface ListChannelModeratorsCommandOutput extends ListChannelModerator
|
|
|
39
39
|
* };
|
|
40
40
|
* const command = new ListChannelModeratorsCommand(input);
|
|
41
41
|
* const response = await client.send(command);
|
|
42
|
+
* // { // ListChannelModeratorsResponse
|
|
43
|
+
* // ChannelArn: "STRING_VALUE",
|
|
44
|
+
* // NextToken: "STRING_VALUE",
|
|
45
|
+
* // ChannelModerators: [ // ChannelModeratorSummaryList
|
|
46
|
+
* // { // ChannelModeratorSummary
|
|
47
|
+
* // Moderator: { // Identity
|
|
48
|
+
* // Arn: "STRING_VALUE",
|
|
49
|
+
* // Name: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // },
|
|
52
|
+
* // ],
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
42
55
|
* ```
|
|
43
56
|
*
|
|
44
57
|
* @param ListChannelModeratorsCommandInput - {@link ListChannelModeratorsCommandInput}
|
|
@@ -65,6 +78,8 @@ export interface ListChannelModeratorsCommandOutput extends ListChannelModerator
|
|
|
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 ListChannelModeratorsCommand extends $Command<ListChannelModeratorsCommandInput, ListChannelModeratorsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -33,6 +33,19 @@ export interface ListChannelsAssociatedWithChannelFlowCommandOutput extends List
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new ListChannelsAssociatedWithChannelFlowCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // ListChannelsAssociatedWithChannelFlowResponse
|
|
37
|
+
* // Channels: [ // ChannelAssociatedWithFlowSummaryList
|
|
38
|
+
* // { // ChannelAssociatedWithFlowSummary
|
|
39
|
+
* // Name: "STRING_VALUE",
|
|
40
|
+
* // ChannelArn: "STRING_VALUE",
|
|
41
|
+
* // Mode: "UNRESTRICTED" || "RESTRICTED",
|
|
42
|
+
* // Privacy: "PUBLIC" || "PRIVATE",
|
|
43
|
+
* // Metadata: "STRING_VALUE",
|
|
44
|
+
* // },
|
|
45
|
+
* // ],
|
|
46
|
+
* // NextToken: "STRING_VALUE",
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
36
49
|
* ```
|
|
37
50
|
*
|
|
38
51
|
* @param ListChannelsAssociatedWithChannelFlowCommandInput - {@link ListChannelsAssociatedWithChannelFlowCommandInput}
|
|
@@ -59,6 +72,8 @@ export interface ListChannelsAssociatedWithChannelFlowCommandOutput extends List
|
|
|
59
72
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
60
73
|
* <p>The client is not currently authorized to make the request.</p>
|
|
61
74
|
*
|
|
75
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
62
77
|
*
|
|
63
78
|
*/
|
|
64
79
|
export declare class ListChannelsAssociatedWithChannelFlowCommand extends $Command<ListChannelsAssociatedWithChannelFlowCommandInput, ListChannelsAssociatedWithChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -54,6 +54,20 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
|
|
|
54
54
|
* };
|
|
55
55
|
* const command = new ListChannelsCommand(input);
|
|
56
56
|
* const response = await client.send(command);
|
|
57
|
+
* // { // ListChannelsResponse
|
|
58
|
+
* // Channels: [ // ChannelSummaryList
|
|
59
|
+
* // { // ChannelSummary
|
|
60
|
+
* // Name: "STRING_VALUE",
|
|
61
|
+
* // ChannelArn: "STRING_VALUE",
|
|
62
|
+
* // Mode: "UNRESTRICTED" || "RESTRICTED",
|
|
63
|
+
* // Privacy: "PUBLIC" || "PRIVATE",
|
|
64
|
+
* // Metadata: "STRING_VALUE",
|
|
65
|
+
* // LastMessageTimestamp: new Date("TIMESTAMP"),
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // NextToken: "STRING_VALUE",
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
57
71
|
* ```
|
|
58
72
|
*
|
|
59
73
|
* @param ListChannelsCommandInput - {@link ListChannelsCommandInput}
|
|
@@ -80,6 +94,8 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
|
|
|
80
94
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
81
95
|
* <p>The client is not currently authorized to make the request.</p>
|
|
82
96
|
*
|
|
97
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
98
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
83
99
|
*
|
|
84
100
|
*/
|
|
85
101
|
export declare class ListChannelsCommand extends $Command<ListChannelsCommandInput, ListChannelsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -39,6 +39,22 @@ export interface ListChannelsModeratedByAppInstanceUserCommandOutput extends Lis
|
|
|
39
39
|
* };
|
|
40
40
|
* const command = new ListChannelsModeratedByAppInstanceUserCommand(input);
|
|
41
41
|
* const response = await client.send(command);
|
|
42
|
+
* // { // ListChannelsModeratedByAppInstanceUserResponse
|
|
43
|
+
* // Channels: [ // ChannelModeratedByAppInstanceUserSummaryList
|
|
44
|
+
* // { // ChannelModeratedByAppInstanceUserSummary
|
|
45
|
+
* // ChannelSummary: { // ChannelSummary
|
|
46
|
+
* // Name: "STRING_VALUE",
|
|
47
|
+
* // ChannelArn: "STRING_VALUE",
|
|
48
|
+
* // Mode: "UNRESTRICTED" || "RESTRICTED",
|
|
49
|
+
* // Privacy: "PUBLIC" || "PRIVATE",
|
|
50
|
+
* // Metadata: "STRING_VALUE",
|
|
51
|
+
* // LastMessageTimestamp: new Date("TIMESTAMP"),
|
|
52
|
+
* // },
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // NextToken: "STRING_VALUE",
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
42
58
|
* ```
|
|
43
59
|
*
|
|
44
60
|
* @param ListChannelsModeratedByAppInstanceUserCommandInput - {@link ListChannelsModeratedByAppInstanceUserCommandInput}
|
|
@@ -65,6 +81,8 @@ export interface ListChannelsModeratedByAppInstanceUserCommandOutput extends Lis
|
|
|
65
81
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
66
82
|
* <p>The client is not currently authorized to make the request.</p>
|
|
67
83
|
*
|
|
84
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
68
86
|
*
|
|
69
87
|
*/
|
|
70
88
|
export declare class ListChannelsModeratedByAppInstanceUserCommand extends $Command<ListChannelsModeratedByAppInstanceUserCommandInput, ListChannelsModeratedByAppInstanceUserCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -34,6 +34,17 @@ export interface ListSubChannelsCommandOutput extends ListSubChannelsResponse, _
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new ListSubChannelsCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // ListSubChannelsResponse
|
|
38
|
+
* // ChannelArn: "STRING_VALUE",
|
|
39
|
+
* // SubChannels: [ // SubChannelSummaryList
|
|
40
|
+
* // { // SubChannelSummary
|
|
41
|
+
* // SubChannelId: "STRING_VALUE",
|
|
42
|
+
* // MembershipCount: Number("int"),
|
|
43
|
+
* // },
|
|
44
|
+
* // ],
|
|
45
|
+
* // NextToken: "STRING_VALUE",
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
37
48
|
* ```
|
|
38
49
|
*
|
|
39
50
|
* @param ListSubChannelsCommandInput - {@link ListSubChannelsCommandInput}
|
|
@@ -60,6 +71,8 @@ export interface ListSubChannelsCommandOutput extends ListSubChannelsResponse, _
|
|
|
60
71
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
61
72
|
* <p>The client is not currently authorized to make the request.</p>
|
|
62
73
|
*
|
|
74
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
63
76
|
*
|
|
64
77
|
*/
|
|
65
78
|
export declare class ListSubChannelsCommand extends $Command<ListSubChannelsCommandInput, ListSubChannelsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -31,6 +31,15 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new ListTagsForResourceCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // ListTagsForResourceResponse
|
|
35
|
+
* // Tags: [ // TagList
|
|
36
|
+
* // { // Tag
|
|
37
|
+
* // Key: "STRING_VALUE", // required
|
|
38
|
+
* // Value: "STRING_VALUE", // required
|
|
39
|
+
* // },
|
|
40
|
+
* // ],
|
|
41
|
+
* // };
|
|
42
|
+
*
|
|
34
43
|
* ```
|
|
35
44
|
*
|
|
36
45
|
* @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
|
|
@@ -57,6 +66,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
57
66
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
58
67
|
* <p>The client is not currently authorized to make the request.</p>
|
|
59
68
|
*
|
|
69
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
60
71
|
*
|
|
61
72
|
*/
|
|
62
73
|
export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -53,6 +53,14 @@ export interface PutChannelExpirationSettingsCommandOutput extends PutChannelExp
|
|
|
53
53
|
* };
|
|
54
54
|
* const command = new PutChannelExpirationSettingsCommand(input);
|
|
55
55
|
* const response = await client.send(command);
|
|
56
|
+
* // { // PutChannelExpirationSettingsResponse
|
|
57
|
+
* // ChannelArn: "STRING_VALUE",
|
|
58
|
+
* // ExpirationSettings: { // ExpirationSettings
|
|
59
|
+
* // ExpirationDays: Number("int"), // required
|
|
60
|
+
* // ExpirationCriterion: "CREATED_TIMESTAMP" || "LAST_MESSAGE_TIMESTAMP", // required
|
|
61
|
+
* // },
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
56
64
|
* ```
|
|
57
65
|
*
|
|
58
66
|
* @param PutChannelExpirationSettingsCommandInput - {@link PutChannelExpirationSettingsCommandInput}
|
|
@@ -83,6 +91,8 @@ export interface PutChannelExpirationSettingsCommandOutput extends PutChannelExp
|
|
|
83
91
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
84
92
|
* <p>The client is not currently authorized to make the request.</p>
|
|
85
93
|
*
|
|
94
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
86
96
|
*
|
|
87
97
|
*/
|
|
88
98
|
export declare class PutChannelExpirationSettingsCommand extends $Command<PutChannelExpirationSettingsCommandInput, PutChannelExpirationSettingsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -48,6 +48,20 @@ export interface PutChannelMembershipPreferencesCommandOutput extends PutChannel
|
|
|
48
48
|
* };
|
|
49
49
|
* const command = new PutChannelMembershipPreferencesCommand(input);
|
|
50
50
|
* const response = await client.send(command);
|
|
51
|
+
* // { // PutChannelMembershipPreferencesResponse
|
|
52
|
+
* // ChannelArn: "STRING_VALUE",
|
|
53
|
+
* // Member: { // Identity
|
|
54
|
+
* // Arn: "STRING_VALUE",
|
|
55
|
+
* // Name: "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // Preferences: { // ChannelMembershipPreferences
|
|
58
|
+
* // PushNotifications: { // PushNotificationPreferences
|
|
59
|
+
* // AllowNotifications: "ALL" || "NONE" || "FILTERED", // required
|
|
60
|
+
* // FilterRule: "STRING_VALUE",
|
|
61
|
+
* // },
|
|
62
|
+
* // },
|
|
63
|
+
* // };
|
|
64
|
+
*
|
|
51
65
|
* ```
|
|
52
66
|
*
|
|
53
67
|
* @param PutChannelMembershipPreferencesCommandInput - {@link PutChannelMembershipPreferencesCommandInput}
|
|
@@ -78,6 +92,8 @@ export interface PutChannelMembershipPreferencesCommandOutput extends PutChannel
|
|
|
78
92
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
79
93
|
* <p>The client is not currently authorized to make the request.</p>
|
|
80
94
|
*
|
|
95
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
81
97
|
*
|
|
82
98
|
*/
|
|
83
99
|
export declare class PutChannelMembershipPreferencesCommand extends $Command<PutChannelMembershipPreferencesCommandInput, PutChannelMembershipPreferencesCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -38,6 +38,15 @@ export interface PutMessagingStreamingConfigurationsCommandOutput extends PutMes
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new PutMessagingStreamingConfigurationsCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // PutMessagingStreamingConfigurationsResponse
|
|
42
|
+
* // StreamingConfigurations: [ // StreamingConfigurationList
|
|
43
|
+
* // { // StreamingConfiguration
|
|
44
|
+
* // DataType: "Channel" || "ChannelMessage", // required
|
|
45
|
+
* // ResourceArn: "STRING_VALUE", // required
|
|
46
|
+
* // },
|
|
47
|
+
* // ],
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
41
50
|
* ```
|
|
42
51
|
*
|
|
43
52
|
* @param PutMessagingStreamingConfigurationsCommandInput - {@link PutMessagingStreamingConfigurationsCommandInput}
|
|
@@ -71,6 +80,8 @@ export interface PutMessagingStreamingConfigurationsCommandOutput extends PutMes
|
|
|
71
80
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
72
81
|
* <p>The client is not currently authorized to make the request.</p>
|
|
73
82
|
*
|
|
83
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
74
85
|
*
|
|
75
86
|
*/
|
|
76
87
|
export declare class PutMessagingStreamingConfigurationsCommand extends $Command<PutMessagingStreamingConfigurationsCommandInput, PutMessagingStreamingConfigurationsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -40,6 +40,12 @@ export interface RedactChannelMessageCommandOutput extends RedactChannelMessageR
|
|
|
40
40
|
* };
|
|
41
41
|
* const command = new RedactChannelMessageCommand(input);
|
|
42
42
|
* const response = await client.send(command);
|
|
43
|
+
* // { // RedactChannelMessageResponse
|
|
44
|
+
* // ChannelArn: "STRING_VALUE",
|
|
45
|
+
* // MessageId: "STRING_VALUE",
|
|
46
|
+
* // SubChannelId: "STRING_VALUE",
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
43
49
|
* ```
|
|
44
50
|
*
|
|
45
51
|
* @param RedactChannelMessageCommandInput - {@link RedactChannelMessageCommandInput}
|
|
@@ -70,6 +76,8 @@ export interface RedactChannelMessageCommandOutput extends RedactChannelMessageR
|
|
|
70
76
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
71
77
|
* <p>The client is not currently authorized to make the request.</p>
|
|
72
78
|
*
|
|
79
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
73
81
|
*
|
|
74
82
|
*/
|
|
75
83
|
export declare class RedactChannelMessageCommand extends $Command<RedactChannelMessageCommandInput, RedactChannelMessageCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -47,6 +47,20 @@ export interface SearchChannelsCommandOutput extends SearchChannelsResponse, __M
|
|
|
47
47
|
* };
|
|
48
48
|
* const command = new SearchChannelsCommand(input);
|
|
49
49
|
* const response = await client.send(command);
|
|
50
|
+
* // { // SearchChannelsResponse
|
|
51
|
+
* // Channels: [ // ChannelSummaryList
|
|
52
|
+
* // { // ChannelSummary
|
|
53
|
+
* // Name: "STRING_VALUE",
|
|
54
|
+
* // ChannelArn: "STRING_VALUE",
|
|
55
|
+
* // Mode: "UNRESTRICTED" || "RESTRICTED",
|
|
56
|
+
* // Privacy: "PUBLIC" || "PRIVATE",
|
|
57
|
+
* // Metadata: "STRING_VALUE",
|
|
58
|
+
* // LastMessageTimestamp: new Date("TIMESTAMP"),
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // NextToken: "STRING_VALUE",
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
50
64
|
* ```
|
|
51
65
|
*
|
|
52
66
|
* @param SearchChannelsCommandInput - {@link SearchChannelsCommandInput}
|
|
@@ -73,6 +87,8 @@ export interface SearchChannelsCommandOutput extends SearchChannelsResponse, __M
|
|
|
73
87
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
74
88
|
* <p>The client is not currently authorized to make the request.</p>
|
|
75
89
|
*
|
|
90
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
91
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
76
92
|
*
|
|
77
93
|
*/
|
|
78
94
|
export declare class SearchChannelsCommand extends $Command<SearchChannelsCommandInput, SearchChannelsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -58,6 +58,16 @@ export interface SendChannelMessageCommandOutput extends SendChannelMessageRespo
|
|
|
58
58
|
* };
|
|
59
59
|
* const command = new SendChannelMessageCommand(input);
|
|
60
60
|
* const response = await client.send(command);
|
|
61
|
+
* // { // SendChannelMessageResponse
|
|
62
|
+
* // ChannelArn: "STRING_VALUE",
|
|
63
|
+
* // MessageId: "STRING_VALUE",
|
|
64
|
+
* // Status: { // ChannelMessageStatusStructure
|
|
65
|
+
* // Value: "SENT" || "PENDING" || "FAILED" || "DENIED",
|
|
66
|
+
* // Detail: "STRING_VALUE",
|
|
67
|
+
* // },
|
|
68
|
+
* // SubChannelId: "STRING_VALUE",
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
61
71
|
* ```
|
|
62
72
|
*
|
|
63
73
|
* @param SendChannelMessageCommandInput - {@link SendChannelMessageCommandInput}
|
|
@@ -88,6 +98,8 @@ export interface SendChannelMessageCommandOutput extends SendChannelMessageRespo
|
|
|
88
98
|
* @throws {@link UnauthorizedClientException} (client fault)
|
|
89
99
|
* <p>The client is not currently authorized to make the request.</p>
|
|
90
100
|
*
|
|
101
|
+
* @throws {@link ChimeSDKMessagingServiceException}
|
|
102
|
+
* <p>Base exception class for all service exceptions from ChimeSDKMessaging service.</p>
|
|
91
103
|
*
|
|
92
104
|
*/
|
|
93
105
|
export declare class SendChannelMessageCommand extends $Command<SendChannelMessageCommandInput, SendChannelMessageCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|