@aws-sdk/client-device-farm 3.288.0 → 3.290.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. package/dist-types/commands/CreateDevicePoolCommand.d.ts +32 -0
  2. package/dist-types/commands/CreateInstanceProfileCommand.d.ts +13 -0
  3. package/dist-types/commands/CreateNetworkProfileCommand.d.ts +13 -0
  4. package/dist-types/commands/CreateProjectCommand.d.ts +36 -0
  5. package/dist-types/commands/CreateRemoteAccessSessionCommand.d.ts +34 -0
  6. package/dist-types/commands/CreateTestGridProjectCommand.d.ts +11 -0
  7. package/dist-types/commands/CreateTestGridUrlCommand.d.ts +11 -0
  8. package/dist-types/commands/CreateUploadCommand.d.ts +38 -0
  9. package/dist-types/commands/CreateVPCEConfigurationCommand.d.ts +10 -0
  10. package/dist-types/commands/DeleteDevicePoolCommand.d.ts +24 -0
  11. package/dist-types/commands/DeleteInstanceProfileCommand.d.ts +13 -0
  12. package/dist-types/commands/DeleteNetworkProfileCommand.d.ts +13 -0
  13. package/dist-types/commands/DeleteProjectCommand.d.ts +24 -0
  14. package/dist-types/commands/DeleteRemoteAccessSessionCommand.d.ts +24 -0
  15. package/dist-types/commands/DeleteRunCommand.d.ts +24 -0
  16. package/dist-types/commands/DeleteTestGridProjectCommand.d.ts +14 -0
  17. package/dist-types/commands/DeleteUploadCommand.d.ts +24 -0
  18. package/dist-types/commands/DeleteVPCEConfigurationCommand.d.ts +14 -0
  19. package/dist-types/commands/GetAccountSettingsCommand.d.ts +33 -0
  20. package/dist-types/commands/GetDeviceCommand.d.ts +49 -0
  21. package/dist-types/commands/GetDeviceInstanceCommand.d.ts +13 -0
  22. package/dist-types/commands/GetDevicePoolCommand.d.ts +29 -0
  23. package/dist-types/commands/GetDevicePoolCompatibilityCommand.d.ts +32 -0
  24. package/dist-types/commands/GetInstanceProfileCommand.d.ts +13 -0
  25. package/dist-types/commands/GetJobCommand.d.ts +29 -0
  26. package/dist-types/commands/GetNetworkProfileCommand.d.ts +13 -0
  27. package/dist-types/commands/GetOfferingStatusCommand.d.ts +55 -0
  28. package/dist-types/commands/GetProjectCommand.d.ts +33 -0
  29. package/dist-types/commands/GetRemoteAccessSessionCommand.d.ts +29 -0
  30. package/dist-types/commands/GetRunCommand.d.ts +54 -0
  31. package/dist-types/commands/GetSuiteCommand.d.ts +29 -0
  32. package/dist-types/commands/GetTestCommand.d.ts +29 -0
  33. package/dist-types/commands/GetTestGridProjectCommand.d.ts +11 -0
  34. package/dist-types/commands/GetTestGridSessionCommand.d.ts +11 -0
  35. package/dist-types/commands/GetUploadCommand.d.ts +29 -0
  36. package/dist-types/commands/GetVPCEConfigurationCommand.d.ts +10 -0
  37. package/dist-types/commands/InstallToRemoteAccessSessionCommand.d.ts +30 -0
  38. package/dist-types/commands/ListArtifactsCommand.d.ts +25 -0
  39. package/dist-types/commands/ListDeviceInstancesCommand.d.ts +13 -0
  40. package/dist-types/commands/ListDevicePoolsCommand.d.ts +55 -0
  41. package/dist-types/commands/ListDevicesCommand.d.ts +24 -0
  42. package/dist-types/commands/ListInstanceProfilesCommand.d.ts +13 -0
  43. package/dist-types/commands/ListJobsCommand.d.ts +24 -0
  44. package/dist-types/commands/ListNetworkProfilesCommand.d.ts +13 -0
  45. package/dist-types/commands/ListOfferingPromotionsCommand.d.ts +17 -0
  46. package/dist-types/commands/ListOfferingTransactionsCommand.d.ts +110 -0
  47. package/dist-types/commands/ListOfferingsCommand.d.ts +94 -0
  48. package/dist-types/commands/ListProjectsCommand.d.ts +41 -0
  49. package/dist-types/commands/ListRemoteAccessSessionsCommand.d.ts +30 -0
  50. package/dist-types/commands/ListRunsCommand.d.ts +57 -0
  51. package/dist-types/commands/ListSamplesCommand.d.ts +30 -0
  52. package/dist-types/commands/ListSuitesCommand.d.ts +30 -0
  53. package/dist-types/commands/ListTagsForResourceCommand.d.ts +10 -0
  54. package/dist-types/commands/ListTestGridProjectsCommand.d.ts +8 -0
  55. package/dist-types/commands/ListTestGridSessionActionsCommand.d.ts +11 -0
  56. package/dist-types/commands/ListTestGridSessionArtifactsCommand.d.ts +11 -0
  57. package/dist-types/commands/ListTestGridSessionsCommand.d.ts +11 -0
  58. package/dist-types/commands/ListTestsCommand.d.ts +30 -0
  59. package/dist-types/commands/ListUniqueProblemsCommand.d.ts +30 -0
  60. package/dist-types/commands/ListUploadsCommand.d.ts +30 -0
  61. package/dist-types/commands/ListVPCEConfigurationsCommand.d.ts +7 -0
  62. package/dist-types/commands/PurchaseOfferingCommand.d.ts +52 -0
  63. package/dist-types/commands/RenewOfferingCommand.d.ts +52 -0
  64. package/dist-types/commands/ScheduleRunCommand.d.ts +38 -0
  65. package/dist-types/commands/StopJobCommand.d.ts +13 -0
  66. package/dist-types/commands/StopRemoteAccessSessionCommand.d.ts +13 -0
  67. package/dist-types/commands/StopRunCommand.d.ts +29 -0
  68. package/dist-types/commands/TagResourceCommand.d.ts +18 -0
  69. package/dist-types/commands/UntagResourceCommand.d.ts +10 -0
  70. package/dist-types/commands/UpdateDeviceInstanceCommand.d.ts +13 -0
  71. package/dist-types/commands/UpdateDevicePoolCommand.d.ts +38 -0
  72. package/dist-types/commands/UpdateInstanceProfileCommand.d.ts +13 -0
  73. package/dist-types/commands/UpdateNetworkProfileCommand.d.ts +13 -0
  74. package/dist-types/commands/UpdateProjectCommand.d.ts +34 -0
  75. package/dist-types/commands/UpdateTestGridProjectCommand.d.ts +14 -0
  76. package/dist-types/commands/UpdateUploadCommand.d.ts +13 -0
  77. package/dist-types/commands/UpdateVPCEConfigurationCommand.d.ts +14 -0
  78. package/package.json +29 -29
