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

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

@@ -29,6 +29,48 @@ export interface ListDevicePoolsCommandOutput extends ListDevicePoolsResult, __M
  * @see {@link ListDevicePoolsCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @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"
+ * };
+ * const command = new ListDevicePoolsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "devicePools": [
+ *     {
+ *       "name": "Top Devices",
+ *       "arn": "arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE",
+ *       "description": "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"
+ *         }
+ *       ]
+ *     },
+ *     {
+ *       "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": [
+ *         {
+ *           "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"
+ *         }
+ *       ]
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-information-about-device-pools-1471635745170
+ * ```
+ *
  */
 export declare class ListDevicePoolsCommand extends $Command<ListDevicePoolsCommandInput, ListDevicePoolsCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: ListDevicePoolsCommandInput;

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

@@ -29,6 +29,17 @@ export interface ListDevicesCommandOutput extends ListDevicesResult, __MetadataB
  * @see {@link ListDevicesCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @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"
+ * };
+ * const command = new ListDevicesCommand(input);
+ * await client.send(command);
+ * // example id: to-get-information-about-devices-1471641699344
+ * ```
+ *
  */
 export declare class ListDevicesCommand extends $Command<ListDevicesCommandInput, ListDevicesCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: ListDevicesCommandInput;

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

@@ -29,6 +29,17 @@ export interface ListJobsCommandOutput extends ListJobsResult, __MetadataBearer
  * @see {@link ListJobsCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @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"
+ * };
+ * const command = new ListJobsCommand(input);
+ * await client.send(command);
+ * // example id: to-get-information-about-jobs-1471642228071
+ * ```
+ *
  */
 export declare class ListJobsCommand extends $Command<ListJobsCommandInput, ListJobsCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: ListJobsCommandInput;

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

@@ -32,6 +32,99 @@ export interface ListOfferingTransactionsCommandOutput extends ListOfferingTrans
  * @see {@link ListOfferingTransactionsCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @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
+ * ```
+ *
  */
 export declare class ListOfferingTransactionsCommand extends $Command<ListOfferingTransactionsCommandInput, ListOfferingTransactionsCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: ListOfferingTransactionsCommandInput;

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

@@ -32,6 +32,83 @@ export interface ListOfferingsCommandOutput extends ListOfferingsResult, __Metad
  * @see {@link ListOfferingsCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To get information about device offerings
+ * ```javascript
+ * // The following example returns information about available device offerings.
+ * const input = {
+ *   "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE="
+ * };
+ * const command = new ListOfferingsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "offerings": [
+ *     {
+ *       "type": "RECURRING",
+ *       "description": "iOS Unmetered Device Slot",
+ *       "id": "A53D4D73-A6F6-4B82-A0B0-12345EXAMPLE",
+ *       "platform": "IOS",
+ *       "recurringCharges": [
+ *         {
+ *           "cost": {
+ *             "amount": 250,
+ *             "currencyCode": "USD"
+ *           },
+ *           "frequency": "MONTHLY"
+ *         }
+ *       ]
+ *     },
+ *     {
+ *       "type": "RECURRING",
+ *       "description": "Android Unmetered Device Slot",
+ *       "id": "8980F81C-00D7-469D-8EC6-12345EXAMPLE",
+ *       "platform": "ANDROID",
+ *       "recurringCharges": [
+ *         {
+ *           "cost": {
+ *             "amount": 250,
+ *             "currencyCode": "USD"
+ *           },
+ *           "frequency": "MONTHLY"
+ *         }
+ *       ]
+ *     },
+ *     {
+ *       "type": "RECURRING",
+ *       "description": "Android Remote Access Unmetered Device Slot",
+ *       "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
+ *       "platform": "ANDROID",
+ *       "recurringCharges": [
+ *         {
+ *           "cost": {
+ *             "amount": 250,
+ *             "currencyCode": "USD"
+ *           },
+ *           "frequency": "MONTHLY"
+ *         }
+ *       ]
+ *     },
+ *     {
+ *       "type": "RECURRING",
+ *       "description": "iOS Remote Access Unmetered Device Slot",
+ *       "id": "552B4DAD-A6C9-45C4-94FB-12345EXAMPLE",
+ *       "platform": "IOS",
+ *       "recurringCharges": [
+ *         {
+ *           "cost": {
+ *             "amount": 250,
+ *             "currencyCode": "USD"
+ *           },
+ *           "frequency": "MONTHLY"
+ *         }
+ *       ]
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-information-about-device-offerings-1472562810999
+ * ```
+ *
  */
 export declare class ListOfferingsCommand extends $Command<ListOfferingsCommandInput, ListOfferingsCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: ListOfferingsCommandInput;

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

@@ -29,6 +29,34 @@ export interface ListProjectsCommandOutput extends ListProjectsResult, __Metadat
  * @see {@link ListProjectsCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To get information about a Device Farm project
+ * ```javascript
+ * // The following example returns information about the specified project in Device Farm.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE",
+ *   "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
+ * };
+ * const command = new ListProjectsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "projects": [
+ *     {
+ *       "name": "My Test Project",
+ *       "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE",
+ *       "created": "1453163262.105"
+ *     },
+ *     {
+ *       "name": "Hello World",
+ *       "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:d6b087d9-56db-4e44-b9ec-12345EXAMPLE",
+ *       "created": "1470350112.439"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-information-about-a-device-farm-project-1472564014388
+ * ```
+ *
  */
 export declare class ListProjectsCommand extends $Command<ListProjectsCommandInput, ListProjectsCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: ListProjectsCommandInput;

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

@@ -29,6 +29,23 @@ export interface ListRemoteAccessSessionsCommandOutput extends ListRemoteAccessS
  * @see {@link ListRemoteAccessSessionsCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To get information about a remote access session
+ * ```javascript
+ * // The following example returns information about a specific Device Farm remote access session.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456",
+ *   "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE="
+ * };
+ * const command = new ListRemoteAccessSessionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "remoteAccessSessions": []
+ * }
+ * *\/
+ * // example id: to-get-information-about-a-remote-access-session-1472581144803
+ * ```
+ *
  */
 export declare class ListRemoteAccessSessionsCommand extends $Command<ListRemoteAccessSessionsCommandInput, ListRemoteAccessSessionsCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: ListRemoteAccessSessionsCommandInput;

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

@@ -29,6 +29,50 @@ export interface ListRunsCommandOutput extends ListRunsResult, __MetadataBearer
  * @see {@link ListRunsCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To get information about a test run
+ * ```javascript
+ * // The following example returns 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",
+ *   "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
+ * };
+ * const command = new ListRunsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "runs": [
+ *     {
+ *       "name": "My Test Run",
+ *       "type": "BUILTIN_EXPLORER",
+ *       "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-information-about-test-runs-1472582711069
+ * ```
+ *
  */
 export declare class ListRunsCommand extends $Command<ListRunsCommandInput, ListRunsCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: ListRunsCommandInput;

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

@@ -29,6 +29,23 @@ export interface ListSamplesCommandOutput extends ListSamplesResult, __MetadataB
  * @see {@link ListSamplesCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To get information about samples
+ * ```javascript
+ * // The following example returns information about samples, given a specific Device Farm project.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
+ *   "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
+ * };
+ * const command = new ListSamplesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "samples": []
+ * }
+ * *\/
+ * // example id: to-get-information-about-samples-1472582847534
+ * ```
+ *
  */
 export declare class ListSamplesCommand extends $Command<ListSamplesCommandInput, ListSamplesCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: ListSamplesCommandInput;

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

@@ -29,6 +29,23 @@ export interface ListSuitesCommandOutput extends ListSuitesResult, __MetadataBea
  * @see {@link ListSuitesCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To get information about suites
+ * ```javascript
+ * // The following example returns information about suites, given a specific Device Farm job.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:job:EXAMPLE-GUID-123-456",
+ *   "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
+ * };
+ * const command = new ListSuitesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "suites": []
+ * }
+ * *\/
+ * // example id: to-get-information-about-suites-1472583038218
+ * ```
+ *
  */
 export declare class ListSuitesCommand extends $Command<ListSuitesCommandInput, ListSuitesCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: ListSuitesCommandInput;

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

@@ -29,6 +29,23 @@ export interface ListTestsCommandOutput extends ListTestsResult, __MetadataBeare
  * @see {@link ListTestsCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To get information about tests
+ * ```javascript
+ * // The following example returns information about tests, given a specific Device Farm project.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
+ *   "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
+ * };
+ * const command = new ListTestsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "tests": []
+ * }
+ * *\/
+ * // example id: to-get-information-about-tests-1472617372212
+ * ```
+ *
  */
 export declare class ListTestsCommand extends $Command<ListTestsCommandInput, ListTestsCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: ListTestsCommandInput;

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

@@ -33,6 +33,23 @@ export interface ListUniqueProblemsCommandOutput extends ListUniqueProblemsResul
  * @see {@link ListUniqueProblemsCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To get information about unique problems
+ * ```javascript
+ * // The following example returns information about unique problems, given a specific Device Farm project.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
+ *   "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
+ * };
+ * const command = new ListUniqueProblemsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "uniqueProblems": {}
+ * }
+ * *\/
+ * // example id: to-get-information-about-unique-problems-1472617781008
+ * ```
+ *
  */
 export declare class ListUniqueProblemsCommand extends $Command<ListUniqueProblemsCommandInput, ListUniqueProblemsCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: ListUniqueProblemsCommandInput;

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

@@ -29,6 +29,23 @@ export interface ListUploadsCommandOutput extends ListUploadsResult, __MetadataB
  * @see {@link ListUploadsCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To get information about uploads
+ * ```javascript
+ * // The following example returns information about uploads, given a specific Device Farm project.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
+ *   "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
+ * };
+ * const command = new ListUploadsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "uploads": []
+ * }
+ * *\/
+ * // example id: to-get-information-about-uploads-1472617943090
+ * ```
+ *
  */
 export declare class ListUploadsCommand extends $Command<ListUploadsCommandInput, ListUploadsCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: ListUploadsCommandInput;

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

@@ -32,6 +32,41 @@ export interface PurchaseOfferingCommandOutput extends PurchaseOfferingResult, _
  * @see {@link PurchaseOfferingCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To purchase a device slot offering
+ * ```javascript
+ * // The following example purchases a specific device slot offering.
+ * const input = {
+ *   "offeringId": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
+ *   "quantity": 1
+ * };
+ * const command = new PurchaseOfferingCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "offeringTransaction": {
+ *     "cost": {
+ *       "amount": 8.07,
+ *       "currencyCode": "USD"
+ *     },
+ *     "createdOn": "1472648340",
+ *     "offeringStatus": {
+ *       "type": "PURCHASE",
+ *       "effectiveOn": "1472648340",
+ *       "offering": {
+ *         "type": "RECURRING",
+ *         "description": "Android Remote Access Unmetered Device Slot",
+ *         "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
+ *         "platform": "ANDROID"
+ *       },
+ *       "quantity": 1
+ *     },
+ *     "transactionId": "d30614ed-1b03-404c-9893-12345EXAMPLE"
+ *   }
+ * }
+ * *\/
+ * // example id: to-purchase-a-device-slot-offering-1472648146343
+ * ```
+ *
  */
 export declare class PurchaseOfferingCommand extends $Command<PurchaseOfferingCommandInput, PurchaseOfferingCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: PurchaseOfferingCommandInput;

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

@@ -31,6 +31,41 @@ export interface RenewOfferingCommandOutput extends RenewOfferingResult, __Metad
  * @see {@link RenewOfferingCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To renew a device slot offering
+ * ```javascript
+ * // The following example renews a specific device slot offering.
+ * const input = {
+ *   "offeringId": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
+ *   "quantity": 1
+ * };
+ * const command = new RenewOfferingCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "offeringTransaction": {
+ *     "cost": {
+ *       "amount": 250,
+ *       "currencyCode": "USD"
+ *     },
+ *     "createdOn": "1472648880",
+ *     "offeringStatus": {
+ *       "type": "RENEW",
+ *       "effectiveOn": "1472688000",
+ *       "offering": {
+ *         "type": "RECURRING",
+ *         "description": "Android Remote Access Unmetered Device Slot",
+ *         "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
+ *         "platform": "ANDROID"
+ *       },
+ *       "quantity": 1
+ *     },
+ *     "transactionId": "e90f1405-8c35-4561-be43-12345EXAMPLE"
+ *   }
+ * }
+ * *\/
+ * // example id: to-renew-a-device-slot-offering-1472648899785
+ * ```
+ *
  */
 export declare class RenewOfferingCommand extends $Command<RenewOfferingCommandInput, RenewOfferingCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: RenewOfferingCommandInput;

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

@@ -29,6 +29,28 @@ export interface ScheduleRunCommandOutput extends ScheduleRunResult, __MetadataB
  * @see {@link ScheduleRunCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To schedule a test run
+ * ```javascript
+ * // The following example schedules a test run named MyRun.
+ * const input = {
+ *   "name": "MyRun",
+ *   "devicePoolArn": "arn:aws:devicefarm:us-west-2:123456789101:pool:EXAMPLE-GUID-123-456",
+ *   "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
+ *   "test": {
+ *     "type": "APPIUM_JAVA_JUNIT",
+ *     "testPackageArn": "arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456"
+ *   }
+ * };
+ * const command = new ScheduleRunCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "run": {}
+ * }
+ * *\/
+ * // example id: to-schedule-a-test-run-1472652429636
+ * ```
+ *
  */
 export declare class ScheduleRunCommand extends $Command<ScheduleRunCommandInput, ScheduleRunCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: ScheduleRunCommandInput;

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

@@ -32,6 +32,22 @@ export interface StopRunCommandOutput extends StopRunResult, __MetadataBearer {
  * @see {@link StopRunCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To stop a test run
+ * ```javascript
+ * // The following example stops a specific test run.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456"
+ * };
+ * const command = new StopRunCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "run": {}
+ * }
+ * *\/
+ * // example id: to-stop-a-test-run-1472653770340
+ * ```
+ *
  */
 export declare class StopRunCommand extends $Command<StopRunCommandInput, StopRunCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: StopRunCommandInput;