@aws-sdk/client-device-farm 3.775.0 → 3.782.0

package/dist-types/commands/GetProjectCommand.d.ts

@@ -80,27 +80,8 @@ declare const GetProjectCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
- * @public
- * @example To get information about a project
- * ```javascript
- * // The following example gets information about a specific project.
- * const input = {
- *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE"
- * };
- * const command = new GetProjectCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "project": {
- *     "name": "My Project",
- *     "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE",
- *     "created": "1472660939.152"
- *   }
- * }
- * *\/
- * // example id: to-get-a-project-1470975038449
- * ```
  *
+ * @public
  */
 export declare class GetProjectCommand extends GetProjectCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetRemoteAccessSessionCommand.d.ts

@@ -154,23 +154,23 @@ declare const GetRemoteAccessSessionCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
- * @public
+ *
  * @example To get a remote access session
  * ```javascript
  * // The following example gets a specific remote access session.
  * const input = {
- *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456"
+ *   arn: "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456"
  * };
  * const command = new GetRemoteAccessSessionCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "remoteAccessSession": {}
+ *   remoteAccessSession:   { /* empty *\/ }
  * }
  * *\/
- * // example id: to-get-a-remote-access-session-1471014119414
  * ```
  *
+ * @public
  */
 export declare class GetRemoteAccessSessionCommand extends GetRemoteAccessSessionCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetRunCommand.d.ts

@@ -166,47 +166,8 @@ declare const GetRunCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
- * @public
- * @example To get information about a test run
- * ```javascript
- * // The following example gets information about a specific test run.
- * const input = {
- *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE"
- * };
- * const command = new GetRunCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "run": {
- *     "name": "My Test Run",
- *     "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE",
- *     "billingMethod": "METERED",
- *     "completedJobs": 0,
- *     "counters": {
- *       "errored": 0,
- *       "failed": 0,
- *       "passed": 0,
- *       "skipped": 0,
- *       "stopped": 0,
- *       "total": 0,
- *       "warned": 0
- *     },
- *     "created": "1472667509.852",
- *     "deviceMinutes": {
- *       "metered": 0,
- *       "total": 0,
- *       "unmetered": 0
- *     },
- *     "platform": "ANDROID",
- *     "result": "PENDING",
- *     "status": "RUNNING",
- *     "totalJobs": 3
- *   }
- * }
- * *\/
- * // example id: to-get-a-test-run-1471015895657
- * ```
  *
+ * @public
  */
 export declare class GetRunCommand extends GetRunCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetSuiteCommand.d.ts

@@ -90,23 +90,23 @@ declare const GetSuiteCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
- * @public
+ *
  * @example To get information about a test suite
  * ```javascript
  * // The following example gets information about a specific test suite.
  * const input = {
- *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:suite:EXAMPLE-GUID-123-456"
+ *   arn: "arn:aws:devicefarm:us-west-2:123456789101:suite:EXAMPLE-GUID-123-456"
  * };
  * const command = new GetSuiteCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "suite": {}
+ *   suite:   { /* empty *\/ }
  * }
  * *\/
- * // example id: to-get-information-about-a-test-suite-1471016525008
  * ```
  *
+ * @public
  */
 export declare class GetSuiteCommand extends GetSuiteCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetTestCommand.d.ts

@@ -90,23 +90,23 @@ declare const GetTestCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
- * @public
+ *
  * @example To get information about a specific test
  * ```javascript
  * // The following example gets information about a specific test.
  * const input = {
- *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456"
+ *   arn: "arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456"
  * };
  * const command = new GetTestCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "test": {}
+ *   test:   { /* empty *\/ }
  * }
  * *\/
- * // example id: to-get-information-about-a-specific-test-1471025744238
  * ```
  *
+ * @public
  */
 export declare class GetTestCommand extends GetTestCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetTestGridProjectCommand.d.ts

