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

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

@@ -8,6 +8,7 @@ export declare class AccessDeniedException extends __BaseException {
     readonly name: "AccessDeniedException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>User does not have sufficient access to perform this action.</p>
      */
     exceptionMessage?: string;
@@ -33,14 +34,17 @@ export type ParticipantTokenCapability = (typeof ParticipantTokenCapability)[key
  */
 export interface CreateParticipantTokenRequest {
     /**
+     * @public
      * <p>ARN of the stage to which this token is scoped.</p>
      */
     stageArn: string | undefined;
     /**
+     * @public
      * <p>Duration (in minutes), after which the token expires. Default:  720 (12 hours).</p>
      */
     duration?: number;
     /**
+     * @public
      * <p>Name that can be specified to help identify the token. This can be any UTF-8 encoded
      *          text. <i>This field is exposed to all stage participants and should not be used for
      *             personally identifying, confidential, or sensitive information.</i>
@@ -48,6 +52,7 @@ export interface CreateParticipantTokenRequest {
      */
     userId?: string;
     /**
+     * @public
      * <p>Application-provided attributes to encode into the token and attach to a stage. Map keys
      *          and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
      *             <i>This field is exposed to all stage participants and should not be used for
@@ -56,6 +61,7 @@ export interface CreateParticipantTokenRequest {
      */
     attributes?: Record<string, string>;
     /**
+     * @public
      * <p>Set of capabilities that the user is allowed to perform in the stage. Default:
      *             <code>PUBLISH, SUBSCRIBE</code>.</p>
      */
@@ -67,14 +73,17 @@ export interface CreateParticipantTokenRequest {
  */
 export interface ParticipantToken {
     /**
+     * @public
      * <p>Unique identifier for this participant token, assigned by IVS.</p>
      */
     participantId?: string;
     /**
+     * @public
      * <p>The issued client token, encrypted.</p>
      */
     token?: string;
     /**
+     * @public
      * <p>Customer-assigned name to help identify the token; this can be used to link a
      *          participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
      *             <i>This field is exposed to all stage participants and should not be used for
@@ -83,6 +92,7 @@ export interface ParticipantToken {
      */
     userId?: string;
     /**
+     * @public
      * <p>Application-provided attributes to encode into the token and attach to a stage.
      *             <i>This field is exposed to all stage participants and should not be used for
      *             personally identifying, confidential, or sensitive information.</i>
@@ -90,14 +100,17 @@ export interface ParticipantToken {
      */
     attributes?: Record<string, string>;
     /**
+     * @public
      * <p>Duration (in minutes), after which the participant token expires. Default:  720 (12 hours).</p>
      */
     duration?: number;
     /**
+     * @public
      * <p>Set of capabilities that the user is allowed to perform in the stage.</p>
      */
     capabilities?: (ParticipantTokenCapability | string)[];
     /**
+     * @public
      * <p>ISO 8601 timestamp (returned as a string) for when this token expires.</p>
      */
     expirationTime?: Date;
@@ -107,6 +120,7 @@ export interface ParticipantToken {
  */
 export interface CreateParticipantTokenResponse {
     /**
+     * @public
      * <p>The participant token that was created.</p>
      */
     participantToken?: ParticipantToken;
@@ -119,6 +133,7 @@ export declare class PendingVerification extends __BaseException {
     readonly name: "PendingVerification";
     readonly $fault: "client";
     /**
+     * @public
      * <p> Your account is pending verification. </p>
      */
     exceptionMessage?: string;
@@ -135,6 +150,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     readonly name: "ResourceNotFoundException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>Request references a resource which does not exist.</p>
      */
     exceptionMessage?: string;
@@ -151,6 +167,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     readonly name: "ServiceQuotaExceededException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>Request would cause a service quota to be exceeded.</p>
      */
     exceptionMessage?: string;
@@ -167,6 +184,7 @@ export declare class ValidationException extends __BaseException {
     readonly name: "ValidationException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
      */
     exceptionMessage?: string;
@@ -181,11 +199,13 @@ export declare class ValidationException extends __BaseException {
  */
 export interface ParticipantTokenConfiguration {
     /**
+     * @public
      * <p>Duration (in minutes), after which the corresponding participant token expires. Default:
      *          720 (12 hours).</p>
      */
     duration?: number;
     /**
+     * @public
      * <p>Customer-assigned name to help identify the token; this can be used to link a
      *          participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
      *             <i>This field is exposed to all stage participants and should not be used for
@@ -194,6 +214,7 @@ export interface ParticipantTokenConfiguration {
      */
     userId?: string;
     /**
+     * @public
      * <p>Application-provided attributes to encode into the corresponding participant token and
      *          attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length
      *          of this field is 1 KB total. <i>This field is exposed to all stage participants and
@@ -203,6 +224,7 @@ export interface ParticipantTokenConfiguration {
      */
     attributes?: Record<string, string>;
     /**
+     * @public
      * <p>Set of capabilities that the user is allowed to perform in the stage.</p>
      */
     capabilities?: (ParticipantTokenCapability | string)[];
@@ -212,14 +234,17 @@ export interface ParticipantTokenConfiguration {
  */
 export interface CreateStageRequest {
     /**
+     * @public
      * <p>Optional name that can be specified for the stage being created.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>Array of participant token configuration objects to attach to the new stage.</p>
      */
     participantTokenConfigurations?: ParticipantTokenConfiguration[];
     /**
+     * @public
      * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
      *             (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
      *             Resources</a> for details, including restrictions that apply to tags and "Tag naming
@@ -234,18 +259,22 @@ export interface CreateStageRequest {
  */
 export interface Stage {
     /**
+     * @public
      * <p>Stage ARN.</p>
      */
     arn: string | undefined;
     /**
+     * @public
      * <p>Stage name.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>ID of the active session within the stage.</p>
      */
     activeSessionId?: string;
     /**
+     * @public
      * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
      *             (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
      *             Resources</a> for details, including restrictions that apply to tags and "Tag naming
@@ -259,10 +288,12 @@ export interface Stage {
  */
 export interface CreateStageResponse {
     /**
+     * @public
      * <p>The stage that was created.</p>
      */
     stage?: Stage;
     /**
+     * @public
      * <p>Participant tokens attached to the stage. These correspond to the
      *             <code>participants</code> in the request.</p>
      */
@@ -276,6 +307,7 @@ export declare class ConflictException extends __BaseException {
     readonly name: "ConflictException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>Updating or deleting a resource can cause an inconsistent state.</p>
      */
     exceptionMessage?: string;
@@ -289,6 +321,7 @@ export declare class ConflictException extends __BaseException {
  */
 export interface DeleteStageRequest {
     /**
+     * @public
      * <p>ARN of the stage to be deleted.</p>
      */
     arn: string | undefined;
@@ -303,15 +336,18 @@ export interface DeleteStageResponse {
  */
 export interface DisconnectParticipantRequest {
     /**
+     * @public
      * <p>ARN of the stage to which the participant is attached.</p>
      */
     stageArn: string | undefined;
     /**
+     * @public
      * <p>Identifier of the participant to be disconnected. This is assigned by IVS and returned
      *          by <a>CreateParticipantToken</a>.</p>
      */
     participantId: string | undefined;
     /**
+     * @public
      * <p>Description of why this participant is being disconnected.</p>
      */
     reason?: string;
@@ -326,14 +362,17 @@ export interface DisconnectParticipantResponse {
  */
 export interface GetParticipantRequest {
     /**
+     * @public
      * <p>Stage ARN.</p>
      */
     stageArn: string | undefined;
     /**
+     * @public
      * <p>ID of a session within the stage.</p>
      */
     sessionId: string | undefined;
     /**
+     * @public
      * <p>Unique identifier for the participant. This is assigned by IVS and returned by <a>CreateParticipantToken</a>.</p>
      */
     participantId: string | undefined;
@@ -356,10 +395,12 @@ export type ParticipantState = (typeof ParticipantState)[keyof typeof Participan
  */
 export interface Participant {
     /**
+     * @public
      * <p>Unique identifier for this participant, assigned by IVS.</p>
      */
     participantId?: string;
     /**
+     * @public
      * <p>Customer-assigned name to help identify the token; this can be used to link a
      *          participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
      *             <i>This field is exposed to all stage participants and should not be used for
@@ -367,15 +408,18 @@ export interface Participant {
      */
     userId?: string;
     /**
+     * @public
      * <p>Whether the participant is connected to or disconnected from the stage.</p>
      */
     state?: ParticipantState | string;
     /**
+     * @public
      * <p>ISO 8601 timestamp (returned as a string) when the participant first joined the stage
      *          session.</p>
      */
     firstJoinTime?: Date;
     /**
+     * @public
      * <p>Application-provided attributes to encode into the token and attach to a stage. Map keys
      *          and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
      *             <i>This field is exposed to all stage participants and should not be used for
@@ -383,6 +427,7 @@ export interface Participant {
      */
     attributes?: Record<string, string>;
     /**
+     * @public
      * <p>Whether the participant ever published to the stage session.</p>
      */
     published?: boolean;
@@ -392,6 +437,7 @@ export interface Participant {
  */
 export interface GetParticipantResponse {
     /**
+     * @public
      * <p>The participant that is returned.</p>
      */
     participant?: Participant;
@@ -401,6 +447,7 @@ export interface GetParticipantResponse {
  */
 export interface GetStageRequest {
     /**
+     * @public
      * <p>ARN of the stage for which the information is to be retrieved.</p>
      */
     arn: string | undefined;
@@ -410,6 +457,7 @@ export interface GetStageRequest {
  */
 export interface GetStageResponse {
     /**
+     * @public
      * <p>The stage that is returned.</p>
      */
     stage?: Stage;
@@ -419,10 +467,12 @@ export interface GetStageResponse {
  */
 export interface GetStageSessionRequest {
     /**
+     * @public
      * <p>ARN of the stage for which the information is to be retrieved.</p>
      */
     stageArn: string | undefined;
     /**
+     * @public
      * <p>ID of a session within the stage.</p>
      */
     sessionId: string | undefined;
@@ -436,14 +486,17 @@ export interface GetStageSessionRequest {
  */
 export interface StageSession {
     /**
+     * @public
      * <p>ID of the session within the stage.</p>
      */
     sessionId?: string;
     /**
+     * @public
      * <p> ISO 8601 timestamp (returned as a string) when this stage session began.</p>
      */
     startTime?: Date;
     /**
+     * @public
      * <p>ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if
      *          the stage is active.</p>
      */
@@ -454,6 +507,7 @@ export interface StageSession {
  */
 export interface GetStageSessionResponse {
     /**
+     * @public
      * <p>The stage session that is returned.</p>
      */
     stageSession?: StageSession;
@@ -463,23 +517,28 @@ export interface GetStageSessionResponse {
  */
 export interface ListParticipantEventsRequest {
     /**
+     * @public
      * <p>Stage ARN.</p>
      */
     stageArn: string | undefined;
     /**
+     * @public
      * <p>ID of a session within the stage.</p>
      */
     sessionId: string | undefined;
     /**
+     * @public
      * <p>Unique identifier for this participant. This is assigned by IVS and returned by <a>CreateParticipantToken</a>.</p>
      */
     participantId: string | undefined;
     /**
+     * @public
      * <p>The first participant to retrieve. This is used for pagination; see the
      *             <code>nextToken</code> response field.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>Maximum number of results to return. Default: 50.</p>
      */
     maxResults?: number;
@@ -520,24 +579,29 @@ export type EventName = (typeof EventName)[keyof typeof EventName];
  */
 export interface Event {
     /**
+     * @public
      * <p>The name of the event.</p>
      */
     name?: EventName | string;
     /**
+     * @public
      * <p>Unique identifier for the participant who triggered the event. This is assigned by
      *          IVS.</p>
      */
     participantId?: string;
     /**
+     * @public
      * <p>ISO 8601 timestamp (returned as a string) for when the event occurred.</p>
      */
     eventTime?: Date;
     /**
+     * @public
      * <p>Unique identifier for the remote participant. For a subscribe event, this is the
      *          publisher. For a publish or join event, this is null. This is assigned by IVS.</p>
      */
     remoteParticipantId?: string;
     /**
+     * @public
      * <p>If the event is an error event, the error code is provided to give insight into the
      *          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
@@ -551,10 +615,12 @@ export interface Event {
  */
 export interface ListParticipantEventsResponse {
     /**
+     * @public
      * <p>List of the matching events.</p>
      */
     events: Event[] | undefined;
     /**
+     * @public
      * <p>If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the
      *          request to get the next set. </p>
      */
@@ -565,14 +631,17 @@ export interface ListParticipantEventsResponse {
  */
 export interface ListParticipantsRequest {
     /**
+     * @public
      * <p>Stage ARN.</p>
      */
     stageArn: string | undefined;
     /**
+     * @public
      * <p>ID of the session within the stage.</p>
      */
     sessionId: string | undefined;
     /**
+     * @public
      * <p>Filters the response list to match the specified user ID. Only one of
      *             <code>filterByUserId</code>, <code>filterByPublished</code>, or
      *             <code>filterByState</code> can be provided per request. A <code>userId</code> is a
@@ -581,23 +650,27 @@ export interface ListParticipantsRequest {
      */
     filterByUserId?: string;
     /**
+     * @public
      * <p>Filters the response list to only show participants who published during the stage
      *          session. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, or
      *             <code>filterByState</code> can be provided per request.</p>
      */
     filterByPublished?: boolean;
     /**
+     * @public
      * <p>Filters the response list to only show participants in the specified state. Only one of
      *             <code>filterByUserId</code>, <code>filterByPublished</code>, or
      *             <code>filterByState</code> can be provided per request.</p>
      */
     filterByState?: ParticipantState | string;
     /**
+     * @public
      * <p>The first participant to retrieve. This is used for pagination; see the
      *             <code>nextToken</code> response field.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>Maximum number of results to return. Default: 50.</p>
      */
     maxResults?: number;
@@ -608,10 +681,12 @@ export interface ListParticipantsRequest {
  */
 export interface ParticipantSummary {
     /**
+     * @public
      * <p>Unique identifier for this participant, assigned by IVS.</p>
      */
     participantId?: string;
     /**
+     * @public
      * <p>Customer-assigned name to help identify the token; this can be used to link a
      *          participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
      *             <i>This field is exposed to all stage participants and should not be used for
@@ -619,15 +694,18 @@ export interface ParticipantSummary {
      */
     userId?: string;
     /**
+     * @public
      * <p>Whether the participant is connected to or disconnected from the stage.</p>
      */
     state?: ParticipantState | string;
     /**
+     * @public
      * <p>ISO 8601 timestamp (returned as a string) when the participant first joined the stage
      *          session.</p>
      */
     firstJoinTime?: Date;
     /**
+     * @public
      * <p>Whether the participant ever published to the stage session.</p>
      */
     published?: boolean;
@@ -637,10 +715,12 @@ export interface ParticipantSummary {
  */
 export interface ListParticipantsResponse {
     /**
+     * @public
      * <p>List of the matching participants (summary information only).</p>
      */
     participants: ParticipantSummary[] | undefined;
     /**
+     * @public
      * <p>If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the
      *          request to get the next set.</p>
      */
@@ -651,11 +731,13 @@ export interface ListParticipantsResponse {
  */
 export interface ListStagesRequest {
     /**
+     * @public
      * <p>The first stage to retrieve. This is used for pagination; see the <code>nextToken</code>
      *          response field.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>Maximum number of results to return. Default: 50.</p>
      */
     maxResults?: number;
@@ -666,18 +748,22 @@ export interface ListStagesRequest {
  */
 export interface StageSummary {
     /**
+     * @public
      * <p>Stage ARN.</p>
      */
     arn: string | undefined;
     /**
+     * @public
      * <p>Stage name.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>ID of the active session within the stage.</p>
      */
     activeSessionId?: string;
     /**
+     * @public
      * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
      *             (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
      *             Resources</a> for details, including restrictions that apply to tags and "Tag naming
@@ -691,10 +777,12 @@ export interface StageSummary {
  */
 export interface ListStagesResponse {
     /**
+     * @public
      * <p>List of the matching stages (summary information only).</p>
      */
     stages: StageSummary[] | undefined;
     /**
+     * @public
      * <p>If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the
      *          request to get the next set.</p>
      */
@@ -705,15 +793,18 @@ export interface ListStagesResponse {
  */
 export interface ListStageSessionsRequest {
     /**
+     * @public
      * <p>Stage ARN.</p>
      */
     stageArn: string | undefined;
     /**
+     * @public
      * <p>The first stage to retrieve. This is used for pagination; see the <code>nextToken</code>
      *          response field.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>Maximum number of results to return. Default: 50.</p>
      */
     maxResults?: number;
@@ -724,14 +815,17 @@ export interface ListStageSessionsRequest {
  */
 export interface StageSessionSummary {
     /**
+     * @public
      * <p>ID of the session within the stage.</p>
      */
     sessionId?: string;
     /**
+     * @public
      * <p> ISO 8601 timestamp (returned as a string) when this stage session began.</p>
      */
     startTime?: Date;
     /**
+     * @public
      * <p>ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if
      *          the stage is active.</p>
      */
@@ -742,10 +836,12 @@ export interface StageSessionSummary {
  */
 export interface ListStageSessionsResponse {
     /**
+     * @public
      * <p>List of matching stage sessions.</p>
      */
     stageSessions: StageSessionSummary[] | undefined;
     /**
+     * @public
      * <p>If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the
      *          request to get the next set.</p>
      */
@@ -759,6 +855,7 @@ export declare class InternalServerException extends __BaseException {
     readonly name: "InternalServerException";
     readonly $fault: "server";
     /**
+     * @public
      * <p>Unexpected error during processing of request.</p>
      */
     exceptionMessage?: string;
@@ -772,6 +869,7 @@ export declare class InternalServerException extends __BaseException {
  */
 export interface ListTagsForResourceRequest {
     /**
+     * @public
      * <p>The ARN of the resource to be retrieved. The ARN must be URL-encoded.</p>
      */
     resourceArn: string | undefined;
@@ -781,6 +879,7 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResponse {
     /**
+     * @public
      * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
      *             (key:value)</code>.</p>
      */
@@ -791,10 +890,12 @@ export interface ListTagsForResourceResponse {
  */
 export interface TagResourceRequest {
     /**
+     * @public
      * <p>The ARN of the resource to be tagged. The ARN must be URL-encoded.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>Array of tags to be added or updated. Array of maps, each of the form
      *             <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
      *             Resources</a> for details, including restrictions that apply to tags and "Tag naming
@@ -813,10 +914,12 @@ export interface TagResourceResponse {
  */
 export interface UntagResourceRequest {
     /**
+     * @public
      * <p>The ARN of the resource to be untagged. The ARN must be URL-encoded.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>Array of tags to be removed. Array of maps, each of the form <code>string:string
      *             (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
      *             Resources</a> for details, including restrictions that apply to tags and "Tag naming
@@ -835,10 +938,12 @@ export interface UntagResourceResponse {
  */
 export interface UpdateStageRequest {
     /**
+     * @public
      * <p>ARN of the stage to be updated.</p>
      */
     arn: string | undefined;
     /**
+     * @public
      * <p>Name of the stage to be updated.</p>
      */
     name?: string;
@@ -848,6 +953,7 @@ export interface UpdateStageRequest {
  */
 export interface UpdateStageResponse {
     /**
+     * @public
      * <p>The updated stage.</p>
      */
     stage?: Stage;

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.379.1",
+  "version": "3.385.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@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.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "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",