AWS Device Farm Update: This release adds support for interacting with devices during a remote access session using the remoteDriverEndpoint interface

Author: AWS

.changes/next-release/feature-AWSDeviceFarm-49282e0.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS Device Farm",
+    "contributor": "",
+    "description": "This release adds support for interacting with devices during a remote access session using the remoteDriverEndpoint interface"
+}

services/devicefarm/src/main/resources/codegen-resources/service-2.json

@@ -218,7 +218,7 @@
         {"shape":"LimitExceededException"},
         {"shape":"ServiceAccountException"}
       ],
-      "documentation":"<p>Deletes an AWS Device Farm project, given the project ARN.</p> <p> Deleting this resource does not stop an in-progress run.</p>"
+      "documentation":"<p>Deletes an AWS Device Farm project, given the project ARN. You cannot delete a project if it has an active run or session.</p> <important> <p>You cannot undo this operation.</p> </important>"
     },
     "DeleteRemoteAccessSession":{
       "name":"DeleteRemoteAccessSession",
@@ -234,7 +234,7 @@
         {"shape":"LimitExceededException"},
         {"shape":"ServiceAccountException"}
       ],
-      "documentation":"<p>Deletes a completed remote access session and its results.</p>"
+      "documentation":"<p>Deletes a completed remote access session and its results. You cannot delete a remote access session if it is still active.</p> <important> <p>You cannot undo this operation.</p> </important>"
     },
     "DeleteRun":{
       "name":"DeleteRun",
@@ -250,7 +250,7 @@
         {"shape":"LimitExceededException"},
         {"shape":"ServiceAccountException"}
       ],
-      "documentation":"<p>Deletes the run, given the run ARN.</p> <p> Deleting this resource does not stop an in-progress run.</p>"
+      "documentation":"<p>Deletes the run, given the run ARN. You cannot delete a run if it is still active.</p> <important> <p>You cannot undo this operation.</p> </important>"
     },
     "DeleteTestGridProject":{
       "name":"DeleteTestGridProject",
@@ -266,7 +266,7 @@
         {"shape":"CannotDeleteException"},
         {"shape":"InternalServiceException"}
       ],
-      "documentation":"<p> Deletes a Selenium testing project and all content generated under it. </p> <important> <p>You cannot undo this operation.</p> </important> <note> <p>You cannot delete a project if it has active sessions.</p> </note>"
+      "documentation":"<p> Deletes a Selenium testing project and all content generated under it. You cannot delete a project if it has active sessions.</p> <important> <p>You cannot undo this operation.</p> </important>"
     },
     "DeleteUpload":{
       "name":"DeleteUpload",
@@ -1423,11 +1423,6 @@
       "documentation":"<p>The requested object could not be deleted.</p>",
       "exception":true
     },
-    "ClientId":{
-      "type":"string",
-      "max":64,
-      "min":0
-    },
     "ContentType":{
       "type":"string",
       "max":64,
@@ -1683,37 +1678,20 @@
           "shape":"AmazonResourceName",
           "documentation":"<p>The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.</p>"
         },
-        "sshPublicKey":{
-          "shape":"SshPublicKey",
-          "documentation":"<p>Ignored. The public key of the <code>ssh</code> key pair you want to use for connecting to remote devices in your remote debugging session. This key is required only if <code>remoteDebugEnabled</code> is set to <code>true</code>.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
-        },
-        "remoteDebugEnabled":{
-          "shape":"Boolean",
-          "documentation":"<p>Set to <code>true</code> if you want to access devices remotely for debugging in your remote access session.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
-        },
-        "remoteRecordEnabled":{
-          "shape":"Boolean",
-          "documentation":"<p>Set to <code>true</code> to enable remote recording for the remote access session.</p>"
-        },
-        "remoteRecordAppArn":{
-          "shape":"AmazonResourceName",
-          "documentation":"<p>The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.</p>"
-        },
         "name":{
           "shape":"Name",
           "documentation":"<p>The name of the remote access session to create.</p>"
         },
-        "clientId":{
-          "shape":"ClientId",
-          "documentation":"<p>Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same <code>clientId</code> value in each call to <code>CreateRemoteAccessSession</code>. This identifier is required only if <code>remoteDebugEnabled</code> is set to <code>true</code>.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
-        },
         "configuration":{
           "shape":"CreateRemoteAccessSessionConfiguration",
           "documentation":"<p>The configuration information for the remote access session request.</p>"
         },
         "interactionMode":{
           "shape":"InteractionMode",
-          "documentation":"<p>The interaction mode of the remote access session. Valid values are:</p> <ul> <li> <p>INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.</p> </li> <li> <p>NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.</p> </li> <li> <p>VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.</p> </li> </ul>"
+          "documentation":"<p>The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available.</p>",
+          "deprecated":true,
+          "deprecatedMessage":"Changing the interactive mode of Remote Access sessions is no longer available.",
+          "deprecatedSince":"2019-09-09"
         },
         "skipAppResign":{
           "shape":"Boolean",
@@ -2089,7 +2067,10 @@
         },
         "remoteDebugEnabled":{
           "shape":"Boolean",
-          "documentation":"<p>This flag is set to <code>true</code> if remote debugging is enabled for the device.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
+          "documentation":"<p>This flag is set to <code>true</code> if remote debugging is enabled for the device.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>",
+          "deprecated":true,
+          "deprecatedMessage":"Direct Device Access is no longer available.",
+          "deprecatedSince":"2019-09-09"
         },
         "fleetType":{
           "shape":"String",
@@ -2858,10 +2839,6 @@
         }
       }
     },
