From 19047c814f1ee2f37db292e0036e1966a9ec05c7 Mon Sep 17 00:00:00 2001
From: awstools
Introduction
The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP
+ 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.
Terminology: The IVS stage API sometimes is referred to as the IVS RealTime
-API. A stage is a virtual space where participants can exchange video in real time. A participant token is an authorization token used to publish/subscribe
-to a stage. A participant token is a token that authenticates a participant when they join a stage. A participant object represents participants
@@ -34,11 +32,11 @@ participant tokens and participants.
Resources
The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS): The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):
-Stage — A stage is a virtual space where multiple participants can exchange audio and video in real time.
@@ -53,7 +51,7 @@ constraints beyond what is documented there.
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 Access Tags).
-The Amazon IVS stage API has these tag-related endpoints: TagResource, UntagResource, and +
The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
diff --git a/clients/client-ivs-realtime/src/IVSRealTime.ts b/clients/client-ivs-realtime/src/IVSRealTime.ts index d4faee4e7353a..44c81859969ff 100644 --- a/clients/client-ivs-realtime/src/IVSRealTime.ts +++ b/clients/client-ivs-realtime/src/IVSRealTime.ts @@ -287,19 +287,17 @@ export interface IVSRealTime { *
* Introduction *
- *The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP + *
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. *
*Terminology:
*The IVS stage API sometimes is referred to as the IVS RealTime - * API.
+ *A stage is a virtual space where participants can exchange video in real time.
*A participant token is an authorization token used to publish/subscribe - * to a stage.
+ *A participant token is a token that authenticates a participant when they join a stage.
*A participant object represents participants @@ -312,11 +310,11 @@ export interface IVSRealTime { *
* Resources *
- *The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):
+ *The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):
*- * Stage — A stage is a virtual space where multiple participants can exchange audio and video in real time.
+ * Stage — A stage is a virtual space where participants can exchange video in real time. *@@ -331,7 +329,7 @@ export interface IVSRealTime { *
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 Access Tags).
- *The Amazon IVS stage API has these tag-related endpoints: TagResource, UntagResource, and + *
The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and * ListTagsForResource. The following resource supports tagging: Stage.
*At most 50 tags can be applied to a resource.
*diff --git a/clients/client-ivs-realtime/src/IVSRealTimeClient.ts b/clients/client-ivs-realtime/src/IVSRealTimeClient.ts index 6c5ef3a886fd0..07b8d5abe4423 100644 --- 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 *
* Introduction *
- *The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP + *
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. *
*Terminology:
*The IVS stage API sometimes is referred to as the IVS RealTime - * API.
+ *A stage is a virtual space where participants can exchange video in real time.
*A participant token is an authorization token used to publish/subscribe - * to a stage.
+ *A participant token is a token that authenticates a participant when they join a stage.
*A participant object represents participants @@ -318,11 +316,11 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv *
* Resources *
- *The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):
+ *The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):
*- * Stage — A stage is a virtual space where multiple participants can exchange audio and video in real time.
+ * Stage — A stage is a virtual space where participants can exchange video in real time. *@@ -337,7 +335,7 @@ export interface IVSRealTimeClientResolvedConfig extends IVSRealTimeClientResolv *
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 Access Tags).
- *The Amazon IVS stage API has these tag-related endpoints: TagResource, UntagResource, and + *
The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and * ListTagsForResource. The following resource supports tagging: Stage.
*At most 50 tags can be applied to a resource.
*diff --git a/clients/client-ivs-realtime/src/index.ts b/clients/client-ivs-realtime/src/index.ts index e026d3a917346..2fadd24661464 100644 --- a/clients/client-ivs-realtime/src/index.ts +++ b/clients/client-ivs-realtime/src/index.ts @@ -4,19 +4,17 @@ *
* Introduction *
- *The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP + *
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. *
*Terminology:
*The IVS stage API sometimes is referred to as the IVS RealTime - * API.
+ *A stage is a virtual space where participants can exchange video in real time.
*A participant token is an authorization token used to publish/subscribe - * to a stage.
+ *A participant token is a token that authenticates a participant when they join a stage.
*A participant object represents participants @@ -29,11 +27,11 @@ *
* Resources *
- *The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):
+ *The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):
*- * Stage — A stage is a virtual space where multiple participants can exchange audio and video in real time.
+ * Stage — A stage is a virtual space where participants can exchange video in real time. *@@ -48,7 +46,7 @@ *
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 Access Tags).
- *The Amazon IVS stage API has these tag-related endpoints: TagResource, UntagResource, and + *
The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and * ListTagsForResource. The following resource supports tagging: Stage.
*At most 50 tags can be applied to a resource.
*
diff --git a/clients/client-ivs-realtime/src/models/models_0.ts b/clients/client-ivs-realtime/src/models/models_0.ts
index 63e8d0cf6c3f6..3b03e753d5621 100644
--- 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.
* INSUFFICIENT_CAPABILITIES
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 capabilities
field in CreateParticipantToken.
capabilities
field in CreateParticipantToken.
+ * QUOTA_EXCEEDED
indicates that the number of participants who want to publish/subscribe to a
+ * stage exceeds the quota; for more information, see Service Quotas.
+ * PUBLISHER_NOT_FOUND
indicates that the participant tried to subscribe to a publisher
+ * that doesn’t exist.
+ *
*/
errorCode?: EventErrorCode | string;
}