CreateDevicePool

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

Creates a device pool.

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([/* ... */]);

Creates a profile that can be applied to one or more private fleet device instances.

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([/* ... */]);

Creates a network profile.

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([/* ... */]);

Creates a project.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'project' => [
        'arn' => '<string>',
        'created' => <DateTime>,
        'defaultJobTimeoutMinutes' => <integer>,
        'name' => '<string>',
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<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([/* ... */]);

Specifies and starts a remote access session.

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>,
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<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 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' => [
    ],
]

CreateTestGridProject

$result = $client->createTestGridProject([/* ... */]);
$promise = $client->createTestGridProjectAsync([/* ... */]);

Creates a Selenium testing project. Projects are used to track TestGridSession instances.

Parameter Syntax

$result = $client->createTestGridProject([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'vpcConfig' => [
        'securityGroupIds' => ['<string>', ...], // REQUIRED
        'subnetIds' => ['<string>', ...], // REQUIRED
        'vpcId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'testGridProject' => [
        'arn' => '<string>',
        'created' => <DateTime>,
        'description' => '<string>',
        'name' => '<string>',
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
    ],
]

Result Details

Errors

ArgumentException:

An invalid argument was specified.

LimitExceededException:

A limit was exceeded.

InternalServiceException:

An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this error.

CreateTestGridUrl

$result = $client->createTestGridUrl([/* ... */]);
$promise = $client->createTestGridUrlAsync([/* ... */]);

Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.

Parameter Syntax

$result = $client->createTestGridUrl([
    'expiresInSeconds' => <integer>, // REQUIRED
    'projectArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'expires' => <DateTime>,
    'url' => '<string>',
]

Result Details

Errors

NotFoundException:

The specified entity was not found.

ArgumentException:

An invalid argument was specified.

InternalServiceException:

An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this error.

CreateUpload

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

Uploads an app or test scripts.

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([/* ... */]);

Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.

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([/* ... */]);

Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.

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([/* ... */]);

Deletes a profile that can be applied to one or more private device instances.

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([/* ... */]);

Deletes a network profile.

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([/* ... */]);

Deletes an AWS Device Farm project, given the project ARN.

Deleting this resource does not stop an in-progress run.

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([/* ... */]);

Deletes a completed remote access session and its results.

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([/* ... */]);

Deletes the run, given the run ARN.

Deleting this resource does not stop an in-progress run.

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:

[
]

DeleteTestGridProject

$result = $client->deleteTestGridProject([/* ... */]);
$promise = $client->deleteTestGridProjectAsync([/* ... */]);

Deletes a Selenium testing project and all content generated under it.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The specified entity was not found.

ArgumentException:

An invalid argument was specified.

CannotDeleteException:

The requested object could not be deleted.

InternalServiceException:

An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this error.

DeleteUpload

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

Deletes an upload given the upload ARN.

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([/* ... */]);

Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.

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([/* ... */]);

Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.

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([/* ... */]);

Gets information about a unique device type.

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([/* ... */]);

Returns information about a device instance that belongs to a private device fleet.

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([/* ... */]);

Gets information about a device pool.

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([/* ... */]);

Gets information about compatibility with a device pool.

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([/* ... */]);

Returns information about the specified instance profile.

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([/* ... */]);

Gets information about a job.

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([/* ... */]);

Returns information about a network profile.

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([/* ... */]);

Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

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([/* ... */]);

Gets information about a project.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'project' => [
        'arn' => '<string>',
        'created' => <DateTime>,
        'defaultJobTimeoutMinutes' => <integer>,
        'name' => '<string>',
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<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([/* ... */]);

Returns a link to a currently running remote access session.

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>,
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<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 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([/* ... */]);

Gets information about a run.

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',
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        '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([/* ... */]);

Gets information about a suite.

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([/* ... */]);

Gets information about a test.

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

GetTestGridProject

$result = $client->getTestGridProject([/* ... */]);
$promise = $client->getTestGridProjectAsync([/* ... */]);

Retrieves information about a Selenium testing project.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'testGridProject' => [
        'arn' => '<string>',
        'created' => <DateTime>,
        'description' => '<string>',
        'name' => '<string>',
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
    ],
]

Result Details

Errors

NotFoundException:

The specified entity was not found.

ArgumentException:

An invalid argument was specified.

InternalServiceException:

An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this error.

GetTestGridSession

$result = $client->getTestGridSession([/* ... */]);
$promise = $client->getTestGridSessionAsync([/* ... */]);

A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrlResult$url. You can use the following to look up sessions:

• The session ARN (GetTestGridSessionRequest$sessionArn).

• The project ARN and a session ID (GetTestGridSessionRequest$projectArn and GetTestGridSessionRequest$sessionId).

Parameter Syntax

$result = $client->getTestGridSession([
    'projectArn' => '<string>',
    'sessionArn' => '<string>',
    'sessionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'testGridSession' => [
        'arn' => '<string>',
        'billingMinutes' => <float>,
        'created' => <DateTime>,
        'ended' => <DateTime>,
        'seleniumProperties' => '<string>',
        'status' => 'ACTIVE|CLOSED|ERRORED',
    ],
]

Result Details

Errors

NotFoundException:

The specified entity was not found.

ArgumentException:

An invalid argument was specified.

InternalServiceException:

An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this error.

GetUpload

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

Gets information about an upload.

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([/* ... */]);

Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.

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([/* ... */]);

Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.

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([/* ... */]);

Gets information about artifacts.

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([/* ... */]);

Returns information about the private device instances associated with one or more AWS accounts.

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([/* ... */]);

Gets information about device pools.

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([/* ... */]);

Gets information about unique device types.

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', // REQUIRED
            'operator' => 'EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|GREATER_THAN|GREATER_THAN_OR_EQUALS|IN|NOT_IN|CONTAINS', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    '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([/* ... */]);

Returns information about all the instance profiles in an AWS account.

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([/* ... */]);

Gets information about jobs for a given test run.

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([/* ... */]);

Returns the list of available network profiles.

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([/* ... */]);

Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you must be able to invoke this operation.

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([/* ... */]);

Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

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([/* ... */]);

Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

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([/* ... */]);

Gets information about projects.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'projects' => [
        [
            'arn' => '<string>',
            'created' => <DateTime>,
            'defaultJobTimeoutMinutes' => <integer>,
            'name' => '<string>',
            'vpcConfig' => [
                'securityGroupIds' => ['<string>', ...],
                'subnetIds' => ['<string>', ...],
                'vpcId' => '<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([/* ... */]);

Returns a list of all currently running remote access sessions.

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>,
            'vpcConfig' => [
                'securityGroupIds' => ['<string>', ...],
                'subnetIds' => ['<string>', ...],
                'vpcId' => '<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 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([/* ... */]);

Gets information about runs, given an AWS Device Farm project ARN.

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',
            'vpcConfig' => [
                'securityGroupIds' => ['<string>', ...],
                'subnetIds' => ['<string>', ...],
                'vpcId' => '<string>',
            ],
            '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([/* ... */]);

Gets information about samples, given an AWS Device Farm job ARN.

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([/* ... */]);

Gets information about test suites for a given job.

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([/* ... */]);

List the tags for an AWS Device Farm resource.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ArgumentException:

An invalid argument was specified.

NotFoundException:

The specified entity was not found.

TagOperationException:

The operation was not successful. Try again.

ListTestGridProjects

$result = $client->listTestGridProjects([/* ... */]);
$promise = $client->listTestGridProjectsAsync([/* ... */]);

Gets a list of all Selenium testing projects in your account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'testGridProjects' => [
        [
            'arn' => '<string>',
            'created' => <DateTime>,
            'description' => '<string>',
            'name' => '<string>',
            'vpcConfig' => [
                'securityGroupIds' => ['<string>', ...],
                'subnetIds' => ['<string>', ...],
                'vpcId' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ArgumentException:

An invalid argument was specified.

InternalServiceException:

An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this error.

ListTestGridSessionActions

$result = $client->listTestGridSessionActions([/* ... */]);
$promise = $client->listTestGridSessionActionsAsync([/* ... */]);

Returns a list of the actions taken in a TestGridSession.

Parameter Syntax

$result = $client->listTestGridSessionActions([
    'maxResult' => <integer>,
    'nextToken' => '<string>',
    'sessionArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'actions' => [
        [
            'action' => '<string>',
            'duration' => <integer>,
            'requestMethod' => '<string>',
            'started' => <DateTime>,
            'statusCode' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

NotFoundException:

The specified entity was not found.

ArgumentException:

An invalid argument was specified.

InternalServiceException:

An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this error.

ListTestGridSessionArtifacts

$result = $client->listTestGridSessionArtifacts([/* ... */]);
$promise = $client->listTestGridSessionArtifactsAsync([/* ... */]);

Retrieves a list of artifacts created during the session.

Parameter Syntax

$result = $client->listTestGridSessionArtifacts([
    'maxResult' => <integer>,
    'nextToken' => '<string>',
    'sessionArn' => '<string>', // REQUIRED
    'type' => 'VIDEO|LOG',
]);

Parameter Details

Result Syntax

[
    'artifacts' => [
        [
            'filename' => '<string>',
            'type' => 'UNKNOWN|VIDEO|SELENIUM_LOG',
            'url' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

NotFoundException:

The specified entity was not found.

ArgumentException:

An invalid argument was specified.

InternalServiceException:

An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this error.

ListTestGridSessions

$result = $client->listTestGridSessions([/* ... */]);
$promise = $client->listTestGridSessionsAsync([/* ... */]);

Retrieves a list of sessions for a TestGridProject.

Parameter Syntax

$result = $client->listTestGridSessions([
    'creationTimeAfter' => <integer || string || DateTime>,
    'creationTimeBefore' => <integer || string || DateTime>,
    'endTimeAfter' => <integer || string || DateTime>,
    'endTimeBefore' => <integer || string || DateTime>,
    'maxResult' => <integer>,
    'nextToken' => '<string>',
    'projectArn' => '<string>', // REQUIRED
    'status' => 'ACTIVE|CLOSED|ERRORED',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'testGridSessions' => [
        [
            'arn' => '<string>',
            'billingMinutes' => <float>,
            'created' => <DateTime>,
            'ended' => <DateTime>,
            'seleniumProperties' => '<string>',
            'status' => 'ACTIVE|CLOSED|ERRORED',
        ],
        // ...
    ],
]

Result Details

Errors

NotFoundException:

The specified entity was not found.

ArgumentException:

An invalid argument was specified.

InternalServiceException:

An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this error.

ListTests

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

Gets information about tests in a given test suite.

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([/* ... */]);

Gets information about unique problems, such as exceptions or crashes.

Unique problems are defined as a single instance of an error across a run, job, or suite. For example, if a call in your application consistently raises an exception (OutOfBoundsException in MyActivity.java:386), ListUniqueProblems returns a single entry instead of many individual entries for that exception.

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([/* ... */]);

Gets information about uploads, given an AWS Device Farm project ARN.

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([/* ... */]);

Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.

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([/* ... */]);

Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

Parameter Syntax

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

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([/* ... */]);

Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

Parameter Syntax

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

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 renew a device slot offering

The following example renews a specific device slot offering.

$result = $client->renewOffering([
    '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' => 250,
            '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' => 1,
        ],
        'transactionId' => 'e90f1405-8c35-4561-be43-12345EXAMPLE',
    ],
]

ScheduleRun

$result = $client->scheduleRun([/* ... */]);
$promise = $client->scheduleRunAsync([/* ... */]);

Schedules a run.

Parameter Syntax

$result = $client->scheduleRun([
    '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>',
    'deviceSelectionConfiguration' => [
        'filters' => [ // REQUIRED
            [
                'attribute' => 'ARN|PLATFORM|OS_VERSION|MODEL|AVAILABILITY|FORM_FACTOR|MANUFACTURER|REMOTE_ACCESS_ENABLED|REMOTE_DEBUG_ENABLED|INSTANCE_ARN|INSTANCE_LABELS|FLEET_TYPE', // REQUIRED
                'operator' => 'EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|GREATER_THAN|GREATER_THAN_OR_EQUALS|IN|NOT_IN|CONTAINS', // REQUIRED
                'values' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
        'maxDevices' => <integer>, // REQUIRED
    ],
    'executionConfiguration' => [
        'accountsCleanup' => true || false,
        'appPackagesCleanup' => true || false,
        'jobTimeoutMinutes' => <integer>,
        'skipAppResign' => true || false,
        'videoCapture' => true || false,
    ],
    'name' => '<string>',
    'projectArn' => '<string>', // REQUIRED
    'test' => [ // REQUIRED
        '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
    ],
]);

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',
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'webUrl' => '<string>',
    ],
]

Result Details

Errors

ArgumentException:

An invalid argument was specified.

NotFoundException:

The specified entity was not found.

LimitExceededException:

A limit was exceeded.

IdempotencyException:

An entity with the same name already exists.

ServiceAccountException:

There was a problem with the service account.

Examples

Example 1: To schedule a test run

The following example schedules a test run named MyRun.

$result = $client->scheduleRun([
    'name' => 'MyRun',
    'devicePoolArn' => 'arn:aws:devicefarm:us-west-2:123456789101:pool:EXAMPLE-GUID-123-456', // You can get the Amazon Resource Name (ARN) of the device pool by using the list-pools CLI command.
    'projectArn' => '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.
    'test' => [
        'type' => 'APPIUM_JAVA_JUNIT',
        'testPackageArn' => 'arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456',
    ],
]);

Result syntax:

[
    'run' => [
    ],
]

StopJob

$result = $client->stopJob([/* ... */]);
$promise = $client->stopJobAsync([/* ... */]);

Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device where tests have not started. You are not billed for this device. On the device where tests have started, setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown, and any tests that were in progress or already completed.

Parameter Syntax

$result = $client->stopJob([
    '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.

StopRemoteAccessSession

$result = $client->stopRemoteAccessSession([/* ... */]);
$promise = $client->stopRemoteAccessSessionAsync([/* ... */]);

Ends a specified remote access session.

Parameter Syntax

$result = $client->stopRemoteAccessSession([
    '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>,
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<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.

StopRun

$result = $client->stopRun([/* ... */]);
$promise = $client->stopRunAsync([/* ... */]);

Initiates a stop request for the current test run. AWS Device Farm immediately stops the run on devices where tests have not started. You are not billed for these devices. On devices where tests have started executing, setup suite and teardown suite tests run to completion on those devices. You are billed for setup, teardown, and any tests that were in progress or already completed.

Parameter Syntax

$result = $client->stopRun([
    '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',
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        '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 stop a test run

The following example stops a specific test run.

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

Result syntax:

[
    'run' => [
    ],
]

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ArgumentException:

An invalid argument was specified.

NotFoundException:

The specified entity was not found.

TagOperationException:

The operation was not successful. Try again.

TooManyTagsException:

The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.

TagPolicyException:

The request doesn't comply with the AWS Identity and Access Management (IAM) tag policy. Correct your request and then retry it.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Deletes the specified tags from a resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ArgumentException:

An invalid argument was specified.

NotFoundException:

The specified entity was not found.

TagOperationException:

The operation was not successful. Try again.

UpdateDeviceInstance

$result = $client->updateDeviceInstance([/* ... */]);
$promise = $client->updateDeviceInstanceAsync([/* ... */]);

Updates information about a private device instance.

Parameter Syntax

$result = $client->updateDeviceInstance([
    'arn' => '<string>', // REQUIRED
    'labels' => ['<string>', ...],
    'profileArn' => '<string>',
]);

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.

UpdateDevicePool

$result = $client->updateDevicePool([/* ... */]);
$promise = $client->updateDevicePoolAsync([/* ... */]);

Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).

Parameter Syntax

$result = $client->updateDevicePool([
    'arn' => '<string>', // REQUIRED
    'clearMaxDevices' => true || false,
    '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>',
        ],
        // ...
    ],
]);

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 update a device pool

The following example updates the specified device pool with a new name and description. It also enables remote access of devices in the device pool.

$result = $client->updateDevicePool([
    'name' => 'NewName',
    'arn' => 'arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE', // You can get the Amazon Resource Name (ARN) of the device pool by using the list-pools CLI command.
    'description' => 'NewDescription',
    'rules' => [
        [
            'value' => 'True',
            'attribute' => 'REMOTE_ACCESS_ENABLED',
            'operator' => 'EQUALS',
        ],
    ],
]);

Result syntax:

[
    'devicePool' => [
    ], // Note: you cannot update curated device pools.
]

UpdateInstanceProfile

$result = $client->updateInstanceProfile([/* ... */]);
$promise = $client->updateInstanceProfileAsync([/* ... */]);

Updates information about an existing private device instance profile.

Parameter Syntax

$result = $client->updateInstanceProfile([
    'arn' => '<string>', // REQUIRED
    'description' => '<string>',
    'excludeAppPackagesFromCleanup' => ['<string>', ...],
    'name' => '<string>',
    '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.

UpdateNetworkProfile

$result = $client->updateNetworkProfile([/* ... */]);
$promise = $client->updateNetworkProfileAsync([/* ... */]);

Updates the network profile.

Parameter Syntax

$result = $client->updateNetworkProfile([
    'arn' => '<string>', // REQUIRED
    'description' => '<string>',
    'downlinkBandwidthBits' => <integer>,
    'downlinkDelayMs' => <integer>,
    'downlinkJitterMs' => <integer>,
    'downlinkLossPercent' => <integer>,
    'name' => '<string>',
    '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.

UpdateProject

$result = $client->updateProject([/* ... */]);
$promise = $client->updateProjectAsync([/* ... */]);

Modifies the specified project name, given the project ARN and a new name.

Parameter Syntax

$result = $client->updateProject([
    'arn' => '<string>', // REQUIRED
    'defaultJobTimeoutMinutes' => <integer>,
    'name' => '<string>',
    'vpcConfig' => [
        'securityGroupIds' => ['<string>', ...], // REQUIRED
        'subnetIds' => ['<string>', ...], // REQUIRED
        'vpcId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'project' => [
        'arn' => '<string>',
        'created' => <DateTime>,
        'defaultJobTimeoutMinutes' => <integer>,
        'name' => '<string>',
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<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 update a device pool

The following example updates the specified project with a new name.

$result = $client->updateProject([
    'name' => 'NewName',
    'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:8f75187d-101e-4625-accc-12345EXAMPLE', // You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.
]);

Result syntax:

[
    'project' => [
        'name' => 'NewName',
        'arn' => 'arn:aws:devicefarm:us-west-2:123456789101:project:8f75187d-101e-4625-accc-12345EXAMPLE',
        'created' => ,
    ],
]

UpdateTestGridProject

$result = $client->updateTestGridProject([/* ... */]);
$promise = $client->updateTestGridProjectAsync([/* ... */]);

Change details of a project.

Parameter Syntax

$result = $client->updateTestGridProject([
    'description' => '<string>',
    'name' => '<string>',
    'projectArn' => '<string>', // REQUIRED
    'vpcConfig' => [
        'securityGroupIds' => ['<string>', ...], // REQUIRED
        'subnetIds' => ['<string>', ...], // REQUIRED
        'vpcId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'testGridProject' => [
        'arn' => '<string>',
        'created' => <DateTime>,
        'description' => '<string>',
        'name' => '<string>',
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
    ],
]

Result Details

Errors

NotFoundException:

The specified entity was not found.

ArgumentException:

An invalid argument was specified.

LimitExceededException:

A limit was exceeded.

InternalServiceException:

An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this error.