AWS SDK for PHP 3.x

Client: Aws\DeviceFarm\DeviceFarmClient

Service ID: devicefarm

Version: 2015-06-23

This page describes the parameters and results for the operations of the AWS Device Farm (2015-06-23), and shows how to use the Aws\DeviceFarm\DeviceFarmClient object to call the described operations. This documentation is specific to the 2015-06-23 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateDevicePool ( array $params = [] )
Creates a device pool.
CreateInstanceProfile ( array $params = [] )
Creates a profile that can be applied to one or more private fleet device instances.
CreateNetworkProfile ( array $params = [] )
Creates a network profile.
CreateProject ( array $params = [] )
Creates a project.
CreateRemoteAccessSession ( array $params = [] )
Specifies and starts a remote access session.
CreateTestGridProject ( array $params = [] )
Creates a Selenium testing project.
CreateTestGridUrl ( array $params = [] )
Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.
CreateUpload ( array $params = [] )
Uploads an app or test scripts.
CreateVPCEConfiguration ( array $params = [] )
Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
DeleteDevicePool ( array $params = [] )
Deletes a device pool given the pool ARN.
DeleteInstanceProfile ( array $params = [] )
Deletes a profile that can be applied to one or more private device instances.
DeleteNetworkProfile ( array $params = [] )
Deletes a network profile.
DeleteProject ( array $params = [] )
Deletes an AWS Device Farm project, given the project ARN.
DeleteRemoteAccessSession ( array $params = [] )
Deletes a completed remote access session and its results.
DeleteRun ( array $params = [] )
Deletes the run, given the run ARN.
DeleteTestGridProject ( array $params = [] )
Deletes a Selenium testing project and all content generated under it.
DeleteUpload ( array $params = [] )
Deletes an upload given the upload ARN.
DeleteVPCEConfiguration ( array $params = [] )
Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
GetAccountSettings ( array $params = [] )
Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.
GetDevice ( array $params = [] )
Gets information about a unique device type.
GetDeviceInstance ( array $params = [] )
Returns information about a device instance that belongs to a private device fleet.
GetDevicePool ( array $params = [] )
Gets information about a device pool.
GetDevicePoolCompatibility ( array $params = [] )
Gets information about compatibility with a device pool.
GetInstanceProfile ( array $params = [] )
Returns information about the specified instance profile.
GetJob ( array $params = [] )
Gets information about a job.
GetNetworkProfile ( array $params = [] )
Returns information about a network profile.
GetOfferingStatus ( array $params = [] )
Gets the current status and future status of all offerings purchased by an AWS account.
GetProject ( array $params = [] )
Gets information about a project.
GetRemoteAccessSession ( array $params = [] )
Returns a link to a currently running remote access session.
GetRun ( array $params = [] )
Gets information about a run.
GetSuite ( array $params = [] )
Gets information about a suite.
GetTest ( array $params = [] )
Gets information about a test.
GetTestGridProject ( array $params = [] )
Retrieves information about a Selenium testing project.
GetTestGridSession ( array $params = [] )
A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrlResult$url.
GetUpload ( array $params = [] )
Gets information about an upload.
GetVPCEConfiguration ( array $params = [] )
Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
InstallToRemoteAccessSession ( array $params = [] )
Installs an application to the device in a remote access session.
ListArtifacts ( array $params = [] )
Gets information about artifacts.
ListDeviceInstances ( array $params = [] )
Returns information about the private device instances associated with one or more AWS accounts.
ListDevicePools ( array $params = [] )
Gets information about device pools.
ListDevices ( array $params = [] )
Gets information about unique device types.
ListInstanceProfiles ( array $params = [] )
Returns information about all the instance profiles in an AWS account.
ListJobs ( array $params = [] )
Gets information about jobs for a given test run.
ListNetworkProfiles ( array $params = [] )
Returns the list of available network profiles.
ListOfferingPromotions ( array $params = [] )
Returns a list of offering promotions.
ListOfferingTransactions ( array $params = [] )
Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account.
ListOfferings ( array $params = [] )
Returns a list of products or offerings that the user can manage through the API.
ListProjects ( array $params = [] )
Gets information about projects.
ListRemoteAccessSessions ( array $params = [] )
Returns a list of all currently running remote access sessions.
ListRuns ( array $params = [] )
Gets information about runs, given an AWS Device Farm project ARN.
ListSamples ( array $params = [] )
Gets information about samples, given an AWS Device Farm job ARN.
ListSuites ( array $params = [] )
Gets information about test suites for a given job.
ListTagsForResource ( array $params = [] )
List the tags for an AWS Device Farm resource.
ListTestGridProjects ( array $params = [] )
Gets a list of all Selenium testing projects in your account.
ListTestGridSessionActions ( array $params = [] )
Returns a list of the actions taken in a TestGridSession.
ListTestGridSessionArtifacts ( array $params = [] )
Retrieves a list of artifacts created during the session.
ListTestGridSessions ( array $params = [] )
Retrieves a list of sessions for a TestGridProject.
ListTests ( array $params = [] )
Gets information about tests in a given test suite.
ListUniqueProblems ( array $params = [] )
Gets information about unique problems, such as exceptions or crashes.
ListUploads ( array $params = [] )
Gets information about uploads, given an AWS Device Farm project ARN.
ListVPCEConfigurations ( array $params = [] )
Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
PurchaseOffering ( array $params = [] )
Immediately purchases offerings for an AWS account.
RenewOffering ( array $params = [] )
Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period.
ScheduleRun ( array $params = [] )
Schedules a run.
StopJob ( array $params = [] )
Initiates a stop request for the current job.
StopRemoteAccessSession ( array $params = [] )
Ends a specified remote access session.
StopRun ( array $params = [] )
Initiates a stop request for the current test run.
TagResource ( array $params = [] )
Associates the specified tags to a resource with the specified resourceArn.
UntagResource ( array $params = [] )
Deletes the specified tags from a resource.
UpdateDeviceInstance ( array $params = [] )
Updates information about a private device instance.
UpdateDevicePool ( array $params = [] )
Modifies the name, description, and rules in a device pool given the attributes and the pool ARN.
UpdateInstanceProfile ( array $params = [] )
Updates information about an existing private device instance profile.
UpdateNetworkProfile ( array $params = [] )
Updates the network profile.
UpdateProject ( array $params = [] )
Modifies the specified project name, given the project ARN and a new name.
UpdateTestGridProject ( array $params = [] )
Change details of a project.
UpdateUpload ( array $params = [] )
Updates an uploaded test spec.
UpdateVPCEConfiguration ( array $params = [] )
Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

GetOfferingStatus
ListArtifacts
ListDevicePools
ListDevices
ListJobs
ListOfferingTransactions
ListOfferings
ListProjects
ListRuns
ListSamples
ListSuites
ListTestGridProjects
ListTestGridSessionActions
ListTestGridSessionArtifacts
ListTestGridSessions
ListTests
ListUniqueProblems
ListUploads

Operations

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

Members

description

Type: string

The device pool's description.

maxDevices

Type: int

The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.

By specifying the maximum number of devices, you can control the costs that you incur by running tests.

name

Required: Yes
Type: string

The device pool's name.

projectArn

Required: Yes
Type: string

The ARN of the project for the device pool.

rules

Required: Yes
Type: Array of Rule structures

The device pool's rules.

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

Members

devicePool

Type: DevicePool structure

The newly created device pool.

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

Members

description

Type: string

The description of your instance profile.

excludeAppPackagesFromCleanup

Type: Array of strings

An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.

The list of packages is considered only if you set packageCleanup to true.

name

Required: Yes
Type: string

The name of your instance profile.

packageCleanup

Type: boolean

When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.

rebootAfterUse

Type: boolean

When set to true, Device Farm reboots the instance after a test run. The default value is true.

Result Syntax

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

Result Details

Members

instanceProfile

Type: InstanceProfile structure

An object that contains information about your instance profile.

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

Members

description

Type: string

The description of the network profile.

downlinkBandwidthBits

Type: long (int|float)

The data throughput rate in bits per second, as an integer from 0 to 104857600.

downlinkDelayMs

Type: long (int|float)

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

downlinkJitterMs

Type: long (int|float)

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

downlinkLossPercent

Type: int

Proportion of received packets that fail to arrive from 0 to 100 percent.

name

Required: Yes
Type: string

The name for the new network profile.

projectArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the project for which you want to create a network profile.

type

Type: string

The type of network profile to create. Valid values are listed here.

