@aws-sdk/client-chime-sdk-meetings 3.476.0 → 3.478.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.
@@ -31,6 +31,14 @@ export interface UpdateAttendeeCapabilitiesCommandOutput extends UpdateAttendeeC
31
31
  * <p>When using capabilities, be aware of these corner cases:</p>
32
32
  * <ul>
33
33
  * <li>
34
+ * <p>If you specify <code>MeetingFeatures:Video:MaxResolution:None</code> when you create a meeting, all API requests
35
+ * 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>
36
+ * </li>
37
+ * <li>
38
+ * <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
39
+ * <code>Receive</code> for <code>AttendeeCapabilities:Content</code> will be rejected with <code>ValidationError 400</code>.</p>
40
+ * </li>
41
+ * <li>
34
42
  * <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>
35
43
  * 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
36
44
  * to receive and you set your <code>content</code> capability to not receive.</p>
@@ -1,5 +1,5 @@
1
1
  /**
2
- * <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
2
+ * <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
3
3
  * receive meeting notifications. For more information about the meeting APIs, see
4
4
  * <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Meetings.html">Amazon Chime SDK meetings</a>.</p>
5
5
  *
@@ -16,25 +16,33 @@ export declare const MediaCapabilities: {
16
16
  export type MediaCapabilities = (typeof MediaCapabilities)[keyof typeof MediaCapabilities];
17
17
  /**
18
18
  * @public
19
- * <p>The media capabilities of an attendee: audio, video, or content. </p>
19
+ * <p>The media capabilities of an attendee: audio, video, or content.</p>
20
20
  * <note>
21
- * <p>You use the capabilities with a set of values that control what the capabilities can do, such as <code>SendReceive</code> data. For more information about those values, see
22
- * .</p>
21
+ * <p>You use the capabilities with a set of values that control what the capabilities can do, such as <code>SendReceive</code> data. For more information, refer to
22
+ * and .</p>
23
23
  * </note>
24
24
  * <p>When using capabilities, be aware of these corner cases:</p>
25
25
  * <ul>
26
26
  * <li>
27
+ * <p>If you specify <code>MeetingFeatures:Video:MaxResolution:None</code> when you create a meeting, all API requests
28
+ * 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>
29
+ * </li>
30
+ * <li>
31
+ * <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
32
+ * <code>Receive</code> for <code>AttendeeCapabilities:Content</code> will be rejected with <code>ValidationError 400</code>.</p>
33
+ * </li>
34
+ * <li>
27
35
  * <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>
28
- * 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
29
- * to receive and you set your <code>content</code> capability to not receive.</p>
36
+ * 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
37
+ * <code>video</code> capability to receive and you set your <code>content</code> capability to not receive.</p>
30
38
  * </li>
31
39
  * <li>
32
40
  * <p>When you change an <code>audio</code> capability from <code>None</code> or <code>Receive</code> to <code>Send</code> or <code>SendReceive</code> ,
33
- * and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.</p>
41
+ * and an attendee unmutes their microphone, audio flows from the attendee to the other meeting participants.</p>
34
42
  * </li>
35
43
  * <li>
36
44
  * <p>When you change a <code>video</code> or <code>content</code> capability from <code>None</code> or <code>Receive</code> to <code>Send</code> or <code>SendReceive</code> ,
37
- * and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.</p>
45
+ * and the attendee turns on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.</p>
38
46
  * </li>
39
47
  * </ul>
40
48
  */
@@ -100,6 +108,14 @@ export interface Attendee {
100
108
  * <p>When using capabilities, be aware of these corner cases:</p>
101
109
  * <ul>
102
110
  * <li>
111
+ * <p>If you specify <code>MeetingFeatures:Video:MaxResolution:None</code> when you create a meeting, all API requests
112
+ * 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>
113
+ * </li>
114
+ * <li>
115
+ * <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
116
+ * <code>Receive</code> for <code>AttendeeCapabilities:Content</code> will be rejected with <code>ValidationError 400</code>.</p>
117
+ * </li>
118
+ * <li>
103
119
  * <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>
104
120
  * 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
105
121
  * to receive and you set your <code>content</code> capability to not receive.</p>
@@ -116,6 +132,21 @@ export interface Attendee {
116
132
  */
117
133
  Capabilities?: AttendeeCapabilities;
118
134
  }
135
+ /**
136
+ * @public
137
+ * <p>Lists the maximum number of attendees allowed into the meeting.</p>
138
+ * <note>
139
+ * <p>If you specify <code>FHD</code> for <code>MeetingFeatures:Video:MaxResolution</code>, or if you specify
140
+ * <code>UHD</code> for <code>MeetingFeatures:Content:MaxResolution</code>, the maximum number of attendees changes from the default of <code>250</code> to <code>25</code>.</p>
141
+ * </note>
142
+ */
143
+ export interface AttendeeFeatures {
144
+ /**
145
+ * @public
146
+ * <p>The maximum number of attendees allowed into the meeting.</p>
147
+ */
148
+ MaxCount?: number;
149
+ }
119
150
  /**
120
151
  * @public
121
152
  * <p>A structure that contains one or more attendee IDs.</p>
@@ -469,6 +500,14 @@ export interface CreateAttendeeRequest {
469
500
  * <p>When using capabilities, be aware of these corner cases:</p>
470
501
  * <ul>
471
502
  * <li>
503
+ * <p>If you specify <code>MeetingFeatures:Video:MaxResolution:None</code> when you create a meeting, all API requests
504
+ * 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>
505
+ * </li>
506
+ * <li>
507
+ * <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
508
+ * <code>Receive</code> for <code>AttendeeCapabilities:Content</code> will be rejected with <code>ValidationError 400</code>.</p>
509
+ * </li>
510
+ * <li>
472
511
  * <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>
473
512
  * 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
474
513
  * to receive and you set your <code>content</code> capability to not receive.</p>
@@ -495,6 +534,70 @@ export interface CreateAttendeeResponse {
495
534
  */
496
535
  Attendee?: Attendee;
497
536
  }
