@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,61 @@ export interface ListDevicePoolsCommandOutput extends ListDevicePoolsResult, __M
29
29
  * @see {@link ListDevicePoolsCommandOutput} 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 device pools
46
+ * ```javascript
47
+ * // The following example returns information about the private device pools in a specific project.
48
+ * const input = {
49
+ * "type": "PRIVATE",
50
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
51
+ * };
52
+ * const command = new ListDevicePoolsCommand(input);
53
+ * const response = await client.send(command);
54
+ * /* response ==
55
+ * {
56
+ * "devicePools": [
57
+ * {
58
+ * "name": "Top Devices",
59
+ * "arn": "arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE",
60
+ * "description": "Top devices",
61
+ * "rules": [
62
+ * {
63
+ * "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\"]",
64
+ * "attribute": "ARN",
65
+ * "operator": "IN"
66
+ * }
67
+ * ]
68
+ * },
69
+ * {
70
+ * "name": "My Android Device Pool",
71
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:devicepool:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/bf96e75a-28f6-4e61-b6a7-12345EXAMPLE",
72
+ * "description": "Samsung Galaxy Android devices",
73
+ * "rules": [
74
+ * {
75
+ * "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\"]",
76
+ * "attribute": "ARN",
77
+ * "operator": "IN"
78
+ * }
79
+ * ]
80
+ * }
81
+ * ]
82
+ * }
83
+ * *\/
84
+ * // example id: to-get-information-about-device-pools-1471635745170
85
+ * ```
86
+ *
32
87
  */
