1{ 2 "version": "1.0", 3 "examples": { 4 "CreateDevicePool": [ 5 { 6 "input": { 7 "name": "MyDevicePool", 8 "description": "My Android devices", 9 "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", 10 "rules": [ 11 12 ] 13 }, 14 "output": { 15 "devicePool": { 16 } 17 }, 18 "comments": { 19 "input": { 20 "name": "A device pool contains related devices, such as devices that run only on Android or that run only on iOS.", 21 "projectArn": "You can get the project ARN by using the list-projects CLI command." 22 }, 23 "output": { 24 } 25 }, 26 "description": "The following example creates a new device pool named MyDevicePool inside an existing project.", 27 "id": "createdevicepool-example-1470862210860", 28 "title": "To create a new device pool" 29 } 30 ], 31 "CreateProject": [ 32 { 33 "input": { 34 "name": "MyProject" 35 }, 36 "output": { 37 "project": { 38 "name": "MyProject", 39 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE", 40 "created": "1472660939.152" 41 } 42 }, 43 "comments": { 44 "input": { 45 "name": "A project in Device Farm is a workspace that contains test runs. A run is a test of a single app against one or more devices." 46 }, 47 "output": { 48 } 49 }, 50 "description": "The following example creates a new project named MyProject.", 51 "id": "createproject-example-1470862210860", 52 "title": "To create a new project" 53 } 54 ], 55 "CreateRemoteAccessSession": [ 56 { 57 "input": { 58 "name": "MySession", 59 "configuration": { 60 "billingMethod": "METERED" 61 }, 62 "deviceArn": "arn:aws:devicefarm:us-west-2::device:123EXAMPLE", 63 "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" 64 }, 65 "output": { 66 "remoteAccessSession": { 67 } 68 }, 69 "comments": { 70 "input": { 71 "deviceArn": "You can get the device ARN by using the list-devices CLI command.", 72 "projectArn": "You can get the project ARN by using the list-projects CLI command." 73 }, 74 "output": { 75 } 76 }, 77 "description": "The following example creates a remote access session named MySession.", 78 "id": "to-create-a-remote-access-session-1470970668274", 79 "title": "To create a remote access session" 80 } 81 ], 82 "CreateUpload": [ 83 { 84 "input": { 85 "name": "MyAppiumPythonUpload", 86 "type": "APPIUM_PYTHON_TEST_PACKAGE", 87 "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" 88 }, 89 "output": { 90 "upload": { 91 "name": "MyAppiumPythonUpload", 92 "type": "APPIUM_PYTHON_TEST_PACKAGE", 93 "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE", 94 "created": "1472661404.186", 95 "status": "INITIALIZED", 96 "url": "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789101%3Aproject%3A5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789101%3Aupload%3A5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE/MyAppiumPythonUpload?AWSAccessKeyId=1234567891011EXAMPLE&Expires=1472747804&Signature=1234567891011EXAMPLE" 97 } 98 }, 99 "comments": { 100 "input": { 101 "projectArn": "You can get the project ARN by using the list-projects CLI command." 102 }, 103 "output": { 104 } 105 }, 106 "description": "The following example creates a new Appium Python test package upload inside an existing project.", 107 "id": "createupload-example-1470864711775", 108 "title": "To create a new test package upload" 109 } 110 ], 111 "DeleteDevicePool": [ 112 { 113 "input": { 114 "arn": "arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID" 115 }, 116 "output": { 117 }, 118 "comments": { 119 "input": { 120 "arn": "You can get the device pool ARN by using the list-device-pools CLI command." 121 }, 122 "output": { 123 } 124 }, 125 "description": "The following example deletes a specific device pool.", 126 "id": "deletedevicepool-example-1470866975494", 127 "title": "To delete a device pool" 128 } 129 ], 130 "DeleteProject": [ 131 { 132 "input": { 133 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" 134 }, 135 "output": { 136 }, 137 "comments": { 138 "input": { 139 "arn": "You can get the project ARN by using the list-projects CLI command." 140 }, 141 "output": { 142 } 143 }, 144 "description": "The following example deletes a specific project.", 145 "id": "deleteproject-example-1470867374212", 146 "title": "To delete a project" 147 } 148 ], 149 "DeleteRemoteAccessSession": [ 150 { 151 "input": { 152 "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456" 153 }, 154 "output": { 155 }, 156 "comments": { 157 "input": { 158 "arn": "You can get the remote access session ARN by using the list-remote-access-sessions CLI command." 159 }, 160 "output": { 161 } 162 }, 163 "description": "The following example deletes a specific remote access session.", 164 "id": "to-delete-a-specific-remote-access-session-1470971431677", 165 "title": "To delete a specific remote access session" 166 } 167 ], 168 "DeleteRun": [ 169 { 170 "input": { 171 "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456" 172 }, 173 "output": { 174 }, 175 "comments": { 176 "input": { 177 "arn": "You can get the run ARN by using the list-runs CLI command." 178 }, 179 "output": { 180 } 181 }, 182 "description": "The following example deletes a specific test run.", 183 "id": "deleterun-example-1470867905129", 184 "title": "To delete a run" 185 } 186 ], 187 "DeleteUpload": [ 188 { 189 "input": { 190 "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456" 191 }, 192 "output": { 193 }, 194 "comments": { 195 "input": { 196 "arn": "You can get the upload ARN by using the list-uploads CLI command." 197 }, 198 "output": { 199 } 200 }, 201 "description": "The following example deletes a specific upload.", 202 "id": "deleteupload-example-1470868363942", 203 "title": "To delete a specific upload" 204 } 205 ], 206 "GetAccountSettings": [ 207 { 208 "input": { 209 }, 210 "output": { 211 "accountSettings": { 212 "awsAccountNumber": "123456789101", 213 "unmeteredDevices": { 214 "ANDROID": 1, 215 "IOS": 2 216 } 217 } 218 }, 219 "comments": { 220 "input": { 221 }, 222 "output": { 223 } 224 }, 225 "description": "The following example returns information about your Device Farm account settings.", 226 "id": "to-get-information-about-account-settings-1472567568189", 227 "title": "To get information about account settings" 228 } 229 ], 230 "GetDevice": [ 231 { 232 "input": { 233 "arn": "arn:aws:devicefarm:us-west-2::device:123EXAMPLE" 234 }, 235 "output": { 236 "device": { 237 "name": "LG G2 (Sprint)", 238 "arn": "arn:aws:devicefarm:us-west-2::device:A0E6E6E1059E45918208DF75B2B7EF6C", 239 "cpu": { 240 "architecture": "armeabi-v7a", 241 "clock": 2265.6, 242 "frequency": "MHz" 243 }, 244 "formFactor": "PHONE", 245 "heapSize": 256000000, 246 "image": "75B2B7EF6C12345EXAMPLE", 247 "manufacturer": "LG", 248 "memory": 16000000000, 249 "model": "G2 (Sprint)", 250 "os": "4.2.2", 251 "platform": "ANDROID", 252 "resolution": { 253 "height": 1920, 254 "width": 1080 255 } 256 } 257 }, 258 "comments": { 259 "input": { 260 }, 261 "output": { 262 } 263 }, 264 "description": "The following example returns information about a specific device.", 265 "id": "getdevice-example-1470870602173", 266 "title": "To get information about a device" 267 } 268 ], 269 "GetDevicePool": [ 270 { 271 "input": { 272 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" 273 }, 274 "output": { 275 "devicePool": { 276 } 277 }, 278 "comments": { 279 "input": { 280 "arn": "You can obtain the project ARN by using the list-projects CLI command." 281 }, 282 "output": { 283 } 284 }, 285 "description": "The following example returns information about a specific device pool, given a project ARN.", 286 "id": "getdevicepool-example-1470870873136", 287 "title": "To get information about a device pool" 288 } 289 ], 290 "GetDevicePoolCompatibility": [ 291 { 292 "input": { 293 "appArn": "arn:aws:devicefarm:us-west-2::app:123-456-EXAMPLE-GUID", 294 "devicePoolArn": "arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID", 295 "testType": "APPIUM_PYTHON" 296 }, 297 "output": { 298 "compatibleDevices": [ 299 300 ], 301 "incompatibleDevices": [ 302 303 ] 304 }, 305 "comments": { 306 "input": { 307 "devicePoolArn": "You can get the device pool ARN by using the list-device-pools CLI command." 308 }, 309 "output": { 310 } 311 }, 312 "description": "The following example returns information about the compatibility of a specific device pool, given its ARN.", 313 "id": "getdevicepoolcompatibility-example-1470925003466", 314 "title": "To get information about the compatibility of a device pool" 315 } 316 ], 317 "GetJob": [ 318 { 319 "input": { 320 "arn": "arn:aws:devicefarm:us-west-2::job:123-456-EXAMPLE-GUID" 321 }, 322 "output": { 323 "job": { 324 } 325 }, 326 "comments": { 327 "input": { 328 "arn": "You can get the job ARN by using the list-jobs CLI command." 329 }, 330 "output": { 331 } 332 }, 333 "description": "The following example returns information about a specific job.", 334 "id": "getjob-example-1470928294268", 335 "title": "To get information about a job" 336 } 337 ], 338 "GetOfferingStatus": [ 339 { 340 "input": { 341 "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=" 342 }, 343 "output": { 344 "current": { 345 "D68B3C05-1BA6-4360-BC69-12345EXAMPLE": { 346 "offering": { 347 "type": "RECURRING", 348 "description": "Android Remote Access Unmetered Device Slot", 349 "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", 350 "platform": "ANDROID" 351 }, 352 "quantity": 1 353 } 354 }, 355 "nextPeriod": { 356 "D68B3C05-1BA6-4360-BC69-12345EXAMPLE": { 357 "effectiveOn": "1472688000", 358 "offering": { 359 "type": "RECURRING", 360 "description": "Android Remote Access Unmetered Device Slot", 361 "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", 362 "platform": "ANDROID" 363 }, 364 "quantity": 1 365 } 366 } 367 }, 368 "comments": { 369 "input": { 370 "nextToken": "A dynamically generated value, used for paginating results." 371 }, 372 "output": { 373 } 374 }, 375 "description": "The following example returns information about Device Farm offerings available to your account.", 376 "id": "to-get-status-information-about-device-offerings-1472568124402", 377 "title": "To get status information about device offerings" 378 } 379 ], 380 "GetProject": [ 381 { 382 "input": { 383 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE" 384 }, 385 "output": { 386 "project": { 387 "name": "My Project", 388 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE", 389 "created": "1472660939.152" 390 } 391 }, 392 "comments": { 393 "input": { 394 "arn": "You can get the project ARN by using the list-projects CLI command." 395 }, 396 "output": { 397 } 398 }, 399 "description": "The following example gets information about a specific project.", 400 "id": "to-get-a-project-1470975038449", 401 "title": "To get information about a project" 402 } 403 ], 404 "GetRemoteAccessSession": [ 405 { 406 "input": { 407 "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456" 408 }, 409 "output": { 410 "remoteAccessSession": { 411 } 412 }, 413 "comments": { 414 "input": { 415 "arn": "You can get the remote access session ARN by using the list-remote-access-sessions CLI command." 416 }, 417 "output": { 418 } 419 }, 420 "description": "The following example gets a specific remote access session.", 421 "id": "to-get-a-remote-access-session-1471014119414", 422 "title": "To get a remote access session" 423 } 424 ], 425 "GetRun": [ 426 { 427 "input": { 428 "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE" 429 }, 430 "output": { 431 "run": { 432 "name": "My Test Run", 433 "type": "BUILTIN_EXPLORER", 434 "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE", 435 "billingMethod": "METERED", 436 "completedJobs": 0, 437 "counters": { 438 "errored": 0, 439 "failed": 0, 440 "passed": 0, 441 "skipped": 0, 442 "stopped": 0, 443 "total": 0, 444 "warned": 0 445 }, 446 "created": "1472667509.852", 447 "deviceMinutes": { 448 "metered": 0.0, 449 "total": 0.0, 450 "unmetered": 0.0 451 }, 452 "platform": "ANDROID", 453 "result": "PENDING", 454 "status": "RUNNING", 455 "totalJobs": 3 456 } 457 }, 458 "comments": { 459 "input": { 460 "arn": "You can get the run ARN by using the list-runs CLI command." 461 }, 462 "output": { 463 } 464 }, 465 "description": "The following example gets information about a specific test run.", 466 "id": "to-get-a-test-run-1471015895657", 467 "title": "To get information about a test run" 468 } 469 ], 470 "GetSuite": [ 471 { 472 "input": { 473 "arn": "arn:aws:devicefarm:us-west-2:123456789101:suite:EXAMPLE-GUID-123-456" 474 }, 475 "output": { 476 "suite": { 477 } 478 }, 479 "comments": { 480 "input": { 481 "arn": "You can get the suite ARN by using the list-suites CLI command." 482 }, 483 "output": { 484 } 485 }, 486 "description": "The following example gets information about a specific test suite.", 487 "id": "to-get-information-about-a-test-suite-1471016525008", 488 "title": "To get information about a test suite" 489 } 490 ], 491 "GetTest": [ 492 { 493 "input": { 494 "arn": "arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456" 495 }, 496 "output": { 497 "test": { 498 } 499 }, 500 "comments": { 501 "input": { 502 "arn": "You can get the test ARN by using the list-tests CLI command." 503 }, 504 "output": { 505 } 506 }, 507 "description": "The following example gets information about a specific test.", 508 "id": "to-get-information-about-a-specific-test-1471025744238", 509 "title": "To get information about a specific test" 510 } 511 ], 512 "GetUpload": [ 513 { 514 "input": { 515 "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456" 516 }, 517 "output": { 518 "upload": { 519 } 520 }, 521 "comments": { 522 "input": { 523 "arn": "You can get the test ARN by using the list-uploads CLI command." 524 }, 525 "output": { 526 } 527 }, 528 "description": "The following example gets information about a specific upload.", 529 "id": "to-get-information-about-a-specific-upload-1471025996221", 530 "title": "To get information about a specific upload" 531 } 532 ], 533 "InstallToRemoteAccessSession": [ 534 { 535 "input": { 536 "appArn": "arn:aws:devicefarm:us-west-2:123456789101:app:EXAMPLE-GUID-123-456", 537 "remoteAccessSessionArn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456" 538 }, 539 "output": { 540 "appUpload": { 541 } 542 }, 543 "comments": { 544 "input": { 545 "remoteAccessSessionArn": "You can get the remote access session ARN by using the list-remote-access-sessions CLI command." 546 }, 547 "output": { 548 } 549 }, 550 "description": "The following example installs a specific app to a device in a specific remote access session.", 551 "id": "to-install-to-a-remote-access-session-1471634453818", 552 "title": "To install to a remote access session" 553 } 554 ], 555 "ListArtifacts": [ 556 { 557 "input": { 558 "type": "SCREENSHOT", 559 "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456" 560 }, 561 "comments": { 562 "input": { 563 "arn": "Can also be used to list artifacts for a Job, Suite, or Test ARN." 564 }, 565 "output": { 566 } 567 }, 568 "description": "The following example lists screenshot artifacts for a specific run.", 569 "id": "to-list-artifacts-for-a-resource-1471635409527", 570 "title": "To list artifacts for a resource" 571 } 572 ], 573 "ListDevicePools": [ 574 { 575 "input": { 576 "type": "PRIVATE", 577 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" 578 }, 579 "output": { 580 "devicePools": [ 581 { 582 "name": "Top Devices", 583 "arn": "arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE", 584 "description": "Top devices", 585 "rules": [ 586 { 587 "value": "[\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\"]", 588 "attribute": "ARN", 589 "operator": "IN" 590 } 591 ] 592 }, 593 { 594 "name": "My Android Device Pool", 595 "arn": "arn:aws:devicefarm:us-west-2:123456789101:devicepool:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/bf96e75a-28f6-4e61-b6a7-12345EXAMPLE", 596 "description": "Samsung Galaxy Android devices", 597 "rules": [ 598 { 599 "value": "[\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\"]", 600 "attribute": "ARN", 601 "operator": "IN" 602 } 603 ] 604 } 605 ] 606 }, 607 "comments": { 608 "input": { 609 "arn": "You can get the project ARN by using the list-projects CLI command." 610 }, 611 "output": { 612 } 613 }, 614 "description": "The following example returns information about the private device pools in a specific project.", 615 "id": "to-get-information-about-device-pools-1471635745170", 616 "title": "To get information about device pools" 617 } 618 ], 619 "ListDevices": [ 620 { 621 "input": { 622 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" 623 }, 624 "output": { 625 }, 626 "comments": { 627 "input": { 628 "arn": "You can get the project ARN by using the list-projects CLI command." 629 }, 630 "output": { 631 } 632 }, 633 "description": "The following example returns information about the available devices in a specific project.", 634 "id": "to-get-information-about-devices-1471641699344", 635 "title": "To get information about devices" 636 } 637 ], 638 "ListJobs": [ 639 { 640 "input": { 641 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" 642 }, 643 "comments": { 644 "input": { 645 "arn": "You can get the project ARN by using the list-jobs CLI command." 646 }, 647 "output": { 648 } 649 }, 650 "description": "The following example returns information about jobs in a specific project.", 651 "id": "to-get-information-about-jobs-1471642228071", 652 "title": "To get information about jobs" 653 } 654 ], 655 "ListOfferingTransactions": [ 656 { 657 "input": { 658 "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=" 659 }, 660 "output": { 661 "offeringTransactions": [ 662 { 663 "cost": { 664 "amount": 0, 665 "currencyCode": "USD" 666 }, 667 "createdOn": "1470021420", 668 "offeringStatus": { 669 "type": "RENEW", 670 "effectiveOn": "1472688000", 671 "offering": { 672 "type": "RECURRING", 673 "description": "Android Remote Access Unmetered Device Slot", 674 "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", 675 "platform": "ANDROID" 676 }, 677 "quantity": 0 678 }, 679 "transactionId": "03728003-d1ea-4851-abd6-12345EXAMPLE" 680 }, 681 { 682 "cost": { 683 "amount": 250, 684 "currencyCode": "USD" 685 }, 686 "createdOn": "1470021420", 687 "offeringStatus": { 688 "type": "PURCHASE", 689 "effectiveOn": "1470021420", 690 "offering": { 691 "type": "RECURRING", 692 "description": "Android Remote Access Unmetered Device Slot", 693 "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", 694 "platform": "ANDROID" 695 }, 696 "quantity": 1 697 }, 698 "transactionId": "56820b6e-06bd-473a-8ff8-12345EXAMPLE" 699 }, 700 { 701 "cost": { 702 "amount": 175, 703 "currencyCode": "USD" 704 }, 705 "createdOn": "1465538520", 706 "offeringStatus": { 707 "type": "PURCHASE", 708 "effectiveOn": "1465538520", 709 "offering": { 710 "type": "RECURRING", 711 "description": "Android Unmetered Device Slot", 712 "id": "8980F81C-00D7-469D-8EC6-12345EXAMPLE", 713 "platform": "ANDROID" 714 }, 715 "quantity": 1 716 }, 717 "transactionId": "953ae2c6-d760-4a04-9597-12345EXAMPLE" 718 }, 719 { 720 "cost": { 721 "amount": 8.07, 722 "currencyCode": "USD" 723 }, 724 "createdOn": "1459344300", 725 "offeringStatus": { 726 "type": "PURCHASE", 727 "effectiveOn": "1459344300", 728 "offering": { 729 "type": "RECURRING", 730 "description": "iOS Unmetered Device Slot", 731 "id": "A53D4D73-A6F6-4B82-A0B0-12345EXAMPLE", 732 "platform": "IOS" 733 }, 734 "quantity": 1 735 }, 736 "transactionId": "2baf9021-ae3e-47f5-ab52-12345EXAMPLE" 737 } 738 ] 739 }, 740 "comments": { 741 "input": { 742 "nextToken": "A dynamically generated value, used for paginating results." 743 }, 744 "output": { 745 } 746 }, 747 "description": "The following example returns information about Device Farm offering transactions.", 748 "id": "to-get-information-about-device-offering-transactions-1472561712315", 749 "title": "To get information about device offering transactions" 750 } 751 ], 752 "ListOfferings": [ 753 { 754 "input": { 755 "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=" 756 }, 757 "output": { 758 "offerings": [ 759 { 760 "type": "RECURRING", 761 "description": "iOS Unmetered Device Slot", 762 "id": "A53D4D73-A6F6-4B82-A0B0-12345EXAMPLE", 763 "platform": "IOS", 764 "recurringCharges": [ 765 { 766 "cost": { 767 "amount": 250, 768 "currencyCode": "USD" 769 }, 770 "frequency": "MONTHLY" 771 } 772 ] 773 }, 774 { 775 "type": "RECURRING", 776 "description": "Android Unmetered Device Slot", 777 "id": "8980F81C-00D7-469D-8EC6-12345EXAMPLE", 778 "platform": "ANDROID", 779 "recurringCharges": [ 780 { 781 "cost": { 782 "amount": 250, 783 "currencyCode": "USD" 784 }, 785 "frequency": "MONTHLY" 786 } 787 ] 788 }, 789 { 790 "type": "RECURRING", 791 "description": "Android Remote Access Unmetered Device Slot", 792 "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", 793 "platform": "ANDROID", 794 "recurringCharges": [ 795 { 796 "cost": { 797 "amount": 250, 798 "currencyCode": "USD" 799 }, 800 "frequency": "MONTHLY" 801 } 802 ] 803 }, 804 { 805 "type": "RECURRING", 806 "description": "iOS Remote Access Unmetered Device Slot", 807 "id": "552B4DAD-A6C9-45C4-94FB-12345EXAMPLE", 808 "platform": "IOS", 809 "recurringCharges": [ 810 { 811 "cost": { 812 "amount": 250, 813 "currencyCode": "USD" 814 }, 815 "frequency": "MONTHLY" 816 } 817 ] 818 } 819 ] 820 }, 821 "comments": { 822 "input": { 823 "nextToken": "A dynamically generated value, used for paginating results." 824 }, 825 "output": { 826 } 827 }, 828 "description": "The following example returns information about available device offerings.", 829 "id": "to-get-information-about-device-offerings-1472562810999", 830 "title": "To get information about device offerings" 831 } 832 ], 833 "ListProjects": [ 834 { 835 "input": { 836 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE", 837 "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" 838 }, 839 "output": { 840 "projects": [ 841 { 842 "name": "My Test Project", 843 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE", 844 "created": "1453163262.105" 845 }, 846 { 847 "name": "Hello World", 848 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:d6b087d9-56db-4e44-b9ec-12345EXAMPLE", 849 "created": "1470350112.439" 850 } 851 ] 852 }, 853 "comments": { 854 "input": { 855 "nextToken": "A dynamically generated value, used for paginating results." 856 }, 857 "output": { 858 } 859 }, 860 "description": "The following example returns information about the specified project in Device Farm.", 861 "id": "to-get-information-about-a-device-farm-project-1472564014388", 862 "title": "To get information about a Device Farm project" 863 } 864 ], 865 "ListRemoteAccessSessions": [ 866 { 867 "input": { 868 "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456", 869 "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=" 870 }, 871 "output": { 872 "remoteAccessSessions": [ 873 874 ] 875 }, 876 "comments": { 877 "input": { 878 "arn": "You can get the Amazon Resource Name (ARN) of the session by using the list-sessions CLI command.", 879 "nextToken": "A dynamically generated value, used for paginating results." 880 }, 881 "output": { 882 } 883 }, 884 "description": "The following example returns information about a specific Device Farm remote access session.", 885 "id": "to-get-information-about-a-remote-access-session-1472581144803", 886 "title": "To get information about a remote access session" 887 } 888 ], 889 "ListRuns": [ 890 { 891 "input": { 892 "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE", 893 "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" 894 }, 895 "output": { 896 "runs": [ 897 { 898 "name": "My Test Run", 899 "type": "BUILTIN_EXPLORER", 900 "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE", 901 "billingMethod": "METERED", 902 "completedJobs": 0, 903 "counters": { 904 "errored": 0, 905 "failed": 0, 906 "passed": 0, 907 "skipped": 0, 908 "stopped": 0, 909 "total": 0, 910 "warned": 0 911 }, 912 "created": "1472667509.852", 913 "deviceMinutes": { 914 "metered": 0.0, 915 "total": 0.0, 916 "unmetered": 0.0 917 }, 918 "platform": "ANDROID", 919 "result": "PENDING", 920 "status": "RUNNING", 921 "totalJobs": 3 922 } 923 ] 924 }, 925 "comments": { 926 "input": { 927 "arn": "You can get the Amazon Resource Name (ARN) of the run by using the list-runs CLI command.", 928 "nextToken": "A dynamically generated value, used for paginating results." 929 }, 930 "output": { 931 } 932 }, 933 "description": "The following example returns information about a specific test run.", 934 "id": "to-get-information-about-test-runs-1472582711069", 935 "title": "To get information about a test run" 936 } 937 ], 938 "ListSamples": [ 939 { 940 "input": { 941 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", 942 "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" 943 }, 944 "output": { 945 "samples": [ 946 947 ] 948 }, 949 "comments": { 950 "input": { 951 "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", 952 "nextToken": "A dynamically generated value, used for paginating results." 953 }, 954 "output": { 955 } 956 }, 957 "description": "The following example returns information about samples, given a specific Device Farm project.", 958 "id": "to-get-information-about-samples-1472582847534", 959 "title": "To get information about samples" 960 } 961 ], 962 "ListSuites": [ 963 { 964 "input": { 965 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", 966 "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" 967 }, 968 "output": { 969 "suites": [ 970 971 ] 972 }, 973 "comments": { 974 "input": { 975 "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", 976 "nextToken": "A dynamically generated value, used for paginating results." 977 }, 978 "output": { 979 } 980 }, 981 "description": "The following example returns information about suites, given a specific Device Farm project.", 982 "id": "to-get-information-about-suites-1472583038218", 983 "title": "To get information about suites" 984 } 985 ], 986 "ListTests": [ 987 { 988 "input": { 989 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", 990 "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" 991 }, 992 "output": { 993 "tests": [ 994 995 ] 996 }, 997 "comments": { 998 "input": { 999 "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", 1000 "nextToken": "A dynamically generated value, used for paginating results." 1001 }, 1002 "output": { 1003 } 1004 }, 1005 "description": "The following example returns information about tests, given a specific Device Farm project.", 1006 "id": "to-get-information-about-tests-1472617372212", 1007 "title": "To get information about tests" 1008 } 1009 ], 1010 "ListUniqueProblems": [ 1011 { 1012 "input": { 1013 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", 1014 "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" 1015 }, 1016 "output": { 1017 "uniqueProblems": { 1018 } 1019 }, 1020 "comments": { 1021 "input": { 1022 "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", 1023 "nextToken": "A dynamically generated value, used for paginating results." 1024 }, 1025 "output": { 1026 } 1027 }, 1028 "description": "The following example returns information about unique problems, given a specific Device Farm project.", 1029 "id": "to-get-information-about-unique-problems-1472617781008", 1030 "title": "To get information about unique problems" 1031 } 1032 ], 1033 "ListUploads": [ 1034 { 1035 "input": { 1036 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", 1037 "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" 1038 }, 1039 "output": { 1040 "uploads": [ 1041 1042 ] 1043 }, 1044 "comments": { 1045 "input": { 1046 "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", 1047 "nextToken": "A dynamically generated value, used for paginating results." 1048 }, 1049 "output": { 1050 } 1051 }, 1052 "description": "The following example returns information about uploads, given a specific Device Farm project.", 1053 "id": "to-get-information-about-uploads-1472617943090", 1054 "title": "To get information about uploads" 1055 } 1056 ], 1057 "PurchaseOffering": [ 1058 { 1059 "input": { 1060 "offeringId": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", 1061 "quantity": 1 1062 }, 1063 "output": { 1064 "offeringTransaction": { 1065 "cost": { 1066 "amount": 8.07, 1067 "currencyCode": "USD" 1068 }, 1069 "createdOn": "1472648340", 1070 "offeringStatus": { 1071 "type": "PURCHASE", 1072 "effectiveOn": "1472648340", 1073 "offering": { 1074 "type": "RECURRING", 1075 "description": "Android Remote Access Unmetered Device Slot", 1076 "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", 1077 "platform": "ANDROID" 1078 }, 1079 "quantity": 1 1080 }, 1081 "transactionId": "d30614ed-1b03-404c-9893-12345EXAMPLE" 1082 } 1083 }, 1084 "comments": { 1085 "input": { 1086 "offeringId": "You can get the offering ID by using the list-offerings CLI command." 1087 }, 1088 "output": { 1089 } 1090 }, 1091 "description": "The following example purchases a specific device slot offering.", 1092 "id": "to-purchase-a-device-slot-offering-1472648146343", 1093 "title": "To purchase a device slot offering" 1094 } 1095 ], 1096 "RenewOffering": [ 1097 { 1098 "input": { 1099 "offeringId": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", 1100 "quantity": 1 1101 }, 1102 "output": { 1103 "offeringTransaction": { 1104 "cost": { 1105 "amount": 250, 1106 "currencyCode": "USD" 1107 }, 1108 "createdOn": "1472648880", 1109 "offeringStatus": { 1110 "type": "RENEW", 1111 "effectiveOn": "1472688000", 1112 "offering": { 1113 "type": "RECURRING", 1114 "description": "Android Remote Access Unmetered Device Slot", 1115 "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", 1116 "platform": "ANDROID" 1117 }, 1118 "quantity": 1 1119 }, 1120 "transactionId": "e90f1405-8c35-4561-be43-12345EXAMPLE" 1121 } 1122 }, 1123 "comments": { 1124 "input": { 1125 "offeringId": "You can get the offering ID by using the list-offerings CLI command." 1126 }, 1127 "output": { 1128 } 1129 }, 1130 "description": "The following example renews a specific device slot offering.", 1131 "id": "to-renew-a-device-slot-offering-1472648899785", 1132 "title": "To renew a device slot offering" 1133 } 1134 ], 1135 "ScheduleRun": [ 1136 { 1137 "input": { 1138 "name": "MyRun", 1139 "devicePoolArn": "arn:aws:devicefarm:us-west-2:123456789101:pool:EXAMPLE-GUID-123-456", 1140 "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", 1141 "test": { 1142 "type": "APPIUM_JAVA_JUNIT", 1143 "testPackageArn": "arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456" 1144 } 1145 }, 1146 "output": { 1147 "run": { 1148 } 1149 }, 1150 "comments": { 1151 "input": { 1152 "devicePoolArn": "You can get the Amazon Resource Name (ARN) of the device pool by using the list-pools CLI command.", 1153 "projectArn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", 1154 "testPackageArn": "You can get the Amazon Resource Name (ARN) of the test package by using the list-tests CLI command." 1155 }, 1156 "output": { 1157 } 1158 }, 1159 "description": "The following example schedules a test run named MyRun.", 1160 "id": "to-schedule-a-test-run-1472652429636", 1161 "title": "To schedule a test run" 1162 } 1163 ], 1164 "StopRun": [ 1165 { 1166 "input": { 1167 "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456" 1168 }, 1169 "output": { 1170 "run": { 1171 } 1172 }, 1173 "comments": { 1174 "input": { 1175 "arn": "You can get the Amazon Resource Name (ARN) of the test run by using the list-runs CLI command." 1176 }, 1177 "output": { 1178 } 1179 }, 1180 "description": "The following example stops a specific test run.", 1181 "id": "to-stop-a-test-run-1472653770340", 1182 "title": "To stop a test run" 1183 } 1184 ], 1185 "UpdateDevicePool": [ 1186 { 1187 "input": { 1188 "name": "NewName", 1189 "arn": "arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE", 1190 "description": "NewDescription", 1191 "rules": [ 1192 { 1193 "value": "True", 1194 "attribute": "REMOTE_ACCESS_ENABLED", 1195 "operator": "EQUALS" 1196 } 1197 ] 1198 }, 1199 "output": { 1200 "devicePool": { 1201 } 1202 }, 1203 "comments": { 1204 "input": { 1205 "arn": "You can get the Amazon Resource Name (ARN) of the device pool by using the list-pools CLI command." 1206 }, 1207 "output": { 1208 "devicePool": "Note: you cannot update curated device pools." 1209 } 1210 }, 1211 "description": "The following example updates the specified device pool with a new name and description. It also enables remote access of devices in the device pool.", 1212 "id": "to-update-a-device-pool-1472653887677", 1213 "title": "To update a device pool" 1214 } 1215 ], 1216 "UpdateProject": [ 1217 { 1218 "input": { 1219 "name": "NewName", 1220 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:8f75187d-101e-4625-accc-12345EXAMPLE" 1221 }, 1222 "output": { 1223 "project": { 1224 "name": "NewName", 1225 "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:8f75187d-101e-4625-accc-12345EXAMPLE", 1226 "created": "1448400709.927" 1227 } 1228 }, 1229 "comments": { 1230 "input": { 1231 "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command." 1232 }, 1233 "output": { 1234 } 1235 }, 1236 "description": "The following example updates the specified project with a new name.", 1237 "id": "to-update-a-device-pool-1472653887677", 1238 "title": "To update a device pool" 1239 } 1240 ] 1241 } 1242} 1243