uplinkBandwidthBits

Type: long (int|float)

The data throughput rate in bits per second, as an integer from 0 to 104857600.

uplinkDelayMs

Type: long (int|float)

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

uplinkJitterMs

Type: long (int|float)

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

uplinkLossPercent

Type: int

Proportion of transmitted packets that fail to arrive from 0 to 100 percent.

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

Members

networkProfile

Type: NetworkProfile structure

The network profile that is returned by the create network profile request.

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

Members

defaultJobTimeoutMinutes

Type: int

Sets the execution timeout value (in minutes) for a project. All test runs in this project use the specified execution timeout value unless overridden when scheduling a run.

name

Required: Yes
Type: string

The project's name.

vpcConfig

Type: VpcConfig structure

The VPC security groups and subnets that are attached to a project.

Result Syntax

[
    'project' => [
        'arn' => '<string>',
        'created' => <DateTime>,
        'defaultJobTimeoutMinutes' => <integer>,
        'name' => '<string>',
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
    ],
]

Result Details

Members

project

Type: Project structure

The newly created project.

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

Members

clientId

Type: string

Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId value in each call to CreateRemoteAccessSession. This identifier is required only if remoteDebugEnabled is set to true.

Remote debugging is no longer supported.

configuration

Type: CreateRemoteAccessSessionConfiguration structure

The configuration information for the remote access session request.

deviceArn

Required: Yes
Type: string

The ARN of the device for which you want to create a remote access session.

instanceArn

Type: string

The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.

interactionMode

Type: string

The interaction mode of the remote access session. Valid values are:

INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.
NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.
VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.

name

Type: string

The name of the remote access session to create.

projectArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.

remoteDebugEnabled

Type: boolean

Set to true if you want to access devices remotely for debugging in your remote access session.

Remote debugging is no longer supported.

remoteRecordAppArn

Type: string

The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.

remoteRecordEnabled

Type: boolean

Set to true to enable remote recording for the remote access session.

skipAppResign

Type: boolean

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information on how Device Farm modifies your uploads during tests, see Do you modify my app?

sshPublicKey

Type: string

Ignored. The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This key is required only if remoteDebugEnabled is set to true.

Remote debugging is no longer supported.

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

Members

remoteAccessSession

Type: RemoteAccessSession structure

A container that describes the remote access session when the request to create a remote access session is sent.

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

Members

description

Type: string

Human-readable description of the project.

name

Required: Yes
Type: string

Human-readable name of the Selenium testing project.

vpcConfig

Type: TestGridVpcConfig structure

The VPC security groups and subnets that are attached to a project.

Result Syntax

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

Result Details

Members

testGridProject

Type: TestGridProject structure

ARN of the Selenium testing project that was created.

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

Members

expiresInSeconds

Required: Yes
Type: int

Lifetime, in seconds, of the URL.

projectArn

Required: Yes
Type: string

ARN (from CreateTestGridProject or ListTestGridProjects) to associate with the short-term URL.

Result Syntax

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

Result Details

Members

expires

Type: timestamp (string|DateTime or anything parsable by strtotime)

The number of seconds the URL from CreateTestGridUrlResult$url stays active.

url

Type: string

A signed URL, expiring in CreateTestGridUrlRequest$expiresInSeconds seconds, to be passed to a RemoteWebDriver.

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

Members

contentType

Type: string

The upload's content type (for example, application/octet-stream).

name

Required: Yes
Type: string

The upload's file name. The name should not contain any forward slashes (/). If you are uploading an iOS app, the file name must end with the .ipa extension. If you are uploading an Android app, the file name must end with the .apk extension. For all others, the file name must end with the .zip file extension.

projectArn

Required: Yes
Type: string

The ARN of the project for the upload.

type

Required: Yes
Type: string

The upload's upload type.

Must be one of the following values:

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

If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.

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

Members

upload

Type: Upload structure

The newly created upload.

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

Members

serviceDnsName

Required: Yes
Type: string

The DNS name of the service running in your VPC that you want Device Farm to test.

vpceConfigurationDescription

Type: string

An optional description that provides details about your VPC endpoint configuration.

vpceConfigurationName

Required: Yes
Type: string

The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.

vpceServiceName

Required: Yes
Type: string

The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.

Result Syntax

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

Result Details

Members

vpceConfiguration

Type: VPCEConfiguration structure

An object that contains information about your VPC endpoint configuration.

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

Members

arn

Required: Yes
Type: string

Represents the Amazon Resource Name (ARN) of the Device Farm device pool to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the instance profile you are requesting to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

arn

Required: Yes
Type: string

The ARN of the network profile to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

arn

Required: Yes
Type: string

Represents the Amazon Resource Name (ARN) of the Device Farm project to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the session for which you want to delete remote access.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) for the run to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

You cannot undo this operation.

You cannot delete a project if it has active sessions.

Parameter Syntax

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

Parameter Details

Members

projectArn

Required: Yes
Type: string

The ARN of the project to delete, from CreateTestGridProject or ListTestGridProjects.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

arn

Required: Yes
Type: string

Represents the Amazon Resource Name (ARN) of the Device Farm upload to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

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

Members

accountSettings

Type: AccountSettings structure

The account settings.

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

Members

arn

Required: Yes
Type: string

The device type's ARN.

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

Members

device

Type: Device structure

An object that contains information about the requested device.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the instance you're requesting information about.

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

Members

deviceInstance

Type: DeviceInstance structure

An object that contains information about your device instance.

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

Members

arn

Required: Yes
Type: string

The device pool's ARN.

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

Members

devicePool

Type: DevicePool structure

An object that contains information about the requested device pool.

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

Members

appArn

Type: string

The ARN of the app that is associated with the specified device pool.

configuration

Type: ScheduleRunConfiguration structure

An object that contains information about the settings for a run.

devicePoolArn

Required: Yes
Type: string

The device pool's ARN.

test

Type: ScheduleRunTest structure

Information about the uploaded test to be run against the device pool.

testType

Type: string

The test type for the specified device pool.

Allowed values include the following:

BUILTIN_FUZZ.
BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
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.

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

Members

compatibleDevices

Type: Array of DevicePoolCompatibilityResult structures

Information about compatible devices.

incompatibleDevices

Type: Array of DevicePoolCompatibilityResult structures

Information about incompatible devices.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of an instance profile.

Result Syntax

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

Result Details

Members

instanceProfile

Type: InstanceProfile structure

An object that contains information about an instance profile.

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

Members

arn

Required: Yes
Type: string

The job's ARN.

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

Members

job

Type: Job structure

An object that contains information about the requested job.

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

Members

arn

Required: Yes
Type: string

The ARN of the network profile to return information about.

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

Members

networkProfile

Type: NetworkProfile structure

The network profile.

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

Members

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

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

Members

current

Type: Associative array of custom strings keys (OfferingIdentifier) to OfferingStatus structures

When specified, gets the offering status for the current period.

nextPeriod

Type: Associative array of custom strings keys (OfferingIdentifier) to OfferingStatus structures

When specified, gets the offering status for the next period.

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

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

Members

arn

Required: Yes
Type: string

The project's ARN.

Result Syntax

[
    'project' => [
        'arn' => '<string>',
        'created' => <DateTime>,
        'defaultJobTimeoutMinutes' => <integer>,
        'name' => '<string>',
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
    ],
]

Result Details

Members

project

Type: Project structure

The project to get information about.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.

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

Members

remoteAccessSession

Type: RemoteAccessSession structure

A container that lists detailed information about the remote access session.

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

Members

arn

Required: Yes
Type: string

The run's ARN.

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

Members

run

Type: Run structure

The run to get results from.

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

Members

arn

Required: Yes
Type: string

The suite's ARN.

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

Members

suite

Type: Suite structure

A collection of one or more tests.

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

Members

arn

Required: Yes
Type: string

The test's ARN.

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

Members

test

Type: Test structure

A test condition that is evaluated.

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

Members

projectArn

Required: Yes
Type: string

The ARN of the Selenium testing project, from either CreateTestGridProject or ListTestGridProjects.

Result Syntax

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

Result Details

Members

testGridProject

Type: TestGridProject structure

A TestGridProject.

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

Members

projectArn

Type: string

The ARN for the project that this session belongs to. See CreateTestGridProject and ListTestGridProjects.

sessionArn

Type: string

An ARN that uniquely identifies a TestGridSession.

sessionId

Type: string

An ID associated with this session.

Result Syntax

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

Result Details

