@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.
Files changed (89) hide show
  1. package/README.md +5 -10
  2. package/dist-cjs/Chime.js +195 -2674
  3. package/dist-cjs/endpoint/ruleset.js +3 -3
  4. package/dist-cjs/models/models_0.js +2 -0
  5. package/dist-cjs/protocols/Aws_restJson1.js +8 -8
  6. package/dist-es/Chime.js +195 -2674
  7. package/dist-es/endpoint/ruleset.js +3 -3
  8. package/dist-es/models/models_0.js +2 -0
  9. package/dist-es/protocols/Aws_restJson1.js +8 -8
  10. package/dist-types/Chime.d.ts +231 -913
  11. package/dist-types/ChimeClient.d.ts +17 -22
  12. package/dist-types/commands/BatchCreateAttendeeCommand.d.ts +2 -2
  13. package/dist-types/commands/BatchCreateChannelMembershipCommand.d.ts +1 -1
  14. package/dist-types/commands/BatchCreateRoomMembershipCommand.d.ts +1 -1
  15. package/dist-types/commands/BatchDeletePhoneNumberCommand.d.ts +0 -1
  16. package/dist-types/commands/BatchSuspendUserCommand.d.ts +0 -3
  17. package/dist-types/commands/BatchUnsuspendUserCommand.d.ts +0 -1
  18. package/dist-types/commands/BatchUpdatePhoneNumberCommand.d.ts +1 -1
  19. package/dist-types/commands/BatchUpdateUserCommand.d.ts +2 -2
  20. package/dist-types/commands/CreateAppInstanceAdminCommand.d.ts +0 -2
  21. package/dist-types/commands/CreateAttendeeCommand.d.ts +2 -2
  22. package/dist-types/commands/CreateChannelBanCommand.d.ts +0 -1
  23. package/dist-types/commands/CreateChannelCommand.d.ts +2 -4
  24. package/dist-types/commands/CreateChannelMembershipCommand.d.ts +1 -5
  25. package/dist-types/commands/CreateChannelModeratorCommand.d.ts +0 -2
  26. package/dist-types/commands/CreateMediaCapturePipelineCommand.d.ts +7 -7
  27. package/dist-types/commands/CreateMeetingCommand.d.ts +4 -4
  28. package/dist-types/commands/CreateMeetingDialOutCommand.d.ts +0 -1
  29. package/dist-types/commands/CreateMeetingWithAttendeesCommand.d.ts +4 -4
  30. package/dist-types/commands/CreatePhoneNumberOrderCommand.d.ts +1 -1
  31. package/dist-types/commands/CreateProxySessionCommand.d.ts +3 -3
  32. package/dist-types/commands/CreateRoomMembershipCommand.d.ts +1 -1
  33. package/dist-types/commands/CreateSipRuleCommand.d.ts +1 -1
  34. package/dist-types/commands/CreateUserCommand.d.ts +1 -1
  35. package/dist-types/commands/CreateVoiceConnectorCommand.d.ts +1 -2
  36. package/dist-types/commands/DeleteAccountCommand.d.ts +0 -3
  37. package/dist-types/commands/DeleteAttendeeCommand.d.ts +2 -2
  38. package/dist-types/commands/DeleteChannelBanCommand.d.ts +0 -1
  39. package/dist-types/commands/DeleteChannelCommand.d.ts +0 -1
  40. package/dist-types/commands/DeleteChannelMembershipCommand.d.ts +0 -1
  41. package/dist-types/commands/DeleteChannelMessageCommand.d.ts +0 -1
  42. package/dist-types/commands/DeleteChannelModeratorCommand.d.ts +0 -1
  43. package/dist-types/commands/DeleteMeetingCommand.d.ts +2 -2
  44. package/dist-types/commands/DeletePhoneNumberCommand.d.ts +0 -1
  45. package/dist-types/commands/DeleteVoiceConnectorOriginationCommand.d.ts +0 -1
  46. package/dist-types/commands/DeleteVoiceConnectorTerminationCommand.d.ts +0 -1
  47. package/dist-types/commands/DescribeChannelBanCommand.d.ts +0 -2
  48. package/dist-types/commands/DescribeChannelCommand.d.ts +0 -2
  49. package/dist-types/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts +0 -1
  50. package/dist-types/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts +0 -1
  51. package/dist-types/commands/GetAttendeeCommand.d.ts +2 -2
  52. package/dist-types/commands/GetChannelMessageCommand.d.ts +0 -1
  53. package/dist-types/commands/GetMeetingCommand.d.ts +2 -2
  54. package/dist-types/commands/GetUserCommand.d.ts +0 -1
  55. package/dist-types/commands/InviteUsersCommand.d.ts +1 -1
  56. package/dist-types/commands/ListAttendeesCommand.d.ts +2 -2
  57. package/dist-types/commands/ListChannelBansCommand.d.ts +0 -2
  58. package/dist-types/commands/ListChannelMembershipsCommand.d.ts +1 -3
  59. package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +0 -1
  60. package/dist-types/commands/ListChannelMessagesCommand.d.ts +1 -1
  61. package/dist-types/commands/ListChannelsCommand.d.ts +1 -3
  62. package/dist-types/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts +0 -1
  63. package/dist-types/commands/ListMeetingsCommand.d.ts +2 -2
  64. package/dist-types/commands/ListPhoneNumbersCommand.d.ts +3 -3
  65. package/dist-types/commands/ListProxySessionsCommand.d.ts +1 -1
  66. package/dist-types/commands/ListSupportedPhoneNumberCountriesCommand.d.ts +1 -1
  67. package/dist-types/commands/ListUsersCommand.d.ts +1 -1
  68. package/dist-types/commands/PutAppInstanceStreamingConfigurationsCommand.d.ts +1 -1
  69. package/dist-types/commands/PutRetentionSettingsCommand.d.ts +0 -1
  70. package/dist-types/commands/PutVoiceConnectorOriginationCommand.d.ts +1 -2
  71. package/dist-types/commands/PutVoiceConnectorStreamingConfigurationCommand.d.ts +1 -1
  72. package/dist-types/commands/PutVoiceConnectorTerminationCommand.d.ts +0 -1
  73. package/dist-types/commands/RedactChannelMessageCommand.d.ts +0 -1
  74. package/dist-types/commands/SearchAvailablePhoneNumbersCommand.d.ts +1 -1
  75. package/dist-types/commands/SendChannelMessageCommand.d.ts +2 -4
  76. package/dist-types/commands/StartMeetingTranscriptionCommand.d.ts +27 -12
  77. package/dist-types/commands/UpdateAccountCommand.d.ts +1 -1
  78. package/dist-types/commands/UpdateChannelCommand.d.ts +1 -1
  79. package/dist-types/commands/UpdateChannelMessageCommand.d.ts +0 -1
  80. package/dist-types/commands/UpdateChannelReadMarkerCommand.d.ts +0 -1
  81. package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +1 -1
  82. package/dist-types/commands/UpdateProxySessionCommand.d.ts +1 -1
  83. package/dist-types/commands/UpdateRoomMembershipCommand.d.ts +1 -1
  84. package/dist-types/commands/UpdateUserCommand.d.ts +2 -2
  85. package/dist-types/models/models_0.d.ts +89 -30
  86. package/dist-types/models/models_1.d.ts +7 -6
  87. package/dist-types/ts3.4/Chime.d.ts +2 -1
  88. package/dist-types/ts3.4/models/models_0.d.ts +8 -1
  89. package/package.json +6 -6
