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

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

@@ -29,6 +29,25 @@ export interface CreateDevicePoolCommandOutput extends CreateDevicePoolResult, _
  * @see {@link CreateDevicePoolCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To create a new device pool
+ * ```javascript
+ * // The following example creates a new device pool named MyDevicePool inside an existing project.
+ * const input = {
+ *   "name": "MyDevicePool",
+ *   "description": "My Android devices",
+ *   "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
+ *   "rules": []
+ * };
+ * const command = new CreateDevicePoolCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "devicePool": {}
+ * }
+ * *\/
+ * // example id: createdevicepool-example-1470862210860
+ * ```
+ *
  */
 export declare class CreateDevicePoolCommand extends $Command<CreateDevicePoolCommandInput, CreateDevicePoolCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: CreateDevicePoolCommandInput;

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

@@ -29,6 +29,26 @@ export interface CreateProjectCommandOutput extends CreateProjectResult, __Metad
  * @see {@link CreateProjectCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To create a new project
+ * ```javascript
+ * // The following example creates a new project named MyProject.
+ * const input = {
+ *   "name": "MyProject"
+ * };
+ * const command = new CreateProjectCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "project": {
+ *     "name": "MyProject",
+ *     "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE",
+ *     "created": "1472660939.152"
+ *   }
+ * }
+ * *\/
+ * // example id: createproject-example-1470862210860
+ * ```
+ *
  */
 export declare class CreateProjectCommand extends $Command<CreateProjectCommandInput, CreateProjectCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: CreateProjectCommandInput;

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

@@ -29,6 +29,27 @@ export interface CreateRemoteAccessSessionCommandOutput extends CreateRemoteAcce
  * @see {@link CreateRemoteAccessSessionCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To create a remote access session
+ * ```javascript
+ * // The following example creates a remote access session named MySession.
+ * const input = {
+ *   "name": "MySession",
+ *   "configuration": {
+ *     "billingMethod": "METERED"
+ *   },
+ *   "deviceArn": "arn:aws:devicefarm:us-west-2::device:123EXAMPLE",
+ *   "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
+ * };
+ * const command = new CreateRemoteAccessSessionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "remoteAccessSession": {}
+ * }
+ * *\/
+ * // example id: to-create-a-remote-access-session-1470970668274
+ * ```
+ *
  */
 export declare class CreateRemoteAccessSessionCommand extends $Command<CreateRemoteAccessSessionCommandInput, CreateRemoteAccessSessionCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: CreateRemoteAccessSessionCommandInput;

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

@@ -29,6 +29,31 @@ export interface CreateUploadCommandOutput extends CreateUploadResult, __Metadat
  * @see {@link CreateUploadCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To create a new test package upload
+ * ```javascript
+ * // The following example creates a new Appium Python test package upload inside an existing project.
+ * const input = {
+ *   "name": "MyAppiumPythonUpload",
+ *   "type": "APPIUM_PYTHON_TEST_PACKAGE",
+ *   "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
+ * };
+ * const command = new CreateUploadCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "upload": {
+ *     "name": "MyAppiumPythonUpload",
+ *     "type": "APPIUM_PYTHON_TEST_PACKAGE",
+ *     "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE",
+ *     "created": "1472661404.186",
+ *     "status": "INITIALIZED",
+ *     "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"
+ *   }
+ * }
+ * *\/
+ * // example id: createupload-example-1470864711775
+ * ```
+ *
  */
 export declare class CreateUploadCommand extends $Command<CreateUploadCommandInput, CreateUploadCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: CreateUploadCommandInput;

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

@@ -30,6 +30,17 @@ export interface DeleteDevicePoolCommandOutput extends DeleteDevicePoolResult, _
  * @see {@link DeleteDevicePoolCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To delete a device pool
+ * ```javascript
+ * // The following example deletes a specific device pool.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID"
+ * };
+ * const command = new DeleteDevicePoolCommand(input);
+ * await client.send(command);
+ * // example id: deletedevicepool-example-1470866975494
+ * ```
+ *
  */
 export declare class DeleteDevicePoolCommand extends $Command<DeleteDevicePoolCommandInput, DeleteDevicePoolCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: DeleteDevicePoolCommandInput;

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

@@ -30,6 +30,17 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResult, __Metad
  * @see {@link DeleteProjectCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To delete a project
+ * ```javascript
+ * // The following example deletes a specific project.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
+ * };
+ * const command = new DeleteProjectCommand(input);
+ * await client.send(command);
+ * // example id: deleteproject-example-1470867374212
+ * ```
+ *
  */
 export declare class DeleteProjectCommand extends $Command<DeleteProjectCommandInput, DeleteProjectCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: DeleteProjectCommandInput;

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

@@ -29,6 +29,17 @@ export interface DeleteRemoteAccessSessionCommandOutput extends DeleteRemoteAcce
  * @see {@link DeleteRemoteAccessSessionCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To delete a specific remote access session
+ * ```javascript
+ * // The following example deletes a specific remote access session.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456"
+ * };
+ * const command = new DeleteRemoteAccessSessionCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-a-specific-remote-access-session-1470971431677
+ * ```
+ *
  */
 export declare class DeleteRemoteAccessSessionCommand extends $Command<DeleteRemoteAccessSessionCommandInput, DeleteRemoteAccessSessionCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: DeleteRemoteAccessSessionCommandInput;

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

@@ -30,6 +30,17 @@ export interface DeleteRunCommandOutput extends DeleteRunResult, __MetadataBeare
  * @see {@link DeleteRunCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To delete a run
+ * ```javascript
+ * // The following example deletes a specific test run.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456"
+ * };
+ * const command = new DeleteRunCommand(input);
+ * await client.send(command);
+ * // example id: deleterun-example-1470867905129
+ * ```
+ *
  */
 export declare class DeleteRunCommand extends $Command<DeleteRunCommandInput, DeleteRunCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: DeleteRunCommandInput;

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

@@ -29,6 +29,17 @@ export interface DeleteUploadCommandOutput extends DeleteUploadResult, __Metadat
  * @see {@link DeleteUploadCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To delete a specific upload
+ * ```javascript
+ * // The following example deletes a specific upload.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456"
+ * };
+ * const command = new DeleteUploadCommand(input);
+ * await client.send(command);
+ * // example id: deleteupload-example-1470868363942
+ * ```
+ *
  */
 export declare class DeleteUploadCommand extends $Command<DeleteUploadCommandInput, DeleteUploadCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: DeleteUploadCommandInput;

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

@@ -30,6 +30,26 @@ export interface GetAccountSettingsCommandOutput extends GetAccountSettingsResul
  * @see {@link GetAccountSettingsCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To get information about account settings
+ * ```javascript
+ * // The following example returns information about your Device Farm account settings.
+ * const input = {};
+ * const command = new GetAccountSettingsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "accountSettings": {
+ *     "awsAccountNumber": "123456789101",
+ *     "unmeteredDevices": {
+ *       "ANDROID": 1,
+ *       "IOS": 2
+ *     }
+ *   }
+ * }
+ * *\/
+ * // example id: to-get-information-about-account-settings-1472567568189
+ * ```
+ *
  */
 export declare class GetAccountSettingsCommand extends $Command<GetAccountSettingsCommandInput, GetAccountSettingsCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: GetAccountSettingsCommandInput;

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

@@ -29,6 +29,42 @@ export interface GetDeviceCommandOutput extends GetDeviceResult, __MetadataBeare
  * @see {@link GetDeviceCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To get information about a device
+ * ```javascript
+ * // The following example returns information about a specific device.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2::device:123EXAMPLE"
+ * };
+ * const command = new GetDeviceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "device": {
+ *     "name": "LG G2 (Sprint)",
+ *     "arn": "arn:aws:devicefarm:us-west-2::device:A0E6E6E1059E45918208DF75B2B7EF6C",
+ *     "cpu": {
+ *       "architecture": "armeabi-v7a",
+ *       "clock": 2265.6,
+ *       "frequency": "MHz"
+ *     },
+ *     "formFactor": "PHONE",
+ *     "heapSize": 256000000,
+ *     "image": "75B2B7EF6C12345EXAMPLE",
+ *     "manufacturer": "LG",
+ *     "memory": 16000000000,
+ *     "model": "G2 (Sprint)",
+ *     "os": "4.2.2",
+ *     "platform": "ANDROID",
+ *     "resolution": {
+ *       "height": 1920,
+ *       "width": 1080
+ *     }
+ *   }
+ * }
+ * *\/
+ * // example id: getdevice-example-1470870602173
+ * ```
+ *
  */
 export declare class GetDeviceCommand extends $Command<GetDeviceCommandInput, GetDeviceCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: GetDeviceCommandInput;

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

@@ -29,6 +29,22 @@ export interface GetDevicePoolCommandOutput extends GetDevicePoolResult, __Metad
  * @see {@link GetDevicePoolCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To get information about a device pool
+ * ```javascript
+ * // The following example returns information about a specific device pool, given a project ARN.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
+ * };
+ * const command = new GetDevicePoolCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "devicePool": {}
+ * }
+ * *\/
+ * // example id: getdevicepool-example-1470870873136
+ * ```
+ *
  */
 export declare class GetDevicePoolCommand extends $Command<GetDevicePoolCommandInput, GetDevicePoolCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: GetDevicePoolCommandInput;

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

@@ -29,6 +29,25 @@ export interface GetDevicePoolCompatibilityCommandOutput extends GetDevicePoolCo
  * @see {@link GetDevicePoolCompatibilityCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To get information about the compatibility of a device pool
+ * ```javascript
+ * // The following example returns information about the compatibility of a specific device pool, given its ARN.
+ * const input = {
+ *   "appArn": "arn:aws:devicefarm:us-west-2::app:123-456-EXAMPLE-GUID",
+ *   "devicePoolArn": "arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID",
+ *   "testType": "APPIUM_PYTHON"
+ * };
+ * const command = new GetDevicePoolCompatibilityCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "compatibleDevices": [],
+ *   "incompatibleDevices": []
+ * }
+ * *\/
+ * // example id: getdevicepoolcompatibility-example-1470925003466
+ * ```
+ *
  */
 export declare class GetDevicePoolCompatibilityCommand extends $Command<GetDevicePoolCompatibilityCommandInput, GetDevicePoolCompatibilityCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: GetDevicePoolCompatibilityCommandInput;

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

@@ -29,6 +29,22 @@ export interface GetJobCommandOutput extends GetJobResult, __MetadataBearer {
  * @see {@link GetJobCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To get information about a job
+ * ```javascript
+ * // The following example returns information about a specific job.
+ * const input = {
+ *   "arn": "arn:aws:devicefarm:us-west-2::job:123-456-EXAMPLE-GUID"
+ * };
+ * const command = new GetJobCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "job": {}
+ * }
+ * *\/
+ * // example id: getjob-example-1470928294268
+ * ```
+ *
  */
 export declare class GetJobCommand extends $Command<GetJobCommandInput, GetJobCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: GetJobCommandInput;

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

@@ -32,6 +32,44 @@ export interface GetOfferingStatusCommandOutput extends GetOfferingStatusResult,
  * @see {@link GetOfferingStatusCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @example To get status information about device offerings
+ * ```javascript
+ * // The following example returns information about Device Farm offerings available to your account.
+ * const input = {
+ *   "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE="
+ * };
+ * const command = new GetOfferingStatusCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "current": {
+ *     "D68B3C05-1BA6-4360-BC69-12345EXAMPLE": {
+ *       "offering": {
+ *         "type": "RECURRING",
+ *         "description": "Android Remote Access Unmetered Device Slot",
+ *         "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
+ *         "platform": "ANDROID"
+ *       },
+ *       "quantity": 1
+ *     }
+ *   },
+ *   "nextPeriod": {
+ *     "D68B3C05-1BA6-4360-BC69-12345EXAMPLE": {
+ *       "effectiveOn": "1472688000",
+ *       "offering": {
+ *         "type": "RECURRING",
+ *         "description": "Android Remote Access Unmetered Device Slot",
+ *         "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
+ *         "platform": "ANDROID"
+ *       },
+ *       "quantity": 1
+ *     }
+ *   }
+ * }
+ * *\/
+ * // example id: to-get-status-information-about-device-offerings-1472568124402
+ * ```
+ *
  */
 export declare class GetOfferingStatusCommand extends $Command<GetOfferingStatusCommandInput, GetOfferingStatusCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: GetOfferingStatusCommandInput;

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

@@ -29,6 +29,26 @@ export interface GetProjectCommandOutput extends GetProjectResult, __MetadataBea
  * @see {@link GetProjectCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @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
+ * ```
+ *
  */
 export declare class GetProjectCommand extends $Command<GetProjectCommandInput, GetProjectCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: GetProjectCommandInput;

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

@@ -29,6 +29,22 @@ export interface GetRemoteAccessSessionCommandOutput extends GetRemoteAccessSess
  * @see {@link GetRemoteAccessSessionCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @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"
+ * };
+ * const command = new GetRemoteAccessSessionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "remoteAccessSession": {}
+ * }
+ * *\/
+ * // example id: to-get-a-remote-access-session-1471014119414
+ * ```
+ *
  */
 export declare class GetRemoteAccessSessionCommand extends $Command<GetRemoteAccessSessionCommandInput, GetRemoteAccessSessionCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: GetRemoteAccessSessionCommandInput;

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

@@ -29,6 +29,47 @@ export interface GetRunCommandOutput extends GetRunResult, __MetadataBearer {
  * @see {@link GetRunCommandOutput} 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 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",
+ *     "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-a-test-run-1471015895657
+ * ```
+ *
  */
 export declare class GetRunCommand extends $Command<GetRunCommandInput, GetRunCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: GetRunCommandInput;

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

@@ -29,6 +29,22 @@ export interface GetSuiteCommandOutput extends GetSuiteResult, __MetadataBearer
  * @see {@link GetSuiteCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @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"
+ * };
+ * const command = new GetSuiteCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "suite": {}
+ * }
+ * *\/
+ * // example id: to-get-information-about-a-test-suite-1471016525008
+ * ```
+ *
  */
 export declare class GetSuiteCommand extends $Command<GetSuiteCommandInput, GetSuiteCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: GetSuiteCommandInput;

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

@@ -29,6 +29,22 @@ export interface GetTestCommandOutput extends GetTestResult, __MetadataBearer {
  * @see {@link GetTestCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @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"
+ * };
+ * const command = new GetTestCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "test": {}
+ * }
+ * *\/
+ * // example id: to-get-information-about-a-specific-test-1471025744238
+ * ```
+ *
  */
 export declare class GetTestCommand extends $Command<GetTestCommandInput, GetTestCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: GetTestCommandInput;

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

@@ -29,6 +29,22 @@ export interface GetUploadCommandOutput extends GetUploadResult, __MetadataBeare
  * @see {@link GetUploadCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @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"
+ * };
+ * const command = new GetUploadCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "upload": {}
+ * }
+ * *\/
+ * // example id: to-get-information-about-a-specific-upload-1471025996221
+ * ```
+ *
  */
 export declare class GetUploadCommand extends $Command<GetUploadCommandInput, GetUploadCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: GetUploadCommandInput;

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

@@ -31,6 +31,23 @@ export interface InstallToRemoteAccessSessionCommandOutput extends InstallToRemo
  * @see {@link InstallToRemoteAccessSessionCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @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"
+ * };
+ * const command = new InstallToRemoteAccessSessionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "appUpload": {}
+ * }
+ * *\/
+ * // example id: to-install-to-a-remote-access-session-1471634453818
+ * ```
+ *
  */
 export declare class InstallToRemoteAccessSessionCommand extends $Command<InstallToRemoteAccessSessionCommandInput, InstallToRemoteAccessSessionCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: InstallToRemoteAccessSessionCommandInput;

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

@@ -29,6 +29,18 @@ export interface ListArtifactsCommandOutput extends ListArtifactsResult, __Metad
  * @see {@link ListArtifactsCommandOutput} for command's `response` shape.
  * @see {@link DeviceFarmClientResolvedConfig | config} for DeviceFarmClient's `config` shape.
  *
+ * @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"
+ * };
+ * const command = new ListArtifactsCommand(input);
+ * await client.send(command);
+ * // example id: to-list-artifacts-for-a-resource-1471635409527
+ * ```
+ *
  */
 export declare class ListArtifactsCommand extends $Command<ListArtifactsCommandInput, ListArtifactsCommandOutput, DeviceFarmClientResolvedConfig> {
     readonly input: ListArtifactsCommandInput;