Members

testGridSession

Type: TestGridSession structure

The TestGridSession that was requested.

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

Members

arn

Required: Yes
Type: string

The upload's ARN.

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

Members

upload

Type: Upload structure

An app or a set of one or more tests to upload or that have been uploaded.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to describe.

Result Syntax

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

Result Details

Members

vpceConfiguration

Type: VPCEConfiguration structure

An object that contains information about your VPC endpoint configuration.

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

Members

appArn

Required: Yes
Type: string

The ARN of the app about which you are requesting information.

remoteAccessSessionArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.

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

Members

appUpload

Type: Upload structure

An app to upload or that has been uploaded.

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

Members

arn

Required: Yes
Type: string

The run, job, suite, or test ARN.

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

type

Required: Yes
Type: string

The artifacts' type.

Allowed values include:

FILE
LOG
SCREENSHOT

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

Members

artifacts

Type: Array of Artifact structures

Information about the artifacts.

nextToken

Type: string

If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

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

Members

maxResults

Type: int

An integer that specifies the maximum number of items you want to return in the API response.

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

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

Members

deviceInstances

Type: Array of DeviceInstance structures

An object that contains information about your device instances.

nextToken

Type: string

An identifier that can be used in the next call to this operation to return the next set of items in the list.

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

Members

arn

Required: Yes
Type: string

The project ARN.

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

type

Type: string

The device pools' type.

Allowed values include:

CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.

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

Members

devicePools

Type: Array of DevicePool structures

Information about the device pools.

nextToken

Type: string

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

Members

arn

Type: string

The Amazon Resource Name (ARN) of the project.

filters

Type: Array of DeviceFilter structures

Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.

Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.

Allowed values include:
- ARN: The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).
- PLATFORM: The device platform. Valid values are ANDROID or IOS.
- OS_VERSION: The operating system version (for example, 10.3.2).
- MODEL: The device model (for example, iPad 5th Gen).
- AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
- FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.
- MANUFACTURER: The device manufacturer (for example, Apple).
- REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
- REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is no longer supported, this attribute is ignored.
- INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
- INSTANCE_LABELS: The label of the device instance.
- FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.
Operator: The filter operator.
- The EQUALS operator is available for every attribute except INSTANCE_LABELS.
- The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.
- The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.
- The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.
Values: An array of one or more filter values.
- The IN and NOT_IN operators take a values array that has one or more elements.
- The other operators require an array with a single element.
- In a request, the AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

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

Members

devices

Type: Array of Device structures

Information about the devices.

nextToken

Type: string

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

Members

maxResults

Type: int

An integer that specifies the maximum number of items you want to return in the API response.

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Result Syntax

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

Result Details

Members

instanceProfiles

Type: Array of InstanceProfile structures

An object that contains information about your instance profiles.

nextToken

Type: string

An identifier that can be used in the next call to this operation to return the next set of items in the list.

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

Members

arn

Required: Yes
Type: string

The run's Amazon Resource Name (ARN).

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

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

Members

jobs

Type: Array of Job structures

Information about the jobs.

nextToken

Type: string

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the project for which you want to list network profiles.

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

type

Type: string

The type of network profile to return information about. Valid values are listed here.

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

Members

networkProfiles

Type: Array of NetworkProfile structures

A list of the available network profiles.

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

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

Members

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Result Syntax

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

Result Details

Members

nextToken

Type: string

An identifier to be used in the next call to this operation, to return the next set of items in the list.

offeringPromotions

Type: Array of OfferingPromotion structures

Information about the offering promotions.

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

Members

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

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

Members

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

offeringTransactions

Type: Array of OfferingTransaction structures

The audit log of subscriptions you have purchased and modified through AWS Device Farm.

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

Members

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Result Syntax

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

Result Details

Members

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

offerings

Type: Array of Offering structures

A value that represents the list offering results.

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

Members

arn

Type: string

Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Result Syntax

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

Result Details

Members

nextToken

Type: string

projects

Type: Array of Project structures

Information about the projects.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the project about which you are requesting information.

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

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

Members

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

remoteAccessSessions

Type: Array of RemoteAccessSession structures

A container that represents the metadata from the service about each remote access session you are requesting.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the project for which you want to list runs.

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

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

Members

nextToken

Type: string

runs

Type: Array of Run structures

Information about the runs.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the job used to list samples.

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

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

Members

nextToken

Type: string

samples

Type: Array of Sample structures

Information about the samples.

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

Members

arn

Required: Yes
Type: string

The job's Amazon Resource Name (ARN).

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

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

Members

nextToken

Type: string

suites

Type: Array of Suite structures

Information about the suites.

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

Members

ResourceARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource or resources for which to list tags. You can associate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.

Result Syntax

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

Result Details

Members

Tags

Type: Array of Tag structures

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.

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

Members

maxResult

Type: int

Return no more than this number of results.

nextToken

Type: string

From a response, used to continue a paginated listing.

Result Syntax

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

Result Details

Members

nextToken

Type: string

Used for pagination. Pass into ListTestGridProjects to get more results in a paginated request.

testGridProjects

Type: Array of TestGridProject structures

The list of TestGridProjects, based on a ListTestGridProjectsRequest.

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

Members

maxResult

Type: int

The maximum number of sessions to return per response.

nextToken

Type: string

Pagination token.

sessionArn

Required: Yes
Type: string

The ARN of the session to retrieve.

Result Syntax

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

Result Details

Members

actions

Type: Array of TestGridSessionAction structures

The action taken by the session.

nextToken

Type: string

Pagination token.

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

Members

maxResult

Type: int

The maximum number of results to be returned by a request.

nextToken

Type: string

Pagination token.

sessionArn

Required: Yes
Type: string

The ARN of a TestGridSession.

type

Type: string

Limit results to a specified type of artifact.

Result Syntax

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

Result Details

Members

artifacts

Type: Array of TestGridSessionArtifact structures

A list of test grid session artifacts for a TestGridSession.

nextToken

Type: string

Pagination token.

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

Members

creationTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

Return only sessions created after this time.

creationTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

Return only sessions created before this time.

endTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

Return only sessions that ended after this time.

endTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

Return only sessions that ended before this time.

maxResult

Type: int

Return only this many results at a time.

nextToken

Type: string

Pagination token.

projectArn

Required: Yes
Type: string

ARN of a TestGridProject.

status

Type: string

Return only sessions in this state.

Result Syntax

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

Result Details

Members

nextToken

Type: string

Pagination token.

testGridSessions

Type: Array of TestGridSession structures

The sessions that match the criteria in a ListTestGridSessionsRequest.

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

Members

arn

Required: Yes
Type: string

The test suite's Amazon Resource Name (ARN).

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

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

Members

nextToken

Type: string

tests

Type: Array of Test structures

Information about the tests.

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

Members

arn

Required: Yes
Type: string

The unique problems' ARNs.

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

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

Members

nextToken

Type: string

uniqueProblems

Type: Associative array of custom strings keys (ExecutionResult) to UniqueProblem structuress

Information about the unique problems.

Allowed values include:

PENDING
PASSED
WARNED
FAILED
SKIPPED
ERRORED
STOPPED

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the project for which you want to list uploads.

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

type

Type: string

The type of upload.

Must be one of the following values:

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

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

Members

nextToken

Type: string

uploads

Type: Array of Upload structures

Information about the uploads.

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

Members

maxResults

Type: int

An integer that specifies the maximum number of items you want to return in the API response.

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Result Syntax

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

Result Details

Members

nextToken

Type: string

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

vpceConfigurations

Type: Array of VPCEConfiguration structures

An array of VPCEConfiguration objects that contain information about your VPC endpoint configuration.

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

Members

offeringId

Required: Yes
Type: string

The ID of the offering.

offeringPromotionId

Type: string

The ID of the offering promotion to be applied to the purchase.

quantity

Required: Yes
Type: int

The number of device slots to purchase in an offering request.

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

Members

offeringTransaction

Type: OfferingTransaction structure

Represents the offering transaction for the purchase result.

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

Members

offeringId

Required: Yes
Type: string

The ID of a request to renew an offering.

quantity

Required: Yes
Type: int

The quantity requested in an offering renewal.

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

Members

offeringTransaction

Type: OfferingTransaction structure

Represents the status of the offering transaction for the renewal.

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

Members

appArn

Type: string

The ARN of an application package to run tests against, created with CreateUpload. See ListUploads.

configuration

Type: ScheduleRunConfiguration structure

