Token Exchange introduces seamless token exchange capabilities for IVS RTX, enabling customers to upgrade or downgrade token capabilities and update token attributes within the IVS client SDK without forcing clients to disconnect and reconnect.

aws-sdk-dotnet-automation · aws-sdk-dotnet-automation · commit 12dd3418d944 · 2025-12-09T19:27:56.000Z
diff --git a/generator/ServiceModels/ivs-realtime/ivs-realtime-2020-07-14.api.json b/generator/ServiceModels/ivs-realtime/ivs-realtime-2020-07-14.api.json
@@ -1184,7 +1184,9 @@
         "errorCode":{"shape":"EventErrorCode"},
         "destinationStageArn":{"shape":"StageArn"},
         "destinationSessionId":{"shape":"StageSessionId"},
-        "replica":{"shape":"Replica"}
+        "replica":{"shape":"Replica"},
+        "previousToken":{"shape":"ExchangedParticipantToken"},
+        "newToken":{"shape":"ExchangedParticipantToken"}
       }
     },
     "EventErrorCode":{
@@ -1223,9 +1225,19 @@
         "SUBSCRIBE_ERROR",
         "JOIN_ERROR",
         "REPLICATION_STARTED",
-        "REPLICATION_STOPPED"
+        "REPLICATION_STOPPED",
+        "TOKEN_EXCHANGED"
       ]
     },
+    "ExchangedParticipantToken":{
+      "type":"structure",
+      "members":{
+        "capabilities":{"shape":"ParticipantTokenCapabilities"},
+        "attributes":{"shape":"ParticipantTokenAttributes"},
+        "userId":{"shape":"ParticipantTokenUserId"},
+        "expirationTime":{"shape":"ParticipantTokenExpirationTime"}
+      }
+    },
     "Framerate":{
       "type":"float",
       "box":true,
diff --git a/generator/ServiceModels/ivs-realtime/ivs-realtime-2020-07-14.docs.json b/generator/ServiceModels/ivs-realtime/ivs-realtime-2020-07-14.docs.json
@@ -407,6 +407,13 @@
         "Event$name": "<p>The name of the event.</p>"
       }
     },
+    "ExchangedParticipantToken": {
+      "base": "<p>Object specifying an exchanged participant token in a stage, created when an original participant token is updated.</p> <p> <b>Important</b>: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.</p>",
+      "refs": {
+        "Event$previousToken": "<p>Source participant token for <code>TOKEN_EXCHANGED</code> event.</p>",
+        "Event$newToken": "<p>Participant token created during <code>TOKEN_EXCHANGED</code> event.</p>"
+      }
+    },
     "Framerate": {
       "base": null,
       "refs": {
@@ -958,14 +965,16 @@
       "base": null,
       "refs": {
         "CreateParticipantTokenRequest$attributes": "<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 personally identifying, confidential, or sensitive information.</i> </p>",
-        "ParticipantToken$attributes": "<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> </p>",
+        "ExchangedParticipantToken$attributes": "<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 personally identifying, confidential, or sensitive information.</i> </p>",
+        "ParticipantToken$attributes": "<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 personally identifying, confidential, or sensitive information.</i> </p>",
         "ParticipantTokenConfiguration$attributes": "<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 should not be used for personally identifying, confidential, or sensitive information.</i> </p>"
       }
     },
     "ParticipantTokenCapabilities": {
       "base": null,
       "refs": {
         "CreateParticipantTokenRequest$capabilities": "<p>Set of capabilities that the user is allowed to perform in the stage. Default: <code>PUBLISH, SUBSCRIBE</code>.</p>",
+        "ExchangedParticipantToken$capabilities": "<p>Set of capabilities that the user is allowed to perform in the stage.</p>",
         "ParticipantToken$capabilities": "<p>Set of capabilities that the user is allowed to perform in the stage.</p>",
         "ParticipantTokenConfiguration$capabilities": "<p>Set of capabilities that the user is allowed to perform in the stage.</p>"
       }
@@ -999,6 +1008,7 @@
     "ParticipantTokenExpirationTime": {
       "base": null,
       "refs": {
+        "ExchangedParticipantToken$expirationTime": "<p>ISO 8601 timestamp (returned as a string) for when this token expires.</p>",
         "ParticipantToken$expirationTime": "<p>ISO 8601 timestamp (returned as a string) for when this token expires.</p>"
       }
     },
@@ -1025,6 +1035,7 @@
       "base": null,
       "refs": {
         "CreateParticipantTokenRequest$userId": "<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> </p>",
+        "ExchangedParticipantToken$userId": "<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 personally identifying, confidential, or sensitive information.</i> </p>",
         "ParticipantToken$userId": "<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 personally identifying, confidential, or sensitive information.</i> </p>",
         "ParticipantTokenConfiguration$userId": "<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 personally identifying, confidential, or sensitive information.</i> </p>"
       }
diff --git a/generator/ServiceModels/ivs-realtime/ivs-realtime-2020-07-14.normal.json b/generator/ServiceModels/ivs-realtime/ivs-realtime-2020-07-14.normal.json
@@ -1535,6 +1535,14 @@
         "replica":{
           "shape":"Replica",
           "documentation":"<p>If true, this indicates the <code>participantId</code> is a replicated participant. If this is a subscribe event, then this flag refers to <code>remoteParticipantId</code>. Default: <code>false</code>.</p>"
+        },
+        "previousToken":{
+          "shape":"ExchangedParticipantToken",
+          "documentation":"<p>Source participant token for <code>TOKEN_EXCHANGED</code> event.</p>"
+        },
+        "newToken":{
+          "shape":"ExchangedParticipantToken",
+          "documentation":"<p>Participant token created during <code>TOKEN_EXCHANGED</code> event.</p>"
         }
       },
       "documentation":"<p>An occurrence during a stage session.</p>"
@@ -1575,9 +1583,32 @@
         "SUBSCRIBE_ERROR",
         "JOIN_ERROR",
         "REPLICATION_STARTED",
-        "REPLICATION_STOPPED"
+        "REPLICATION_STOPPED",
+        "TOKEN_EXCHANGED"
       ]
     },
