@aws-sdk/client-ivs-realtime 3.385.0 → 3.387.0

package/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>

package/dist-cjs/IVSRealTimeClient.js

@@ -15,8 +15,8 @@ Object.defineProperty(exports, "__Client", { enumerable: true, get: function ()
 const EndpointParameters_1 = require("./endpoint/EndpointParameters");
 const runtimeConfig_1 = require("./runtimeConfig");
 class IVSRealTimeClient extends smithy_client_1.Client {
-    constructor(configuration) {
-        const _config_0 = (0, runtimeConfig_1.getRuntimeConfig)(configuration);
+    constructor(...[configuration]) {
+        const _config_0 = (0, runtimeConfig_1.getRuntimeConfig)(configuration || {});
         const _config_1 = (0, EndpointParameters_1.resolveClientEndpointParameters)(_config_0);
         const _config_2 = (0, config_resolver_1.resolveRegionConfig)(_config_1);
         const _config_3 = (0, middleware_endpoint_1.resolveEndpointConfig)(_config_2);

package/dist-cjs/models/models_0.js

@@ -97,6 +97,8 @@ exports.ParticipantState = {
 };
 exports.EventErrorCode = {
     INSUFFICIENT_CAPABILITIES: "INSUFFICIENT_CAPABILITIES",
+    PUBLISHER_NOT_FOUND: "PUBLISHER_NOT_FOUND",
+    QUOTA_EXCEEDED: "QUOTA_EXCEEDED",
 };
 exports.EventName = {
     JOINED: "JOINED",

package/dist-es/IVSRealTimeClient.js

@@ -12,8 +12,8 @@ import { resolveClientEndpointParameters, } from "./endpoint/EndpointParameters"
 import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig";
 export { __Client };
 export class IVSRealTimeClient extends __Client {
-    constructor(configuration) {
-        const _config_0 = __getRuntimeConfig(configuration);
+    constructor(...[configuration]) {
+        const _config_0 = __getRuntimeConfig(configuration || {});
         const _config_1 = resolveClientEndpointParameters(_config_0);
         const _config_2 = resolveRegionConfig(_config_1);
         const _config_3 = resolveEndpointConfig(_config_2);

package/dist-es/models/models_0.js

@@ -88,6 +88,8 @@ export const ParticipantState = {
 };
 export const EventErrorCode = {
     INSUFFICIENT_CAPABILITIES: "INSUFFICIENT_CAPABILITIES",
+    PUBLISHER_NOT_FOUND: "PUBLISHER_NOT_FOUND",
+    QUOTA_EXCEEDED: "QUOTA_EXCEEDED",
 };
 export const EventName = {
     JOINED: "JOINED",

package/dist-types/IVSRealTime.d.ts

@@ -112,19 +112,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
@@ -137,11 +135,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>
@@ -156,7 +154,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>

package/dist-types/IVSRealTimeClient.d.ts

@@ -7,7 +7,7 @@ import { EndpointInputConfig, EndpointResolvedConfig } from "@smithy/middleware-
 import { RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry";
 import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
 import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
-import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
+import { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
 import { CreateParticipantTokenCommandInput, CreateParticipantTokenCommandOutput } from "./commands/CreateParticipantTokenCommand";
 import { CreateStageCommandInput, CreateStageCommandOutput } from "./commands/CreateStageCommand";
 import { DeleteStageCommandInput, DeleteStageCommandOutput } from "./commands/DeleteStageCommand";
@@ -163,19 +163,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
@@ -188,11 +186,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>
@@ -207,7 +205,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>
@@ -293,7 +291,7 @@ export declare class IVSRealTimeClient extends __Client<__HttpHandlerOptions, Se
      * The resolved configuration of IVSRealTimeClient class. This is resolved and normalized from the {@link IVSRealTimeClientConfig | constructor configuration interface}.
      */
     readonly config: IVSRealTimeClientResolvedConfig;
-    constructor(configuration: IVSRealTimeClientConfig);
+    constructor(...[configuration]: __CheckOptionalClientConfig<IVSRealTimeClientConfig>);
     /**
      * Destroy underlying resources, like sockets. It's usually not necessary to do this.
      * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.

package/dist-types/index.d.ts

@@ -2,19 +2,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
@@ -27,11 +25,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>
@@ -46,7 +44,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>

package/dist-types/models/models_0.d.ts

@@ -549,6 +549,8 @@ export interface ListParticipantEventsRequest {
  */
 export declare const EventErrorCode: {
     readonly INSUFFICIENT_CAPABILITIES: "INSUFFICIENT_CAPABILITIES";
+    readonly PUBLISHER_NOT_FOUND: "PUBLISHER_NOT_FOUND";
+    readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
 };
 /**
  * @public
@@ -606,7 +608,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;
 }

package/dist-types/ts3.4/IVSRealTimeClient.d.ts

@@ -32,6 +32,7 @@ import {
 } from "@smithy/smithy-client";
 import {
   BodyLengthCalculator as __BodyLengthCalculator,
+  CheckOptionalClientConfig as __CheckOptionalClientConfig,
   ChecksumConstructor as __ChecksumConstructor,
   Decoder as __Decoder,
   Encoder as __Encoder,
@@ -197,6 +198,8 @@ export declare class IVSRealTimeClient extends __Client<
   IVSRealTimeClientResolvedConfig
 > {
   readonly config: IVSRealTimeClientResolvedConfig;
-  constructor(configuration: IVSRealTimeClientConfig);
+  constructor(
+    ...[configuration]: __CheckOptionalClientConfig<IVSRealTimeClientConfig>
+  );
   destroy(): void;
 }

package/dist-types/ts3.4/models/models_0.d.ts

@@ -151,6 +151,8 @@ export interface ListParticipantEventsRequest {
 }
 export declare const EventErrorCode: {
   readonly INSUFFICIENT_CAPABILITIES: "INSUFFICIENT_CAPABILITIES";
+  readonly PUBLISHER_NOT_FOUND: "PUBLISHER_NOT_FOUND";
+  readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
 };
 export type EventErrorCode =
   (typeof EventErrorCode)[keyof typeof EventErrorCode];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-ivs-realtime",
   "description": "AWS SDK for JavaScript Ivs Realtime Client for Node.js, Browser and React Native",
-  "version": "3.385.0",
+  "version": "3.387.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,37 +21,37 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.385.0",
-    "@aws-sdk/credential-provider-node": "3.385.0",
-    "@aws-sdk/middleware-host-header": "3.379.1",
-    "@aws-sdk/middleware-logger": "3.378.0",
-    "@aws-sdk/middleware-recursion-detection": "3.378.0",
-    "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.382.0",
-    "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.382.0",
-    "@aws-sdk/util-user-agent-browser": "3.378.0",
-    "@aws-sdk/util-user-agent-node": "3.378.0",
-    "@smithy/config-resolver": "^2.0.1",
-    "@smithy/fetch-http-handler": "^2.0.1",
-    "@smithy/hash-node": "^2.0.1",
-    "@smithy/invalid-dependency": "^2.0.1",
-    "@smithy/middleware-content-length": "^2.0.1",
-    "@smithy/middleware-endpoint": "^2.0.1",
-    "@smithy/middleware-retry": "^2.0.1",
-    "@smithy/middleware-serde": "^2.0.1",
+    "@aws-sdk/client-sts": "3.387.0",
+    "@aws-sdk/credential-provider-node": "3.387.0",
+    "@aws-sdk/middleware-host-header": "3.387.0",
+    "@aws-sdk/middleware-logger": "3.387.0",
+    "@aws-sdk/middleware-recursion-detection": "3.387.0",
+    "@aws-sdk/middleware-signing": "3.387.0",
+    "@aws-sdk/middleware-user-agent": "3.387.0",
+    "@aws-sdk/types": "3.387.0",
+    "@aws-sdk/util-endpoints": "3.387.0",
+    "@aws-sdk/util-user-agent-browser": "3.387.0",
+    "@aws-sdk/util-user-agent-node": "3.387.0",
+    "@smithy/config-resolver": "^2.0.2",
+    "@smithy/fetch-http-handler": "^2.0.2",
+    "@smithy/hash-node": "^2.0.2",
+    "@smithy/invalid-dependency": "^2.0.2",
+    "@smithy/middleware-content-length": "^2.0.2",
+    "@smithy/middleware-endpoint": "^2.0.2",
+    "@smithy/middleware-retry": "^2.0.2",
+    "@smithy/middleware-serde": "^2.0.2",
     "@smithy/middleware-stack": "^2.0.0",
-    "@smithy/node-config-provider": "^2.0.1",
-    "@smithy/node-http-handler": "^2.0.1",
-    "@smithy/protocol-http": "^2.0.1",
-    "@smithy/smithy-client": "^2.0.1",
-    "@smithy/types": "^2.0.2",
-    "@smithy/url-parser": "^2.0.1",
+    "@smithy/node-config-provider": "^2.0.2",
+    "@smithy/node-http-handler": "^2.0.2",
+    "@smithy/protocol-http": "^2.0.2",
+    "@smithy/smithy-client": "^2.0.2",
+    "@smithy/types": "^2.1.0",
+    "@smithy/url-parser": "^2.0.2",
     "@smithy/util-base64": "^2.0.0",
     "@smithy/util-body-length-browser": "^2.0.0",
     "@smithy/util-body-length-node": "^2.0.0",
-    "@smithy/util-defaults-mode-browser": "^2.0.1",
-    "@smithy/util-defaults-mode-node": "^2.0.1",
+    "@smithy/util-defaults-mode-browser": "^2.0.2",
+    "@smithy/util-defaults-mode-node": "^2.0.2",
     "@smithy/util-retry": "^2.0.0",
     "@smithy/util-utf8": "^2.0.0",
     "tslib": "^2.5.0"