Information about the settings for the run to be scheduled.

devicePoolArn

Type: string

The ARN of the device pool for the run to be scheduled.

deviceSelectionConfiguration

Type: DeviceSelectionConfiguration structure

The filter criteria used to dynamically select a set of devices for a test run and the maximum number of devices to be included in the run.

Either devicePoolArn or deviceSelectionConfiguration is required in a request.

executionConfiguration

Type: ExecutionConfiguration structure

Specifies configuration information about a test run, such as the execution timeout (in minutes).

name

Type: string

The name for the run to be scheduled.

projectArn

Required: Yes
Type: string

The ARN of the project for the run to be scheduled.

test

Required: Yes
Type: ScheduleRunTest structure

Information about the test for the run to be scheduled.

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

Members

run

Type: Run structure

Information about the scheduled run.

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

Members

arn

Required: Yes
Type: string

Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.

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

Members

job

Type: Job structure

The job that was stopped.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the remote access session to stop.

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

Members

remoteAccessSession

Type: RemoteAccessSession structure

A container that represents the metadata from the service about the remote access session you are stopping.

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

Members

arn

Required: Yes
Type: string

Represents the Amazon Resource Name (ARN) of the Device Farm run to stop.

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

Members

run

Type: Run structure

The run that was stopped.

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

Members

ResourceARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource or resources to which to add tags. You can associate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.

Tags

Required: Yes
Type: Array of Tag structures

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

ResourceARN

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource or resources from which to delete tags. You can associate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.

TagKeys

Required: Yes
Type: Array of strings

The keys of the tags to be removed.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the device instance.

labels

Type: Array of strings

An array of strings that you want to associate with the device instance.

profileArn

Type: string

The ARN of the profile that you want to associate with the device instance.

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

Members

deviceInstance

Type: DeviceInstance structure

An object that contains information about your device instance.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Device Farm device pool to update.

clearMaxDevices

Type: boolean

Sets whether the maxDevices parameter applies to your device pool. If you set this parameter to true, the maxDevices parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria specified in the rules parameter.

If you use this parameter in your request, you cannot use the maxDevices parameter in the same request.

description

Type: string

A description of the device pool to update.

maxDevices

Type: int

The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.

By specifying the maximum number of devices, you can control the costs that you incur by running tests.

If you use this parameter in your request, you cannot use the clearMaxDevices parameter in the same request.

name

Type: string

A string that represents the name of the device pool to update.

rules

Type: Array of Rule structures

Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for your request, the update replaces the existing rules.

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

Members

devicePool

Type: DevicePool structure

The device pool you just updated.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the instance profile.

description

Type: string

The updated description for your instance profile.

excludeAppPackagesFromCleanup

Type: Array of strings

An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run is over.

The list of packages is only considered if you set packageCleanup to true.

name

Type: string

The updated name for your instance profile.

packageCleanup

Type: boolean

The updated choice for whether you want to specify package cleanup. The default value is false for private devices.

rebootAfterUse

Type: boolean

The updated choice for whether you want to reboot the device after use. The default value is true.

Result Syntax

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

Result Details

Members

instanceProfile

Type: InstanceProfile structure

An object that contains information about your instance profile.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the project for which you want to update network profile settings.

description

Type: string

The description of the network profile about which you are returning information.

downlinkBandwidthBits

Type: long (int|float)

The data throughput rate in bits per second, as an integer from 0 to 104857600.

downlinkDelayMs

Type: long (int|float)

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

downlinkJitterMs

Type: long (int|float)

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

downlinkLossPercent

Type: int

Proportion of received packets that fail to arrive from 0 to 100 percent.

name

Type: string

The name of the network profile about which you are returning information.

type

Type: string

The type of network profile to return information about. Valid values are listed here.

uplinkBandwidthBits

Type: long (int|float)

The data throughput rate in bits per second, as an integer from 0 to 104857600.

uplinkDelayMs

Type: long (int|float)

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

uplinkJitterMs

Type: long (int|float)

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

uplinkLossPercent

Type: int

Proportion of transmitted packets that fail to arrive from 0 to 100 percent.

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

Members

networkProfile

Type: NetworkProfile structure

A list of the available network profiles.

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

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the project whose name to update.

defaultJobTimeoutMinutes

Type: int

The number of minutes a test run in the project executes before it times out.

name

Type: string

A string that represents the new name of the project that you are updating.

vpcConfig

Type: VpcConfig structure

The VPC security groups and subnets that are attached to a project.

Result Syntax

[
    'project' => [
        'arn' => '<string>',
        'created' => <DateTime>,
        'defaultJobTimeoutMinutes' => <integer>,
        'name' => '<string>',
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
    ],
]

Result Details

Members

project

Type: Project structure

The project to update.

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

Members

description

Type: string

Human-readable description for the project.

name

Type: string

Human-readable name for the project.

projectArn

Required: Yes
Type: string

ARN of the project to update.

vpcConfig

Type: TestGridVpcConfig structure

The VPC security groups and subnets that are attached to a project.

Result Syntax

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

Result Details

Members

testGridProject

Type: TestGridProject structure

The project, including updated information.

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.

UpdateUpload

$result = $client->updateUpload([/* ... */]);
$promise = $client->updateUploadAsync([/* ... */]);

Updates an uploaded test spec.

Parameter Syntax

$result = $client->updateUpload([
    'arn' => '<string>', // REQUIRED
    'contentType' => '<string>',
    'editContent' => true || false,
    'name' => '<string>',
]);

Parameter Details

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the uploaded test spec.

contentType

Type: string

The upload's content type (for example, application/x-yaml).

editContent

Type: boolean

Set to true if the YAML file has changed and must be updated. Otherwise, set to false.

name

Type: string

The upload's test spec file name. The name must not contain any forward slashes (/). The test spec file name must end with the .yaml or .yml file extension.

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

Members

upload

Type: Upload structure

A test spec uploaded to Device Farm.

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.

UpdateVPCEConfiguration

$result = $client->updateVPCEConfiguration([/* ... */]);
$promise = $client->updateVPCEConfigurationAsync([/* ... */]);

Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.

Parameter Syntax

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

Parameter Details

Members

arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to update.

serviceDnsName

Type: string

The DNS (domain) name used to connect to your private service in your VPC. The DNS name must not already be in use on the internet.

vpceConfigurationDescription

Type: string

An optional description that provides details about your VPC endpoint configuration.

vpceConfigurationName

Type: string

The friendly name you give to your VPC endpoint configuration to manage your configurations more easily.

vpceServiceName

Type: string

The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.

Result Syntax

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

Result Details

Members

vpceConfiguration

Type: VPCEConfiguration structure

An object that contains information about your VPC endpoint configuration.

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.

Shapes

AccountSettings

Description

A container for account-level settings in AWS Device Farm.

Members

awsAccountNumber

Type: string

The AWS account number specified in the AccountSettings container.

defaultJobTimeoutMinutes

Type: int

The default number of minutes (at the account level) a test run executes before it times out. The default value is 150 minutes.

maxJobTimeoutMinutes

Type: int

The maximum number of minutes a test run executes before it times out.

maxSlots

Type: Associative array of custom strings keys (String) to ints

The maximum number of device slots that the AWS account can purchase. Each maximum is expressed as an offering-id:number pair, where the offering-id represents one of the IDs returned by the ListOfferings command.

skipAppResign

Type: boolean

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

trialMinutes

Type: TrialMinutes structure

Information about an AWS account's usage of free trial device minutes.

unmeteredDevices

Type: Associative array of custom strings keys (DevicePlatform) to ints

Returns the unmetered devices you have purchased or want to purchase.

unmeteredRemoteAccessDevices

Type: Associative array of custom strings keys (DevicePlatform) to ints

Returns the unmetered remote access devices you have purchased or want to purchase.

ArgumentException

Description

An invalid argument was specified.

Members

message

Type: string

Any additional information about the exception.

Artifact

Description

Represents the output of a test. Examples of artifacts include logs and screenshots.

Members

arn

Type: string

The artifact's ARN.

extension

Type: string

The artifact's file extension.

name

Type: string

The artifact's name.

type

Type: string

The artifact's type.

Allowed values include the following:

UNKNOWN
SCREENSHOT
DEVICE_LOG
MESSAGE_LOG
VIDEO_LOG
RESULT_LOG
SERVICE_LOG
WEBKIT_LOG
INSTRUMENTATION_OUTPUT
EXERCISER_MONKEY_OUTPUT: the artifact (log) generated by an Android fuzz test.
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