@@ -78,6 +78,7 @@ declare const GetTestGridProjectCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
+ *
  * @public
  */
 export declare class GetTestGridProjectCommand extends GetTestGridProjectCommand_base {

package/dist-types/commands/GetTestGridSessionCommand.d.ts

@@ -82,6 +82,7 @@ declare const GetTestGridSessionCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
+ *
  * @public
  */
 export declare class GetTestGridSessionCommand extends GetTestGridSessionCommand_base {

package/dist-types/commands/GetUploadCommand.d.ts

@@ -77,23 +77,23 @@ declare const GetUploadCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
- * @public
+ *
  * @example To get information about a specific upload
  * ```javascript
  * // The following example gets information about a specific upload.
  * const input = {
- *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456"
+ *   arn: "arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456"
  * };
  * const command = new GetUploadCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "upload": {}
+ *   upload:   { /* empty *\/ }
  * }
  * *\/
- * // example id: to-get-information-about-a-specific-upload-1471025996221
  * ```
  *
+ * @public
  */
 export declare class GetUploadCommand extends GetUploadCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetVPCEConfigurationCommand.d.ts

@@ -70,6 +70,7 @@ declare const GetVPCEConfigurationCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
+ *
  * @public
  */
 export declare class GetVPCEConfigurationCommand extends GetVPCEConfigurationCommand_base {

package/dist-types/commands/InstallToRemoteAccessSessionCommand.d.ts

@@ -80,24 +80,24 @@ declare const InstallToRemoteAccessSessionCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
- * @public
+ *
  * @example To install to a remote access session
  * ```javascript
  * // The following example installs a specific app to a device in a specific remote access session.
  * const input = {
- *   "appArn": "arn:aws:devicefarm:us-west-2:123456789101:app:EXAMPLE-GUID-123-456",
- *   "remoteAccessSessionArn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456"
+ *   appArn: "arn:aws:devicefarm:us-west-2:123456789101:app:EXAMPLE-GUID-123-456",
+ *   remoteAccessSessionArn: "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456"
  * };
  * const command = new InstallToRemoteAccessSessionCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "appUpload": {}
+ *   appUpload:   { /* empty *\/ }
  * }
  * *\/
- * // example id: to-install-to-a-remote-access-session-1471634453818
  * ```
  *
+ * @public
  */
 export declare class InstallToRemoteAccessSessionCommand extends InstallToRemoteAccessSessionCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListArtifactsCommand.d.ts

@@ -77,19 +77,22 @@ declare const ListArtifactsCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
- * @public
+ *
  * @example To list artifacts for a resource
  * ```javascript
  * // The following example lists screenshot artifacts for a specific run.
  * const input = {
- *   "type": "SCREENSHOT",
- *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456"
+ *   arn: "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456",
+ *   type: "SCREENSHOT"
  * };
  * const command = new ListArtifactsCommand(input);
- * await client.send(command);
- * // example id: to-list-artifacts-for-a-resource-1471635409527
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class ListArtifactsCommand extends ListArtifactsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListDeviceInstancesCommand.d.ts

@@ -89,6 +89,7 @@ declare const ListDeviceInstancesCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
+ *
  * @public
  */
 export declare class ListDeviceInstancesCommand extends ListDeviceInstancesCommand_base {

package/dist-types/commands/ListDevicePoolsCommand.d.ts

@@ -84,49 +84,49 @@ declare const ListDevicePoolsCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
- * @public
+ *
  * @example To get information about device pools
  * ```javascript
  * // The following example returns information about the private device pools in a specific project.
  * const input = {
- *   "type": "PRIVATE",
- *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
+ *   arn: "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
+ *   type: "PRIVATE"
  * };
  * const command = new ListDevicePoolsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "devicePools": [
+ *   devicePools: [
  *     {
- *       "name": "Top Devices",
- *       "arn": "arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE",
- *       "description": "Top devices",
- *       "rules": [
+ *       arn: "arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE",
+ *       description: "Top devices",
+ *       name: "Top Devices",
+ *       rules: [
  *         {
- *           "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\"]",
- *           "attribute": "ARN",
- *           "operator": "IN"
+ *           attribute: "ARN",
+ *           operator: "IN",
+ *           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"]`
  *         }
  *       ]
  *     },
  *     {
- *       "name": "My Android Device Pool",
- *       "arn": "arn:aws:devicefarm:us-west-2:123456789101:devicepool:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/bf96e75a-28f6-4e61-b6a7-12345EXAMPLE",
- *       "description": "Samsung Galaxy Android devices",
- *       "rules": [
+ *       arn: "arn:aws:devicefarm:us-west-2:123456789101:devicepool:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/bf96e75a-28f6-4e61-b6a7-12345EXAMPLE",
+ *       description: "Samsung Galaxy Android devices",
+ *       name: "My Android Device Pool",
+ *       rules: [
  *         {
- *           "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\"]",
- *           "attribute": "ARN",
- *           "operator": "IN"
+ *           attribute: "ARN",
+ *           operator: "IN",
+ *           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"]`
  *         }
  *       ]
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-get-information-about-device-pools-1471635745170
  * ```
  *
+ * @public
  */
 export declare class ListDevicePoolsCommand extends ListDevicePoolsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListDevicesCommand.d.ts

@@ -128,18 +128,21 @@ declare const ListDevicesCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
- * @public
+ *
  * @example To get information about devices
  * ```javascript
  * // The following example returns information about the available devices in a specific project.
  * const input = {
- *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
+ *   arn: "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
  * };
  * const command = new ListDevicesCommand(input);
- * await client.send(command);
- * // example id: to-get-information-about-devices-1471641699344
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class ListDevicesCommand extends ListDevicesCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListInstanceProfilesCommand.d.ts

@@ -79,6 +79,7 @@ declare const ListInstanceProfilesCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
+ *
  * @public
  */
 export declare class ListInstanceProfilesCommand extends ListInstanceProfilesCommand_base {

package/dist-types/commands/ListJobsCommand.d.ts

@@ -147,18 +147,21 @@ declare const ListJobsCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
- * @public
+ *
  * @example To get information about jobs
  * ```javascript
  * // The following example returns information about jobs in a specific project.
  * const input = {
- *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
+ *   arn: "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
  * };
  * const command = new ListJobsCommand(input);
- * await client.send(command);
- * // example id: to-get-information-about-jobs-1471642228071
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class ListJobsCommand extends ListJobsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListNetworkProfilesCommand.d.ts

@@ -84,6 +84,7 @@ declare const ListNetworkProfilesCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
+ *
  * @public
  */
 export declare class ListNetworkProfilesCommand extends ListNetworkProfilesCommand_base {

package/dist-types/commands/ListOfferingPromotionsCommand.d.ts

@@ -78,6 +78,7 @@ declare const ListOfferingPromotionsCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
+ *
  * @public
  */
 export declare class ListOfferingPromotionsCommand extends ListOfferingPromotionsCommand_base {

package/dist-types/commands/ListOfferingTransactionsCommand.d.ts

@@ -104,100 +104,8 @@ declare const ListOfferingTransactionsCommand_base: {
  * @throws {@link DeviceFarmServiceException}
  * <p>Base exception class for all service exceptions from DeviceFarm service.</p>
  *
- * @public
- * @example To get information about device offering transactions
- * ```javascript
- * // The following example returns information about Device Farm offering transactions.
- * const input = {
- *   "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE="
- * };
- * const command = new ListOfferingTransactionsCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "offeringTransactions": [
- *     {
- *       "cost": {
- *         "amount": 0,
- *         "currencyCode": "USD"
- *       },
- *       "createdOn": "1470021420",
- *       "offeringStatus": {
- *         "type": "RENEW",
- *         "effectiveOn": "1472688000",
- *         "offering": {
- *           "type": "RECURRING",
- *           "description": "Android Remote Access Unmetered Device Slot",
- *           "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
- *           "platform": "ANDROID"
- *         },
- *         "quantity": 0
- *       },
- *       "transactionId": "03728003-d1ea-4851-abd6-12345EXAMPLE"
- *     },
- *     {
- *       "cost": {
- *         "amount": 250,
- *         "currencyCode": "USD"
- *       },
- *       "createdOn": "1470021420",
- *       "offeringStatus": {
- *         "type": "PURCHASE",
- *         "effectiveOn": "1470021420",
- *         "offering": {
- *           "type": "RECURRING",
- *           "description": "Android Remote Access Unmetered Device Slot",
- *           "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
- *           "platform": "ANDROID"
- *         },
- *         "quantity": 1
- *       },
- *       "transactionId": "56820b6e-06bd-473a-8ff8-12345EXAMPLE"
- *     },
- *     {
- *       "cost": {
- *         "amount": 175,
- *         "currencyCode": "USD"
- *       },
- *       "createdOn": "1465538520",
- *       "offeringStatus": {
- *         "type": "PURCHASE",
- *         "effectiveOn": "1465538520",
- *         "offering": {
- *           "type": "RECURRING",
- *           "description": "Android Unmetered Device Slot",
- *           "id": "8980F81C-00D7-469D-8EC6-12345EXAMPLE",
- *           "platform": "ANDROID"
- *         },
- *         "quantity": 1
- *       },
- *       "transactionId": "953ae2c6-d760-4a04-9597-12345EXAMPLE"
- *     },
- *     {
- *       "cost": {
- *         "amount": 8.07,
- *         "currencyCode": "USD"
- *       },
- *       "createdOn": "1459344300",
- *       "offeringStatus": {
- *         "type": "PURCHASE",
- *         "effectiveOn": "1459344300",
- *         "offering": {
- *           "type": "RECURRING",
- *           "description": "iOS Unmetered Device Slot",
- *           "id": "A53D4D73-A6F6-4B82-A0B0-12345EXAMPLE",
- *           "platform": "IOS"
- *         },
- *         "quantity": 1
- *       },
- *       "transactionId": "2baf9021-ae3e-47f5-ab52-12345EXAMPLE"
- *     }
- *   ]
- * }
- * *\/
- * // example id: to-get-information-about-device-offering-transactions-1472561712315
- * ```
  *
+ * @public
  */
 export declare class ListOfferingTransactionsCommand extends ListOfferingTransactionsCommand_base {
     /** @internal type navigation helper, not in runtime. */