feat(client-device-farm): Add an optional configuration to the ScheduleRun and CreateRemoteAccessSession API to set a device level http/s proxy.

awstools · awstools · commit 6702dbb2311e · 2025-02-25T19:22:54.000Z
diff --git a/clients/client-device-farm/src/commands/CreateRemoteAccessSessionCommand.ts b/clients/client-device-farm/src/commands/CreateRemoteAccessSessionCommand.ts
@@ -50,6 +50,10 @@ export interface CreateRemoteAccessSessionCommandOutput extends CreateRemoteAcce
  *     vpceConfigurationArns: [ // AmazonResourceNames
  *       "STRING_VALUE",
  *     ],
+ *     deviceProxy: { // DeviceProxy
+ *       host: "STRING_VALUE", // required
+ *       port: Number("int"), // required
+ *     },
  *   },
  *   interactionMode: "INTERACTIVE" || "NO_VIDEO" || "VIDEO_ONLY",
  *   skipAppResign: true || false,
@@ -141,6 +145,10 @@ export interface CreateRemoteAccessSessionCommandOutput extends CreateRemoteAcce
  * //       ],
  * //       vpcId: "STRING_VALUE", // required
  * //     },
+ * //     deviceProxy: { // DeviceProxy
+ * //       host: "STRING_VALUE", // required
+ * //       port: Number("int"), // required
+ * //     },
  * //   },
  * // };
  *
diff --git a/clients/client-device-farm/src/commands/GetDevicePoolCompatibilityCommand.ts b/clients/client-device-farm/src/commands/GetDevicePoolCompatibilityCommand.ts
@@ -59,6 +59,10 @@ export interface GetDevicePoolCompatibilityCommandOutput extends GetDevicePoolCo
  *     vpceConfigurationArns: [ // AmazonResourceNames
  *       "STRING_VALUE",
  *     ],