537
+ /**
538
+ * @public
539
+ * @enum
540
+ */
541
+ export declare const ContentResolution: {
542
+ readonly FHD: "FHD";
543
+ readonly NONE: "None";
544
+ readonly UHD: "UHD";
545
+ };
546
+ /**
547
+ * @public
548
+ */
549
+ export type ContentResolution = (typeof ContentResolution)[keyof typeof ContentResolution];
550
+ /**
551
+ * @public
552
+ * <p>Lists the content (screen share) features for the meeting. Applies to all attendees.</p>
553
+ * <note>
554
+ * <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
555
+ * <code>Receive</code> for <code>AttendeeCapabilities:Content</code> will be rejected with <code>ValidationError 400</code>.</p>
556
+ * </note>
557
+ */
558
+ export interface ContentFeatures {
559
+ /**
560
+ * @public
561
+ * <p>The maximum resolution for the meeting content.</p>
562
+ * <note>
563
+ * <p>Defaults to <code>FHD</code>. To use <code>UHD</code>, you must also provide a <code>MeetingFeatures:Attendee:MaxCount</code>
564
+ * value and override the default size limit of 250 attendees.</p>
565
+ * </note>
566
+ */
567
+ MaxResolution?: ContentResolution;
568
+ }
569
+ /**
570
+ * @public
571
+ * @enum
572
+ */
573
+ export declare const VideoResolution: {
574
+ readonly FHD: "FHD";
575
+ readonly HD: "HD";
576
+ readonly NONE: "None";
577
+ };
578
+ /**
579
+ * @public
580
+ */
581
+ export type VideoResolution = (typeof VideoResolution)[keyof typeof VideoResolution];
582
+ /**
583
+ * @public
584
+ * <p>The video features set for the meeting. Applies to all attendees.</p>
585
+ * <note>
586
+ * <p>If you specify <code>MeetingFeatures:Video:MaxResolution:None</code> when you create a meeting, all API requests
587
+ * 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>
588
+ * </note>
589
+ */
590
+ export interface VideoFeatures {
591
+ /**
592
+ * @public
593
+ * <p>The maximum video resolution for the meeting. Applies to all attendees.</p>
594
+ * <note>
595
+ * <p>Defaults to <code>HD</code>. To use <code>FHD</code>, you must also provide a <code>MeetingFeatures:Attendee:MaxCount</code> value and override the default size
596
+ * limit of 250 attendees.</p>
597
+ * </note>
598
+ */
599
+ MaxResolution?: VideoResolution;
600
+ }
498
601
  /**
499
602
  * @public
500
603
  * <p>The configuration settings of the features available to a meeting.</p>
@@ -505,6 +608,21 @@ export interface MeetingFeaturesConfiguration {
505
608
  * <p>The configuration settings for the audio features available to a meeting.</p>
506
609
  */
507
610
  Audio?: AudioFeatures;
611
+ /**
612
+ * @public
613
+ * <p>The configuration settings for the video features available to a meeting.</p>
614
+ */
615
+ Video?: VideoFeatures;
616
+ /**
617
+ * @public
618
+ * <p>The configuration settings for the content features available to a meeting.</p>
619
+ */
620
+ Content?: ContentFeatures;
621
+ /**
622
+ * @public
623
+ * <p>The configuration settings for the attendee features available to a meeting.</p>
624
+ */
625
+ Attendee?: AttendeeFeatures;
508
626
  }