33
88
  export declare class ListDevicePoolsCommand extends $Command<ListDevicePoolsCommandInput, ListDevicePoolsCommandOutput, DeviceFarmClientResolvedConfig> {
34
89
  readonly input: ListDevicePoolsCommandInput;
@@ -29,6 +29,30 @@ export interface ListDevicesCommandOutput extends ListDevicesResult, __MetadataB
29
29
  * @see {@link ListDevicesCommandOutput} 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 devices
46
+ * ```javascript
47
+ * // The following example returns information about the available devices in a specific project.
48
+ * const input = {
49
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
50
+ * };
51
+ * const command = new ListDevicesCommand(input);
52
+ * await client.send(command);
53
+ * // example id: to-get-information-about-devices-1471641699344
54
+ * ```
55
+ *
32
56
  */
33
57
  export declare class ListDevicesCommand extends $Command<ListDevicesCommandInput, ListDevicesCommandOutput, DeviceFarmClientResolvedConfig> {
34
58
  readonly input: ListDevicesCommandInput;
@@ -29,6 +29,19 @@ export interface ListInstanceProfilesCommandOutput extends ListInstanceProfilesR
29
29
  * @see {@link ListInstanceProfilesCommandOutput} 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 ListInstanceProfilesCommand extends $Command<ListInstanceProfilesCommandInput, ListInstanceProfilesCommandOutput, DeviceFarmClientResolvedConfig> {
34
47
  readonly input: ListInstanceProfilesCommandInput;
@@ -29,6 +29,30 @@ export interface ListJobsCommandOutput extends ListJobsResult, __MetadataBearer
29
29
  * @see {@link ListJobsCommandOutput} 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 jobs
46
+ * ```javascript
47
+ * // The following example returns information about jobs in a specific project.
48
+ * const input = {
49
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
50
+ * };
51
+ * const command = new ListJobsCommand(input);
52
+ * await client.send(command);
53
+ * // example id: to-get-information-about-jobs-1471642228071
54
+ * ```
55
+ *
32
56
  */
33
57
  export declare class ListJobsCommand extends $Command<ListJobsCommandInput, ListJobsCommandOutput, DeviceFarmClientResolvedConfig> {
34
58
  readonly input: ListJobsCommandInput;
@@ -29,6 +29,19 @@ export interface ListNetworkProfilesCommandOutput extends ListNetworkProfilesRes
29
29
  * @see {@link ListNetworkProfilesCommandOutput} 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 ListNetworkProfilesCommand extends $Command<ListNetworkProfilesCommandInput, ListNetworkProfilesCommandOutput, DeviceFarmClientResolvedConfig> {
34
47
  readonly input: ListNetworkProfilesCommandInput;
@@ -31,6 +31,23 @@ export interface ListOfferingPromotionsCommandOutput extends ListOfferingPromoti
31
31
  * @see {@link ListOfferingPromotionsCommandOutput} 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 NotEligibleException} (client fault)
41
+ * <p>Exception gets thrown when a user is not eligible to perform the specified
42
+ * transaction.</p>
43
+ *
44
+ * @throws {@link NotFoundException} (client fault)
45
+ * <p>The specified entity was not found.</p>
46
+ *
47
+ * @throws {@link ServiceAccountException} (client fault)
48
+ * <p>There was a problem with the service account.</p>
49
+ *
50
+ *
34
51
  */
35
52
  export declare class ListOfferingPromotionsCommand extends $Command<ListOfferingPromotionsCommandInput, ListOfferingPromotionsCommandOutput, DeviceFarmClientResolvedConfig> {
36
53
  readonly input: ListOfferingPromotionsCommandInput;
@@ -32,6 +32,116 @@ export interface ListOfferingTransactionsCommandOutput extends ListOfferingTrans
32
32
  * @see {@link ListOfferingTransactionsCommandOutput} 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 information about device offering transactions
53
+ * ```javascript
54
+ * // The following example returns information about Device Farm offering transactions.
55
+ * const input = {
56
+ * "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE="
57
+ * };
58
+ * const command = new ListOfferingTransactionsCommand(input);
59
+ * const response = await client.send(command);
60
+ * /* response ==
61
+ * {
62
+ * "offeringTransactions": [
63
+ * {
64
+ * "cost": {
65
+ * "amount": 0,
66
+ * "currencyCode": "USD"
67
+ * },
68
+ * "createdOn": "1470021420",
69
+ * "offeringStatus": {
70
+ * "type": "RENEW",
71
+ * "effectiveOn": "1472688000",
72
+ * "offering": {
73
+ * "type": "RECURRING",
74
+ * "description": "Android Remote Access Unmetered Device Slot",
75
+ * "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
76
+ * "platform": "ANDROID"
77
+ * },
78
+ * "quantity": 0
79
+ * },
80
+ * "transactionId": "03728003-d1ea-4851-abd6-12345EXAMPLE"
81
+ * },
82
+ * {
83
+ * "cost": {
84
+ * "amount": 250,
85
+ * "currencyCode": "USD"
86
+ * },
87
+ * "createdOn": "1470021420",
88
+ * "offeringStatus": {
89
+ * "type": "PURCHASE",
90
+ * "effectiveOn": "1470021420",
91
+ * "offering": {
92
+ * "type": "RECURRING",
93
+ * "description": "Android Remote Access Unmetered Device Slot",
94
+ * "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
95
+ * "platform": "ANDROID"
96
+ * },
97
+ * "quantity": 1
98
+ * },
99
+ * "transactionId": "56820b6e-06bd-473a-8ff8-12345EXAMPLE"
100
+ * },
101
+ * {
102
+ * "cost": {
103
+ * "amount": 175,
104
+ * "currencyCode": "USD"
105
+ * },
106
+ * "createdOn": "1465538520",
107
+ * "offeringStatus": {
108
+ * "type": "PURCHASE",
109
+ * "effectiveOn": "1465538520",
110
+ * "offering": {
111
+ * "type": "RECURRING",
112
+ * "description": "Android Unmetered Device Slot",
113
+ * "id": "8980F81C-00D7-469D-8EC6-12345EXAMPLE",
114
+ * "platform": "ANDROID"
115
+ * },
116
+ * "quantity": 1
117
+ * },
118
+ * "transactionId": "953ae2c6-d760-4a04-9597-12345EXAMPLE"
119
+ * },
120
+ * {
121
+ * "cost": {
122
+ * "amount": 8.07,
123
+ * "currencyCode": "USD"
124
+ * },
125
+ * "createdOn": "1459344300",
126
+ * "offeringStatus": {
127
+ * "type": "PURCHASE",
128
+ * "effectiveOn": "1459344300",
129
+ * "offering": {
130
+ * "type": "RECURRING",
131
+ * "description": "iOS Unmetered Device Slot",
132
+ * "id": "A53D4D73-A6F6-4B82-A0B0-12345EXAMPLE",
133
+ * "platform": "IOS"
134
+ * },
135
+ * "quantity": 1
136
+ * },
137
+ * "transactionId": "2baf9021-ae3e-47f5-ab52-12345EXAMPLE"
138
+ * }
139
+ * ]
140
+ * }
141
+ * *\/
142
+ * // example id: to-get-information-about-device-offering-transactions-1472561712315
143
+ * ```
144
+ *
35
145
  */
36
146
  export declare class ListOfferingTransactionsCommand extends $Command<ListOfferingTransactionsCommandInput, ListOfferingTransactionsCommandOutput, DeviceFarmClientResolvedConfig> {
37
147
  readonly input: ListOfferingTransactionsCommandInput;
@@ -32,6 +32,100 @@ export interface ListOfferingsCommandOutput extends ListOfferingsResult, __Metad
32
32
  * @see {@link ListOfferingsCommandOutput} 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 information about device offerings
53
+ * ```javascript
54
+ * // The following example returns information about available device offerings.
55
+ * const input = {
56
+ * "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE="
57
+ * };
58
+ * const command = new ListOfferingsCommand(input);
59
+ * const response = await client.send(command);
60
+ * /* response ==
61
+ * {
62
+ * "offerings": [
63
+ * {
64
+ * "type": "RECURRING",
65
+ * "description": "iOS Unmetered Device Slot",
66
+ * "id": "A53D4D73-A6F6-4B82-A0B0-12345EXAMPLE",
67
+ * "platform": "IOS",
68
+ * "recurringCharges": [
69
+ * {
70
+ * "cost": {
71
+ * "amount": 250,
72
+ * "currencyCode": "USD"
73
+ * },
74
+ * "frequency": "MONTHLY"
75
+ * }
76
+ * ]
77
+ * },
78
+ * {
79
+ * "type": "RECURRING",
80
+ * "description": "Android Unmetered Device Slot",
81
+ * "id": "8980F81C-00D7-469D-8EC6-12345EXAMPLE",
82
+ * "platform": "ANDROID",
83
+ * "recurringCharges": [
84
+ * {
85
+ * "cost": {
86
+ * "amount": 250,
87
+ * "currencyCode": "USD"
88
+ * },
89
+ * "frequency": "MONTHLY"
90
+ * }
91
+ * ]
92
+ * },
93
+ * {
94
+ * "type": "RECURRING",
95
+ * "description": "Android Remote Access Unmetered Device Slot",
96
+ * "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
97
+ * "platform": "ANDROID",
98
+ * "recurringCharges": [
99
+ * {
100
+ * "cost": {
101
+ * "amount": 250,
102
+ * "currencyCode": "USD"
103
+ * },
104
+ * "frequency": "MONTHLY"
105
+ * }
106
+ * ]
107
+ * },
108
+ * {
109
+ * "type": "RECURRING",
110
+ * "description": "iOS Remote Access Unmetered Device Slot",
111
+ * "id": "552B4DAD-A6C9-45C4-94FB-12345EXAMPLE",
112
+ * "platform": "IOS",
113
+ * "recurringCharges": [
114
+ * {
115
+ * "cost": {
116
+ * "amount": 250,
117
+ * "currencyCode": "USD"
118
+ * },
119
+ * "frequency": "MONTHLY"
120
+ * }
121
+ * ]
122
+ * }
123
+ * ]
124
+ * }
125
+ * *\/
126
+ * // example id: to-get-information-about-device-offerings-1472562810999
127
+ * ```
128
+ *
35
129
  */
36
130
  export declare class ListOfferingsCommand extends $Command<ListOfferingsCommandInput, ListOfferingsCommandOutput, DeviceFarmClientResolvedConfig> {
37
131
  readonly input: ListOfferingsCommandInput;
@@ -29,6 +29,47 @@ export interface ListProjectsCommandOutput extends ListProjectsResult, __Metadat
29
29
  * @see {@link ListProjectsCommandOutput} 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 Farm project
46
+ * ```javascript
47
+ * // The following example returns information about the specified project in Device Farm.
48
+ * const input = {
49
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE",
50
+ * "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
51
+ * };
52
+ * const command = new ListProjectsCommand(input);
53
+ * const response = await client.send(command);
54
+ * /* response ==
55
+ * {
56
+ * "projects": [
57
+ * {
58
+ * "name": "My Test Project",
59
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE",
60
+ * "created": "1453163262.105"
61
+ * },
62
+ * {
63
+ * "name": "Hello World",
64
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:d6b087d9-56db-4e44-b9ec-12345EXAMPLE",
65
+ * "created": "1470350112.439"
66
+ * }
67
+ * ]
68
+ * }
69
+ * *\/
70
+ * // example id: to-get-information-about-a-device-farm-project-1472564014388
71
+ * ```
72
+ *
32
73
  */
33
74
  export declare class ListProjectsCommand extends $Command<ListProjectsCommandInput, ListProjectsCommandOutput, DeviceFarmClientResolvedConfig> {
34
75
  readonly input: ListProjectsCommandInput;
@@ -29,6 +29,36 @@ export interface ListRemoteAccessSessionsCommandOutput extends ListRemoteAccessS
29
29
  * @see {@link ListRemoteAccessSessionsCommandOutput} 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 remote access session
46
+ * ```javascript
47
+ * // The following example returns information about a specific Device Farm remote access session.
48
+ * const input = {
49
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456",
50
+ * "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE="
51
+ * };
52
+ * const command = new ListRemoteAccessSessionsCommand(input);
53
+ * const response = await client.send(command);
54
+ * /* response ==
55
+ * {
56
+ * "remoteAccessSessions": []
57
+ * }
58
+ * *\/
59
+ * // example id: to-get-information-about-a-remote-access-session-1472581144803
60
+ * ```
61
+ *
32
62
  */
33
63
  export declare class ListRemoteAccessSessionsCommand extends $Command<ListRemoteAccessSessionsCommandInput, ListRemoteAccessSessionsCommandOutput, DeviceFarmClientResolvedConfig> {
34
64
  readonly input: ListRemoteAccessSessionsCommandInput;
@@ -29,6 +29,63 @@ export interface ListRunsCommandOutput extends ListRunsResult, __MetadataBearer
29
29
  * @see {@link ListRunsCommandOutput} 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 returns 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
+ * "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
51
+ * };
52
+ * const command = new ListRunsCommand(input);
53
+ * const response = await client.send(command);
54
+ * /* response ==
55
+ * {
56
+ * "runs": [
57
+ * {
58
+ * "name": "My Test Run",
59
+ * "type": "BUILTIN_EXPLORER",
60
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE",
61
+ * "billingMethod": "METERED",
62
+ * "completedJobs": 0,
63
+ * "counters": {
64
+ * "errored": 0,
65
+ * "failed": 0,
66
+ * "passed": 0,
67
+ * "skipped": 0,
68
+ * "stopped": 0,
69
+ * "total": 0,
70
+ * "warned": 0
71
+ * },
72
+ * "created": "1472667509.852",
73
+ * "deviceMinutes": {
74
+ * "metered": 0,
75
+ * "total": 0,
76
+ * "unmetered": 0
77
+ * },
78
+ * "platform": "ANDROID",
79
+ * "result": "PENDING",
80
+ * "status": "RUNNING",
81
+ * "totalJobs": 3
82
+ * }
83
+ * ]
84
+ * }
85
+ * *\/
86
+ * // example id: to-get-information-about-test-runs-1472582711069
87
+ * ```
88
+ *
32
89
  */
33
90
  export declare class ListRunsCommand extends $Command<ListRunsCommandInput, ListRunsCommandOutput, DeviceFarmClientResolvedConfig> {
34
91
  readonly input: ListRunsCommandInput;
@@ -29,6 +29,36 @@ export interface ListSamplesCommandOutput extends ListSamplesResult, __MetadataB
29
29
  * @see {@link ListSamplesCommandOutput} 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 samples
46
+ * ```javascript
47
+ * // The following example returns information about samples, given a specific Device Farm project.
48
+ * const input = {
49
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
50
+ * "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
51
+ * };
52
+ * const command = new ListSamplesCommand(input);
53
+ * const response = await client.send(command);
54
+ * /* response ==
55
+ * {
56
+ * "samples": []
57
+ * }
58
+ * *\/
59
+ * // example id: to-get-information-about-samples-1472582847534
60
+ * ```
61
+ *
32
62
  */
33
63
  export declare class ListSamplesCommand extends $Command<ListSamplesCommandInput, ListSamplesCommandOutput, DeviceFarmClientResolvedConfig> {
34
64
  readonly input: ListSamplesCommandInput;
@@ -29,6 +29,36 @@ export interface ListSuitesCommandOutput extends ListSuitesResult, __MetadataBea
29
29
  * @see {@link ListSuitesCommandOutput} 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 suites
46
+ * ```javascript
47
+ * // The following example returns information about suites, given a specific Device Farm job.
48
+ * const input = {
49
+ * "arn": "arn:aws:devicefarm:us-west-2:123456789101:job:EXAMPLE-GUID-123-456",
50
+ * "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
51
+ * };
52
+ * const command = new ListSuitesCommand(input);
53
+ * const response = await client.send(command);
54
+ * /* response ==
55
+ * {
56
+ * "suites": []
57
+ * }
58
+ * *\/
59
+ * // example id: to-get-information-about-suites-1472583038218
60
+ * ```
61
+ *
32
62
  */
33
63
  export declare class ListSuitesCommand extends $Command<ListSuitesCommandInput, ListSuitesCommandOutput, DeviceFarmClientResolvedConfig> {
34
64
  readonly input: ListSuitesCommandInput;
@@ -29,6 +29,16 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
29
29
  * @see {@link ListTagsForResourceCommandOutput} 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 NotFoundException} (client fault)
36
+ * <p>The specified entity was not found.</p>
37
+ *
38
+ * @throws {@link TagOperationException} (client fault)
39
+ * <p>The operation was not successful. Try again.</p>
40
+ *
41
+ *
32
42
  */
33
43
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, DeviceFarmClientResolvedConfig> {
34
44
  readonly input: ListTagsForResourceCommandInput;
@@ -29,6 +29,14 @@ export interface ListTestGridProjectsCommandOutput extends ListTestGridProjectsR
29
29
  * @see {@link ListTestGridProjectsCommandOutput} 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
+ *
32
40
  */
33
41
  export declare class ListTestGridProjectsCommand extends $Command<ListTestGridProjectsCommandInput, ListTestGridProjectsCommandOutput, DeviceFarmClientResolvedConfig> {
34
42
  readonly input: ListTestGridProjectsCommandInput;