+ *     deviceProxy: { // DeviceProxy
+ *       host: "STRING_VALUE", // required
+ *       port: Number("int"), // required
+ *     },
  *     customerArtifactPaths: { // CustomerArtifactPaths
  *       iosPaths: [ // IosPaths
  *         "STRING_VALUE",
diff --git a/clients/client-device-farm/src/commands/GetRemoteAccessSessionCommand.ts b/clients/client-device-farm/src/commands/GetRemoteAccessSessionCommand.ts
@@ -125,6 +125,10 @@ export interface GetRemoteAccessSessionCommandOutput extends GetRemoteAccessSess
  * //       ],
  * //       vpcId: "STRING_VALUE", // required
  * //     },
+ * //     deviceProxy: { // DeviceProxy
+ * //       host: "STRING_VALUE", // required
+ * //       port: Number("int"), // required
+ * //     },
  * //   },
  * // };
  *
diff --git a/clients/client-device-farm/src/commands/GetRunCommand.ts b/clients/client-device-farm/src/commands/GetRunCommand.ts
@@ -83,6 +83,10 @@ export interface GetRunCommandOutput extends GetRunResult, __MetadataBearer {}
  * //       uplinkLossPercent: Number("int"),
  * //       downlinkLossPercent: Number("int"),
  * //     },
+ * //     deviceProxy: { // DeviceProxy
+ * //       host: "STRING_VALUE", // required
+ * //       port: Number("int"), // required
+ * //     },
  * //     parsingResultUrl: "STRING_VALUE",
  * //     resultCode: "PARSING_FAILED" || "VPC_ENDPOINT_SETUP_FAILED",
  * //     seed: Number("int"),
diff --git a/clients/client-device-farm/src/commands/ListRemoteAccessSessionsCommand.ts b/clients/client-device-farm/src/commands/ListRemoteAccessSessionsCommand.ts
@@ -127,6 +127,10 @@ export interface ListRemoteAccessSessionsCommandOutput extends ListRemoteAccessS
  * //         ],
  * //         vpcId: "STRING_VALUE", // required
  * //       },
+ * //       deviceProxy: { // DeviceProxy
+ * //         host: "STRING_VALUE", // required
+ * //         port: Number("int"), // required
+ * //       },
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",
diff --git a/clients/client-device-farm/src/commands/ListRunsCommand.ts b/clients/client-device-farm/src/commands/ListRunsCommand.ts
@@ -85,6 +85,10 @@ export interface ListRunsCommandOutput extends ListRunsResult, __MetadataBearer
  * //         uplinkLossPercent: Number("int"),
  * //         downlinkLossPercent: Number("int"),
  * //       },
+ * //       deviceProxy: { // DeviceProxy
+ * //         host: "STRING_VALUE", // required
+ * //         port: Number("int"), // required
+ * //       },
  * //       parsingResultUrl: "STRING_VALUE",
  * //       resultCode: "PARSING_FAILED" || "VPC_ENDPOINT_SETUP_FAILED",
  * //       seed: Number("int"),
diff --git a/clients/client-device-farm/src/commands/ScheduleRunCommand.ts b/clients/client-device-farm/src/commands/ScheduleRunCommand.ts
@@ -72,6 +72,10 @@ export interface ScheduleRunCommandOutput extends ScheduleRunResult, __MetadataB
  *     vpceConfigurationArns: [ // AmazonResourceNames
  *       "STRING_VALUE",
  *     ],
+ *     deviceProxy: { // DeviceProxy
+ *       host: "STRING_VALUE", // required
+ *       port: Number("int"), // required
+ *     },
  *     customerArtifactPaths: { // CustomerArtifactPaths
  *       iosPaths: [ // IosPaths
  *         "STRING_VALUE",
@@ -147,6 +151,10 @@ export interface ScheduleRunCommandOutput extends ScheduleRunResult, __MetadataB
  * //       uplinkLossPercent: Number("int"),
  * //       downlinkLossPercent: Number("int"),
  * //     },
+ * //     deviceProxy: { // DeviceProxy
+ * //       host: "STRING_VALUE", // required
+ * //       port: Number("int"), // required
+ * //     },
  * //     parsingResultUrl: "STRING_VALUE",
  * //     resultCode: "PARSING_FAILED" || "VPC_ENDPOINT_SETUP_FAILED",
  * //     seed: Number("int"),
diff --git a/clients/client-device-farm/src/commands/StopRemoteAccessSessionCommand.ts b/clients/client-device-farm/src/commands/StopRemoteAccessSessionCommand.ts
@@ -125,6 +125,10 @@ export interface StopRemoteAccessSessionCommandOutput extends StopRemoteAccessSe
  * //       ],
  * //       vpcId: "STRING_VALUE", // required
  * //     },
+ * //     deviceProxy: { // DeviceProxy
+ * //       host: "STRING_VALUE", // required
+ * //       port: Number("int"), // required
+ * //     },
  * //   },
  * // };
  *
diff --git a/clients/client-device-farm/src/commands/StopRunCommand.ts b/clients/client-device-farm/src/commands/StopRunCommand.ts
@@ -86,6 +86,10 @@ export interface StopRunCommandOutput extends StopRunResult, __MetadataBearer {}
  * //       uplinkLossPercent: Number("int"),
  * //       downlinkLossPercent: Number("int"),
  * //     },
+ * //     deviceProxy: { // DeviceProxy
+ * //       host: "STRING_VALUE", // required
+ * //       port: Number("int"), // required
+ * //     },
  * //     parsingResultUrl: "STRING_VALUE",
  * //     resultCode: "PARSING_FAILED" || "VPC_ENDPOINT_SETUP_FAILED",
  * //     seed: Number("int"),
diff --git a/clients/client-device-farm/src/models/models_0.ts b/clients/client-device-farm/src/models/models_0.ts
@@ -1155,6 +1155,24 @@ export class TagOperationException extends __BaseException {
   }
 }
 
+/**
+ * <p>Represents the http/s proxy configuration that will be applied to a device during a run.</p>
+ * @public
+ */
+export interface DeviceProxy {
+  /**
+   * <p>Hostname or IPv4 address of the proxy.</p>
+   * @public
+   */
+  host: string | undefined;
+
+  /**
+   * <p>The port number on which the http/s proxy is listening.</p>
+   * @public
+   */
+  port: number | undefined;
+}
+
 /**
  * <p>Configuration settings for a remote access session, including billing
  *             method.</p>
@@ -1172,6 +1190,12 @@ export interface CreateRemoteAccessSessionConfiguration {
    * @public
    */
   vpceConfigurationArns?: string[] | undefined;
+
+  /**
+   * <p>The device proxy to be configured on the device for the remote access session.</p>
+   * @public
+   */
+  deviceProxy?: DeviceProxy | undefined;
 }
 
 /**
@@ -1853,6 +1877,12 @@ export interface RemoteAccessSession {
    * @public
    */
   vpcConfig?: VpcConfig | undefined;
+
+  /**
+   * <p>The device proxy configured for the remote access session.</p>
+   * @public
+   */
+  deviceProxy?: DeviceProxy | undefined;
 }
 
 /**
@@ -2895,6 +2925,12 @@ export interface ScheduleRunConfiguration {
    */
   vpceConfigurationArns?: string[] | undefined;
 
+  /**
+   * <p>The device proxy to be configured on the device for the run.</p>
+   * @public
+   */
+  deviceProxy?: DeviceProxy | undefined;
+
   /**
    * <p>Input <code>CustomerArtifactPaths</code> object for the scheduled run
    *             configuration.</p>
@@ -4248,6 +4284,12 @@ export interface Run {
    */
   networkProfile?: NetworkProfile | undefined;
 
+  /**
+   * <p>The device proxy configured for the devices in the run.</p>
+   * @public
+   */
+  deviceProxy?: DeviceProxy | undefined;
+
   /**
    * <p>Read-only URL for an object in an S3 bucket where you can get the parsing results of the test package.
    *             If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points
diff --git a/clients/client-device-farm/src/protocols/Aws_json1_1.ts b/clients/client-device-farm/src/protocols/Aws_json1_1.ts
@@ -232,6 +232,7 @@ import {
   DeviceFilter,
   DeviceMinutes,
   DevicePoolCompatibilityResult,
+  DeviceProxy,
   DeviceSelectionConfiguration,
   ExecutionConfiguration,
   ExecutionResult,
@@ -3195,6 +3196,8 @@ const de_TooManyTagsExceptionRes = async (
 
 // se_DeviceHostPaths omitted.
 
+// se_DeviceProxy omitted.
+
 // se_DeviceSelectionConfiguration omitted.
 
 // se_ExecutionConfiguration omitted.
@@ -3347,6 +3350,7 @@ const se_ScheduleRunConfiguration = (input: ScheduleRunConfiguration, context: _
     auxiliaryApps: _json,
     billingMethod: [],
     customerArtifactPaths: _json,
+    deviceProxy: _json,
     extraDataPackageArn: [],
     locale: [],
     location: (_) => se_Location(_, context),
@@ -3612,6 +3616,8 @@ const de_DevicePoolCompatibilityResults = (output: any, context: __SerdeContext)
 
 // de_DevicePools omitted.
 
+// de_DeviceProxy omitted.
+
 /**
  * deserializeAws_json1_1Devices
  */
@@ -4200,6 +4206,7 @@ const de_RemoteAccessSession = (output: any, context: __SerdeContext): RemoteAcc
     created: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
     device: (_: any) => de_Device(_, context),
     deviceMinutes: (_: any) => de_DeviceMinutes(_, context),
+    deviceProxy: _json,
     deviceUdid: __expectString,
     endpoint: __expectString,
     hostAddress: __expectString,
@@ -4260,6 +4267,7 @@ const de_Run = (output: any, context: __SerdeContext): Run => {
     customerArtifactPaths: _json,
     deviceMinutes: (_: any) => de_DeviceMinutes(_, context),
     devicePoolArn: __expectString,
+    deviceProxy: _json,
     deviceSelectionResult: _json,
     eventCount: __expectInt32,
     jobTimeoutMinutes: __expectInt32,
diff --git a/codegen/sdk-codegen/aws-models/device-farm.json b/codegen/sdk-codegen/aws-models/device-farm.json
@@ -934,6 +934,12 @@
           "traits": {
             "smithy.api#documentation": "<p>An array of ARNs included in the VPC endpoint configuration.</p>"
           }
+        },
+        "deviceProxy": {
+          "target": "com.amazonaws.devicefarm#DeviceProxy",
+          "traits": {
+            "smithy.api#documentation": "<p>The device proxy to be configured on the device for the remote access session.</p>"
+          }
         }
       },
       "traits": {
@@ -3334,6 +3340,48 @@
         "target": "com.amazonaws.devicefarm#DevicePool"
       }
     },