+    "ExchangedParticipantToken":{
+      "type":"structure",
+      "members":{
+        "capabilities":{
+          "shape":"ParticipantTokenCapabilities",
+          "documentation":"<p>Set of capabilities that the user is allowed to perform in the stage.</p>"
+        },
+        "attributes":{
+          "shape":"ParticipantTokenAttributes",
+          "documentation":"<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 personally identifying, confidential, or sensitive information.</i> </p>"
+        },
+        "userId":{
+          "shape":"ParticipantTokenUserId",
+          "documentation":"<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 personally identifying, confidential, or sensitive information.</i> </p>"
+        },
+        "expirationTime":{
+          "shape":"ParticipantTokenExpirationTime",
+          "documentation":"<p>ISO 8601 timestamp (returned as a string) for when this token expires.</p>"
+        }
+      },
+      "documentation":"<p>Object specifying an exchanged participant token in a stage, created when an original participant token is updated.</p> <p> <b>Important</b>: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.</p>"
+    },
     "Framerate":{
       "type":"float",
       "box":true,
@@ -2780,7 +2811,7 @@
         },
         "attributes":{
           "shape":"ParticipantTokenAttributes",
-          "documentation":"<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> </p>"
+          "documentation":"<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 personally identifying, confidential, or sensitive information.</i> </p>"
         },
         "duration":{
           "shape":"ParticipantTokenDurationMinutes",
diff --git a/sdk/code-analysis/ServiceAnalysis/IVSRealTime/Generated/PropertyValueRules.xml b/sdk/code-analysis/ServiceAnalysis/IVSRealTime/Generated/PropertyValueRules.xml
@@ -627,6 +627,11 @@
     <max>64</max>
     <pattern>[a-zA-Z0-9-]*</pattern>
   </property-value-rule>
+  <property-value-rule>
+    <property>Amazon.IVSRealTime.Model.ExchangedParticipantToken.UserId</property>
+    <min>0</min>
+    <max>128</max>
+  </property-value-rule>
   <property-value-rule>
     <property>Amazon.IVSRealTime.Model.GridConfiguration.FeaturedParticipantAttribute</property>
     <min>0</min>
diff --git a/sdk/src/Services/IVSRealTime/Generated/Model/Event.cs b/sdk/src/Services/IVSRealTime/Generated/Model/Event.cs
@@ -39,7 +39,9 @@ public partial class Event
         private EventErrorCode _errorCode;
         private DateTime? _eventTime;
         private EventName _name;
+        private ExchangedParticipantToken _newToken;
         private string _participantId;
+        private ExchangedParticipantToken _previousToken;
         private string _remoteParticipantId;
         private bool? _replica;
 
@@ -218,6 +220,24 @@ internal bool IsSetName()
             return this._name != null;
         }
 
