Skip to content

Commit

Permalink
feat(client-chime-sdk-meetings): Add meeting features to specify a ma…
Browse files Browse the repository at this point in the history 
…ximum camera resolution, a maximum content sharing resolution, and a maximum number of attendees for a given meeting.
  • Loading branch information
awstools committed Dec 19, 2023
1 parent b3d1497 commit 9a30a93
Show file tree
Hide file tree
Showing 15 changed files with 392 additions and 45 deletions.
2 changes: 1 addition & 1 deletion clients/client-chime-sdk-meetings/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

AWS SDK for JavaScript ChimeSDKMeetings Client for Node.js, Browser and React Native.

<p>The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and
<p>The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the Amazon Web Services Regions for meetings, create and manage users, and send and
receive meeting notifications. For more information about the meeting APIs, see
<a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Meetings.html">Amazon Chime SDK meetings</a>.</p>

Expand Down
2 changes: 1 addition & 1 deletion clients/client-chime-sdk-meetings/src/ChimeSDKMeetings.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ export interface ChimeSDKMeetings {

/**
* @public
* <p>The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and
* <p>The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the Amazon Web Services Regions for meetings, create and manage users, and send and
* receive meeting notifications. For more information about the meeting APIs, see
* <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Meetings.html">Amazon Chime SDK meetings</a>.</p>
*/
Expand Down
2 changes: 1 addition & 1 deletion clients/client-chime-sdk-meetings/src/ChimeSDKMeetingsClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ export interface ChimeSDKMeetingsClientResolvedConfig extends ChimeSDKMeetingsCl

/**
* @public
* <p>The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and
* <p>The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the Amazon Web Services Regions for meetings, create and manage users, and send and
* receive meeting notifications. For more information about the meeting APIs, see
* <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Meetings.html">Amazon Chime SDK meetings</a>.</p>
*/
Expand Down
8 changes: 8 additions & 0 deletions ...ts/client-chime-sdk-meetings/src/commands/BatchUpdateAttendeeCapabilitiesExceptCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ export interface BatchUpdateAttendeeCapabilitiesExceptCommandOutput extends __Me
* <p>When using capabilities, be aware of these corner cases:</p>
* <ul>
* <li>
* <p>If you specify <code>MeetingFeatures:Video:MaxResolution:None</code> when you create a meeting, all API requests
* that include <code>SendReceive</code>, <code>Send</code>, or <code>Receive</code> for <code>AttendeeCapabilities:Video</code> will be rejected with <code>ValidationError 400</code>.</p>
* </li>
* <li>
* <p>If you specify <code>MeetingFeatures:Content:MaxResolution:None</code> when you create a meeting, all API requests that include <code>SendReceive</code>, <code>Send</code>, or
* <code>Receive</code> for <code>AttendeeCapabilities:Content</code> will be rejected with <code>ValidationError 400</code>.</p>
* </li>
* <li>
* <p>You can't set <code>content</code> capabilities to <code>SendReceive</code> or <code>Receive</code> unless you also set <code>video</code> capabilities to <code>SendReceive</code>
* or <code>Receive</code>. If you don't set the <code>video</code> capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your <code>video</code> capability
* to receive and you set your <code>content</code> capability to not receive.</p>
Expand Down
18 changes: 18 additions & 0 deletions clients/client-chime-sdk-meetings/src/commands/CreateMeetingCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,15 @@ export interface CreateMeetingCommandOutput extends CreateMeetingResponse, __Met
* Audio: { // AudioFeatures
* EchoReduction: "AVAILABLE" || "UNAVAILABLE",
* },
* Video: { // VideoFeatures
* MaxResolution: "None" || "HD" || "FHD",
* },
* Content: { // ContentFeatures
* MaxResolution: "None" || "FHD" || "UHD",
* },
* Attendee: { // AttendeeFeatures
* MaxCount: Number("int"),
* },
* },
* PrimaryMeetingId: "STRING_VALUE",
* TenantIds: [ // TenantIdList
Expand Down Expand Up @@ -103,6 +112,15 @@ export interface CreateMeetingCommandOutput extends CreateMeetingResponse, __Met
* // Audio: { // AudioFeatures
* // EchoReduction: "AVAILABLE" || "UNAVAILABLE",
* // },
* // Video: { // VideoFeatures
* // MaxResolution: "None" || "HD" || "FHD",
* // },
* // Content: { // ContentFeatures
* // MaxResolution: "None" || "FHD" || "UHD",
* // },
* // Attendee: { // AttendeeFeatures
* // MaxCount: Number("int"),
* // },
* // },
* // PrimaryMeetingId: "STRING_VALUE",
* // TenantIds: [ // TenantIdList
Expand Down
18 changes: 18 additions & 0 deletions clients/client-chime-sdk-meetings/src/commands/CreateMeetingWithAttendeesCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,15 @@ export interface CreateMeetingWithAttendeesCommandOutput extends CreateMeetingWi
* Audio: { // AudioFeatures
* EchoReduction: "AVAILABLE" || "UNAVAILABLE",
* },
* Video: { // VideoFeatures
* MaxResolution: "None" || "HD" || "FHD",
* },
* Content: { // ContentFeatures
* MaxResolution: "None" || "FHD" || "UHD",
* },
* Attendee: { // AttendeeFeatures
* MaxCount: Number("int"),
* },
* },
* NotificationsConfiguration: { // NotificationsConfiguration
* LambdaFunctionArn: "STRING_VALUE",
Expand Down Expand Up @@ -113,6 +122,15 @@ export interface CreateMeetingWithAttendeesCommandOutput extends CreateMeetingWi
* // Audio: { // AudioFeatures
* // EchoReduction: "AVAILABLE" || "UNAVAILABLE",
* // },
* // Video: { // VideoFeatures
* // MaxResolution: "None" || "HD" || "FHD",
* // },
* // Content: { // ContentFeatures
* // MaxResolution: "None" || "FHD" || "UHD",
* // },
* // Attendee: { // AttendeeFeatures
* // MaxCount: Number("int"),
* // },
* // },
* // PrimaryMeetingId: "STRING_VALUE",
* // TenantIds: [ // TenantIdList
Expand Down
9 changes: 9 additions & 0 deletions clients/client-chime-sdk-meetings/src/commands/GetMeetingCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,15 @@ export interface GetMeetingCommandOutput extends GetMeetingResponse, __MetadataB
* // Audio: { // AudioFeatures
* // EchoReduction: "AVAILABLE" || "UNAVAILABLE",
* // },
* // Video: { // VideoFeatures
* // MaxResolution: "None" || "HD" || "FHD",
* // },
* // Content: { // ContentFeatures
* // MaxResolution: "None" || "FHD" || "UHD",
* // },
* // Attendee: { // AttendeeFeatures
* // MaxCount: Number("int"),
* // },
* // },
* // PrimaryMeetingId: "STRING_VALUE",
* // TenantIds: [ // TenantIdList
Expand Down
12 changes: 8 additions & 4 deletions clients/client-chime-sdk-meetings/src/commands/StartMeetingTranscriptionCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,14 @@ export interface StartMeetingTranscriptionCommandOutput extends __MetadataBearer
* For more information on each parameter and which combinations are valid, refer to the
* <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html">StartStreamTranscription</a> API in the
* <i>Amazon Transcribe Developer Guide</i>.</p>
* <important>
* <p>Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the
* <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>
* </important>
* <note>
* <p>By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve Amazon Web Services AI/ML services as
* further described in section 50 of the <a href="https://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a>. Using Amazon Transcribe
* may be subject to federal and state laws or regulations regarding the recording or interception of electronic communications. It is your and your end users’
* responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or communication
* that the session or communication is being recorded, and obtaining all necessary consents. You can opt out from Amazon Web Services using audio content to develop and
* improve AWS AI/ML services by configuring an AI services opt out policy using Amazon Web Services Organizations.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
8 changes: 6 additions & 2 deletions clients/client-chime-sdk-meetings/src/commands/StopMeetingTranscriptionCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,12 @@ export interface StopMeetingTranscriptionCommandOutput extends __MetadataBearer
* Using Amazon Chime SDK live transcription
* </a> in the <i>Amazon Chime SDK Developer Guide</i>.</p>
* <important>
* <p>Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the
* <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>
* <p>By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve Amazon Web Services AI/ML services as
* further described in section 50 of the <a href="https://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a>. Using Amazon Transcribe
* may be subject to federal and state laws or regulations regarding the recording or interception of electronic communications. It is your and your end users’
* responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or communication
* that the session or communication is being recorded, and obtaining all necessary consents. You can opt out from Amazon Web Services using audio content to develop and
* improve Amazon Web Services AI/ML services by configuring an AI services opt out policy using Amazon Web Services Organizations.</p>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
2 changes: 1 addition & 1 deletion clients/client-chime-sdk-meetings/src/commands/UntagResourceCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
* see the documentation for the service whose resource you want to untag.</p>
* </li>
* <li>
* <p>You can only tag resources that are located in the specified AWS Region for the calling AWS account.</p>
* <p>You can only tag resources that are located in the specified Amazon Web Services Region for the calling Amazon Web Services account.</p>
* </li>
* </ul>
* <p>
Expand Down
8 changes: 8 additions & 0 deletions clients/client-chime-sdk-meetings/src/commands/UpdateAttendeeCapabilitiesCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ export interface UpdateAttendeeCapabilitiesCommandOutput extends UpdateAttendeeC
* <p>When using capabilities, be aware of these corner cases:</p>
* <ul>
* <li>
* <p>If you specify <code>MeetingFeatures:Video:MaxResolution:None</code> when you create a meeting, all API requests
* that include <code>SendReceive</code>, <code>Send</code>, or <code>Receive</code> for <code>AttendeeCapabilities:Video</code> will be rejected with <code>ValidationError 400</code>.</p>
* </li>
* <li>
* <p>If you specify <code>MeetingFeatures:Content:MaxResolution:None</code> when you create a meeting, all API requests that include <code>SendReceive</code>, <code>Send</code>, or
* <code>Receive</code> for <code>AttendeeCapabilities:Content</code> will be rejected with <code>ValidationError 400</code>.</p>
* </li>
* <li>
* <p>You can't set <code>content</code> capabilities to <code>SendReceive</code> or <code>Receive</code> unless you also set <code>video</code> capabilities to <code>SendReceive</code>
* or <code>Receive</code>. If you don't set the <code>video</code> capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your <code>video</code> capability
* to receive and you set your <code>content</code> capability to not receive.</p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-chime-sdk-meetings/src/index.ts
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// smithy-typescript generated code
/* eslint-disable */
/**
* <p>The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and
* <p>The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the Amazon Web Services Regions for meetings, create and manage users, and send and
* receive meeting notifications. For more information about the meeting APIs, see
* <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Meetings.html">Amazon Chime SDK meetings</a>.</p>
*
Expand Down
Loading

0 comments on commit 9a30a93

Please sign in to comment.