AWS Device Farm 2015-06-23

CreateDevicePool

$result = $client->createDevicePool([/* ... */]);
$promise = $client->createDevicePoolAsync([/* ... */]);

Parameter Syntax

$result = $client->createDevicePool([
    'description' => '<string>',
    'maxDevices' => <integer>,
    'name' => '<string>', // REQUIRED
    'projectArn' => '<string>', // REQUIRED
    'rules' => [ // REQUIRED
        [
            'attribute' => 'ARN|PLATFORM|FORM_FACTOR|MANUFACTURER|REMOTE_ACCESS_ENABLED|REMOTE_DEBUG_ENABLED|APPIUM_VERSION|INSTANCE_ARN|INSTANCE_LABELS|FLEET_TYPE|OS_VERSION|MODEL|AVAILABILITY',
            'operator' => 'EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|GREATER_THAN|GREATER_THAN_OR_EQUALS|IN|NOT_IN|CONTAINS',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'devicePool' => [
        'arn' => '<string>',
        'description' => '<string>',
        'maxDevices' => <integer>,
        'name' => '<string>',
        'rules' => [
            [
                'attribute' => 'ARN|PLATFORM|FORM_FACTOR|MANUFACTURER|REMOTE_ACCESS_ENABLED|REMOTE_DEBUG_ENABLED|APPIUM_VERSION|INSTANCE_ARN|INSTANCE_LABELS|FLEET_TYPE|OS_VERSION|MODEL|AVAILABILITY',
                'operator' => 'EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|GREATER_THAN|GREATER_THAN_OR_EQUALS|IN|NOT_IN|CONTAINS',
                'value' => '<string>',
            ],
            // ...
        ],
        'type' => 'CURATED|PRIVATE',
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To create a new device pool

The following example creates a new device pool named MyDevicePool inside an existing project.

$result = $client->createDevicePool([
    'name' => 'MyDevicePool', // A device pool contains related devices, such as devices that run only on Android or that run only on iOS.
    'description' => 'My Android devices',
    'projectArn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456', // You can get the project ARN by using the list-projects CLI command.
    'rules' => [
    ],
]);

Result syntax:

[
    'devicePool' => [
    ],
]

CreateInstanceProfile

$result = $client->createInstanceProfile([/* ... */]);
$promise = $client->createInstanceProfileAsync([/* ... */]);

Parameter Syntax

$result = $client->createInstanceProfile([
    'description' => '<string>',
    'excludeAppPackagesFromCleanup' => ['<string>', ...],
    'name' => '<string>', // REQUIRED
    'packageCleanup' => true || false,
    'rebootAfterUse' => true || false,
]);

Parameter Details

Result Syntax

[
    'instanceProfile' => [
        'arn' => '<string>',
        'description' => '<string>',
        'excludeAppPackagesFromCleanup' => ['<string>', ...],
        'name' => '<string>',
        'packageCleanup' => true || false,
        'rebootAfterUse' => true || false,
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

CreateNetworkProfile

$result = $client->createNetworkProfile([/* ... */]);
$promise = $client->createNetworkProfileAsync([/* ... */]);

Parameter Syntax

$result = $client->createNetworkProfile([
    'description' => '<string>',
    'downlinkBandwidthBits' => <integer>,
    'downlinkDelayMs' => <integer>,
    'downlinkJitterMs' => <integer>,
    'downlinkLossPercent' => <integer>,
    'name' => '<string>', // REQUIRED
    'projectArn' => '<string>', // REQUIRED
    'type' => 'CURATED|PRIVATE',
    'uplinkBandwidthBits' => <integer>,
    'uplinkDelayMs' => <integer>,
    'uplinkJitterMs' => <integer>,
    'uplinkLossPercent' => <integer>,
]);

Parameter Details

Result Syntax

[
    'networkProfile' => [
        'arn' => '<string>',
        'description' => '<string>',
        'downlinkBandwidthBits' => <integer>,
        'downlinkDelayMs' => <integer>,
        'downlinkJitterMs' => <integer>,
        'downlinkLossPercent' => <integer>,
        'name' => '<string>',
        'type' => 'CURATED|PRIVATE',
        'uplinkBandwidthBits' => <integer>,
        'uplinkDelayMs' => <integer>,
        'uplinkJitterMs' => <integer>,
        'uplinkLossPercent' => <integer>,
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

CreateProject

$result = $client->createProject([/* ... */]);
$promise = $client->createProjectAsync([/* ... */]);

Parameter Syntax

$result = $client->createProject([
    'defaultJobTimeoutMinutes' => <integer>,
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'project' => [
        'arn' => '<string>',
        'created' => <DateTime>,
        'defaultJobTimeoutMinutes' => <integer>,
        'name' => '<string>',
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

• TagOperationException:

  The operation was not successful. Try again.

Examples

Example 1: To create a new project

The following example creates a new project named MyProject.

$result = $client->createProject([
    'name' => 'MyProject', // A project in Device Farm is a workspace that contains test runs. A run is a test of a single app against one or more devices.
]);

Result syntax:

[
    'project' => [
        'name' => 'MyProject',
        'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE',
        'created' => ,
    ],
]

CreateRemoteAccessSession

$result = $client->createRemoteAccessSession([/* ... */]);
$promise = $client->createRemoteAccessSessionAsync([/* ... */]);

Parameter Syntax

$result = $client->createRemoteAccessSession([
    'clientId' => '<string>',
    'configuration' => [
        'billingMethod' => 'METERED|UNMETERED',
        'vpceConfigurationArns' => ['<string>', ...],
    ],
    'deviceArn' => '<string>', // REQUIRED
    'instanceArn' => '<string>',
    'interactionMode' => 'INTERACTIVE|NO_VIDEO|VIDEO_ONLY',
    'name' => '<string>',
    'projectArn' => '<string>', // REQUIRED
    'remoteDebugEnabled' => true || false,
    'remoteRecordAppArn' => '<string>',
    'remoteRecordEnabled' => true || false,
    'skipAppResign' => true || false,
    'sshPublicKey' => '<string>',
]);

Parameter Details

Result Syntax

[
    'remoteAccessSession' => [
        'arn' => '<string>',
        'billingMethod' => 'METERED|UNMETERED',
        'clientId' => '<string>',
        'created' => <DateTime>,
        'device' => [
            'arn' => '<string>',
            'availability' => 'TEMPORARY_NOT_AVAILABLE|BUSY|AVAILABLE|HIGHLY_AVAILABLE',
            'carrier' => '<string>',
            'cpu' => [
                'architecture' => '<string>',
                'clock' => <float>,
                'frequency' => '<string>',
            ],
            'fleetName' => '<string>',
            'fleetType' => '<string>',
            'formFactor' => 'PHONE|TABLET',
            'heapSize' => <integer>,
            'image' => '<string>',
            'instances' => [
                [
                    'arn' => '<string>',
                    'deviceArn' => '<string>',
                    'instanceProfile' => [
                        'arn' => '<string>',
                        'description' => '<string>',
                        'excludeAppPackagesFromCleanup' => ['<string>', ...],
                        'name' => '<string>',
                        'packageCleanup' => true || false,
                        'rebootAfterUse' => true || false,
                    ],
                    'labels' => ['<string>', ...],
                    'status' => 'IN_USE|PREPARING|AVAILABLE|NOT_AVAILABLE',
                    'udid' => '<string>',
                ],
                // ...
            ],
            'manufacturer' => '<string>',
            'memory' => <integer>,
            'model' => '<string>',
            'modelId' => '<string>',
            'name' => '<string>',
            'os' => '<string>',
            'platform' => 'ANDROID|IOS',
            'radio' => '<string>',
            'remoteAccessEnabled' => true || false,
            'remoteDebugEnabled' => true || false,
            'resolution' => [
                'height' => <integer>,
                'width' => <integer>,
            ],
        ],
        'deviceMinutes' => [
            'metered' => <float>,
            'total' => <float>,
            'unmetered' => <float>,
        ],
        'deviceUdid' => '<string>',
        'endpoint' => '<string>',
        'hostAddress' => '<string>',
        'instanceArn' => '<string>',
        'interactionMode' => 'INTERACTIVE|NO_VIDEO|VIDEO_ONLY',
        'message' => '<string>',
        'name' => '<string>',
        'remoteDebugEnabled' => true || false,
        'remoteRecordAppArn' => '<string>',
        'remoteRecordEnabled' => true || false,
        'result' => 'PENDING|PASSED|WARNED|FAILED|SKIPPED|ERRORED|STOPPED',
        'skipAppResign' => true || false,
        'started' => <DateTime>,
        'status' => 'PENDING|PENDING_CONCURRENCY|PENDING_DEVICE|PROCESSING|SCHEDULING|PREPARING|RUNNING|COMPLETED|STOPPING',
        'stopped' => <DateTime>,
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To create a remote access session

The following example creates a remote access session named MySession.

$result = $client->createRemoteAccessSession([
    'name' => 'MySession',
    'configuration' => [
        'billingMethod' => 'METERED',
    ],
    'deviceArn' => 'arn:aws:devicefarm:us-west-2::device:123EXAMPLE', // You can get the device ARN by using the list-devices CLI command.
    'projectArn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456', // You can get the project ARN by using the list-projects CLI command.
]);

Result syntax:

[
    'remoteAccessSession' => [
    ],
]

CreateUpload

$result = $client->createUpload([/* ... */]);
$promise = $client->createUploadAsync([/* ... */]);

Parameter Syntax

$result = $client->createUpload([
    'contentType' => '<string>',
    'name' => '<string>', // REQUIRED
    'projectArn' => '<string>', // REQUIRED
    'type' => 'ANDROID_APP|IOS_APP|WEB_APP|EXTERNAL_DATA|APPIUM_JAVA_JUNIT_TEST_PACKAGE|APPIUM_JAVA_TESTNG_TEST_PACKAGE|APPIUM_PYTHON_TEST_PACKAGE|APPIUM_NODE_TEST_PACKAGE|APPIUM_RUBY_TEST_PACKAGE|APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE|APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE|APPIUM_WEB_PYTHON_TEST_PACKAGE|APPIUM_WEB_NODE_TEST_PACKAGE|APPIUM_WEB_RUBY_TEST_PACKAGE|CALABASH_TEST_PACKAGE|INSTRUMENTATION_TEST_PACKAGE|UIAUTOMATION_TEST_PACKAGE|UIAUTOMATOR_TEST_PACKAGE|XCTEST_TEST_PACKAGE|XCTEST_UI_TEST_PACKAGE|APPIUM_JAVA_JUNIT_TEST_SPEC|APPIUM_JAVA_TESTNG_TEST_SPEC|APPIUM_PYTHON_TEST_SPEC|APPIUM_NODE_TEST_SPEC|APPIUM_RUBY_TEST_SPEC|APPIUM_WEB_JAVA_JUNIT_TEST_SPEC|APPIUM_WEB_JAVA_TESTNG_TEST_SPEC|APPIUM_WEB_PYTHON_TEST_SPEC|APPIUM_WEB_NODE_TEST_SPEC|APPIUM_WEB_RUBY_TEST_SPEC|INSTRUMENTATION_TEST_SPEC|XCTEST_UI_TEST_SPEC', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'upload' => [
        'arn' => '<string>',
        'category' => 'CURATED|PRIVATE',
        'contentType' => '<string>',
        'created' => <DateTime>,
        'message' => '<string>',
        'metadata' => '<string>',
        'name' => '<string>',
        'status' => 'INITIALIZED|PROCESSING|SUCCEEDED|FAILED',
        'type' => 'ANDROID_APP|IOS_APP|WEB_APP|EXTERNAL_DATA|APPIUM_JAVA_JUNIT_TEST_PACKAGE|APPIUM_JAVA_TESTNG_TEST_PACKAGE|APPIUM_PYTHON_TEST_PACKAGE|APPIUM_NODE_TEST_PACKAGE|APPIUM_RUBY_TEST_PACKAGE|APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE|APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE|APPIUM_WEB_PYTHON_TEST_PACKAGE|APPIUM_WEB_NODE_TEST_PACKAGE|APPIUM_WEB_RUBY_TEST_PACKAGE|CALABASH_TEST_PACKAGE|INSTRUMENTATION_TEST_PACKAGE|UIAUTOMATION_TEST_PACKAGE|UIAUTOMATOR_TEST_PACKAGE|XCTEST_TEST_PACKAGE|XCTEST_UI_TEST_PACKAGE|APPIUM_JAVA_JUNIT_TEST_SPEC|APPIUM_JAVA_TESTNG_TEST_SPEC|APPIUM_PYTHON_TEST_SPEC|APPIUM_NODE_TEST_SPEC|APPIUM_RUBY_TEST_SPEC|APPIUM_WEB_JAVA_JUNIT_TEST_SPEC|APPIUM_WEB_JAVA_TESTNG_TEST_SPEC|APPIUM_WEB_PYTHON_TEST_SPEC|APPIUM_WEB_NODE_TEST_SPEC|APPIUM_WEB_RUBY_TEST_SPEC|INSTRUMENTATION_TEST_SPEC|XCTEST_UI_TEST_SPEC',
        'url' => '<string>',
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To create a new test package upload

The following example creates a new Appium Python test package upload inside an existing project.

$result = $client->createUpload([
    'name' => 'MyAppiumPythonUpload',
    'type' => 'APPIUM_PYTHON_TEST_PACKAGE',
    'projectArn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456', // You can get the project ARN by using the list-projects CLI command.
]);

Result syntax:

[
    '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' => ,
        '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',
    ],
]

CreateVPCEConfiguration

$result = $client->createVPCEConfiguration([/* ... */]);
$promise = $client->createVPCEConfigurationAsync([/* ... */]);

Parameter Syntax

$result = $client->createVPCEConfiguration([
    'serviceDnsName' => '<string>', // REQUIRED
    'vpceConfigurationDescription' => '<string>',
    'vpceConfigurationName' => '<string>', // REQUIRED
    'vpceServiceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'vpceConfiguration' => [
        'arn' => '<string>',
        'serviceDnsName' => '<string>',
        'vpceConfigurationDescription' => '<string>',
        'vpceConfigurationName' => '<string>',
        'vpceServiceName' => '<string>',
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

DeleteDevicePool

$result = $client->deleteDevicePool([/* ... */]);
$promise = $client->deleteDevicePoolAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteDevicePool([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To delete a device pool

The following example deletes a specific device pool.

$result = $client->deleteDevicePool([
    'arn' => 'arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID', // You can get the device pool ARN by using the list-device-pools CLI command.
]);

Result syntax:

[
]

DeleteInstanceProfile

$result = $client->deleteInstanceProfile([/* ... */]);
$promise = $client->deleteInstanceProfileAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteInstanceProfile([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

DeleteNetworkProfile

$result = $client->deleteNetworkProfile([/* ... */]);
$promise = $client->deleteNetworkProfileAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteNetworkProfile([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

DeleteProject

$result = $client->deleteProject([/* ... */]);
$promise = $client->deleteProjectAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteProject([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To delete a project

The following example deletes a specific project.

$result = $client->deleteProject([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456', // You can get the project ARN by using the list-projects CLI command.
]);

Result syntax:

[
]

DeleteRemoteAccessSession

$result = $client->deleteRemoteAccessSession([/* ... */]);
$promise = $client->deleteRemoteAccessSessionAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteRemoteAccessSession([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To delete a specific remote access session

The following example deletes a specific remote access session.

$result = $client->deleteRemoteAccessSession([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456', // You can get the remote access session ARN by using the list-remote-access-sessions CLI command.
]);

Result syntax:

[
]

DeleteRun

$result = $client->deleteRun([/* ... */]);
$promise = $client->deleteRunAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteRun([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To delete a run

The following example deletes a specific test run.

$result = $client->deleteRun([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456', // You can get the run ARN by using the list-runs CLI command.
]);

Result syntax:

[
]

DeleteUpload

$result = $client->deleteUpload([/* ... */]);
$promise = $client->deleteUploadAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteUpload([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To delete a specific upload

The following example deletes a specific upload.

$result = $client->deleteUpload([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456', // You can get the upload ARN by using the list-uploads CLI command.
]);

Result syntax:

[
]

DeleteVPCEConfiguration

$result = $client->deleteVPCEConfiguration([/* ... */]);
$promise = $client->deleteVPCEConfigurationAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteVPCEConfiguration([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• ServiceAccountException:

  There was a problem with the service account.

• InvalidOperationException:

  There was an error with the update request, or you do not have sufficient permissions to update this VPC endpoint configuration.

GetAccountSettings

$result = $client->getAccountSettings([/* ... */]);
$promise = $client->getAccountSettingsAsync([/* ... */]);

Parameter Syntax

$result = $client->getAccountSettings([
]);

Parameter Details

Result Syntax

[
    'accountSettings' => [
        'awsAccountNumber' => '<string>',
        'defaultJobTimeoutMinutes' => <integer>,
        'maxJobTimeoutMinutes' => <integer>,
        'maxSlots' => [<integer>, ...],
        'skipAppResign' => true || false,
        'trialMinutes' => [
            'remaining' => <float>,
            'total' => <float>,
        ],
        'unmeteredDevices' => [<integer>, ...],
        'unmeteredRemoteAccessDevices' => [<integer>, ...],
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about account settings

The following example returns information about your Device Farm account settings.

$result = $client->getAccountSettings([
]);

Result syntax:

[
    'accountSettings' => [
        'awsAccountNumber' => '123456789101',
        'unmeteredDevices' => [
            'ANDROID' => 1,
            'IOS' => 2,
        ],
    ],
]

GetDevice

$result = $client->getDevice([/* ... */]);
$promise = $client->getDeviceAsync([/* ... */]);

Parameter Syntax

$result = $client->getDevice([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'device' => [
        'arn' => '<string>',
        'availability' => 'TEMPORARY_NOT_AVAILABLE|BUSY|AVAILABLE|HIGHLY_AVAILABLE',
        'carrier' => '<string>',
        'cpu' => [
            'architecture' => '<string>',
            'clock' => <float>,
            'frequency' => '<string>',
        ],
        'fleetName' => '<string>',
        'fleetType' => '<string>',
        'formFactor' => 'PHONE|TABLET',
        'heapSize' => <integer>,
        'image' => '<string>',
        'instances' => [
            [
                'arn' => '<string>',
                'deviceArn' => '<string>',
                'instanceProfile' => [
                    'arn' => '<string>',
                    'description' => '<string>',
                    'excludeAppPackagesFromCleanup' => ['<string>', ...],
                    'name' => '<string>',
                    'packageCleanup' => true || false,
                    'rebootAfterUse' => true || false,
                ],
                'labels' => ['<string>', ...],
                'status' => 'IN_USE|PREPARING|AVAILABLE|NOT_AVAILABLE',
                'udid' => '<string>',
            ],
            // ...
        ],
        'manufacturer' => '<string>',
        'memory' => <integer>,
        'model' => '<string>',
        'modelId' => '<string>',
        'name' => '<string>',
        'os' => '<string>',
        'platform' => 'ANDROID|IOS',
        'radio' => '<string>',
        'remoteAccessEnabled' => true || false,
        'remoteDebugEnabled' => true || false,
        'resolution' => [
            'height' => <integer>,
            'width' => <integer>,
        ],
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about a device

The following example returns information about a specific device.

$result = $client->getDevice([
    'arn' => 'arn:aws:devicefarm:us-west-2::device:123EXAMPLE',
]);

Result syntax:

[
    '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,
        ],
    ],
]

GetDeviceInstance

$result = $client->getDeviceInstance([/* ... */]);
$promise = $client->getDeviceInstanceAsync([/* ... */]);

Parameter Syntax

$result = $client->getDeviceInstance([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deviceInstance' => [
        'arn' => '<string>',
        'deviceArn' => '<string>',
        'instanceProfile' => [
            'arn' => '<string>',
            'description' => '<string>',
            'excludeAppPackagesFromCleanup' => ['<string>', ...],
            'name' => '<string>',
            'packageCleanup' => true || false,
            'rebootAfterUse' => true || false,
        ],
        'labels' => ['<string>', ...],
        'status' => 'IN_USE|PREPARING|AVAILABLE|NOT_AVAILABLE',
        'udid' => '<string>',
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

GetDevicePool

$result = $client->getDevicePool([/* ... */]);
$promise = $client->getDevicePoolAsync([/* ... */]);

Parameter Syntax

$result = $client->getDevicePool([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'devicePool' => [
        'arn' => '<string>',
        'description' => '<string>',
        'maxDevices' => <integer>,
        'name' => '<string>',
        'rules' => [
            [
                'attribute' => 'ARN|PLATFORM|FORM_FACTOR|MANUFACTURER|REMOTE_ACCESS_ENABLED|REMOTE_DEBUG_ENABLED|APPIUM_VERSION|INSTANCE_ARN|INSTANCE_LABELS|FLEET_TYPE|OS_VERSION|MODEL|AVAILABILITY',
                'operator' => 'EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|GREATER_THAN|GREATER_THAN_OR_EQUALS|IN|NOT_IN|CONTAINS',
                'value' => '<string>',
            ],
            // ...
        ],
        'type' => 'CURATED|PRIVATE',
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about a device pool

The following example returns information about a specific device pool, given a project ARN.

$result = $client->getDevicePool([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456', // You can obtain the project ARN by using the list-projects CLI command.
]);

Result syntax:

[
    'devicePool' => [
    ],
]

GetDevicePoolCompatibility

$result = $client->getDevicePoolCompatibility([/* ... */]);
$promise = $client->getDevicePoolCompatibilityAsync([/* ... */]);

Parameter Syntax

$result = $client->getDevicePoolCompatibility([
    'appArn' => '<string>',
    'configuration' => [
        'auxiliaryApps' => ['<string>', ...],
        'billingMethod' => 'METERED|UNMETERED',
        'customerArtifactPaths' => [
            'androidPaths' => ['<string>', ...],
            'deviceHostPaths' => ['<string>', ...],
            'iosPaths' => ['<string>', ...],
        ],
        'extraDataPackageArn' => '<string>',
        'locale' => '<string>',
        'location' => [
            'latitude' => <float>, // REQUIRED
            'longitude' => <float>, // REQUIRED
        ],
        'networkProfileArn' => '<string>',
        'radios' => [
            'bluetooth' => true || false,
            'gps' => true || false,
            'nfc' => true || false,
            'wifi' => true || false,
        ],
        'vpceConfigurationArns' => ['<string>', ...],
    ],
    'devicePoolArn' => '<string>', // REQUIRED
    'test' => [
        'filter' => '<string>',
        'parameters' => ['<string>', ...],
        'testPackageArn' => '<string>',
        'testSpecArn' => '<string>',
        'type' => 'BUILTIN_FUZZ|BUILTIN_EXPLORER|WEB_PERFORMANCE_PROFILE|APPIUM_JAVA_JUNIT|APPIUM_JAVA_TESTNG|APPIUM_PYTHON|APPIUM_NODE|APPIUM_RUBY|APPIUM_WEB_JAVA_JUNIT|APPIUM_WEB_JAVA_TESTNG|APPIUM_WEB_PYTHON|APPIUM_WEB_NODE|APPIUM_WEB_RUBY|CALABASH|INSTRUMENTATION|UIAUTOMATION|UIAUTOMATOR|XCTEST|XCTEST_UI|REMOTE_ACCESS_RECORD|REMOTE_ACCESS_REPLAY', // REQUIRED
    ],
    'testType' => 'BUILTIN_FUZZ|BUILTIN_EXPLORER|WEB_PERFORMANCE_PROFILE|APPIUM_JAVA_JUNIT|APPIUM_JAVA_TESTNG|APPIUM_PYTHON|APPIUM_NODE|APPIUM_RUBY|APPIUM_WEB_JAVA_JUNIT|APPIUM_WEB_JAVA_TESTNG|APPIUM_WEB_PYTHON|APPIUM_WEB_NODE|APPIUM_WEB_RUBY|CALABASH|INSTRUMENTATION|UIAUTOMATION|UIAUTOMATOR|XCTEST|XCTEST_UI|REMOTE_ACCESS_RECORD|REMOTE_ACCESS_REPLAY',
]);

Parameter Details

Result Syntax

[
    'compatibleDevices' => [
        [
            'compatible' => true || false,
            'device' => [
                'arn' => '<string>',
                'availability' => 'TEMPORARY_NOT_AVAILABLE|BUSY|AVAILABLE|HIGHLY_AVAILABLE',
                'carrier' => '<string>',
                'cpu' => [
                    'architecture' => '<string>',
                    'clock' => <float>,
                    'frequency' => '<string>',
                ],
                'fleetName' => '<string>',
                'fleetType' => '<string>',
                'formFactor' => 'PHONE|TABLET',
                'heapSize' => <integer>,
                'image' => '<string>',
                'instances' => [
                    [
                        'arn' => '<string>',
                        'deviceArn' => '<string>',
                        'instanceProfile' => [
                            'arn' => '<string>',
                            'description' => '<string>',
                            'excludeAppPackagesFromCleanup' => ['<string>', ...],
                            'name' => '<string>',
                            'packageCleanup' => true || false,
                            'rebootAfterUse' => true || false,
                        ],
                        'labels' => ['<string>', ...],
                        'status' => 'IN_USE|PREPARING|AVAILABLE|NOT_AVAILABLE',
                        'udid' => '<string>',
                    ],
                    // ...
                ],
                'manufacturer' => '<string>',
                'memory' => <integer>,
                'model' => '<string>',
                'modelId' => '<string>',
                'name' => '<string>',
                'os' => '<string>',
                'platform' => 'ANDROID|IOS',
                'radio' => '<string>',
                'remoteAccessEnabled' => true || false,
                'remoteDebugEnabled' => true || false,
                'resolution' => [
                    'height' => <integer>,
                    'width' => <integer>,
                ],
            ],
            'incompatibilityMessages' => [
                [
                    'message' => '<string>',
                    'type' => 'ARN|PLATFORM|FORM_FACTOR|MANUFACTURER|REMOTE_ACCESS_ENABLED|REMOTE_DEBUG_ENABLED|APPIUM_VERSION|INSTANCE_ARN|INSTANCE_LABELS|FLEET_TYPE|OS_VERSION|MODEL|AVAILABILITY',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'incompatibleDevices' => [
        [
            'compatible' => true || false,
            'device' => [
                'arn' => '<string>',
                'availability' => 'TEMPORARY_NOT_AVAILABLE|BUSY|AVAILABLE|HIGHLY_AVAILABLE',
                'carrier' => '<string>',
                'cpu' => [
                    'architecture' => '<string>',
                    'clock' => <float>,
                    'frequency' => '<string>',
                ],
                'fleetName' => '<string>',
                'fleetType' => '<string>',
                'formFactor' => 'PHONE|TABLET',
                'heapSize' => <integer>,
                'image' => '<string>',
                'instances' => [
                    [
                        'arn' => '<string>',
                        'deviceArn' => '<string>',
                        'instanceProfile' => [
                            'arn' => '<string>',
                            'description' => '<string>',
                            'excludeAppPackagesFromCleanup' => ['<string>', ...],
                            'name' => '<string>',
                            'packageCleanup' => true || false,
                            'rebootAfterUse' => true || false,
                        ],
                        'labels' => ['<string>', ...],
                        'status' => 'IN_USE|PREPARING|AVAILABLE|NOT_AVAILABLE',
                        'udid' => '<string>',
                    ],
                    // ...
                ],
                'manufacturer' => '<string>',
                'memory' => <integer>,
                'model' => '<string>',
                'modelId' => '<string>',
                'name' => '<string>',
                'os' => '<string>',
                'platform' => 'ANDROID|IOS',
                'radio' => '<string>',
                'remoteAccessEnabled' => true || false,
                'remoteDebugEnabled' => true || false,
                'resolution' => [
                    'height' => <integer>,
                    'width' => <integer>,
                ],
            ],
            'incompatibilityMessages' => [
                [
                    'message' => '<string>',
                    'type' => 'ARN|PLATFORM|FORM_FACTOR|MANUFACTURER|REMOTE_ACCESS_ENABLED|REMOTE_DEBUG_ENABLED|APPIUM_VERSION|INSTANCE_ARN|INSTANCE_LABELS|FLEET_TYPE|OS_VERSION|MODEL|AVAILABILITY',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about the compatibility of a device pool

The following example returns information about the compatibility of a specific device pool, given its ARN.

$result = $client->getDevicePoolCompatibility([
    'appArn' => 'arn:aws:devicefarm:us-west-2::app:123-456-EXAMPLE-GUID',
    'devicePoolArn' => 'arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID', // You can get the device pool ARN by using the list-device-pools CLI command.
    'testType' => 'APPIUM_PYTHON',
]);

Result syntax:

[
    'compatibleDevices' => [
    ],
    'incompatibleDevices' => [
    ],
]

GetInstanceProfile

$result = $client->getInstanceProfile([/* ... */]);
$promise = $client->getInstanceProfileAsync([/* ... */]);

Parameter Syntax

$result = $client->getInstanceProfile([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'instanceProfile' => [
        'arn' => '<string>',
        'description' => '<string>',
        'excludeAppPackagesFromCleanup' => ['<string>', ...],
        'name' => '<string>',
        'packageCleanup' => true || false,
        'rebootAfterUse' => true || false,
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

GetJob

$result = $client->getJob([/* ... */]);
$promise = $client->getJobAsync([/* ... */]);

Parameter Syntax

$result = $client->getJob([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'job' => [
        'arn' => '<string>',
        'counters' => [
            'errored' => <integer>,
            'failed' => <integer>,
            'passed' => <integer>,
            'skipped' => <integer>,
            'stopped' => <integer>,
            'total' => <integer>,
            'warned' => <integer>,
        ],
        'created' => <DateTime>,
        'device' => [
            'arn' => '<string>',
            'availability' => 'TEMPORARY_NOT_AVAILABLE|BUSY|AVAILABLE|HIGHLY_AVAILABLE',
            'carrier' => '<string>',
            'cpu' => [
                'architecture' => '<string>',
                'clock' => <float>,
                'frequency' => '<string>',
            ],
            'fleetName' => '<string>',
            'fleetType' => '<string>',
            'formFactor' => 'PHONE|TABLET',
            'heapSize' => <integer>,
            'image' => '<string>',
            'instances' => [
                [
                    'arn' => '<string>',
                    'deviceArn' => '<string>',
                    'instanceProfile' => [
                        'arn' => '<string>',
                        'description' => '<string>',
                        'excludeAppPackagesFromCleanup' => ['<string>', ...],
                        'name' => '<string>',
                        'packageCleanup' => true || false,
                        'rebootAfterUse' => true || false,
                    ],
                    'labels' => ['<string>', ...],
                    'status' => 'IN_USE|PREPARING|AVAILABLE|NOT_AVAILABLE',
                    'udid' => '<string>',
                ],
                // ...
            ],
            'manufacturer' => '<string>',
            'memory' => <integer>,
            'model' => '<string>',
            'modelId' => '<string>',
            'name' => '<string>',
            'os' => '<string>',
            'platform' => 'ANDROID|IOS',
            'radio' => '<string>',
            'remoteAccessEnabled' => true || false,
            'remoteDebugEnabled' => true || false,
            'resolution' => [
                'height' => <integer>,
                'width' => <integer>,
            ],
        ],
        'deviceMinutes' => [
            'metered' => <float>,
            'total' => <float>,
            'unmetered' => <float>,
        ],
        'instanceArn' => '<string>',
        'message' => '<string>',
        'name' => '<string>',
        'result' => 'PENDING|PASSED|WARNED|FAILED|SKIPPED|ERRORED|STOPPED',
        'started' => <DateTime>,
        'status' => 'PENDING|PENDING_CONCURRENCY|PENDING_DEVICE|PROCESSING|SCHEDULING|PREPARING|RUNNING|COMPLETED|STOPPING',
        'stopped' => <DateTime>,
        'type' => 'BUILTIN_FUZZ|BUILTIN_EXPLORER|WEB_PERFORMANCE_PROFILE|APPIUM_JAVA_JUNIT|APPIUM_JAVA_TESTNG|APPIUM_PYTHON|APPIUM_NODE|APPIUM_RUBY|APPIUM_WEB_JAVA_JUNIT|APPIUM_WEB_JAVA_TESTNG|APPIUM_WEB_PYTHON|APPIUM_WEB_NODE|APPIUM_WEB_RUBY|CALABASH|INSTRUMENTATION|UIAUTOMATION|UIAUTOMATOR|XCTEST|XCTEST_UI|REMOTE_ACCESS_RECORD|REMOTE_ACCESS_REPLAY',
        'videoCapture' => true || false,
        'videoEndpoint' => '<string>',
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about a job

The following example returns information about a specific job.

$result = $client->getJob([
    'arn' => 'arn:aws:devicefarm:us-west-2::job:123-456-EXAMPLE-GUID', // You can get the job ARN by using the list-jobs CLI command.
]);

Result syntax:

[
    'job' => [
    ],
]

GetNetworkProfile

$result = $client->getNetworkProfile([/* ... */]);
$promise = $client->getNetworkProfileAsync([/* ... */]);

Parameter Syntax

$result = $client->getNetworkProfile([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'networkProfile' => [
        'arn' => '<string>',
        'description' => '<string>',
        'downlinkBandwidthBits' => <integer>,
        'downlinkDelayMs' => <integer>,
        'downlinkJitterMs' => <integer>,
        'downlinkLossPercent' => <integer>,
        'name' => '<string>',
        'type' => 'CURATED|PRIVATE',
        'uplinkBandwidthBits' => <integer>,
        'uplinkDelayMs' => <integer>,
        'uplinkJitterMs' => <integer>,
        'uplinkLossPercent' => <integer>,
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

GetOfferingStatus

$result = $client->getOfferingStatus([/* ... */]);
$promise = $client->getOfferingStatusAsync([/* ... */]);

Parameter Syntax

$result = $client->getOfferingStatus([
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'current' => [
        '<OfferingIdentifier>' => [
            'effectiveOn' => <DateTime>,
            'offering' => [
                'description' => '<string>',
                'id' => '<string>',
                'platform' => 'ANDROID|IOS',
                'recurringCharges' => [
                    [
                        'cost' => [
                            'amount' => <float>,
                            'currencyCode' => 'USD',
                        ],
                        'frequency' => 'MONTHLY',
                    ],
                    // ...
                ],
                'type' => 'RECURRING',
            ],
            'quantity' => <integer>,
            'type' => 'PURCHASE|RENEW|SYSTEM',
        ],
        // ...
    ],
    'nextPeriod' => [
        '<OfferingIdentifier>' => [
            'effectiveOn' => <DateTime>,
            'offering' => [
                'description' => '<string>',
                'id' => '<string>',
                'platform' => 'ANDROID|IOS',
                'recurringCharges' => [
                    [
                        'cost' => [
                            'amount' => <float>,
                            'currencyCode' => 'USD',
                        ],
                        'frequency' => 'MONTHLY',
                    ],
                    // ...
                ],
                'type' => 'RECURRING',
            ],
            'quantity' => <integer>,
            'type' => 'PURCHASE|RENEW|SYSTEM',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• NotEligibleException:

  Exception gets thrown when a user is not eligible to perform the specified transaction.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get status information about device offerings

The following example returns information about Device Farm offerings available to your account.

$result = $client->getOfferingStatus([
    'nextToken' => 'RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=', // A dynamically generated value, used for paginating results.
]);

Result syntax:

[
    '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' => ,
            'offering' => [
                'type' => 'RECURRING',
                'description' => 'Android Remote Access Unmetered Device Slot',
                'id' => 'D68B3C05-1BA6-4360-BC69-12345EXAMPLE',
                'platform' => 'ANDROID',
            ],
            'quantity' => 1,
        ],
    ],
]

GetProject

$result = $client->getProject([/* ... */]);
$promise = $client->getProjectAsync([/* ... */]);

Parameter Syntax

$result = $client->getProject([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'project' => [
        'arn' => '<string>',
        'created' => <DateTime>,
        'defaultJobTimeoutMinutes' => <integer>,
        'name' => '<string>',
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about a project

The following example gets information about a specific project.

$result = $client->getProject([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE', // You can get the project ARN by using the list-projects CLI command.
]);

Result syntax:

[
    'project' => [
        'name' => 'My Project',
        'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE',
        'created' => ,
    ],
]

GetRemoteAccessSession

$result = $client->getRemoteAccessSession([/* ... */]);
$promise = $client->getRemoteAccessSessionAsync([/* ... */]);

Parameter Syntax

$result = $client->getRemoteAccessSession([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'remoteAccessSession' => [
        'arn' => '<string>',
        'billingMethod' => 'METERED|UNMETERED',
        'clientId' => '<string>',
        'created' => <DateTime>,
        'device' => [
            'arn' => '<string>',
            'availability' => 'TEMPORARY_NOT_AVAILABLE|BUSY|AVAILABLE|HIGHLY_AVAILABLE',
            'carrier' => '<string>',
            'cpu' => [
                'architecture' => '<string>',
                'clock' => <float>,
                'frequency' => '<string>',
            ],
            'fleetName' => '<string>',
            'fleetType' => '<string>',
            'formFactor' => 'PHONE|TABLET',
            'heapSize' => <integer>,
            'image' => '<string>',
            'instances' => [
                [
                    'arn' => '<string>',
                    'deviceArn' => '<string>',
                    'instanceProfile' => [
                        'arn' => '<string>',
                        'description' => '<string>',
                        'excludeAppPackagesFromCleanup' => ['<string>', ...],
                        'name' => '<string>',
                        'packageCleanup' => true || false,
                        'rebootAfterUse' => true || false,
                    ],
                    'labels' => ['<string>', ...],
                    'status' => 'IN_USE|PREPARING|AVAILABLE|NOT_AVAILABLE',
                    'udid' => '<string>',
                ],
                // ...
            ],
            'manufacturer' => '<string>',
            'memory' => <integer>,
            'model' => '<string>',
            'modelId' => '<string>',
            'name' => '<string>',
            'os' => '<string>',
            'platform' => 'ANDROID|IOS',
            'radio' => '<string>',
            'remoteAccessEnabled' => true || false,
            'remoteDebugEnabled' => true || false,
            'resolution' => [
                'height' => <integer>,
                'width' => <integer>,
            ],
        ],
        'deviceMinutes' => [
            'metered' => <float>,
            'total' => <float>,
            'unmetered' => <float>,
        ],
        'deviceUdid' => '<string>',
        'endpoint' => '<string>',
        'hostAddress' => '<string>',
        'instanceArn' => '<string>',
        'interactionMode' => 'INTERACTIVE|NO_VIDEO|VIDEO_ONLY',
        'message' => '<string>',
        'name' => '<string>',
        'remoteDebugEnabled' => true || false,
        'remoteRecordAppArn' => '<string>',
        'remoteRecordEnabled' => true || false,
        'result' => 'PENDING|PASSED|WARNED|FAILED|SKIPPED|ERRORED|STOPPED',
        'skipAppResign' => true || false,
        'started' => <DateTime>,
        'status' => 'PENDING|PENDING_CONCURRENCY|PENDING_DEVICE|PROCESSING|SCHEDULING|PREPARING|RUNNING|COMPLETED|STOPPING',
        'stopped' => <DateTime>,
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get a remote access session

The following example gets a specific remote access session.

$result = $client->getRemoteAccessSession([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456', // You can get the remote access session ARN by using the list-remote-access-sessions CLI command.
]);

Result syntax:

[
    'remoteAccessSession' => [
    ],
]

GetRun

$result = $client->getRun([/* ... */]);
$promise = $client->getRunAsync([/* ... */]);

Parameter Syntax

$result = $client->getRun([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'run' => [
        'appUpload' => '<string>',
        'arn' => '<string>',
        'billingMethod' => 'METERED|UNMETERED',
        'completedJobs' => <integer>,
        'counters' => [
            'errored' => <integer>,
            'failed' => <integer>,
            'passed' => <integer>,
            'skipped' => <integer>,
            'stopped' => <integer>,
            'total' => <integer>,
            'warned' => <integer>,
        ],
        'created' => <DateTime>,
        'customerArtifactPaths' => [
            'androidPaths' => ['<string>', ...],
            'deviceHostPaths' => ['<string>', ...],
            'iosPaths' => ['<string>', ...],
        ],
        'deviceMinutes' => [
            'metered' => <float>,
            'total' => <float>,
            'unmetered' => <float>,
        ],
        'devicePoolArn' => '<string>',
        'deviceSelectionResult' => [
            'filters' => [
                [
                    'attribute' => 'ARN|PLATFORM|OS_VERSION|MODEL|AVAILABILITY|FORM_FACTOR|MANUFACTURER|REMOTE_ACCESS_ENABLED|REMOTE_DEBUG_ENABLED|INSTANCE_ARN|INSTANCE_LABELS|FLEET_TYPE',
                    'operator' => 'EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|GREATER_THAN|GREATER_THAN_OR_EQUALS|IN|NOT_IN|CONTAINS',
                    'values' => ['<string>', ...],
                ],
                // ...
            ],
            'matchedDevicesCount' => <integer>,
            'maxDevices' => <integer>,
        ],
        'eventCount' => <integer>,
        'jobTimeoutMinutes' => <integer>,
        'locale' => '<string>',
        'location' => [
            'latitude' => <float>,
            'longitude' => <float>,
        ],
        'message' => '<string>',
        'name' => '<string>',
        'networkProfile' => [
            'arn' => '<string>',
            'description' => '<string>',
            'downlinkBandwidthBits' => <integer>,
            'downlinkDelayMs' => <integer>,
            'downlinkJitterMs' => <integer>,
            'downlinkLossPercent' => <integer>,
            'name' => '<string>',
            'type' => 'CURATED|PRIVATE',
            'uplinkBandwidthBits' => <integer>,
            'uplinkDelayMs' => <integer>,
            'uplinkJitterMs' => <integer>,
            'uplinkLossPercent' => <integer>,
        ],
        'parsingResultUrl' => '<string>',
        'platform' => 'ANDROID|IOS',
        'radios' => [
            'bluetooth' => true || false,
            'gps' => true || false,
            'nfc' => true || false,
            'wifi' => true || false,
        ],
        'result' => 'PENDING|PASSED|WARNED|FAILED|SKIPPED|ERRORED|STOPPED',
        'resultCode' => 'PARSING_FAILED|VPC_ENDPOINT_SETUP_FAILED',
        'seed' => <integer>,
        'skipAppResign' => true || false,
        'started' => <DateTime>,
        'status' => 'PENDING|PENDING_CONCURRENCY|PENDING_DEVICE|PROCESSING|SCHEDULING|PREPARING|RUNNING|COMPLETED|STOPPING',
        'stopped' => <DateTime>,
        'testSpecArn' => '<string>',
        'totalJobs' => <integer>,
        'type' => 'BUILTIN_FUZZ|BUILTIN_EXPLORER|WEB_PERFORMANCE_PROFILE|APPIUM_JAVA_JUNIT|APPIUM_JAVA_TESTNG|APPIUM_PYTHON|APPIUM_NODE|APPIUM_RUBY|APPIUM_WEB_JAVA_JUNIT|APPIUM_WEB_JAVA_TESTNG|APPIUM_WEB_PYTHON|APPIUM_WEB_NODE|APPIUM_WEB_RUBY|CALABASH|INSTRUMENTATION|UIAUTOMATION|UIAUTOMATOR|XCTEST|XCTEST_UI|REMOTE_ACCESS_RECORD|REMOTE_ACCESS_REPLAY',
        'webUrl' => '<string>',
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about a test run

The following example gets information about a specific test run.

$result = $client->getRun([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE', // You can get the run ARN by using the list-runs CLI command.
]);

Result syntax:

[
    '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' => ,
        'deviceMinutes' => [
            'metered' => 0,
            'total' => 0,
            'unmetered' => 0,
        ],
        'platform' => 'ANDROID',
        'result' => 'PENDING',
        'status' => 'RUNNING',
        'totalJobs' => 3,
    ],
]

GetSuite

$result = $client->getSuite([/* ... */]);
$promise = $client->getSuiteAsync([/* ... */]);

Parameter Syntax

$result = $client->getSuite([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'suite' => [
        'arn' => '<string>',
        'counters' => [
            'errored' => <integer>,
            'failed' => <integer>,
            'passed' => <integer>,
            'skipped' => <integer>,
            'stopped' => <integer>,
            'total' => <integer>,
            'warned' => <integer>,
        ],
        'created' => <DateTime>,
        'deviceMinutes' => [
            'metered' => <float>,
            'total' => <float>,
            'unmetered' => <float>,
        ],
        'message' => '<string>',
        'name' => '<string>',
        'result' => 'PENDING|PASSED|WARNED|FAILED|SKIPPED|ERRORED|STOPPED',
        'started' => <DateTime>,
        'status' => 'PENDING|PENDING_CONCURRENCY|PENDING_DEVICE|PROCESSING|SCHEDULING|PREPARING|RUNNING|COMPLETED|STOPPING',
        'stopped' => <DateTime>,
        'type' => 'BUILTIN_FUZZ|BUILTIN_EXPLORER|WEB_PERFORMANCE_PROFILE|APPIUM_JAVA_JUNIT|APPIUM_JAVA_TESTNG|APPIUM_PYTHON|APPIUM_NODE|APPIUM_RUBY|APPIUM_WEB_JAVA_JUNIT|APPIUM_WEB_JAVA_TESTNG|APPIUM_WEB_PYTHON|APPIUM_WEB_NODE|APPIUM_WEB_RUBY|CALABASH|INSTRUMENTATION|UIAUTOMATION|UIAUTOMATOR|XCTEST|XCTEST_UI|REMOTE_ACCESS_RECORD|REMOTE_ACCESS_REPLAY',
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about a test suite

The following example gets information about a specific test suite.

$result = $client->getSuite([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:suite:EXAMPLE-GUID-123-456', // You can get the suite ARN by using the list-suites CLI command.
]);

Result syntax:

[
    'suite' => [
    ],
]

GetTest

$result = $client->getTest([/* ... */]);
$promise = $client->getTestAsync([/* ... */]);

Parameter Syntax

$result = $client->getTest([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'test' => [
        'arn' => '<string>',
        'counters' => [
            'errored' => <integer>,
            'failed' => <integer>,
            'passed' => <integer>,
            'skipped' => <integer>,
            'stopped' => <integer>,
            'total' => <integer>,
            'warned' => <integer>,
        ],
        'created' => <DateTime>,
        'deviceMinutes' => [
            'metered' => <float>,
            'total' => <float>,
            'unmetered' => <float>,
        ],
        'message' => '<string>',
        'name' => '<string>',
        'result' => 'PENDING|PASSED|WARNED|FAILED|SKIPPED|ERRORED|STOPPED',
        'started' => <DateTime>,
        'status' => 'PENDING|PENDING_CONCURRENCY|PENDING_DEVICE|PROCESSING|SCHEDULING|PREPARING|RUNNING|COMPLETED|STOPPING',
        'stopped' => <DateTime>,
        'type' => 'BUILTIN_FUZZ|BUILTIN_EXPLORER|WEB_PERFORMANCE_PROFILE|APPIUM_JAVA_JUNIT|APPIUM_JAVA_TESTNG|APPIUM_PYTHON|APPIUM_NODE|APPIUM_RUBY|APPIUM_WEB_JAVA_JUNIT|APPIUM_WEB_JAVA_TESTNG|APPIUM_WEB_PYTHON|APPIUM_WEB_NODE|APPIUM_WEB_RUBY|CALABASH|INSTRUMENTATION|UIAUTOMATION|UIAUTOMATOR|XCTEST|XCTEST_UI|REMOTE_ACCESS_RECORD|REMOTE_ACCESS_REPLAY',
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about a specific test

The following example gets information about a specific test.

$result = $client->getTest([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456', // You can get the test ARN by using the list-tests CLI command.
]);

Result syntax:

[
    'test' => [
    ],
]

GetUpload

$result = $client->getUpload([/* ... */]);
$promise = $client->getUploadAsync([/* ... */]);

Parameter Syntax

$result = $client->getUpload([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'upload' => [
        'arn' => '<string>',
        'category' => 'CURATED|PRIVATE',
        'contentType' => '<string>',
        'created' => <DateTime>,
        'message' => '<string>',
        'metadata' => '<string>',
        'name' => '<string>',
        'status' => 'INITIALIZED|PROCESSING|SUCCEEDED|FAILED',
        'type' => 'ANDROID_APP|IOS_APP|WEB_APP|EXTERNAL_DATA|APPIUM_JAVA_JUNIT_TEST_PACKAGE|APPIUM_JAVA_TESTNG_TEST_PACKAGE|APPIUM_PYTHON_TEST_PACKAGE|APPIUM_NODE_TEST_PACKAGE|APPIUM_RUBY_TEST_PACKAGE|APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE|APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE|APPIUM_WEB_PYTHON_TEST_PACKAGE|APPIUM_WEB_NODE_TEST_PACKAGE|APPIUM_WEB_RUBY_TEST_PACKAGE|CALABASH_TEST_PACKAGE|INSTRUMENTATION_TEST_PACKAGE|UIAUTOMATION_TEST_PACKAGE|UIAUTOMATOR_TEST_PACKAGE|XCTEST_TEST_PACKAGE|XCTEST_UI_TEST_PACKAGE|APPIUM_JAVA_JUNIT_TEST_SPEC|APPIUM_JAVA_TESTNG_TEST_SPEC|APPIUM_PYTHON_TEST_SPEC|APPIUM_NODE_TEST_SPEC|APPIUM_RUBY_TEST_SPEC|APPIUM_WEB_JAVA_JUNIT_TEST_SPEC|APPIUM_WEB_JAVA_TESTNG_TEST_SPEC|APPIUM_WEB_PYTHON_TEST_SPEC|APPIUM_WEB_NODE_TEST_SPEC|APPIUM_WEB_RUBY_TEST_SPEC|INSTRUMENTATION_TEST_SPEC|XCTEST_UI_TEST_SPEC',
        'url' => '<string>',
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about a specific upload

The following example gets information about a specific upload.

$result = $client->getUpload([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456', // You can get the test ARN by using the list-uploads CLI command.
]);

Result syntax:

[
    'upload' => [
    ],
]

GetVPCEConfiguration

$result = $client->getVPCEConfiguration([/* ... */]);
$promise = $client->getVPCEConfigurationAsync([/* ... */]);

Parameter Syntax

$result = $client->getVPCEConfiguration([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'vpceConfiguration' => [
        'arn' => '<string>',
        'serviceDnsName' => '<string>',
        'vpceConfigurationDescription' => '<string>',
        'vpceConfigurationName' => '<string>',
        'vpceServiceName' => '<string>',
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• ServiceAccountException:

  There was a problem with the service account.

InstallToRemoteAccessSession

$result = $client->installToRemoteAccessSession([/* ... */]);
$promise = $client->installToRemoteAccessSessionAsync([/* ... */]);

Parameter Syntax

$result = $client->installToRemoteAccessSession([
    'appArn' => '<string>', // REQUIRED
    'remoteAccessSessionArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appUpload' => [
        'arn' => '<string>',
        'category' => 'CURATED|PRIVATE',
        'contentType' => '<string>',
        'created' => <DateTime>,
        'message' => '<string>',
        'metadata' => '<string>',
        'name' => '<string>',
        'status' => 'INITIALIZED|PROCESSING|SUCCEEDED|FAILED',
        'type' => 'ANDROID_APP|IOS_APP|WEB_APP|EXTERNAL_DATA|APPIUM_JAVA_JUNIT_TEST_PACKAGE|APPIUM_JAVA_TESTNG_TEST_PACKAGE|APPIUM_PYTHON_TEST_PACKAGE|APPIUM_NODE_TEST_PACKAGE|APPIUM_RUBY_TEST_PACKAGE|APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE|APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE|APPIUM_WEB_PYTHON_TEST_PACKAGE|APPIUM_WEB_NODE_TEST_PACKAGE|APPIUM_WEB_RUBY_TEST_PACKAGE|CALABASH_TEST_PACKAGE|INSTRUMENTATION_TEST_PACKAGE|UIAUTOMATION_TEST_PACKAGE|UIAUTOMATOR_TEST_PACKAGE|XCTEST_TEST_PACKAGE|XCTEST_UI_TEST_PACKAGE|APPIUM_JAVA_JUNIT_TEST_SPEC|APPIUM_JAVA_TESTNG_TEST_SPEC|APPIUM_PYTHON_TEST_SPEC|APPIUM_NODE_TEST_SPEC|APPIUM_RUBY_TEST_SPEC|APPIUM_WEB_JAVA_JUNIT_TEST_SPEC|APPIUM_WEB_JAVA_TESTNG_TEST_SPEC|APPIUM_WEB_PYTHON_TEST_SPEC|APPIUM_WEB_NODE_TEST_SPEC|APPIUM_WEB_RUBY_TEST_SPEC|INSTRUMENTATION_TEST_SPEC|XCTEST_UI_TEST_SPEC',
        'url' => '<string>',
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To install to a remote access session

The following example installs a specific app to a device in a specific remote access session.

$result = $client->installToRemoteAccessSession([
    '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', // You can get the remote access session ARN by using the list-remote-access-sessions CLI command.
]);

Result syntax:

[
    'appUpload' => [
    ],
]

ListArtifacts

$result = $client->listArtifacts([/* ... */]);
$promise = $client->listArtifactsAsync([/* ... */]);

Parameter Syntax

$result = $client->listArtifacts([
    'arn' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'type' => 'SCREENSHOT|FILE|LOG', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'artifacts' => [
        [
            'arn' => '<string>',
            'extension' => '<string>',
            'name' => '<string>',
            'type' => 'UNKNOWN|SCREENSHOT|DEVICE_LOG|MESSAGE_LOG|VIDEO_LOG|RESULT_LOG|SERVICE_LOG|WEBKIT_LOG|INSTRUMENTATION_OUTPUT|EXERCISER_MONKEY_OUTPUT|CALABASH_JSON_OUTPUT|CALABASH_PRETTY_OUTPUT|CALABASH_STANDARD_OUTPUT|CALABASH_JAVA_XML_OUTPUT|AUTOMATION_OUTPUT|APPIUM_SERVER_OUTPUT|APPIUM_JAVA_OUTPUT|APPIUM_JAVA_XML_OUTPUT|APPIUM_PYTHON_OUTPUT|APPIUM_PYTHON_XML_OUTPUT|EXPLORER_EVENT_LOG|EXPLORER_SUMMARY_LOG|APPLICATION_CRASH_REPORT|XCTEST_LOG|VIDEO|CUSTOMER_ARTIFACT|CUSTOMER_ARTIFACT_LOG|TESTSPEC_OUTPUT',
            'url' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To list artifacts for a resource

The following example lists screenshot artifacts for a specific run.

$result = $client->listArtifacts([
    'type' => 'SCREENSHOT',
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456', // Can also be used to list artifacts for a Job, Suite, or Test ARN.
]);

ListDeviceInstances

$result = $client->listDeviceInstances([/* ... */]);
$promise = $client->listDeviceInstancesAsync([/* ... */]);

Parameter Syntax

$result = $client->listDeviceInstances([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'deviceInstances' => [
        [
            'arn' => '<string>',
            'deviceArn' => '<string>',
            'instanceProfile' => [
                'arn' => '<string>',
                'description' => '<string>',
                'excludeAppPackagesFromCleanup' => ['<string>', ...],
                'name' => '<string>',
                'packageCleanup' => true || false,
                'rebootAfterUse' => true || false,
            ],
            'labels' => ['<string>', ...],
            'status' => 'IN_USE|PREPARING|AVAILABLE|NOT_AVAILABLE',
            'udid' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

ListDevicePools

$result = $client->listDevicePools([/* ... */]);
$promise = $client->listDevicePoolsAsync([/* ... */]);

Parameter Syntax

$result = $client->listDevicePools([
    'arn' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'type' => 'CURATED|PRIVATE',
]);

Parameter Details

Result Syntax

[
    'devicePools' => [
        [
            'arn' => '<string>',
            'description' => '<string>',
            'maxDevices' => <integer>,
            'name' => '<string>',
            'rules' => [
                [
                    'attribute' => 'ARN|PLATFORM|FORM_FACTOR|MANUFACTURER|REMOTE_ACCESS_ENABLED|REMOTE_DEBUG_ENABLED|APPIUM_VERSION|INSTANCE_ARN|INSTANCE_LABELS|FLEET_TYPE|OS_VERSION|MODEL|AVAILABILITY',
                    'operator' => 'EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|GREATER_THAN|GREATER_THAN_OR_EQUALS|IN|NOT_IN|CONTAINS',
                    'value' => '<string>',
                ],
                // ...
            ],
            'type' => 'CURATED|PRIVATE',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about device pools

The following example returns information about the private device pools in a specific project.

$result = $client->listDevicePools([
    'type' => 'PRIVATE',
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456', // You can get the project ARN by using the list-projects CLI command.
]);

Result syntax:

[
    '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',
                ],
            ],
        ],
    ],
]

ListDevices

$result = $client->listDevices([/* ... */]);
$promise = $client->listDevicesAsync([/* ... */]);

Parameter Syntax

$result = $client->listDevices([
    'arn' => '<string>',
    'filters' => [
        [
            'attribute' => 'ARN|PLATFORM|OS_VERSION|MODEL|AVAILABILITY|FORM_FACTOR|MANUFACTURER|REMOTE_ACCESS_ENABLED|REMOTE_DEBUG_ENABLED|INSTANCE_ARN|INSTANCE_LABELS|FLEET_TYPE',
            'operator' => 'EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|GREATER_THAN|GREATER_THAN_OR_EQUALS|IN|NOT_IN|CONTAINS',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'devices' => [
        [
            'arn' => '<string>',
            'availability' => 'TEMPORARY_NOT_AVAILABLE|BUSY|AVAILABLE|HIGHLY_AVAILABLE',
            'carrier' => '<string>',
            'cpu' => [
                'architecture' => '<string>',
                'clock' => <float>,
                'frequency' => '<string>',
            ],
            'fleetName' => '<string>',
            'fleetType' => '<string>',
            'formFactor' => 'PHONE|TABLET',
            'heapSize' => <integer>,
            'image' => '<string>',
            'instances' => [
                [
                    'arn' => '<string>',
                    'deviceArn' => '<string>',
                    'instanceProfile' => [
                        'arn' => '<string>',
                        'description' => '<string>',
                        'excludeAppPackagesFromCleanup' => ['<string>', ...],
                        'name' => '<string>',
                        'packageCleanup' => true || false,
                        'rebootAfterUse' => true || false,
                    ],
                    'labels' => ['<string>', ...],
                    'status' => 'IN_USE|PREPARING|AVAILABLE|NOT_AVAILABLE',
                    'udid' => '<string>',
                ],
                // ...
            ],
            'manufacturer' => '<string>',
            'memory' => <integer>,
            'model' => '<string>',
            'modelId' => '<string>',
            'name' => '<string>',
            'os' => '<string>',
            'platform' => 'ANDROID|IOS',
            'radio' => '<string>',
            'remoteAccessEnabled' => true || false,
            'remoteDebugEnabled' => true || false,
            'resolution' => [
                'height' => <integer>,
                'width' => <integer>,
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about devices

The following example returns information about the available devices in a specific project.

$result = $client->listDevices([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456', // You can get the project ARN by using the list-projects CLI command.
]);

Result syntax:

[
]

ListInstanceProfiles

$result = $client->listInstanceProfiles([/* ... */]);
$promise = $client->listInstanceProfilesAsync([/* ... */]);

Parameter Syntax

$result = $client->listInstanceProfiles([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'instanceProfiles' => [
        [
            'arn' => '<string>',
            'description' => '<string>',
            'excludeAppPackagesFromCleanup' => ['<string>', ...],
            'name' => '<string>',
            'packageCleanup' => true || false,
            'rebootAfterUse' => true || false,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

ListJobs

$result = $client->listJobs([/* ... */]);
$promise = $client->listJobsAsync([/* ... */]);

Parameter Syntax

$result = $client->listJobs([
    'arn' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'jobs' => [
        [
            'arn' => '<string>',
            'counters' => [
                'errored' => <integer>,
                'failed' => <integer>,
                'passed' => <integer>,
                'skipped' => <integer>,
                'stopped' => <integer>,
                'total' => <integer>,
                'warned' => <integer>,
            ],
            'created' => <DateTime>,
            'device' => [
                'arn' => '<string>',
                'availability' => 'TEMPORARY_NOT_AVAILABLE|BUSY|AVAILABLE|HIGHLY_AVAILABLE',
                'carrier' => '<string>',
                'cpu' => [
                    'architecture' => '<string>',
                    'clock' => <float>,
                    'frequency' => '<string>',
                ],
                'fleetName' => '<string>',
                'fleetType' => '<string>',
                'formFactor' => 'PHONE|TABLET',
                'heapSize' => <integer>,
                'image' => '<string>',
                'instances' => [
                    [
                        'arn' => '<string>',
                        'deviceArn' => '<string>',
                        'instanceProfile' => [
                            'arn' => '<string>',
                            'description' => '<string>',
                            'excludeAppPackagesFromCleanup' => ['<string>', ...],
                            'name' => '<string>',
                            'packageCleanup' => true || false,
                            'rebootAfterUse' => true || false,
                        ],
                        'labels' => ['<string>', ...],
                        'status' => 'IN_USE|PREPARING|AVAILABLE|NOT_AVAILABLE',
                        'udid' => '<string>',
                    ],
                    // ...
                ],
                'manufacturer' => '<string>',
                'memory' => <integer>,
                'model' => '<string>',
                'modelId' => '<string>',
                'name' => '<string>',
                'os' => '<string>',
                'platform' => 'ANDROID|IOS',
                'radio' => '<string>',
                'remoteAccessEnabled' => true || false,
                'remoteDebugEnabled' => true || false,
                'resolution' => [
                    'height' => <integer>,
                    'width' => <integer>,
                ],
            ],
            'deviceMinutes' => [
                'metered' => <float>,
                'total' => <float>,
                'unmetered' => <float>,
            ],
            'instanceArn' => '<string>',
            'message' => '<string>',
            'name' => '<string>',
            'result' => 'PENDING|PASSED|WARNED|FAILED|SKIPPED|ERRORED|STOPPED',
            'started' => <DateTime>,
            'status' => 'PENDING|PENDING_CONCURRENCY|PENDING_DEVICE|PROCESSING|SCHEDULING|PREPARING|RUNNING|COMPLETED|STOPPING',
            'stopped' => <DateTime>,
            'type' => 'BUILTIN_FUZZ|BUILTIN_EXPLORER|WEB_PERFORMANCE_PROFILE|APPIUM_JAVA_JUNIT|APPIUM_JAVA_TESTNG|APPIUM_PYTHON|APPIUM_NODE|APPIUM_RUBY|APPIUM_WEB_JAVA_JUNIT|APPIUM_WEB_JAVA_TESTNG|APPIUM_WEB_PYTHON|APPIUM_WEB_NODE|APPIUM_WEB_RUBY|CALABASH|INSTRUMENTATION|UIAUTOMATION|UIAUTOMATOR|XCTEST|XCTEST_UI|REMOTE_ACCESS_RECORD|REMOTE_ACCESS_REPLAY',
            'videoCapture' => true || false,
            'videoEndpoint' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about jobs

The following example returns information about jobs in a specific project.

$result = $client->listJobs([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456', // You can get the project ARN by using the list-jobs CLI command.
]);

ListNetworkProfiles

$result = $client->listNetworkProfiles([/* ... */]);
$promise = $client->listNetworkProfilesAsync([/* ... */]);

Parameter Syntax

$result = $client->listNetworkProfiles([
    'arn' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'type' => 'CURATED|PRIVATE',
]);

Parameter Details

Result Syntax

[
    'networkProfiles' => [
        [
            'arn' => '<string>',
            'description' => '<string>',
            'downlinkBandwidthBits' => <integer>,
            'downlinkDelayMs' => <integer>,
            'downlinkJitterMs' => <integer>,
            'downlinkLossPercent' => <integer>,
            'name' => '<string>',
            'type' => 'CURATED|PRIVATE',
            'uplinkBandwidthBits' => <integer>,
            'uplinkDelayMs' => <integer>,
            'uplinkJitterMs' => <integer>,
            'uplinkLossPercent' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

ListOfferingPromotions

$result = $client->listOfferingPromotions([/* ... */]);
$promise = $client->listOfferingPromotionsAsync([/* ... */]);

Parameter Syntax

$result = $client->listOfferingPromotions([
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'offeringPromotions' => [
        [
            'description' => '<string>',
            'id' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• NotEligibleException:

  Exception gets thrown when a user is not eligible to perform the specified transaction.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

ListOfferingTransactions

$result = $client->listOfferingTransactions([/* ... */]);
$promise = $client->listOfferingTransactionsAsync([/* ... */]);

Parameter Syntax

$result = $client->listOfferingTransactions([
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'offeringTransactions' => [
        [
            'cost' => [
                'amount' => <float>,
                'currencyCode' => 'USD',
            ],
            'createdOn' => <DateTime>,
            'offeringPromotionId' => '<string>',
            'offeringStatus' => [
                'effectiveOn' => <DateTime>,
                'offering' => [
                    'description' => '<string>',
                    'id' => '<string>',
                    'platform' => 'ANDROID|IOS',
                    'recurringCharges' => [
                        [
                            'cost' => [
                                'amount' => <float>,
                                'currencyCode' => 'USD',
                            ],
                            'frequency' => 'MONTHLY',
                        ],
                        // ...
                    ],
                    'type' => 'RECURRING',
                ],
                'quantity' => <integer>,
                'type' => 'PURCHASE|RENEW|SYSTEM',
            ],
            'transactionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• NotEligibleException:

  Exception gets thrown when a user is not eligible to perform the specified transaction.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about device offering transactions

The following example returns information about Device Farm offering transactions.

$result = $client->listOfferingTransactions([
    'nextToken' => 'RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=', // A dynamically generated value, used for paginating results.
]);

Result syntax:

[
    'offeringTransactions' => [
        [
            'cost' => [
                'amount' => 0,
                'currencyCode' => 'USD',
            ],
            'createdOn' => ,
            'offeringStatus' => [
                'type' => 'RENEW',
                'effectiveOn' => ,
                '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' => ,
            'offeringStatus' => [
                'type' => 'PURCHASE',
                'effectiveOn' => ,
                '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' => ,
            'offeringStatus' => [
                'type' => 'PURCHASE',
                'effectiveOn' => ,
                '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' => ,
            'offeringStatus' => [
                'type' => 'PURCHASE',
                'effectiveOn' => ,
                'offering' => [
                    'type' => 'RECURRING',
                    'description' => 'iOS Unmetered Device Slot',
                    'id' => 'A53D4D73-A6F6-4B82-A0B0-12345EXAMPLE',
                    'platform' => 'IOS',
                ],
                'quantity' => 1,
            ],
            'transactionId' => '2baf9021-ae3e-47f5-ab52-12345EXAMPLE',
        ],
    ],
]

ListOfferings

$result = $client->listOfferings([/* ... */]);
$promise = $client->listOfferingsAsync([/* ... */]);

Parameter Syntax

$result = $client->listOfferings([
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'offerings' => [
        [
            'description' => '<string>',
            'id' => '<string>',
            'platform' => 'ANDROID|IOS',
            'recurringCharges' => [
                [
                    'cost' => [
                        'amount' => <float>,
                        'currencyCode' => 'USD',
                    ],
                    'frequency' => 'MONTHLY',
                ],
                // ...
            ],
            'type' => 'RECURRING',
        ],
        // ...
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• NotEligibleException:

  Exception gets thrown when a user is not eligible to perform the specified transaction.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about device offerings

The following example returns information about available device offerings.

$result = $client->listOfferings([
    'nextToken' => 'RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=', // A dynamically generated value, used for paginating results.
]);

Result syntax:

[
    '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',
                ],
            ],
        ],
    ],
]

ListProjects

$result = $client->listProjects([/* ... */]);
$promise = $client->listProjectsAsync([/* ... */]);

Parameter Syntax

$result = $client->listProjects([
    'arn' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'projects' => [
        [
            'arn' => '<string>',
            'created' => <DateTime>,
            'defaultJobTimeoutMinutes' => <integer>,
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about a Device Farm project

The following example returns information about the specified project in Device Farm.

$result = $client->listProjects([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE',
    'nextToken' => 'RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE', // A dynamically generated value, used for paginating results.
]);

Result syntax:

[
    'projects' => [
        [
            'name' => 'My Test Project',
            'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE',
            'created' => ,
        ],
        [
            'name' => 'Hello World',
            'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:d6b087d9-56db-4e44-b9ec-12345EXAMPLE',
            'created' => ,
        ],
    ],
]

ListRemoteAccessSessions

$result = $client->listRemoteAccessSessions([/* ... */]);
$promise = $client->listRemoteAccessSessionsAsync([/* ... */]);

Parameter Syntax

$result = $client->listRemoteAccessSessions([
    'arn' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'remoteAccessSessions' => [
        [
            'arn' => '<string>',
            'billingMethod' => 'METERED|UNMETERED',
            'clientId' => '<string>',
            'created' => <DateTime>,
            'device' => [
                'arn' => '<string>',
                'availability' => 'TEMPORARY_NOT_AVAILABLE|BUSY|AVAILABLE|HIGHLY_AVAILABLE',
                'carrier' => '<string>',
                'cpu' => [
                    'architecture' => '<string>',
                    'clock' => <float>,
                    'frequency' => '<string>',
                ],
                'fleetName' => '<string>',
                'fleetType' => '<string>',
                'formFactor' => 'PHONE|TABLET',
                'heapSize' => <integer>,
                'image' => '<string>',
                'instances' => [
                    [
                        'arn' => '<string>',
                        'deviceArn' => '<string>',
                        'instanceProfile' => [
                            'arn' => '<string>',
                            'description' => '<string>',
                            'excludeAppPackagesFromCleanup' => ['<string>', ...],
                            'name' => '<string>',
                            'packageCleanup' => true || false,
                            'rebootAfterUse' => true || false,
                        ],
                        'labels' => ['<string>', ...],
                        'status' => 'IN_USE|PREPARING|AVAILABLE|NOT_AVAILABLE',
                        'udid' => '<string>',
                    ],
                    // ...
                ],
                'manufacturer' => '<string>',
                'memory' => <integer>,
                'model' => '<string>',
                'modelId' => '<string>',
                'name' => '<string>',
                'os' => '<string>',
                'platform' => 'ANDROID|IOS',
                'radio' => '<string>',
                'remoteAccessEnabled' => true || false,
                'remoteDebugEnabled' => true || false,
                'resolution' => [
                    'height' => <integer>,
                    'width' => <integer>,
                ],
            ],
            'deviceMinutes' => [
                'metered' => <float>,
                'total' => <float>,
                'unmetered' => <float>,
            ],
            'deviceUdid' => '<string>',
            'endpoint' => '<string>',
            'hostAddress' => '<string>',
            'instanceArn' => '<string>',
            'interactionMode' => 'INTERACTIVE|NO_VIDEO|VIDEO_ONLY',
            'message' => '<string>',
            'name' => '<string>',
            'remoteDebugEnabled' => true || false,
            'remoteRecordAppArn' => '<string>',
            'remoteRecordEnabled' => true || false,
            'result' => 'PENDING|PASSED|WARNED|FAILED|SKIPPED|ERRORED|STOPPED',
            'skipAppResign' => true || false,
            'started' => <DateTime>,
            'status' => 'PENDING|PENDING_CONCURRENCY|PENDING_DEVICE|PROCESSING|SCHEDULING|PREPARING|RUNNING|COMPLETED|STOPPING',
            'stopped' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about a remote access session

The following example returns information about a specific Device Farm remote access session.

$result = $client->listRemoteAccessSessions([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456', // You can get the Amazon Resource Name (ARN) of the session by using the list-sessions CLI command.
    'nextToken' => 'RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=', // A dynamically generated value, used for paginating results.
]);

Result syntax:

[
    'remoteAccessSessions' => [
    ],
]

ListRuns

$result = $client->listRuns([/* ... */]);
$promise = $client->listRunsAsync([/* ... */]);

Parameter Syntax

$result = $client->listRuns([
    'arn' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'runs' => [
        [
            'appUpload' => '<string>',
            'arn' => '<string>',
            'billingMethod' => 'METERED|UNMETERED',
            'completedJobs' => <integer>,
            'counters' => [
                'errored' => <integer>,
                'failed' => <integer>,
                'passed' => <integer>,
                'skipped' => <integer>,
                'stopped' => <integer>,
                'total' => <integer>,
                'warned' => <integer>,
            ],
            'created' => <DateTime>,
            'customerArtifactPaths' => [
                'androidPaths' => ['<string>', ...],
                'deviceHostPaths' => ['<string>', ...],
                'iosPaths' => ['<string>', ...],
            ],
            'deviceMinutes' => [
                'metered' => <float>,
                'total' => <float>,
                'unmetered' => <float>,
            ],
            'devicePoolArn' => '<string>',
            'deviceSelectionResult' => [
                'filters' => [
                    [
                        'attribute' => 'ARN|PLATFORM|OS_VERSION|MODEL|AVAILABILITY|FORM_FACTOR|MANUFACTURER|REMOTE_ACCESS_ENABLED|REMOTE_DEBUG_ENABLED|INSTANCE_ARN|INSTANCE_LABELS|FLEET_TYPE',
                        'operator' => 'EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|GREATER_THAN|GREATER_THAN_OR_EQUALS|IN|NOT_IN|CONTAINS',
                        'values' => ['<string>', ...],
                    ],
                    // ...
                ],
                'matchedDevicesCount' => <integer>,
                'maxDevices' => <integer>,
            ],
            'eventCount' => <integer>,
            'jobTimeoutMinutes' => <integer>,
            'locale' => '<string>',
            'location' => [
                'latitude' => <float>,
                'longitude' => <float>,
            ],
            'message' => '<string>',
            'name' => '<string>',
            'networkProfile' => [
                'arn' => '<string>',
                'description' => '<string>',
                'downlinkBandwidthBits' => <integer>,
                'downlinkDelayMs' => <integer>,
                'downlinkJitterMs' => <integer>,
                'downlinkLossPercent' => <integer>,
                'name' => '<string>',
                'type' => 'CURATED|PRIVATE',
                'uplinkBandwidthBits' => <integer>,
                'uplinkDelayMs' => <integer>,
                'uplinkJitterMs' => <integer>,
                'uplinkLossPercent' => <integer>,
            ],
            'parsingResultUrl' => '<string>',
            'platform' => 'ANDROID|IOS',
            'radios' => [
                'bluetooth' => true || false,
                'gps' => true || false,
                'nfc' => true || false,
                'wifi' => true || false,
            ],
            'result' => 'PENDING|PASSED|WARNED|FAILED|SKIPPED|ERRORED|STOPPED',
            'resultCode' => 'PARSING_FAILED|VPC_ENDPOINT_SETUP_FAILED',
            'seed' => <integer>,
            'skipAppResign' => true || false,
            'started' => <DateTime>,
            'status' => 'PENDING|PENDING_CONCURRENCY|PENDING_DEVICE|PROCESSING|SCHEDULING|PREPARING|RUNNING|COMPLETED|STOPPING',
            'stopped' => <DateTime>,
            'testSpecArn' => '<string>',
            'totalJobs' => <integer>,
            'type' => 'BUILTIN_FUZZ|BUILTIN_EXPLORER|WEB_PERFORMANCE_PROFILE|APPIUM_JAVA_JUNIT|APPIUM_JAVA_TESTNG|APPIUM_PYTHON|APPIUM_NODE|APPIUM_RUBY|APPIUM_WEB_JAVA_JUNIT|APPIUM_WEB_JAVA_TESTNG|APPIUM_WEB_PYTHON|APPIUM_WEB_NODE|APPIUM_WEB_RUBY|CALABASH|INSTRUMENTATION|UIAUTOMATION|UIAUTOMATOR|XCTEST|XCTEST_UI|REMOTE_ACCESS_RECORD|REMOTE_ACCESS_REPLAY',
            'webUrl' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about a test run

The following example returns information about a specific test run.

$result = $client->listRuns([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE', // You can get the Amazon Resource Name (ARN) of the run by using the list-runs CLI command.
    'nextToken' => 'RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE', // A dynamically generated value, used for paginating results.
]);

Result syntax:

[
    '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' => ,
            'deviceMinutes' => [
                'metered' => 0,
                'total' => 0,
                'unmetered' => 0,
            ],
            'platform' => 'ANDROID',
            'result' => 'PENDING',
            'status' => 'RUNNING',
            'totalJobs' => 3,
        ],
    ],
]

ListSamples

$result = $client->listSamples([/* ... */]);
$promise = $client->listSamplesAsync([/* ... */]);

Parameter Syntax

$result = $client->listSamples([
    'arn' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'samples' => [
        [
            'arn' => '<string>',
            'type' => 'CPU|MEMORY|THREADS|RX_RATE|TX_RATE|RX|TX|NATIVE_FRAMES|NATIVE_FPS|NATIVE_MIN_DRAWTIME|NATIVE_AVG_DRAWTIME|NATIVE_MAX_DRAWTIME|OPENGL_FRAMES|OPENGL_FPS|OPENGL_MIN_DRAWTIME|OPENGL_AVG_DRAWTIME|OPENGL_MAX_DRAWTIME',
            'url' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about samples

The following example returns information about samples, given a specific Device Farm project.

$result = $client->listSamples([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456', // You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.
    'nextToken' => 'RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE', // A dynamically generated value, used for paginating results.
]);

Result syntax:

[
    'samples' => [
    ],
]

ListSuites

$result = $client->listSuites([/* ... */]);
$promise = $client->listSuitesAsync([/* ... */]);

Parameter Syntax

$result = $client->listSuites([
    'arn' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'suites' => [
        [
            'arn' => '<string>',
            'counters' => [
                'errored' => <integer>,
                'failed' => <integer>,
                'passed' => <integer>,
                'skipped' => <integer>,
                'stopped' => <integer>,
                'total' => <integer>,
                'warned' => <integer>,
            ],
            'created' => <DateTime>,
            'deviceMinutes' => [
                'metered' => <float>,
                'total' => <float>,
                'unmetered' => <float>,
            ],
            'message' => '<string>',
            'name' => '<string>',
            'result' => 'PENDING|PASSED|WARNED|FAILED|SKIPPED|ERRORED|STOPPED',
            'started' => <DateTime>,
            'status' => 'PENDING|PENDING_CONCURRENCY|PENDING_DEVICE|PROCESSING|SCHEDULING|PREPARING|RUNNING|COMPLETED|STOPPING',
            'stopped' => <DateTime>,
            'type' => 'BUILTIN_FUZZ|BUILTIN_EXPLORER|WEB_PERFORMANCE_PROFILE|APPIUM_JAVA_JUNIT|APPIUM_JAVA_TESTNG|APPIUM_PYTHON|APPIUM_NODE|APPIUM_RUBY|APPIUM_WEB_JAVA_JUNIT|APPIUM_WEB_JAVA_TESTNG|APPIUM_WEB_PYTHON|APPIUM_WEB_NODE|APPIUM_WEB_RUBY|CALABASH|INSTRUMENTATION|UIAUTOMATION|UIAUTOMATOR|XCTEST|XCTEST_UI|REMOTE_ACCESS_RECORD|REMOTE_ACCESS_REPLAY',
        ],
        // ...
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about suites

The following example returns information about suites, given a specific Device Farm job.

$result = $client->listSuites([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:job:EXAMPLE-GUID-123-456', // You can get the Amazon Resource Name (ARN) of the job by using the list-jobs CLI command.
    'nextToken' => 'RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE', // A dynamically generated value, used for paginating results.
]);

Result syntax:

[
    'suites' => [
    ],
]

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• NotFoundException:

  The specified entity was not found.

• TagOperationException:

  The operation was not successful. Try again.

ListTests

$result = $client->listTests([/* ... */]);
$promise = $client->listTestsAsync([/* ... */]);

Parameter Syntax

$result = $client->listTests([
    'arn' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'tests' => [
        [
            'arn' => '<string>',
            'counters' => [
                'errored' => <integer>,
                'failed' => <integer>,
                'passed' => <integer>,
                'skipped' => <integer>,
                'stopped' => <integer>,
                'total' => <integer>,
                'warned' => <integer>,
            ],
            'created' => <DateTime>,
            'deviceMinutes' => [
                'metered' => <float>,
                'total' => <float>,
                'unmetered' => <float>,
            ],
            'message' => '<string>',
            'name' => '<string>',
            'result' => 'PENDING|PASSED|WARNED|FAILED|SKIPPED|ERRORED|STOPPED',
            'started' => <DateTime>,
            'status' => 'PENDING|PENDING_CONCURRENCY|PENDING_DEVICE|PROCESSING|SCHEDULING|PREPARING|RUNNING|COMPLETED|STOPPING',
            'stopped' => <DateTime>,
            'type' => 'BUILTIN_FUZZ|BUILTIN_EXPLORER|WEB_PERFORMANCE_PROFILE|APPIUM_JAVA_JUNIT|APPIUM_JAVA_TESTNG|APPIUM_PYTHON|APPIUM_NODE|APPIUM_RUBY|APPIUM_WEB_JAVA_JUNIT|APPIUM_WEB_JAVA_TESTNG|APPIUM_WEB_PYTHON|APPIUM_WEB_NODE|APPIUM_WEB_RUBY|CALABASH|INSTRUMENTATION|UIAUTOMATION|UIAUTOMATOR|XCTEST|XCTEST_UI|REMOTE_ACCESS_RECORD|REMOTE_ACCESS_REPLAY',
        ],
        // ...
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about tests

The following example returns information about tests, given a specific Device Farm project.

$result = $client->listTests([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456', // You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.
    'nextToken' => 'RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE', // A dynamically generated value, used for paginating results.
]);

Result syntax:

[
    'tests' => [
    ],
]

ListUniqueProblems

$result = $client->listUniqueProblems([/* ... */]);
$promise = $client->listUniqueProblemsAsync([/* ... */]);

Parameter Syntax

$result = $client->listUniqueProblems([
    'arn' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'uniqueProblems' => [
        '<ExecutionResult>' => [
            [
                'message' => '<string>',
                'problems' => [
                    [
                        'device' => [
                            'arn' => '<string>',
                            'availability' => 'TEMPORARY_NOT_AVAILABLE|BUSY|AVAILABLE|HIGHLY_AVAILABLE',
                            'carrier' => '<string>',
                            'cpu' => [
                                'architecture' => '<string>',
                                'clock' => <float>,
                                'frequency' => '<string>',
                            ],
                            'fleetName' => '<string>',
                            'fleetType' => '<string>',
                            'formFactor' => 'PHONE|TABLET',
                            'heapSize' => <integer>,
                            'image' => '<string>',
                            'instances' => [
                                [
                                    'arn' => '<string>',
                                    'deviceArn' => '<string>',
                                    'instanceProfile' => [
                                        'arn' => '<string>',
                                        'description' => '<string>',
                                        'excludeAppPackagesFromCleanup' => ['<string>', ...],
                                        'name' => '<string>',
                                        'packageCleanup' => true || false,
                                        'rebootAfterUse' => true || false,
                                    ],
                                    'labels' => ['<string>', ...],
                                    'status' => 'IN_USE|PREPARING|AVAILABLE|NOT_AVAILABLE',
                                    'udid' => '<string>',
                                ],
                                // ...
                            ],
                            'manufacturer' => '<string>',
                            'memory' => <integer>,
                            'model' => '<string>',
                            'modelId' => '<string>',
                            'name' => '<string>',
                            'os' => '<string>',
                            'platform' => 'ANDROID|IOS',
                            'radio' => '<string>',
                            'remoteAccessEnabled' => true || false,
                            'remoteDebugEnabled' => true || false,
                            'resolution' => [
                                'height' => <integer>,
                                'width' => <integer>,
                            ],
                        ],
                        'job' => [
                            'arn' => '<string>',
                            'name' => '<string>',
                        ],
                        'message' => '<string>',
                        'result' => 'PENDING|PASSED|WARNED|FAILED|SKIPPED|ERRORED|STOPPED',
                        'run' => [
                            'arn' => '<string>',
                            'name' => '<string>',
                        ],
                        'suite' => [
                            'arn' => '<string>',
                            'name' => '<string>',
                        ],
                        'test' => [
                            'arn' => '<string>',
                            'name' => '<string>',
                        ],
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        // ...
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about unique problems

The following example returns information about unique problems, given a specific Device Farm project.

$result = $client->listUniqueProblems([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456', // You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.
    'nextToken' => 'RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE', // A dynamically generated value, used for paginating results.
]);

Result syntax:

[
    'uniqueProblems' => [
    ],
]

ListUploads

$result = $client->listUploads([/* ... */]);
$promise = $client->listUploadsAsync([/* ... */]);

Parameter Syntax

$result = $client->listUploads([
    'arn' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'type' => 'ANDROID_APP|IOS_APP|WEB_APP|EXTERNAL_DATA|APPIUM_JAVA_JUNIT_TEST_PACKAGE|APPIUM_JAVA_TESTNG_TEST_PACKAGE|APPIUM_PYTHON_TEST_PACKAGE|APPIUM_NODE_TEST_PACKAGE|APPIUM_RUBY_TEST_PACKAGE|APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE|APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE|APPIUM_WEB_PYTHON_TEST_PACKAGE|APPIUM_WEB_NODE_TEST_PACKAGE|APPIUM_WEB_RUBY_TEST_PACKAGE|CALABASH_TEST_PACKAGE|INSTRUMENTATION_TEST_PACKAGE|UIAUTOMATION_TEST_PACKAGE|UIAUTOMATOR_TEST_PACKAGE|XCTEST_TEST_PACKAGE|XCTEST_UI_TEST_PACKAGE|APPIUM_JAVA_JUNIT_TEST_SPEC|APPIUM_JAVA_TESTNG_TEST_SPEC|APPIUM_PYTHON_TEST_SPEC|APPIUM_NODE_TEST_SPEC|APPIUM_RUBY_TEST_SPEC|APPIUM_WEB_JAVA_JUNIT_TEST_SPEC|APPIUM_WEB_JAVA_TESTNG_TEST_SPEC|APPIUM_WEB_PYTHON_TEST_SPEC|APPIUM_WEB_NODE_TEST_SPEC|APPIUM_WEB_RUBY_TEST_SPEC|INSTRUMENTATION_TEST_SPEC|XCTEST_UI_TEST_SPEC',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'uploads' => [
        [
            'arn' => '<string>',
            'category' => 'CURATED|PRIVATE',
            'contentType' => '<string>',
            'created' => <DateTime>,
            'message' => '<string>',
            'metadata' => '<string>',
            'name' => '<string>',
            'status' => 'INITIALIZED|PROCESSING|SUCCEEDED|FAILED',
            'type' => 'ANDROID_APP|IOS_APP|WEB_APP|EXTERNAL_DATA|APPIUM_JAVA_JUNIT_TEST_PACKAGE|APPIUM_JAVA_TESTNG_TEST_PACKAGE|APPIUM_PYTHON_TEST_PACKAGE|APPIUM_NODE_TEST_PACKAGE|APPIUM_RUBY_TEST_PACKAGE|APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE|APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE|APPIUM_WEB_PYTHON_TEST_PACKAGE|APPIUM_WEB_NODE_TEST_PACKAGE|APPIUM_WEB_RUBY_TEST_PACKAGE|CALABASH_TEST_PACKAGE|INSTRUMENTATION_TEST_PACKAGE|UIAUTOMATION_TEST_PACKAGE|UIAUTOMATOR_TEST_PACKAGE|XCTEST_TEST_PACKAGE|XCTEST_UI_TEST_PACKAGE|APPIUM_JAVA_JUNIT_TEST_SPEC|APPIUM_JAVA_TESTNG_TEST_SPEC|APPIUM_PYTHON_TEST_SPEC|APPIUM_NODE_TEST_SPEC|APPIUM_RUBY_TEST_SPEC|APPIUM_WEB_JAVA_JUNIT_TEST_SPEC|APPIUM_WEB_JAVA_TESTNG_TEST_SPEC|APPIUM_WEB_PYTHON_TEST_SPEC|APPIUM_WEB_NODE_TEST_SPEC|APPIUM_WEB_RUBY_TEST_SPEC|INSTRUMENTATION_TEST_SPEC|XCTEST_UI_TEST_SPEC',
            'url' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To get information about uploads

The following example returns information about uploads, given a specific Device Farm project.

$result = $client->listUploads([
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456', // You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.
    'nextToken' => 'RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE', // A dynamically generated value, used for paginating results.
]);

Result syntax:

[
    'uploads' => [
    ],
]

ListVPCEConfigurations

$result = $client->listVPCEConfigurations([/* ... */]);
$promise = $client->listVPCEConfigurationsAsync([/* ... */]);

Parameter Syntax

$result = $client->listVPCEConfigurations([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'vpceConfigurations' => [
        [
            'arn' => '<string>',
            'serviceDnsName' => '<string>',
            'vpceConfigurationDescription' => '<string>',
            'vpceConfigurationName' => '<string>',
            'vpceServiceName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• ServiceAccountException:

  There was a problem with the service account.

PurchaseOffering

$result = $client->purchaseOffering([/* ... */]);
$promise = $client->purchaseOfferingAsync([/* ... */]);

Parameter Syntax

$result = $client->purchaseOffering([
    'offeringId' => '<string>',
    'offeringPromotionId' => '<string>',
    'quantity' => <integer>,
]);

Parameter Details

Result Syntax

[
    'offeringTransaction' => [
        'cost' => [
            'amount' => <float>,
            'currencyCode' => 'USD',
        ],
        'createdOn' => <DateTime>,
        'offeringPromotionId' => '<string>',
        'offeringStatus' => [
            'effectiveOn' => <DateTime>,
            'offering' => [
                'description' => '<string>',
                'id' => '<string>',
                'platform' => 'ANDROID|IOS',
                'recurringCharges' => [
                    [
                        'cost' => [
                            'amount' => <float>,
                            'currencyCode' => 'USD',
                        ],
                        'frequency' => 'MONTHLY',
                    ],
                    // ...
                ],
                'type' => 'RECURRING',
            ],
            'quantity' => <integer>,
            'type' => 'PURCHASE|RENEW|SYSTEM',
        ],
        'transactionId' => '<string>',
    ],
]

Result Details

Errors

• ArgumentException:

  An invalid argument was specified.

• NotFoundException:

  The specified entity was not found.

• NotEligibleException:

  Exception gets thrown when a user is not eligible to perform the specified transaction.

• LimitExceededException:

  A limit was exceeded.

• ServiceAccountException:

  There was a problem with the service account.

Examples

Example 1: To purchase a device slot offering

The following example purchases a specific device slot offering.

$result = $client->purchaseOffering([
    'offeringId' => 'D68B3C05-1BA6-4360-BC69-12345EXAMPLE', // You can get the offering ID by using the list-offerings CLI command.
    'quantity' => 1,
]);

Result syntax:

[
    'offeringTransaction' => [
        'cost' => [
            'amount' => 8.07,
            'currencyCode' => 'USD',
        ],
        'createdOn' => ,
        'offeringStatus' => [
            'type' => 'PURCHASE',
            'effectiveOn' => ,
            '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',
    ],
]

RenewOffering

$result = $client->renewOffering([/* ... */]);
$promise = $client->renewOfferingAsync([/* ... */]);

Parameter Syntax

$result = $client->renewOffering([
    'offeringId' => '<string>',
    'quantity' => <integer>,
]);

Parameter Details