feat(client-ivs-realtime): Add QUOTA_EXCEEDED and PUBLISHER_NOT_FOUND…

… to EventErrorCode for stage health events.
aws · Aug 7, 2023 · 19047c8 · 19047c8
1 parent 29e5e50
commit 19047c8
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 33 deletions.
diff --git a/clients/client-ivs-realtime/README.md b/clients/client-ivs-realtime/README.md
@@ -9,19 +9,17 @@ AWS SDK for JavaScript IVSRealTime Client for Node.js, Browser and React Native.
 <p>
 <b>Introduction</b>
 </p>
-<p>The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP
+<p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
 API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
 including errors.
 </p>
 <p>Terminology:</p>
 <ul>
 <li>
-<p>The IVS stage API sometimes is referred to as the IVS <i>RealTime</i>
-API.</p>
+<p>A <i>stage</i>  is a virtual space where participants can exchange video in real time.</p>
 </li>
 <li>
-<p>A <i>participant token</i> is an authorization token used to publish/subscribe
-to a stage.</p>
+<p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
 </li>
 <li>
 <p>A <i>participant object</i> represents participants
@@ -34,11 +32,11 @@ participant tokens and participants.</p>
 <p>
 <b>Resources</b>
 </p>
-<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>
+<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>
 <ul>
 <li>
 <p>
-<b>Stage</b> — A stage is a virtual space where multiple participants can exchange audio and video in real time.</p>
+<b>Stage</b> — A stage is a virtual space where participants can exchange video in real time.</p>
 </li>
 </ul>
 <p>
@@ -53,7 +51,7 @@ constraints beyond what is documented there.</p>
 <p>Tags can help you identify and organize your AWS resources. For example, you can use the
 same tag for different resources to indicate that they are related. You can also use tags to
 manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
-<p>The Amazon IVS stage API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
+<p>The Amazon IVS real-time API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
 <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
 <p>At most 50 tags can be applied to a resource.</p>
 <p>