+        /// <summary>
+        /// Gets and sets the property NewToken. 
+        /// <para>
+        /// Participant token created during <c>TOKEN_EXCHANGED</c> event.
+        /// </para>
+        /// </summary>
+        public ExchangedParticipantToken NewToken
+        {
+            get { return this._newToken; }
+            set { this._newToken = value; }
+        }
+
+        // Check to see if NewToken property is set
+        internal bool IsSetNewToken()
+        {
+            return this._newToken != null;
+        }
+
         /// <summary>
         /// Gets and sets the property ParticipantId. 
         /// <para>
@@ -238,6 +258,24 @@ internal bool IsSetParticipantId()
             return this._participantId != null;
         }
 
+        /// <summary>
+        /// Gets and sets the property PreviousToken. 
+        /// <para>
+        /// Source participant token for <c>TOKEN_EXCHANGED</c> event.
+        /// </para>
+        /// </summary>
+        public ExchangedParticipantToken PreviousToken
+        {
+            get { return this._previousToken; }
+            set { this._previousToken = value; }
+        }
+
+        // Check to see if PreviousToken property is set
+        internal bool IsSetPreviousToken()
+        {
+            return this._previousToken != null;
+        }
+
         /// <summary>
         /// Gets and sets the property RemoteParticipantId. 
         /// <para>
