@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,38 @@ export interface CreateDevicePoolCommandOutput extends CreateDevicePoolResult, _
29
29
  * @see {@link CreateDevicePoolCommandOutput} 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 create a new device pool
46
+ * ```javascript
47
+ * // The following example creates a new device pool named MyDevicePool inside an existing project.
48
+ * const input = {
49
+ * "name": "MyDevicePool",
50
+ * "description": "My Android devices",
51
+ * "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
52
+ * "rules": []
53
+ * };
54
+ * const command = new CreateDevicePoolCommand(input);
55
+ * const response = await client.send(command);
56
+ * /* response ==
57
+ * {
58
+ * "devicePool": {}
59
+ * }
60
+ * *\/
61
+ * // example id: createdevicepool-example-1470862210860
62
+ * ```
63
+ *
32
64
  */
33
65
  export declare class CreateDevicePoolCommand extends $Command<CreateDevicePoolCommandInput, CreateDevicePoolCommandOutput, DeviceFarmClientResolvedConfig> {
34
66
  readonly input: CreateDevicePoolCommandInput;
@@ -30,6 +30,19 @@ export interface CreateInstanceProfileCommandOutput extends CreateInstanceProfil
30
30
  * @see {@link CreateInstanceProfileCommandOutput} 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 CreateInstanceProfileCommand extends $Command<CreateInstanceProfileCommandInput, CreateInstanceProfileCommandOutput, DeviceFarmClientResolvedConfig> {
35
48
  readonly input: CreateInstanceProfileCommandInput;
@@ -29,6 +29,19 @@ export interface CreateNetworkProfileCommandOutput extends CreateNetworkProfileR
29
29
  * @see {@link CreateNetworkProfileCommandOutput} 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 CreateNetworkProfileCommand extends $Command<CreateNetworkProfileCommandInput, CreateNetworkProfileCommandOutput, DeviceFarmClientResolvedConfig> {
34
47
  readonly input: CreateNetworkProfileCommandInput;
@@ -29,6 +29,42 @@ export interface CreateProjectCommandOutput extends CreateProjectResult, __Metad
29
29
  * @see {@link CreateProjectCommandOutput} 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
+ * @throws {@link TagOperationException} (client fault)
45
+ * <p>The operation was not successful. Try again.</p>
46
+ *
47
+ *
48
+ * @example To create a new project
49
+ * ```javascript
50
+ * // The following example creates a new project named MyProject.
51
+ * const input = {
52
+ * "name": "MyProject"
53
+ * };
54
+ * const command = new CreateProjectCommand(input);
55
+ * const response = await client.send(command);
56
+ * /* response ==
57
+ * {
58
+ * "project": {
59
+ * "name": "MyProject",
60
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE",
61
+ * "created": "1472660939.152"
62
+ * }
63
+ * }
64
+ * *\/
65
+ * // example id: createproject-example-1470862210860
66
+ * ```
67
+ *
32
68
  */
33
69
  export declare class CreateProjectCommand extends $Command<CreateProjectCommandInput, CreateProjectCommandOutput, DeviceFarmClientResolvedConfig> {
34
70
  readonly input: CreateProjectCommandInput;
@@ -29,6 +29,40 @@ export interface CreateRemoteAccessSessionCommandOutput extends CreateRemoteAcce
29
29
  * @see {@link CreateRemoteAccessSessionCommandOutput} 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 create a remote access session
46
+ * ```javascript
47
+ * // The following example creates a remote access session named MySession.
48
+ * const input = {
49
+ * "name": "MySession",
50
+ * "configuration": {
51
+ * "billingMethod": "METERED"
52
+ * },
53
+ * "deviceArn": "arn:aws:devicefarm:us-west-2::device:123EXAMPLE",
54
+ * "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
55
+ * };
56
+ * const command = new CreateRemoteAccessSessionCommand(input);
57
+ * const response = await client.send(command);
58
+ * /* response ==
59
+ * {
60
+ * "remoteAccessSession": {}
61
+ * }
62
+ * *\/
63
+ * // example id: to-create-a-remote-access-session-1470970668274
64
+ * ```
65
+ *
32
66
  */
33
67
  export declare class CreateRemoteAccessSessionCommand extends $Command<CreateRemoteAccessSessionCommandInput, CreateRemoteAccessSessionCommandOutput, DeviceFarmClientResolvedConfig> {
34
68
  readonly input: CreateRemoteAccessSessionCommandInput;
@@ -30,6 +30,17 @@ export interface CreateTestGridProjectCommandOutput extends CreateTestGridProjec
30
30
  * @see {@link CreateTestGridProjectCommandOutput} 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 InternalServiceException} (server fault)
37
+ * <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
38
+ * error. </p>
39
+ *
40
+ * @throws {@link LimitExceededException} (client fault)
41
+ * <p>A limit was exceeded.</p>
42
+ *
43
+ *
33
44
  */
34
45
  export declare class CreateTestGridProjectCommand extends $Command<CreateTestGridProjectCommandInput, CreateTestGridProjectCommandOutput, DeviceFarmClientResolvedConfig> {
35
46
  readonly input: CreateTestGridProjectCommandInput;
@@ -30,6 +30,17 @@ export interface CreateTestGridUrlCommandOutput extends CreateTestGridUrlResult,
30
30
  * @see {@link CreateTestGridUrlCommandOutput} 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 InternalServiceException} (server fault)
37
+ * <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
38
+ * error. </p>
39
+ *
40
+ * @throws {@link NotFoundException} (client fault)
41
+ * <p>The specified entity was not found.</p>
42
+ *
43
+ *
33
44
  */
34
45
  export declare class CreateTestGridUrlCommand extends $Command<CreateTestGridUrlCommandInput, CreateTestGridUrlCommandOutput, DeviceFarmClientResolvedConfig> {
35
46
  readonly input: CreateTestGridUrlCommandInput;
@@ -29,6 +29,44 @@ export interface CreateUploadCommandOutput extends CreateUploadResult, __Metadat
29
29
  * @see {@link CreateUploadCommandOutput} 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 create a new test package upload
46
+ * ```javascript
47
+ * // The following example creates a new Appium Python test package upload inside an existing project.
48
+ * const input = {
49
+ * "name": "MyAppiumPythonUpload",
50
+ * "type": "APPIUM_PYTHON_TEST_PACKAGE",
51
+ * "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
52
+ * };
53
+ * const command = new CreateUploadCommand(input);
54
+ * const response = await client.send(command);
55
+ * /* response ==
56
+ * {
57
+ * "upload": {
58
+ * "name": "MyAppiumPythonUpload",
59
+ * "type": "APPIUM_PYTHON_TEST_PACKAGE",
60
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE",
61
+ * "created": "1472661404.186",
62
+ * "status": "INITIALIZED",
63
+ * "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"
64
+ * }
65
+ * }
66
+ * *\/
67
+ * // example id: createupload-example-1470864711775
68
+ * ```
69
+ *
32
70
  */
33
71
  export declare class CreateUploadCommand extends $Command<CreateUploadCommandInput, CreateUploadCommandOutput, DeviceFarmClientResolvedConfig> {
34
72
  readonly input: CreateUploadCommandInput;
@@ -30,6 +30,16 @@ export interface CreateVPCEConfigurationCommandOutput extends CreateVPCEConfigur
30
30
  * @see {@link CreateVPCEConfigurationCommandOutput} 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 ServiceAccountException} (client fault)
40
+ * <p>There was a problem with the service account.</p>
41
+ *
42
+ *
33
43
  */
34
44
  export declare class CreateVPCEConfigurationCommand extends $Command<CreateVPCEConfigurationCommandInput, CreateVPCEConfigurationCommandOutput, DeviceFarmClientResolvedConfig> {
35
45
  readonly input: CreateVPCEConfigurationCommandInput;
@@ -30,6 +30,30 @@ export interface DeleteDevicePoolCommandOutput extends DeleteDevicePoolResult, _
30
30
  * @see {@link DeleteDevicePoolCommandOutput} 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
+ *
46
+ * @example To delete a device pool
47
+ * ```javascript
48
+ * // The following example deletes a specific device pool.
49
+ * const input = {
50
+ * "arn": "arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID"
51
+ * };
52
+ * const command = new DeleteDevicePoolCommand(input);
53
+ * await client.send(command);
54
+ * // example id: deletedevicepool-example-1470866975494
55
+ * ```
56
+ *
33
57
  */
34
58
  export declare class DeleteDevicePoolCommand extends $Command<DeleteDevicePoolCommandInput, DeleteDevicePoolCommandOutput, DeviceFarmClientResolvedConfig> {
35
59
  readonly input: DeleteDevicePoolCommandInput;
@@ -29,6 +29,19 @@ export interface DeleteInstanceProfileCommandOutput extends DeleteInstanceProfil
29
29
  * @see {@link DeleteInstanceProfileCommandOutput} 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 DeleteInstanceProfileCommand extends $Command<DeleteInstanceProfileCommandInput, DeleteInstanceProfileCommandOutput, DeviceFarmClientResolvedConfig> {
34
47
  readonly input: DeleteInstanceProfileCommandInput;
@@ -29,6 +29,19 @@ export interface DeleteNetworkProfileCommandOutput extends DeleteNetworkProfileR
29
29
  * @see {@link DeleteNetworkProfileCommandOutput} 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 DeleteNetworkProfileCommand extends $Command<DeleteNetworkProfileCommandInput, DeleteNetworkProfileCommandOutput, DeviceFarmClientResolvedConfig> {
34
47
  readonly input: DeleteNetworkProfileCommandInput;
@@ -30,6 +30,30 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResult, __Metad
30
30
  * @see {@link DeleteProjectCommandOutput} 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
+ *
46
+ * @example To delete a project
47
+ * ```javascript
48
+ * // The following example deletes a specific project.
49
+ * const input = {
50
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
51
+ * };
52
+ * const command = new DeleteProjectCommand(input);
53
+ * await client.send(command);
54
+ * // example id: deleteproject-example-1470867374212
55
+ * ```
56
+ *
33
57
  */
34
58
  export declare class DeleteProjectCommand extends $Command<DeleteProjectCommandInput, DeleteProjectCommandOutput, DeviceFarmClientResolvedConfig> {
35
59
  readonly input: DeleteProjectCommandInput;
@@ -29,6 +29,30 @@ export interface DeleteRemoteAccessSessionCommandOutput extends DeleteRemoteAcce
29
29
  * @see {@link DeleteRemoteAccessSessionCommandOutput} 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 delete a specific remote access session
46
+ * ```javascript
47
+ * // The following example deletes 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 DeleteRemoteAccessSessionCommand(input);
52
+ * await client.send(command);
53
+ * // example id: to-delete-a-specific-remote-access-session-1470971431677
54
+ * ```
55
+ *
32
56
  */
33
57
  export declare class DeleteRemoteAccessSessionCommand extends $Command<DeleteRemoteAccessSessionCommandInput, DeleteRemoteAccessSessionCommandOutput, DeviceFarmClientResolvedConfig> {
34
58
  readonly input: DeleteRemoteAccessSessionCommandInput;
@@ -30,6 +30,30 @@ export interface DeleteRunCommandOutput extends DeleteRunResult, __MetadataBeare
30
30
  * @see {@link DeleteRunCommandOutput} 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
+ *
46
+ * @example To delete a run
47
+ * ```javascript
48
+ * // The following example deletes a specific test run.
49
+ * const input = {
50
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456"
51
+ * };
52
+ * const command = new DeleteRunCommand(input);
53
+ * await client.send(command);
54
+ * // example id: deleterun-example-1470867905129
55
+ * ```
56
+ *
33
57
  */
34
58
  export declare class DeleteRunCommand extends $Command<DeleteRunCommandInput, DeleteRunCommandOutput, DeviceFarmClientResolvedConfig> {
35
59
  readonly input: DeleteRunCommandInput;
@@ -35,6 +35,20 @@ export interface DeleteTestGridProjectCommandOutput extends DeleteTestGridProjec
35
35
  * @see {@link DeleteTestGridProjectCommandOutput} for command's `response` shape.
36
36
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
37
37
  *
38
+ * @throws {@link ArgumentException} (client fault)
39
+ * <p>An invalid argument was specified.</p>
40
+ *
41
+ * @throws {@link CannotDeleteException} (client fault)
42
+ * <p>The requested object could not be deleted.</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
+ *
38
52
  */
39
53
  export declare class DeleteTestGridProjectCommand extends $Command<DeleteTestGridProjectCommandInput, DeleteTestGridProjectCommandOutput, DeviceFarmClientResolvedConfig> {
40
54
  readonly input: DeleteTestGridProjectCommandInput;
@@ -29,6 +29,30 @@ export interface DeleteUploadCommandOutput extends DeleteUploadResult, __Metadat
29
29
  * @see {@link DeleteUploadCommandOutput} 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 delete a specific upload
46
+ * ```javascript
47
+ * // The following example deletes 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 DeleteUploadCommand(input);
52
+ * await client.send(command);
53
+ * // example id: deleteupload-example-1470868363942
54
+ * ```
55
+ *
32
56
  */
33
57
  export declare class DeleteUploadCommand extends $Command<DeleteUploadCommandInput, DeleteUploadCommandOutput, DeviceFarmClientResolvedConfig> {
34
58
  readonly input: DeleteUploadCommandInput;
@@ -29,6 +29,20 @@ export interface DeleteVPCEConfigurationCommandOutput extends DeleteVPCEConfigur
29
29
  * @see {@link DeleteVPCEConfigurationCommandOutput} 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 InvalidOperationException} (client fault)
36
+ * <p>There was an error with the update request, or you do not have sufficient permissions
37
+ * to update this VPC endpoint configuration.</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
+ *
32
46
  */
33
47
  export declare class DeleteVPCEConfigurationCommand extends $Command<DeleteVPCEConfigurationCommandInput, DeleteVPCEConfigurationCommandOutput, DeviceFarmClientResolvedConfig> {
34
48
  readonly input: DeleteVPCEConfigurationCommandInput;
@@ -30,6 +30,39 @@ export interface GetAccountSettingsCommandOutput extends GetAccountSettingsResul
30
30
  * @see {@link GetAccountSettingsCommandOutput} 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
+ *
46
+ * @example To get information about account settings
47
+ * ```javascript
48
+ * // The following example returns information about your Device Farm account settings.
49
+ * const input = {};
50
+ * const command = new GetAccountSettingsCommand(input);
51
+ * const response = await client.send(command);
52
+ * /* response ==
53
+ * {
54
+ * "accountSettings": {
55
+ * "awsAccountNumber": "123456789101",
56
+ * "unmeteredDevices": {
57
+ * "ANDROID": 1,
58
+ * "IOS": 2
59
+ * }
60
+ * }
61
+ * }
62
+ * *\/
63
+ * // example id: to-get-information-about-account-settings-1472567568189
64
+ * ```
65
+ *
33
66
  */
34
67
  export declare class GetAccountSettingsCommand extends $Command<GetAccountSettingsCommandInput, GetAccountSettingsCommandOutput, DeviceFarmClientResolvedConfig> {
35
68
  readonly input: GetAccountSettingsCommandInput;
@@ -29,6 +29,55 @@ export interface GetDeviceCommandOutput extends GetDeviceResult, __MetadataBeare
29
29
  * @see {@link GetDeviceCommandOutput} 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
46
+ * ```javascript
47
+ * // The following example returns information about a specific device.
48
+ * const input = {
49
+ * "arn": "arn:aws:devicefarm:us-west-2::device:123EXAMPLE"
50
+ * };
51
+ * const command = new GetDeviceCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "device": {
56
+ * "name": "LG G2 (Sprint)",
57
+ * "arn": "arn:aws:devicefarm:us-west-2::device:A0E6E6E1059E45918208DF75B2B7EF6C",
58
+ * "cpu": {
59
+ * "architecture": "armeabi-v7a",
60
+ * "clock": 2265.6,
61
+ * "frequency": "MHz"
62
+ * },
63
+ * "formFactor": "PHONE",
64
+ * "heapSize": 256000000,
65
+ * "image": "75B2B7EF6C12345EXAMPLE",
66
+ * "manufacturer": "LG",
67
+ * "memory": 16000000000,
68
+ * "model": "G2 (Sprint)",
69
+ * "os": "4.2.2",
70
+ * "platform": "ANDROID",
71
+ * "resolution": {
72
+ * "height": 1920,
73
+ * "width": 1080
74
+ * }
75
+ * }
76
+ * }
77
+ * *\/
78
+ * // example id: getdevice-example-1470870602173
79
+ * ```
80
+ *
32
81
  */
33
82
  export declare class GetDeviceCommand extends $Command<GetDeviceCommandInput, GetDeviceCommandOutput, DeviceFarmClientResolvedConfig> {
34
83
  readonly input: GetDeviceCommandInput;
@@ -29,6 +29,19 @@ export interface GetDeviceInstanceCommandOutput extends GetDeviceInstanceResult,
29
29
  * @see {@link GetDeviceInstanceCommandOutput} 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 GetDeviceInstanceCommand extends $Command<GetDeviceInstanceCommandInput, GetDeviceInstanceCommandOutput, DeviceFarmClientResolvedConfig> {
34
47
  readonly input: GetDeviceInstanceCommandInput;