diff --git a/clients/client-ivs-realtime/src/IVSRealTime.ts b/clients/client-ivs-realtime/src/IVSRealTime.ts
@@ -287,19 +287,17 @@ export interface IVSRealTime {
  * <p>
  *             <b>Introduction</b>
  *          </p>
- *          <p>The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP
+ *          <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
  * 	  API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
  * 	  including errors.
  *     </p>
  *          <p>Terminology:</p>
  *          <ul>
  *             <li>
- *                <p>The IVS stage API sometimes is referred to as the IVS <i>RealTime</i>
- *           API.</p>
+ *                <p>A <i>stage</i>  is a virtual space where participants can exchange video in real time.</p>
  *             </li>
  *             <li>
- *                <p>A <i>participant token</i> is an authorization token used to publish/subscribe
- *           to a stage.</p>
+ *                <p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
  *             </li>
  *             <li>
  *                <p>A <i>participant object</i> represents participants
@@ -312,11 +310,11 @@ export interface IVSRealTime {
  *          <p>
  *             <b>Resources</b>
  *          </p>
- *          <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>
+ *          <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>
  *          <ul>
  *             <li>
  *                <p>
- *                   <b>Stage</b> — A stage is a virtual space where multiple participants can exchange audio and video in real time.</p>
+ *                   <b>Stage</b> — A stage is a virtual space where participants can exchange video in real time.</p>
  *             </li>
  *          </ul>
  *          <p>
@@ -331,7 +329,7 @@ export interface IVSRealTime {
  *          <p>Tags can help you identify and organize your AWS resources. For example, you can use the
  *       same tag for different resources to indicate that they are related. You can also use tags to
  *       manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
- *          <p>The Amazon IVS stage API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
+ *          <p>The Amazon IVS real-time API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
  *       <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
  *          <p>At most 50 tags can be applied to a resource.</p>
  *          <p>

diff --git a/clients/client-ivs-realtime/src/IVSRealTimeClient.ts b/clients/client-ivs-realtime/src/IVSRealTimeClient.ts
@@ -293,19 +293,17 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv
  * <p>
  *             <b>Introduction</b>
  *          </p>
- *          <p>The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP
+ *          <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
  * 	  API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
  * 	  including errors.
  *     </p>
  *          <p>Terminology:</p>
  *          <ul>
  *             <li>
- *                <p>The IVS stage API sometimes is referred to as the IVS <i>RealTime</i>
- *           API.</p>
+ *                <p>A <i>stage</i>  is a virtual space where participants can exchange video in real time.</p>
  *             </li>
  *             <li>
- *                <p>A <i>participant token</i> is an authorization token used to publish/subscribe
- *           to a stage.</p>
+ *                <p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
  *             </li>
  *             <li>
  *                <p>A <i>participant object</i> represents participants
@@ -318,11 +316,11 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv
  *          <p>
  *             <b>Resources</b>
  *          </p>
- *          <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>
+ *          <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>
  *          <ul>
  *             <li>
  *                <p>
- *                   <b>Stage</b> — A stage is a virtual space where multiple participants can exchange audio and video in real time.</p>
+ *                   <b>Stage</b> — A stage is a virtual space where participants can exchange video in real time.</p>
  *             </li>
  *          </ul>
  *          <p>
@@ -337,7 +335,7 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv
  *          <p>Tags can help you identify and organize your AWS resources. For example, you can use the
  *       same tag for different resources to indicate that they are related. You can also use tags to
  *       manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
- *          <p>The Amazon IVS stage API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
+ *          <p>The Amazon IVS real-time API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
  *       <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
  *          <p>At most 50 tags can be applied to a resource.</p>
  *          <p>

diff --git a/clients/client-ivs-realtime/src/index.ts b/clients/client-ivs-realtime/src/index.ts
@@ -4,19 +4,17 @@
  * <p>
  *             <b>Introduction</b>
  *          </p>
- *          <p>The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP
+ *          <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
  * 	  API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
  * 	  including errors.
  *     </p>
  *          <p>Terminology:</p>
  *          <ul>
  *             <li>
- *                <p>The IVS stage API sometimes is referred to as the IVS <i>RealTime</i>
- *           API.</p>
+ *                <p>A <i>stage</i>  is a virtual space where participants can exchange video in real time.</p>
  *             </li>
  *             <li>
- *                <p>A <i>participant token</i> is an authorization token used to publish/subscribe
- *           to a stage.</p>
+ *                <p>A <i>participant token</i> is a token that authenticates a participant when they join a stage.</p>
  *             </li>
  *             <li>
  *                <p>A <i>participant object</i> represents participants
@@ -29,11 +27,11 @@
  *          <p>
  *             <b>Resources</b>
  *          </p>
- *          <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>
+ *          <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>
  *          <ul>
  *             <li>
  *                <p>
- *                   <b>Stage</b> — A stage is a virtual space where multiple participants can exchange audio and video in real time.</p>
+ *                   <b>Stage</b> — A stage is a virtual space where participants can exchange video in real time.</p>
  *             </li>
  *          </ul>
  *          <p>
@@ -48,7 +46,7 @@
  *          <p>Tags can help you identify and organize your AWS resources. For example, you can use the
  *       same tag for different resources to indicate that they are related. You can also use tags to
  *       manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
- *          <p>The Amazon IVS stage API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
+ *          <p>The Amazon IVS real-time API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
  *       <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
  *          <p>At most 50 tags can be applied to a resource.</p>
  *          <p>

diff --git a/clients/client-ivs-realtime/src/models/models_0.ts b/clients/client-ivs-realtime/src/models/models_0.ts
@@ -663,6 +663,8 @@ export interface ListParticipantEventsRequest {
  */
 export const EventErrorCode = {
   INSUFFICIENT_CAPABILITIES: "INSUFFICIENT_CAPABILITIES",
+  PUBLISHER_NOT_FOUND: "PUBLISHER_NOT_FOUND",
+  QUOTA_EXCEEDED: "QUOTA_EXCEEDED",
 } as const;
 
 /**
@@ -728,7 +730,12 @@ export interface Event {
    *          specific error that occurred. If the event is not an error event, this field is null.
    *          <code>INSUFFICIENT_CAPABILITIES</code> indicates that the participant tried to take an action that the
    *          participant’s token is not allowed to do. For more information about participant
-   *          capabilities, see the <code>capabilities</code> field in <a>CreateParticipantToken</a>.</p>
+   *          capabilities, see the <code>capabilities</code> field in <a>CreateParticipantToken</a>.
+   * 		 <code>QUOTA_EXCEEDED</code> indicates that the number of participants who want to publish/subscribe to a
+   * 		 stage exceeds the quota; for more information, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">Service Quotas</a>.
+   * 		 <code>PUBLISHER_NOT_FOUND</code> indicates that the participant tried to subscribe to a publisher
+   * 		 that doesn’t exist.
+   * </p>
    */
   errorCode?: EventErrorCode | string;
 }