@aws-sdk/client-chime 3.315.0 → 3.317.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/README.md +5 -10
- package/dist-cjs/Chime.js +195 -2674
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +8 -8
- package/dist-es/Chime.js +195 -2674
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +8 -8
- package/dist-types/Chime.d.ts +231 -913
- package/dist-types/ChimeClient.d.ts +17 -22
- package/dist-types/commands/BatchCreateAttendeeCommand.d.ts +2 -2
- package/dist-types/commands/BatchCreateChannelMembershipCommand.d.ts +1 -1
- package/dist-types/commands/BatchCreateRoomMembershipCommand.d.ts +1 -1
- package/dist-types/commands/BatchDeletePhoneNumberCommand.d.ts +0 -1
- package/dist-types/commands/BatchSuspendUserCommand.d.ts +0 -3
- package/dist-types/commands/BatchUnsuspendUserCommand.d.ts +0 -1
- package/dist-types/commands/BatchUpdatePhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/BatchUpdateUserCommand.d.ts +2 -2
- package/dist-types/commands/CreateAppInstanceAdminCommand.d.ts +0 -2
- package/dist-types/commands/CreateAttendeeCommand.d.ts +2 -2
- package/dist-types/commands/CreateChannelBanCommand.d.ts +0 -1
- package/dist-types/commands/CreateChannelCommand.d.ts +2 -4
- package/dist-types/commands/CreateChannelMembershipCommand.d.ts +1 -5
- package/dist-types/commands/CreateChannelModeratorCommand.d.ts +0 -2
- package/dist-types/commands/CreateMediaCapturePipelineCommand.d.ts +7 -7
- package/dist-types/commands/CreateMeetingCommand.d.ts +4 -4
- package/dist-types/commands/CreateMeetingDialOutCommand.d.ts +0 -1
- package/dist-types/commands/CreateMeetingWithAttendeesCommand.d.ts +4 -4
- package/dist-types/commands/CreatePhoneNumberOrderCommand.d.ts +1 -1
- package/dist-types/commands/CreateProxySessionCommand.d.ts +3 -3
- package/dist-types/commands/CreateRoomMembershipCommand.d.ts +1 -1
- package/dist-types/commands/CreateSipRuleCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserCommand.d.ts +1 -1
- package/dist-types/commands/CreateVoiceConnectorCommand.d.ts +1 -2
- package/dist-types/commands/DeleteAccountCommand.d.ts +0 -3
- package/dist-types/commands/DeleteAttendeeCommand.d.ts +2 -2
- package/dist-types/commands/DeleteChannelBanCommand.d.ts +0 -1
- package/dist-types/commands/DeleteChannelCommand.d.ts +0 -1
- package/dist-types/commands/DeleteChannelMembershipCommand.d.ts +0 -1
- package/dist-types/commands/DeleteChannelMessageCommand.d.ts +0 -1
- package/dist-types/commands/DeleteChannelModeratorCommand.d.ts +0 -1
- package/dist-types/commands/DeleteMeetingCommand.d.ts +2 -2
- package/dist-types/commands/DeletePhoneNumberCommand.d.ts +0 -1
- package/dist-types/commands/DeleteVoiceConnectorOriginationCommand.d.ts +0 -1
- package/dist-types/commands/DeleteVoiceConnectorTerminationCommand.d.ts +0 -1
- package/dist-types/commands/DescribeChannelBanCommand.d.ts +0 -2
- package/dist-types/commands/DescribeChannelCommand.d.ts +0 -2
- package/dist-types/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts +0 -1
- package/dist-types/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts +0 -1
- package/dist-types/commands/GetAttendeeCommand.d.ts +2 -2
- package/dist-types/commands/GetChannelMessageCommand.d.ts +0 -1
- package/dist-types/commands/GetMeetingCommand.d.ts +2 -2
- package/dist-types/commands/GetUserCommand.d.ts +0 -1
- package/dist-types/commands/InviteUsersCommand.d.ts +1 -1
- package/dist-types/commands/ListAttendeesCommand.d.ts +2 -2
- package/dist-types/commands/ListChannelBansCommand.d.ts +0 -2
- package/dist-types/commands/ListChannelMembershipsCommand.d.ts +1 -3
- package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +0 -1
- package/dist-types/commands/ListChannelMessagesCommand.d.ts +1 -1
- package/dist-types/commands/ListChannelsCommand.d.ts +1 -3
- package/dist-types/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts +0 -1
- package/dist-types/commands/ListMeetingsCommand.d.ts +2 -2
- package/dist-types/commands/ListPhoneNumbersCommand.d.ts +3 -3
- package/dist-types/commands/ListProxySessionsCommand.d.ts +1 -1
- package/dist-types/commands/ListSupportedPhoneNumberCountriesCommand.d.ts +1 -1
- package/dist-types/commands/ListUsersCommand.d.ts +1 -1
- package/dist-types/commands/PutAppInstanceStreamingConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/PutRetentionSettingsCommand.d.ts +0 -1
- package/dist-types/commands/PutVoiceConnectorOriginationCommand.d.ts +1 -2
- package/dist-types/commands/PutVoiceConnectorStreamingConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutVoiceConnectorTerminationCommand.d.ts +0 -1
- package/dist-types/commands/RedactChannelMessageCommand.d.ts +0 -1
- package/dist-types/commands/SearchAvailablePhoneNumbersCommand.d.ts +1 -1
- package/dist-types/commands/SendChannelMessageCommand.d.ts +2 -4
- package/dist-types/commands/StartMeetingTranscriptionCommand.d.ts +27 -12
- package/dist-types/commands/UpdateAccountCommand.d.ts +1 -1
- package/dist-types/commands/UpdateChannelCommand.d.ts +1 -1
- package/dist-types/commands/UpdateChannelMessageCommand.d.ts +0 -1
- package/dist-types/commands/UpdateChannelReadMarkerCommand.d.ts +0 -1
- package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/UpdateProxySessionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRoomMembershipCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserCommand.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +89 -30
- package/dist-types/models/models_1.d.ts +7 -6
- package/dist-types/ts3.4/Chime.d.ts +2 -1
- package/dist-types/ts3.4/models/models_0.d.ts +8 -1
- package/package.json +6 -6
|
@@ -334,45 +334,40 @@ export interface ChimeClientResolvedConfig extends ChimeClientResolvedConfigType
|
|
|
334
334
|
}
|
|
335
335
|
/**
|
|
336
336
|
* @public
|
|
337
|
-
* <p>The Amazon Chime
|
|
337
|
+
* <p>The Amazon Chime application programming interface (API) is designed so administrators can
|
|
338
338
|
* perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice
|
|
339
339
|
* Connectors. This guide provides detailed information about the Amazon Chime API,
|
|
340
|
-
* including operations, types, inputs and outputs, and error codes
|
|
341
|
-
*
|
|
342
|
-
*
|
|
343
|
-
* </a> in the <i>Amazon Chime Developer Guide</i>.</p>
|
|
344
|
-
* <p>You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the
|
|
345
|
-
* AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.</p>
|
|
340
|
+
* including operations, types, inputs and outputs, and error codes.</p>
|
|
341
|
+
* <p>You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the
|
|
342
|
+
* AWS CLI. The page for each API action contains a <i>See Also</i> section that includes links to information about using the action with a language-specific AWS SDK or the AWS CLI.</p>
|
|
346
343
|
* <dl>
|
|
347
344
|
* <dt>Using an AWS SDK</dt>
|
|
348
345
|
* <dd>
|
|
349
346
|
* <p>
|
|
350
|
-
*
|
|
351
|
-
*
|
|
352
|
-
*
|
|
347
|
+
* You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the
|
|
348
|
+
* <a href="http://aws.amazon.com/developer/">AWS Developer Center</a>.
|
|
349
|
+
* </p>
|
|
353
350
|
* </dd>
|
|
354
351
|
* <dt>Using the AWS CLI</dt>
|
|
355
352
|
* <dd>
|
|
356
353
|
* <p>Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see
|
|
357
|
-
*
|
|
358
|
-
*
|
|
359
|
-
*
|
|
360
|
-
*
|
|
361
|
-
*
|
|
354
|
+
* <a href="https://docs.aws.amazon.com/cli/latest/userguide/installing.html">Installing the AWS Command Line Interface</a>
|
|
355
|
+
* in the <i>AWS Command Line Interface User Guide</i>. For a list of available Amazon Chime commands, see the
|
|
356
|
+
* <a href="https://docs.aws.amazon.com/cli/latest/reference/chime/index.html">Amazon Chime commands</a> in the
|
|
357
|
+
* <i>AWS CLI Command Reference</i>.
|
|
358
|
+
* </p>
|
|
362
359
|
* </dd>
|
|
363
360
|
* <dt>Using REST APIs</dt>
|
|
364
361
|
* <dd>
|
|
365
|
-
* <p>If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports
|
|
366
|
-
*
|
|
367
|
-
*
|
|
368
|
-
*
|
|
362
|
+
* <p>If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports Signature Version 4. For more information, see
|
|
363
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>
|
|
364
|
+
* in the <i>Amazon Web Services General Reference</i>.</p>
|
|
369
365
|
* <p>When making REST API calls, use the service name <code>chime</code> and REST endpoint <code>https://service.chime.aws.amazon.com</code>.</p>
|
|
370
366
|
* </dd>
|
|
371
367
|
* </dl>
|
|
372
|
-
*
|
|
373
368
|
* <p>Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see
|
|
374
|
-
*
|
|
375
|
-
*
|
|
369
|
+
* <a href="https://docs.aws.amazon.com/chime/latest/ag/security-iam.html">Identity and Access Management for Amazon Chime</a>
|
|
370
|
+
* in the <i>Amazon Chime Administration Guide</i>.</p>
|
|
376
371
|
*/
|
|
377
372
|
export declare class ChimeClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ChimeClientResolvedConfig> {
|
|
378
373
|
/**
|
|
@@ -21,9 +21,9 @@ export interface BatchCreateAttendeeCommandOutput extends BatchCreateAttendeeRes
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>
|
|
23
23
|
* Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see
|
|
24
|
-
* <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
|
|
24
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
|
|
25
25
|
* in the
|
|
26
|
-
* <i>Amazon Chime Developer Guide</i>.
|
|
26
|
+
* <i>Amazon Chime SDK Developer Guide</i>.
|
|
27
27
|
* </p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -28,7 +28,7 @@ export interface BatchCreateChannelMembershipCommandOutput extends BatchCreateCh
|
|
|
28
28
|
* const client = new ChimeClient(config);
|
|
29
29
|
* const input = { // BatchCreateChannelMembershipRequest
|
|
30
30
|
* ChannelArn: "STRING_VALUE", // required
|
|
31
|
-
* Type: "
|
|
31
|
+
* Type: "DEFAULT" || "HIDDEN",
|
|
32
32
|
* MemberArns: [ // MemberArns // required
|
|
33
33
|
* "STRING_VALUE",
|
|
34
34
|
* ],
|
|
@@ -32,7 +32,7 @@ export interface BatchCreateRoomMembershipCommandOutput extends BatchCreateRoomM
|
|
|
32
32
|
* MembershipItemList: [ // MembershipItemList // required
|
|
33
33
|
* { // MembershipItem
|
|
34
34
|
* MemberId: "STRING_VALUE",
|
|
35
|
-
* Role: "
|
|
35
|
+
* Role: "Administrator" || "Member",
|
|
36
36
|
* },
|
|
37
37
|
* ],
|
|
38
38
|
* };
|
|
@@ -23,7 +23,6 @@ export interface BatchDeletePhoneNumberCommandOutput extends BatchDeletePhoneNum
|
|
|
23
23
|
* Moves phone numbers into the
|
|
24
24
|
* <b>Deletion queue</b>. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.
|
|
25
25
|
* </p>
|
|
26
|
-
*
|
|
27
26
|
* <p>
|
|
28
27
|
* Phone numbers remain in the
|
|
29
28
|
* <b>Deletion queue</b> for 7 days before they are deleted permanently.
|
|
@@ -22,15 +22,12 @@ export interface BatchSuspendUserCommandOutput extends BatchSuspendUserResponse,
|
|
|
22
22
|
* <p>Suspends up to 50 users from a <code>Team</code> or <code>EnterpriseLWA</code> Amazon Chime
|
|
23
23
|
* account. For more information about different account types, see <a href="https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration
|
|
24
24
|
* Guide</i>.</p>
|
|
25
|
-
*
|
|
26
25
|
* <p>Users suspended from a <code>Team</code> account are disassociated from the account,but they
|
|
27
26
|
* can continue to use Amazon Chime as free users. To remove the suspension from suspended
|
|
28
27
|
* <code>Team</code> account users, invite them to the <code>Team</code> account again.
|
|
29
28
|
* You can use the <a>InviteUsers</a> action to do so.</p>
|
|
30
|
-
*
|
|
31
29
|
* <p>Users suspended from an <code>EnterpriseLWA</code> account are immediately signed out of
|
|
32
30
|
* Amazon Chime and can no longer sign in. To remove the suspension from suspended <code>EnterpriseLWA</code> account users, use the <a>BatchUnsuspendUser</a> action.</p>
|
|
33
|
-
*
|
|
34
31
|
* <p>
|
|
35
32
|
* To sign out users without suspending them, use the
|
|
36
33
|
* <a>LogoutUser</a>
|
|
@@ -26,7 +26,6 @@ export interface BatchUnsuspendUserCommandOutput extends BatchUnsuspendUserRespo
|
|
|
26
26
|
* Managing Your Amazon Chime Accounts
|
|
27
27
|
* </a> in the account types, in the <i>Amazon Chime Administration Guide</i>.
|
|
28
28
|
* </p>
|
|
29
|
-
*
|
|
30
29
|
* <p>
|
|
31
30
|
* Previously suspended users who are unsuspended using this action are returned to
|
|
32
31
|
* <code>Registered</code>
|
|
@@ -32,7 +32,7 @@ export interface BatchUpdatePhoneNumberCommandOutput extends BatchUpdatePhoneNum
|
|
|
32
32
|
* UpdatePhoneNumberRequestItems: [ // UpdatePhoneNumberRequestItemList // required
|
|
33
33
|
* { // UpdatePhoneNumberRequestItem
|
|
34
34
|
* PhoneNumberId: "STRING_VALUE", // required
|
|
35
|
-
* ProductType: "
|
|
35
|
+
* ProductType: "BusinessCalling" || "VoiceConnector" || "SipMediaApplicationDialIn",
|
|
36
36
|
* CallingName: "STRING_VALUE",
|
|
37
37
|
* },
|
|
38
38
|
* ],
|
|
@@ -31,8 +31,8 @@ export interface BatchUpdateUserCommandOutput extends BatchUpdateUserResponse, _
|
|
|
31
31
|
* UpdateUserRequestItems: [ // UpdateUserRequestItemList // required
|
|
32
32
|
* { // UpdateUserRequestItem
|
|
33
33
|
* UserId: "STRING_VALUE", // required
|
|
34
|
-
* LicenseType: "
|
|
35
|
-
* UserType: "
|
|
34
|
+
* LicenseType: "Basic" || "Plus" || "Pro" || "ProTrial",
|
|
35
|
+
* UserType: "PrivateUser" || "SharedDevice",
|
|
36
36
|
* AlexaForBusinessMetadata: { // AlexaForBusinessMetadata
|
|
37
37
|
* IsAlexaForBusinessEnabled: true || false,
|
|
38
38
|
* AlexaForBusinessRoomArn: "STRING_VALUE",
|
|
@@ -21,7 +21,6 @@ export interface CreateAppInstanceAdminCommandOutput extends CreateAppInstanceAd
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Promotes an <code>AppInstanceUser</code> to an <code>AppInstanceAdmin</code>. The promoted user can perform the following actions.
|
|
23
23
|
* </p>
|
|
24
|
-
*
|
|
25
24
|
* <ul>
|
|
26
25
|
* <li>
|
|
27
26
|
* <p>
|
|
@@ -32,7 +31,6 @@ export interface CreateAppInstanceAdminCommandOutput extends CreateAppInstanceAd
|
|
|
32
31
|
* <code>DeleteChannelMessage</code> actions.</p>
|
|
33
32
|
* </li>
|
|
34
33
|
* </ul>
|
|
35
|
-
*
|
|
36
34
|
* <p>Only an <code>AppInstanceUser</code> can be promoted to an <code>AppInstanceAdmin</code> role.</p>
|
|
37
35
|
* @example
|
|
38
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -21,9 +21,9 @@ export interface CreateAttendeeCommandOutput extends CreateAttendeeResponse, __M
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>
|
|
23
23
|
* Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see
|
|
24
|
-
* <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
|
|
24
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
|
|
25
25
|
* in the
|
|
26
|
-
* <i>Amazon Chime Developer Guide</i>.
|
|
26
|
+
* <i>Amazon Chime SDK Developer Guide</i>.
|
|
27
27
|
* </p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -25,7 +25,6 @@ export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse,
|
|
|
25
25
|
* channels.</p>
|
|
26
26
|
* <p>If you ban a user who is already part of a channel, that user is automatically kicked
|
|
27
27
|
* from the channel.</p>
|
|
28
|
-
*
|
|
29
28
|
* <note>
|
|
30
29
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
31
30
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -20,11 +20,9 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Creates a channel to which you can add users and send messages.</p>
|
|
23
|
-
*
|
|
24
23
|
* <p>
|
|
25
24
|
* <b>Restriction</b>: You can't change a channel's
|
|
26
25
|
* privacy.</p>
|
|
27
|
-
*
|
|
28
26
|
* <note>
|
|
29
27
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
30
28
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -39,8 +37,8 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
|
|
|
39
37
|
* const input = { // CreateChannelRequest
|
|
40
38
|
* AppInstanceArn: "STRING_VALUE", // required
|
|
41
39
|
* Name: "STRING_VALUE", // required
|
|
42
|
-
* Mode: "
|
|
43
|
-
* Privacy: "
|
|
40
|
+
* Mode: "UNRESTRICTED" || "RESTRICTED",
|
|
41
|
+
* Privacy: "PUBLIC" || "PRIVATE",
|
|
44
42
|
* Metadata: "STRING_VALUE",
|
|
45
43
|
* ClientRequestToken: "STRING_VALUE", // required
|
|
46
44
|
* Tags: [ // TagList
|
|
@@ -21,7 +21,6 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Adds a user to a channel. The <code>InvitedBy</code> response field is derived from the
|
|
23
23
|
* request header. A channel member can:</p>
|
|
24
|
-
*
|
|
25
24
|
* <ul>
|
|
26
25
|
* <li>
|
|
27
26
|
* <p>List messages</p>
|
|
@@ -39,9 +38,7 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
|
|
|
39
38
|
* <p>Leave the channel</p>
|
|
40
39
|
* </li>
|
|
41
40
|
* </ul>
|
|
42
|
-
*
|
|
43
41
|
* <p>Privacy settings impact this action as follows:</p>
|
|
44
|
-
*
|
|
45
42
|
* <ul>
|
|
46
43
|
* <li>
|
|
47
44
|
* <p>Public Channels: You do not need to be a member to list messages, but you must be
|
|
@@ -51,7 +48,6 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
|
|
|
51
48
|
* <p>Private Channels: You must be a member to list or send messages.</p>
|
|
52
49
|
* </li>
|
|
53
50
|
* </ul>
|
|
54
|
-
*
|
|
55
51
|
* <note>
|
|
56
52
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
57
53
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -66,7 +62,7 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
|
|
|
66
62
|
* const input = { // CreateChannelMembershipRequest
|
|
67
63
|
* ChannelArn: "STRING_VALUE", // required
|
|
68
64
|
* MemberArn: "STRING_VALUE", // required
|
|
69
|
-
* Type: "
|
|
65
|
+
* Type: "DEFAULT" || "HIDDEN", // required
|
|
70
66
|
* ChimeBearer: "STRING_VALUE",
|
|
71
67
|
* };
|
|
72
68
|
* const command = new CreateChannelMembershipCommand(input);
|
|
@@ -20,7 +20,6 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Creates a new <code>ChannelModerator</code>. A channel moderator can:</p>
|
|
23
|
-
*
|
|
24
23
|
* <ul>
|
|
25
24
|
* <li>
|
|
26
25
|
* <p>Add and remove other members of the channel.</p>
|
|
@@ -38,7 +37,6 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera
|
|
|
38
37
|
* <p>List messages in the channel.</p>
|
|
39
38
|
* </li>
|
|
40
39
|
* </ul>
|
|
41
|
-
*
|
|
42
40
|
* <note>
|
|
43
41
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
44
42
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -27,9 +27,9 @@ export interface CreateMediaCapturePipelineCommandOutput extends CreateMediaCapt
|
|
|
27
27
|
* // const { ChimeClient, CreateMediaCapturePipelineCommand } = require("@aws-sdk/client-chime"); // CommonJS import
|
|
28
28
|
* const client = new ChimeClient(config);
|
|
29
29
|
* const input = { // CreateMediaCapturePipelineRequest
|
|
30
|
-
* SourceType: "
|
|
30
|
+
* SourceType: "ChimeSdkMeeting", // required
|
|
31
31
|
* SourceArn: "STRING_VALUE", // required
|
|
32
|
-
* SinkType: "
|
|
32
|
+
* SinkType: "S3Bucket", // required
|
|
33
33
|
* SinkArn: "STRING_VALUE", // required
|
|
34
34
|
* ClientRequestToken: "STRING_VALUE",
|
|
35
35
|
* ChimeSdkMeetingConfiguration: { // ChimeSdkMeetingConfiguration
|
|
@@ -45,15 +45,15 @@ export interface CreateMediaCapturePipelineCommandOutput extends CreateMediaCapt
|
|
|
45
45
|
* },
|
|
46
46
|
* ArtifactsConfiguration: { // ArtifactsConfiguration
|
|
47
47
|
* Audio: { // AudioArtifactsConfiguration
|
|
48
|
-
* MuxType: "
|
|
48
|
+
* MuxType: "AudioOnly" || "AudioWithActiveSpeakerVideo", // required
|
|
49
49
|
* },
|
|
50
50
|
* Video: { // VideoArtifactsConfiguration
|
|
51
|
-
* State: "
|
|
52
|
-
* MuxType: "
|
|
51
|
+
* State: "Enabled" || "Disabled", // required
|
|
52
|
+
* MuxType: "VideoOnly",
|
|
53
53
|
* },
|
|
54
54
|
* Content: { // ContentArtifactsConfiguration
|
|
55
|
-
* State: "
|
|
56
|
-
* MuxType: "
|
|
55
|
+
* State: "Enabled" || "Disabled", // required
|
|
56
|
+
* MuxType: "ContentOnly",
|
|
57
57
|
* },
|
|
58
58
|
* },
|
|
59
59
|
* },
|
|
@@ -21,13 +21,13 @@ export interface CreateMeetingCommandOutput extends CreateMeetingResponse, __Met
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>
|
|
23
23
|
* Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see
|
|
24
|
-
* <a href="https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html">Amazon Chime SDK Media Regions</a>
|
|
24
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/chime-sdk-meetings-regions.html">Amazon Chime SDK Media Regions</a>
|
|
25
25
|
* in the
|
|
26
|
-
* <i>Amazon Chime Developer Guide</i>
|
|
26
|
+
* <i>Amazon Chime SDK Developer Guide</i>
|
|
27
27
|
* . For more information about the Amazon Chime SDK, see
|
|
28
|
-
* <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
|
|
28
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
|
|
29
29
|
* in the
|
|
30
|
-
* <i>Amazon Chime Developer Guide</i>
|
|
30
|
+
* <i>Amazon Chime SDK Developer Guide</i>
|
|
31
31
|
* .
|
|
32
32
|
* </p>
|
|
33
33
|
* @example
|
|
@@ -21,7 +21,6 @@ export interface CreateMeetingDialOutCommandOutput extends CreateMeetingDialOutR
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public
|
|
23
23
|
* switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.</p>
|
|
24
|
-
*
|
|
25
24
|
* <p>To play welcome audio or implement an interactive voice response (IVR), use the
|
|
26
25
|
* <code>CreateSipMediaApplicationCall</code> action with the corresponding SIP media application ID.</p>
|
|
27
26
|
* @example
|
|
@@ -21,13 +21,13 @@ export interface CreateMeetingWithAttendeesCommandOutput extends CreateMeetingWi
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>
|
|
23
23
|
* Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see
|
|
24
|
-
* <a href="https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html">Amazon Chime SDK Media Regions</a>
|
|
24
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/chime-sdk-meetings-regions.html">Amazon Chime SDK Media Regions</a>
|
|
25
25
|
* in the
|
|
26
|
-
* <i>Amazon Chime Developer Guide</i>
|
|
26
|
+
* <i>Amazon Chime SDK Developer Guide</i>
|
|
27
27
|
* . For more information about the Amazon Chime SDK, see
|
|
28
|
-
* <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
|
|
28
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
|
|
29
29
|
* in the
|
|
30
|
-
* <i>Amazon Chime Developer Guide</i>
|
|
30
|
+
* <i>Amazon Chime SDK Developer Guide</i>
|
|
31
31
|
* .
|
|
32
32
|
* </p>
|
|
33
33
|
* @example
|
|
@@ -28,7 +28,7 @@ export interface CreatePhoneNumberOrderCommandOutput extends CreatePhoneNumberOr
|
|
|
28
28
|
* // const { ChimeClient, CreatePhoneNumberOrderCommand } = require("@aws-sdk/client-chime"); // CommonJS import
|
|
29
29
|
* const client = new ChimeClient(config);
|
|
30
30
|
* const input = { // CreatePhoneNumberOrderRequest
|
|
31
|
-
* ProductType: "
|
|
31
|
+
* ProductType: "BusinessCalling" || "VoiceConnector" || "SipMediaApplicationDialIn", // required
|
|
32
32
|
* E164PhoneNumbers: [ // E164PhoneNumberList // required
|
|
33
33
|
* "STRING_VALUE",
|
|
34
34
|
* ],
|
|
@@ -34,10 +34,10 @@ export interface CreateProxySessionCommandOutput extends CreateProxySessionRespo
|
|
|
34
34
|
* Name: "STRING_VALUE",
|
|
35
35
|
* ExpiryMinutes: Number("int"),
|
|
36
36
|
* Capabilities: [ // CapabilityList // required
|
|
37
|
-
* "
|
|
37
|
+
* "Voice" || "SMS",
|
|
38
38
|
* ],
|
|
39
|
-
* NumberSelectionBehavior: "
|
|
40
|
-
* GeoMatchLevel: "
|
|
39
|
+
* NumberSelectionBehavior: "PreferSticky" || "AvoidSticky",
|
|
40
|
+
* GeoMatchLevel: "Country" || "AreaCode",
|
|
41
41
|
* GeoMatchParams: { // GeoMatchParams
|
|
42
42
|
* Country: "STRING_VALUE", // required
|
|
43
43
|
* AreaCode: "STRING_VALUE", // required
|
|
@@ -30,7 +30,7 @@ export interface CreateRoomMembershipCommandOutput extends CreateRoomMembershipR
|
|
|
30
30
|
* AccountId: "STRING_VALUE", // required
|
|
31
31
|
* RoomId: "STRING_VALUE", // required
|
|
32
32
|
* MemberId: "STRING_VALUE", // required
|
|
33
|
-
* Role: "
|
|
33
|
+
* Role: "Administrator" || "Member",
|
|
34
34
|
* };
|
|
35
35
|
* const command = new CreateRoomMembershipCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
@@ -28,7 +28,7 @@ export interface CreateSipRuleCommandOutput extends CreateSipRuleResponse, __Met
|
|
|
28
28
|
* const client = new ChimeClient(config);
|
|
29
29
|
* const input = { // CreateSipRuleRequest
|
|
30
30
|
* Name: "STRING_VALUE", // required
|
|
31
|
-
* TriggerType: "
|
|
31
|
+
* TriggerType: "ToPhoneNumber" || "RequestUriHostname", // required
|
|
32
32
|
* TriggerValue: "STRING_VALUE", // required
|
|
33
33
|
* Disabled: true || false,
|
|
34
34
|
* TargetApplications: [ // SipRuleTargetApplicationList // required
|
|
@@ -30,7 +30,7 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
|
|
|
30
30
|
* AccountId: "STRING_VALUE", // required
|
|
31
31
|
* Username: "STRING_VALUE",
|
|
32
32
|
* Email: "STRING_VALUE",
|
|
33
|
-
* UserType: "
|
|
33
|
+
* UserType: "PrivateUser" || "SharedDevice",
|
|
34
34
|
* };
|
|
35
35
|
* const command = new CreateUserCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
@@ -20,7 +20,6 @@ export interface CreateVoiceConnectorCommandOutput extends CreateVoiceConnectorR
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.</p>
|
|
23
|
-
*
|
|
24
23
|
* <p>
|
|
25
24
|
* Enabling
|
|
26
25
|
* <a>CreateVoiceConnectorRequest$RequireEncryption</a>
|
|
@@ -34,7 +33,7 @@ export interface CreateVoiceConnectorCommandOutput extends CreateVoiceConnectorR
|
|
|
34
33
|
* const client = new ChimeClient(config);
|
|
35
34
|
* const input = { // CreateVoiceConnectorRequest
|
|
36
35
|
* Name: "STRING_VALUE", // required
|
|
37
|
-
* AwsRegion: "
|
|
36
|
+
* AwsRegion: "us-east-1" || "us-west-2",
|
|
38
37
|
* RequireEncryption: true || false, // required
|
|
39
38
|
* };
|
|
40
39
|
* const command = new CreateVoiceConnectorCommand(input);
|
|
@@ -22,15 +22,12 @@ export interface DeleteAccountCommandOutput extends DeleteAccountResponse, __Met
|
|
|
22
22
|
* <p>Deletes the specified Amazon Chime account. You must suspend all users before deleting
|
|
23
23
|
* <code>Team</code> account. You can use the <a>BatchSuspendUser</a> action
|
|
24
24
|
* to dodo.</p>
|
|
25
|
-
*
|
|
26
25
|
* <p>For <code>EnterpriseLWA</code> and <code>EnterpriseAD</code> accounts, you must release the
|
|
27
26
|
* claimed domains for your Amazon Chime account before deletion. As soon as you release
|
|
28
27
|
* the domain, all users under that account are suspended.</p>
|
|
29
|
-
*
|
|
30
28
|
* <p>Deleted accounts appear in your <code>Disabled</code> accounts list for 90 days. To restore
|
|
31
29
|
* deleted account from your <code>Disabled</code> accounts list, you must contact AWS
|
|
32
30
|
* Support.</p>
|
|
33
|
-
*
|
|
34
31
|
* <p>After 90 days, deleted accounts are permanently removed from your
|
|
35
32
|
* <code>Disabled</code> accounts list.</p>
|
|
36
33
|
* @example
|
|
@@ -21,8 +21,8 @@ export interface DeleteAttendeeCommandOutput extends __MetadataBearer {
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their
|
|
23
23
|
* <code>JoinToken</code>. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see
|
|
24
|
-
* <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
|
|
25
|
-
* in the <i>Amazon Chime Developer Guide</i>.</p>
|
|
24
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
|
|
25
|
+
* in the <i>Amazon Chime SDK Developer Guide</i>.</p>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|
|
@@ -20,7 +20,6 @@ export interface DeleteChannelBanCommandOutput extends __MetadataBearer {
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Removes a user from a channel's ban list.</p>
|
|
23
|
-
*
|
|
24
23
|
* <note>
|
|
25
24
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
26
25
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -21,7 +21,6 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Immediately makes a channel and its memberships inaccessible and marks them for
|
|
23
23
|
* deletion. This is an irreversible process.</p>
|
|
24
|
-
*
|
|
25
24
|
* <note>
|
|
26
25
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
27
26
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -20,7 +20,6 @@ export interface DeleteChannelMembershipCommandOutput extends __MetadataBearer {
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Removes a member from a channel.</p>
|
|
23
|
-
*
|
|
24
23
|
* <note>
|
|
25
24
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
26
25
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -22,7 +22,6 @@ export interface DeleteChannelMessageCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
* <p>Deletes a channel message. Only admins can perform this action. Deletion makes messages
|
|
23
23
|
* inaccessible immediately. A background process deletes any revisions created by
|
|
24
24
|
* <code>UpdateChannelMessage</code>.</p>
|
|
25
|
-
*
|
|
26
25
|
* <note>
|
|
27
26
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
28
27
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -20,7 +20,6 @@ export interface DeleteChannelModeratorCommandOutput extends __MetadataBearer {
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes a channel moderator.</p>
|
|
23
|
-
*
|
|
24
23
|
* <note>
|
|
25
24
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
26
25
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -21,8 +21,8 @@ export interface DeleteMeetingCommandOutput extends __MetadataBearer {
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from
|
|
23
23
|
* joining the meeting. For more information about the Amazon Chime SDK, see
|
|
24
|
-
* <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a> in the
|
|
25
|
-
* <i>Amazon Chime Developer Guide</i>.</p>
|
|
24
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a> in the
|
|
25
|
+
* <i>Amazon Chime SDK Developer Guide</i>.</p>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|
|
@@ -22,7 +22,6 @@ export interface DeletePhoneNumberCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
* <p>Moves the specified phone number into the <b>Deletion queue</b>. A
|
|
23
23
|
* phone number must be disassociated from any users or Amazon Chime Voice Connectors
|
|
24
24
|
* before it can be deleted.</p>
|
|
25
|
-
*
|
|
26
25
|
* <p>Deleted phone numbers remain in the
|
|
27
26
|
* <b>Deletion queue</b>
|
|
28
27
|
* for 7 days before they are deleted permanently.</p>
|
|
@@ -20,7 +20,6 @@ export interface DeleteVoiceConnectorOriginationCommandOutput extends __Metadata
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes the origination settings for the specified Amazon Chime Voice Connector.</p>
|
|
23
|
-
*
|
|
24
23
|
* <note>
|
|
25
24
|
* <p>If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.</p>
|
|
26
25
|
* </note>
|
|
@@ -20,7 +20,6 @@ export interface DeleteVoiceConnectorTerminationCommandOutput extends __Metadata
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes the termination settings for the specified Amazon Chime Voice Connector.</p>
|
|
23
|
-
*
|
|
24
23
|
* <note>
|
|
25
24
|
* <p>If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.</p>
|
|
26
25
|
* </note>
|
|
@@ -20,9 +20,7 @@ export interface DescribeChannelBanCommandOutput extends DescribeChannelBanRespo
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Returns the full details of a channel ban.</p>
|
|
23
|
-
*
|
|
24
23
|
* <note>
|
|
25
|
-
*
|
|
26
24
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
27
25
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
28
26
|
* the header.</p>
|
|
@@ -21,9 +21,7 @@ export interface DescribeChannelCommandOutput extends DescribeChannelResponse, _
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Returns the full details of a channel in an Amazon Chime
|
|
23
23
|
* <code>AppInstance</code>.</p>
|
|
24
|
-
*
|
|
25
24
|
* <note>
|
|
26
|
-
*
|
|
27
25
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
28
26
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
29
27
|
* the header.</p>
|
|
@@ -21,7 +21,6 @@ export interface DescribeChannelMembershipForAppInstanceUserCommandOutput extend
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p> Returns the details of a channel based on the membership of the specified
|
|
23
23
|
* <code>AppInstanceUser</code>.</p>
|
|
24
|
-
*
|
|
25
24
|
* <note>
|
|
26
25
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
27
26
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -21,7 +21,6 @@ export interface DescribeChannelModeratedByAppInstanceUserCommandOutput extends
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Returns the full details of a channel moderated by the specified
|
|
23
23
|
* <code>AppInstanceUser</code>.</p>
|
|
24
|
-
*
|
|
25
24
|
* <note>
|
|
26
25
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
27
26
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|
|
@@ -21,9 +21,9 @@ export interface GetAttendeeCommandOutput extends GetAttendeeResponse, __Metadat
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>
|
|
23
23
|
* Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see
|
|
24
|
-
* <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
|
|
24
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
|
|
25
25
|
* in the
|
|
26
|
-
* <i>Amazon Chime Developer Guide</i>
|
|
26
|
+
* <i>Amazon Chime SDK Developer Guide</i>
|
|
27
27
|
* .
|
|
28
28
|
* </p>
|
|
29
29
|
* @example
|
|
@@ -20,7 +20,6 @@ export interface GetChannelMessageCommandOutput extends GetChannelMessageRespons
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Gets the full details of a channel message.</p>
|
|
23
|
-
*
|
|
24
23
|
* <note>
|
|
25
24
|
* <p>The x-amz-chime-bearer request header is mandatory. Use the
|
|
26
25
|
* <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
|