@@ -21,9 +21,9 @@ export interface GetMeetingCommandOutput extends GetMeetingResponse, __MetadataB
21
21
  * @public
22
22
  * <p>
23
23
  * Gets the Amazon Chime SDK meeting details for the specified meeting 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 GetUserCommandOutput extends GetUserResponse, __MetadataBearer
20
20
  /**
21
21
  * @public
22
22
  * <p>Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.</p>
23
- *
24
23
  * <p>
25
24
  * To retrieve user details with an email address instead of a user ID, use the
26
25
  * <a>ListUsers</a> action, and then filter by email address.
@@ -33,7 +33,7 @@ export interface InviteUsersCommandOutput extends InviteUsersResponse, __Metadat
33
33
  * UserEmailList: [ // UserEmailList // required
34
34
  * "STRING_VALUE",
35
35
  * ],
36
- * UserType: "STRING_VALUE",
36
+ * UserType: "PrivateUser" || "SharedDevice",
37
37
  * };
38
38
  * const command = new InviteUsersCommand(input);
39
39
  * const response = await client.send(command);
@@ -21,8 +21,8 @@ export interface ListAttendeesCommandOutput extends ListAttendeesResponse, __Met
21
21
  * @public
22
22
  * <p>
23
23
  * Lists the attendees for the specified 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>
25
- * in the <i>Amazon Chime Developer Guide</i>.
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>.
26
26
  * </p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
@@ -20,9 +20,7 @@ export interface ListChannelBansCommandOutput extends ListChannelBansResponse, _
20
20
  /**
21
21
  * @public
22
22
  * <p>Lists all the users banned from a particular channel.</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>
@@ -20,9 +20,7 @@ export interface ListChannelMembershipsCommandOutput extends ListChannelMembersh
20
20
  /**
21
21
  * @public
22
22
  * <p>Lists all channel memberships in a channel.</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>
@@ -35,7 +33,7 @@ export interface ListChannelMembershipsCommandOutput extends ListChannelMembersh
35
33
  * const client = new ChimeClient(config);
36
34
  * const input = { // ListChannelMembershipsRequest
37
35
  * ChannelArn: "STRING_VALUE", // required
38
- * Type: "STRING_VALUE",
36
+ * Type: "DEFAULT" || "HIDDEN",
39
37
  * MaxResults: Number("int"),
40
38
  * NextToken: "STRING_VALUE",
41
39
  * ChimeBearer: "STRING_VALUE",
@@ -21,7 +21,6 @@ export interface ListChannelMembershipsForAppInstanceUserCommandOutput extends L
21
21
  * @public
22
22
  * <p> Lists all channels that a particular <code>AppInstanceUser</code> is a part of. Only an
23
23
  * <code>AppInstanceAdmin</code> can call the API with a user ARN that is not their own. </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
@@ -38,7 +38,7 @@ export interface ListChannelMessagesCommandOutput extends ListChannelMessagesRes
38
38
  * const client = new ChimeClient(config);
39
39
  * const input = { // ListChannelMessagesRequest
40
40
  * ChannelArn: "STRING_VALUE", // required
41
- * SortOrder: "STRING_VALUE",
41
+ * SortOrder: "ASCENDING" || "DESCENDING",
42
42
  * NotBefore: new Date("TIMESTAMP"),
43
43
  * NotAfter: new Date("TIMESTAMP"),
44
44
  * MaxResults: Number("int"),
@@ -21,7 +21,6 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
21
21
  * @public
22
22
  * <p>Lists all Channels created under a single Chime App as a paginated list. You can specify
23
23
  * filters to narrow results.</p>
24
- *
25
24
  * <p class="title">
26
25
  * <b>Functionality & restrictions</b>
27
26
  * </p>
@@ -35,7 +34,6 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
35
34
  * list the private channels in an account.</p>
36
35
  * </li>
37
36
  * </ul>
38
- *
39
37
  * <note>
40
38
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
41
39
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -49,7 +47,7 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
49
47
  * const client = new ChimeClient(config);
50
48
  * const input = { // ListChannelsRequest
51
49
  * AppInstanceArn: "STRING_VALUE", // required
52
- * Privacy: "STRING_VALUE",
50
+ * Privacy: "PUBLIC" || "PRIVATE",
53
51
  * MaxResults: Number("int"),
54
52
  * NextToken: "STRING_VALUE",
55
53
  * ChimeBearer: "STRING_VALUE",
@@ -20,7 +20,6 @@ export interface ListChannelsModeratedByAppInstanceUserCommandOutput extends Lis
20
20
  /**
21
21
  * @public
22
22
  * <p>A list of the channels moderated by an <code>AppInstanceUser</code>.</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 ListMeetingsCommandOutput extends ListMeetingsResponse, __Metad
21
21
  * @public
22
22
  * <p>
23
23
  * Lists up to 100 active Amazon Chime SDK meetings. 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
@@ -27,9 +27,9 @@ export interface ListPhoneNumbersCommandOutput extends ListPhoneNumbersResponse,
27
27
  * // const { ChimeClient, ListPhoneNumbersCommand } = require("@aws-sdk/client-chime"); // CommonJS import
28
28
  * const client = new ChimeClient(config);
29
29
  * const input = { // ListPhoneNumbersRequest
30
- * Status: "STRING_VALUE",
31
- * ProductType: "STRING_VALUE",
32
- * FilterName: "STRING_VALUE",
30
+ * Status: "AcquireInProgress" || "AcquireFailed" || "Unassigned" || "Assigned" || "ReleaseInProgress" || "DeleteInProgress" || "ReleaseFailed" || "DeleteFailed",
31
+ * ProductType: "BusinessCalling" || "VoiceConnector" || "SipMediaApplicationDialIn",
32
+ * FilterName: "AccountId" || "UserId" || "VoiceConnectorId" || "VoiceConnectorGroupId" || "SipRuleId",
33
33
  * FilterValue: "STRING_VALUE",
34
34
  * MaxResults: Number("int"),
35
35
  * NextToken: "STRING_VALUE",
@@ -28,7 +28,7 @@ export interface ListProxySessionsCommandOutput extends ListProxySessionsRespons
28
28
  * const client = new ChimeClient(config);
29
29
  * const input = { // ListProxySessionsRequest
30
30
  * VoiceConnectorId: "STRING_VALUE", // required
31
- * Status: "STRING_VALUE",
31
+ * Status: "Open" || "InProgress" || "Closed",
32
32
  * NextToken: "STRING_VALUE",
33
33
  * MaxResults: Number("int"),
34
34
  * };
@@ -27,7 +27,7 @@ export interface ListSupportedPhoneNumberCountriesCommandOutput extends ListSupp
27
27
  * // const { ChimeClient, ListSupportedPhoneNumberCountriesCommand } = require("@aws-sdk/client-chime"); // CommonJS import
28
28
  * const client = new ChimeClient(config);
29
29
  * const input = { // ListSupportedPhoneNumberCountriesRequest
30
- * ProductType: "STRING_VALUE", // required
30
+ * ProductType: "BusinessCalling" || "VoiceConnector" || "SipMediaApplicationDialIn", // required
31
31
  * };
32
32
  * const command = new ListSupportedPhoneNumberCountriesCommand(input);
33
33
  * const response = await client.send(command);
@@ -30,7 +30,7 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
30
30
  * const input = { // ListUsersRequest
31
31
  * AccountId: "STRING_VALUE", // required
32
32
  * UserEmail: "STRING_VALUE",
33
- * UserType: "STRING_VALUE",
33
+ * UserType: "PrivateUser" || "SharedDevice",
34
34
  * MaxResults: Number("int"),
35
35
  * NextToken: "STRING_VALUE",
36
36
  * };
@@ -30,7 +30,7 @@ export interface PutAppInstanceStreamingConfigurationsCommandOutput extends PutA
30
30
  * AppInstanceArn: "STRING_VALUE", // required
31
31
  * AppInstanceStreamingConfigurations: [ // AppInstanceStreamingConfigurationList // required
32
32
  * { // AppInstanceStreamingConfiguration
33
- * AppInstanceDataType: "STRING_VALUE", // required
33
+ * AppInstanceDataType: "Channel" || "ChannelMessage", // required
34
34
  * ResourceArn: "STRING_VALUE", // required
35
35
  * },
36
36
  * ],
@@ -23,7 +23,6 @@ export interface PutRetentionSettingsCommandOutput extends PutRetentionSettingsR
23
23
  * Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see
24
24
  * <a href="https://docs.aws.amazon.com/chime/latest/ag/cloudtrail.html">Logging Amazon Chime API Calls with AWS CloudTrail</a>
25
25
  * in the <i>Amazon Chime Administration Guide</i>.</p>
26
- *
27
26
  * <p>
28
27
  * To turn off existing retention settings, remove the number of days from the corresponding
29
28
  * <b>RetentionDays</b>
@@ -20,7 +20,6 @@ export interface PutVoiceConnectorOriginationCommandOutput extends PutVoiceConne
20
20
  /**
21
21
  * @public
22
22
  * <p>Adds 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 turning off origination settings.</p>
26
25
  * </note>
@@ -37,7 +36,7 @@ export interface PutVoiceConnectorOriginationCommandOutput extends PutVoiceConne
37
36
  * { // OriginationRoute
38
37
  * Host: "STRING_VALUE",
39
38
  * Port: Number("int"),
40
- * Protocol: "STRING_VALUE",
39
+ * Protocol: "TCP" || "UDP",
41
40
  * Priority: Number("int"),
42
41
  * Weight: Number("int"),
43
42
  * },
@@ -35,7 +35,7 @@ export interface PutVoiceConnectorStreamingConfigurationCommandOutput extends Pu
35
35
  * Disabled: true || false,
36
36
  * StreamingNotificationTargets: [ // StreamingNotificationTargetList
37
37
  * { // StreamingNotificationTarget
38
- * NotificationTarget: "STRING_VALUE", // required
38
+ * NotificationTarget: "EventBridge" || "SNS" || "SQS", // required
39
39
  * },
40
40
  * ],
41
41
  * },
@@ -20,7 +20,6 @@ export interface PutVoiceConnectorTerminationCommandOutput extends PutVoiceConne
20
20
  /**
21
21
  * @public
22
22
  * <p>Adds 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 turning off termination settings.</p>
26
25
  * </note>
@@ -21,7 +21,6 @@ export interface RedactChannelMessageCommandOutput extends RedactChannelMessageR
21
21
  * @public
22
22
  * <p>Redacts message content, but not metadata. The message exists in the back end, but the
23
23
  * action returns null content, and the state shows as redacted.</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
@@ -36,7 +36,7 @@ export interface SearchAvailablePhoneNumbersCommandOutput extends SearchAvailabl
36
36
  * Country: "STRING_VALUE",
37
37
  * State: "STRING_VALUE",
38
38
  * TollFreePrefix: "STRING_VALUE",
39
- * PhoneNumberType: "STRING_VALUE",
39
+ * PhoneNumberType: "Local" || "TollFree",
40
40
  * MaxResults: Number("int"),
41
41
  * NextToken: "STRING_VALUE",
42
42
  * };
@@ -20,12 +20,10 @@ export interface SendChannelMessageCommandOutput extends SendChannelMessageRespo
20
20
  /**
21
21
  * @public
22
22
  * <p>Sends a message to a particular channel that the member is a part of.</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
27
26
  * the header.</p>
28
- *
29
27
  * <p>Also, <code>STANDARD</code> messages can contain 4KB of data and the 1KB of metadata.
30
28
  * <code>CONTROL</code> messages can contain 30 bytes of data and no metadata.</p>
31
29
  * </note>
@@ -38,8 +36,8 @@ export interface SendChannelMessageCommandOutput extends SendChannelMessageRespo
38
36
  * const input = { // SendChannelMessageRequest
39
37
  * ChannelArn: "STRING_VALUE", // required
40
38
  * Content: "STRING_VALUE", // required
41
- * Type: "STRING_VALUE", // required
42
- * Persistence: "STRING_VALUE", // required
39
+ * Type: "STANDARD" || "CONTROL", // required
40
+ * Persistence: "PERSISTENT" || "NON_PERSISTENT", // required
43
41
  * Metadata: "STRING_VALUE",
44
42
  * ClientRequestToken: "STRING_VALUE", // required
45
43
  * ChimeBearer: "STRING_VALUE",
@@ -19,7 +19,17 @@ export interface StartMeetingTranscriptionCommandOutput extends StartMeetingTran
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Starts transcription for the specified <code>meetingId</code>. </p>
22
+ * <p>Starts transcription for the specified <code>meetingId</code>. For more information, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meeting-transcription.html">
23
+ * Using Amazon Chime SDK live transcription
24
+ * </a> in the <i>Amazon Chime SDK Developer Guide</i>.</p>
25
+ * <p>If you specify an invalid configuration, a <code>TranscriptFailed</code> event will be sent with the contents of the <code>BadRequestException</code> generated by Amazon Transcribe.
26
+ * For more information on each parameter and which combinations are valid, refer to the
27
+ * <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html">StartStreamTranscription</a> API in the
28
+ * <i>Amazon Transcribe Developer Guide</i>.</p>
29
+ * <important>
30
+ * <p>Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the
31
+ * <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a>, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.</p>
32
+ * </important>
23
33
  * @example
24
34
  * Use a bare-bones client and the command you need to make an API call.
25
35
  * ```javascript
@@ -30,25 +40,30 @@ export interface StartMeetingTranscriptionCommandOutput extends StartMeetingTran
30
40
  * MeetingId: "STRING_VALUE", // required
31
41
  * TranscriptionConfiguration: { // TranscriptionConfiguration
32
42
  * EngineTranscribeSettings: { // EngineTranscribeSettings
33
- * LanguageCode: "STRING_VALUE", // required
34
- * VocabularyFilterMethod: "STRING_VALUE",
43
+ * LanguageCode: "en-US" || "en-GB" || "es-US" || "fr-CA" || "fr-FR" || "en-AU" || "it-IT" || "de-DE" || "pt-BR" || "ja-JP" || "ko-KR" || "zh-CN" || "th-TH" || "hi-IN",
44
+ * VocabularyFilterMethod: "remove" || "mask" || "tag",
35
45
  * VocabularyFilterName: "STRING_VALUE",
36
46
  * VocabularyName: "STRING_VALUE",
37
- * Region: "STRING_VALUE",
47
+ * Region: "us-east-2" || "us-east-1" || "us-west-2" || "ap-northeast-2" || "ap-southeast-2" || "ap-northeast-1" || "ca-central-1" || "eu-central-1" || "eu-west-1" || "eu-west-2" || "sa-east-1" || "auto",
38
48
  * EnablePartialResultsStabilization: true || false,
39
- * PartialResultsStability: "STRING_VALUE",
40
- * ContentIdentificationType: "STRING_VALUE",
41
- * ContentRedactionType: "STRING_VALUE",
49
+ * PartialResultsStability: "low" || "medium" || "high",
50
+ * ContentIdentificationType: "PII",
51
+ * ContentRedactionType: "PII",
42
52
  * PiiEntityTypes: "STRING_VALUE",
43
53
  * LanguageModelName: "STRING_VALUE",
54
+ * IdentifyLanguage: true || false,
55
+ * LanguageOptions: "STRING_VALUE",
56
+ * PreferredLanguage: "en-US" || "en-GB" || "es-US" || "fr-CA" || "fr-FR" || "en-AU" || "it-IT" || "de-DE" || "pt-BR" || "ja-JP" || "ko-KR" || "zh-CN" || "th-TH" || "hi-IN",
57
+ * VocabularyNames: "STRING_VALUE",
58
+ * VocabularyFilterNames: "STRING_VALUE",
44
59
  * },
45
60
  * EngineTranscribeMedicalSettings: { // EngineTranscribeMedicalSettings
46
- * LanguageCode: "STRING_VALUE", // required
47
- * Specialty: "STRING_VALUE", // required
48
- * Type: "STRING_VALUE", // required
61
+ * LanguageCode: "en-US", // required
62
+ * Specialty: "PRIMARYCARE" || "CARDIOLOGY" || "NEUROLOGY" || "ONCOLOGY" || "RADIOLOGY" || "UROLOGY", // required
63
+ * Type: "CONVERSATION" || "DICTATION", // required
49
64
  * VocabularyName: "STRING_VALUE",
50
- * Region: "STRING_VALUE",
51
- * ContentIdentificationType: "STRING_VALUE",
65
+ * Region: "us-east-1" || "us-east-2" || "us-west-2" || "ap-southeast-2" || "ca-central-1" || "eu-west-1" || "auto",
66
+ * ContentIdentificationType: "PHI",
52
67
  * },
53
68
  * },
54
69
  * };
@@ -29,7 +29,7 @@ export interface UpdateAccountCommandOutput extends UpdateAccountResponse, __Met
29
29
  * const input = { // UpdateAccountRequest
30
30
  * AccountId: "STRING_VALUE", // required
31
31
  * Name: "STRING_VALUE",
32
- * DefaultLicense: "STRING_VALUE",
32
+ * DefaultLicense: "Basic" || "Plus" || "Pro" || "ProTrial",
33
33
  * };
34
34
  * const command = new UpdateAccountCommand(input);
35
35
  * const response = await client.send(command);
@@ -36,7 +36,7 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met
36
36
  * const input = { // UpdateChannelRequest
37
37
  * ChannelArn: "STRING_VALUE", // required
38
38
  * Name: "STRING_VALUE", // required
39
- * Mode: "STRING_VALUE", // required
39
+ * Mode: "UNRESTRICTED" || "RESTRICTED", // required
40
40
  * Metadata: "STRING_VALUE",
41
41
  * ChimeBearer: "STRING_VALUE",
42
42
  * };
@@ -20,7 +20,6 @@ export interface UpdateChannelMessageCommandOutput extends UpdateChannelMessageR
20
20
  /**
21
21
  * @public
22
22
  * <p>Updates the content of a message.</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
@@ -20,7 +20,6 @@ export interface UpdateChannelReadMarkerCommandOutput extends UpdateChannelReadM
20
20
  /**
21
21
  * @public
22
22
  * <p>The details of the time when a user last read messages in 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
@@ -30,7 +30,7 @@ export interface UpdatePhoneNumberCommandOutput extends UpdatePhoneNumberRespons
30
30
  * const client = new ChimeClient(config);
31
31
  * const input = { // UpdatePhoneNumberRequest
32
32
  * PhoneNumberId: "STRING_VALUE", // required
33
- * ProductType: "STRING_VALUE",
33
+ * ProductType: "BusinessCalling" || "VoiceConnector" || "SipMediaApplicationDialIn",
34
34
  * CallingName: "STRING_VALUE",
35
35
  * };
36
36
  * const command = new UpdatePhoneNumberCommand(input);
@@ -30,7 +30,7 @@ export interface UpdateProxySessionCommandOutput extends UpdateProxySessionRespo
30
30
  * VoiceConnectorId: "STRING_VALUE", // required
31
31
  * ProxySessionId: "STRING_VALUE", // required
32
32
  * Capabilities: [ // CapabilityList // required
33
- * "STRING_VALUE",
33
+ * "Voice" || "SMS",
34
34
  * ],
35
35
  * ExpiryMinutes: Number("int"),
36
36
  * };
@@ -33,7 +33,7 @@ export interface UpdateRoomMembershipCommandOutput extends UpdateRoomMembershipR
33
33
  * AccountId: "STRING_VALUE", // required
34
34
  * RoomId: "STRING_VALUE", // required
35
35
  * MemberId: "STRING_VALUE", // required
36
- * Role: "STRING_VALUE",
36
+ * Role: "Administrator" || "Member",
37
37
  * };
38
38
  * const command = new UpdateRoomMembershipCommand(input);
39
39
  * const response = await client.send(command);
@@ -29,8 +29,8 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB
29
29
  * const input = { // UpdateUserRequest
30
30
  * AccountId: "STRING_VALUE", // required
31
31
  * UserId: "STRING_VALUE", // required
32
- * LicenseType: "STRING_VALUE",
33
- * UserType: "STRING_VALUE",
32
+ * LicenseType: "Basic" || "Plus" || "Pro" || "ProTrial",
33
+ * UserType: "PrivateUser" || "SharedDevice",
34
34
  * AlexaForBusinessMetadata: { // AlexaForBusinessMetadata
35
35
  * IsAlexaForBusinessEnabled: true || false,
36
36
  * AlexaForBusinessRoomArn: "STRING_VALUE",