509
627
  /**
510
628
  * @public
@@ -513,7 +631,7 @@ export interface MeetingFeaturesConfiguration {
513
631
  export interface NotificationsConfiguration {
514
632
  /**
515
633
  * @public
516
- * <p>The ARN of the AWS Lambda function in the notifications configuration.</p>
634
+ * <p>The ARN of the Amazon Web Services Lambda function in the notifications configuration.</p>
517
635
  */
518
636
  LambdaFunctionArn?: string;
519
637
  /**
@@ -576,7 +694,7 @@ export interface CreateMeetingRequest {
576
694
  * <code>us-west-1</code>,
577
695
  * <code>us-west-2</code>.
578
696
  * </p>
579
- * <p>Available values in AWS GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>
697
+ * <p>Available values in Amazon Web Services GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>
580
698
  */
581
699
  MediaRegion: string | undefined;
582
700
  /**
@@ -627,7 +745,7 @@ export interface CreateMeetingRequest {
627
745
  * <i>AWS General Reference</i>.</p>
628
746
  * </li>
629
747
  * <li>
630
- * <p>You can only tag resources that are located in the specified AWS Region for the AWS account.</p>
748
+ * <p>You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services account.</p>
631
749
  * </li>
632
750
  * <li>
633
751
  * <p>To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the
@@ -679,21 +797,41 @@ export interface MediaPlacement {
679
797
  /**
680
798
  * @public
681
799
  * <p>The turn control URL.</p>
800
+ * <important>
801
+ * <p>
802
+ * <b>This parameter is deprecated and no longer used by the Amazon Chime SDK.</b>
803
+ * </p>
804
+ * </important>
682
805
  */
683
806
  TurnControlUrl?: string;
684
807
  /**
685
808
  * @public
686
809
  * <p>The screen data URL.</p>
810
+ * <important>
811
+ * <p>
812
+ * <b>This parameter is deprecated and no longer used by the Amazon Chime SDK.</b>
813
+ * </p>
814
+ * </important>
687
815
  */
688
816
  ScreenDataUrl?: string;
689
817
  /**
690
818
  * @public
691
819
  * <p>The screen viewing URL.</p>
820
+ * <important>
821
+ * <p>
822
+ * <b>This parameter is deprecated and no longer used by the Amazon Chime SDK.</b>
823
+ * </p>
824
+ * </important>
692
825
  */
693
826
  ScreenViewingUrl?: string;
694
827
  /**
695
828
  * @public
696
829
  * <p>The screen sharing URL.</p>
830
+ * <important>
831
+ * <p>
832
+ * <b>This parameter is deprecated and no longer used by the Amazon Chime SDK.</b>
833
+ * </p>
834
+ * </important>
697
835
  */
698
836
  ScreenSharingUrl?: string;
699
837
  /**
@@ -734,7 +872,7 @@ export interface Meeting {
734
872
  * <code>eu-west-1</code>, <code>eu-west-2</code>, <code>eu-west-3</code>,
735
873
  * <code>sa-east-1</code>, <code>us-east-1</code>, <code>us-east-2</code>,
736
874
  * <code>us-west-1</code>, <code>us-west-2</code>.</p>
737
- * <p>Available values in AWS GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>
875
+ * <p>Available values in Amazon Web Services GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>
738
876
  */
739
877
  MediaRegion?: string;
740
878
  /**
@@ -807,7 +945,7 @@ export interface CreateMeetingWithAttendeesRequest {
807
945
  * <code>us-west-1</code>,
808
946
  * <code>us-west-2</code>.
809
947
  * </p>
810
- * <p>Available values in AWS GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>
948
+ * <p>Available values in Amazon Web Services GovCloud (US) Regions: <code>us-gov-east-1</code>, <code>us-gov-west-1</code>.</p>
811
949
  */
812
950
  MediaRegion: string | undefined;
813
951
  /**
@@ -1119,7 +1257,7 @@ export interface EngineTranscribeMedicalSettings {
1119
1257
  VocabularyName?: string;
1120
1258
  /**
1121
1259
  * @public
1122
- * <p>The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region. </p>
1260
+ * <p>The Amazon Web Services Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region. </p>
1123
1261
  */
1124
1262
  Region?: TranscribeMedicalRegion;
1125
1263
  /**
@@ -1263,7 +1401,7 @@ export interface EngineTranscribeSettings {
1263
1401
  VocabularyName?: string;
1264
1402
  /**
1265
1403
  * @public
1266
- * <p>The AWS Region in which to use Amazon Transcribe.</p>
1404
+ * <p>The Amazon Web Services Region in which to use Amazon Transcribe.</p>
1267
1405
  * <p>If you don't specify a Region, then the <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html">MediaRegion</a> of the meeting is used.
1268
1406
  * However, if Amazon Transcribe is not available in the <code>MediaRegion</code>, then a <code>TranscriptFailed</code> event is sent.</p>
1269
1407
  * <p>Use <code>auto</code> to use Amazon Transcribe in a Region near the meeting’s <code>MediaRegion</code>. For more information, refer to
@@ -4,4 +4,4 @@ import { ChimeSDKMeetingsPaginationConfiguration } from "./Interfaces";
4
4
  /**
5
5
  * @public
6
6
  */
