@aws-sdk/client-ivs-realtime 3.382.0 → 3.386.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 (9) hide show
  1. package/README.md +6 -8
  2. package/dist-cjs/models/models_0.js +2 -0
  3. package/dist-es/models/models_0.js +2 -0
  4. package/dist-types/IVSRealTime.d.ts +6 -8
  5. package/dist-types/IVSRealTimeClient.d.ts +6 -8
  6. package/dist-types/index.d.ts +6 -8
  7. package/dist-types/models/models_0.d.ts +8 -1
  8. package/dist-types/ts3.4/models/models_0.d.ts +2 -0
  9. package/package.json +5 -5
package/README.md CHANGED
@@ -9,19 +9,17 @@ AWS SDK for JavaScript IVSRealTime Client for Node.js, Browser and React Native.
9
9
  <p>
10
10
  <b>Introduction</b>
11
11
  </p>
12
- <p>The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP
12
+ <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
13
13
  API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
14
14
  including errors.
15
15
  </p>
16
16
  <p>Terminology:</p>
17
17
  <ul>
18
18
  <li>
19
- <p>The IVS stage API sometimes is referred to as the IVS <i>RealTime</i>
20
- API.</p>
19
+ <p>A <i>stage</i> is a virtual space where participants can exchange video in real time.</p>
21
20
  </li>
22
21
  <li>
23
- <p>A <i>participant token</i> is an authorization token used to publish/subscribe
24
- to a stage.</p>
22
+ <p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
25
23
  </li>
26
24
  <li>
27
25
  <p>A <i>participant object</i> represents participants
@@ -34,11 +32,11 @@ participant tokens and participants.</p>
34
32
  <p>
35
33
  <b>Resources</b>
36
34
  </p>
37
- <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html">Getting Started with Amazon IVS</a>):</p>
35
+ <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>):</p>
38
36
  <ul>
39
37
  <li>
40
38
  <p>
41
- <b>Stage</b> — A stage is a virtual space where multiple participants can exchange audio and video in real time.</p>
39
+ <b>Stage</b> — A stage is a virtual space where participants can exchange video in real time.</p>
42
40
  </li>
43
41
  </ul>
44
42
  <p>
@@ -53,7 +51,7 @@ constraints beyond what is documented there.</p>
53
51
  <p>Tags can help you identify and organize your AWS resources. For example, you can use the
54
52
  same tag for different resources to indicate that they are related. You can also use tags to
55
53
  manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
56
- <p>The Amazon IVS stage API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
54
+ <p>The Amazon IVS real-time API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
57
55
  <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
58
56
  <p>At most 50 tags can be applied to a resource.</p>
59
57
  <p>
package/dist-cjs/models/models_0.js CHANGED
@@ -97,6 +97,8 @@ exports.ParticipantState = {
97
97
  };
98
98
  exports.EventErrorCode = {
99
99
  INSUFFICIENT_CAPABILITIES: "INSUFFICIENT_CAPABILITIES",
100
+ PUBLISHER_NOT_FOUND: "PUBLISHER_NOT_FOUND",
101
+ QUOTA_EXCEEDED: "QUOTA_EXCEEDED",
100
102
  };
