UNPKG

153 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class DeviceFarm extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: DeviceFarm.Types.ClientConfiguration)
13 config: Config & DeviceFarm.Types.ClientConfiguration;
14 /**
15 * Creates a device pool.
16 */
17 createDevicePool(params: DeviceFarm.Types.CreateDevicePoolRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateDevicePoolResult) => void): Request<DeviceFarm.Types.CreateDevicePoolResult, AWSError>;
18 /**
19 * Creates a device pool.
20 */
21 createDevicePool(callback?: (err: AWSError, data: DeviceFarm.Types.CreateDevicePoolResult) => void): Request<DeviceFarm.Types.CreateDevicePoolResult, AWSError>;
22 /**
23 * Creates a profile that can be applied to one or more private fleet device instances.
24 */
25 createInstanceProfile(params: DeviceFarm.Types.CreateInstanceProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateInstanceProfileResult) => void): Request<DeviceFarm.Types.CreateInstanceProfileResult, AWSError>;
26 /**
27 * Creates a profile that can be applied to one or more private fleet device instances.
28 */
29 createInstanceProfile(callback?: (err: AWSError, data: DeviceFarm.Types.CreateInstanceProfileResult) => void): Request<DeviceFarm.Types.CreateInstanceProfileResult, AWSError>;
30 /**
31 * Creates a network profile.
32 */
33 createNetworkProfile(params: DeviceFarm.Types.CreateNetworkProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateNetworkProfileResult) => void): Request<DeviceFarm.Types.CreateNetworkProfileResult, AWSError>;
34 /**
35 * Creates a network profile.
36 */
37 createNetworkProfile(callback?: (err: AWSError, data: DeviceFarm.Types.CreateNetworkProfileResult) => void): Request<DeviceFarm.Types.CreateNetworkProfileResult, AWSError>;
38 /**
39 * Creates a new project.
40 */
41 createProject(params: DeviceFarm.Types.CreateProjectRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateProjectResult) => void): Request<DeviceFarm.Types.CreateProjectResult, AWSError>;
42 /**
43 * Creates a new project.
44 */
45 createProject(callback?: (err: AWSError, data: DeviceFarm.Types.CreateProjectResult) => void): Request<DeviceFarm.Types.CreateProjectResult, AWSError>;
46 /**
47 * Specifies and starts a remote access session.
48 */
49 createRemoteAccessSession(params: DeviceFarm.Types.CreateRemoteAccessSessionRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.CreateRemoteAccessSessionResult, AWSError>;
50 /**
51 * Specifies and starts a remote access session.
52 */
53 createRemoteAccessSession(callback?: (err: AWSError, data: DeviceFarm.Types.CreateRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.CreateRemoteAccessSessionResult, AWSError>;
54 /**
55 * Uploads an app or test scripts.
56 */
57 createUpload(params: DeviceFarm.Types.CreateUploadRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateUploadResult) => void): Request<DeviceFarm.Types.CreateUploadResult, AWSError>;
58 /**
59 * Uploads an app or test scripts.
60 */
61 createUpload(callback?: (err: AWSError, data: DeviceFarm.Types.CreateUploadResult) => void): Request<DeviceFarm.Types.CreateUploadResult, AWSError>;
62 /**
63 * Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
64 */
65 createVPCEConfiguration(params: DeviceFarm.Types.CreateVPCEConfigurationRequest, callback?: (err: AWSError, data: DeviceFarm.Types.CreateVPCEConfigurationResult) => void): Request<DeviceFarm.Types.CreateVPCEConfigurationResult, AWSError>;
66 /**
67 * Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
68 */
69 createVPCEConfiguration(callback?: (err: AWSError, data: DeviceFarm.Types.CreateVPCEConfigurationResult) => void): Request<DeviceFarm.Types.CreateVPCEConfigurationResult, AWSError>;
70 /**
71 * Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
72 */
73 deleteDevicePool(params: DeviceFarm.Types.DeleteDevicePoolRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteDevicePoolResult) => void): Request<DeviceFarm.Types.DeleteDevicePoolResult, AWSError>;
74 /**
75 * Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
76 */
77 deleteDevicePool(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteDevicePoolResult) => void): Request<DeviceFarm.Types.DeleteDevicePoolResult, AWSError>;
78 /**
79 * Deletes a profile that can be applied to one or more private device instances.
80 */
81 deleteInstanceProfile(params: DeviceFarm.Types.DeleteInstanceProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteInstanceProfileResult) => void): Request<DeviceFarm.Types.DeleteInstanceProfileResult, AWSError>;
82 /**
83 * Deletes a profile that can be applied to one or more private device instances.
84 */
85 deleteInstanceProfile(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteInstanceProfileResult) => void): Request<DeviceFarm.Types.DeleteInstanceProfileResult, AWSError>;
86 /**
87 * Deletes a network profile.
88 */
89 deleteNetworkProfile(params: DeviceFarm.Types.DeleteNetworkProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteNetworkProfileResult) => void): Request<DeviceFarm.Types.DeleteNetworkProfileResult, AWSError>;
90 /**
91 * Deletes a network profile.
92 */
93 deleteNetworkProfile(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteNetworkProfileResult) => void): Request<DeviceFarm.Types.DeleteNetworkProfileResult, AWSError>;
94 /**
95 * Deletes an AWS Device Farm project, given the project ARN. Note Deleting this resource does not stop an in-progress run.
96 */
97 deleteProject(params: DeviceFarm.Types.DeleteProjectRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteProjectResult) => void): Request<DeviceFarm.Types.DeleteProjectResult, AWSError>;
98 /**
99 * Deletes an AWS Device Farm project, given the project ARN. Note Deleting this resource does not stop an in-progress run.
100 */
101 deleteProject(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteProjectResult) => void): Request<DeviceFarm.Types.DeleteProjectResult, AWSError>;
102 /**
103 * Deletes a completed remote access session and its results.
104 */
105 deleteRemoteAccessSession(params: DeviceFarm.Types.DeleteRemoteAccessSessionRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.DeleteRemoteAccessSessionResult, AWSError>;
106 /**
107 * Deletes a completed remote access session and its results.
108 */
109 deleteRemoteAccessSession(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.DeleteRemoteAccessSessionResult, AWSError>;
110 /**
111 * Deletes the run, given the run ARN. Note Deleting this resource does not stop an in-progress run.
112 */
113 deleteRun(params: DeviceFarm.Types.DeleteRunRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteRunResult) => void): Request<DeviceFarm.Types.DeleteRunResult, AWSError>;
114 /**
115 * Deletes the run, given the run ARN. Note Deleting this resource does not stop an in-progress run.
116 */
117 deleteRun(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteRunResult) => void): Request<DeviceFarm.Types.DeleteRunResult, AWSError>;
118 /**
119 * Deletes an upload given the upload ARN.
120 */
121 deleteUpload(params: DeviceFarm.Types.DeleteUploadRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteUploadResult) => void): Request<DeviceFarm.Types.DeleteUploadResult, AWSError>;
122 /**
123 * Deletes an upload given the upload ARN.
124 */
125 deleteUpload(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteUploadResult) => void): Request<DeviceFarm.Types.DeleteUploadResult, AWSError>;
126 /**
127 * Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
128 */
129 deleteVPCEConfiguration(params: DeviceFarm.Types.DeleteVPCEConfigurationRequest, callback?: (err: AWSError, data: DeviceFarm.Types.DeleteVPCEConfigurationResult) => void): Request<DeviceFarm.Types.DeleteVPCEConfigurationResult, AWSError>;
130 /**
131 * Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
132 */
133 deleteVPCEConfiguration(callback?: (err: AWSError, data: DeviceFarm.Types.DeleteVPCEConfigurationResult) => void): Request<DeviceFarm.Types.DeleteVPCEConfigurationResult, AWSError>;
134 /**
135 * Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.
136 */
137 getAccountSettings(params: DeviceFarm.Types.GetAccountSettingsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetAccountSettingsResult) => void): Request<DeviceFarm.Types.GetAccountSettingsResult, AWSError>;
138 /**
139 * Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.
140 */
141 getAccountSettings(callback?: (err: AWSError, data: DeviceFarm.Types.GetAccountSettingsResult) => void): Request<DeviceFarm.Types.GetAccountSettingsResult, AWSError>;
142 /**
143 * Gets information about a unique device type.
144 */
145 getDevice(params: DeviceFarm.Types.GetDeviceRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetDeviceResult) => void): Request<DeviceFarm.Types.GetDeviceResult, AWSError>;
146 /**
147 * Gets information about a unique device type.
148 */
149 getDevice(callback?: (err: AWSError, data: DeviceFarm.Types.GetDeviceResult) => void): Request<DeviceFarm.Types.GetDeviceResult, AWSError>;
150 /**
151 * Returns information about a device instance belonging to a private device fleet.
152 */
153 getDeviceInstance(params: DeviceFarm.Types.GetDeviceInstanceRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetDeviceInstanceResult) => void): Request<DeviceFarm.Types.GetDeviceInstanceResult, AWSError>;
154 /**
155 * Returns information about a device instance belonging to a private device fleet.
156 */
157 getDeviceInstance(callback?: (err: AWSError, data: DeviceFarm.Types.GetDeviceInstanceResult) => void): Request<DeviceFarm.Types.GetDeviceInstanceResult, AWSError>;
158 /**
159 * Gets information about a device pool.
160 */
161 getDevicePool(params: DeviceFarm.Types.GetDevicePoolRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetDevicePoolResult) => void): Request<DeviceFarm.Types.GetDevicePoolResult, AWSError>;
162 /**
163 * Gets information about a device pool.
164 */
165 getDevicePool(callback?: (err: AWSError, data: DeviceFarm.Types.GetDevicePoolResult) => void): Request<DeviceFarm.Types.GetDevicePoolResult, AWSError>;
166 /**
167 * Gets information about compatibility with a device pool.
168 */
169 getDevicePoolCompatibility(params: DeviceFarm.Types.GetDevicePoolCompatibilityRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetDevicePoolCompatibilityResult) => void): Request<DeviceFarm.Types.GetDevicePoolCompatibilityResult, AWSError>;
170 /**
171 * Gets information about compatibility with a device pool.
172 */
173 getDevicePoolCompatibility(callback?: (err: AWSError, data: DeviceFarm.Types.GetDevicePoolCompatibilityResult) => void): Request<DeviceFarm.Types.GetDevicePoolCompatibilityResult, AWSError>;
174 /**
175 * Returns information about the specified instance profile.
176 */
177 getInstanceProfile(params: DeviceFarm.Types.GetInstanceProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetInstanceProfileResult) => void): Request<DeviceFarm.Types.GetInstanceProfileResult, AWSError>;
178 /**
179 * Returns information about the specified instance profile.
180 */
181 getInstanceProfile(callback?: (err: AWSError, data: DeviceFarm.Types.GetInstanceProfileResult) => void): Request<DeviceFarm.Types.GetInstanceProfileResult, AWSError>;
182 /**
183 * Gets information about a job.
184 */
185 getJob(params: DeviceFarm.Types.GetJobRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetJobResult) => void): Request<DeviceFarm.Types.GetJobResult, AWSError>;
186 /**
187 * Gets information about a job.
188 */
189 getJob(callback?: (err: AWSError, data: DeviceFarm.Types.GetJobResult) => void): Request<DeviceFarm.Types.GetJobResult, AWSError>;
190 /**
191 * Returns information about a network profile.
192 */
193 getNetworkProfile(params: DeviceFarm.Types.GetNetworkProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetNetworkProfileResult) => void): Request<DeviceFarm.Types.GetNetworkProfileResult, AWSError>;
194 /**
195 * Returns information about a network profile.
196 */
197 getNetworkProfile(callback?: (err: AWSError, data: DeviceFarm.Types.GetNetworkProfileResult) => void): Request<DeviceFarm.Types.GetNetworkProfileResult, AWSError>;
198 /**
199 * Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
200 */
201 getOfferingStatus(params: DeviceFarm.Types.GetOfferingStatusRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetOfferingStatusResult) => void): Request<DeviceFarm.Types.GetOfferingStatusResult, AWSError>;
202 /**
203 * Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
204 */
205 getOfferingStatus(callback?: (err: AWSError, data: DeviceFarm.Types.GetOfferingStatusResult) => void): Request<DeviceFarm.Types.GetOfferingStatusResult, AWSError>;
206 /**
207 * Gets information about a project.
208 */
209 getProject(params: DeviceFarm.Types.GetProjectRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetProjectResult) => void): Request<DeviceFarm.Types.GetProjectResult, AWSError>;
210 /**
211 * Gets information about a project.
212 */
213 getProject(callback?: (err: AWSError, data: DeviceFarm.Types.GetProjectResult) => void): Request<DeviceFarm.Types.GetProjectResult, AWSError>;
214 /**
215 * Returns a link to a currently running remote access session.
216 */
217 getRemoteAccessSession(params: DeviceFarm.Types.GetRemoteAccessSessionRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.GetRemoteAccessSessionResult, AWSError>;
218 /**
219 * Returns a link to a currently running remote access session.
220 */
221 getRemoteAccessSession(callback?: (err: AWSError, data: DeviceFarm.Types.GetRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.GetRemoteAccessSessionResult, AWSError>;
222 /**
223 * Gets information about a run.
224 */
225 getRun(params: DeviceFarm.Types.GetRunRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetRunResult) => void): Request<DeviceFarm.Types.GetRunResult, AWSError>;
226 /**
227 * Gets information about a run.
228 */
229 getRun(callback?: (err: AWSError, data: DeviceFarm.Types.GetRunResult) => void): Request<DeviceFarm.Types.GetRunResult, AWSError>;
230 /**
231 * Gets information about a suite.
232 */
233 getSuite(params: DeviceFarm.Types.GetSuiteRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetSuiteResult) => void): Request<DeviceFarm.Types.GetSuiteResult, AWSError>;
234 /**
235 * Gets information about a suite.
236 */
237 getSuite(callback?: (err: AWSError, data: DeviceFarm.Types.GetSuiteResult) => void): Request<DeviceFarm.Types.GetSuiteResult, AWSError>;
238 /**
239 * Gets information about a test.
240 */
241 getTest(params: DeviceFarm.Types.GetTestRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetTestResult) => void): Request<DeviceFarm.Types.GetTestResult, AWSError>;
242 /**
243 * Gets information about a test.
244 */
245 getTest(callback?: (err: AWSError, data: DeviceFarm.Types.GetTestResult) => void): Request<DeviceFarm.Types.GetTestResult, AWSError>;
246 /**
247 * Gets information about an upload.
248 */
249 getUpload(params: DeviceFarm.Types.GetUploadRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetUploadResult) => void): Request<DeviceFarm.Types.GetUploadResult, AWSError>;
250 /**
251 * Gets information about an upload.
252 */
253 getUpload(callback?: (err: AWSError, data: DeviceFarm.Types.GetUploadResult) => void): Request<DeviceFarm.Types.GetUploadResult, AWSError>;
254 /**
255 * Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
256 */
257 getVPCEConfiguration(params: DeviceFarm.Types.GetVPCEConfigurationRequest, callback?: (err: AWSError, data: DeviceFarm.Types.GetVPCEConfigurationResult) => void): Request<DeviceFarm.Types.GetVPCEConfigurationResult, AWSError>;
258 /**
259 * Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
260 */
261 getVPCEConfiguration(callback?: (err: AWSError, data: DeviceFarm.Types.GetVPCEConfigurationResult) => void): Request<DeviceFarm.Types.GetVPCEConfigurationResult, AWSError>;
262 /**
263 * Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.
264 */
265 installToRemoteAccessSession(params: DeviceFarm.Types.InstallToRemoteAccessSessionRequest, callback?: (err: AWSError, data: DeviceFarm.Types.InstallToRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.InstallToRemoteAccessSessionResult, AWSError>;
266 /**
267 * Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.
268 */
269 installToRemoteAccessSession(callback?: (err: AWSError, data: DeviceFarm.Types.InstallToRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.InstallToRemoteAccessSessionResult, AWSError>;
270 /**
271 * Gets information about artifacts.
272 */
273 listArtifacts(params: DeviceFarm.Types.ListArtifactsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListArtifactsResult) => void): Request<DeviceFarm.Types.ListArtifactsResult, AWSError>;
274 /**
275 * Gets information about artifacts.
276 */
277 listArtifacts(callback?: (err: AWSError, data: DeviceFarm.Types.ListArtifactsResult) => void): Request<DeviceFarm.Types.ListArtifactsResult, AWSError>;
278 /**
279 * Returns information about the private device instances associated with one or more AWS accounts.
280 */
281 listDeviceInstances(params: DeviceFarm.Types.ListDeviceInstancesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListDeviceInstancesResult) => void): Request<DeviceFarm.Types.ListDeviceInstancesResult, AWSError>;
282 /**
283 * Returns information about the private device instances associated with one or more AWS accounts.
284 */
285 listDeviceInstances(callback?: (err: AWSError, data: DeviceFarm.Types.ListDeviceInstancesResult) => void): Request<DeviceFarm.Types.ListDeviceInstancesResult, AWSError>;
286 /**
287 * Gets information about device pools.
288 */
289 listDevicePools(params: DeviceFarm.Types.ListDevicePoolsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListDevicePoolsResult) => void): Request<DeviceFarm.Types.ListDevicePoolsResult, AWSError>;
290 /**
291 * Gets information about device pools.
292 */
293 listDevicePools(callback?: (err: AWSError, data: DeviceFarm.Types.ListDevicePoolsResult) => void): Request<DeviceFarm.Types.ListDevicePoolsResult, AWSError>;
294 /**
295 * Gets information about unique device types.
296 */
297 listDevices(params: DeviceFarm.Types.ListDevicesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListDevicesResult) => void): Request<DeviceFarm.Types.ListDevicesResult, AWSError>;
298 /**
299 * Gets information about unique device types.
300 */
301 listDevices(callback?: (err: AWSError, data: DeviceFarm.Types.ListDevicesResult) => void): Request<DeviceFarm.Types.ListDevicesResult, AWSError>;
302 /**
303 * Returns information about all the instance profiles in an AWS account.
304 */
305 listInstanceProfiles(params: DeviceFarm.Types.ListInstanceProfilesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListInstanceProfilesResult) => void): Request<DeviceFarm.Types.ListInstanceProfilesResult, AWSError>;
306 /**
307 * Returns information about all the instance profiles in an AWS account.
308 */
309 listInstanceProfiles(callback?: (err: AWSError, data: DeviceFarm.Types.ListInstanceProfilesResult) => void): Request<DeviceFarm.Types.ListInstanceProfilesResult, AWSError>;
310 /**
311 * Gets information about jobs for a given test run.
312 */
313 listJobs(params: DeviceFarm.Types.ListJobsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListJobsResult) => void): Request<DeviceFarm.Types.ListJobsResult, AWSError>;
314 /**
315 * Gets information about jobs for a given test run.
316 */
317 listJobs(callback?: (err: AWSError, data: DeviceFarm.Types.ListJobsResult) => void): Request<DeviceFarm.Types.ListJobsResult, AWSError>;
318 /**
319 * Returns the list of available network profiles.
320 */
321 listNetworkProfiles(params: DeviceFarm.Types.ListNetworkProfilesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListNetworkProfilesResult) => void): Request<DeviceFarm.Types.ListNetworkProfilesResult, AWSError>;
322 /**
323 * Returns the list of available network profiles.
324 */
325 listNetworkProfiles(callback?: (err: AWSError, data: DeviceFarm.Types.ListNetworkProfilesResult) => void): Request<DeviceFarm.Types.ListNetworkProfilesResult, AWSError>;
326 /**
327 * Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
328 */
329 listOfferingPromotions(params: DeviceFarm.Types.ListOfferingPromotionsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingPromotionsResult) => void): Request<DeviceFarm.Types.ListOfferingPromotionsResult, AWSError>;
330 /**
331 * Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
332 */
333 listOfferingPromotions(callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingPromotionsResult) => void): Request<DeviceFarm.Types.ListOfferingPromotionsResult, AWSError>;
334 /**
335 * Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
336 */
337 listOfferingTransactions(params: DeviceFarm.Types.ListOfferingTransactionsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingTransactionsResult) => void): Request<DeviceFarm.Types.ListOfferingTransactionsResult, AWSError>;
338 /**
339 * Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
340 */
341 listOfferingTransactions(callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingTransactionsResult) => void): Request<DeviceFarm.Types.ListOfferingTransactionsResult, AWSError>;
342 /**
343 * Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
344 */
345 listOfferings(params: DeviceFarm.Types.ListOfferingsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingsResult) => void): Request<DeviceFarm.Types.ListOfferingsResult, AWSError>;
346 /**
347 * Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
348 */
349 listOfferings(callback?: (err: AWSError, data: DeviceFarm.Types.ListOfferingsResult) => void): Request<DeviceFarm.Types.ListOfferingsResult, AWSError>;
350 /**
351 * Gets information about projects.
352 */
353 listProjects(params: DeviceFarm.Types.ListProjectsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListProjectsResult) => void): Request<DeviceFarm.Types.ListProjectsResult, AWSError>;
354 /**
355 * Gets information about projects.
356 */
357 listProjects(callback?: (err: AWSError, data: DeviceFarm.Types.ListProjectsResult) => void): Request<DeviceFarm.Types.ListProjectsResult, AWSError>;
358 /**
359 * Returns a list of all currently running remote access sessions.
360 */
361 listRemoteAccessSessions(params: DeviceFarm.Types.ListRemoteAccessSessionsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListRemoteAccessSessionsResult) => void): Request<DeviceFarm.Types.ListRemoteAccessSessionsResult, AWSError>;
362 /**
363 * Returns a list of all currently running remote access sessions.
364 */
365 listRemoteAccessSessions(callback?: (err: AWSError, data: DeviceFarm.Types.ListRemoteAccessSessionsResult) => void): Request<DeviceFarm.Types.ListRemoteAccessSessionsResult, AWSError>;
366 /**
367 * Gets information about runs, given an AWS Device Farm project ARN.
368 */
369 listRuns(params: DeviceFarm.Types.ListRunsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListRunsResult) => void): Request<DeviceFarm.Types.ListRunsResult, AWSError>;
370 /**
371 * Gets information about runs, given an AWS Device Farm project ARN.
372 */
373 listRuns(callback?: (err: AWSError, data: DeviceFarm.Types.ListRunsResult) => void): Request<DeviceFarm.Types.ListRunsResult, AWSError>;
374 /**
375 * Gets information about samples, given an AWS Device Farm job ARN.
376 */
377 listSamples(params: DeviceFarm.Types.ListSamplesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListSamplesResult) => void): Request<DeviceFarm.Types.ListSamplesResult, AWSError>;
378 /**
379 * Gets information about samples, given an AWS Device Farm job ARN.
380 */
381 listSamples(callback?: (err: AWSError, data: DeviceFarm.Types.ListSamplesResult) => void): Request<DeviceFarm.Types.ListSamplesResult, AWSError>;
382 /**
383 * Gets information about test suites for a given job.
384 */
385 listSuites(params: DeviceFarm.Types.ListSuitesRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListSuitesResult) => void): Request<DeviceFarm.Types.ListSuitesResult, AWSError>;
386 /**
387 * Gets information about test suites for a given job.
388 */
389 listSuites(callback?: (err: AWSError, data: DeviceFarm.Types.ListSuitesResult) => void): Request<DeviceFarm.Types.ListSuitesResult, AWSError>;
390 /**
391 * Gets information about tests in a given test suite.
392 */
393 listTests(params: DeviceFarm.Types.ListTestsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListTestsResult) => void): Request<DeviceFarm.Types.ListTestsResult, AWSError>;
394 /**
395 * Gets information about tests in a given test suite.
396 */
397 listTests(callback?: (err: AWSError, data: DeviceFarm.Types.ListTestsResult) => void): Request<DeviceFarm.Types.ListTestsResult, AWSError>;
398 /**
399 * Gets information about unique problems.
400 */
401 listUniqueProblems(params: DeviceFarm.Types.ListUniqueProblemsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListUniqueProblemsResult) => void): Request<DeviceFarm.Types.ListUniqueProblemsResult, AWSError>;
402 /**
403 * Gets information about unique problems.
404 */
405 listUniqueProblems(callback?: (err: AWSError, data: DeviceFarm.Types.ListUniqueProblemsResult) => void): Request<DeviceFarm.Types.ListUniqueProblemsResult, AWSError>;
406 /**
407 * Gets information about uploads, given an AWS Device Farm project ARN.
408 */
409 listUploads(params: DeviceFarm.Types.ListUploadsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListUploadsResult) => void): Request<DeviceFarm.Types.ListUploadsResult, AWSError>;
410 /**
411 * Gets information about uploads, given an AWS Device Farm project ARN.
412 */
413 listUploads(callback?: (err: AWSError, data: DeviceFarm.Types.ListUploadsResult) => void): Request<DeviceFarm.Types.ListUploadsResult, AWSError>;
414 /**
415 * Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
416 */
417 listVPCEConfigurations(params: DeviceFarm.Types.ListVPCEConfigurationsRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ListVPCEConfigurationsResult) => void): Request<DeviceFarm.Types.ListVPCEConfigurationsResult, AWSError>;
418 /**
419 * Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
420 */
421 listVPCEConfigurations(callback?: (err: AWSError, data: DeviceFarm.Types.ListVPCEConfigurationsResult) => void): Request<DeviceFarm.Types.ListVPCEConfigurationsResult, AWSError>;
422 /**
423 * Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
424 */
425 purchaseOffering(params: DeviceFarm.Types.PurchaseOfferingRequest, callback?: (err: AWSError, data: DeviceFarm.Types.PurchaseOfferingResult) => void): Request<DeviceFarm.Types.PurchaseOfferingResult, AWSError>;
426 /**
427 * Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
428 */
429 purchaseOffering(callback?: (err: AWSError, data: DeviceFarm.Types.PurchaseOfferingResult) => void): Request<DeviceFarm.Types.PurchaseOfferingResult, AWSError>;
430 /**
431 * Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
432 */
433 renewOffering(params: DeviceFarm.Types.RenewOfferingRequest, callback?: (err: AWSError, data: DeviceFarm.Types.RenewOfferingResult) => void): Request<DeviceFarm.Types.RenewOfferingResult, AWSError>;
434 /**
435 * Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
436 */
437 renewOffering(callback?: (err: AWSError, data: DeviceFarm.Types.RenewOfferingResult) => void): Request<DeviceFarm.Types.RenewOfferingResult, AWSError>;
438 /**
439 * Schedules a run.
440 */
441 scheduleRun(params: DeviceFarm.Types.ScheduleRunRequest, callback?: (err: AWSError, data: DeviceFarm.Types.ScheduleRunResult) => void): Request<DeviceFarm.Types.ScheduleRunResult, AWSError>;
442 /**
443 * Schedules a run.
444 */
445 scheduleRun(callback?: (err: AWSError, data: DeviceFarm.Types.ScheduleRunResult) => void): Request<DeviceFarm.Types.ScheduleRunResult, AWSError>;
446 /**
447 * Initiates a stop request for the current job. AWS Device Farm will immediately stop the job on the device where tests have not started executing, and you will not be billed for this device. On the device where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on the device. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
448 */
449 stopJob(params: DeviceFarm.Types.StopJobRequest, callback?: (err: AWSError, data: DeviceFarm.Types.StopJobResult) => void): Request<DeviceFarm.Types.StopJobResult, AWSError>;
450 /**
451 * Initiates a stop request for the current job. AWS Device Farm will immediately stop the job on the device where tests have not started executing, and you will not be billed for this device. On the device where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on the device. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
452 */
453 stopJob(callback?: (err: AWSError, data: DeviceFarm.Types.StopJobResult) => void): Request<DeviceFarm.Types.StopJobResult, AWSError>;
454 /**
455 * Ends a specified remote access session.
456 */
457 stopRemoteAccessSession(params: DeviceFarm.Types.StopRemoteAccessSessionRequest, callback?: (err: AWSError, data: DeviceFarm.Types.StopRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.StopRemoteAccessSessionResult, AWSError>;
458 /**
459 * Ends a specified remote access session.
460 */
461 stopRemoteAccessSession(callback?: (err: AWSError, data: DeviceFarm.Types.StopRemoteAccessSessionResult) => void): Request<DeviceFarm.Types.StopRemoteAccessSessionResult, AWSError>;
462 /**
463 * Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
464 */
465 stopRun(params: DeviceFarm.Types.StopRunRequest, callback?: (err: AWSError, data: DeviceFarm.Types.StopRunResult) => void): Request<DeviceFarm.Types.StopRunResult, AWSError>;
466 /**
467 * Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
468 */
469 stopRun(callback?: (err: AWSError, data: DeviceFarm.Types.StopRunResult) => void): Request<DeviceFarm.Types.StopRunResult, AWSError>;
470 /**
471 * Updates information about an existing private device instance.
472 */
473 updateDeviceInstance(params: DeviceFarm.Types.UpdateDeviceInstanceRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateDeviceInstanceResult) => void): Request<DeviceFarm.Types.UpdateDeviceInstanceResult, AWSError>;
474 /**
475 * Updates information about an existing private device instance.
476 */
477 updateDeviceInstance(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateDeviceInstanceResult) => void): Request<DeviceFarm.Types.UpdateDeviceInstanceResult, AWSError>;
478 /**
479 * Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).
480 */
481 updateDevicePool(params: DeviceFarm.Types.UpdateDevicePoolRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateDevicePoolResult) => void): Request<DeviceFarm.Types.UpdateDevicePoolResult, AWSError>;
482 /**
483 * Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).
484 */
485 updateDevicePool(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateDevicePoolResult) => void): Request<DeviceFarm.Types.UpdateDevicePoolResult, AWSError>;
486 /**
487 * Updates information about an existing private device instance profile.
488 */
489 updateInstanceProfile(params: DeviceFarm.Types.UpdateInstanceProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateInstanceProfileResult) => void): Request<DeviceFarm.Types.UpdateInstanceProfileResult, AWSError>;
490 /**
491 * Updates information about an existing private device instance profile.
492 */
493 updateInstanceProfile(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateInstanceProfileResult) => void): Request<DeviceFarm.Types.UpdateInstanceProfileResult, AWSError>;
494 /**
495 * Updates the network profile with specific settings.
496 */
497 updateNetworkProfile(params: DeviceFarm.Types.UpdateNetworkProfileRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateNetworkProfileResult) => void): Request<DeviceFarm.Types.UpdateNetworkProfileResult, AWSError>;
498 /**
499 * Updates the network profile with specific settings.
500 */
501 updateNetworkProfile(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateNetworkProfileResult) => void): Request<DeviceFarm.Types.UpdateNetworkProfileResult, AWSError>;
502 /**
503 * Modifies the specified project name, given the project ARN and a new name.
504 */
505 updateProject(params: DeviceFarm.Types.UpdateProjectRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateProjectResult) => void): Request<DeviceFarm.Types.UpdateProjectResult, AWSError>;
506 /**
507 * Modifies the specified project name, given the project ARN and a new name.
508 */
509 updateProject(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateProjectResult) => void): Request<DeviceFarm.Types.UpdateProjectResult, AWSError>;
510 /**
511 * Update an uploaded test specification (test spec).
512 */
513 updateUpload(params: DeviceFarm.Types.UpdateUploadRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateUploadResult) => void): Request<DeviceFarm.Types.UpdateUploadResult, AWSError>;
514 /**
515 * Update an uploaded test specification (test spec).
516 */
517 updateUpload(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateUploadResult) => void): Request<DeviceFarm.Types.UpdateUploadResult, AWSError>;
518 /**
519 * Updates information about an existing Amazon Virtual Private Cloud (VPC) endpoint configuration.
520 */
521 updateVPCEConfiguration(params: DeviceFarm.Types.UpdateVPCEConfigurationRequest, callback?: (err: AWSError, data: DeviceFarm.Types.UpdateVPCEConfigurationResult) => void): Request<DeviceFarm.Types.UpdateVPCEConfigurationResult, AWSError>;
522 /**
523 * Updates information about an existing Amazon Virtual Private Cloud (VPC) endpoint configuration.
524 */
525 updateVPCEConfiguration(callback?: (err: AWSError, data: DeviceFarm.Types.UpdateVPCEConfigurationResult) => void): Request<DeviceFarm.Types.UpdateVPCEConfigurationResult, AWSError>;
526}
527declare namespace DeviceFarm {
528 export type AWSAccountNumber = string;
529 export interface AccountSettings {
530 /**
531 * The AWS account number specified in the AccountSettings container.
532 */
533 awsAccountNumber?: AWSAccountNumber;
534 /**
535 * Returns the unmetered devices you have purchased or want to purchase.
536 */
537 unmeteredDevices?: PurchasedDevicesMap;
538 /**
539 * Returns the unmetered remote access devices you have purchased or want to purchase.
540 */
541 unmeteredRemoteAccessDevices?: PurchasedDevicesMap;
542 /**
543 * The maximum number of minutes a test run will execute before it times out.
544 */
545 maxJobTimeoutMinutes?: JobTimeoutMinutes;
546 /**
547 * Information about an AWS account's usage of free trial device minutes.
548 */
549 trialMinutes?: TrialMinutes;
550 /**
551 * The maximum number of device slots that the AWS account can purchase. Each maximum is expressed as an offering-id:number pair, where the offering-id represents one of the IDs returned by the ListOfferings command.
552 */
553 maxSlots?: MaxSlotMap;
554 /**
555 * The default number of minutes (at the account level) a test run will execute before it times out. Default value is 60 minutes.
556 */
557 defaultJobTimeoutMinutes?: JobTimeoutMinutes;
558 /**
559 * When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
560 */
561 skipAppResign?: SkipAppResign;
562 }
563 export type AccountsCleanup = boolean;
564 export type AmazonResourceName = string;
565 export type AmazonResourceNames = AmazonResourceName[];
566 export type AndroidPaths = String[];
567 export type AppPackagesCleanup = boolean;
568 export interface Artifact {
569 /**
570 * The artifact's ARN.
571 */
572 arn?: AmazonResourceName;
573 /**
574 * The artifact's name.
575 */
576 name?: Name;
577 /**
578 * The artifact's type. Allowed values include the following: UNKNOWN: An unknown type. SCREENSHOT: The screenshot type. DEVICE_LOG: The device log type. MESSAGE_LOG: The message log type. VIDEO_LOG: The video log type. RESULT_LOG: The result log type. SERVICE_LOG: The service log type. WEBKIT_LOG: The web kit log type. INSTRUMENTATION_OUTPUT: The instrumentation type. EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test. CALABASH_JSON_OUTPUT: The Calabash JSON output type. CALABASH_PRETTY_OUTPUT: The Calabash pretty output type. CALABASH_STANDARD_OUTPUT: The Calabash standard output type. CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type. AUTOMATION_OUTPUT: The automation output type. APPIUM_SERVER_OUTPUT: The Appium server output type. APPIUM_JAVA_OUTPUT: The Appium Java output type. APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type. APPIUM_PYTHON_OUTPUT: The Appium Python output type. APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type. EXPLORER_EVENT_LOG: The Explorer event log output type. EXPLORER_SUMMARY_LOG: The Explorer summary log output type. APPLICATION_CRASH_REPORT: The application crash report output type. XCTEST_LOG: The XCode test output type. VIDEO: The Video output type. CUSTOMER_ARTIFACT:The Customer Artifact output type. CUSTOMER_ARTIFACT_LOG: The Customer Artifact Log output type. TESTSPEC_OUTPUT: The Test Spec Output type.
579 */
580 type?: ArtifactType;
581 /**
582 * The artifact's file extension.
583 */
584 extension?: String;
585 /**
586 * The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the artifact's file.
587 */
588 url?: URL;
589 }
590 export type ArtifactCategory = "SCREENSHOT"|"FILE"|"LOG"|string;
591 export type ArtifactType = "UNKNOWN"|"SCREENSHOT"|"DEVICE_LOG"|"MESSAGE_LOG"|"VIDEO_LOG"|"RESULT_LOG"|"SERVICE_LOG"|"WEBKIT_LOG"|"INSTRUMENTATION_OUTPUT"|"EXERCISER_MONKEY_OUTPUT"|"CALABASH_JSON_OUTPUT"|"CALABASH_PRETTY_OUTPUT"|"CALABASH_STANDARD_OUTPUT"|"CALABASH_JAVA_XML_OUTPUT"|"AUTOMATION_OUTPUT"|"APPIUM_SERVER_OUTPUT"|"APPIUM_JAVA_OUTPUT"|"APPIUM_JAVA_XML_OUTPUT"|"APPIUM_PYTHON_OUTPUT"|"APPIUM_PYTHON_XML_OUTPUT"|"EXPLORER_EVENT_LOG"|"EXPLORER_SUMMARY_LOG"|"APPLICATION_CRASH_REPORT"|"XCTEST_LOG"|"VIDEO"|"CUSTOMER_ARTIFACT"|"CUSTOMER_ARTIFACT_LOG"|"TESTSPEC_OUTPUT"|string;
592 export type Artifacts = Artifact[];
593 export type BillingMethod = "METERED"|"UNMETERED"|string;
594 export type Boolean = boolean;
595 export interface CPU {
596 /**
597 * The CPU's frequency.
598 */
599 frequency?: String;
600 /**
601 * The CPU's architecture, for example x86 or ARM.
602 */
603 architecture?: String;
604 /**
605 * The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.
606 */
607 clock?: Double;
608 }
609 export type ClientId = string;
610 export type ContentType = string;
611 export interface Counters {
612 /**
613 * The total number of entities.
614 */
615 total?: Integer;
616 /**
617 * The number of passed entities.
618 */
619 passed?: Integer;
620 /**
621 * The number of failed entities.
622 */
623 failed?: Integer;
624 /**
625 * The number of warned entities.
626 */
627 warned?: Integer;
628 /**
629 * The number of errored entities.
630 */
631 errored?: Integer;
632 /**
633 * The number of stopped entities.
634 */
635 stopped?: Integer;
636 /**
637 * The number of skipped entities.
638 */
639 skipped?: Integer;
640 }
641 export interface CreateDevicePoolRequest {
642 /**
643 * The ARN of the project for the device pool.
644 */
645 projectArn: AmazonResourceName;
646 /**
647 * The device pool's name.
648 */
649 name: Name;
650 /**
651 * The device pool's description.
652 */
653 description?: Message;
654 /**
655 * The device pool's rules.
656 */
657 rules: Rules;
658 /**
659 * The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter. By specifying the maximum number of devices, you can control the costs that you incur by running tests.
660 */
661 maxDevices?: Integer;
662 }
663 export interface CreateDevicePoolResult {
664 /**
665 * The newly created device pool.
666 */
667 devicePool?: DevicePool;
668 }
669 export interface CreateInstanceProfileRequest {
670 /**
671 * The name of your instance profile.
672 */
673 name: Name;
674 /**
675 * The description of your instance profile.
676 */
677 description?: Message;
678 /**
679 * When set to true, Device Farm will remove app packages after a test run. The default value is false for private devices.
680 */
681 packageCleanup?: Boolean;
682 /**
683 * An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over. The list of packages is only considered if you set packageCleanup to true.
684 */
685 excludeAppPackagesFromCleanup?: PackageIds;
686 /**
687 * When set to true, Device Farm will reboot the instance after a test run. The default value is true.
688 */
689 rebootAfterUse?: Boolean;
690 }
691 export interface CreateInstanceProfileResult {
692 /**
693 * An object containing information about your instance profile.
694 */
695 instanceProfile?: InstanceProfile;
696 }
697 export interface CreateNetworkProfileRequest {
698 /**
699 * The Amazon Resource Name (ARN) of the project for which you want to create a network profile.
700 */
701 projectArn: AmazonResourceName;
702 /**
703 * The name you wish to specify for the new network profile.
704 */
705 name: Name;
706 /**
707 * The description of the network profile.
708 */
709 description?: Message;
710 /**
711 * The type of network profile you wish to create. Valid values are listed below.
712 */
713 type?: NetworkProfileType;
714 /**
715 * The data throughput rate in bits per second, as an integer from 0 to 104857600.
716 */
717 uplinkBandwidthBits?: Long;
718 /**
719 * The data throughput rate in bits per second, as an integer from 0 to 104857600.
720 */
721 downlinkBandwidthBits?: Long;
722 /**
723 * Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
724 */
725 uplinkDelayMs?: Long;
726 /**
727 * Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
728 */
729 downlinkDelayMs?: Long;
730 /**
731 * Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
732 */
733 uplinkJitterMs?: Long;
734 /**
735 * Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
736 */
737 downlinkJitterMs?: Long;
738 /**
739 * Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
740 */
741 uplinkLossPercent?: PercentInteger;
742 /**
743 * Proportion of received packets that fail to arrive from 0 to 100 percent.
744 */
745 downlinkLossPercent?: PercentInteger;
746 }
747 export interface CreateNetworkProfileResult {
748 /**
749 * The network profile that is returned by the create network profile request.
750 */
751 networkProfile?: NetworkProfile;
752 }
753 export interface CreateProjectRequest {
754 /**
755 * The project's name.
756 */
757 name: Name;
758 /**
759 * Sets the execution timeout value (in minutes) for a project. All test runs in this project will use the specified execution timeout value unless overridden when scheduling a run.
760 */
761 defaultJobTimeoutMinutes?: JobTimeoutMinutes;
762 }
763 export interface CreateProjectResult {
764 /**
765 * The newly created project.
766 */
767 project?: Project;
768 }
769 export interface CreateRemoteAccessSessionConfiguration {
770 /**
771 * The billing method for the remote access session.
772 */
773 billingMethod?: BillingMethod;
774 /**
775 * An array of Amazon Resource Names (ARNs) included in the VPC endpoint configuration.
776 */
777 vpceConfigurationArns?: AmazonResourceNames;
778 }
779 export interface CreateRemoteAccessSessionRequest {
780 /**
781 * The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
782 */
783 projectArn: AmazonResourceName;
784 /**
785 * The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.
786 */
787 deviceArn: AmazonResourceName;
788 /**
789 * The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
790 */
791 instanceArn?: AmazonResourceName;
792 /**
793 * The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This is only required if remoteDebugEnabled is set to true.
794 */
795 sshPublicKey?: SshPublicKey;
796 /**
797 * Set to true if you want to access devices remotely for debugging in your remote access session.
798 */
799 remoteDebugEnabled?: Boolean;
800 /**
801 * Set to true to enable remote recording for the remote access session.
802 */
803 remoteRecordEnabled?: Boolean;
804 /**
805 * The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
806 */
807 remoteRecordAppArn?: AmazonResourceName;
808 /**
809 * The name of the remote access session that you wish to create.
810 */
811 name?: Name;
812 /**
813 * Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId value in each call to CreateRemoteAccessSession. This is required only if remoteDebugEnabled is set to true.
814 */
815 clientId?: ClientId;
816 /**
817 * The configuration information for the remote access session request.
818 */
819 configuration?: CreateRemoteAccessSessionConfiguration;
820 /**
821 * The interaction mode of the remote access session. Valid values are: 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. 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. 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.
822 */
823 interactionMode?: InteractionMode;
824 /**
825 * When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
826 */
827 skipAppResign?: Boolean;
828 }
829 export interface CreateRemoteAccessSessionResult {
830 /**
831 * A container that describes the remote access session when the request to create a remote access session is sent.
832 */
833 remoteAccessSession?: RemoteAccessSession;
834 }
835 export interface CreateUploadRequest {
836 /**
837 * The ARN of the project for the upload.
838 */
839 projectArn: AmazonResourceName;
840 /**
841 * The upload's file name. The name should not contain the '/' character. If uploading an iOS app, the file name needs to end with the .ipa extension. If uploading an Android app, the file name needs to end with the .apk extension. For all others, the file name must end with the .zip file extension.
842 */
843 name: Name;
844 /**
845 * The upload's upload type. Must be one of the following values: ANDROID_APP: An Android upload. IOS_APP: An iOS upload. WEB_APP: A web application upload. EXTERNAL_DATA: An external data upload. APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload. APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload. APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload. APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload. APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload. APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app. APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app. APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app. APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app. APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app. CALABASH_TEST_PACKAGE: A Calabash test package upload. INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload. UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload. UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload. XCTEST_TEST_PACKAGE: An XCode test package upload. XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload. APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload. APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload. APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload. APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload. APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload. APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app. APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app. APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app. APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app. APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app. INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload. XCTEST_UI_TEST_SPEC: An XCode UI test spec upload. Note If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.
846 */
847 type: UploadType;
848 /**
849 * The upload's content type (for example, "application/octet-stream").
850 */
851 contentType?: ContentType;
852 }
853 export interface CreateUploadResult {
854 /**
855 * The newly created upload.
856 */
857 upload?: Upload;
858 }
859 export interface CreateVPCEConfigurationRequest {
860 /**
861 * The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.
862 */
863 vpceConfigurationName: VPCEConfigurationName;
864 /**
865 * The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.
866 */
867 vpceServiceName: VPCEServiceName;
868 /**
869 * The DNS name of the service running in your VPC that you want Device Farm to test.
870 */
871 serviceDnsName: ServiceDnsName;
872 /**
873 * An optional description, providing more details about your VPC endpoint configuration.
874 */
875 vpceConfigurationDescription?: VPCEConfigurationDescription;
876 }
877 export interface CreateVPCEConfigurationResult {
878 /**
879 * An object containing information about your VPC endpoint configuration.
880 */
881 vpceConfiguration?: VPCEConfiguration;
882 }
883 export type CurrencyCode = "USD"|string;
884 export interface CustomerArtifactPaths {
885 /**
886 * Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests will be pulled from.
887 */
888 iosPaths?: IosPaths;
889 /**
890 * Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests will be pulled from.
891 */
892 androidPaths?: AndroidPaths;
893 /**
894 * Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests will be pulled from.
895 */
896 deviceHostPaths?: DeviceHostPaths;
897 }
898 export type DateTime = Date;
899 export interface DeleteDevicePoolRequest {
900 /**
901 * Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete.
902 */
903 arn: AmazonResourceName;
904 }
905 export interface DeleteDevicePoolResult {
906 }
907 export interface DeleteInstanceProfileRequest {
908 /**
909 * The Amazon Resource Name (ARN) of the instance profile you are requesting to delete.
910 */
911 arn: AmazonResourceName;
912 }
913 export interface DeleteInstanceProfileResult {
914 }
915 export interface DeleteNetworkProfileRequest {
916 /**
917 * The Amazon Resource Name (ARN) of the network profile you want to delete.
918 */
919 arn: AmazonResourceName;
920 }
921 export interface DeleteNetworkProfileResult {
922 }
923 export interface DeleteProjectRequest {
924 /**
925 * Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete.
926 */
927 arn: AmazonResourceName;
928 }
929 export interface DeleteProjectResult {
930 }
931 export interface DeleteRemoteAccessSessionRequest {
932 /**
933 * The Amazon Resource Name (ARN) of the sesssion for which you want to delete remote access.
934 */
935 arn: AmazonResourceName;
936 }
937 export interface DeleteRemoteAccessSessionResult {
938 }
939 export interface DeleteRunRequest {
940 /**
941 * The Amazon Resource Name (ARN) for the run you wish to delete.
942 */
943 arn: AmazonResourceName;
944 }
945 export interface DeleteRunResult {
946 }
947 export interface DeleteUploadRequest {
948 /**
949 * Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete.
950 */
951 arn: AmazonResourceName;
952 }
953 export interface DeleteUploadResult {
954 }
955 export interface DeleteVPCEConfigurationRequest {
956 /**
957 * The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to delete.
958 */
959 arn: AmazonResourceName;
960 }
961 export interface DeleteVPCEConfigurationResult {
962 }
963 export interface Device {
964 /**
965 * The device's ARN.
966 */
967 arn?: AmazonResourceName;
968 /**
969 * The device's display name.
970 */
971 name?: Name;
972 /**
973 * The device's manufacturer name.
974 */
975 manufacturer?: String;
976 /**
977 * The device's model name.
978 */
979 model?: String;
980 /**
981 * The device's model ID.
982 */
983 modelId?: String;
984 /**
985 * The device's form factor. Allowed values include: PHONE: The phone form factor. TABLET: The tablet form factor.
986 */
987 formFactor?: DeviceFormFactor;
988 /**
989 * The device's platform. Allowed values include: ANDROID: The Android platform. IOS: The iOS platform.
990 */
991 platform?: DevicePlatform;
992 /**
993 * The device's operating system type.
994 */
995 os?: String;
996 /**
997 * Information about the device's CPU.
998 */
999 cpu?: CPU;
1000 /**
1001 * The resolution of the device.
1002 */
1003 resolution?: Resolution;
1004 /**
1005 * The device's heap size, expressed in bytes.
1006 */
1007 heapSize?: Long;
1008 /**
1009 * The device's total memory size, expressed in bytes.
1010 */
1011 memory?: Long;
1012 /**
1013 * The device's image name.
1014 */
1015 image?: String;
1016 /**
1017 * The device's carrier.
1018 */
1019 carrier?: String;
1020 /**
1021 * The device's radio.
1022 */
1023 radio?: String;
1024 /**
1025 * Specifies whether remote access has been enabled for the specified device.
1026 */
1027 remoteAccessEnabled?: Boolean;
1028 /**
1029 * This flag is set to true if remote debugging is enabled for the device.
1030 */
1031 remoteDebugEnabled?: Boolean;
1032 /**
1033 * The type of fleet to which this device belongs. Possible values for fleet type are PRIVATE and PUBLIC.
1034 */
1035 fleetType?: String;
1036 /**
1037 * The name of the fleet to which this device belongs.
1038 */
1039 fleetName?: String;
1040 /**
1041 * The instances belonging to this device.
1042 */
1043 instances?: DeviceInstances;
1044 /**
1045 * Reflects how likely a device will be available for a test run. It is currently available in the ListDevices and GetDevice API methods.
1046 */
1047 availability?: DeviceAvailability;
1048 }
1049 export type DeviceAttribute = "ARN"|"PLATFORM"|"FORM_FACTOR"|"MANUFACTURER"|"REMOTE_ACCESS_ENABLED"|"REMOTE_DEBUG_ENABLED"|"APPIUM_VERSION"|"INSTANCE_ARN"|"INSTANCE_LABELS"|"FLEET_TYPE"|"OS_VERSION"|"MODEL"|"AVAILABILITY"|string;
1050 export type DeviceAvailability = "TEMPORARY_NOT_AVAILABLE"|"BUSY"|"AVAILABLE"|"HIGHLY_AVAILABLE"|string;
1051 export interface DeviceFilter {
1052 /**
1053 * The aspect of a device such as platform or model used as the selection criteria in a device filter. The supported operators for each attribute are provided in the following list. ARN The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example". Supported operators: EQUALS, IN, NOT_IN PLATFORM The device platform. Valid values are "ANDROID" or "IOS". Supported operators: EQUALS OS_VERSION The operating system version. For example, "10.3.2". Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN MODEL The device model. For example, "iPad 5th Gen". Supported operators: CONTAINS, EQUALS, IN, NOT_IN AVAILABILITY The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". Supported operators: EQUALS FORM_FACTOR The device form factor. Valid values are "PHONE" or "TABLET". Supported operators: EQUALS MANUFACTURER The device manufacturer. For example, "Apple". Supported operators: EQUALS, IN, NOT_IN REMOTE_ACCESS_ENABLED Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE". Supported operators: EQUALS REMOTE_DEBUG_ENABLED Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE". Supported operators: EQUALS INSTANCE_ARN The Amazon Resource Name (ARN) of the device instance. Supported operators: EQUALS, IN, NOT_IN INSTANCE_LABELS The label of the device instance. Supported operators: CONTAINS FLEET_TYPE The fleet type. Valid values are "PUBLIC" or "PRIVATE". Supported operators: EQUALS
1054 */
1055 attribute?: DeviceFilterAttribute;
1056 /**
1057 * Specifies how Device Farm compares the filter's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.
1058 */
1059 operator?: RuleOperator;
1060 /**
1061 * An array of one or more filter values used in a device filter. Operator Values The IN and NOT_IN operators can take a values array that has more than one element. The other operators require an array with a single element. Attribute Values The PLATFORM attribute can be set to "ANDROID" or "IOS". The AVAILABILITY attribute can be set to "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". The FORM_FACTOR attribute can be set to "PHONE" or "TABLET". The FLEET_TYPE attribute can be set to "PUBLIC" or "PRIVATE".
1062 */
1063 values?: DeviceFilterValues;
1064 }
1065 export type DeviceFilterAttribute = "ARN"|"PLATFORM"|"OS_VERSION"|"MODEL"|"AVAILABILITY"|"FORM_FACTOR"|"MANUFACTURER"|"REMOTE_ACCESS_ENABLED"|"REMOTE_DEBUG_ENABLED"|"INSTANCE_ARN"|"INSTANCE_LABELS"|"FLEET_TYPE"|string;
1066 export type DeviceFilterValues = String[];
1067 export type DeviceFilters = DeviceFilter[];
1068 export type DeviceFormFactor = "PHONE"|"TABLET"|string;
1069 export type DeviceHostPaths = String[];
1070 export interface DeviceInstance {
1071 /**
1072 * The Amazon Resource Name (ARN) of the device instance.
1073 */
1074 arn?: AmazonResourceName;
1075 /**
1076 * The Amazon Resource Name (ARN) of the device.
1077 */
1078 deviceArn?: AmazonResourceName;
1079 /**
1080 * An array of strings describing the device instance.
1081 */
1082 labels?: InstanceLabels;
1083 /**
1084 * The status of the device instance. Valid values are listed below.
1085 */
1086 status?: InstanceStatus;
1087 /**
1088 * Unique device identifier for the device instance.
1089 */
1090 udid?: String;
1091 /**
1092 * A object containing information about the instance profile.
1093 */
1094 instanceProfile?: InstanceProfile;
1095 }
1096 export type DeviceInstances = DeviceInstance[];
1097 export interface DeviceMinutes {
1098 /**
1099 * When specified, represents the total minutes used by the resource to run tests.
1100 */
1101 total?: Double;
1102 /**
1103 * When specified, represents only the sum of metered minutes used by the resource to run tests.
1104 */
1105 metered?: Double;
1106 /**
1107 * When specified, represents only the sum of unmetered minutes used by the resource to run tests.
1108 */
1109 unmetered?: Double;
1110 }
1111 export type DevicePlatform = "ANDROID"|"IOS"|string;
1112 export interface DevicePool {
1113 /**
1114 * The device pool's ARN.
1115 */
1116 arn?: AmazonResourceName;
1117 /**
1118 * The device pool's name.
1119 */
1120 name?: Name;
1121 /**
1122 * The device pool's description.
1123 */
1124 description?: Message;
1125 /**
1126 * The device pool's type. Allowed values include: CURATED: A device pool that is created and managed by AWS Device Farm. PRIVATE: A device pool that is created and managed by the device pool developer.
1127 */
1128 type?: DevicePoolType;
1129 /**
1130 * Information about the device pool's rules.
1131 */
1132 rules?: Rules;
1133 /**
1134 * The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter. By specifying the maximum number of devices, you can control the costs that you incur by running tests.
1135 */
1136 maxDevices?: Integer;
1137 }
1138 export interface DevicePoolCompatibilityResult {
1139 /**
1140 * The device (phone or tablet) that you wish to return information about.
1141 */
1142 device?: Device;
1143 /**
1144 * Whether the result was compatible with the device pool.
1145 */
1146 compatible?: Boolean;
1147 /**
1148 * Information about the compatibility.
1149 */
1150 incompatibilityMessages?: IncompatibilityMessages;
1151 }
1152 export type DevicePoolCompatibilityResults = DevicePoolCompatibilityResult[];
1153 export type DevicePoolType = "CURATED"|"PRIVATE"|string;
1154 export type DevicePools = DevicePool[];
1155 export interface DeviceSelectionConfiguration {
1156 /**
1157 * Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values. Attribute The aspect of a device such as platform or model used as the selection criteria in a device filter. Allowed values include: ARN: The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example". PLATFORM: The device platform. Valid values are "ANDROID" or "IOS". OS_VERSION: The operating system version. For example, "10.3.2". MODEL: The device model. For example, "iPad 5th Gen". AVAILABILITY: The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". FORM_FACTOR: The device form factor. Valid values are "PHONE" or "TABLET". MANUFACTURER: The device manufacturer. For example, "Apple". REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE". REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE". INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance. INSTANCE_LABELS: The label of the device instance. FLEET_TYPE: The fleet type. Valid values are "PUBLIC" or "PRIVATE". Operator The filter operator. The EQUALS operator is available for every attribute except INSTANCE_LABELS. The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes. The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes. The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute. Values An array of one or more filter values. Operator Values The IN and NOT_IN operators can take a values array that has more than one element. The other operators require an array with a single element. Attribute Values The PLATFORM attribute can be set to "ANDROID" or "IOS". The AVAILABILITY attribute can be set to "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". The FORM_FACTOR attribute can be set to "PHONE" or "TABLET". The FLEET_TYPE attribute can be set to "PUBLIC" or "PRIVATE".
1158 */
1159 filters: DeviceFilters;
1160 /**
1161 * The maximum number of devices to be included in a test run.
1162 */
1163 maxDevices: Integer;
1164 }
1165 export interface DeviceSelectionResult {
1166 /**
1167 * The filters in a device selection result.
1168 */
1169 filters?: DeviceFilters;
1170 /**
1171 * The number of devices that matched the device filter selection criteria.
1172 */
1173 matchedDevicesCount?: Integer;
1174 /**
1175 * The maximum number of devices to be selected by a device filter and included in a test run.
1176 */
1177 maxDevices?: Integer;
1178 }
1179 export type Devices = Device[];
1180 export type Double = number;
1181 export interface ExecutionConfiguration {
1182 /**
1183 * The number of minutes a test run will execute before it times out.
1184 */
1185 jobTimeoutMinutes?: JobTimeoutMinutes;
1186 /**
1187 * True if account cleanup is enabled at the beginning of the test; otherwise, false.
1188 */
1189 accountsCleanup?: AccountsCleanup;
1190 /**
1191 * True if app package cleanup is enabled at the beginning of the test; otherwise, false.
1192 */
1193 appPackagesCleanup?: AppPackagesCleanup;
1194 /**
1195 * Set to true to enable video capture; otherwise, set to false. The default is true.
1196 */
1197 videoCapture?: VideoCapture;
1198 /**
1199 * When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
1200 */
1201 skipAppResign?: SkipAppResign;
1202 }
1203 export type ExecutionResult = "PENDING"|"PASSED"|"WARNED"|"FAILED"|"SKIPPED"|"ERRORED"|"STOPPED"|string;
1204 export type ExecutionResultCode = "PARSING_FAILED"|"VPC_ENDPOINT_SETUP_FAILED"|string;
1205 export type ExecutionStatus = "PENDING"|"PENDING_CONCURRENCY"|"PENDING_DEVICE"|"PROCESSING"|"SCHEDULING"|"PREPARING"|"RUNNING"|"COMPLETED"|"STOPPING"|string;
1206 export type Filter = string;
1207 export interface GetAccountSettingsRequest {
1208 }
1209 export interface GetAccountSettingsResult {
1210 /**
1211 * The account settings.
1212 */
1213 accountSettings?: AccountSettings;
1214 }
1215 export interface GetDeviceInstanceRequest {
1216 /**
1217 * The Amazon Resource Name (ARN) of the instance you're requesting information about.
1218 */
1219 arn: AmazonResourceName;
1220 }
1221 export interface GetDeviceInstanceResult {
1222 /**
1223 * An object containing information about your device instance.
1224 */
1225 deviceInstance?: DeviceInstance;
1226 }
1227 export interface GetDevicePoolCompatibilityRequest {
1228 /**
1229 * The device pool's ARN.
1230 */
1231 devicePoolArn: AmazonResourceName;
1232 /**
1233 * The ARN of the app that is associated with the specified device pool.
1234 */
1235 appArn?: AmazonResourceName;
1236 /**
1237 * The test type for the specified device pool. Allowed values include the following: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The XCode test type. XCTEST_UI: The XCode UI test type.
1238 */
1239 testType?: TestType;
1240 /**
1241 * Information about the uploaded test to be run against the device pool.
1242 */
1243 test?: ScheduleRunTest;
1244 /**
1245 * An object containing information about the settings for a run.
1246 */
1247 configuration?: ScheduleRunConfiguration;
1248 }
1249 export interface GetDevicePoolCompatibilityResult {
1250 /**
1251 * Information about compatible devices.
1252 */
1253 compatibleDevices?: DevicePoolCompatibilityResults;
1254 /**
1255 * Information about incompatible devices.
1256 */
1257 incompatibleDevices?: DevicePoolCompatibilityResults;
1258 }
1259 export interface GetDevicePoolRequest {
1260 /**
1261 * The device pool's ARN.
1262 */
1263 arn: AmazonResourceName;
1264 }
1265 export interface GetDevicePoolResult {
1266 /**
1267 * An object containing information about the requested device pool.
1268 */
1269 devicePool?: DevicePool;
1270 }
1271 export interface GetDeviceRequest {
1272 /**
1273 * The device type's ARN.
1274 */
1275 arn: AmazonResourceName;
1276 }
1277 export interface GetDeviceResult {
1278 /**
1279 * An object containing information about the requested device.
1280 */
1281 device?: Device;
1282 }
1283 export interface GetInstanceProfileRequest {
1284 /**
1285 * The Amazon Resource Name (ARN) of your instance profile.
1286 */
1287 arn: AmazonResourceName;
1288 }
1289 export interface GetInstanceProfileResult {
1290 /**
1291 * An object containing information about your instance profile.
1292 */
1293 instanceProfile?: InstanceProfile;
1294 }
1295 export interface GetJobRequest {
1296 /**
1297 * The job's ARN.
1298 */
1299 arn: AmazonResourceName;
1300 }
1301 export interface GetJobResult {
1302 /**
1303 * An object containing information about the requested job.
1304 */
1305 job?: Job;
1306 }
1307 export interface GetNetworkProfileRequest {
1308 /**
1309 * The Amazon Resource Name (ARN) of the network profile you want to return information about.
1310 */
1311 arn: AmazonResourceName;
1312 }
1313 export interface GetNetworkProfileResult {
1314 /**
1315 * The network profile.
1316 */
1317 networkProfile?: NetworkProfile;
1318 }
1319 export interface GetOfferingStatusRequest {
1320 /**
1321 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1322 */
1323 nextToken?: PaginationToken;
1324 }
1325 export interface GetOfferingStatusResult {
1326 /**
1327 * When specified, gets the offering status for the current period.
1328 */
1329 current?: OfferingStatusMap;
1330 /**
1331 * When specified, gets the offering status for the next period.
1332 */
1333 nextPeriod?: OfferingStatusMap;
1334 /**
1335 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1336 */
1337 nextToken?: PaginationToken;
1338 }
1339 export interface GetProjectRequest {
1340 /**
1341 * The project's ARN.
1342 */
1343 arn: AmazonResourceName;
1344 }
1345 export interface GetProjectResult {
1346 /**
1347 * The project you wish to get information about.
1348 */
1349 project?: Project;
1350 }
1351 export interface GetRemoteAccessSessionRequest {
1352 /**
1353 * The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.
1354 */
1355 arn: AmazonResourceName;
1356 }
1357 export interface GetRemoteAccessSessionResult {
1358 /**
1359 * A container that lists detailed information about the remote access session.
1360 */
1361 remoteAccessSession?: RemoteAccessSession;
1362 }
1363 export interface GetRunRequest {
1364 /**
1365 * The run's ARN.
1366 */
1367 arn: AmazonResourceName;
1368 }
1369 export interface GetRunResult {
1370 /**
1371 * The run you wish to get results from.
1372 */
1373 run?: Run;
1374 }
1375 export interface GetSuiteRequest {
1376 /**
1377 * The suite's ARN.
1378 */
1379 arn: AmazonResourceName;
1380 }
1381 export interface GetSuiteResult {
1382 /**
1383 * A collection of one or more tests.
1384 */
1385 suite?: Suite;
1386 }
1387 export interface GetTestRequest {
1388 /**
1389 * The test's ARN.
1390 */
1391 arn: AmazonResourceName;
1392 }
1393 export interface GetTestResult {
1394 /**
1395 * A test condition that is evaluated.
1396 */
1397 test?: Test;
1398 }
1399 export interface GetUploadRequest {
1400 /**
1401 * The upload's ARN.
1402 */
1403 arn: AmazonResourceName;
1404 }
1405 export interface GetUploadResult {
1406 /**
1407 * An app or a set of one or more tests to upload or that have been uploaded.
1408 */
1409 upload?: Upload;
1410 }
1411 export interface GetVPCEConfigurationRequest {
1412 /**
1413 * The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to describe.
1414 */
1415 arn: AmazonResourceName;
1416 }
1417 export interface GetVPCEConfigurationResult {
1418 /**
1419 * An object containing information about your VPC endpoint configuration.
1420 */
1421 vpceConfiguration?: VPCEConfiguration;
1422 }
1423 export type HostAddress = string;
1424 export interface IncompatibilityMessage {
1425 /**
1426 * A message about the incompatibility.
1427 */
1428 message?: Message;
1429 /**
1430 * The type of incompatibility. Allowed values include: ARN: The ARN. FORM_FACTOR: The form factor (for example, phone or tablet). MANUFACTURER: The manufacturer. PLATFORM: The platform (for example, Android or iOS). REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. APPIUM_VERSION: The Appium version for the test.
1431 */
1432 type?: DeviceAttribute;
1433 }
1434 export type IncompatibilityMessages = IncompatibilityMessage[];
1435 export interface InstallToRemoteAccessSessionRequest {
1436 /**
1437 * The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.
1438 */
1439 remoteAccessSessionArn: AmazonResourceName;
1440 /**
1441 * The Amazon Resource Name (ARN) of the app about which you are requesting information.
1442 */
1443 appArn: AmazonResourceName;
1444 }
1445 export interface InstallToRemoteAccessSessionResult {
1446 /**
1447 * An app to upload or that has been uploaded.
1448 */
1449 appUpload?: Upload;
1450 }
1451 export type InstanceLabels = String[];
1452 export interface InstanceProfile {
1453 /**
1454 * The Amazon Resource Name (ARN) of the instance profile.
1455 */
1456 arn?: AmazonResourceName;
1457 /**
1458 * When set to true, Device Farm will remove app packages after a test run. The default value is false for private devices.
1459 */
1460 packageCleanup?: Boolean;
1461 /**
1462 * An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over. The list of packages is only considered if you set packageCleanup to true.
1463 */
1464 excludeAppPackagesFromCleanup?: PackageIds;
1465 /**
1466 * When set to true, Device Farm will reboot the instance after a test run. The default value is true.
1467 */
1468 rebootAfterUse?: Boolean;
1469 /**
1470 * The name of the instance profile.
1471 */
1472 name?: Name;
1473 /**
1474 * The description of the instance profile.
1475 */
1476 description?: Message;
1477 }
1478 export type InstanceProfiles = InstanceProfile[];
1479 export type InstanceStatus = "IN_USE"|"PREPARING"|"AVAILABLE"|"NOT_AVAILABLE"|string;
1480 export type Integer = number;
1481 export type InteractionMode = "INTERACTIVE"|"NO_VIDEO"|"VIDEO_ONLY"|string;
1482 export type IosPaths = String[];
1483 export interface Job {
1484 /**
1485 * The job's ARN.
1486 */
1487 arn?: AmazonResourceName;
1488 /**
1489 * The job's name.
1490 */
1491 name?: Name;
1492 /**
1493 * The job's type. Allowed values include the following: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby test type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The XCode test type. XCTEST_UI: The XCode UI test type.
1494 */
1495 type?: TestType;
1496 /**
1497 * When the job was created.
1498 */
1499 created?: DateTime;
1500 /**
1501 * The job's status. Allowed values include: PENDING: A pending status. PENDING_CONCURRENCY: A pending concurrency status. PENDING_DEVICE: A pending device status. PROCESSING: A processing status. SCHEDULING: A scheduling status. PREPARING: A preparing status. RUNNING: A running status. COMPLETED: A completed status. STOPPING: A stopping status.
1502 */
1503 status?: ExecutionStatus;
1504 /**
1505 * The job's result. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition.
1506 */
1507 result?: ExecutionResult;
1508 /**
1509 * The job's start time.
1510 */
1511 started?: DateTime;
1512 /**
1513 * The job's stop time.
1514 */
1515 stopped?: DateTime;
1516 /**
1517 * The job's result counters.
1518 */
1519 counters?: Counters;
1520 /**
1521 * A message about the job's result.
1522 */
1523 message?: Message;
1524 /**
1525 * The device (phone or tablet).
1526 */
1527 device?: Device;
1528 /**
1529 * The Amazon Resource Name (ARN) of the instance.
1530 */
1531 instanceArn?: AmazonResourceName;
1532 /**
1533 * Represents the total (metered or unmetered) minutes used by the job.
1534 */
1535 deviceMinutes?: DeviceMinutes;
1536 /**
1537 * The endpoint for streaming device video.
1538 */
1539 videoEndpoint?: String;
1540 /**
1541 * This value is set to true if video capture is enabled; otherwise, it is set to false.
1542 */
1543 videoCapture?: VideoCapture;
1544 }
1545 export type JobTimeoutMinutes = number;
1546 export type Jobs = Job[];
1547 export interface ListArtifactsRequest {
1548 /**
1549 * The Run, Job, Suite, or Test ARN.
1550 */
1551 arn: AmazonResourceName;
1552 /**
1553 * The artifacts' type. Allowed values include: FILE: The artifacts are files. LOG: The artifacts are logs. SCREENSHOT: The artifacts are screenshots.
1554 */
1555 type: ArtifactCategory;
1556 /**
1557 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1558 */
1559 nextToken?: PaginationToken;
1560 }
1561 export interface ListArtifactsResult {
1562 /**
1563 * Information about the artifacts.
1564 */
1565 artifacts?: Artifacts;
1566 /**
1567 * If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
1568 */
1569 nextToken?: PaginationToken;
1570 }
1571 export interface ListDeviceInstancesRequest {
1572 /**
1573 * An integer specifying the maximum number of items you want to return in the API response.
1574 */
1575 maxResults?: Integer;
1576 /**
1577 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1578 */
1579 nextToken?: PaginationToken;
1580 }
1581 export interface ListDeviceInstancesResult {
1582 /**
1583 * An object containing information about your device instances.
1584 */
1585 deviceInstances?: DeviceInstances;
1586 /**
1587 * An identifier that can be used in the next call to this operation to return the next set of items in the list.
1588 */
1589 nextToken?: PaginationToken;
1590 }
1591 export interface ListDevicePoolsRequest {
1592 /**
1593 * The project ARN.
1594 */
1595 arn: AmazonResourceName;
1596 /**
1597 * The device pools' type. Allowed values include: CURATED: A device pool that is created and managed by AWS Device Farm. PRIVATE: A device pool that is created and managed by the device pool developer.
1598 */
1599 type?: DevicePoolType;
1600 /**
1601 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1602 */
1603 nextToken?: PaginationToken;
1604 }
1605 export interface ListDevicePoolsResult {
1606 /**
1607 * Information about the device pools.
1608 */
1609 devicePools?: DevicePools;
1610 /**
1611 * If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
1612 */
1613 nextToken?: PaginationToken;
1614 }
1615 export interface ListDevicesRequest {
1616 /**
1617 * The Amazon Resource Name (ARN) of the project.
1618 */
1619 arn?: AmazonResourceName;
1620 /**
1621 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1622 */
1623 nextToken?: PaginationToken;
1624 /**
1625 * Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values. Attribute: The aspect of a device such as platform or model used as the selction criteria in a device filter. Allowed values include: ARN: The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example". PLATFORM: The device platform. Valid values are "ANDROID" or "IOS". OS_VERSION: The operating system version. For example, "10.3.2". MODEL: The device model. For example, "iPad 5th Gen". AVAILABILITY: The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". FORM_FACTOR: The device form factor. Valid values are "PHONE" or "TABLET". MANUFACTURER: The device manufacturer. For example, "Apple". REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE". REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE". INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance. INSTANCE_LABELS: The label of the device instance. FLEET_TYPE: The fleet type. Valid values are "PUBLIC" or "PRIVATE". Operator: The filter operator. The EQUALS operator is available for every attribute except INSTANCE_LABELS. The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes. The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes. The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute. Values: An array of one or more filter values. The IN and NOT_IN operators take a values array that has one or more elements. The other operators require an array with a single element. In a request, the AVAILABILITY attribute takes "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.
1626 */
1627 filters?: DeviceFilters;
1628 }
1629 export interface ListDevicesResult {
1630 /**
1631 * Information about the devices.
1632 */
1633 devices?: Devices;
1634 /**
1635 * If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
1636 */
1637 nextToken?: PaginationToken;
1638 }
1639 export interface ListInstanceProfilesRequest {
1640 /**
1641 * An integer specifying the maximum number of items you want to return in the API response.
1642 */
1643 maxResults?: Integer;
1644 /**
1645 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1646 */
1647 nextToken?: PaginationToken;
1648 }
1649 export interface ListInstanceProfilesResult {
1650 /**
1651 * An object containing information about your instance profiles.
1652 */
1653 instanceProfiles?: InstanceProfiles;
1654 /**
1655 * An identifier that can be used in the next call to this operation to return the next set of items in the list.
1656 */
1657 nextToken?: PaginationToken;
1658 }
1659 export interface ListJobsRequest {
1660 /**
1661 * The run's Amazon Resource Name (ARN).
1662 */
1663 arn: AmazonResourceName;
1664 /**
1665 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1666 */
1667 nextToken?: PaginationToken;
1668 }
1669 export interface ListJobsResult {
1670 /**
1671 * Information about the jobs.
1672 */
1673 jobs?: Jobs;
1674 /**
1675 * If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
1676 */
1677 nextToken?: PaginationToken;
1678 }
1679 export interface ListNetworkProfilesRequest {
1680 /**
1681 * The Amazon Resource Name (ARN) of the project for which you want to list network profiles.
1682 */
1683 arn: AmazonResourceName;
1684 /**
1685 * The type of network profile you wish to return information about. Valid values are listed below.
1686 */
1687 type?: NetworkProfileType;
1688 /**
1689 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1690 */
1691 nextToken?: PaginationToken;
1692 }
1693 export interface ListNetworkProfilesResult {
1694 /**
1695 * A list of the available network profiles.
1696 */
1697 networkProfiles?: NetworkProfiles;
1698 /**
1699 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1700 */
1701 nextToken?: PaginationToken;
1702 }
1703 export interface ListOfferingPromotionsRequest {
1704 /**
1705 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1706 */
1707 nextToken?: PaginationToken;
1708 }
1709 export interface ListOfferingPromotionsResult {
1710 /**
1711 * Information about the offering promotions.
1712 */
1713 offeringPromotions?: OfferingPromotions;
1714 /**
1715 * An identifier to be used in the next call to this operation, to return the next set of items in the list.
1716 */
1717 nextToken?: PaginationToken;
1718 }
1719 export interface ListOfferingTransactionsRequest {
1720 /**
1721 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1722 */
1723 nextToken?: PaginationToken;
1724 }
1725 export interface ListOfferingTransactionsResult {
1726 /**
1727 * The audit log of subscriptions you have purchased and modified through AWS Device Farm.
1728 */
1729 offeringTransactions?: OfferingTransactions;
1730 /**
1731 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1732 */
1733 nextToken?: PaginationToken;
1734 }
1735 export interface ListOfferingsRequest {
1736 /**
1737 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1738 */
1739 nextToken?: PaginationToken;
1740 }
1741 export interface ListOfferingsResult {
1742 /**
1743 * A value representing the list offering results.
1744 */
1745 offerings?: Offerings;
1746 /**
1747 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1748 */
1749 nextToken?: PaginationToken;
1750 }
1751 export interface ListProjectsRequest {
1752 /**
1753 * Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.
1754 */
1755 arn?: AmazonResourceName;
1756 /**
1757 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1758 */
1759 nextToken?: PaginationToken;
1760 }
1761 export interface ListProjectsResult {
1762 /**
1763 * Information about the projects.
1764 */
1765 projects?: Projects;
1766 /**
1767 * If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
1768 */
1769 nextToken?: PaginationToken;
1770 }
1771 export interface ListRemoteAccessSessionsRequest {
1772 /**
1773 * The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.
1774 */
1775 arn: AmazonResourceName;
1776 /**
1777 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1778 */
1779 nextToken?: PaginationToken;
1780 }
1781 export interface ListRemoteAccessSessionsResult {
1782 /**
1783 * A container representing the metadata from the service about each remote access session you are requesting.
1784 */
1785 remoteAccessSessions?: RemoteAccessSessions;
1786 /**
1787 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1788 */
1789 nextToken?: PaginationToken;
1790 }
1791 export interface ListRunsRequest {
1792 /**
1793 * The Amazon Resource Name (ARN) of the project for which you want to list runs.
1794 */
1795 arn: AmazonResourceName;
1796 /**
1797 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1798 */
1799 nextToken?: PaginationToken;
1800 }
1801 export interface ListRunsResult {
1802 /**
1803 * Information about the runs.
1804 */
1805 runs?: Runs;
1806 /**
1807 * If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
1808 */
1809 nextToken?: PaginationToken;
1810 }
1811 export interface ListSamplesRequest {
1812 /**
1813 * The Amazon Resource Name (ARN) of the job used to list samples.
1814 */
1815 arn: AmazonResourceName;
1816 /**
1817 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1818 */
1819 nextToken?: PaginationToken;
1820 }
1821 export interface ListSamplesResult {
1822 /**
1823 * Information about the samples.
1824 */
1825 samples?: Samples;
1826 /**
1827 * If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
1828 */
1829 nextToken?: PaginationToken;
1830 }
1831 export interface ListSuitesRequest {
1832 /**
1833 * The job's Amazon Resource Name (ARN).
1834 */
1835 arn: AmazonResourceName;
1836 /**
1837 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1838 */
1839 nextToken?: PaginationToken;
1840 }
1841 export interface ListSuitesResult {
1842 /**
1843 * Information about the suites.
1844 */
1845 suites?: Suites;
1846 /**
1847 * If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
1848 */
1849 nextToken?: PaginationToken;
1850 }
1851 export interface ListTestsRequest {
1852 /**
1853 * The test suite's Amazon Resource Name (ARN).
1854 */
1855 arn: AmazonResourceName;
1856 /**
1857 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1858 */
1859 nextToken?: PaginationToken;
1860 }
1861 export interface ListTestsResult {
1862 /**
1863 * Information about the tests.
1864 */
1865 tests?: Tests;
1866 /**
1867 * If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
1868 */
1869 nextToken?: PaginationToken;
1870 }
1871 export interface ListUniqueProblemsRequest {
1872 /**
1873 * The unique problems' ARNs.
1874 */
1875 arn: AmazonResourceName;
1876 /**
1877 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1878 */
1879 nextToken?: PaginationToken;
1880 }
1881 export interface ListUniqueProblemsResult {
1882 /**
1883 * Information about the unique problems. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition.
1884 */
1885 uniqueProblems?: UniqueProblemsByExecutionResultMap;
1886 /**
1887 * If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
1888 */
1889 nextToken?: PaginationToken;
1890 }
1891 export interface ListUploadsRequest {
1892 /**
1893 * The Amazon Resource Name (ARN) of the project for which you want to list uploads.
1894 */
1895 arn: AmazonResourceName;
1896 /**
1897 * The type of upload. Must be one of the following values: ANDROID_APP: An Android upload. IOS_APP: An iOS upload. WEB_APP: A web appliction upload. EXTERNAL_DATA: An external data upload. APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload. APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload. APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload. APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload. APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload. APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app. APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app. APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app. APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app. APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app. CALABASH_TEST_PACKAGE: A Calabash test package upload. INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload. UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload. UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload. XCTEST_TEST_PACKAGE: An XCode test package upload. XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload. APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload. APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload. APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload. APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload. APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload. APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app. APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app. APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app. APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app. APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app. INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload. XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
1898 */
1899 type?: UploadType;
1900 /**
1901 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1902 */
1903 nextToken?: PaginationToken;
1904 }
1905 export interface ListUploadsResult {
1906 /**
1907 * Information about the uploads.
1908 */
1909 uploads?: Uploads;
1910 /**
1911 * If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
1912 */
1913 nextToken?: PaginationToken;
1914 }
1915 export interface ListVPCEConfigurationsRequest {
1916 /**
1917 * An integer specifying the maximum number of items you want to return in the API response.
1918 */
1919 maxResults?: Integer;
1920 /**
1921 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1922 */
1923 nextToken?: PaginationToken;
1924 }
1925 export interface ListVPCEConfigurationsResult {
1926 /**
1927 * An array of VPCEConfiguration objects containing information about your VPC endpoint configuration.
1928 */
1929 vpceConfigurations?: VPCEConfigurations;
1930 /**
1931 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1932 */
1933 nextToken?: PaginationToken;
1934 }
1935 export interface Location {
1936 /**
1937 * The latitude.
1938 */
1939 latitude: Double;
1940 /**
1941 * The longitude.
1942 */
1943 longitude: Double;
1944 }
1945 export type Long = number;
1946 export type MaxSlotMap = {[key: string]: Integer};
1947 export type Message = string;
1948 export type Metadata = string;
1949 export interface MonetaryAmount {
1950 /**
1951 * The numerical amount of an offering or transaction.
1952 */
1953 amount?: Double;
1954 /**
1955 * The currency code of a monetary amount. For example, USD means "U.S. dollars."
1956 */
1957 currencyCode?: CurrencyCode;
1958 }
1959 export type Name = string;
1960 export interface NetworkProfile {
1961 /**
1962 * The Amazon Resource Name (ARN) of the network profile.
1963 */
1964 arn?: AmazonResourceName;
1965 /**
1966 * The name of the network profile.
1967 */
1968 name?: Name;
1969 /**
1970 * The description of the network profile.
1971 */
1972 description?: Message;
1973 /**
1974 * The type of network profile. Valid values are listed below.
1975 */
1976 type?: NetworkProfileType;
1977 /**
1978 * The data throughput rate in bits per second, as an integer from 0 to 104857600.
1979 */
1980 uplinkBandwidthBits?: Long;
1981 /**
1982 * The data throughput rate in bits per second, as an integer from 0 to 104857600.
1983 */
1984 downlinkBandwidthBits?: Long;
1985 /**
1986 * Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
1987 */
1988 uplinkDelayMs?: Long;
1989 /**
1990 * Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
1991 */
1992 downlinkDelayMs?: Long;
1993 /**
1994 * Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
1995 */
1996 uplinkJitterMs?: Long;
1997 /**
1998 * Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
1999 */
2000 downlinkJitterMs?: Long;
2001 /**
2002 * Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
2003 */
2004 uplinkLossPercent?: PercentInteger;
2005 /**
2006 * Proportion of received packets that fail to arrive from 0 to 100 percent.
2007 */
2008 downlinkLossPercent?: PercentInteger;
2009 }
2010 export type NetworkProfileType = "CURATED"|"PRIVATE"|string;
2011 export type NetworkProfiles = NetworkProfile[];
2012 export interface Offering {
2013 /**
2014 * The ID that corresponds to a device offering.
2015 */
2016 id?: OfferingIdentifier;
2017 /**
2018 * A string describing the offering.
2019 */
2020 description?: Message;
2021 /**
2022 * The type of offering (e.g., "RECURRING") for a device.
2023 */
2024 type?: OfferingType;
2025 /**
2026 * The platform of the device (e.g., ANDROID or IOS).
2027 */
2028 platform?: DevicePlatform;
2029 /**
2030 * Specifies whether there are recurring charges for the offering.
2031 */
2032 recurringCharges?: RecurringCharges;
2033 }
2034 export type OfferingIdentifier = string;
2035 export interface OfferingPromotion {
2036 /**
2037 * The ID of the offering promotion.
2038 */
2039 id?: OfferingPromotionIdentifier;
2040 /**
2041 * A string describing the offering promotion.
2042 */
2043 description?: Message;
2044 }
2045 export type OfferingPromotionIdentifier = string;
2046 export type OfferingPromotions = OfferingPromotion[];
2047 export interface OfferingStatus {
2048 /**
2049 * The type specified for the offering status.
2050 */
2051 type?: OfferingTransactionType;
2052 /**
2053 * Represents the metadata of an offering status.
2054 */
2055 offering?: Offering;
2056 /**
2057 * The number of available devices in the offering.
2058 */
2059 quantity?: Integer;
2060 /**
2061 * The date on which the offering is effective.
2062 */
2063 effectiveOn?: DateTime;
2064 }
2065 export type OfferingStatusMap = {[key: string]: OfferingStatus};
2066 export interface OfferingTransaction {
2067 /**
2068 * The status of an offering transaction.
2069 */
2070 offeringStatus?: OfferingStatus;
2071 /**
2072 * The transaction ID of the offering transaction.
2073 */
2074 transactionId?: TransactionIdentifier;
2075 /**
2076 * The ID that corresponds to a device offering promotion.
2077 */
2078 offeringPromotionId?: OfferingPromotionIdentifier;
2079 /**
2080 * The date on which an offering transaction was created.
2081 */
2082 createdOn?: DateTime;
2083 /**
2084 * The cost of an offering transaction.
2085 */
2086 cost?: MonetaryAmount;
2087 }
2088 export type OfferingTransactionType = "PURCHASE"|"RENEW"|"SYSTEM"|string;
2089 export type OfferingTransactions = OfferingTransaction[];
2090 export type OfferingType = "RECURRING"|string;
2091 export type Offerings = Offering[];
2092 export type PackageIds = String[];
2093 export type PaginationToken = string;
2094 export type PercentInteger = number;
2095 export interface Problem {
2096 /**
2097 * Information about the associated run.
2098 */
2099 run?: ProblemDetail;
2100 /**
2101 * Information about the associated job.
2102 */
2103 job?: ProblemDetail;
2104 /**
2105 * Information about the associated suite.
2106 */
2107 suite?: ProblemDetail;
2108 /**
2109 * Information about the associated test.
2110 */
2111 test?: ProblemDetail;
2112 /**
2113 * Information about the associated device.
2114 */
2115 device?: Device;
2116 /**
2117 * The problem's result. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition.
2118 */
2119 result?: ExecutionResult;
2120 /**
2121 * A message about the problem's result.
2122 */
2123 message?: Message;
2124 }
2125 export interface ProblemDetail {
2126 /**
2127 * The problem detail's ARN.
2128 */
2129 arn?: AmazonResourceName;
2130 /**
2131 * The problem detail's name.
2132 */
2133 name?: Name;
2134 }
2135 export type Problems = Problem[];
2136 export interface Project {
2137 /**
2138 * The project's ARN.
2139 */
2140 arn?: AmazonResourceName;
2141 /**
2142 * The project's name.
2143 */
2144 name?: Name;
2145 /**
2146 * The default number of minutes (at the project level) a test run will execute before it times out. Default value is 60 minutes.
2147 */
2148 defaultJobTimeoutMinutes?: JobTimeoutMinutes;
2149 /**
2150 * When the project was created.
2151 */
2152 created?: DateTime;
2153 }
2154 export type Projects = Project[];
2155 export interface PurchaseOfferingRequest {
2156 /**
2157 * The ID of the offering.
2158 */
2159 offeringId?: OfferingIdentifier;
2160 /**
2161 * The number of device slots you wish to purchase in an offering request.
2162 */
2163 quantity?: Integer;
2164 /**
2165 * The ID of the offering promotion to be applied to the purchase.
2166 */
2167 offeringPromotionId?: OfferingPromotionIdentifier;
2168 }
2169 export interface PurchaseOfferingResult {
2170 /**
2171 * Represents the offering transaction for the purchase result.
2172 */
2173 offeringTransaction?: OfferingTransaction;
2174 }
2175 export type PurchasedDevicesMap = {[key: string]: Integer};
2176 export interface Radios {
2177 /**
2178 * True if Wi-Fi is enabled at the beginning of the test; otherwise, false.
2179 */
2180 wifi?: Boolean;
2181 /**
2182 * True if Bluetooth is enabled at the beginning of the test; otherwise, false.
2183 */
2184 bluetooth?: Boolean;
2185 /**
2186 * True if NFC is enabled at the beginning of the test; otherwise, false.
2187 */
2188 nfc?: Boolean;
2189 /**
2190 * True if GPS is enabled at the beginning of the test; otherwise, false.
2191 */
2192 gps?: Boolean;
2193 }
2194 export interface RecurringCharge {
2195 /**
2196 * The cost of the recurring charge.
2197 */
2198 cost?: MonetaryAmount;
2199 /**
2200 * The frequency in which charges will recur.
2201 */
2202 frequency?: RecurringChargeFrequency;
2203 }
2204 export type RecurringChargeFrequency = "MONTHLY"|string;
2205 export type RecurringCharges = RecurringCharge[];
2206 export interface RemoteAccessSession {
2207 /**
2208 * The Amazon Resource Name (ARN) of the remote access session.
2209 */
2210 arn?: AmazonResourceName;
2211 /**
2212 * The name of the remote access session.
2213 */
2214 name?: Name;
2215 /**
2216 * The date and time the remote access session was created.
2217 */
2218 created?: DateTime;
2219 /**
2220 * The status of the remote access session. Can be any of the following: PENDING: A pending status. PENDING_CONCURRENCY: A pending concurrency status. PENDING_DEVICE: A pending device status. PROCESSING: A processing status. SCHEDULING: A scheduling status. PREPARING: A preparing status. RUNNING: A running status. COMPLETED: A completed status. STOPPING: A stopping status.
2221 */
2222 status?: ExecutionStatus;
2223 /**
2224 * The result of the remote access session. Can be any of the following: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition.
2225 */
2226 result?: ExecutionResult;
2227 /**
2228 * A message about the remote access session.
2229 */
2230 message?: Message;
2231 /**
2232 * The date and time the remote access session was started.
2233 */
2234 started?: DateTime;
2235 /**
2236 * The date and time the remote access session was stopped.
2237 */
2238 stopped?: DateTime;
2239 /**
2240 * The device (phone or tablet) used in the remote access session.
2241 */
2242 device?: Device;
2243 /**
2244 * The Amazon Resource Name (ARN) of the instance.
2245 */
2246 instanceArn?: AmazonResourceName;
2247 /**
2248 * This flag is set to true if remote debugging is enabled for the remote access session.
2249 */
2250 remoteDebugEnabled?: Boolean;
2251 /**
2252 * This flag is set to true if remote recording is enabled for the remote access session.
2253 */
2254 remoteRecordEnabled?: Boolean;
2255 /**
2256 * The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
2257 */
2258 remoteRecordAppArn?: AmazonResourceName;
2259 /**
2260 * 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.
2261 */
2262 hostAddress?: HostAddress;
2263 /**
2264 * Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.
2265 */
2266 clientId?: ClientId;
2267 /**
2268 * The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology."
2269 */
2270 billingMethod?: BillingMethod;
2271 /**
2272 * The number of minutes a device is used in a remote access sesssion (including setup and teardown minutes).
2273 */
2274 deviceMinutes?: DeviceMinutes;
2275 /**
2276 * The endpoint for the remote access sesssion.
2277 */
2278 endpoint?: String;
2279 /**
2280 * Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.
2281 */
2282 deviceUdid?: String;
2283 /**
2284 * The interaction mode of the remote access session. Valid values are: 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. 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. 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.
2285 */
2286 interactionMode?: InteractionMode;
2287 /**
2288 * When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
2289 */
2290 skipAppResign?: SkipAppResign;
2291 }
2292 export type RemoteAccessSessions = RemoteAccessSession[];
2293 export interface RenewOfferingRequest {
2294 /**
2295 * The ID of a request to renew an offering.
2296 */
2297 offeringId?: OfferingIdentifier;
2298 /**
2299 * The quantity requested in an offering renewal.
2300 */
2301 quantity?: Integer;
2302 }
2303 export interface RenewOfferingResult {
2304 /**
2305 * Represents the status of the offering transaction for the renewal.
2306 */
2307 offeringTransaction?: OfferingTransaction;
2308 }
2309 export interface Resolution {
2310 /**
2311 * The screen resolution's width, expressed in pixels.
2312 */
2313 width?: Integer;
2314 /**
2315 * The screen resolution's height, expressed in pixels.
2316 */
2317 height?: Integer;
2318 }
2319 export interface Rule {
2320 /**
2321 * The rule's stringified attribute. For example, specify the value as "\"abc\"". The supported operators for each attribute are provided in the following list. APPIUM_VERSION The Appium version for the test. Supported operators: CONTAINS ARN The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example". Supported operators: EQUALS, IN, NOT_IN AVAILABILITY The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE". Supported operators: EQUALS FLEET_TYPE The fleet type. Valid values are "PUBLIC" or "PRIVATE". Supported operators: EQUALS FORM_FACTOR The device form factor. Valid values are "PHONE" or "TABLET". Supported operators: EQUALS, IN, NOT_IN INSTANCE_ARN The Amazon Resource Name (ARN) of the device instance. Supported operators: IN, NOT_IN INSTANCE_LABELS The label of the device instance. Supported operators: CONTAINS MANUFACTURER The device manufacturer. For example, "Apple". Supported operators: EQUALS, IN, NOT_IN MODEL The device model, such as "Apple iPad Air 2" or "Google Pixel". Supported operators: CONTAINS, EQUALS, IN, NOT_IN OS_VERSION The operating system version. For example, "10.3.2". Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN PLATFORM The device platform. Valid values are "ANDROID" or "IOS". Supported operators: EQUALS, IN, NOT_IN REMOTE_ACCESS_ENABLED Whether the device is enabled for remote access. Valid values are "TRUE" or "FALSE". Supported operators: EQUALS REMOTE_DEBUG_ENABLED Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE". Supported operators: EQUALS
2322 */
2323 attribute?: DeviceAttribute;
2324 /**
2325 * Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.
2326 */
2327 operator?: RuleOperator;
2328 /**
2329 * The rule's value.
2330 */
2331 value?: String;
2332 }
2333 export type RuleOperator = "EQUALS"|"LESS_THAN"|"LESS_THAN_OR_EQUALS"|"GREATER_THAN"|"GREATER_THAN_OR_EQUALS"|"IN"|"NOT_IN"|"CONTAINS"|string;
2334 export type Rules = Rule[];
2335 export interface Run {
2336 /**
2337 * The run's ARN.
2338 */
2339 arn?: AmazonResourceName;
2340 /**
2341 * The run's name.
2342 */
2343 name?: Name;
2344 /**
2345 * The run's type. Must be one of the following values: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The XCode test type. XCTEST_UI: The XCode UI test type.
2346 */
2347 type?: TestType;
2348 /**
2349 * The run's platform. Allowed values include: ANDROID: The Android platform. IOS: The iOS platform.
2350 */
2351 platform?: DevicePlatform;
2352 /**
2353 * When the run was created.
2354 */
2355 created?: DateTime;
2356 /**
2357 * The run's status. Allowed values include: PENDING: A pending status. PENDING_CONCURRENCY: A pending concurrency status. PENDING_DEVICE: A pending device status. PROCESSING: A processing status. SCHEDULING: A scheduling status. PREPARING: A preparing status. RUNNING: A running status. COMPLETED: A completed status. STOPPING: A stopping status.
2358 */
2359 status?: ExecutionStatus;
2360 /**
2361 * The run's result. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition.
2362 */
2363 result?: ExecutionResult;
2364 /**
2365 * The run's start time.
2366 */
2367 started?: DateTime;
2368 /**
2369 * The run's stop time.
2370 */
2371 stopped?: DateTime;
2372 /**
2373 * The run's result counters.
2374 */
2375 counters?: Counters;
2376 /**
2377 * A message about the run's result.
2378 */
2379 message?: Message;
2380 /**
2381 * The total number of jobs for the run.
2382 */
2383 totalJobs?: Integer;
2384 /**
2385 * The total number of completed jobs.
2386 */
2387 completedJobs?: Integer;
2388 /**
2389 * Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.
2390 */
2391 billingMethod?: BillingMethod;
2392 /**
2393 * Represents the total (metered or unmetered) minutes used by the test run.
2394 */
2395 deviceMinutes?: DeviceMinutes;
2396 /**
2397 * The network profile being used for a test run.
2398 */
2399 networkProfile?: NetworkProfile;
2400 /**
2401 * Read-only URL for an object in 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 to.
2402 */
2403 parsingResultUrl?: String;
2404 /**
2405 * Supporting field for the result field. Set only if result is SKIPPED. PARSING_FAILED if the result is skipped because of test package parsing failure.
2406 */
2407 resultCode?: ExecutionResultCode;
2408 /**
2409 * For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
2410 */
2411 seed?: Integer;
2412 /**
2413 * An app to upload or that has been uploaded.
2414 */
2415 appUpload?: AmazonResourceName;
2416 /**
2417 * For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
2418 */
2419 eventCount?: Integer;
2420 /**
2421 * The number of minutes the job will execute before it times out.
2422 */
2423 jobTimeoutMinutes?: JobTimeoutMinutes;
2424 /**
2425 * The ARN of the device pool for the run.
2426 */
2427 devicePoolArn?: AmazonResourceName;
2428 /**
2429 * Information about the locale that is used for the run.
2430 */
2431 locale?: String;
2432 /**
2433 * Information about the radio states for the run.
2434 */
2435 radios?: Radios;
2436 /**
2437 * Information about the location that is used for the run.
2438 */
2439 location?: Location;
2440 /**
2441 * Output CustomerArtifactPaths object for the test run.
2442 */
2443 customerArtifactPaths?: CustomerArtifactPaths;
2444 /**
2445 * The Device Farm console URL for the recording of the run.
2446 */
2447 webUrl?: String;
2448 /**
2449 * When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect. For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
2450 */
2451 skipAppResign?: SkipAppResign;
2452 /**
2453 * The ARN of the YAML-formatted test specification for the run.
2454 */
2455 testSpecArn?: AmazonResourceName;
2456 /**
2457 * The results of a device filter used to select the devices for a test run.
2458 */
2459 deviceSelectionResult?: DeviceSelectionResult;
2460 }
2461 export type Runs = Run[];
2462 export interface Sample {
2463 /**
2464 * The sample's ARN.
2465 */
2466 arn?: AmazonResourceName;
2467 /**
2468 * The sample's type. Must be one of the following values: CPU: A CPU sample type. This is expressed as the app processing CPU time (including child processes) as reported by process, as a percentage. MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app process, in kilobytes. NATIVE_AVG_DRAWTIME NATIVE_FPS NATIVE_FRAMES NATIVE_MAX_DRAWTIME NATIVE_MIN_DRAWTIME OPENGL_AVG_DRAWTIME OPENGL_FPS OPENGL_FRAMES OPENGL_MAX_DRAWTIME OPENGL_MIN_DRAWTIME RX RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, by app process. THREADS: A threads sample type. This is expressed as the total number of threads per app process. TX TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process.
2469 */
2470 type?: SampleType;
2471 /**
2472 * The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the sample's file.
2473 */
2474 url?: URL;
2475 }
2476 export type SampleType = "CPU"|"MEMORY"|"THREADS"|"RX_RATE"|"TX_RATE"|"RX"|"TX"|"NATIVE_FRAMES"|"NATIVE_FPS"|"NATIVE_MIN_DRAWTIME"|"NATIVE_AVG_DRAWTIME"|"NATIVE_MAX_DRAWTIME"|"OPENGL_FRAMES"|"OPENGL_FPS"|"OPENGL_MIN_DRAWTIME"|"OPENGL_AVG_DRAWTIME"|"OPENGL_MAX_DRAWTIME"|string;
2477 export type Samples = Sample[];
2478 export interface ScheduleRunConfiguration {
2479 /**
2480 * The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app's sandbox for iOS.
2481 */
2482 extraDataPackageArn?: AmazonResourceName;
2483 /**
2484 * Reserved for internal use.
2485 */
2486 networkProfileArn?: AmazonResourceName;
2487 /**
2488 * Information about the locale that is used for the run.
2489 */
2490 locale?: String;
2491 /**
2492 * Information about the location that is used for the run.
2493 */
2494 location?: Location;
2495 /**
2496 * An array of Amazon Resource Names (ARNs) for your VPC endpoint configurations.
2497 */
2498 vpceConfigurationArns?: AmazonResourceNames;
2499 /**
2500 * Input CustomerArtifactPaths object for the scheduled run configuration.
2501 */
2502 customerArtifactPaths?: CustomerArtifactPaths;
2503 /**
2504 * Information about the radio states for the run.
2505 */
2506 radios?: Radios;
2507 /**
2508 * A list of auxiliary apps for the run.
2509 */
2510 auxiliaryApps?: AmazonResourceNames;
2511 /**
2512 * Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.
2513 */
2514 billingMethod?: BillingMethod;
2515 }
2516 export interface ScheduleRunRequest {
2517 /**
2518 * The ARN of the project for the run to be scheduled.
2519 */
2520 projectArn: AmazonResourceName;
2521 /**
2522 * The ARN of the app to schedule a run.
2523 */
2524 appArn?: AmazonResourceName;
2525 /**
2526 * The ARN of the device pool for the run to be scheduled.
2527 */
2528 devicePoolArn?: AmazonResourceName;
2529 /**
2530 * The filter criteria used to dynamically select a set of devices for a test run, as well as the maximum number of devices to be included in the run. Either devicePoolArn or deviceSelectionConfiguration is required in a request.
2531 */
2532 deviceSelectionConfiguration?: DeviceSelectionConfiguration;
2533 /**
2534 * The name for the run to be scheduled.
2535 */
2536 name?: Name;
2537 /**
2538 * Information about the test for the run to be scheduled.
2539 */
2540 test: ScheduleRunTest;
2541 /**
2542 * Information about the settings for the run to be scheduled.
2543 */
2544 configuration?: ScheduleRunConfiguration;
2545 /**
2546 * Specifies configuration information about a test run, such as the execution timeout (in minutes).
2547 */
2548 executionConfiguration?: ExecutionConfiguration;
2549 }
2550 export interface ScheduleRunResult {
2551 /**
2552 * Information about the scheduled run.
2553 */
2554 run?: Run;
2555 }
2556 export interface ScheduleRunTest {
2557 /**
2558 * The test's type. Must be one of the following values: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The XCode test type. XCTEST_UI: The XCode UI test type.
2559 */
2560 type: TestType;
2561 /**
2562 * The ARN of the uploaded test that will be run.
2563 */
2564 testPackageArn?: AmazonResourceName;
2565 /**
2566 * The ARN of the YAML-formatted test specification.
2567 */
2568 testSpecArn?: AmazonResourceName;
2569 /**
2570 * The test's filter.
2571 */
2572 filter?: Filter;
2573 /**
2574 * The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings. For all tests: app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to "false" to disable it. For Calabash tests: profile: A cucumber profile, for example, "my_profile_name". tags: You can limit execution to features or scenarios that have (or don't have) certain tags, for example, "@smoke" or "@smoke,~@wip". For Appium tests (all types): appium_version: The Appium version. Currently supported values are "1.6.5" (and higher), "latest", and "default". “latest” will run the latest Appium version supported by Device Farm (1.9.1). For “default”, Device Farm will choose a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier, 1.7.2 for iOS 10 and later. This behavior is subject to change. For Fuzz tests (Android only): event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform. throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events. seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences. For Explorer tests: username: A username to use if the Explorer encounters a login form. If not supplied, no username will be inserted. password: A password to use if the Explorer encounters a login form. If not supplied, no password will be inserted. For Instrumentation: filter: A test filter string. Examples: Running a single test case: "com.android.abc.Test1" Running a single test: "com.android.abc.Test1#smoke" Running multiple tests: "com.android.abc.Test1,com.android.abc.Test2" For XCTest and XCTestUI: filter: A test filter string. Examples: Running a single test class: "LoginTests" Running a multiple test classes: "LoginTests,SmokeTests" Running a single test: "LoginTests/testValid" Running multiple tests: "LoginTests/testValid,LoginTests/testInvalid" For UIAutomator: filter: A test filter string. Examples: Running a single test case: "com.android.abc.Test1" Running a single test: "com.android.abc.Test1#smoke" Running multiple tests: "com.android.abc.Test1,com.android.abc.Test2"
2575 */
2576 parameters?: TestParameters;
2577 }
2578 export type ServiceDnsName = string;
2579 export type SkipAppResign = boolean;
2580 export type SshPublicKey = string;
2581 export interface StopJobRequest {
2582 /**
2583 * Represents the Amazon Resource Name (ARN) of the Device Farm job you wish to stop.
2584 */
2585 arn: AmazonResourceName;
2586 }
2587 export interface StopJobResult {
2588 /**
2589 * The job that was stopped.
2590 */
2591 job?: Job;
2592 }
2593 export interface StopRemoteAccessSessionRequest {
2594 /**
2595 * The Amazon Resource Name (ARN) of the remote access session you wish to stop.
2596 */
2597 arn: AmazonResourceName;
2598 }
2599 export interface StopRemoteAccessSessionResult {
2600 /**
2601 * A container representing the metadata from the service about the remote access session you are stopping.
2602 */
2603 remoteAccessSession?: RemoteAccessSession;
2604 }
2605 export interface StopRunRequest {
2606 /**
2607 * Represents the Amazon Resource Name (ARN) of the Device Farm run you wish to stop.
2608 */
2609 arn: AmazonResourceName;
2610 }
2611 export interface StopRunResult {
2612 /**
2613 * The run that was stopped.
2614 */
2615 run?: Run;
2616 }
2617 export type String = string;
2618 export interface Suite {
2619 /**
2620 * The suite's ARN.
2621 */
2622 arn?: AmazonResourceName;
2623 /**
2624 * The suite's name.
2625 */
2626 name?: Name;
2627 /**
2628 * The suite's type. Must be one of the following values: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The XCode test type. XCTEST_UI: The XCode UI test type.
2629 */
2630 type?: TestType;
2631 /**
2632 * When the suite was created.
2633 */
2634 created?: DateTime;
2635 /**
2636 * The suite's status. Allowed values include: PENDING: A pending status. PENDING_CONCURRENCY: A pending concurrency status. PENDING_DEVICE: A pending device status. PROCESSING: A processing status. SCHEDULING: A scheduling status. PREPARING: A preparing status. RUNNING: A running status. COMPLETED: A completed status. STOPPING: A stopping status.
2637 */
2638 status?: ExecutionStatus;
2639 /**
2640 * The suite's result. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition.
2641 */
2642 result?: ExecutionResult;
2643 /**
2644 * The suite's start time.
2645 */
2646 started?: DateTime;
2647 /**
2648 * The suite's stop time.
2649 */
2650 stopped?: DateTime;
2651 /**
2652 * The suite's result counters.
2653 */
2654 counters?: Counters;
2655 /**
2656 * A message about the suite's result.
2657 */
2658 message?: Message;
2659 /**
2660 * Represents the total (metered or unmetered) minutes used by the test suite.
2661 */
2662 deviceMinutes?: DeviceMinutes;
2663 }
2664 export type Suites = Suite[];
2665 export interface Test {
2666 /**
2667 * The test's ARN.
2668 */
2669 arn?: AmazonResourceName;
2670 /**
2671 * The test's name.
2672 */
2673 name?: Name;
2674 /**
2675 * The test's type. Must be one of the following values: BUILTIN_FUZZ: The built-in fuzz type. BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. APPIUM_JAVA_JUNIT: The Appium Java JUnit type. APPIUM_JAVA_TESTNG: The Appium Java TestNG type. APPIUM_PYTHON: The Appium Python type. APPIUM_NODE: The Appium Node.js type. APPIUM_RUBY: The Appium Ruby type. APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps. APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps. APPIUM_WEB_PYTHON: The Appium Python type for web apps. APPIUM_WEB_NODE: The Appium Node.js type for web apps. APPIUM_WEB_RUBY: The Appium Ruby type for web apps. CALABASH: The Calabash type. INSTRUMENTATION: The Instrumentation type. UIAUTOMATION: The uiautomation type. UIAUTOMATOR: The uiautomator type. XCTEST: The XCode test type. XCTEST_UI: The XCode UI test type.
2676 */
2677 type?: TestType;
2678 /**
2679 * When the test was created.
2680 */
2681 created?: DateTime;
2682 /**
2683 * The test's status. Allowed values include: PENDING: A pending status. PENDING_CONCURRENCY: A pending concurrency status. PENDING_DEVICE: A pending device status. PROCESSING: A processing status. SCHEDULING: A scheduling status. PREPARING: A preparing status. RUNNING: A running status. COMPLETED: A completed status. STOPPING: A stopping status.
2684 */
2685 status?: ExecutionStatus;
2686 /**
2687 * The test's result. Allowed values include: PENDING: A pending condition. PASSED: A passing condition. WARNED: A warning condition. FAILED: A failed condition. SKIPPED: A skipped condition. ERRORED: An error condition. STOPPED: A stopped condition.
2688 */
2689 result?: ExecutionResult;
2690 /**
2691 * The test's start time.
2692 */
2693 started?: DateTime;
2694 /**
2695 * The test's stop time.
2696 */
2697 stopped?: DateTime;
2698 /**
2699 * The test's result counters.
2700 */
2701 counters?: Counters;
2702 /**
2703 * A message about the test's result.
2704 */
2705 message?: Message;
2706 /**
2707 * Represents the total (metered or unmetered) minutes used by the test.
2708 */
2709 deviceMinutes?: DeviceMinutes;
2710 }
2711 export type TestParameters = {[key: string]: String};
2712 export type TestType = "BUILTIN_FUZZ"|"BUILTIN_EXPLORER"|"WEB_PERFORMANCE_PROFILE"|"APPIUM_JAVA_JUNIT"|"APPIUM_JAVA_TESTNG"|"APPIUM_PYTHON"|"APPIUM_NODE"|"APPIUM_RUBY"|"APPIUM_WEB_JAVA_JUNIT"|"APPIUM_WEB_JAVA_TESTNG"|"APPIUM_WEB_PYTHON"|"APPIUM_WEB_NODE"|"APPIUM_WEB_RUBY"|"CALABASH"|"INSTRUMENTATION"|"UIAUTOMATION"|"UIAUTOMATOR"|"XCTEST"|"XCTEST_UI"|"REMOTE_ACCESS_RECORD"|"REMOTE_ACCESS_REPLAY"|string;
2713 export type Tests = Test[];
2714 export type TransactionIdentifier = string;
2715 export interface TrialMinutes {
2716 /**
2717 * The total number of free trial minutes that the account started with.
2718 */
2719 total?: Double;
2720 /**
2721 * The number of free trial minutes remaining in the account.
2722 */
2723 remaining?: Double;
2724 }
2725 export type URL = string;
2726 export interface UniqueProblem {
2727 /**
2728 * A message about the unique problems' result.
2729 */
2730 message?: Message;
2731 /**
2732 * Information about the problems.
2733 */
2734 problems?: Problems;
2735 }
2736 export type UniqueProblems = UniqueProblem[];
2737 export type UniqueProblemsByExecutionResultMap = {[key: string]: UniqueProblems};
2738 export interface UpdateDeviceInstanceRequest {
2739 /**
2740 * The Amazon Resource Name (ARN) of the device instance.
2741 */
2742 arn: AmazonResourceName;
2743 /**
2744 * The Amazon Resource Name (ARN) of the profile that you want to associate with the device instance.
2745 */
2746 profileArn?: AmazonResourceName;
2747 /**
2748 * An array of strings that you want to associate with the device instance.
2749 */
2750 labels?: InstanceLabels;
2751 }
2752 export interface UpdateDeviceInstanceResult {
2753 /**
2754 * An object containing information about your device instance.
2755 */
2756 deviceInstance?: DeviceInstance;
2757 }
2758 export interface UpdateDevicePoolRequest {
2759 /**
2760 * The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.
2761 */
2762 arn: AmazonResourceName;
2763 /**
2764 * A string representing the name of the device pool you wish to update.
2765 */
2766 name?: Name;
2767 /**
2768 * A description of the device pool you wish to update.
2769 */
2770 description?: Message;
2771 /**
2772 * Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.
2773 */
2774 rules?: Rules;
2775 /**
2776 * The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter. By specifying the maximum number of devices, you can control the costs that you incur by running tests. If you use this parameter in your request, you cannot use the clearMaxDevices parameter in the same request.
2777 */
2778 maxDevices?: Integer;
2779 /**
2780 * Sets whether the maxDevices parameter applies to your device pool. If you set this parameter to true, the maxDevices parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria that are specified for the rules parameter. If you use this parameter in your request, you cannot use the maxDevices parameter in the same request.
2781 */
2782 clearMaxDevices?: Boolean;
2783 }
2784 export interface UpdateDevicePoolResult {
2785 /**
2786 * The device pool you just updated.
2787 */
2788 devicePool?: DevicePool;
2789 }
2790 export interface UpdateInstanceProfileRequest {
2791 /**
2792 * The Amazon Resource Name (ARN) of the instance profile.
2793 */
2794 arn: AmazonResourceName;
2795 /**
2796 * The updated name for your instance profile.
2797 */
2798 name?: Name;
2799 /**
2800 * The updated description for your instance profile.
2801 */
2802 description?: Message;
2803 /**
2804 * The updated choice for whether you want to specify package cleanup. The default value is false for private devices.
2805 */
2806 packageCleanup?: Boolean;
2807 /**
2808 * An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over. The list of packages is only considered if you set packageCleanup to true.
2809 */
2810 excludeAppPackagesFromCleanup?: PackageIds;
2811 /**
2812 * The updated choice for whether you want to reboot the device after use. The default value is true.
2813 */
2814 rebootAfterUse?: Boolean;
2815 }
2816 export interface UpdateInstanceProfileResult {
2817 /**
2818 * An object containing information about your instance profile.
2819 */
2820 instanceProfile?: InstanceProfile;
2821 }
2822 export interface UpdateNetworkProfileRequest {
2823 /**
2824 * The Amazon Resource Name (ARN) of the project for which you want to update network profile settings.
2825 */
2826 arn: AmazonResourceName;
2827 /**
2828 * The name of the network profile about which you are returning information.
2829 */
2830 name?: Name;
2831 /**
2832 * The descriptoin of the network profile about which you are returning information.
2833 */
2834 description?: Message;
2835 /**
2836 * The type of network profile you wish to return information about. Valid values are listed below.
2837 */
2838 type?: NetworkProfileType;
2839 /**
2840 * The data throughput rate in bits per second, as an integer from 0 to 104857600.
2841 */
2842 uplinkBandwidthBits?: Long;
2843 /**
2844 * The data throughput rate in bits per second, as an integer from 0 to 104857600.
2845 */
2846 downlinkBandwidthBits?: Long;
2847 /**
2848 * Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
2849 */
2850 uplinkDelayMs?: Long;
2851 /**
2852 * Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
2853 */
2854 downlinkDelayMs?: Long;
2855 /**
2856 * Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
2857 */
2858 uplinkJitterMs?: Long;
2859 /**
2860 * Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
2861 */
2862 downlinkJitterMs?: Long;
2863 /**
2864 * Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
2865 */
2866 uplinkLossPercent?: PercentInteger;
2867 /**
2868 * Proportion of received packets that fail to arrive from 0 to 100 percent.
2869 */
2870 downlinkLossPercent?: PercentInteger;
2871 }
2872 export interface UpdateNetworkProfileResult {
2873 /**
2874 * A list of the available network profiles.
2875 */
2876 networkProfile?: NetworkProfile;
2877 }
2878 export interface UpdateProjectRequest {
2879 /**
2880 * The Amazon Resource Name (ARN) of the project whose name you wish to update.
2881 */
2882 arn: AmazonResourceName;
2883 /**
2884 * A string representing the new name of the project that you are updating.
2885 */
2886 name?: Name;
2887 /**
2888 * The number of minutes a test run in the project will execute before it times out.
2889 */
2890 defaultJobTimeoutMinutes?: JobTimeoutMinutes;
2891 }
2892 export interface UpdateProjectResult {
2893 /**
2894 * The project you wish to update.
2895 */
2896 project?: Project;
2897 }
2898 export interface UpdateUploadRequest {
2899 /**
2900 * The Amazon Resource Name (ARN) of the uploaded test spec.
2901 */
2902 arn: AmazonResourceName;
2903 /**
2904 * The upload's test spec file name. The name should not contain the '/' character. The test spec file name must end with the .yaml or .yml file extension.
2905 */
2906 name?: Name;
2907 /**
2908 * The upload's content type (for example, "application/x-yaml").
2909 */
2910 contentType?: ContentType;
2911 /**
2912 * Set to true if the YAML file has changed and needs to be updated; otherwise, set to false.
2913 */
2914 editContent?: Boolean;
2915 }
2916 export interface UpdateUploadResult {
2917 /**
2918 * A test spec uploaded to Device Farm.
2919 */
2920 upload?: Upload;
2921 }
2922 export interface UpdateVPCEConfigurationRequest {
2923 /**
2924 * The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to update.
2925 */
2926 arn: AmazonResourceName;
2927 /**
2928 * The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.
2929 */
2930 vpceConfigurationName?: VPCEConfigurationName;
2931 /**
2932 * The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.
2933 */
2934 vpceServiceName?: VPCEServiceName;
2935 /**
2936 * The DNS (domain) name used to connect to your private service in your Amazon VPC. The DNS name must not already be in use on the Internet.
2937 */
2938 serviceDnsName?: ServiceDnsName;
2939 /**
2940 * An optional description, providing more details about your VPC endpoint configuration.
2941 */
2942 vpceConfigurationDescription?: VPCEConfigurationDescription;
2943 }
2944 export interface UpdateVPCEConfigurationResult {
2945 /**
2946 * An object containing information about your VPC endpoint configuration.
2947 */
2948 vpceConfiguration?: VPCEConfiguration;
2949 }
2950 export interface Upload {
2951 /**
2952 * The upload's ARN.
2953 */
2954 arn?: AmazonResourceName;
2955 /**
2956 * The upload's file name.
2957 */
2958 name?: Name;
2959 /**
2960 * When the upload was created.
2961 */
2962 created?: DateTime;
2963 /**
2964 * The upload's type. Must be one of the following values: ANDROID_APP: An Android upload. IOS_APP: An iOS upload. WEB_APP: A web appliction upload. EXTERNAL_DATA: An external data upload. APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload. APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload. APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload. APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload. APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload. APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for web apps. APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for web apps. APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for web apps. APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for web apps. APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for web apps. CALABASH_TEST_PACKAGE: A Calabash test package upload. INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload. UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload. UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload. XCTEST_TEST_PACKAGE: An XCode test package upload. XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload. APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload. APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload. APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload. APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload. APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload. APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app. APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app. APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app. APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app. APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app. INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload. XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
2965 */
2966 type?: UploadType;
2967 /**
2968 * The upload's status. Must be one of the following values: FAILED: A failed status. INITIALIZED: An initialized status. PROCESSING: A processing status. SUCCEEDED: A succeeded status.
2969 */
2970 status?: UploadStatus;
2971 /**
2972 * The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.
2973 */
2974 url?: URL;
2975 /**
2976 * The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.
2977 */
2978 metadata?: Metadata;
2979 /**
2980 * The upload's content type (for example, "application/octet-stream").
2981 */
2982 contentType?: ContentType;
2983 /**
2984 * A message about the upload's result.
2985 */
2986 message?: Message;
2987 /**
2988 * The upload's category. Allowed values include: CURATED: An upload managed by AWS Device Farm. PRIVATE: An upload managed by the AWS Device Farm customer.
2989 */
2990 category?: UploadCategory;
2991 }
2992 export type UploadCategory = "CURATED"|"PRIVATE"|string;
2993 export type UploadStatus = "INITIALIZED"|"PROCESSING"|"SUCCEEDED"|"FAILED"|string;
2994 export type UploadType = "ANDROID_APP"|"IOS_APP"|"WEB_APP"|"EXTERNAL_DATA"|"APPIUM_JAVA_JUNIT_TEST_PACKAGE"|"APPIUM_JAVA_TESTNG_TEST_PACKAGE"|"APPIUM_PYTHON_TEST_PACKAGE"|"APPIUM_NODE_TEST_PACKAGE"|"APPIUM_RUBY_TEST_PACKAGE"|"APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE"|"APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE"|"APPIUM_WEB_PYTHON_TEST_PACKAGE"|"APPIUM_WEB_NODE_TEST_PACKAGE"|"APPIUM_WEB_RUBY_TEST_PACKAGE"|"CALABASH_TEST_PACKAGE"|"INSTRUMENTATION_TEST_PACKAGE"|"UIAUTOMATION_TEST_PACKAGE"|"UIAUTOMATOR_TEST_PACKAGE"|"XCTEST_TEST_PACKAGE"|"XCTEST_UI_TEST_PACKAGE"|"APPIUM_JAVA_JUNIT_TEST_SPEC"|"APPIUM_JAVA_TESTNG_TEST_SPEC"|"APPIUM_PYTHON_TEST_SPEC"|"APPIUM_NODE_TEST_SPEC"|"APPIUM_RUBY_TEST_SPEC"|"APPIUM_WEB_JAVA_JUNIT_TEST_SPEC"|"APPIUM_WEB_JAVA_TESTNG_TEST_SPEC"|"APPIUM_WEB_PYTHON_TEST_SPEC"|"APPIUM_WEB_NODE_TEST_SPEC"|"APPIUM_WEB_RUBY_TEST_SPEC"|"INSTRUMENTATION_TEST_SPEC"|"XCTEST_UI_TEST_SPEC"|string;
2995 export type Uploads = Upload[];
2996 export interface VPCEConfiguration {
2997 /**
2998 * The Amazon Resource Name (ARN) of the VPC endpoint configuration.
2999 */
3000 arn?: AmazonResourceName;
3001 /**
3002 * The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.
3003 */
3004 vpceConfigurationName?: VPCEConfigurationName;
3005 /**
3006 * The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.
3007 */
3008 vpceServiceName?: VPCEServiceName;
3009 /**
3010 * The DNS name that maps to the private IP address of the service you want to access.
3011 */
3012 serviceDnsName?: ServiceDnsName;
3013 /**
3014 * An optional description, providing more details about your VPC endpoint configuration.
3015 */
3016 vpceConfigurationDescription?: VPCEConfigurationDescription;
3017 }
3018 export type VPCEConfigurationDescription = string;
3019 export type VPCEConfigurationName = string;
3020 export type VPCEConfigurations = VPCEConfiguration[];
3021 export type VPCEServiceName = string;
3022 export type VideoCapture = boolean;
3023 /**
3024 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
3025 */
3026 export type apiVersion = "2015-06-23"|"latest"|string;
3027 export interface ClientApiVersions {
3028 /**
3029 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
3030 */
3031 apiVersion?: apiVersion;
3032 }
3033 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
3034 /**
3035 * Contains interfaces for use with the DeviceFarm client.
3036 */
3037 export import Types = DeviceFarm;
3038}
3039export = DeviceFarm;