@@ -29,6 +29,35 @@ export interface GetDevicePoolCommandOutput extends GetDevicePoolResult, __Metad
29
29
  * @see {@link GetDevicePoolCommandOutput} for command's `response` shape.
30
30
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
31
31
  *
32
+ * @throws {@link ArgumentException} (client fault)
33
+ * <p>An invalid argument was specified.</p>
34
+ *
35
+ * @throws {@link LimitExceededException} (client fault)
36
+ * <p>A limit was exceeded.</p>
37
+ *
38
+ * @throws {@link NotFoundException} (client fault)
39
+ * <p>The specified entity was not found.</p>
40
+ *
41
+ * @throws {@link ServiceAccountException} (client fault)
42
+ * <p>There was a problem with the service account.</p>
43
+ *
44
+ *
45
+ * @example To get information about a device pool
46
+ * ```javascript
47
+ * // The following example returns information about a specific device pool, given a project ARN.
48
+ * const input = {
49
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
50
+ * };
51
+ * const command = new GetDevicePoolCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "devicePool": {}
56
+ * }
57
+ * *\/
58
+ * // example id: getdevicepool-example-1470870873136
59
+ * ```
60
+ *
32
61
  */
33
62
  export declare class GetDevicePoolCommand extends $Command<GetDevicePoolCommandInput, GetDevicePoolCommandOutput, DeviceFarmClientResolvedConfig> {
34
63
  readonly input: GetDevicePoolCommandInput;
@@ -29,6 +29,38 @@ export interface GetDevicePoolCompatibilityCommandOutput extends GetDevicePoolCo
29
29
  * @see {@link GetDevicePoolCompatibilityCommandOutput} for command's `response` shape.
30
30
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
31
31
  *
32
+ * @throws {@link ArgumentException} (client fault)
33
+ * <p>An invalid argument was specified.</p>
34
+ *
35
+ * @throws {@link LimitExceededException} (client fault)
36
+ * <p>A limit was exceeded.</p>
37
+ *
38
+ * @throws {@link NotFoundException} (client fault)
39
+ * <p>The specified entity was not found.</p>
40
+ *
41
+ * @throws {@link ServiceAccountException} (client fault)
42
+ * <p>There was a problem with the service account.</p>
43
+ *
44
+ *
45
+ * @example To get information about the compatibility of a device pool
46
+ * ```javascript
47
+ * // The following example returns information about the compatibility of a specific device pool, given its ARN.
48
+ * const input = {
49
+ * "appArn": "arn:aws:devicefarm:us-west-2::app:123-456-EXAMPLE-GUID",
50
+ * "devicePoolArn": "arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID",
51
+ * "testType": "APPIUM_PYTHON"
52
+ * };
53
+ * const command = new GetDevicePoolCompatibilityCommand(input);
54
+ * const response = await client.send(command);
55
+ * /* response ==
56
+ * {
57
+ * "compatibleDevices": [],
58
+ * "incompatibleDevices": []
59
+ * }
60
+ * *\/
61
+ * // example id: getdevicepoolcompatibility-example-1470925003466
62
+ * ```
63
+ *
32
64
  */
33
65
  export declare class GetDevicePoolCompatibilityCommand extends $Command<GetDevicePoolCompatibilityCommandInput, GetDevicePoolCompatibilityCommandOutput, DeviceFarmClientResolvedConfig> {
34
66
  readonly input: GetDevicePoolCompatibilityCommandInput;
@@ -29,6 +29,19 @@ export interface GetInstanceProfileCommandOutput extends GetInstanceProfileResul
29
29
  * @see {@link GetInstanceProfileCommandOutput} for command's `response` shape.
30
30
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
31
31
  *
32
+ * @throws {@link ArgumentException} (client fault)
33
+ * <p>An invalid argument was specified.</p>
34
+ *
35
+ * @throws {@link LimitExceededException} (client fault)
36
+ * <p>A limit was exceeded.</p>
37
+ *
38
+ * @throws {@link NotFoundException} (client fault)
39
+ * <p>The specified entity was not found.</p>
40
+ *
41
+ * @throws {@link ServiceAccountException} (client fault)
42
+ * <p>There was a problem with the service account.</p>
43
+ *
44
+ *
32
45
  */
33
46
  export declare class GetInstanceProfileCommand extends $Command<GetInstanceProfileCommandInput, GetInstanceProfileCommandOutput, DeviceFarmClientResolvedConfig> {
34
47
  readonly input: GetInstanceProfileCommandInput;
@@ -29,6 +29,35 @@ export interface GetJobCommandOutput extends GetJobResult, __MetadataBearer {
29
29
  * @see {@link GetJobCommandOutput} for command's `response` shape.
30
30
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
31
31
  *
32
+ * @throws {@link ArgumentException} (client fault)
33
+ * <p>An invalid argument was specified.</p>
34
+ *
35
+ * @throws {@link LimitExceededException} (client fault)
36
+ * <p>A limit was exceeded.</p>
37
+ *
38
+ * @throws {@link NotFoundException} (client fault)
39
+ * <p>The specified entity was not found.</p>
40
+ *
41
+ * @throws {@link ServiceAccountException} (client fault)
42
+ * <p>There was a problem with the service account.</p>
43
+ *
44
+ *
45
+ * @example To get information about a job
46
+ * ```javascript
47
+ * // The following example returns information about a specific job.
48
+ * const input = {
49
+ * "arn": "arn:aws:devicefarm:us-west-2::job:123-456-EXAMPLE-GUID"
50
+ * };
51
+ * const command = new GetJobCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "job": {}
56
+ * }
57
+ * *\/
58
+ * // example id: getjob-example-1470928294268
59
+ * ```
60
+ *
32
61
  */
33
62
  export declare class GetJobCommand extends $Command<GetJobCommandInput, GetJobCommandOutput, DeviceFarmClientResolvedConfig> {
34
63
  readonly input: GetJobCommandInput;
@@ -29,6 +29,19 @@ export interface GetNetworkProfileCommandOutput extends GetNetworkProfileResult,
29
29
  * @see {@link GetNetworkProfileCommandOutput} for command's `response` shape.
30
30
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
31
31
  *
32
+ * @throws {@link ArgumentException} (client fault)
33
+ * <p>An invalid argument was specified.</p>
34
+ *
35
+ * @throws {@link LimitExceededException} (client fault)
36
+ * <p>A limit was exceeded.</p>
37
+ *
38
+ * @throws {@link NotFoundException} (client fault)
39
+ * <p>The specified entity was not found.</p>
40
+ *
41
+ * @throws {@link ServiceAccountException} (client fault)
42
+ * <p>There was a problem with the service account.</p>
43
+ *
44
+ *
32
45
  */
33
46
  export declare class GetNetworkProfileCommand extends $Command<GetNetworkProfileCommandInput, GetNetworkProfileCommandOutput, DeviceFarmClientResolvedConfig> {
34
47
  readonly input: GetNetworkProfileCommandInput;
@@ -32,6 +32,61 @@ export interface GetOfferingStatusCommandOutput extends GetOfferingStatusResult,
32
32
  * @see {@link GetOfferingStatusCommandOutput} for command's `response` shape.
33
33
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
34
34
  *
35
+ * @throws {@link ArgumentException} (client fault)
36
+ * <p>An invalid argument was specified.</p>
37
+ *
38
+ * @throws {@link LimitExceededException} (client fault)
39
+ * <p>A limit was exceeded.</p>
40
+ *
41
+ * @throws {@link NotEligibleException} (client fault)
42
+ * <p>Exception gets thrown when a user is not eligible to perform the specified
43
+ * transaction.</p>
44
+ *
45
+ * @throws {@link NotFoundException} (client fault)
46
+ * <p>The specified entity was not found.</p>
47
+ *
48
+ * @throws {@link ServiceAccountException} (client fault)
49
+ * <p>There was a problem with the service account.</p>
50
+ *
51
+ *
52
+ * @example To get status information about device offerings
53
+ * ```javascript
54
+ * // The following example returns information about Device Farm offerings available to your account.
55
+ * const input = {
56
+ * "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE="
57
+ * };
58
+ * const command = new GetOfferingStatusCommand(input);
59
+ * const response = await client.send(command);
60
+ * /* response ==
61
+ * {
62
+ * "current": {
63
+ * "D68B3C05-1BA6-4360-BC69-12345EXAMPLE": {
64
+ * "offering": {
65
+ * "type": "RECURRING",
66
+ * "description": "Android Remote Access Unmetered Device Slot",
67
+ * "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
68
+ * "platform": "ANDROID"
69
+ * },
70
+ * "quantity": 1
71
+ * }
72
+ * },
73
+ * "nextPeriod": {
74
+ * "D68B3C05-1BA6-4360-BC69-12345EXAMPLE": {
75
+ * "effectiveOn": "1472688000",
76
+ * "offering": {
77
+ * "type": "RECURRING",
78
+ * "description": "Android Remote Access Unmetered Device Slot",
79
+ * "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
80
+ * "platform": "ANDROID"
81
+ * },
82
+ * "quantity": 1
83
+ * }
84
+ * }
85
+ * }
86
+ * *\/
87
+ * // example id: to-get-status-information-about-device-offerings-1472568124402
88
+ * ```
89
+ *
35
90
  */
36
91
  export declare class GetOfferingStatusCommand extends $Command<GetOfferingStatusCommandInput, GetOfferingStatusCommandOutput, DeviceFarmClientResolvedConfig> {
37
92
  readonly input: GetOfferingStatusCommandInput;
@@ -29,6 +29,39 @@ export interface GetProjectCommandOutput extends GetProjectResult, __MetadataBea
29
29
  * @see {@link GetProjectCommandOutput} for command's `response` shape.
30
30
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
31
31
  *
32
+ * @throws {@link ArgumentException} (client fault)
33
+ * <p>An invalid argument was specified.</p>
34
+ *
35
+ * @throws {@link LimitExceededException} (client fault)
36
+ * <p>A limit was exceeded.</p>
37
+ *
38
+ * @throws {@link NotFoundException} (client fault)
39
+ * <p>The specified entity was not found.</p>
40
+ *
41
+ * @throws {@link ServiceAccountException} (client fault)
42
+ * <p>There was a problem with the service account.</p>
43
+ *
44
+ *
45
+ * @example To get information about a project
46
+ * ```javascript
47
+ * // The following example gets information about a specific project.
48
+ * const input = {
49
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE"
50
+ * };
51
+ * const command = new GetProjectCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "project": {
56
+ * "name": "My Project",
57
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE",
58
+ * "created": "1472660939.152"
59
+ * }
60
+ * }
61
+ * *\/
62
+ * // example id: to-get-a-project-1470975038449
63
+ * ```
64
+ *
32
65
  */
33
66
  export declare class GetProjectCommand extends $Command<GetProjectCommandInput, GetProjectCommandOutput, DeviceFarmClientResolvedConfig> {
34
67
  readonly input: GetProjectCommandInput;
@@ -29,6 +29,35 @@ export interface GetRemoteAccessSessionCommandOutput extends GetRemoteAccessSess
29
29
  * @see {@link GetRemoteAccessSessionCommandOutput} for command's `response` shape.
30
30
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
31
31
  *
32
+ * @throws {@link ArgumentException} (client fault)
33
+ * <p>An invalid argument was specified.</p>
34
+ *
35
+ * @throws {@link LimitExceededException} (client fault)
36
+ * <p>A limit was exceeded.</p>
37
+ *
38
+ * @throws {@link NotFoundException} (client fault)
39
+ * <p>The specified entity was not found.</p>
40
+ *
41
+ * @throws {@link ServiceAccountException} (client fault)
42
+ * <p>There was a problem with the service account.</p>
43
+ *
44
+ *
45
+ * @example To get a remote access session
46
+ * ```javascript
47
+ * // The following example gets a specific remote access session.
48
+ * const input = {
49
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456"
50
+ * };
51
+ * const command = new GetRemoteAccessSessionCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "remoteAccessSession": {}
56
+ * }
57
+ * *\/
58
+ * // example id: to-get-a-remote-access-session-1471014119414
59
+ * ```
60
+ *
32
61
  */
33
62
  export declare class GetRemoteAccessSessionCommand extends $Command<GetRemoteAccessSessionCommandInput, GetRemoteAccessSessionCommandOutput, DeviceFarmClientResolvedConfig> {
34
63
  readonly input: GetRemoteAccessSessionCommandInput;
@@ -29,6 +29,60 @@ export interface GetRunCommandOutput extends GetRunResult, __MetadataBearer {
29
29
  * @see {@link GetRunCommandOutput} for command's `response` shape.
30
30
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
31
31
  *
32
+ * @throws {@link ArgumentException} (client fault)
33
+ * <p>An invalid argument was specified.</p>
34
+ *
35
+ * @throws {@link LimitExceededException} (client fault)
36
+ * <p>A limit was exceeded.</p>
37
+ *
38
+ * @throws {@link NotFoundException} (client fault)
39
+ * <p>The specified entity was not found.</p>
40
+ *
41
+ * @throws {@link ServiceAccountException} (client fault)
42
+ * <p>There was a problem with the service account.</p>
43
+ *
44
+ *
45
+ * @example To get information about a test run
46
+ * ```javascript
47
+ * // The following example gets information about a specific test run.
48
+ * const input = {
49
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE"
50
+ * };
51
+ * const command = new GetRunCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "run": {
56
+ * "name": "My Test Run",
57
+ * "type": "BUILTIN_EXPLORER",
58
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE",
59
+ * "billingMethod": "METERED",
60
+ * "completedJobs": 0,
61
+ * "counters": {
62
+ * "errored": 0,
63
+ * "failed": 0,
64
+ * "passed": 0,
65
+ * "skipped": 0,
66
+ * "stopped": 0,
67
+ * "total": 0,
68
+ * "warned": 0
69
+ * },
70
+ * "created": "1472667509.852",
71
+ * "deviceMinutes": {
72
+ * "metered": 0,
73
+ * "total": 0,
74
+ * "unmetered": 0
75
+ * },
76
+ * "platform": "ANDROID",
77
+ * "result": "PENDING",
78
+ * "status": "RUNNING",
79
+ * "totalJobs": 3
80
+ * }
81
+ * }
82
+ * *\/
83
+ * // example id: to-get-a-test-run-1471015895657
84
+ * ```
85
+ *
32
86
  */
33
87
  export declare class GetRunCommand extends $Command<GetRunCommandInput, GetRunCommandOutput, DeviceFarmClientResolvedConfig> {
34
88
  readonly input: GetRunCommandInput;
@@ -29,6 +29,35 @@ export interface GetSuiteCommandOutput extends GetSuiteResult, __MetadataBearer
29
29
  * @see {@link GetSuiteCommandOutput} for command's `response` shape.
30
30
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
31
31
  *
32
+ * @throws {@link ArgumentException} (client fault)
33
+ * <p>An invalid argument was specified.</p>
34
+ *
35
+ * @throws {@link LimitExceededException} (client fault)
36
+ * <p>A limit was exceeded.</p>
37
+ *
38
+ * @throws {@link NotFoundException} (client fault)
39
+ * <p>The specified entity was not found.</p>
40
+ *
41
+ * @throws {@link ServiceAccountException} (client fault)
42
+ * <p>There was a problem with the service account.</p>
43
+ *
44
+ *
45
+ * @example To get information about a test suite
46
+ * ```javascript
47
+ * // The following example gets information about a specific test suite.
48
+ * const input = {
49
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:suite:EXAMPLE-GUID-123-456"
50
+ * };
51
+ * const command = new GetSuiteCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "suite": {}
56
+ * }
57
+ * *\/
58
+ * // example id: to-get-information-about-a-test-suite-1471016525008
59
+ * ```
60
+ *
32
61
  */
33
62
  export declare class GetSuiteCommand extends $Command<GetSuiteCommandInput, GetSuiteCommandOutput, DeviceFarmClientResolvedConfig> {
34
63
  readonly input: GetSuiteCommandInput;
@@ -29,6 +29,35 @@ export interface GetTestCommandOutput extends GetTestResult, __MetadataBearer {
29
29
  * @see {@link GetTestCommandOutput} for command's `response` shape.
30
30
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
31
31
  *
32
+ * @throws {@link ArgumentException} (client fault)
33
+ * <p>An invalid argument was specified.</p>
34
+ *
35
+ * @throws {@link LimitExceededException} (client fault)
36
+ * <p>A limit was exceeded.</p>
37
+ *
38
+ * @throws {@link NotFoundException} (client fault)
39
+ * <p>The specified entity was not found.</p>
40
+ *
41
+ * @throws {@link ServiceAccountException} (client fault)
42
+ * <p>There was a problem with the service account.</p>
43
+ *
44
+ *
45
+ * @example To get information about a specific test
46
+ * ```javascript
47
+ * // The following example gets information about a specific test.
48
+ * const input = {
49
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456"
50
+ * };
51
+ * const command = new GetTestCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "test": {}
56
+ * }
57
+ * *\/
58
+ * // example id: to-get-information-about-a-specific-test-1471025744238
59
+ * ```
60
+ *
32
61
  */
33
62
  export declare class GetTestCommand extends $Command<GetTestCommandInput, GetTestCommandOutput, DeviceFarmClientResolvedConfig> {
34
63
  readonly input: GetTestCommandInput;
@@ -29,6 +29,17 @@ export interface GetTestGridProjectCommandOutput extends GetTestGridProjectResul
29
29
  * @see {@link GetTestGridProjectCommandOutput} for command's `response` shape.
30
30
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
31
31
  *
32
+ * @throws {@link ArgumentException} (client fault)
33
+ * <p>An invalid argument was specified.</p>
34
+ *
35
+ * @throws {@link InternalServiceException} (server fault)
36
+ * <p>An internal exception was raised in the service. Contact <a href="mailto:aws-devicefarm-support@amazon.com">aws-devicefarm-support@amazon.com</a> if you see this
37
+ * error. </p>
38
+ *
39
+ * @throws {@link NotFoundException} (client fault)
40
+ * <p>The specified entity was not found.</p>
41
+ *
42
+ *
32
43
  */
33
44
  export declare class GetTestGridProjectCommand extends $Command<GetTestGridProjectCommandInput, GetTestGridProjectCommandOutput, DeviceFarmClientResolvedConfig> {
34
45
  readonly input: GetTestGridProjectCommandInput;
@@ -38,6 +38,17 @@ export interface GetTestGridSessionCommandOutput extends GetTestGridSessionResul
38
38
  * @see {@link GetTestGridSessionCommandOutput} for command's `response` shape.
39
39
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
40
40
  *
41
+ * @throws {@link ArgumentException} (client fault)
42
+ * <p>An invalid argument was specified.</p>
43
+ *
44
+ * @throws {@link InternalServiceException} (server fault)
45
+ * <p>An internal exception was raised in the service. Contact <a href="mailto:aws-devicefarm-support@amazon.com">aws-devicefarm-support@amazon.com</a> if you see this
46
+ * error. </p>
47
+ *
48
+ * @throws {@link NotFoundException} (client fault)
49
+ * <p>The specified entity was not found.</p>
50
+ *
51
+ *
41
52
  */
42
53
  export declare class GetTestGridSessionCommand extends $Command<GetTestGridSessionCommandInput, GetTestGridSessionCommandOutput, DeviceFarmClientResolvedConfig> {
43
54
  readonly input: GetTestGridSessionCommandInput;
@@ -29,6 +29,35 @@ export interface GetUploadCommandOutput extends GetUploadResult, __MetadataBeare
29
29
  * @see {@link GetUploadCommandOutput} for command's `response` shape.
30
30
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
31
31
  *
32
+ * @throws {@link ArgumentException} (client fault)
33
+ * <p>An invalid argument was specified.</p>
34
+ *
35
+ * @throws {@link LimitExceededException} (client fault)
36
+ * <p>A limit was exceeded.</p>
37
+ *
38
+ * @throws {@link NotFoundException} (client fault)
39
+ * <p>The specified entity was not found.</p>
40
+ *
41
+ * @throws {@link ServiceAccountException} (client fault)
42
+ * <p>There was a problem with the service account.</p>
43
+ *
44
+ *
45
+ * @example To get information about a specific upload
46
+ * ```javascript
47
+ * // The following example gets information about a specific upload.
48
+ * const input = {
49
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456"
50
+ * };
51
+ * const command = new GetUploadCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "upload": {}
56
+ * }
57
+ * *\/
58
+ * // example id: to-get-information-about-a-specific-upload-1471025996221
59
+ * ```
60
+ *
32
61
  */
33
62
  export declare class GetUploadCommand extends $Command<GetUploadCommandInput, GetUploadCommandOutput, DeviceFarmClientResolvedConfig> {
34
63
  readonly input: GetUploadCommandInput;
@@ -30,6 +30,16 @@ export interface GetVPCEConfigurationCommandOutput extends GetVPCEConfigurationR
30
30
  * @see {@link GetVPCEConfigurationCommandOutput} for command's `response` shape.
31
31
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
32
32
  *
33
+ * @throws {@link ArgumentException} (client fault)
34
+ * <p>An invalid argument was specified.</p>
35
+ *
36
+ * @throws {@link NotFoundException} (client fault)
37
+ * <p>The specified entity was not found.</p>
38
+ *
39
+ * @throws {@link ServiceAccountException} (client fault)
40
+ * <p>There was a problem with the service account.</p>
41
+ *
42
+ *
33
43
  */
34
44
  export declare class GetVPCEConfigurationCommand extends $Command<GetVPCEConfigurationCommandInput, GetVPCEConfigurationCommandOutput, DeviceFarmClientResolvedConfig> {
35
45
  readonly input: GetVPCEConfigurationCommandInput;
@@ -31,6 +31,36 @@ export interface InstallToRemoteAccessSessionCommandOutput extends InstallToRemo
31
31
  * @see {@link InstallToRemoteAccessSessionCommandOutput} for command's `response` shape.
32
32
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
33
33
  *
34
+ * @throws {@link ArgumentException} (client fault)
35
+ * <p>An invalid argument was specified.</p>
36
+ *
37
+ * @throws {@link LimitExceededException} (client fault)
38
+ * <p>A limit was exceeded.</p>
39
+ *
40
+ * @throws {@link NotFoundException} (client fault)
41
+ * <p>The specified entity was not found.</p>
42
+ *
43
+ * @throws {@link ServiceAccountException} (client fault)
44
+ * <p>There was a problem with the service account.</p>
45
+ *
46
+ *
47
+ * @example To install to a remote access session
48
+ * ```javascript
49
+ * // The following example installs a specific app to a device in a specific remote access session.
50
+ * const input = {
51
+ * "appArn": "arn:aws:devicefarm:us-west-2:123456789101:app:EXAMPLE-GUID-123-456",
52
+ * "remoteAccessSessionArn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456"
53
+ * };
54
+ * const command = new InstallToRemoteAccessSessionCommand(input);
55
+ * const response = await client.send(command);
56
+ * /* response ==
57
+ * {
58
+ * "appUpload": {}
59
+ * }
60
+ * *\/
61
+ * // example id: to-install-to-a-remote-access-session-1471634453818
62
+ * ```
63
+ *
34
64
  */
35
65
  export declare class InstallToRemoteAccessSessionCommand extends $Command<InstallToRemoteAccessSessionCommandInput, InstallToRemoteAccessSessionCommandOutput, DeviceFarmClientResolvedConfig> {
36
66
  readonly input: InstallToRemoteAccessSessionCommandInput;
@@ -29,6 +29,31 @@ export interface ListArtifactsCommandOutput extends ListArtifactsResult, __Metad
29
29
  * @see {@link ListArtifactsCommandOutput} for command's `response` shape.
30
30
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
31
31
  *
32
+ * @throws {@link ArgumentException} (client fault)
33
+ * <p>An invalid argument was specified.</p>
34
+ *
35
+ * @throws {@link LimitExceededException} (client fault)
36
+ * <p>A limit was exceeded.</p>
37
+ *
38
+ * @throws {@link NotFoundException} (client fault)
39
+ * <p>The specified entity was not found.</p>
40
+ *
41
+ * @throws {@link ServiceAccountException} (client fault)
42
+ * <p>There was a problem with the service account.</p>
43
+ *
44
+ *
45
+ * @example To list artifacts for a resource
46
+ * ```javascript
47
+ * // The following example lists screenshot artifacts for a specific run.
48
+ * const input = {
49
+ * "type": "SCREENSHOT",
50
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456"
51
+ * };
52
+ * const command = new ListArtifactsCommand(input);
53
+ * await client.send(command);
54
+ * // example id: to-list-artifacts-for-a-resource-1471635409527
55
+ * ```
56
+ *
32
57
  */
33
58
  export declare class ListArtifactsCommand extends $Command<ListArtifactsCommandInput, ListArtifactsCommandOutput, DeviceFarmClientResolvedConfig> {
34
59
  readonly input: ListArtifactsCommandInput;
@@ -30,6 +30,19 @@ export interface ListDeviceInstancesCommandOutput extends ListDeviceInstancesRes
30
30
  * @see {@link ListDeviceInstancesCommandOutput} for command's `response` shape.
31
31
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
32
32
  *
33
+ * @throws {@link ArgumentException} (client fault)
34
+ * <p>An invalid argument was specified.</p>
35
+ *
36
+ * @throws {@link LimitExceededException} (client fault)
37
+ * <p>A limit was exceeded.</p>
38
+ *
39
+ * @throws {@link NotFoundException} (client fault)
40
+ * <p>The specified entity was not found.</p>
41
+ *
42
+ * @throws {@link ServiceAccountException} (client fault)
43
+ * <p>There was a problem with the service account.</p>
44
+ *
45
+ *
33
46
  */
34
47
  export declare class ListDeviceInstancesCommand extends $Command<ListDeviceInstancesCommandInput, ListDeviceInstancesCommandOutput, DeviceFarmClientResolvedConfig> {
35
48
  readonly input: ListDeviceInstancesCommandInput;