101
103
  exports.EventName = {
102
104
  JOINED: "JOINED",
package/dist-es/models/models_0.js CHANGED
@@ -88,6 +88,8 @@ export const ParticipantState = {
88
88
  };
89
89
  export const EventErrorCode = {
90
90
  INSUFFICIENT_CAPABILITIES: "INSUFFICIENT_CAPABILITIES",
91
+ PUBLISHER_NOT_FOUND: "PUBLISHER_NOT_FOUND",
92
+ QUOTA_EXCEEDED: "QUOTA_EXCEEDED",
91
93
  };
92
94
  export const EventName = {
93
95
  JOINED: "JOINED",
package/dist-types/IVSRealTime.d.ts CHANGED
@@ -112,19 +112,17 @@ export interface IVSRealTime {
112
112
  * <p>
113
113
  * <b>Introduction</b>
114
114
  * </p>
115
- * <p>The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP
115
+ * <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
116
116
  * API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
117
117
  * including errors.
118
118
  * </p>
119
119
  * <p>Terminology:</p>
120
120
  * <ul>
121
121
  * <li>
122
- * <p>The IVS stage API sometimes is referred to as the IVS <i>RealTime</i>
123
- * API.</p>
122
+ * <p>A <i>stage</i> is a virtual space where participants can exchange video in real time.</p>
124
123
  * </li>
125
124
  * <li>
126
- * <p>A <i>participant token</i> is an authorization token used to publish/subscribe
127
- * to a stage.</p>
125
+ * <p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
128
126
  * </li>
129
127
  * <li>
130
128
  * <p>A <i>participant object</i> represents participants
@@ -137,11 +135,11 @@ export interface IVSRealTime {
137
135
  * <p>
138
136
  * <b>Resources</b>
139
137
  * </p>
140
- * <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html">Getting Started with Amazon IVS</a>):</p>
138
+ * <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>):</p>
141
139
  * <ul>
142
140
  * <li>
143
141
  * <p>
144
- * <b>Stage</b> — A stage is a virtual space where multiple participants can exchange audio and video in real time.</p>
142
+ * <b>Stage</b> — A stage is a virtual space where participants can exchange video in real time.</p>
145
143
  * </li>
146
144
  * </ul>
147
145
  * <p>
@@ -156,7 +154,7 @@ export interface IVSRealTime {
156
154
  * <p>Tags can help you identify and organize your AWS resources. For example, you can use the
157
155
  * same tag for different resources to indicate that they are related. You can also use tags to
158
156
  * manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
159
- * <p>The Amazon IVS stage API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
157
+ * <p>The Amazon IVS real-time API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
160
158
  * <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
161
159
  * <p>At most 50 tags can be applied to a resource.</p>
162
160
  * <p>
package/dist-types/IVSRealTimeClient.d.ts CHANGED
@@ -163,19 +163,17 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv
163
163
  * <p>
164
164
  * <b>Introduction</b>
165
165
  * </p>
166
- * <p>The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP
166
+ * <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
167
167
  * API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
168
168
  * including errors.
169
169
  * </p>
170
170
  * <p>Terminology:</p>
171
171
  * <ul>
172
172
  * <li>
173
- * <p>The IVS stage API sometimes is referred to as the IVS <i>RealTime</i>
174
- * API.</p>
173
+ * <p>A <i>stage</i> is a virtual space where participants can exchange video in real time.</p>
175
174
  * </li>
176
175
  * <li>
177
- * <p>A <i>participant token</i> is an authorization token used to publish/subscribe
178
- * to a stage.</p>
176
+ * <p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
179
177
  * </li>
180
178
  * <li>
181
179
  * <p>A <i>participant object</i> represents participants
@@ -188,11 +186,11 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv
188
186
  * <p>
189
187
  * <b>Resources</b>
190
188
  * </p>
191
- * <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html">Getting Started with Amazon IVS</a>):</p>
189
+ * <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>):</p>
192
190
  * <ul>
193
191
  * <li>
194
192
  * <p>
195
- * <b>Stage</b> — A stage is a virtual space where multiple participants can exchange audio and video in real time.</p>
193
+ * <b>Stage</b> — A stage is a virtual space where participants can exchange video in real time.</p>
196
194
  * </li>
197
195
  * </ul>
198
196
  * <p>
@@ -207,7 +205,7 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv
207
205
  * <p>Tags can help you identify and organize your AWS resources. For example, you can use the
208
206
  * same tag for different resources to indicate that they are related. You can also use tags to
209
207
  * manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
210
- * <p>The Amazon IVS stage API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
208
+ * <p>The Amazon IVS real-time API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
211
209
  * <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
212
210
  * <p>At most 50 tags can be applied to a resource.</p>
213
211
  * <p>
package/dist-types/index.d.ts CHANGED
@@ -2,19 +2,17 @@
2
2
  * <p>
3
3
  * <b>Introduction</b>
4
4
  * </p>
5
- * <p>The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP
5
+ * <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
6
6
  * API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
7
7
  * including errors.
8
8
  * </p>
9
9
  * <p>Terminology:</p>
10
10
  * <ul>
11
11
  * <li>
12
- * <p>The IVS stage API sometimes is referred to as the IVS <i>RealTime</i>
13
- * API.</p>
12
+ * <p>A <i>stage</i> is a virtual space where participants can exchange video in real time.</p>
14
13
  * </li>
15
14
  * <li>
16
- * <p>A <i>participant token</i> is an authorization token used to publish/subscribe
17
- * to a stage.</p>
15
+ * <p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
18
16
  * </li>
19
17
  * <li>
20
18
  * <p>A <i>participant object</i> represents participants
@@ -27,11 +25,11 @@
27
25
  * <p>
28
26
  * <b>Resources</b>
29
27
  * </p>
30
- * <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html">Getting Started with Amazon IVS</a>):</p>
28
+ * <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>):</p>
31
29
  * <ul>
32
30
  * <li>
33
31
  * <p>
34
- * <b>Stage</b> — A stage is a virtual space where multiple participants can exchange audio and video in real time.</p>
32
+ * <b>Stage</b> — A stage is a virtual space where participants can exchange video in real time.</p>
35
33
  * </li>
36
34
  * </ul>
37
35
  * <p>
@@ -46,7 +44,7 @@
46
44
  * <p>Tags can help you identify and organize your AWS resources. For example, you can use the
47
45
  * same tag for different resources to indicate that they are related. You can also use tags to
48
46
  * manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
49
- * <p>The Amazon IVS stage API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
47
+ * <p>The Amazon IVS real-time API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
50
48
  * <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
51
49
  * <p>At most 50 tags can be applied to a resource.</p>
52
50
  * <p>
package/dist-types/models/models_0.d.ts CHANGED
@@ -549,6 +549,8 @@ export interface ListParticipantEventsRequest {
549
549
  */
550
550
  export declare const EventErrorCode: {
551
551
  readonly INSUFFICIENT_CAPABILITIES: "INSUFFICIENT_CAPABILITIES";
552
+ readonly PUBLISHER_NOT_FOUND: "PUBLISHER_NOT_FOUND";
553
+ readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
552
554
  };
553
555
  /**
554
556
  * @public
@@ -606,7 +608,12 @@ export interface Event {
606
608
  * specific error that occurred. If the event is not an error event, this field is null.
607
609
  * <code>INSUFFICIENT_CAPABILITIES</code> indicates that the participant tried to take an action that the
608
610
  * participant’s token is not allowed to do. For more information about participant
609
- * capabilities, see the <code>capabilities</code> field in <a>CreateParticipantToken</a>.</p>
611
+ * capabilities, see the <code>capabilities</code> field in <a>CreateParticipantToken</a>.
612
+ * <code>QUOTA_EXCEEDED</code> indicates that the number of participants who want to publish/subscribe to a
613
+ * stage exceeds the quota; for more information, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">Service Quotas</a>.
614
+ * <code>PUBLISHER_NOT_FOUND</code> indicates that the participant tried to subscribe to a publisher
615
+ * that doesn’t exist.
616
+ * </p>
610
617
  */
611
618
  errorCode?: EventErrorCode | string;
612
619
  }
package/dist-types/ts3.4/models/models_0.d.ts CHANGED
@@ -151,6 +151,8 @@ export interface ListParticipantEventsRequest {
151
151
  }
152
152
  export declare const EventErrorCode: {
153
153
  readonly INSUFFICIENT_CAPABILITIES: "INSUFFICIENT_CAPABILITIES";
154
+ readonly PUBLISHER_NOT_FOUND: "PUBLISHER_NOT_FOUND";
155
+ readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
154
156
  };
155
157
  export type EventErrorCode =
156
158
  (typeof EventErrorCode)[keyof typeof EventErrorCode];
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ivs-realtime",
3
3
  "description": "AWS SDK for JavaScript Ivs Realtime Client for Node.js, Browser and React Native",
4
- "version": "3.382.0",
4
+ "version": "3.386.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",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.382.0",
25
- "@aws-sdk/credential-provider-node": "3.382.0",
24
+ "@aws-sdk/client-sts": "3.386.0",
25
+ "@aws-sdk/credential-provider-node": "3.386.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.382.0",
30
+ "@aws-sdk/middleware-user-agent": "3.386.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.382.0",
32
+ "@aws-sdk/util-endpoints": "3.386.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",