Skip to content

Commit fdc692e

Browse files
trivikrtrivikr
authored
docs: re-add docs overwritten in 11/20 clients update (#1732)
1 parent b344ed8 commit fdc692e

File tree

203 files changed

+1356
-353
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

203 files changed

+1356
-353
lines changed

Diff for: ‎clients/client-chime/commands/CreateAppInstanceAdminCommand.ts

+17
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,20 @@ import {
2020
export type CreateAppInstanceAdminCommandInput = CreateAppInstanceAdminRequest;
2121
export type CreateAppInstanceAdminCommandOutput = CreateAppInstanceAdminResponse & __MetadataBearer;
2222

23+
/**
24+
* <p>Promotes an <code>AppInstanceUser</code> to an <code>AppInstanceAdmin</code>. The promoted user can perform the following actions. </p>
25+
* <ul>
26+
* <li>
27+
* <p>
28+
* <code>ChannelModerator</code> actions across all channels in the app instance.</p>
29+
* </li>
30+
* <li>
31+
* <p>
32+
* <code>DeleteChannelMessage</code> actions.</p>
33+
* </li>
34+
* </ul>
35+
* <p>Only an <code>AppInstanceUser</code> can be promoted to an <code>AppInstanceAdmin</code> role.</p>
36+
*/
2337
export class CreateAppInstanceAdminCommand extends $Command<
2438
CreateAppInstanceAdminCommandInput,
2539
CreateAppInstanceAdminCommandOutput,
@@ -34,6 +48,9 @@ export class CreateAppInstanceAdminCommand extends $Command<
3448
// End section: command_constructor
3549
}
3650

51+
/**
52+
* @internal
53+
*/
3754
resolveMiddleware(
3855
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3956
configuration: ChimeClientResolvedConfig,

Diff for: ‎clients/client-chime/commands/CreateAppInstanceCommand.ts

+7
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ import {
2020
export type CreateAppInstanceCommandInput = CreateAppInstanceRequest;
2121
export type CreateAppInstanceCommandOutput = CreateAppInstanceResponse & __MetadataBearer;
2222

23+
/**
24+
* <p>Creates an Amazon Chime Messaging SDK <code>AppInstance</code> under an AWS Account. Only Messaging SDK customers use this API.
25+
* <code>CreateAppInstance</code> supports <code>idempotency</code> behavior as described in the AWS API Standard.</p>
26+
*/
2327
export class CreateAppInstanceCommand extends $Command<
2428
CreateAppInstanceCommandInput,
2529
CreateAppInstanceCommandOutput,
@@ -34,6 +38,9 @@ export class CreateAppInstanceCommand extends $Command<
3438
// End section: command_constructor
3539
}
3640

41+
/**
42+
* @internal
43+
*/
3744
resolveMiddleware(
3845
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3946
configuration: ChimeClientResolvedConfig,

Diff for: ‎clients/client-chime/commands/CreateAppInstanceUserCommand.ts

+7
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ import {
2020
export type CreateAppInstanceUserCommandInput = CreateAppInstanceUserRequest;
2121
export type CreateAppInstanceUserCommandOutput = CreateAppInstanceUserResponse & __MetadataBearer;
2222

23+
/**
24+
* <p>Creates a user under an Amazon Chime <code>AppInstance</code>. The request consists of a unique <code>appInstanceUserId</code> and
25+
* <code>Name</code> for that user.</p>
26+
*/
2327
export class CreateAppInstanceUserCommand extends $Command<
2428
CreateAppInstanceUserCommandInput,
2529
CreateAppInstanceUserCommandOutput,
@@ -34,6 +38,9 @@ export class CreateAppInstanceUserCommand extends $Command<
3438
// End section: command_constructor
3539
}
3640

41+
/**
42+
* @internal
43+
*/
3744
resolveMiddleware(
3845
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3946
configuration: ChimeClientResolvedConfig,

Diff for: ‎clients/client-chime/commands/CreateChannelBanCommand.ts

+10
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@ import {
2020
export type CreateChannelBanCommandInput = CreateChannelBanRequest;
2121
export type CreateChannelBanCommandOutput = CreateChannelBanResponse & __MetadataBearer;
2222

23+
/**
24+
* <p>Permanently bans a member from a channel. Moderators can't add banned members to a channel.
25+
* To undo a ban, you first have to <code>DeleteChannelBan</code>, and then <code>CreateChannelMembership</code>.
26+
* Bans are cleaned up when you delete users or channels.
27+
* </p>
28+
* <p>If you ban a user who is already part of a channel, that user is automatically kicked from the channel.</p>
29+
*/
2330
export class CreateChannelBanCommand extends $Command<
2431
CreateChannelBanCommandInput,
2532
CreateChannelBanCommandOutput,
@@ -34,6 +41,9 @@ export class CreateChannelBanCommand extends $Command<
3441
// End section: command_constructor
3542
}
3643

44+
/**
45+
* @internal
46+
*/
3747
resolveMiddleware(
3848
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3949
configuration: ChimeClientResolvedConfig,

Diff for: ‎clients/client-chime/commands/CreateChannelCommand.ts

+8
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ import {
2020
export type CreateChannelCommandInput = CreateChannelRequest;
2121
export type CreateChannelCommandOutput = CreateChannelResponse & __MetadataBearer;
2222

23+
/**
24+
* <p>Creates a channel to which you can add users and send messages.</p>
25+
* <p>
26+
* <b>Restriction</b>: You can't change a channel's privacy.</p>
27+
*/
2328
export class CreateChannelCommand extends $Command<
2429
CreateChannelCommandInput,
2530
CreateChannelCommandOutput,
@@ -34,6 +39,9 @@ export class CreateChannelCommand extends $Command<
3439
// End section: command_constructor
3540
}
3641

42+
/**
43+
* @internal
44+
*/
3745
resolveMiddleware(
3846
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3947
configuration: ChimeClientResolvedConfig,

Diff for: ‎clients/client-chime/commands/CreateChannelMembershipCommand.ts

+33
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,36 @@ import {
2020
export type CreateChannelMembershipCommandInput = CreateChannelMembershipRequest;
2121
export type CreateChannelMembershipCommandOutput = CreateChannelMembershipResponse & __MetadataBearer;
2222

23+
/**
24+
* <p>Adds a user to a channel. The <code>InvitedBy</code> response field is derived from the request header.
25+
* A channel member can:</p>
26+
* <ul>
27+
* <li>
28+
* <p>List messages</p>
29+
* </li>
30+
* <li>
31+
* <p>Send messages</p>
32+
* </li>
33+
* <li>
34+
* <p>Receive messages</p>
35+
* </li>
36+
* <li>
37+
* <p>Edit their own messages</p>
38+
* </li>
39+
* <li>
40+
* <p>Leave the channel</p>
41+
* </li>
42+
* </ul>
43+
* <p>Privacy settings impact this action as follows:</p>
44+
* <ul>
45+
* <li>
46+
* <p>Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.</p>
47+
* </li>
48+
* <li>
49+
* <p>Private Channels: You must be a member to list or send messages.</p>
50+
* </li>
51+
* </ul>
52+
*/
2353
export class CreateChannelMembershipCommand extends $Command<
2454
CreateChannelMembershipCommandInput,
2555
CreateChannelMembershipCommandOutput,
@@ -34,6 +64,9 @@ export class CreateChannelMembershipCommand extends $Command<
3464
// End section: command_constructor
3565
}
3666

67+
/**
68+
* @internal
69+
*/
3770
resolveMiddleware(
3871
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3972
configuration: ChimeClientResolvedConfig,

Diff for: ‎clients/client-chime/commands/CreateChannelModeratorCommand.ts

+23
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,26 @@ import {
2020
export type CreateChannelModeratorCommandInput = CreateChannelModeratorRequest;
2121
export type CreateChannelModeratorCommandOutput = CreateChannelModeratorResponse & __MetadataBearer;
2222

23+
/**
24+
* <p>Creates a new <code>ChannelModerator</code>. A channel moderator can:</p>
25+
* <ul>
26+
* <li>
27+
* <p>Add and remove other members of the channel.</p>
28+
* </li>
29+
* <li>
30+
* <p>Add and remove other moderators of the channel.</p>
31+
* </li>
32+
* <li>
33+
* <p>Add and remove user bans for the channel.</p>
34+
* </li>
35+
* <li>
36+
* <p>Redact messages in the channel.</p>
37+
* </li>
38+
* <li>
39+
* <p>List messages in the channel.</p>
40+
* </li>
41+
* </ul>
42+
*/
2343
export class CreateChannelModeratorCommand extends $Command<
2444
CreateChannelModeratorCommandInput,
2545
CreateChannelModeratorCommandOutput,
@@ -34,6 +54,9 @@ export class CreateChannelModeratorCommand extends $Command<
3454
// End section: command_constructor
3555
}
3656

57+
/**
58+
* @internal
59+
*/
3760
resolveMiddleware(
3861
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3962
configuration: ChimeClientResolvedConfig,

Diff for: ‎clients/client-chime/commands/DeleteAppInstanceAdminCommand.ts

+6
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ import {
2020
export type DeleteAppInstanceAdminCommandInput = DeleteAppInstanceAdminRequest;
2121
export type DeleteAppInstanceAdminCommandOutput = __MetadataBearer;
2222

23+
/**
24+
* <p>Demotes an <code>AppInstanceAdmin</code> to an <code>AppInstanceUser</code>. This action does not delete the user.</p>
25+
*/
2326
export class DeleteAppInstanceAdminCommand extends $Command<
2427
DeleteAppInstanceAdminCommandInput,
2528
DeleteAppInstanceAdminCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteAppInstanceAdminCommand extends $Command<
3437
// End section: command_constructor
3538
}
3639

40+
/**
41+
* @internal
42+
*/
3743
resolveMiddleware(
3844
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3945
configuration: ChimeClientResolvedConfig,

Diff for: ‎clients/client-chime/commands/DeleteAppInstanceCommand.ts

+6
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ import {
2020
export type DeleteAppInstanceCommandInput = DeleteAppInstanceRequest;
2121
export type DeleteAppInstanceCommandOutput = __MetadataBearer;
2222

23+
/**
24+
* <p>Deletes an <code>AppInstance</code> and all associated data asynchronously.</p>
25+
*/
2326
export class DeleteAppInstanceCommand extends $Command<
2427
DeleteAppInstanceCommandInput,
2528
DeleteAppInstanceCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteAppInstanceCommand extends $Command<
3437
// End section: command_constructor
3538
}
3639

40+
/**
41+
* @internal
42+
*/
3743
resolveMiddleware(
3844
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3945
configuration: ChimeClientResolvedConfig,

Diff for: ‎clients/client-chime/commands/DeleteAppInstanceStreamingConfigurationsCommand.ts

+6
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ import {
2020
export type DeleteAppInstanceStreamingConfigurationsCommandInput = DeleteAppInstanceStreamingConfigurationsRequest;
2121
export type DeleteAppInstanceStreamingConfigurationsCommandOutput = __MetadataBearer;
2222

23+
/**
24+
* <p>Deletes the streaming configurations of an app instance.</p>
25+
*/
2326
export class DeleteAppInstanceStreamingConfigurationsCommand extends $Command<
2427
DeleteAppInstanceStreamingConfigurationsCommandInput,
2528
DeleteAppInstanceStreamingConfigurationsCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteAppInstanceStreamingConfigurationsCommand extends $Command<
3437
// End section: command_constructor
3538
}
3639

40+
/**
41+
* @internal
42+
*/
3743
resolveMiddleware(
3844
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3945
configuration: ChimeClientResolvedConfig,

Diff for: ‎clients/client-chime/commands/DeleteAppInstanceUserCommand.ts

+6
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ import {
2020
export type DeleteAppInstanceUserCommandInput = DeleteAppInstanceUserRequest;
2121
export type DeleteAppInstanceUserCommandOutput = __MetadataBearer;
2222

23+
/**
24+
* <p>Deletes an <code>AppInstanceUser</code>.</p>
25+
*/
2326
export class DeleteAppInstanceUserCommand extends $Command<
2427
DeleteAppInstanceUserCommandInput,
2528
DeleteAppInstanceUserCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteAppInstanceUserCommand extends $Command<
3437
// End section: command_constructor
3538
}
3639

40+
/**
41+
* @internal
42+
*/
3743
resolveMiddleware(
3844
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3945
configuration: ChimeClientResolvedConfig,

Diff for: ‎clients/client-chime/commands/DeleteChannelBanCommand.ts

+6
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ import {
2020
export type DeleteChannelBanCommandInput = DeleteChannelBanRequest;
2121
export type DeleteChannelBanCommandOutput = __MetadataBearer;
2222

23+
/**
24+
* <p>Removes a user from a channel's ban list.</p>
25+
*/
2326
export class DeleteChannelBanCommand extends $Command<
2427
DeleteChannelBanCommandInput,
2528
DeleteChannelBanCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteChannelBanCommand extends $Command<
3437
// End section: command_constructor
3538
}
3639

40+
/**
41+
* @internal
42+
*/
3743
resolveMiddleware(
3844
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3945
configuration: ChimeClientResolvedConfig,

Diff for: ‎clients/client-chime/commands/DeleteChannelCommand.ts

+6
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ import {
2020
export type DeleteChannelCommandInput = DeleteChannelRequest;
2121
export type DeleteChannelCommandOutput = __MetadataBearer;
2222

23+
/**
24+
* <p>Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.</p>
25+
*/
2326
export class DeleteChannelCommand extends $Command<
2427
DeleteChannelCommandInput,
2528
DeleteChannelCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteChannelCommand extends $Command<
3437
// End section: command_constructor
3538
}
3639

40+
/**
41+
* @internal
42+
*/
3743
resolveMiddleware(
3844
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3945
configuration: ChimeClientResolvedConfig,

Diff for: ‎clients/client-chime/commands/DeleteChannelMembershipCommand.ts

+6
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ import {
2020
export type DeleteChannelMembershipCommandInput = DeleteChannelMembershipRequest;
2121
export type DeleteChannelMembershipCommandOutput = __MetadataBearer;
2222

23+
/**
24+
* <p>Removes a member from a channel.</p>
25+
*/
2326
export class DeleteChannelMembershipCommand extends $Command<
2427
DeleteChannelMembershipCommandInput,
2528
DeleteChannelMembershipCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteChannelMembershipCommand extends $Command<
3437
// End section: command_constructor
3538
}
3639

40+
/**
41+
* @internal
42+
*/
3743
resolveMiddleware(
3844
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3945
configuration: ChimeClientResolvedConfig,

Diff for: ‎clients/client-chime/commands/DeleteChannelMessageCommand.ts

+7
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ import {
2020
export type DeleteChannelMessageCommandInput = DeleteChannelMessageRequest;
2121
export type DeleteChannelMessageCommandOutput = __MetadataBearer;
2222

23+
/**
24+
* <p>Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A
25+
* background process deletes any revisions created by <code>UpdateChannelMessage</code>.</p>
26+
*/
2327
export class DeleteChannelMessageCommand extends $Command<
2428
DeleteChannelMessageCommandInput,
2529
DeleteChannelMessageCommandOutput,
@@ -34,6 +38,9 @@ export class DeleteChannelMessageCommand extends $Command<
3438
// End section: command_constructor
3539
}
3640

41+
/**
42+
* @internal
43+
*/
3744
resolveMiddleware(
3845
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3946
configuration: ChimeClientResolvedConfig,

Diff for: ‎clients/client-chime/commands/DeleteChannelModeratorCommand.ts

+6
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ import {
2020
export type DeleteChannelModeratorCommandInput = DeleteChannelModeratorRequest;
2121
export type DeleteChannelModeratorCommandOutput = __MetadataBearer;
2222

23+
/**
24+
* <p>Deletes a channel moderator.</p>
25+
*/
2326
export class DeleteChannelModeratorCommand extends $Command<
2427
DeleteChannelModeratorCommandInput,
2528
DeleteChannelModeratorCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteChannelModeratorCommand extends $Command<
3437
// End section: command_constructor
3538
}
3639

40+
/**
41+
* @internal
42+
*/
3743
resolveMiddleware(
3844
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3945
configuration: ChimeClientResolvedConfig,

0 commit comments

Comments
 (0)