+    "com.amazonaws.devicefarm#DeviceProxy": {
+      "type": "structure",
+      "members": {
+        "host": {
+          "target": "com.amazonaws.devicefarm#DeviceProxyHost",
+          "traits": {
+            "smithy.api#documentation": "<p>Hostname or IPv4 address of the proxy.</p>",
+            "smithy.api#required": {}
+          }
+        },
+        "port": {
+          "target": "com.amazonaws.devicefarm#DeviceProxyPort",
+          "traits": {
+            "smithy.api#default": 3128,
+            "smithy.api#documentation": "<p>The port number on which the http/s proxy is listening.</p>",
+            "smithy.api#required": {}
+          }
+        }
+      },
+      "traits": {
+        "smithy.api#documentation": "<p>Represents the http/s proxy configuration that will be applied to a device during a run.</p>"
+      }
+    },
+    "com.amazonaws.devicefarm#DeviceProxyHost": {
+      "type": "string",
+      "traits": {
+        "smithy.api#length": {
+          "min": 1,
+          "max": 255
+        },
+        "smithy.api#pattern": "^([a-zA-Z0-9])([a-zA-Z0-9-.]+)([a-zA-Z0-9])$"
+      }
+    },
+    "com.amazonaws.devicefarm#DeviceProxyPort": {
+      "type": "integer",
+      "traits": {
+        "smithy.api#range": {
+          "min": 1,
+          "max": 65535
+        }
+      }
+    },
     "com.amazonaws.devicefarm#DeviceSelectionConfiguration": {
       "type": "structure",
       "members": {
@@ -7991,6 +8039,12 @@
           "traits": {
             "smithy.api#documentation": "<p>The VPC security groups and subnets that are attached to a project.</p>"
           }
+        },
+        "deviceProxy": {
+          "target": "com.amazonaws.devicefarm#DeviceProxy",
+          "traits": {
+            "smithy.api#documentation": "<p>The device proxy configured for the remote access session.</p>"
+          }
         }
       },
       "traits": {
@@ -8304,6 +8358,12 @@
             "smithy.api#documentation": "<p>The network profile being used for a test run.</p>"
           }
         },
+        "deviceProxy": {
+          "target": "com.amazonaws.devicefarm#DeviceProxy",
+          "traits": {
+            "smithy.api#documentation": "<p>The device proxy configured for the devices in the run.</p>"
+          }
+        },
         "parsingResultUrl": {
           "target": "com.amazonaws.devicefarm#String",
           "traits": {
@@ -8630,6 +8690,12 @@
             "smithy.api#documentation": "<p>An array of ARNs for your VPC endpoint configurations.</p>"
           }
         },
+        "deviceProxy": {
+          "target": "com.amazonaws.devicefarm#DeviceProxy",
+          "traits": {
+            "smithy.api#documentation": "<p>The device proxy to be configured on the device for the run.</p>"
+          }
+        },
         "customerArtifactPaths": {
           "target": "com.amazonaws.devicefarm#CustomerArtifactPaths",
           "traits": {