7
- export declare function paginateListAttendees(config: ChimeSDKMeetingsPaginationConfiguration, input: ListAttendeesCommandInput, ...additionalArguments: any): Paginator<ListAttendeesCommandOutput>;
7
+ export declare const paginateListAttendees: (config: ChimeSDKMeetingsPaginationConfiguration, input: ListAttendeesCommandInput, ...rest: any[]) => Paginator<ListAttendeesCommandOutput>;
@@ -19,6 +19,9 @@ export interface Attendee {
19
19
  JoinToken?: string;
20
20
  Capabilities?: AttendeeCapabilities;
21
21
  }
22
+ export interface AttendeeFeatures {
23
+ MaxCount?: number;
24
+ }
22
25
  export interface AttendeeIdItem {
23
26
  AttendeeId: string | undefined;
24
27
  }
@@ -156,8 +159,31 @@ export interface CreateAttendeeRequest {
156
159
  export interface CreateAttendeeResponse {
157
160
  Attendee?: Attendee;
158
161
  }
162
+ export declare const ContentResolution: {
163
+ readonly FHD: "FHD";
164
+ readonly NONE: "None";
165
+ readonly UHD: "UHD";
166
+ };
167
+ export type ContentResolution =
168
+ (typeof ContentResolution)[keyof typeof ContentResolution];
169
+ export interface ContentFeatures {
170
+ MaxResolution?: ContentResolution;
171
+ }
172
+ export declare const VideoResolution: {
173
+ readonly FHD: "FHD";
174
+ readonly HD: "HD";
175
+ readonly NONE: "None";
176
+ };
177
+ export type VideoResolution =
178
+ (typeof VideoResolution)[keyof typeof VideoResolution];
179
+ export interface VideoFeatures {
180
+ MaxResolution?: VideoResolution;
181
+ }
159
182
  export interface MeetingFeaturesConfiguration {
160
183
  Audio?: AudioFeatures;
184
+ Video?: VideoFeatures;
185
+ Content?: ContentFeatures;
186
+ Attendee?: AttendeeFeatures;
161
187
  }
162
188
  export interface NotificationsConfiguration {
163
189
  LambdaFunctionArn?: string;
@@ -4,8 +4,8 @@ import {
4
4
  ListAttendeesCommandOutput,
5
5
  } from "../commands/ListAttendeesCommand";
6
6
  import { ChimeSDKMeetingsPaginationConfiguration } from "./Interfaces";
7
- export declare function paginateListAttendees(
7
+ export declare const paginateListAttendees: (
8
8
  config: ChimeSDKMeetingsPaginationConfiguration,
9
9
  input: ListAttendeesCommandInput,
10
- ...additionalArguments: any
11
- ): Paginator<ListAttendeesCommandOutput>;
10
+ ...rest: any[]
11
+ ) => Paginator<ListAttendeesCommandOutput>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-chime-sdk-meetings",
3
3
  "description": "AWS SDK for JavaScript Chime Sdk Meetings Client for Node.js, Browser and React Native",
4
- "version": "3.476.0",
4
+ "version": "3.478.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,20 +20,21 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.476.0",
24
- "@aws-sdk/core": "3.476.0",
25
- "@aws-sdk/credential-provider-node": "3.476.0",
23
+ "@aws-sdk/client-sts": "3.478.0",
24
+ "@aws-sdk/core": "3.477.0",
25
+ "@aws-sdk/credential-provider-node": "3.478.0",
26
26
  "@aws-sdk/middleware-host-header": "3.468.0",
27
27
  "@aws-sdk/middleware-logger": "3.468.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.468.0",
29
29
  "@aws-sdk/middleware-signing": "3.468.0",
30
- "@aws-sdk/middleware-user-agent": "3.470.0",
30
+ "@aws-sdk/middleware-user-agent": "3.478.0",
31
31
  "@aws-sdk/region-config-resolver": "3.470.0",
32
32
  "@aws-sdk/types": "3.468.0",
33
- "@aws-sdk/util-endpoints": "3.470.0",
33
+ "@aws-sdk/util-endpoints": "3.478.0",
34
34
  "@aws-sdk/util-user-agent-browser": "3.468.0",
35
35
  "@aws-sdk/util-user-agent-node": "3.470.0",
36
36
  "@smithy/config-resolver": "^2.0.21",
37
+ "@smithy/core": "^1.2.0",
37
38
  "@smithy/fetch-http-handler": "^2.3.1",
38
39
  "@smithy/hash-node": "^2.0.17",
39
40
  "@smithy/invalid-dependency": "^2.0.15",