String awsAccountNumber
The AWS account number specified in the AccountSettings
container.
Map<K,V> unmeteredDevices
Returns the unmetered devices you have purchased or want to purchase.
Map<K,V> unmeteredRemoteAccessDevices
Returns the unmetered remote access devices you have purchased or want to purchase.
Integer maxJobTimeoutMinutes
The maximum number of minutes a test run executes before it times out.
TrialMinutes trialMinutes
Information about an AWS account's usage of free trial device minutes.
Map<K,V> maxSlots
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.
Integer defaultJobTimeoutMinutes
The default number of minutes (at the account level) a test run executes before it times out. The default value is 150 minutes.
Boolean skipAppResign
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.
String arn
The artifact's ARN.
String name
The artifact's name.
String type
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
String extension
The artifact's file extension.
String url
The presigned Amazon S3 URL that can be used with a GET request to download the artifact's file.
Integer total
The total number of entities.
Integer passed
The number of passed entities.
Integer failed
The number of failed entities.
Integer warned
The number of warned entities.
Integer errored
The number of errored entities.
Integer stopped
The number of stopped entities.
Integer skipped
The number of skipped entities.
String projectArn
The ARN of the project for the device pool.
String name
The device pool's name.
String description
The device pool's description.
List<E> rules
The device pool's rules.
Integer maxDevices
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.
DevicePool devicePool
The newly created device pool.
String name
The name of your instance profile.
String description
The description of your instance profile.
Boolean packageCleanup
When set to true
, Device Farm removes app packages after a test run. The default value is
false
for private devices.
List<E> excludeAppPackagesFromCleanup
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
.
Boolean rebootAfterUse
When set to true
, Device Farm reboots the instance after a test run. The default value is
true
.
InstanceProfile instanceProfile
An object that contains information about your instance profile.
String projectArn
The Amazon Resource Name (ARN) of the project for which you want to create a network profile.
String name
The name for the new network profile.
String description
The description of the network profile.
String type
The type of network profile to create. Valid values are listed here.
Long uplinkBandwidthBits
The data throughput rate in bits per second, as an integer from 0 to 104857600.
Long downlinkBandwidthBits
The data throughput rate in bits per second, as an integer from 0 to 104857600.
Long uplinkDelayMs
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
Long downlinkDelayMs
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
Long uplinkJitterMs
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
Long downlinkJitterMs
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
Integer uplinkLossPercent
Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
Integer downlinkLossPercent
Proportion of received packets that fail to arrive from 0 to 100 percent.
NetworkProfile networkProfile
The network profile that is returned by the create network profile request.
Project project
The newly created project.
String projectArn
The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
String deviceArn
The ARN of the device for which you want to create a remote access session.
String instanceArn
The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
String sshPublicKey
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.
Boolean remoteDebugEnabled
Set to true
if you want to access devices remotely for debugging in your remote access session.
Remote debugging is no longer supported.
Boolean remoteRecordEnabled
Set to true
to enable remote recording for the remote access session.
String remoteRecordAppArn
The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
String name
The name of the remote access session to create.
String clientId
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.
CreateRemoteAccessSessionConfiguration configuration
The configuration information for the remote access session request.
String interactionMode
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.
Boolean skipAppResign
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?
RemoteAccessSession remoteAccessSession
A container that describes the remote access session when the request to create a remote access session is sent.
String name
Human-readable name of the Selenium testing project.
String description
Human-readable description of the project.
TestGridVpcConfig vpcConfig
The VPC security groups and subnets that are attached to a project.
TestGridProject testGridProject
ARN of the Selenium testing project that was created.
String projectArn
ARN (from CreateTestGridProject or ListTestGridProjects) to associate with the short-term URL.
Integer expiresInSeconds
Lifetime, in seconds, of the URL.
String url
A signed URL, expiring in CreateTestGridUrlRequest$expiresInSeconds seconds, to be passed to a
RemoteWebDriver
.
Date expires
The number of seconds the URL from CreateTestGridUrlResult$url stays active.
String projectArn
The ARN of the project for the upload.
String name
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.
String type
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.
String contentType
The upload's content type (for example, application/octet-stream
).
Upload upload
The newly created upload.
String vpceConfigurationName
The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.
String vpceServiceName
The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.
String serviceDnsName
The DNS name of the service running in your VPC that you want Device Farm to test.
String vpceConfigurationDescription
An optional description that provides details about your VPC endpoint configuration.
VPCEConfiguration vpceConfiguration
An object that contains information about your VPC endpoint configuration.
List<E> iosPaths
Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests are pulled from.
List<E> androidPaths
Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests are pulled from.
List<E> deviceHostPaths
Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests are pulled from.
String arn
Represents the Amazon Resource Name (ARN) of the Device Farm device pool to delete.
String arn
The Amazon Resource Name (ARN) of the instance profile you are requesting to delete.
String arn
The ARN of the network profile to delete.
String arn
Represents the Amazon Resource Name (ARN) of the Device Farm project to delete.
String arn
The Amazon Resource Name (ARN) of the session for which you want to delete remote access.
String arn
The Amazon Resource Name (ARN) for the run to delete.
String projectArn
The ARN of the project to delete, from CreateTestGridProject or ListTestGridProjects.
String arn
Represents the Amazon Resource Name (ARN) of the Device Farm upload to delete.
String arn
The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to delete.
String arn
The device's ARN.
String name
The device's display name.
String manufacturer
The device's manufacturer name.
String model
The device's model name.
String modelId
The device's model ID.
String formFactor
The device's form factor.
Allowed values include:
PHONE
TABLET
String platform
The device's platform.
Allowed values include:
ANDROID
IOS
String os
The device's operating system type.
CPU cpu
Information about the device's CPU.
Resolution resolution
The resolution of the device.
Long heapSize
The device's heap size, expressed in bytes.
Long memory
The device's total memory size, expressed in bytes.
String image
The device's image name.
String carrier
The device's carrier.
String radio
The device's radio.
Boolean remoteAccessEnabled
Specifies whether remote access has been enabled for the specified device.
Boolean remoteDebugEnabled
This flag is set to true
if remote debugging is enabled for the device.
Remote debugging is no longer supported.
String fleetType
The type of fleet to which this device belongs. Possible values are PRIVATE and PUBLIC.
String fleetName
The name of the fleet to which this device belongs.
List<E> instances
The instances that belong to this device.
String availability
Indicates how likely a device is available for a test run. Currently available in the ListDevices and GetDevice API methods.
String attribute
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.
The Amazon Resource Name (ARN) of the device (for example,
arn:aws:devicefarm:us-west-2::device:12345Example
).
Supported operators: EQUALS
, IN
, NOT_IN
The device platform. Valid values are ANDROID or IOS.
Supported operators: EQUALS
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
The device model (for example, iPad 5th Gen).
Supported operators: CONTAINS
, EQUALS
, IN
, NOT_IN
The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
Supported operators: EQUALS
The device form factor. Valid values are PHONE or TABLET.
Supported operators: EQUALS
The device manufacturer (for example, Apple).
Supported operators: EQUALS
, IN
, NOT_IN
Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
Supported operators: EQUALS
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.
The Amazon Resource Name (ARN) of the device instance.
Supported operators: EQUALS
, IN
, NOT_IN
The label of the device instance.
Supported operators: CONTAINS
The fleet type. Valid values are PUBLIC or PRIVATE.
Supported operators: EQUALS
String operator
Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.
List<E> values
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.
String arn
The Amazon Resource Name (ARN) of the device instance.
String deviceArn
The ARN of the device.
List<E> labels
An array of strings that describe the device instance.
String status
The status of the device instance. Valid values are listed here.
String udid
Unique device identifier for the device instance.
InstanceProfile instanceProfile
A object that contains information about the instance profile.
Double total
When specified, represents the total minutes used by the resource to run tests.
Double metered
When specified, represents only the sum of metered minutes used by the resource to run tests.
Double unmetered
When specified, represents only the sum of unmetered minutes used by the resource to run tests.
String arn
The device pool's ARN.
String name
The device pool's name.
String description
The device pool's description.
String type
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.
List<E> rules
Information about the device pool's rules.
Integer maxDevices
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.
List<E> filters
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.
Integer maxDevices
The maximum number of devices to be included in a test run.
List<E> filters
The filters in a device selection result.
Integer matchedDevicesCount
The number of devices that matched the device filter selection criteria.
Integer maxDevices
The maximum number of devices to be selected by a device filter and included in a test run.
Integer jobTimeoutMinutes
The number of minutes a test run executes before it times out.
Boolean accountsCleanup
True if account cleanup is enabled at the beginning of the test. Otherwise, false.
Boolean appPackagesCleanup
True if app package cleanup is enabled at the beginning of the test. Otherwise, false.
Boolean videoCapture
Set to true to enable video capture. Otherwise, set to false. The default is true.
Boolean skipAppResign
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.
AccountSettings accountSettings
The account settings.
String arn
The Amazon Resource Name (ARN) of the instance you're requesting information about.
DeviceInstance deviceInstance
An object that contains information about your device instance.
String devicePoolArn
The device pool's ARN.
String appArn
The ARN of the app that is associated with the specified device pool.
String testType
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.
ScheduleRunTest test
Information about the uploaded test to be run against the device pool.
ScheduleRunConfiguration configuration
An object that contains information about the settings for a run.
String arn
The device pool's ARN.
DevicePool devicePool
An object that contains information about the requested device pool.
String arn
The device type's ARN.
Device device
An object that contains information about the requested device.
String arn
The Amazon Resource Name (ARN) of an instance profile.
InstanceProfile instanceProfile
An object that contains information about an instance profile.
String arn
The job's ARN.
Job job
An object that contains information about the requested job.
String arn
The ARN of the network profile to return information about.
NetworkProfile networkProfile
The network profile.
String nextToken
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.
Map<K,V> current
When specified, gets the offering status for the current period.
Map<K,V> nextPeriod
When specified, gets the offering status for the next period.
String nextToken
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.
String arn
The project's ARN.
Project project
The project to get information about.
String arn
The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.
RemoteAccessSession remoteAccessSession
A container that lists detailed information about the remote access session.
String arn
The run's ARN.
Run run
The run to get results from.
String arn
The suite's ARN.
Suite suite
A collection of one or more tests.
String projectArn
The ARN of the Selenium testing project, from either CreateTestGridProject or ListTestGridProjects.
TestGridProject testGridProject
String projectArn
The ARN for the project that this session belongs to. See CreateTestGridProject and ListTestGridProjects.
String sessionId
An ID associated with this session.
String sessionArn
An ARN that uniquely identifies a TestGridSession.
TestGridSession testGridSession
The TestGridSession that was requested.
String arn
The test's ARN.
Test test
A test condition that is evaluated.
String arn
The upload's ARN.
Upload upload
An app or a set of one or more tests to upload or that have been uploaded.
String arn
The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to describe.
VPCEConfiguration vpceConfiguration
An object that contains information about your VPC endpoint configuration.
Upload appUpload
An app to upload or that has been uploaded.
String arn
The Amazon Resource Name (ARN) of the instance profile.
Boolean packageCleanup
When set to true
, Device Farm removes app packages after a test run. The default value is
false
for private devices.
List<E> excludeAppPackagesFromCleanup
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
.
Boolean rebootAfterUse
When set to true
, Device Farm reboots the instance after a test run. The default value is
true
.
String name
The name of the instance profile.
String description
The description of the instance profile.
String arn
The job's ARN.
String name
The job's name.
String type
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
Date created
When the job was created.
String status
The job's status.
Allowed values include:
PENDING
PENDING_CONCURRENCY
PENDING_DEVICE
PROCESSING
SCHEDULING
PREPARING
RUNNING
COMPLETED
STOPPING
String result
The job's result.
Allowed values include:
PENDING
PASSED
WARNED
FAILED
SKIPPED
ERRORED
STOPPED
Date started
The job's start time.
Date stopped
The job's stop time.
Counters counters
The job's result counters.
String message
A message about the job's result.
Device device
The device (phone or tablet).
String instanceArn
The ARN of the instance.
DeviceMinutes deviceMinutes
Represents the total (metered or unmetered) minutes used by the job.
String videoEndpoint
The endpoint for streaming device video.
Boolean videoCapture
This value is set to true if video capture is enabled. Otherwise, it is set to false.
String arn
The project ARN.
String type
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.
String nextToken
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.
List<E> devicePools
Information about the device pools.
String nextToken
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.
String arn
The Amazon Resource Name (ARN) of the project.
String nextToken
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.
List<E> filters
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.
String arn
The Amazon Resource Name (ARN) of the project for which you want to list network profiles.
String type
The type of network profile to return information about. Valid values are listed here.
String nextToken
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.
String nextToken
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.
String nextToken
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.
String nextToken
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.
List<E> offeringTransactions
The audit log of subscriptions you have purchased and modified through AWS Device Farm.
String nextToken
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.
String arn
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.
String nextToken
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.
List<E> remoteAccessSessions
A container that represents the metadata from the service about each remote access session you are requesting.
String nextToken
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.
String resourceARN
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
.
List<E> testGridProjects
The list of TestGridProjects, based on a ListTestGridProjectsRequest.
String nextToken
Used for pagination. Pass into ListTestGridProjects to get more results in a paginated request.
String sessionArn
The ARN of a TestGridSession.
String type
Limit results to a specified type of artifact.
Integer maxResult
The maximum number of results to be returned by a request.
String nextToken
Pagination token.
List<E> artifacts
A list of test grid session artifacts for a TestGridSession.
String nextToken
Pagination token.
String projectArn
ARN of a TestGridProject.
String status
Return only sessions in this state.
Date creationTimeAfter
Return only sessions created after this time.
Date creationTimeBefore
Return only sessions created before this time.
Date endTimeAfter
Return only sessions that ended after this time.
Date endTimeBefore
Return only sessions that ended before this time.
Integer maxResult
Return only this many results at a time.
String nextToken
Pagination token.
List<E> testGridSessions
The sessions that match the criteria in a ListTestGridSessionsRequest.
String nextToken
Pagination token.
Map<K,V> uniqueProblems
Information about the unique problems.
Allowed values include:
PENDING
PASSED
WARNED
FAILED
SKIPPED
ERRORED
STOPPED
String nextToken
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.
String arn
The Amazon Resource Name (ARN) of the project for which you want to list uploads.
String type
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
String nextToken
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.
List<E> vpceConfigurations
An array of VPCEConfiguration
objects that contain information about your VPC endpoint
configuration.
String nextToken
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.
String arn
The Amazon Resource Name (ARN) of the network profile.
String name
The name of the network profile.
String description
The description of the network profile.
String type
The type of network profile. Valid values are listed here.
Long uplinkBandwidthBits
The data throughput rate in bits per second, as an integer from 0 to 104857600.
Long downlinkBandwidthBits
The data throughput rate in bits per second, as an integer from 0 to 104857600.
Long uplinkDelayMs
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
Long downlinkDelayMs
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
Long uplinkJitterMs
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
Long downlinkJitterMs
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
Integer uplinkLossPercent
Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
Integer downlinkLossPercent
Proportion of received packets that fail to arrive from 0 to 100 percent.
String id
The ID that corresponds to a device offering.
String description
A string that describes the offering.
String type
The type of offering (for example, RECURRING
) for a device.
String platform
The platform of the device (for example, ANDROID
or IOS
).
List<E> recurringCharges
Specifies whether there are recurring charges for the offering.
OfferingStatus offeringStatus
The status of an offering transaction.
String transactionId
The transaction ID of the offering transaction.
String offeringPromotionId
The ID that corresponds to a device offering promotion.
Date createdOn
The date on which an offering transaction was created.
MonetaryAmount cost
The cost of an offering transaction.
ProblemDetail run
Information about the associated run.
ProblemDetail job
Information about the associated job.
ProblemDetail suite
Information about the associated suite.
ProblemDetail test
Information about the associated test.
Device device
Information about the associated device.
String result
The problem's result.
Allowed values include:
PENDING
PASSED
WARNED
FAILED
SKIPPED
ERRORED
STOPPED
String message
A message about the problem's result.
String arn
The project's ARN.
String name
The project's name.
Integer defaultJobTimeoutMinutes
The default number of minutes (at the project level) a test run executes before it times out. The default value is 150 minutes.
Date created
When the project was created.
OfferingTransaction offeringTransaction
Represents the offering transaction for the purchase result.
Boolean wifi
True if Wi-Fi is enabled at the beginning of the test. Otherwise, false.
Boolean bluetooth
True if Bluetooth is enabled at the beginning of the test. Otherwise, false.
Boolean nfc
True if NFC is enabled at the beginning of the test. Otherwise, false.
Boolean gps
True if GPS is enabled at the beginning of the test. Otherwise, false.
MonetaryAmount cost
The cost of the recurring charge.
String frequency
The frequency in which charges recur.
String arn
The Amazon Resource Name (ARN) of the remote access session.
String name
The name of the remote access session.
Date created
The date and time the remote access session was created.
String status
The status of the remote access session. Can be any of the following:
PENDING.
PENDING_CONCURRENCY.
PENDING_DEVICE.
PROCESSING.
SCHEDULING.
PREPARING.
RUNNING.
COMPLETED.
STOPPING.
String result
The result of the remote access session. Can be any of the following:
PENDING.
PASSED.
WARNED.
FAILED.
SKIPPED.
ERRORED.
STOPPED.
String message
A message about the remote access session.
Date started
The date and time the remote access session was started.
Date stopped
The date and time the remote access session was stopped.
Device device
The device (phone or tablet) used in the remote access session.
String instanceArn
The ARN of the instance.
Boolean remoteDebugEnabled
This flag is set to true
if remote debugging is enabled for the remote access session.
Remote debugging is no longer supported.
Boolean remoteRecordEnabled
This flag is set to true
if remote recording is enabled for the remote access session.
String remoteRecordAppArn
The ARN for the app to be recorded in the remote access session.
String hostAddress
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.
String clientId
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.
String billingMethod
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.
DeviceMinutes deviceMinutes
The number of minutes a device is used in a remote access session (including setup and teardown minutes).
String endpoint
The endpoint for the remote access sesssion.
String deviceUdid
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.
String interactionMode
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.
Boolean skipAppResign
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.
OfferingTransaction offeringTransaction
Represents the status of the offering transaction for the renewal.
String attribute
The rule's stringified attribute. For example, specify the value as "\"abc\""
.
The supported operators for each attribute are provided in the following list.
The Appium version for the test.
Supported operators: CONTAINS
The Amazon Resource Name (ARN) of the device (for example,
arn:aws:devicefarm:us-west-2::device:12345Example
.
Supported operators: EQUALS
, IN
, NOT_IN
The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
Supported operators: EQUALS
The fleet type. Valid values are PUBLIC or PRIVATE.
Supported operators: EQUALS
The device form factor. Valid values are PHONE or TABLET.
Supported operators: EQUALS
, IN
, NOT_IN
The Amazon Resource Name (ARN) of the device instance.
Supported operators: IN
, NOT_IN
The label of the device instance.
Supported operators: CONTAINS
The device manufacturer (for example, Apple).
Supported operators: EQUALS
, IN
, NOT_IN
The device model, such as Apple iPad Air 2 or Google Pixel.
Supported operators: CONTAINS
, EQUALS
, IN
, NOT_IN
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
The device platform. Valid values are ANDROID or IOS.
Supported operators: EQUALS
, IN
, NOT_IN
Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
Supported operators: EQUALS
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.
String operator
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.
String value
The rule's value.
String arn
The run's ARN.
String name
The run's name.
String type
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
String platform
The run's platform.
Allowed values include:
ANDROID
IOS
Date created
When the run was created.
String status
The run's status.
Allowed values include:
PENDING
PENDING_CONCURRENCY
PENDING_DEVICE
PROCESSING
SCHEDULING
PREPARING
RUNNING
COMPLETED
STOPPING
String result
The run's result.
Allowed values include:
PENDING
PASSED
WARNED
FAILED
SKIPPED
ERRORED
STOPPED
Date started
The run's start time.
Date stopped
The run's stop time.
Counters counters
The run's result counters.
String message
A message about the run's result.
Integer totalJobs
The total number of jobs for the run.
Integer completedJobs
The total number of completed jobs.
String billingMethod
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.
DeviceMinutes deviceMinutes
Represents the total (metered or unmetered) minutes used by the test run.
NetworkProfile networkProfile
The network profile being used for a test run.
String parsingResultUrl
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.
String resultCode
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.
Integer seed
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.
String appUpload
An app to upload or that has been uploaded.
Integer eventCount
For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
Integer jobTimeoutMinutes
The number of minutes the job executes before it times out.
String devicePoolArn
The ARN of the device pool for the run.
String locale
Information about the locale that is used for the run.
Radios radios
Information about the radio states for the run.
Location location
Information about the location that is used for the run.
CustomerArtifactPaths customerArtifactPaths
Output CustomerArtifactPaths
object for the test run.
String webUrl
The Device Farm console URL for the recording of the run.
Boolean skipAppResign
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.
String testSpecArn
The ARN of the YAML-formatted test specification for the run.
DeviceSelectionResult deviceSelectionResult
The results of a device filter used to select the devices for a test run.
String arn
The sample's ARN.
String type
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.
String url
The presigned Amazon S3 URL that can be used with a GET request to download the sample's file.
String extraDataPackageArn
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.
String networkProfileArn
Reserved for internal use.
String locale
Information about the locale that is used for the run.
Location location
Information about the location that is used for the run.
List<E> vpceConfigurationArns
An array of ARNs for your VPC endpoint configurations.
CustomerArtifactPaths customerArtifactPaths
Input CustomerArtifactPaths
object for the scheduled run configuration.
Radios radios
Information about the radio states for the run.
List<E> auxiliaryApps
A list of upload ARNs for app packages to be installed with your app.
String billingMethod
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.
String projectArn
The ARN of the project for the run to be scheduled.
String appArn
The ARN of an application package to run tests against, created with CreateUpload. See ListUploads.
String devicePoolArn
The ARN of the device pool for the run to be scheduled.
DeviceSelectionConfiguration deviceSelectionConfiguration
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.
String name
The name for the run to be scheduled.
ScheduleRunTest test
Information about the test for the run to be scheduled.
ScheduleRunConfiguration configuration
Information about the settings for the run to be scheduled.
ExecutionConfiguration executionConfiguration
Specifies configuration information about a test run, such as the execution timeout (in minutes).
Run run
Information about the scheduled run.
String type
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
String testPackageArn
The ARN of the uploaded test to be run.
String testSpecArn
The ARN of the YAML-formatted test specification.
String filter
The test's filter.
Map<K,V> parameters
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
String arn
Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.
Job job
The job that was stopped.
String arn
The Amazon Resource Name (ARN) of the remote access session to stop.
RemoteAccessSession remoteAccessSession
A container that represents the metadata from the service about the remote access session you are stopping.
String arn
Represents the Amazon Resource Name (ARN) of the Device Farm run to stop.
Run run
The run that was stopped.
String arn
The suite's ARN.
String name
The suite's name.
String type
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
Date created
When the suite was created.
String status
The suite's status.
Allowed values include:
PENDING
PENDING_CONCURRENCY
PENDING_DEVICE
PROCESSING
SCHEDULING
PREPARING
RUNNING
COMPLETED
STOPPING
String result
The suite's result.
Allowed values include:
PENDING
PASSED
WARNED
FAILED
SKIPPED
ERRORED
STOPPED
Date started
The suite's start time.
Date stopped
The suite's stop time.
Counters counters
The suite's result counters.
String message
A message about the suite's result.
DeviceMinutes deviceMinutes
Represents the total (metered or unmetered) minutes used by the test suite.
String resourceName
String resourceName
String resourceARN
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
.
List<E> tags
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.
String arn
The test's ARN.
String name
The test's name.
String type
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
Date created
When the test was created.
String status
The test's status.
Allowed values include:
PENDING
PENDING_CONCURRENCY
PENDING_DEVICE
PROCESSING
SCHEDULING
PREPARING
RUNNING
COMPLETED
STOPPING
String result
The test's result.
Allowed values include:
PENDING
PASSED
WARNED
FAILED
SKIPPED
ERRORED
STOPPED
Date started
The test's start time.
Date stopped
The test's stop time.
Counters counters
The test's result counters.
String message
A message about the test's result.
DeviceMinutes deviceMinutes
Represents the total (metered or unmetered) minutes used by the test.
String arn
The ARN for the project.
String name
A human-readable name for the project.
String description
A human-readable description for the project.
TestGridVpcConfig vpcConfig
The VPC security groups and subnets that are attached to a project.
Date created
When the project was created.
String arn
The ARN of the session.
String status
The state of the session.
Date created
The time that the session was started.
Date ended
The time the session ended.
Double billingMinutes
The number of billed minutes that were used for this session.
String seleniumProperties
A JSON object of options and parameters passed to the Selenium WebDriver.
String action
The action taken by the session.
Date started
The time that the session invoked the action.
Long duration
The time, in milliseconds, that the action took to complete in the browser.
String statusCode
HTTP status code returned to the browser when the action was taken.
String requestMethod
HTTP method that the browser used to make the request.
String resourceName
String resourceARN
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
.
List<E> tagKeys
The keys of the tags to be removed.
DeviceInstance deviceInstance
An object that contains information about your device instance.
String arn
The Amazon Resource Name (ARN) of the Device Farm device pool to update.
String name
A string that represents the name of the device pool to update.
String description
A description of the device pool to update.
List<E> rules
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.
Integer maxDevices
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.
Boolean clearMaxDevices
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.
DevicePool devicePool
The device pool you just updated.
String arn
The Amazon Resource Name (ARN) of the instance profile.
String name
The updated name for your instance profile.
String description
The updated description for your instance profile.
Boolean packageCleanup
The updated choice for whether you want to specify package cleanup. The default value is false
for
private devices.
List<E> excludeAppPackagesFromCleanup
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
.
Boolean rebootAfterUse
The updated choice for whether you want to reboot the device after use. The default value is true
.
InstanceProfile instanceProfile
An object that contains information about your instance profile.
String arn
The Amazon Resource Name (ARN) of the project for which you want to update network profile settings.
String name
The name of the network profile about which you are returning information.
String description
The description of the network profile about which you are returning information.
String type
The type of network profile to return information about. Valid values are listed here.
Long uplinkBandwidthBits
The data throughput rate in bits per second, as an integer from 0 to 104857600.
Long downlinkBandwidthBits
The data throughput rate in bits per second, as an integer from 0 to 104857600.
Long uplinkDelayMs
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
Long downlinkDelayMs
Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
Long uplinkJitterMs
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
Long downlinkJitterMs
Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
Integer uplinkLossPercent
Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
Integer downlinkLossPercent
Proportion of received packets that fail to arrive from 0 to 100 percent.
NetworkProfile networkProfile
A list of the available network profiles.
String arn
The Amazon Resource Name (ARN) of the project whose name to update.
String name
A string that represents the new name of the project that you are updating.
Integer defaultJobTimeoutMinutes
The number of minutes a test run in the project executes before it times out.
Project project
The project to update.
String projectArn
ARN of the project to update.
String name
Human-readable name for the project.
String description
Human-readable description for the project.
TestGridVpcConfig vpcConfig
The VPC security groups and subnets that are attached to a project.
TestGridProject testGridProject
The project, including updated information.
String arn
The Amazon Resource Name (ARN) of the uploaded test spec.
String name
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.
String contentType
The upload's content type (for example, application/x-yaml
).
Boolean editContent
Set to true if the YAML file has changed and must be updated. Otherwise, set to false.
Upload upload
A test spec uploaded to Device Farm.
String arn
The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to update.
String vpceConfigurationName
The friendly name you give to your VPC endpoint configuration to manage your configurations more easily.
String vpceServiceName
The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.
String serviceDnsName
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.
String vpceConfigurationDescription
An optional description that provides details about your VPC endpoint configuration.
VPCEConfiguration vpceConfiguration
An object that contains information about your VPC endpoint configuration.
String arn
The upload's ARN.
String name
The upload's file name.
Date created
When the upload was created.
String type
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
String status
The upload's status.
Must be one of the following values:
FAILED
INITIALIZED
PROCESSING
SUCCEEDED
String url
The presigned Amazon S3 URL that was used to store a file using a PUT request.
String metadata
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.
String contentType
The upload's content type (for example, application/octet-stream
).
String message
A message about the upload's result.
String category
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.
String arn
The Amazon Resource Name (ARN) of the VPC endpoint configuration.
String vpceConfigurationName
The friendly name you give to your VPC endpoint configuration to manage your configurations more easily.
String vpceServiceName
The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.
String serviceDnsName
The DNS name that maps to the private IP address of the service you want to access.
String vpceConfigurationDescription
An optional description that provides details about your VPC endpoint configuration.
Copyright © 2021. All rights reserved.