Type: string

The presigned Amazon S3 URL that can be used with a GET request to download the artifact's file.

CPU

Description

Represents the amount of CPU that an app is using on a physical device. Does not represent system-wide CPU usage.

Members

architecture

Type: string

The CPU's architecture (for example, x86 or ARM).

clock

Type: double

The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.

frequency

Type: string

The CPU's frequency.

CannotDeleteException

Description

The requested object could not be deleted.

Members

message

Type: string

Counters

Description

Represents entity counters.

Members

errored

Type: int

The number of errored entities.

failed

Type: int

The number of failed entities.

passed

Type: int

The number of passed entities.

skipped

Type: int

The number of skipped entities.

stopped

Type: int

The number of stopped entities.

total

Type: int

The total number of entities.

warned

Type: int

The number of warned entities.

CreateRemoteAccessSessionConfiguration

Description

Configuration settings for a remote access session, including billing method.

Members

billingMethod

Type: string

The billing method for the remote access session.

vpceConfigurationArns

Type: Array of strings

An array of ARNs included in the VPC endpoint configuration.

CustomerArtifactPaths

Description

A JSON object that specifies the paths where the artifacts generated by the customer's tests, on the device or in the test environment, are pulled from.

Specify deviceHostPaths and optionally specify either iosPaths or androidPaths.

For web app tests, you can specify both iosPaths and androidPaths.

Members

androidPaths

Type: Array of strings

Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests are pulled from.

deviceHostPaths

Type: Array of strings

Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests are pulled from.

iosPaths

Type: Array of strings

Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests are pulled from.

Device

Description

Represents a device type that an app is tested against.

Members

arn

Type: string

The device's ARN.

availability

Type: string

Indicates how likely a device is available for a test run. Currently available in the ListDevices and GetDevice API methods.

carrier

Type: string

The device's carrier.

cpu

Type: CPU structure

Information about the device's CPU.

fleetName

Type: string

The name of the fleet to which this device belongs.

fleetType

Type: string

The type of fleet to which this device belongs. Possible values are PRIVATE and PUBLIC.

formFactor

Type: string

The device's form factor.

Allowed values include:

PHONE
TABLET

heapSize

Type: long (int|float)

The device's heap size, expressed in bytes.

image

Type: string

The device's image name.

instances

Type: Array of DeviceInstance structures

The instances that belong to this device.

manufacturer

Type: string

The device's manufacturer name.

memory

Type: long (int|float)

The device's total memory size, expressed in bytes.

model

Type: string

The device's model name.

modelId

Type: string

The device's model ID.

name

Type: string

The device's display name.

os

Type: string

The device's operating system type.

platform

Type: string

The device's platform.

Allowed values include:

ANDROID
IOS

radio

Type: string

The device's radio.

remoteAccessEnabled

Type: boolean

Specifies whether remote access has been enabled for the specified device.

remoteDebugEnabled

Type: boolean

This flag is set to true if remote debugging is enabled for the device.

Remote debugging is no longer supported.

resolution

Type: Resolution structure

The resolution of the device.

DeviceFilter

Description

Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the deviceSelectionConfiguration parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.

It is also passed in as the filters parameter to ListDevices. For an example of the JSON request syntax, see ListDevices.

Members

attribute

Required: Yes
Type: string

The aspect of a device such as platform or model used as the selection criteria in a device filter.

The supported operators for each attribute are provided in the following list.

ARN

The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).

Supported operators: EQUALS, IN, NOT_IN

PLATFORM

The device platform. Valid values are ANDROID or IOS.

Supported operators: EQUALS

OS_VERSION

The operating system version (for example, 10.3.2).

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

MODEL

The device model (for example, iPad 5th Gen).

Supported operators: CONTAINS, EQUALS, IN, NOT_IN

AVAILABILITY

The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

Supported operators: EQUALS

FORM_FACTOR

The device form factor. Valid values are PHONE or TABLET.

Supported operators: EQUALS

MANUFACTURER

The device manufacturer (for example, Apple).

Supported operators: EQUALS, IN, NOT_IN

REMOTE_ACCESS_ENABLED

Whether the device is enabled for remote access. Valid values are TRUE or FALSE.

Supported operators: EQUALS

REMOTE_DEBUG_ENABLED

Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.

Supported operators: EQUALS

Because remote debugging is no longer supported, this filter is ignored.

INSTANCE_ARN

The Amazon Resource Name (ARN) of the device instance.

Supported operators: EQUALS, IN, NOT_IN

INSTANCE_LABELS

The label of the device instance.

Supported operators: CONTAINS

FLEET_TYPE

The fleet type. Valid values are PUBLIC or PRIVATE.

Supported operators: EQUALS

operator

Required: Yes
Type: string

Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.

values

Required: Yes
Type: Array of strings

An array of one or more filter values used in a device filter.

Operator Values

The IN and NOT_IN operators can take a values array that has more than one element.
The other operators require an array with a single element.

Attribute Values

The PLATFORM attribute can be set to ANDROID or IOS.
The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
The FORM_FACTOR attribute can be set to PHONE or TABLET.
The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.

DeviceInstance

Description

Represents the device instance.

Members

arn

Type: string

The Amazon Resource Name (ARN) of the device instance.

deviceArn

Type: string

The ARN of the device.

instanceProfile

Type: InstanceProfile structure

A object that contains information about the instance profile.

labels

Type: Array of strings

An array of strings that describe the device instance.

status

Type: string

The status of the device instance. Valid values are listed here.

udid

Type: string

Unique device identifier for the device instance.

DeviceMinutes

Description

Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.

Members

metered

Type: double

When specified, represents only the sum of metered minutes used by the resource to run tests.

total

Type: double

When specified, represents the total minutes used by the resource to run tests.

unmetered

Type: double

When specified, represents only the sum of unmetered minutes used by the resource to run tests.

DevicePool

Description

Represents a collection of device types.

Members

arn

Type: string

The device pool's ARN.

description

Type: string

The device pool's description.

maxDevices

Type: int

By specifying the maximum number of devices, you can control the costs that you incur by running tests.

name

Type: string

The device pool's name.

rules

Type: Array of Rule structures

Information about the device pool's rules.

type

Type: string

The device pool's type.

Allowed values include:

CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.

DevicePoolCompatibilityResult

Description

Represents a device pool compatibility result.

Members

compatible

Type: boolean

Whether the result was compatible with the device pool.

device

Type: Device structure

The device (phone or tablet) to return information about.

incompatibilityMessages

Type: Array of IncompatibilityMessage structures

Information about the compatibility.

DeviceSelectionConfiguration

Description

Represents the device filters used in a test run and the maximum number of devices to be included in the run. It is passed in as the deviceSelectionConfiguration request parameter in ScheduleRun.

Members

filters

Required: Yes
Type: Array of DeviceFilter structures

Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values.

Attribute

The aspect of a device such as platform or model used as the selection criteria in a device filter.

Allowed values include:
- ARN: The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).
- PLATFORM: The device platform. Valid values are ANDROID or IOS.
- OS_VERSION: The operating system version (for example, 10.3.2).
- MODEL: The device model (for example, iPad 5th Gen).
- AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
- FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.
- MANUFACTURER: The device manufacturer (for example, Apple).
- REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
- REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is no longer supported, this filter is ignored.
- INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
- INSTANCE_LABELS: The label of the device instance.
- FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.
Operator

The filter operator.
- The EQUALS operator is available for every attribute except INSTANCE_LABELS.
- The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.
- The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.
- The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.
Values

An array of one or more filter values.

Operator Values
- The IN and NOT_IN operators can take a values array that has more than one element.
- The other operators require an array with a single element.
Attribute Values
- The PLATFORM attribute can be set to ANDROID or IOS.
- The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
- The FORM_FACTOR attribute can be set to PHONE or TABLET.
- The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.

maxDevices

Required: Yes
Type: int

The maximum number of devices to be included in a test run.

DeviceSelectionResult

Description

Contains the run results requested by the device selection configuration and how many devices were returned. For an example of the JSON response syntax, see ScheduleRun.

Members

filters

Type: Array of DeviceFilter structures

The filters in a device selection result.

matchedDevicesCount

Type: int

The number of devices that matched the device filter selection criteria.

maxDevices

Type: int

The maximum number of devices to be selected by a device filter and included in a test run.

ExecutionConfiguration

Description

Represents configuration information about a test run, such as the execution timeout (in minutes).