diff --git a/sdk/src/Services/IVSRealTime/Generated/Model/ExchangedParticipantToken.cs b/sdk/src/Services/IVSRealTime/Generated/Model/ExchangedParticipantToken.cs
@@ -0,0 +1,140 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/*
+ * Do not modify this file. This file is generated from the ivs-realtime-2020-07-14.normal.json service model.
+ */
+using System;
+using System.Collections.Generic;
+using System.Xml.Serialization;
+using System.Text;
+using System.IO;
+using System.Net;
+
+using Amazon.Runtime;
+using Amazon.Runtime.Internal;
+
+#pragma warning disable CS0612,CS0618,CS1570
+namespace Amazon.IVSRealTime.Model
+{
+    /// <summary>
+    /// Object specifying an exchanged participant token in a stage, created when an original
+    /// participant token is updated.
+    /// 
+    ///  
+    /// <para>
+    ///  <b>Important</b>: Treat tokens as opaque; i.e., do not build functionality based
+    /// on token contents. The format of tokens could change in the future.
+    /// </para>
+    /// </summary>
+    public partial class ExchangedParticipantToken
+    {
+        private Dictionary<string, string> _attributes = AWSConfigs.InitializeCollections ? new Dictionary<string, string>() : null;
+        private List<string> _capabilities = AWSConfigs.InitializeCollections ? new List<string>() : null;
+        private DateTime? _expirationTime;
+        private string _userId;
+
+        /// <summary>
+        /// Gets and sets the property Attributes. 
+        /// <para>
+        /// 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 personally identifying, confidential, or sensitive information.</i> 
+        /// </para>
+        /// <para />
+        /// Starting with version 4 of the SDK this property will default to null. If no data for this property is returned
+        /// from the service the property will also be null. This was changed to improve performance and allow the SDK and caller
+        /// to distinguish between a property not set or a property being empty to clear out a value. To retain the previous
+        /// SDK behavior set the AWSConfigs.InitializeCollections static property to true.
+        /// </summary>
+        public Dictionary<string, string> Attributes
+        {
+            get { return this._attributes; }
+            set { this._attributes = value; }
+        }
+
+        // Check to see if Attributes property is set
+        internal bool IsSetAttributes()
+        {
+            return this._attributes != null && (this._attributes.Count > 0 || !AWSConfigs.InitializeCollections); 
+        }
+
+        /// <summary>
+        /// Gets and sets the property Capabilities. 
+        /// <para>
+        /// Set of capabilities that the user is allowed to perform in the stage.
+        /// </para>
+        /// <para />
+        /// Starting with version 4 of the SDK this property will default to null. If no data for this property is returned
+        /// from the service the property will also be null. This was changed to improve performance and allow the SDK and caller
+        /// to distinguish between a property not set or a property being empty to clear out a value. To retain the previous
+        /// SDK behavior set the AWSConfigs.InitializeCollections static property to true.
+        /// </summary>
+        [AWSProperty(Min=0, Max=2)]
+        public List<string> Capabilities
+        {
+            get { return this._capabilities; }
+            set { this._capabilities = value; }
+        }
+
+        // Check to see if Capabilities property is set
+        internal bool IsSetCapabilities()
+        {
+            return this._capabilities != null && (this._capabilities.Count > 0 || !AWSConfigs.InitializeCollections); 
+        }
+
+        /// <summary>
+        /// Gets and sets the property ExpirationTime. 
+        /// <para>
+        /// ISO 8601 timestamp (returned as a string) for when this token expires.
+        /// </para>
+        /// </summary>
+        public DateTime? ExpirationTime
+        {
+            get { return this._expirationTime; }
+            set { this._expirationTime = value; }
+        }
+
+        // Check to see if ExpirationTime property is set
+        internal bool IsSetExpirationTime()
+        {
+            return this._expirationTime.HasValue; 
+        }
+
+        /// <summary>
+        /// Gets and sets the property UserId. 
+        /// <para>
+        /// 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 personally identifying,
+        /// confidential, or sensitive information.</i> 
+        /// </para>
+        /// </summary>
+        [AWSProperty(Min=0, Max=128)]
+        public string UserId
+        {
+            get { return this._userId; }
+            set { this._userId = value; }
+        }
+
+        // Check to see if UserId property is set
+        internal bool IsSetUserId()
+        {
+            return this._userId != null;
+        }
+
+    }
+}
diff --git a/sdk/src/Services/IVSRealTime/Generated/Model/Internal/MarshallTransformations/EventUnmarshaller.cs b/sdk/src/Services/IVSRealTime/Generated/Model/Internal/MarshallTransformations/EventUnmarshaller.cs
@@ -86,12 +86,24 @@ public Event Unmarshall(JsonUnmarshallerContext context, ref StreamingUtf8JsonRe
                     unmarshalledObject.Name = unmarshaller.Unmarshall(context, ref reader);
                     continue;
                 }
+                if (context.TestExpression("newToken", targetDepth))
+                {
+                    var unmarshaller = ExchangedParticipantTokenUnmarshaller.Instance;
+                    unmarshalledObject.NewToken = unmarshaller.Unmarshall(context, ref reader);
+                    continue;
+                }
                 if (context.TestExpression("participantId", targetDepth))
                 {
                     var unmarshaller = StringUnmarshaller.Instance;
                     unmarshalledObject.ParticipantId = unmarshaller.Unmarshall(context, ref reader);
                     continue;
                 }
+                if (context.TestExpression("previousToken", targetDepth))
+                {
+                    var unmarshaller = ExchangedParticipantTokenUnmarshaller.Instance;
+                    unmarshalledObject.PreviousToken = unmarshaller.Unmarshall(context, ref reader);
+                    continue;
+                }
                 if (context.TestExpression("remoteParticipantId", targetDepth))
                 {
                     var unmarshaller = StringUnmarshaller.Instance;
diff --git a/sdk/src/Services/IVSRealTime/Generated/Model/Internal/MarshallTransformations/ExchangedParticipantTokenUnmarshaller.cs b/sdk/src/Services/IVSRealTime/Generated/Model/Internal/MarshallTransformations/ExchangedParticipantTokenUnmarshaller.cs
diff --git a/sdk/src/Services/IVSRealTime/Generated/Model/ParticipantToken.cs b/sdk/src/Services/IVSRealTime/Generated/Model/ParticipantToken.cs
diff --git a/sdk/src/Services/IVSRealTime/Generated/ServiceEnumerations.cs b/sdk/src/Services/IVSRealTime/Generated/ServiceEnumerations.cs