-    "HostAddress":{
-      "type":"string",
-      "max":1024
-    },
     "IdempotencyException":{
       "type":"structure",
       "members":{
@@ -4239,6 +4216,20 @@
       "type":"list",
       "member":{"shape":"RecurringCharge"}
     },
+    "RemoteAccessEndpoints":{
+      "type":"structure",
+      "members":{
+        "remoteDriverEndpoint":{
+          "shape":"SensitiveURL",
+          "documentation":"<p>URL for controlling the device using WebDriver-compliant clients, like Appium, during the remote access session.</p>"
+        },
+        "interactiveEndpoint":{
+          "shape":"SensitiveURL",
+          "documentation":"<p>URL for viewing and interacting with the device during the remote access session.</p>"
+        }
+      },
+      "documentation":"<p>Represents the remote endpoints for viewing and controlling a device during a remote access session.</p>"
+    },
     "RemoteAccessSession":{
       "type":"structure",
       "members":{
@@ -4282,26 +4273,6 @@
           "shape":"AmazonResourceName",
           "documentation":"<p>The ARN of the instance.</p>"
         },
-        "remoteDebugEnabled":{
-          "shape":"Boolean",
-          "documentation":"<p>This flag is set to <code>true</code> if remote debugging is enabled for the remote access session.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
-        },
-        "remoteRecordEnabled":{
-          "shape":"Boolean",
-          "documentation":"<p>This flag is set to <code>true</code> if remote recording is enabled for the remote access session.</p>"
-        },
-        "remoteRecordAppArn":{
-          "shape":"AmazonResourceName",
-          "documentation":"<p>The ARN for the app to be recorded in the remote access session.</p>"
-        },
-        "hostAddress":{
-          "shape":"HostAddress",
-          "documentation":"<p>IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
-        },
-        "clientId":{
-          "shape":"ClientId",
-          "documentation":"<p>Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
-        },
         "billingMethod":{
           "shape":"BillingMethod",
           "documentation":"<p>The billing method of the remote access session. Possible values include <code>METERED</code> or <code>UNMETERED</code>. For more information about metered devices, see <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology\">AWS Device Farm terminology</a>.</p>"
@@ -4312,15 +4283,21 @@
         },
         "endpoint":{
           "shape":"String",
-          "documentation":"<p>The endpoint for the remote access sesssion.</p>"
+          "documentation":"<p>The endpoint for the remote access session. This field is deprecated, and is replaced by the new <code>endpoints.interactiveEndpoint</code> field.</p>",
+          "deprecated":true,
+          "deprecatedMessage":"This field is deprecated, and is replaced by the new endpoints.interactiveEndpoint field.",
+          "deprecatedSince":"2025-11-17"
         },
         "deviceUdid":{
           "shape":"String",
           "documentation":"<p>Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
         },
         "interactionMode":{
           "shape":"InteractionMode",
-          "documentation":"<p>The interaction mode of the remote access session. Valid values are:</p> <ul> <li> <p>INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.</p> </li> <li> <p>NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.</p> </li> <li> <p>VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.</p> </li> </ul>"
+          "documentation":"<p>The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available.</p>",
+          "deprecated":true,
+          "deprecatedMessage":"Changing the interactive mode of Remote Access sessions is no longer available.",
+          "deprecatedSince":"2019-09-09"
         },
         "skipAppResign":{
           "shape":"SkipAppResign",
@@ -4337,7 +4314,8 @@
         "appUpload":{
           "shape":"AmazonResourceName",
           "documentation":"<p>The ARN for the app to be installed onto your device.</p>"
-        }
+        },
+        "endpoints":{"shape":"RemoteAccessEndpoints"}
       },
       "documentation":"<p>Represents information about the remote access session.</p>"
     },
@@ -4769,7 +4747,7 @@
     },
     "SensitiveURL":{
       "type":"string",
-      "max":2048,
+      "max":4096,
       "min":0,
       "sensitive":true
     },
@@ -4790,11 +4768,6 @@
       "min":0
     },
     "SkipAppResign":{"type":"boolean"},
-    "SshPublicKey":{
-      "type":"string",
-      "max":8192,
-      "min":0
-    },
     "StopJobRequest":{
       "type":"structure",
       "required":["arn"],