Members

accountsCleanup

Type: boolean

True if account cleanup is enabled at the beginning of the test. Otherwise, false.

appPackagesCleanup

Type: boolean

True if app package cleanup is enabled at the beginning of the test. Otherwise, false.

jobTimeoutMinutes

Type: int

The number of minutes a test run executes before it times out.

skipAppResign

Type: boolean

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

videoCapture

Type: boolean

Set to true to enable video capture. Otherwise, set to false. The default is true.

IdempotencyException

Description

An entity with the same name already exists.

Members

message

Type: string

Any additional information about the exception.

IncompatibilityMessage

Description

Represents information about incompatibility.

Members

message

Type: string

A message about the incompatibility.

type

Type: string

The type of incompatibility.

Allowed values include:

ARN
FORM_FACTOR (for example, phone or tablet)
MANUFACTURER
PLATFORM (for example, Android or iOS)
REMOTE_ACCESS_ENABLED
APPIUM_VERSION

InstanceProfile

Description

Represents the instance profile.

Members

arn

Type: string

The Amazon Resource Name (ARN) of the instance profile.

description

Type: string

The description of the instance profile.

excludeAppPackagesFromCleanup

Type: Array of strings

An array of strings containing the list of app packages that should not be cleaned up from the device after a test run completes.

The list of packages is considered only if you set packageCleanup to true.

name

Type: string

The name of the instance profile.

packageCleanup

Type: boolean

When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.

rebootAfterUse

Type: boolean

When set to true, Device Farm reboots the instance after a test run. The default value is true.

InternalServiceException

Description

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

Members

message

Type: string

InvalidOperationException

Description

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

Members

message

Type: string

Job

Description

Represents a device.

Members

arn

Type: string

The job's ARN.

counters

Type: Counters structure

The job's result counters.

created

Type: timestamp (string|DateTime or anything parsable by strtotime)

When the job was created.

device

Type: Device structure

The device (phone or tablet).

deviceMinutes

Type: DeviceMinutes structure

Represents the total (metered or unmetered) minutes used by the job.

instanceArn

Type: string

The ARN of the instance.

message

Type: string

A message about the job's result.

name

Type: string

The job's name.

result

Type: string

The job's result.

Allowed values include:

PENDING
PASSED
WARNED
FAILED
SKIPPED
ERRORED
STOPPED

started

Type: timestamp (string|DateTime or anything parsable by strtotime)

The job's start time.

status

Type: string

The job's status.

Allowed values include:

PENDING
PENDING_CONCURRENCY
PENDING_DEVICE
PROCESSING
SCHEDULING
PREPARING
RUNNING
COMPLETED
STOPPING

stopped

Type: timestamp (string|DateTime or anything parsable by strtotime)

The job's stop time.

type

Type: string

The job's type.

Allowed values include the following:

BUILTIN_FUZZ
BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
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

videoCapture

Type: boolean

This value is set to true if video capture is enabled. Otherwise, it is set to false.

videoEndpoint

Type: string

The endpoint for streaming device video.

LimitExceededException

Description

A limit was exceeded.

Members

message

Type: string

Any additional information about the exception.

Location

Description

Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example, 47.6204, -122.3491).

Elevation is currently not supported.

Members

latitude

Required: Yes
Type: double

The latitude.

longitude

Required: Yes
Type: double

The longitude.

MonetaryAmount

Description

A number that represents the monetary amount for an offering or transaction.

Members

amount

Type: double

The numerical amount of an offering or transaction.

currencyCode

Type: string

The currency code of a monetary amount. For example, USD means U.S. dollars.

NetworkProfile

Description

An array of settings that describes characteristics of a network profile.

Members

arn

Type: string

The Amazon Resource Name (ARN) of the network profile.

description

Type: string

The description of the network profile.

downlinkBandwidthBits

Type: long (int|float)

The data throughput rate in bits per second, as an integer from 0 to 104857600.

downlinkDelayMs

Type: long (int|float)

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

downlinkJitterMs

Type: long (int|float)

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

downlinkLossPercent

Type: int

Proportion of received packets that fail to arrive from 0 to 100 percent.

name

Type: string

The name of the network profile.

type

Type: string

The type of network profile. Valid values are listed here.

uplinkBandwidthBits

Type: long (int|float)

The data throughput rate in bits per second, as an integer from 0 to 104857600.

uplinkDelayMs

Type: long (int|float)

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

uplinkJitterMs

Type: long (int|float)

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

uplinkLossPercent

Type: int

Proportion of transmitted packets that fail to arrive from 0 to 100 percent.

NotEligibleException

Description

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

Members

message

Type: string

The HTTP response code of a Not Eligible exception.

NotFoundException

Description

The specified entity was not found.

Members

message

Type: string

Any additional information about the exception.

Offering

Description

Represents the metadata of a device offering.

Members

description

Type: string

A string that describes the offering.

id

Type: string

The ID that corresponds to a device offering.

platform

Type: string

The platform of the device (for example, ANDROID or IOS).

recurringCharges

Type: Array of RecurringCharge structures

Specifies whether there are recurring charges for the offering.

type

Type: string

The type of offering (for example, RECURRING) for a device.

OfferingPromotion

Description

Represents information about an offering promotion.

Members

description

Type: string

A string that describes the offering promotion.

id

Type: string

The ID of the offering promotion.

OfferingStatus

Description

The status of the offering.

Members

effectiveOn

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date on which the offering is effective.

offering

Type: Offering structure

Represents the metadata of an offering status.

quantity

Type: int

The number of available devices in the offering.

type

Type: string

The type specified for the offering status.

OfferingTransaction

Description

Represents the metadata of an offering transaction.

Members

cost

Type: MonetaryAmount structure

The cost of an offering transaction.

createdOn

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date on which an offering transaction was created.

offeringPromotionId

Type: string

The ID that corresponds to a device offering promotion.

offeringStatus

Type: OfferingStatus structure

The status of an offering transaction.

transactionId

Type: string

The transaction ID of the offering transaction.

Problem

Description

Represents a specific warning or failure.

Members

device

Type: Device structure

Information about the associated device.

job

Type: ProblemDetail structure

Information about the associated job.

message

Type: string

A message about the problem's result.

result

Type: string

The problem's result.

Allowed values include:

PENDING
PASSED
WARNED
FAILED
SKIPPED
ERRORED
STOPPED

run

Type: ProblemDetail structure

Information about the associated run.

suite

Type: ProblemDetail structure

Information about the associated suite.

test

Type: ProblemDetail structure

Information about the associated test.

ProblemDetail

Description

Information about a problem detail.

Members

arn

Type: string

The problem detail's ARN.

name

Type: string

The problem detail's name.

Project

Description

Represents an operating-system neutral workspace for running and managing tests.

Members

arn

Type: string

The project's ARN.

created

Type: timestamp (string|DateTime or anything parsable by strtotime)

When the project was created.

defaultJobTimeoutMinutes

Type: int

The default number of minutes (at the project level) a test run executes before it times out. The default value is 150 minutes.

name

Type: string

The project's name.

vpcConfig

Type: VpcConfig structure

The VPC security groups and subnets that are attached to a project.

Radios

Description

Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.

Members

bluetooth

Type: boolean

True if Bluetooth is enabled at the beginning of the test. Otherwise, false.

gps

Type: boolean

True if GPS is enabled at the beginning of the test. Otherwise, false.

nfc

Type: boolean

True if NFC is enabled at the beginning of the test. Otherwise, false.

wifi

Type: boolean

True if Wi-Fi is enabled at the beginning of the test. Otherwise, false.

RecurringCharge

Description

Specifies whether charges for devices are recurring.

Members

cost

Type: MonetaryAmount structure

The cost of the recurring charge.

frequency

Type: string

The frequency in which charges recur.

RemoteAccessSession

Description

Represents information about the remote access session.

Members

arn

Type: string

The Amazon Resource Name (ARN) of the remote access session.

billingMethod

Type: string

The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology.

clientId

Type: string

Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported.

created

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the remote access session was created.

device

Type: Device structure

The device (phone or tablet) used in the remote access session.

deviceMinutes

Type: DeviceMinutes structure

The number of minutes a device is used in a remote access session (including setup and teardown minutes).

deviceUdid

Type: string

Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported.

endpoint

Type: string

The endpoint for the remote access sesssion.

hostAddress

Type: string

IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported.

instanceArn

Type: string

The ARN of the instance.

interactionMode

Type: string

