libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DeviceFarm.Lens

Contents

Description

 
Synopsis

Operations

ListProjects

listProjects_arn :: Lens' ListProjects (Maybe Text) Source #

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.

listProjects_nextToken :: Lens' ListProjects (Maybe Text) Source #

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.

listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text) Source #

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.

DeleteProject

deleteProject_arn :: Lens' DeleteProject Text Source #

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

UpdateProject

updateProject_name :: Lens' UpdateProject (Maybe Text) Source #

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

updateProject_defaultJobTimeoutMinutes :: Lens' UpdateProject (Maybe Int) Source #

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

updateProject_arn :: Lens' UpdateProject Text Source #

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

UpdateNetworkProfile

updateNetworkProfile_uplinkJitterMs :: Lens' UpdateNetworkProfile (Maybe Integer) Source #

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

updateNetworkProfile_uplinkLossPercent :: Lens' UpdateNetworkProfile (Maybe Natural) Source #

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

updateNetworkProfile_downlinkJitterMs :: Lens' UpdateNetworkProfile (Maybe Integer) Source #

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

updateNetworkProfile_name :: Lens' UpdateNetworkProfile (Maybe Text) Source #

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

updateNetworkProfile_downlinkLossPercent :: Lens' UpdateNetworkProfile (Maybe Natural) Source #

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

updateNetworkProfile_type :: Lens' UpdateNetworkProfile (Maybe NetworkProfileType) Source #

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

updateNetworkProfile_uplinkDelayMs :: Lens' UpdateNetworkProfile (Maybe Integer) Source #

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

updateNetworkProfile_uplinkBandwidthBits :: Lens' UpdateNetworkProfile (Maybe Integer) Source #

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

updateNetworkProfile_description :: Lens' UpdateNetworkProfile (Maybe Text) Source #

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

updateNetworkProfile_downlinkDelayMs :: Lens' UpdateNetworkProfile (Maybe Integer) Source #

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

updateNetworkProfile_downlinkBandwidthBits :: Lens' UpdateNetworkProfile (Maybe Integer) Source #

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

updateNetworkProfile_arn :: Lens' UpdateNetworkProfile Text Source #

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

DeleteNetworkProfile

deleteNetworkProfile_arn :: Lens' DeleteNetworkProfile Text Source #

The ARN of the network profile to delete.

GetDevicePoolCompatibility

getDevicePoolCompatibility_test :: Lens' GetDevicePoolCompatibility (Maybe ScheduleRunTest) Source #

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

getDevicePoolCompatibility_appArn :: Lens' GetDevicePoolCompatibility (Maybe Text) Source #

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

getDevicePoolCompatibility_configuration :: Lens' GetDevicePoolCompatibility (Maybe ScheduleRunConfiguration) Source #

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

getDevicePoolCompatibility_testType :: Lens' GetDevicePoolCompatibility (Maybe TestType) Source #

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.

InstallToRemoteAccessSession

installToRemoteAccessSession_remoteAccessSessionArn :: Lens' InstallToRemoteAccessSession Text Source #

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

installToRemoteAccessSession_appArn :: Lens' InstallToRemoteAccessSession Text Source #

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

ListTests

listTests_nextToken :: Lens' ListTests (Maybe Text) Source #

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.

listTests_arn :: Lens' ListTests Text Source #

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

listTestsResponse_tests :: Lens' ListTestsResponse (Maybe [Test]) Source #

Information about the tests.

listTestsResponse_nextToken :: Lens' ListTestsResponse (Maybe Text) Source #

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.

listTestsResponse_httpStatus :: Lens' ListTestsResponse Int Source #

The response's http status code.

ListArtifacts

listArtifacts_nextToken :: Lens' ListArtifacts (Maybe Text) Source #

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.

listArtifacts_arn :: Lens' ListArtifacts Text Source #

The run, job, suite, or test ARN.

listArtifacts_type :: Lens' ListArtifacts ArtifactCategory Source #

The artifacts' type.

Allowed values include:

  • FILE
  • LOG
  • SCREENSHOT

listArtifactsResponse_nextToken :: Lens' ListArtifactsResponse (Maybe Text) Source #

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.

ListTestGridSessionActions

listTestGridSessionActions_maxResult :: Lens' ListTestGridSessionActions (Maybe Natural) Source #

The maximum number of sessions to return per response.

CreateUpload

createUpload_contentType :: Lens' CreateUpload (Maybe Text) Source #

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

createUpload_projectArn :: Lens' CreateUpload Text Source #

The ARN of the project for the upload.

createUpload_name :: Lens' CreateUpload Text Source #

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.

createUpload_type :: Lens' CreateUpload UploadType Source #

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.

GetDeviceInstance

getDeviceInstance_arn :: Lens' GetDeviceInstance Text Source #

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

getDeviceInstanceResponse_deviceInstance :: Lens' GetDeviceInstanceResponse (Maybe DeviceInstance) Source #

An object that contains information about your device instance.

StopJob

stopJob_arn :: Lens' StopJob Text Source #

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

stopJobResponse_job :: Lens' StopJobResponse (Maybe Job) Source #

The job that was stopped.

stopJobResponse_httpStatus :: Lens' StopJobResponse Int Source #

The response's http status code.

DeleteRemoteAccessSession

deleteRemoteAccessSession_arn :: Lens' DeleteRemoteAccessSession Text Source #

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

ListTestGridSessionArtifacts

listTestGridSessionArtifacts_maxResult :: Lens' ListTestGridSessionArtifacts (Maybe Natural) Source #

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

ListTestGridProjects

listTestGridProjects_maxResult :: Lens' ListTestGridProjects (Maybe Natural) Source #

Return no more than this number of results.

listTestGridProjects_nextToken :: Lens' ListTestGridProjects (Maybe Text) Source #

From a response, used to continue a paginated listing.

listTestGridProjectsResponse_testGridProjects :: Lens' ListTestGridProjectsResponse (Maybe [TestGridProject]) Source #

The list of TestGridProjects, based on a ListTestGridProjectsRequest.

listTestGridProjectsResponse_nextToken :: Lens' ListTestGridProjectsResponse (Maybe Text) Source #

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

DeleteUpload

deleteUpload_arn :: Lens' DeleteUpload Text Source #

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

UpdateUpload

updateUpload_editContent :: Lens' UpdateUpload (Maybe Bool) Source #

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

updateUpload_name :: Lens' UpdateUpload (Maybe Text) Source #

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.

updateUpload_contentType :: Lens' UpdateUpload (Maybe Text) Source #

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

updateUpload_arn :: Lens' UpdateUpload Text Source #

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

updateUploadResponse_upload :: Lens' UpdateUploadResponse (Maybe Upload) Source #

A test spec uploaded to Device Farm.

DeleteTestGridProject

deleteTestGridProject_projectArn :: Lens' DeleteTestGridProject Text Source #

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

UpdateTestGridProject

updateTestGridProject_name :: Lens' UpdateTestGridProject (Maybe Text) Source #

Human-readable name for the project.

updateTestGridProject_vpcConfig :: Lens' UpdateTestGridProject (Maybe TestGridVpcConfig) Source #

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

updateTestGridProject_description :: Lens' UpdateTestGridProject (Maybe Text) Source #

Human-readable description for the project.

ListTagsForResource

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #

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.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

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.

GetDevicePool

getDevicePoolResponse_devicePool :: Lens' GetDevicePoolResponse (Maybe DevicePool) Source #

An object that contains information about the requested device pool.

ListDevicePools

listDevicePools_nextToken :: Lens' ListDevicePools (Maybe Text) Source #

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.

listDevicePools_type :: Lens' ListDevicePools (Maybe DevicePoolType) Source #

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.

listDevicePoolsResponse_nextToken :: Lens' ListDevicePoolsResponse (Maybe Text) Source #

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.

UpdateDevicePool

updateDevicePool_rules :: Lens' UpdateDevicePool (Maybe [Rule]) Source #

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.

updateDevicePool_clearMaxDevices :: Lens' UpdateDevicePool (Maybe Bool) Source #

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.

updateDevicePool_name :: Lens' UpdateDevicePool (Maybe Text) Source #

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

updateDevicePool_maxDevices :: Lens' UpdateDevicePool (Maybe Int) Source #

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.

updateDevicePool_description :: Lens' UpdateDevicePool (Maybe Text) Source #

A description of the device pool to update.

updateDevicePool_arn :: Lens' UpdateDevicePool Text Source #

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

DeleteDevicePool

deleteDevicePool_arn :: Lens' DeleteDevicePool Text Source #

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

GetUpload

getUploadResponse_upload :: Lens' GetUploadResponse (Maybe Upload) Source #

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

getUploadResponse_httpStatus :: Lens' GetUploadResponse Int Source #

The response's http status code.

ListOfferingTransactions

listOfferingTransactions_nextToken :: Lens' ListOfferingTransactions (Maybe Text) Source #

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.

listOfferingTransactionsResponse_offeringTransactions :: Lens' ListOfferingTransactionsResponse (Maybe [OfferingTransaction]) Source #

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

listOfferingTransactionsResponse_nextToken :: Lens' ListOfferingTransactionsResponse (Maybe Text) Source #

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.

CreateDevicePool

createDevicePool_maxDevices :: Lens' CreateDevicePool (Maybe Int) Source #

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.

createDevicePool_projectArn :: Lens' CreateDevicePool Text Source #

The ARN of the project for the device pool.

DeleteRun

deleteRun_arn :: Lens' DeleteRun Text Source #

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

deleteRunResponse_httpStatus :: Lens' DeleteRunResponse Int Source #

The response's http status code.

ListRuns

listRuns_nextToken :: Lens' ListRuns (Maybe Text) Source #

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.

listRuns_arn :: Lens' ListRuns Text Source #

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

listRunsResponse_runs :: Lens' ListRunsResponse (Maybe [Run]) Source #

Information about the runs.

listRunsResponse_nextToken :: Lens' ListRunsResponse (Maybe Text) Source #

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.

listRunsResponse_httpStatus :: Lens' ListRunsResponse Int Source #

The response's http status code.

GetTest

getTest_arn :: Lens' GetTest Text Source #

The test's ARN.

getTestResponse_test :: Lens' GetTestResponse (Maybe Test) Source #

A test condition that is evaluated.

getTestResponse_httpStatus :: Lens' GetTestResponse Int Source #

The response's http status code.

UpdateDeviceInstance

updateDeviceInstance_profileArn :: Lens' UpdateDeviceInstance (Maybe Text) Source #

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

updateDeviceInstance_labels :: Lens' UpdateDeviceInstance (Maybe [Text]) Source #

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

updateDeviceInstance_arn :: Lens' UpdateDeviceInstance Text Source #

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

updateDeviceInstanceResponse_deviceInstance :: Lens' UpdateDeviceInstanceResponse (Maybe DeviceInstance) Source #

An object that contains information about your device instance.

GetNetworkProfile

getNetworkProfile_arn :: Lens' GetNetworkProfile Text Source #

The ARN of the network profile to return information about.

RenewOffering

renewOffering_offeringId :: Lens' RenewOffering Text Source #

The ID of a request to renew an offering.

renewOffering_quantity :: Lens' RenewOffering Int Source #

The quantity requested in an offering renewal.

renewOfferingResponse_offeringTransaction :: Lens' RenewOfferingResponse (Maybe OfferingTransaction) Source #

Represents the status of the offering transaction for the renewal.

DeleteInstanceProfile

deleteInstanceProfile_arn :: Lens' DeleteInstanceProfile Text Source #

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

UpdateInstanceProfile

updateInstanceProfile_rebootAfterUse :: Lens' UpdateInstanceProfile (Maybe Bool) Source #

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

updateInstanceProfile_name :: Lens' UpdateInstanceProfile (Maybe Text) Source #

The updated name for your instance profile.

updateInstanceProfile_packageCleanup :: Lens' UpdateInstanceProfile (Maybe Bool) Source #

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

updateInstanceProfile_excludeAppPackagesFromCleanup :: Lens' UpdateInstanceProfile (Maybe [Text]) Source #

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.

updateInstanceProfile_description :: Lens' UpdateInstanceProfile (Maybe Text) Source #

The updated description for your instance profile.

updateInstanceProfile_arn :: Lens' UpdateInstanceProfile Text Source #

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

updateInstanceProfileResponse_instanceProfile :: Lens' UpdateInstanceProfileResponse (Maybe InstanceProfile) Source #

An object that contains information about your instance profile.

CreateInstanceProfile

createInstanceProfile_rebootAfterUse :: Lens' CreateInstanceProfile (Maybe Bool) Source #

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

createInstanceProfile_packageCleanup :: Lens' CreateInstanceProfile (Maybe Bool) Source #

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

createInstanceProfile_excludeAppPackagesFromCleanup :: Lens' CreateInstanceProfile (Maybe [Text]) Source #

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.

createInstanceProfile_description :: Lens' CreateInstanceProfile (Maybe Text) Source #

The description of your instance profile.

createInstanceProfile_name :: Lens' CreateInstanceProfile Text Source #

The name of your instance profile.

createInstanceProfileResponse_instanceProfile :: Lens' CreateInstanceProfileResponse (Maybe InstanceProfile) Source #

An object that contains information about your instance profile.

GetDevice

getDevice_arn :: Lens' GetDevice Text Source #

The device type's ARN.

getDeviceResponse_device :: Lens' GetDeviceResponse (Maybe Device) Source #

An object that contains information about the requested device.

getDeviceResponse_httpStatus :: Lens' GetDeviceResponse Int Source #

The response's http status code.

ListJobs

listJobs_nextToken :: Lens' ListJobs (Maybe Text) Source #

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.

listJobs_arn :: Lens' ListJobs Text Source #

The run's Amazon Resource Name (ARN).

listJobsResponse_jobs :: Lens' ListJobsResponse (Maybe [Job]) Source #

Information about the jobs.

listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text) Source #

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.

listJobsResponse_httpStatus :: Lens' ListJobsResponse Int Source #

The response's http status code.

GetTestGridSession

getTestGridSession_sessionArn :: Lens' GetTestGridSession (Maybe Text) Source #

An ARN that uniquely identifies a TestGridSession.

getTestGridSession_projectArn :: Lens' GetTestGridSession (Maybe Text) Source #

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

getTestGridSession_sessionId :: Lens' GetTestGridSession (Maybe Text) Source #

An ID associated with this session.

GetVPCEConfiguration

getVPCEConfiguration_arn :: Lens' GetVPCEConfiguration Text Source #

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

getVPCEConfigurationResponse_vpceConfiguration :: Lens' GetVPCEConfigurationResponse (Maybe VPCEConfiguration) Source #

An object that contains information about your VPC endpoint configuration.

StopRemoteAccessSession

stopRemoteAccessSession_arn :: Lens' StopRemoteAccessSession Text Source #

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

stopRemoteAccessSessionResponse_remoteAccessSession :: Lens' StopRemoteAccessSessionResponse (Maybe RemoteAccessSession) Source #

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

CreateNetworkProfile

createNetworkProfile_uplinkJitterMs :: Lens' CreateNetworkProfile (Maybe Integer) Source #

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

createNetworkProfile_uplinkLossPercent :: Lens' CreateNetworkProfile (Maybe Natural) Source #

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

createNetworkProfile_downlinkJitterMs :: Lens' CreateNetworkProfile (Maybe Integer) Source #

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

createNetworkProfile_downlinkLossPercent :: Lens' CreateNetworkProfile (Maybe Natural) Source #

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

createNetworkProfile_type :: Lens' CreateNetworkProfile (Maybe NetworkProfileType) Source #

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

createNetworkProfile_uplinkDelayMs :: Lens' CreateNetworkProfile (Maybe Integer) Source #

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

createNetworkProfile_uplinkBandwidthBits :: Lens' CreateNetworkProfile (Maybe Integer) Source #

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

createNetworkProfile_description :: Lens' CreateNetworkProfile (Maybe Text) Source #

The description of the network profile.

createNetworkProfile_downlinkDelayMs :: Lens' CreateNetworkProfile (Maybe Integer) Source #

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

createNetworkProfile_downlinkBandwidthBits :: Lens' CreateNetworkProfile (Maybe Integer) Source #

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

createNetworkProfile_projectArn :: Lens' CreateNetworkProfile Text Source #

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

createNetworkProfile_name :: Lens' CreateNetworkProfile Text Source #

The name for the new network profile.

createNetworkProfileResponse_networkProfile :: Lens' CreateNetworkProfileResponse (Maybe NetworkProfile) Source #

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

DeleteVPCEConfiguration

deleteVPCEConfiguration_arn :: Lens' DeleteVPCEConfiguration Text Source #

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

UpdateVPCEConfiguration

updateVPCEConfiguration_vpceServiceName :: Lens' UpdateVPCEConfiguration (Maybe Text) Source #

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

updateVPCEConfiguration_vpceConfigurationName :: Lens' UpdateVPCEConfiguration (Maybe Text) Source #

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

updateVPCEConfiguration_serviceDnsName :: Lens' UpdateVPCEConfiguration (Maybe Text) Source #

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.

updateVPCEConfiguration_vpceConfigurationDescription :: Lens' UpdateVPCEConfiguration (Maybe Text) Source #

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

updateVPCEConfiguration_arn :: Lens' UpdateVPCEConfiguration Text Source #

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

updateVPCEConfigurationResponse_vpceConfiguration :: Lens' UpdateVPCEConfigurationResponse (Maybe VPCEConfiguration) Source #

An object that contains information about your VPC endpoint configuration.

GetJob

getJob_arn :: Lens' GetJob Text Source #

The job's ARN.

getJobResponse_job :: Lens' GetJobResponse (Maybe Job) Source #

An object that contains information about the requested job.

getJobResponse_httpStatus :: Lens' GetJobResponse Int Source #

The response's http status code.

GetInstanceProfile

getInstanceProfile_arn :: Lens' GetInstanceProfile Text Source #

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

getInstanceProfileResponse_instanceProfile :: Lens' GetInstanceProfileResponse (Maybe InstanceProfile) Source #

An object that contains information about an instance profile.

ListNetworkProfiles

listNetworkProfiles_nextToken :: Lens' ListNetworkProfiles (Maybe Text) Source #

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.

listNetworkProfiles_type :: Lens' ListNetworkProfiles (Maybe NetworkProfileType) Source #

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

listNetworkProfiles_arn :: Lens' ListNetworkProfiles Text Source #

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

listNetworkProfilesResponse_nextToken :: Lens' ListNetworkProfilesResponse (Maybe Text) Source #

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.

CreateVPCEConfiguration

createVPCEConfiguration_vpceConfigurationDescription :: Lens' CreateVPCEConfiguration (Maybe Text) Source #

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

createVPCEConfiguration_vpceConfigurationName :: Lens' CreateVPCEConfiguration Text Source #

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

createVPCEConfiguration_vpceServiceName :: Lens' CreateVPCEConfiguration Text Source #

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

createVPCEConfiguration_serviceDnsName :: Lens' CreateVPCEConfiguration Text Source #

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

createVPCEConfigurationResponse_vpceConfiguration :: Lens' CreateVPCEConfigurationResponse (Maybe VPCEConfiguration) Source #

An object that contains information about your VPC endpoint configuration.

ScheduleRun

scheduleRun_executionConfiguration :: Lens' ScheduleRun (Maybe ExecutionConfiguration) Source #

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

scheduleRun_deviceSelectionConfiguration :: Lens' ScheduleRun (Maybe DeviceSelectionConfiguration) Source #

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.

scheduleRun_appArn :: Lens' ScheduleRun (Maybe Text) Source #

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

scheduleRun_name :: Lens' ScheduleRun (Maybe Text) Source #

The name for the run to be scheduled.

scheduleRun_configuration :: Lens' ScheduleRun (Maybe ScheduleRunConfiguration) Source #

Information about the settings for the run to be scheduled.

scheduleRun_devicePoolArn :: Lens' ScheduleRun (Maybe Text) Source #

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

scheduleRun_projectArn :: Lens' ScheduleRun Text Source #

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

scheduleRun_test :: Lens' ScheduleRun ScheduleRunTest Source #

Information about the test for the run to be scheduled.

scheduleRunResponse_run :: Lens' ScheduleRunResponse (Maybe Run) Source #

Information about the scheduled run.

CreateTestGridProject

createTestGridProject_vpcConfig :: Lens' CreateTestGridProject (Maybe TestGridVpcConfig) Source #

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

createTestGridProject_description :: Lens' CreateTestGridProject (Maybe Text) Source #

Human-readable description of the project.

createTestGridProject_name :: Lens' CreateTestGridProject Text Source #

Human-readable name of the Selenium testing project.

GetRun

getRun_arn :: Lens' GetRun Text Source #

The run's ARN.

getRunResponse_run :: Lens' GetRunResponse (Maybe Run) Source #

The run to get results from.

getRunResponse_httpStatus :: Lens' GetRunResponse Int Source #

The response's http status code.

ListSamples

listSamples_nextToken :: Lens' ListSamples (Maybe Text) Source #

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.

listSamples_arn :: Lens' ListSamples Text Source #

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

listSamplesResponse_nextToken :: Lens' ListSamplesResponse (Maybe Text) Source #

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.

ListSuites

listSuites_nextToken :: Lens' ListSuites (Maybe Text) Source #

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.

listSuites_arn :: Lens' ListSuites Text Source #

The job's Amazon Resource Name (ARN).

listSuitesResponse_nextToken :: Lens' ListSuitesResponse (Maybe Text) Source #

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.

ListRemoteAccessSessions

listRemoteAccessSessions_nextToken :: Lens' ListRemoteAccessSessions (Maybe Text) Source #

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.

listRemoteAccessSessions_arn :: Lens' ListRemoteAccessSessions Text Source #

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

listRemoteAccessSessionsResponse_nextToken :: Lens' ListRemoteAccessSessionsResponse (Maybe Text) Source #

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.

listRemoteAccessSessionsResponse_remoteAccessSessions :: Lens' ListRemoteAccessSessionsResponse (Maybe [RemoteAccessSession]) Source #

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

GetAccountSettings

CreateRemoteAccessSession

createRemoteAccessSession_clientId :: Lens' CreateRemoteAccessSession (Maybe Text) Source #

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.

createRemoteAccessSession_skipAppResign :: Lens' CreateRemoteAccessSession (Maybe Bool) Source #

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?

createRemoteAccessSession_instanceArn :: Lens' CreateRemoteAccessSession (Maybe Text) Source #

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

createRemoteAccessSession_remoteRecordEnabled :: Lens' CreateRemoteAccessSession (Maybe Bool) Source #

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

createRemoteAccessSession_remoteRecordAppArn :: Lens' CreateRemoteAccessSession (Maybe Text) Source #

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

createRemoteAccessSession_sshPublicKey :: Lens' CreateRemoteAccessSession (Maybe Text) Source #

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.

createRemoteAccessSession_name :: Lens' CreateRemoteAccessSession (Maybe Text) Source #

The name of the remote access session to create.

createRemoteAccessSession_remoteDebugEnabled :: Lens' CreateRemoteAccessSession (Maybe Bool) Source #

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

Remote debugging is no longer supported.

createRemoteAccessSession_interactionMode :: Lens' CreateRemoteAccessSession (Maybe InteractionMode) Source #

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.

createRemoteAccessSession_projectArn :: Lens' CreateRemoteAccessSession Text Source #

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

createRemoteAccessSession_deviceArn :: Lens' CreateRemoteAccessSession Text Source #

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

createRemoteAccessSessionResponse_remoteAccessSession :: Lens' CreateRemoteAccessSessionResponse (Maybe RemoteAccessSession) Source #

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

ListOfferingPromotions

listOfferingPromotions_nextToken :: Lens' ListOfferingPromotions (Maybe Text) Source #

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.

listOfferingPromotionsResponse_nextToken :: Lens' ListOfferingPromotionsResponse (Maybe Text) Source #

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

GetOfferingStatus

getOfferingStatus_nextToken :: Lens' GetOfferingStatus (Maybe Text) Source #

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.

getOfferingStatusResponse_nextPeriod :: Lens' GetOfferingStatusResponse (Maybe (HashMap Text OfferingStatus)) Source #

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

getOfferingStatusResponse_current :: Lens' GetOfferingStatusResponse (Maybe (HashMap Text OfferingStatus)) Source #

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

getOfferingStatusResponse_nextToken :: Lens' GetOfferingStatusResponse (Maybe Text) Source #

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.

ListUploads

listUploads_nextToken :: Lens' ListUploads (Maybe Text) Source #

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.

listUploads_type :: Lens' ListUploads (Maybe UploadType) Source #

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

listUploads_arn :: Lens' ListUploads Text Source #

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

listUploadsResponse_nextToken :: Lens' ListUploadsResponse (Maybe Text) Source #

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.

GetTestGridProject

getTestGridProject_projectArn :: Lens' GetTestGridProject Text Source #

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

GetSuite

getSuite_arn :: Lens' GetSuite Text Source #

The suite's ARN.

getSuiteResponse_suite :: Lens' GetSuiteResponse (Maybe Suite) Source #

A collection of one or more tests.

getSuiteResponse_httpStatus :: Lens' GetSuiteResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceARN :: Lens' TagResource Text Source #

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.

tagResource_tags :: Lens' TagResource [Tag] Source #

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.

GetRemoteAccessSession

getRemoteAccessSession_arn :: Lens' GetRemoteAccessSession Text Source #

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

getRemoteAccessSessionResponse_remoteAccessSession :: Lens' GetRemoteAccessSessionResponse (Maybe RemoteAccessSession) Source #

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

ListDeviceInstances

listDeviceInstances_nextToken :: Lens' ListDeviceInstances (Maybe Text) Source #

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.

listDeviceInstances_maxResults :: Lens' ListDeviceInstances (Maybe Int) Source #

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

listDeviceInstancesResponse_nextToken :: Lens' ListDeviceInstancesResponse (Maybe Text) Source #

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

listDeviceInstancesResponse_deviceInstances :: Lens' ListDeviceInstancesResponse (Maybe [DeviceInstance]) Source #

An object that contains information about your device instances.

PurchaseOffering

purchaseOffering_offeringPromotionId :: Lens' PurchaseOffering (Maybe Text) Source #

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

purchaseOffering_quantity :: Lens' PurchaseOffering Int Source #

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

purchaseOfferingResponse_offeringTransaction :: Lens' PurchaseOfferingResponse (Maybe OfferingTransaction) Source #

Represents the offering transaction for the purchase result.

ListInstanceProfiles

listInstanceProfiles_nextToken :: Lens' ListInstanceProfiles (Maybe Text) Source #

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.

listInstanceProfiles_maxResults :: Lens' ListInstanceProfiles (Maybe Int) Source #

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

listInstanceProfilesResponse_nextToken :: Lens' ListInstanceProfilesResponse (Maybe Text) Source #

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

listInstanceProfilesResponse_instanceProfiles :: Lens' ListInstanceProfilesResponse (Maybe [InstanceProfile]) Source #

An object that contains information about your instance profiles.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text Source #

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.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The keys of the tags to be removed.

GetProject

getProjectResponse_project :: Lens' GetProjectResponse (Maybe Project) Source #

The project to get information about.

ListUniqueProblems

listUniqueProblems_nextToken :: Lens' ListUniqueProblems (Maybe Text) Source #

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.

listUniqueProblemsResponse_nextToken :: Lens' ListUniqueProblemsResponse (Maybe Text) Source #

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.

listUniqueProblemsResponse_uniqueProblems :: Lens' ListUniqueProblemsResponse (Maybe (HashMap ExecutionResult [UniqueProblem])) Source #

Information about the unique problems.

Allowed values include:

  • PENDING
  • PASSED
  • WARNED
  • FAILED
  • SKIPPED
  • ERRORED
  • STOPPED

ListVPCEConfigurations

listVPCEConfigurations_nextToken :: Lens' ListVPCEConfigurations (Maybe Text) Source #

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.

listVPCEConfigurations_maxResults :: Lens' ListVPCEConfigurations (Maybe Int) Source #

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

listVPCEConfigurationsResponse_nextToken :: Lens' ListVPCEConfigurationsResponse (Maybe Text) Source #

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.

listVPCEConfigurationsResponse_vpceConfigurations :: Lens' ListVPCEConfigurationsResponse (Maybe [VPCEConfiguration]) Source #

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

StopRun

stopRun_arn :: Lens' StopRun Text Source #

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

stopRunResponse_run :: Lens' StopRunResponse (Maybe Run) Source #

The run that was stopped.

stopRunResponse_httpStatus :: Lens' StopRunResponse Int Source #

The response's http status code.

ListDevices

listDevices_arn :: Lens' ListDevices (Maybe Text) Source #

The Amazon Resource Name (ARN) of the project.

listDevices_filters :: Lens' ListDevices (Maybe [DeviceFilter]) Source #

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.

listDevices_nextToken :: Lens' ListDevices (Maybe Text) Source #

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.

listDevicesResponse_nextToken :: Lens' ListDevicesResponse (Maybe Text) Source #

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.

CreateProject

createProject_defaultJobTimeoutMinutes :: Lens' CreateProject (Maybe Int) Source #

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.

ListTestGridSessions

listTestGridSessions_maxResult :: Lens' ListTestGridSessions (Maybe Natural) Source #

Return only this many results at a time.

listTestGridSessions_creationTimeAfter :: Lens' ListTestGridSessions (Maybe UTCTime) Source #

Return only sessions created after this time.

listTestGridSessions_endTimeBefore :: Lens' ListTestGridSessions (Maybe UTCTime) Source #

Return only sessions that ended before this time.

listTestGridSessions_endTimeAfter :: Lens' ListTestGridSessions (Maybe UTCTime) Source #

Return only sessions that ended after this time.

listTestGridSessions_creationTimeBefore :: Lens' ListTestGridSessions (Maybe UTCTime) Source #

Return only sessions created before this time.

listTestGridSessionsResponse_testGridSessions :: Lens' ListTestGridSessionsResponse (Maybe [TestGridSession]) Source #

The sessions that match the criteria in a ListTestGridSessionsRequest.

CreateTestGridUrl

createTestGridUrl_projectArn :: Lens' CreateTestGridUrl Text Source #

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

createTestGridUrlResponse_expires :: Lens' CreateTestGridUrlResponse (Maybe UTCTime) Source #

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

createTestGridUrlResponse_url :: Lens' CreateTestGridUrlResponse (Maybe Text) Source #

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

ListOfferings

listOfferings_nextToken :: Lens' ListOfferings (Maybe Text) Source #

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.

listOfferingsResponse_nextToken :: Lens' ListOfferingsResponse (Maybe Text) Source #

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.

listOfferingsResponse_offerings :: Lens' ListOfferingsResponse (Maybe [Offering]) Source #

A value that represents the list offering results.

Types

AccountSettings

accountSettings_skipAppResign :: Lens' AccountSettings (Maybe Bool) Source #

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_awsAccountNumber :: Lens' AccountSettings (Maybe Text) Source #

The AWS account number specified in the AccountSettings container.

accountSettings_maxJobTimeoutMinutes :: Lens' AccountSettings (Maybe Int) Source #

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

accountSettings_maxSlots :: Lens' AccountSettings (Maybe (HashMap Text Int)) Source #

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.

accountSettings_trialMinutes :: Lens' AccountSettings (Maybe TrialMinutes) Source #

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

accountSettings_unmeteredDevices :: Lens' AccountSettings (Maybe (HashMap DevicePlatform Int)) Source #

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

accountSettings_unmeteredRemoteAccessDevices :: Lens' AccountSettings (Maybe (HashMap DevicePlatform Int)) Source #

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

accountSettings_defaultJobTimeoutMinutes :: Lens' AccountSettings (Maybe Int) Source #

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

Artifact

artifact_arn :: Lens' Artifact (Maybe Text) Source #

The artifact's ARN.

artifact_url :: Lens' Artifact (Maybe Text) Source #

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

artifact_extension :: Lens' Artifact (Maybe Text) Source #

The artifact's file extension.

artifact_name :: Lens' Artifact (Maybe Text) Source #

The artifact's name.

artifact_type :: Lens' Artifact (Maybe ArtifactType) Source #

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

CPU

cpu_frequency :: Lens' CPU (Maybe Text) Source #

The CPU's frequency.

cpu_clock :: Lens' CPU (Maybe Double) Source #

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

cpu_architecture :: Lens' CPU (Maybe Text) Source #

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

Counters

counters_passed :: Lens' Counters (Maybe Int) Source #

The number of passed entities.

counters_skipped :: Lens' Counters (Maybe Int) Source #

The number of skipped entities.

counters_warned :: Lens' Counters (Maybe Int) Source #

The number of warned entities.

counters_stopped :: Lens' Counters (Maybe Int) Source #

The number of stopped entities.

counters_total :: Lens' Counters (Maybe Int) Source #

The total number of entities.

counters_failed :: Lens' Counters (Maybe Int) Source #

The number of failed entities.

counters_errored :: Lens' Counters (Maybe Int) Source #

The number of errored entities.

CreateRemoteAccessSessionConfiguration

CustomerArtifactPaths

customerArtifactPaths_androidPaths :: Lens' CustomerArtifactPaths (Maybe [Text]) Source #

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

customerArtifactPaths_deviceHostPaths :: Lens' CustomerArtifactPaths (Maybe [Text]) Source #

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

customerArtifactPaths_iosPaths :: Lens' CustomerArtifactPaths (Maybe [Text]) Source #

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

Device

device_carrier :: Lens' Device (Maybe Text) Source #

The device's carrier.

device_image :: Lens' Device (Maybe Text) Source #

The device's image name.

device_manufacturer :: Lens' Device (Maybe Text) Source #

The device's manufacturer name.

device_platform :: Lens' Device (Maybe DevicePlatform) Source #

The device's platform.

Allowed values include:

  • ANDROID
  • IOS

device_modelId :: Lens' Device (Maybe Text) Source #

The device's model ID.

device_remoteAccessEnabled :: Lens' Device (Maybe Bool) Source #

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

device_arn :: Lens' Device (Maybe Text) Source #

The device's ARN.

device_formFactor :: Lens' Device (Maybe DeviceFormFactor) Source #

The device's form factor.

Allowed values include:

  • PHONE
  • TABLET

device_fleetType :: Lens' Device (Maybe Text) Source #

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

device_resolution :: Lens' Device (Maybe Resolution) Source #

The resolution of the device.

device_availability :: Lens' Device (Maybe DeviceAvailability) Source #

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

device_memory :: Lens' Device (Maybe Integer) Source #

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

device_radio :: Lens' Device (Maybe Text) Source #

The device's radio.

device_os :: Lens' Device (Maybe Text) Source #

The device's operating system type.

device_name :: Lens' Device (Maybe Text) Source #

The device's display name.

device_model :: Lens' Device (Maybe Text) Source #

The device's model name.

device_instances :: Lens' Device (Maybe [DeviceInstance]) Source #

The instances that belong to this device.

device_remoteDebugEnabled :: Lens' Device (Maybe Bool) Source #

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

Remote debugging is no longer supported.

device_cpu :: Lens' Device (Maybe CPU) Source #

Information about the device's CPU.

device_heapSize :: Lens' Device (Maybe Integer) Source #

The device's heap size, expressed in bytes.

device_fleetName :: Lens' Device (Maybe Text) Source #

The name of the fleet to which this device belongs.

DeviceFilter

deviceFilter_attribute :: Lens' DeviceFilter DeviceFilterAttribute Source #

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

deviceFilter_operator :: Lens' DeviceFilter RuleOperator Source #

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

deviceFilter_values :: Lens' DeviceFilter [Text] Source #

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

deviceInstance_status :: Lens' DeviceInstance (Maybe InstanceStatus) Source #

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

deviceInstance_udid :: Lens' DeviceInstance (Maybe Text) Source #

Unique device identifier for the device instance.

deviceInstance_instanceProfile :: Lens' DeviceInstance (Maybe InstanceProfile) Source #

A object that contains information about the instance profile.

deviceInstance_arn :: Lens' DeviceInstance (Maybe Text) Source #

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

deviceInstance_labels :: Lens' DeviceInstance (Maybe [Text]) Source #

An array of strings that describe the device instance.

DeviceMinutes

deviceMinutes_metered :: Lens' DeviceMinutes (Maybe Double) Source #

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

deviceMinutes_total :: Lens' DeviceMinutes (Maybe Double) Source #

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

deviceMinutes_unmetered :: Lens' DeviceMinutes (Maybe Double) Source #

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

DevicePool

devicePool_arn :: Lens' DevicePool (Maybe Text) Source #

The device pool's ARN.

devicePool_rules :: Lens' DevicePool (Maybe [Rule]) Source #

Information about the device pool's rules.

devicePool_name :: Lens' DevicePool (Maybe Text) Source #

The device pool's name.

devicePool_maxDevices :: Lens' DevicePool (Maybe Int) Source #

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_type :: Lens' DevicePool (Maybe DevicePoolType) Source #

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.

devicePool_description :: Lens' DevicePool (Maybe Text) Source #

The device pool's description.

DevicePoolCompatibilityResult

devicePoolCompatibilityResult_device :: Lens' DevicePoolCompatibilityResult (Maybe Device) Source #

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

devicePoolCompatibilityResult_compatible :: Lens' DevicePoolCompatibilityResult (Maybe Bool) Source #

Whether the result was compatible with the device pool.

DeviceSelectionConfiguration

deviceSelectionConfiguration_filters :: Lens' DeviceSelectionConfiguration [DeviceFilter] Source #

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.

deviceSelectionConfiguration_maxDevices :: Lens' DeviceSelectionConfiguration Int Source #

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

DeviceSelectionResult

deviceSelectionResult_matchedDevicesCount :: Lens' DeviceSelectionResult (Maybe Int) Source #

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

deviceSelectionResult_filters :: Lens' DeviceSelectionResult (Maybe [DeviceFilter]) Source #

The filters in a device selection result.

deviceSelectionResult_maxDevices :: Lens' DeviceSelectionResult (Maybe Int) Source #

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

ExecutionConfiguration

executionConfiguration_skipAppResign :: Lens' ExecutionConfiguration (Maybe Bool) Source #

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.

executionConfiguration_accountsCleanup :: Lens' ExecutionConfiguration (Maybe Bool) Source #

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

executionConfiguration_appPackagesCleanup :: Lens' ExecutionConfiguration (Maybe Bool) Source #

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

executionConfiguration_jobTimeoutMinutes :: Lens' ExecutionConfiguration (Maybe Int) Source #

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

executionConfiguration_videoCapture :: Lens' ExecutionConfiguration (Maybe Bool) Source #

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

IncompatibilityMessage

incompatibilityMessage_type :: Lens' IncompatibilityMessage (Maybe DeviceAttribute) Source #

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

instanceProfile_arn :: Lens' InstanceProfile (Maybe Text) Source #

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

instanceProfile_rebootAfterUse :: Lens' InstanceProfile (Maybe Bool) Source #

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

instanceProfile_name :: Lens' InstanceProfile (Maybe Text) Source #

The name of the instance profile.

instanceProfile_packageCleanup :: Lens' InstanceProfile (Maybe Bool) Source #

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

instanceProfile_excludeAppPackagesFromCleanup :: Lens' InstanceProfile (Maybe [Text]) Source #

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.

instanceProfile_description :: Lens' InstanceProfile (Maybe Text) Source #

The description of the instance profile.

Job

job_instanceArn :: Lens' Job (Maybe Text) Source #

The ARN of the instance.

job_status :: Lens' Job (Maybe ExecutionStatus) Source #

The job's status.

Allowed values include:

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

job_counters :: Lens' Job (Maybe Counters) Source #

The job's result counters.

job_arn :: Lens' Job (Maybe Text) Source #

The job's ARN.

job_created :: Lens' Job (Maybe UTCTime) Source #

When the job was created.

job_device :: Lens' Job (Maybe Device) Source #

The device (phone or tablet).

job_stopped :: Lens' Job (Maybe UTCTime) Source #

The job's stop time.

job_result :: Lens' Job (Maybe ExecutionResult) Source #

The job's result.

Allowed values include:

  • PENDING
  • PASSED
  • WARNED
  • FAILED
  • SKIPPED
  • ERRORED
  • STOPPED

job_name :: Lens' Job (Maybe Text) Source #

The job's name.

job_videoEndpoint :: Lens' Job (Maybe Text) Source #

The endpoint for streaming device video.

job_deviceMinutes :: Lens' Job (Maybe DeviceMinutes) Source #

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

job_videoCapture :: Lens' Job (Maybe Bool) Source #

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

job_type :: Lens' Job (Maybe TestType) Source #

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

job_message :: Lens' Job (Maybe Text) Source #

A message about the job's result.

job_started :: Lens' Job (Maybe UTCTime) Source #

The job's start time.

Location

MonetaryAmount

monetaryAmount_amount :: Lens' MonetaryAmount (Maybe Double) Source #

The numerical amount of an offering or transaction.

monetaryAmount_currencyCode :: Lens' MonetaryAmount (Maybe CurrencyCode) Source #

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

NetworkProfile

networkProfile_uplinkJitterMs :: Lens' NetworkProfile (Maybe Integer) Source #

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

networkProfile_arn :: Lens' NetworkProfile (Maybe Text) Source #

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

networkProfile_uplinkLossPercent :: Lens' NetworkProfile (Maybe Natural) Source #

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

networkProfile_downlinkJitterMs :: Lens' NetworkProfile (Maybe Integer) Source #

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

networkProfile_name :: Lens' NetworkProfile (Maybe Text) Source #

The name of the network profile.

networkProfile_downlinkLossPercent :: Lens' NetworkProfile (Maybe Natural) Source #

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

networkProfile_type :: Lens' NetworkProfile (Maybe NetworkProfileType) Source #

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

networkProfile_uplinkDelayMs :: Lens' NetworkProfile (Maybe Integer) Source #

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

networkProfile_uplinkBandwidthBits :: Lens' NetworkProfile (Maybe Integer) Source #

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

networkProfile_description :: Lens' NetworkProfile (Maybe Text) Source #

The description of the network profile.

networkProfile_downlinkDelayMs :: Lens' NetworkProfile (Maybe Integer) Source #

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

networkProfile_downlinkBandwidthBits :: Lens' NetworkProfile (Maybe Integer) Source #

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

Offering

offering_platform :: Lens' Offering (Maybe DevicePlatform) Source #

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

offering_id :: Lens' Offering (Maybe Text) Source #

The ID that corresponds to a device offering.

offering_recurringCharges :: Lens' Offering (Maybe [RecurringCharge]) Source #

Specifies whether there are recurring charges for the offering.

offering_type :: Lens' Offering (Maybe OfferingType) Source #

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

offering_description :: Lens' Offering (Maybe Text) Source #

A string that describes the offering.

OfferingPromotion

offeringPromotion_id :: Lens' OfferingPromotion (Maybe Text) Source #

The ID of the offering promotion.

offeringPromotion_description :: Lens' OfferingPromotion (Maybe Text) Source #

A string that describes the offering promotion.

OfferingStatus

offeringStatus_effectiveOn :: Lens' OfferingStatus (Maybe UTCTime) Source #

The date on which the offering is effective.

offeringStatus_offering :: Lens' OfferingStatus (Maybe Offering) Source #

Represents the metadata of an offering status.

offeringStatus_quantity :: Lens' OfferingStatus (Maybe Int) Source #

The number of available devices in the offering.

offeringStatus_type :: Lens' OfferingStatus (Maybe OfferingTransactionType) Source #

The type specified for the offering status.

OfferingTransaction

offeringTransaction_transactionId :: Lens' OfferingTransaction (Maybe Text) Source #

The transaction ID of the offering transaction.

offeringTransaction_offeringPromotionId :: Lens' OfferingTransaction (Maybe Text) Source #

The ID that corresponds to a device offering promotion.

offeringTransaction_createdOn :: Lens' OfferingTransaction (Maybe UTCTime) Source #

The date on which an offering transaction was created.

Problem

problem_device :: Lens' Problem (Maybe Device) Source #

Information about the associated device.

problem_test :: Lens' Problem (Maybe ProblemDetail) Source #

Information about the associated test.

problem_result :: Lens' Problem (Maybe ExecutionResult) Source #

The problem's result.

Allowed values include:

  • PENDING
  • PASSED
  • WARNED
  • FAILED
  • SKIPPED
  • ERRORED
  • STOPPED

problem_run :: Lens' Problem (Maybe ProblemDetail) Source #

Information about the associated run.

problem_job :: Lens' Problem (Maybe ProblemDetail) Source #

Information about the associated job.

problem_message :: Lens' Problem (Maybe Text) Source #

A message about the problem's result.

problem_suite :: Lens' Problem (Maybe ProblemDetail) Source #

Information about the associated suite.

ProblemDetail

problemDetail_arn :: Lens' ProblemDetail (Maybe Text) Source #

The problem detail's ARN.

problemDetail_name :: Lens' ProblemDetail (Maybe Text) Source #

The problem detail's name.

Project

project_arn :: Lens' Project (Maybe Text) Source #

The project's ARN.

project_created :: Lens' Project (Maybe UTCTime) Source #

When the project was created.

project_name :: Lens' Project (Maybe Text) Source #

The project's name.

project_defaultJobTimeoutMinutes :: Lens' Project (Maybe Int) Source #

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

Radios

radios_nfc :: Lens' Radios (Maybe Bool) Source #

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

radios_gps :: Lens' Radios (Maybe Bool) Source #

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

radios_bluetooth :: Lens' Radios (Maybe Bool) Source #

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

radios_wifi :: Lens' Radios (Maybe Bool) Source #

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

RecurringCharge

recurringCharge_cost :: Lens' RecurringCharge (Maybe MonetaryAmount) Source #

The cost of the recurring charge.

RemoteAccessSession

remoteAccessSession_billingMethod :: Lens' RemoteAccessSession (Maybe BillingMethod) Source #

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.

remoteAccessSession_clientId :: Lens' RemoteAccessSession (Maybe Text) Source #

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.

remoteAccessSession_deviceUdid :: Lens' RemoteAccessSession (Maybe Text) Source #

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.

remoteAccessSession_skipAppResign :: Lens' RemoteAccessSession (Maybe Bool) Source #

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.

remoteAccessSession_status :: Lens' RemoteAccessSession (Maybe ExecutionStatus) Source #

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

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

remoteAccessSession_remoteRecordEnabled :: Lens' RemoteAccessSession (Maybe Bool) Source #

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

remoteAccessSession_arn :: Lens' RemoteAccessSession (Maybe Text) Source #

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

remoteAccessSession_remoteRecordAppArn :: Lens' RemoteAccessSession (Maybe Text) Source #

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

remoteAccessSession_created :: Lens' RemoteAccessSession (Maybe UTCTime) Source #

The date and time the remote access session was created.

remoteAccessSession_device :: Lens' RemoteAccessSession (Maybe Device) Source #

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

remoteAccessSession_stopped :: Lens' RemoteAccessSession (Maybe UTCTime) Source #

The date and time the remote access session was stopped.

remoteAccessSession_result :: Lens' RemoteAccessSession (Maybe ExecutionResult) Source #

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

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

remoteAccessSession_name :: Lens' RemoteAccessSession (Maybe Text) Source #

The name of the remote access session.

remoteAccessSession_deviceMinutes :: Lens' RemoteAccessSession (Maybe DeviceMinutes) Source #

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

remoteAccessSession_remoteDebugEnabled :: Lens' RemoteAccessSession (Maybe Bool) Source #

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

Remote debugging is no longer supported.

remoteAccessSession_endpoint :: Lens' RemoteAccessSession (Maybe Text) Source #

The endpoint for the remote access sesssion.

remoteAccessSession_message :: Lens' RemoteAccessSession (Maybe Text) Source #

A message about the remote access session.

remoteAccessSession_hostAddress :: Lens' RemoteAccessSession (Maybe Text) Source #

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.

remoteAccessSession_interactionMode :: Lens' RemoteAccessSession (Maybe InteractionMode) Source #

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.

remoteAccessSession_started :: Lens' RemoteAccessSession (Maybe UTCTime) Source #

The date and time the remote access session was started.

Resolution

resolution_height :: Lens' Resolution (Maybe Int) Source #

The screen resolution's height, expressed in pixels.

resolution_width :: Lens' Resolution (Maybe Int) Source #

The screen resolution's width, expressed in pixels.

Rule

rule_attribute :: Lens' Rule (Maybe DeviceAttribute) Source #

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.

rule_operator :: Lens' Rule (Maybe RuleOperator) Source #

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.

rule_value :: Lens' Rule (Maybe Text) Source #

The rule's value.

Run

run_billingMethod :: Lens' Run (Maybe BillingMethod) Source #

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.

run_skipAppResign :: Lens' Run (Maybe Bool) Source #

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.

run_status :: Lens' Run (Maybe ExecutionStatus) Source #

The run's status.

Allowed values include:

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

run_customerArtifactPaths :: Lens' Run (Maybe CustomerArtifactPaths) Source #

Output CustomerArtifactPaths object for the test run.

run_eventCount :: Lens' Run (Maybe Int) Source #

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

run_counters :: Lens' Run (Maybe Counters) Source #

The run's result counters.

run_platform :: Lens' Run (Maybe DevicePlatform) Source #

The run's platform.

Allowed values include:

  • ANDROID
  • IOS

run_seed :: Lens' Run (Maybe Int) Source #

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.

run_radios :: Lens' Run (Maybe Radios) Source #

Information about the radio states for the run.

run_arn :: Lens' Run (Maybe Text) Source #

The run's ARN.

run_location :: Lens' Run (Maybe Location) Source #

Information about the location that is used for the run.

run_created :: Lens' Run (Maybe UTCTime) Source #

When the run was created.

run_locale :: Lens' Run (Maybe Text) Source #

Information about the locale that is used for the run.

run_testSpecArn :: Lens' Run (Maybe Text) Source #

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

run_stopped :: Lens' Run (Maybe UTCTime) Source #

The run's stop time.

run_result :: Lens' Run (Maybe ExecutionResult) Source #

The run's result.

Allowed values include:

  • PENDING
  • PASSED
  • WARNED
  • FAILED
  • SKIPPED
  • ERRORED
  • STOPPED

run_jobTimeoutMinutes :: Lens' Run (Maybe Int) Source #

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

run_completedJobs :: Lens' Run (Maybe Int) Source #

The total number of completed jobs.

run_resultCode :: Lens' Run (Maybe ExecutionResultCode) Source #

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.

run_name :: Lens' Run (Maybe Text) Source #

The run's name.

run_appUpload :: Lens' Run (Maybe Text) Source #

An app to upload or that has been uploaded.

run_parsingResultUrl :: Lens' Run (Maybe Text) Source #

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.

run_networkProfile :: Lens' Run (Maybe NetworkProfile) Source #

The network profile being used for a test run.

run_deviceMinutes :: Lens' Run (Maybe DeviceMinutes) Source #

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

run_type :: Lens' Run (Maybe TestType) Source #

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

run_message :: Lens' Run (Maybe Text) Source #

A message about the run's result.

run_webUrl :: Lens' Run (Maybe Text) Source #

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

run_totalJobs :: Lens' Run (Maybe Int) Source #

The total number of jobs for the run.

run_devicePoolArn :: Lens' Run (Maybe Text) Source #

The ARN of the device pool for the run.

run_started :: Lens' Run (Maybe UTCTime) Source #

The run's start time.

run_deviceSelectionResult :: Lens' Run (Maybe DeviceSelectionResult) Source #

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

Sample

sample_arn :: Lens' Sample (Maybe Text) Source #

The sample's ARN.

sample_url :: Lens' Sample (Maybe Text) Source #

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

sample_type :: Lens' Sample (Maybe SampleType) Source #

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.

ScheduleRunConfiguration

scheduleRunConfiguration_billingMethod :: Lens' ScheduleRunConfiguration (Maybe BillingMethod) Source #

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.

scheduleRunConfiguration_customerArtifactPaths :: Lens' ScheduleRunConfiguration (Maybe CustomerArtifactPaths) Source #

Input CustomerArtifactPaths object for the scheduled run configuration.

scheduleRunConfiguration_radios :: Lens' ScheduleRunConfiguration (Maybe Radios) Source #

Information about the radio states for the run.

scheduleRunConfiguration_location :: Lens' ScheduleRunConfiguration (Maybe Location) Source #

Information about the location that is used for the run.

scheduleRunConfiguration_locale :: Lens' ScheduleRunConfiguration (Maybe Text) Source #

Information about the locale that is used for the run.

scheduleRunConfiguration_extraDataPackageArn :: Lens' ScheduleRunConfiguration (Maybe Text) Source #

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.

scheduleRunConfiguration_auxiliaryApps :: Lens' ScheduleRunConfiguration (Maybe [Text]) Source #

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

scheduleRunConfiguration_vpceConfigurationArns :: Lens' ScheduleRunConfiguration (Maybe [Text]) Source #

An array of ARNs for your VPC endpoint configurations.

ScheduleRunTest

scheduleRunTest_testSpecArn :: Lens' ScheduleRunTest (Maybe Text) Source #

The ARN of the YAML-formatted test specification.

scheduleRunTest_testPackageArn :: Lens' ScheduleRunTest (Maybe Text) Source #

The ARN of the uploaded test to be run.

scheduleRunTest_parameters :: Lens' ScheduleRunTest (Maybe (HashMap Text Text)) Source #

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

scheduleRunTest_type :: Lens' ScheduleRunTest TestType Source #

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

Suite

suite_status :: Lens' Suite (Maybe ExecutionStatus) Source #

The suite's status.

Allowed values include:

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

suite_counters :: Lens' Suite (Maybe Counters) Source #

The suite's result counters.

suite_arn :: Lens' Suite (Maybe Text) Source #

The suite's ARN.

suite_created :: Lens' Suite (Maybe UTCTime) Source #

When the suite was created.

suite_stopped :: Lens' Suite (Maybe UTCTime) Source #

The suite's stop time.

suite_result :: Lens' Suite (Maybe ExecutionResult) Source #

The suite's result.

Allowed values include:

  • PENDING
  • PASSED
  • WARNED
  • FAILED
  • SKIPPED
  • ERRORED
  • STOPPED

suite_name :: Lens' Suite (Maybe Text) Source #

The suite's name.

suite_deviceMinutes :: Lens' Suite (Maybe DeviceMinutes) Source #

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

suite_type :: Lens' Suite (Maybe TestType) Source #

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

suite_message :: Lens' Suite (Maybe Text) Source #

A message about the suite's result.

suite_started :: Lens' Suite (Maybe UTCTime) Source #

The suite's start time.

Tag

tag_key :: Lens' Tag Text Source #

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.

tag_value :: Lens' Tag Text Source #

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

Test

test_status :: Lens' Test (Maybe ExecutionStatus) Source #

The test's status.

Allowed values include:

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

test_counters :: Lens' Test (Maybe Counters) Source #

The test's result counters.

test_arn :: Lens' Test (Maybe Text) Source #

The test's ARN.

test_created :: Lens' Test (Maybe UTCTime) Source #

When the test was created.

test_stopped :: Lens' Test (Maybe UTCTime) Source #

The test's stop time.

test_result :: Lens' Test (Maybe ExecutionResult) Source #

The test's result.

Allowed values include:

  • PENDING
  • PASSED
  • WARNED
  • FAILED
  • SKIPPED
  • ERRORED
  • STOPPED

test_name :: Lens' Test (Maybe Text) Source #

The test's name.

test_deviceMinutes :: Lens' Test (Maybe DeviceMinutes) Source #

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

test_type :: Lens' Test (Maybe TestType) Source #

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

test_message :: Lens' Test (Maybe Text) Source #

A message about the test's result.

test_started :: Lens' Test (Maybe UTCTime) Source #

The test's start time.

TestGridProject

testGridProject_name :: Lens' TestGridProject (Maybe Text) Source #

A human-readable name for the project.

testGridProject_vpcConfig :: Lens' TestGridProject (Maybe TestGridVpcConfig) Source #

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

testGridProject_description :: Lens' TestGridProject (Maybe Text) Source #

A human-readable description for the project.

TestGridSession

testGridSession_created :: Lens' TestGridSession (Maybe UTCTime) Source #

The time that the session was started.

testGridSession_billingMinutes :: Lens' TestGridSession (Maybe Double) Source #

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

testGridSession_seleniumProperties :: Lens' TestGridSession (Maybe Text) Source #

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

TestGridSessionAction

testGridSessionAction_duration :: Lens' TestGridSessionAction (Maybe Integer) Source #

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

testGridSessionAction_requestMethod :: Lens' TestGridSessionAction (Maybe Text) Source #

HTTP method that the browser used to make the request.

testGridSessionAction_started :: Lens' TestGridSessionAction (Maybe UTCTime) Source #

The time that the session invoked the action.

testGridSessionAction_statusCode :: Lens' TestGridSessionAction (Maybe Text) Source #

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

TestGridSessionArtifact

testGridSessionArtifact_url :: Lens' TestGridSessionArtifact (Maybe Text) Source #

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

TestGridVpcConfig

testGridVpcConfig_securityGroupIds :: Lens' TestGridVpcConfig (NonEmpty Text) Source #

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

testGridVpcConfig_subnetIds :: Lens' TestGridVpcConfig (NonEmpty Text) Source #

A list of VPC subnet IDs in your Amazon VPC.

TrialMinutes

trialMinutes_remaining :: Lens' TrialMinutes (Maybe Double) Source #

The number of free trial minutes remaining in the account.

trialMinutes_total :: Lens' TrialMinutes (Maybe Double) Source #

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

UniqueProblem

uniqueProblem_problems :: Lens' UniqueProblem (Maybe [Problem]) Source #

Information about the problems.

uniqueProblem_message :: Lens' UniqueProblem (Maybe Text) Source #

A message about the unique problems' result.

Upload

upload_status :: Lens' Upload (Maybe UploadStatus) Source #

The upload's status.

Must be one of the following values:

  • FAILED
  • INITIALIZED
  • PROCESSING
  • SUCCEEDED

upload_arn :: Lens' Upload (Maybe Text) Source #

The upload's ARN.

upload_created :: Lens' Upload (Maybe UTCTime) Source #

When the upload was created.

upload_category :: Lens' Upload (Maybe UploadCategory) Source #

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.

upload_url :: Lens' Upload (Maybe Text) Source #

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

upload_name :: Lens' Upload (Maybe Text) Source #

The upload's file name.

upload_metadata :: Lens' Upload (Maybe Text) Source #

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.

upload_type :: Lens' Upload (Maybe UploadType) Source #

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

upload_message :: Lens' Upload (Maybe Text) Source #

A message about the upload's result.

upload_contentType :: Lens' Upload (Maybe Text) Source #

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

VPCEConfiguration

vPCEConfiguration_vpceServiceName :: Lens' VPCEConfiguration (Maybe Text) Source #

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

vPCEConfiguration_arn :: Lens' VPCEConfiguration (Maybe Text) Source #

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

vPCEConfiguration_vpceConfigurationName :: Lens' VPCEConfiguration (Maybe Text) Source #

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

vPCEConfiguration_serviceDnsName :: Lens' VPCEConfiguration (Maybe Text) Source #

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

vPCEConfiguration_vpceConfigurationDescription :: Lens' VPCEConfiguration (Maybe Text) Source #

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