The interaction mode of the remote access session. Valid values are:

INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.
NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.
VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.

message

Type: string

A message about the remote access session.

name

Type: string

The name of the remote access session.

remoteDebugEnabled

Type: boolean

This flag is set to true if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported.

remoteRecordAppArn

Type: string

The ARN for the app to be recorded in the remote access session.

remoteRecordEnabled

Type: boolean

This flag is set to true if remote recording is enabled for the remote access session.

result

Type: string

The result of the remote access session. Can be any of the following:

PENDING.
PASSED.
WARNED.
FAILED.
SKIPPED.
ERRORED.
STOPPED.

skipAppResign

Type: boolean

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

started

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the remote access session was started.

status

Type: string

The status of the remote access session. Can be any of the following:

PENDING.
PENDING_CONCURRENCY.
PENDING_DEVICE.
PROCESSING.
SCHEDULING.
PREPARING.
RUNNING.
COMPLETED.
STOPPING.

stopped

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the remote access session was stopped.

vpcConfig

Type: VpcConfig structure

The VPC security groups and subnets that are attached to a project.

Resolution

Description

Represents the screen resolution of a device in height and width, expressed in pixels.

Members

height

Type: int

The screen resolution's height, expressed in pixels.

width

Type: int

The screen resolution's width, expressed in pixels.

Rule

Description

Represents a condition for a device pool.

Members

attribute

Type: string

The rule's stringified attribute. For example, specify the value as "\"abc\"".

The supported operators for each attribute are provided in the following list.

APPIUM_VERSION

The Appium version for the test.

Supported operators: CONTAINS

ARN

The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example.

Supported operators: EQUALS, IN, NOT_IN

AVAILABILITY

The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

Supported operators: EQUALS

FLEET_TYPE

The fleet type. Valid values are PUBLIC or PRIVATE.

Supported operators: EQUALS

FORM_FACTOR

The device form factor. Valid values are PHONE or TABLET.

Supported operators: EQUALS, IN, NOT_IN

INSTANCE_ARN

The Amazon Resource Name (ARN) of the device instance.

Supported operators: IN, NOT_IN

INSTANCE_LABELS

The label of the device instance.

Supported operators: CONTAINS

MANUFACTURER

The device manufacturer (for example, Apple).

Supported operators: EQUALS, IN, NOT_IN

MODEL

The device model, such as Apple iPad Air 2 or Google Pixel.

Supported operators: CONTAINS, EQUALS, IN, NOT_IN

OS_VERSION

The operating system version (for example, 10.3.2).

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

PLATFORM

The device platform. Valid values are ANDROID or IOS.

Supported operators: EQUALS, IN, NOT_IN

REMOTE_ACCESS_ENABLED

Whether the device is enabled for remote access. Valid values are TRUE or FALSE.

Supported operators: EQUALS

REMOTE_DEBUG_ENABLED

Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.

Supported operators: EQUALS

Because remote debugging is no longer supported, this filter is ignored.

operator

Type: string

Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.

value

Type: string

The rule's value.

Run

Description

Represents a test run on a set of devices with a given app package, test parameters, and so on.

Members

appUpload

Type: string

An app to upload or that has been uploaded.

arn

Type: string

The run's ARN.

billingMethod

Type: string

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

If you have unmetered device slots, you must set this to unmetered to use them. Otherwise, the run is counted toward metered device minutes.

completedJobs

Type: int

The total number of completed jobs.

counters

Type: Counters structure

The run's result counters.

created

Type: timestamp (string|DateTime or anything parsable by strtotime)

When the run was created.

customerArtifactPaths

Type: CustomerArtifactPaths structure

Output CustomerArtifactPaths object for the test run.

deviceMinutes

Type: DeviceMinutes structure

Represents the total (metered or unmetered) minutes used by the test run.

devicePoolArn

Type: string

The ARN of the device pool for the run.

deviceSelectionResult

Type: DeviceSelectionResult structure

The results of a device filter used to select the devices for a test run.

eventCount

Type: int

For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.

jobTimeoutMinutes

Type: int

The number of minutes the job executes before it times out.

locale

Type: string

Information about the locale that is used for the run.

location

Type: Location structure

Information about the location that is used for the run.

message

Type: string

A message about the run's result.

name

Type: string

The run's name.

networkProfile

Type: NetworkProfile structure

The network profile being used for a test run.

parsingResultUrl

Type: string

Read-only URL for an object in an S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.

platform

Type: string

The run's platform.

Allowed values include:

ANDROID
IOS

radios

Type: Radios structure

Information about the radio states for the run.

result

Type: string

The run's result.

Allowed values include:

PENDING
PASSED
WARNED
FAILED
SKIPPED
ERRORED
STOPPED

resultCode

Type: string

Supporting field for the result field. Set only if result is SKIPPED. PARSING_FAILED if the result is skipped because of test package parsing failure.

seed

Type: int

For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.

skipAppResign

Type: boolean

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

started

Type: timestamp (string|DateTime or anything parsable by strtotime)

The run's start time.

status

Type: string

The run's status.

Allowed values include:

PENDING
PENDING_CONCURRENCY
PENDING_DEVICE
PROCESSING
SCHEDULING
PREPARING
RUNNING
COMPLETED
STOPPING

stopped

Type: timestamp (string|DateTime or anything parsable by strtotime)

The run's stop time.

testSpecArn

Type: string

The ARN of the YAML-formatted test specification for the run.

totalJobs

Type: int

The total number of jobs for the run.

type

Type: string

The run's type.

Must be one of the following values:

BUILTIN_FUZZ
BUILTIN_EXPLORER

For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
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

vpcConfig

Type: VpcConfig structure

The VPC security groups and subnets that are attached to a project.

webUrl

Type: string

The Device Farm console URL for the recording of the run.

Sample

Description

Represents a sample of performance data.

Members

arn

Type: string

The sample's ARN.

type

Type: string

The sample's type.

Must be one of the following values:

CPU: A CPU sample type. This is expressed as the app processing CPU time (including child processes) as reported by process, as a percentage.
MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app process, in kilobytes.
NATIVE_AVG_DRAWTIME
NATIVE_FPS
NATIVE_FRAMES
NATIVE_MAX_DRAWTIME
NATIVE_MIN_DRAWTIME
OPENGL_AVG_DRAWTIME
OPENGL_FPS
OPENGL_FRAMES
OPENGL_MAX_DRAWTIME
OPENGL_MIN_DRAWTIME
RX
RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, by app process.
THREADS: A threads sample type. This is expressed as the total number of threads per app process.
TX
TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process.

url

Type: string

The presigned Amazon S3 URL that can be used with a GET request to download the sample's file.

ScheduleRunConfiguration

Description

Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles.

Members

auxiliaryApps

Type: Array of strings

A list of upload ARNs for app packages to be installed with your app.

billingMethod

Type: string

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

If you have purchased unmetered device slots, you must set this parameter to unmetered to make use of them. Otherwise, your run counts against your metered time.

customerArtifactPaths

Type: CustomerArtifactPaths structure

Input CustomerArtifactPaths object for the scheduled run configuration.

extraDataPackageArn

Type: string

The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm extracts to external data for Android or the app's sandbox for iOS.

locale

Type: string

Information about the locale that is used for the run.

location

Type: Location structure

Information about the location that is used for the run.

networkProfileArn

Type: string

Reserved for internal use.

radios

Type: Radios structure

Information about the radio states for the run.

vpceConfigurationArns

Type: Array of strings

An array of ARNs for your VPC endpoint configurations.

ScheduleRunTest

Description

Represents test settings. This data structure is passed in as the test parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.

Members

filter

Type: string

The test's filter.

parameters

Type: Associative array of custom strings keys (String) to strings

The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.

For all tests:

app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to false to disable it.

For Calabash tests:

profile: A cucumber profile (for example, my_profile_name).
tags: You can limit execution to features or scenarios that have (or don't have) certain tags (for example, @smoke or @smoke,~@wip).

For Appium tests (all types):

appium_version: The Appium version. Currently supported values are 1.6.5 (and later), latest, and default.
- latest runs the latest Appium version supported by Device Farm (1.9.1).
- For default, Device Farm selects a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier and 1.7.2 for iOS 10 and later.
- This behavior is subject to change.

For fuzz tests (Android only):

event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.
throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.
seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.

For Explorer tests:

username: A user name to use if the Explorer encounters a login form. If not supplied, no user name is inserted.
password: A password to use if the Explorer encounters a login form. If not supplied, no password is inserted.

For Instrumentation:

filter: A test filter string. Examples:
- Running a single test case: com.android.abc.Test1
- Running a single test: com.android.abc.Test1#smoke
- Running multiple tests: com.android.abc.Test1,com.android.abc.Test2

For XCTest and XCTestUI:

filter: A test filter string. Examples:
- Running a single test class: LoginTests
- Running a multiple test classes: LoginTests,SmokeTests
- Running a single test: LoginTests/testValid
- Running multiple tests: LoginTests/testValid,LoginTests/testInvalid

For UIAutomator:

filter: A test filter string. Examples:
- Running a single test case: com.android.abc.Test1
- Running a single test: com.android.abc.Test1#smoke
- Running multiple tests: com.android.abc.Test1,com.android.abc.Test2

testPackageArn

Type: string

The ARN of the uploaded test to be run.

testSpecArn

Type: string

The ARN of the YAML-formatted test specification.

type

Required: Yes
Type: string

The test's type.

Must be one of the following values:

BUILTIN_FUZZ
BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
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

ServiceAccountException

Description

There was a problem with the service account.

Members

message

Type: string

Any additional information about the exception.

Suite

Description

Represents a collection of one or more tests.

Members

arn

Type: string

The suite's ARN.

counters

Type: Counters structure

The suite's result counters.

created

Type: timestamp (string|DateTime or anything parsable by strtotime)

When the suite was created.

deviceMinutes

Type: DeviceMinutes structure

Represents the total (metered or unmetered) minutes used by the test suite.

message

Type: string

A message about the suite's result.

name

Type: string

The suite's name.

result

Type: string

The suite's result.

Allowed values include:

PENDING
PASSED
WARNED
FAILED
SKIPPED
ERRORED
STOPPED

started

Type: timestamp (string|DateTime or anything parsable by strtotime)

The suite's start time.

status

Type: string

The suite's status.

Allowed values include:

PENDING
PENDING_CONCURRENCY
PENDING_DEVICE
PROCESSING
SCHEDULING
PREPARING
RUNNING
COMPLETED
STOPPING

stopped

Type: timestamp (string|DateTime or anything parsable by strtotime)

The suite's stop time.

type

Type: string

The suite's type.

Must be one of the following values:

BUILTIN_FUZZ
BUILTIN_EXPLORER

Only available for Android; an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
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

Tag

Description

The metadata that you apply to a resource to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.

Members

Key

Required: Yes
Type: string

One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

Value

Required: Yes
Type: string

The optional part of a key-value pair that makes up a tag. A value acts as a descriptor in a tag category (key).

TagOperationException

Description

The operation was not successful. Try again.

Members

message

Type: string

resourceName

Type: string

TagPolicyException

Description

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

Members

message

Type: string

resourceName

Type: string

Test

Description

Represents a condition that is evaluated.

Members

arn

Type: string

The test's ARN.

counters

Type: Counters structure

The test's result counters.

created

Type: timestamp (string|DateTime or anything parsable by strtotime)

When the test was created.

deviceMinutes

Type: DeviceMinutes structure

Represents the total (metered or unmetered) minutes used by the test.

message

Type: string

A message about the test's result.

name

Type: string

The test's name.

result

Type: string

The test's result.

Allowed values include:

PENDING
PASSED
WARNED
FAILED
SKIPPED
ERRORED
STOPPED

started

Type: timestamp (string|DateTime or anything parsable by strtotime)

The test's start time.

status

Type: string

The test's status.

Allowed values include:

PENDING
PENDING_CONCURRENCY
PENDING_DEVICE
PROCESSING
SCHEDULING
PREPARING
RUNNING
COMPLETED
STOPPING

stopped

Type: timestamp (string|DateTime or anything parsable by strtotime)

The test's stop time.

type

Type: string

The test's type.

Must be one of the following values:

BUILTIN_FUZZ
BUILTIN_EXPLORER

For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
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

TestGridProject

Description

A Selenium testing project. Projects are used to collect and collate sessions.

Members

arn

Type: string

The ARN for the project.

created

Type: timestamp (string|DateTime or anything parsable by strtotime)

When the project was created.

description

Type: string

A human-readable description for the project.

name

Type: string

A human-readable name for the project.

vpcConfig

Type: TestGridVpcConfig structure

The VPC security groups and subnets that are attached to a project.

TestGridSession

Description

A TestGridSession is a single instance of a browser launched from the URL provided by a call to CreateTestGridUrl.

Members

arn

Type: string

The ARN of the session.

billingMinutes

Type: double

The number of billed minutes that were used for this session.

created

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the session was started.

ended

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the session ended.

seleniumProperties

Type: string

A JSON object of options and parameters passed to the Selenium WebDriver.

status

Type: string

The state of the session.

TestGridSessionAction

Description

An action taken by a TestGridSession browser instance.

Members

action

Type: string

The action taken by the session.

duration

Type: long (int|float)

The time, in milliseconds, that the action took to complete in the browser.

requestMethod

Type: string

HTTP method that the browser used to make the request.

started

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the session invoked the action.

statusCode

Type: string

HTTP status code returned to the browser when the action was taken.

TestGridSessionArtifact

Description

Artifacts are video and other files that are produced in the process of running a browser in an automated context.

Video elements might be broken up into multiple artifacts as they grow in size during creation.

Members

filename

Type: string

The file name of the artifact.

type

Type: string

The kind of artifact.

url

Type: string

A semi-stable URL to the content of the object.

TestGridVpcConfig

Description

The VPC security groups and subnets that are attached to a project.

Members

securityGroupIds

Required: Yes
Type: Array of strings

A list of VPC security group IDs in your Amazon VPC.

subnetIds

Required: Yes
Type: Array of strings

A list of VPC subnet IDs in your Amazon VPC.

vpcId

Required: Yes
Type: string

The ID of the Amazon VPC.

TooManyTagsException

Description

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.

Members

message

Type: string

resourceName

Type: string

TrialMinutes

Description

Represents information about free trial device minutes for an AWS account.

Members

remaining

Type: double

The number of free trial minutes remaining in the account.

total

Type: double

The total number of free trial minutes that the account started with.

UniqueProblem

Description

A collection of one or more problems, grouped by their result.

Members

message

Type: string

A message about the unique problems' result.

problems

Type: Array of Problem structures

Information about the problems.

Upload

Description

An app or a set of one or more tests to upload or that have been uploaded.

Members

arn

Type: string

The upload's ARN.

category

Type: string

The upload's category. Allowed values include:

CURATED: An upload managed by AWS Device Farm.
PRIVATE: An upload managed by the AWS Device Farm customer.

contentType

Type: string

The upload's content type (for example, application/octet-stream).

created

Type: timestamp (string|DateTime or anything parsable by strtotime)

When the upload was created.

message

Type: string

A message about the upload's result.

metadata

Type: string

The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.

name

Type: string

The upload's file name.

status

Type: string

The upload's status.

Must be one of the following values:

FAILED
INITIALIZED
PROCESSING
SUCCEEDED

type

Type: string

The upload's type.

Must be one of the following values:

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

Type: string

The presigned Amazon S3 URL that was used to store a file using a PUT request.

VPCEConfiguration

Description

Represents an Amazon Virtual Private Cloud (VPC) endpoint configuration.

Members

arn

Type: string

The Amazon Resource Name (ARN) of the VPC endpoint configuration.

serviceDnsName

Type: string

The DNS name that maps to the private IP address of the service you want to access.

vpceConfigurationDescription

Type: string

An optional description that provides details about your VPC endpoint configuration.

vpceConfigurationName

Type: string

The friendly name you give to your VPC endpoint configuration to manage your configurations more easily.

vpceServiceName

Type: string

The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.

VpcConfig

Description

Contains the VPC configuration data necessary to interface with AWS Device Farm's services.

Members

securityGroupIds

Required: Yes
Type: Array of strings

An array of one or more security groups IDs in your Amazon VPC.

subnetIds

Required: Yes
Type: Array of strings

An array of one or more subnet IDs in your Amazon VPC.

vpcId

Required: Yes
Type: string

The ID of the Amazon VPC.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Device Farm 2015-06-23

Operation Summary

Paginators

Operations

CreateDevicePool

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a new device pool

CreateInstanceProfile

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateNetworkProfile

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateProject

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a new project

CreateRemoteAccessSession

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a remote access session

CreateTestGridProject

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateTestGridUrl

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateUpload

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors