Amazonka.DeviceFarm.Lens

Operations

CreateDevicePool

createDevicePool_description :: Lens' CreateDevicePool (Maybe Text)

The device pool's description.

createDevicePool_maxDevices :: Lens' CreateDevicePool (Maybe Int)

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

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

createDevicePool_projectArn :: Lens' CreateDevicePool Text

The ARN of the project for the device pool.

createDevicePool_name :: Lens' CreateDevicePool Text

The device pool's name.

createDevicePool_rules :: Lens' CreateDevicePool [Rule]

The device pool's rules.

createDevicePoolResponse_devicePool :: Lens' CreateDevicePoolResponse (Maybe DevicePool)

The newly created device pool.

createDevicePoolResponse_httpStatus :: Lens' CreateDevicePoolResponse Int

The response's http status code.

CreateInstanceProfile

createInstanceProfile_description :: Lens' CreateInstanceProfile (Maybe Text)

The description of your instance profile.

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

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_packageCleanup :: Lens' CreateInstanceProfile (Maybe Bool)

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

createInstanceProfile_rebootAfterUse :: Lens' CreateInstanceProfile (Maybe Bool)

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

createInstanceProfile_name :: Lens' CreateInstanceProfile Text

The name of your instance profile.

createInstanceProfileResponse_instanceProfile :: Lens' CreateInstanceProfileResponse (Maybe InstanceProfile)

An object that contains information about your instance profile.

createInstanceProfileResponse_httpStatus :: Lens' CreateInstanceProfileResponse Int

The response's http status code.

CreateNetworkProfile

createNetworkProfile_description :: Lens' CreateNetworkProfile (Maybe Text)

The description of the network profile.

createNetworkProfile_downlinkBandwidthBits :: Lens' CreateNetworkProfile (Maybe Integer)

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

createNetworkProfile_downlinkDelayMs :: Lens' CreateNetworkProfile (Maybe Integer)

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

createNetworkProfile_downlinkJitterMs :: Lens' CreateNetworkProfile (Maybe Integer)

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

createNetworkProfile_downlinkLossPercent :: Lens' CreateNetworkProfile (Maybe Natural)

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

createNetworkProfile_type :: Lens' CreateNetworkProfile (Maybe NetworkProfileType)

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

createNetworkProfile_uplinkBandwidthBits :: Lens' CreateNetworkProfile (Maybe Integer)

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

createNetworkProfile_uplinkDelayMs :: Lens' CreateNetworkProfile (Maybe Integer)

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

createNetworkProfile_uplinkJitterMs :: Lens' CreateNetworkProfile (Maybe Integer)

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

createNetworkProfile_uplinkLossPercent :: Lens' CreateNetworkProfile (Maybe Natural)

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

createNetworkProfile_projectArn :: Lens' CreateNetworkProfile Text

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

createNetworkProfile_name :: Lens' CreateNetworkProfile Text

The name for the new network profile.

createNetworkProfileResponse_networkProfile :: Lens' CreateNetworkProfileResponse (Maybe NetworkProfile)

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

createNetworkProfileResponse_httpStatus :: Lens' CreateNetworkProfileResponse Int

The response's http status code.

CreateProject

createProject_defaultJobTimeoutMinutes :: Lens' CreateProject (Maybe Int)

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

createProject_vpcConfig :: Lens' CreateProject (Maybe VpcConfig)

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

createProject_name :: Lens' CreateProject Text

The project's name.

createProjectResponse_project :: Lens' CreateProjectResponse (Maybe Project)

The newly created project.

createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int

The response's http status code.

CreateRemoteAccessSession

createRemoteAccessSession_clientId :: Lens' CreateRemoteAccessSession (Maybe Text)

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_configuration :: Lens' CreateRemoteAccessSession (Maybe CreateRemoteAccessSessionConfiguration)

The configuration information for the remote access session request.

createRemoteAccessSession_instanceArn :: Lens' CreateRemoteAccessSession (Maybe Text)

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

createRemoteAccessSession_interactionMode :: Lens' CreateRemoteAccessSession (Maybe InteractionMode)

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

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

createRemoteAccessSession_name :: Lens' CreateRemoteAccessSession (Maybe Text)

The name of the remote access session to create.

createRemoteAccessSession_remoteDebugEnabled :: Lens' CreateRemoteAccessSession (Maybe Bool)

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

Remote debugging is no longer supported.

createRemoteAccessSession_remoteRecordAppArn :: Lens' CreateRemoteAccessSession (Maybe Text)

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

createRemoteAccessSession_remoteRecordEnabled :: Lens' CreateRemoteAccessSession (Maybe Bool)

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

createRemoteAccessSession_skipAppResign :: Lens' CreateRemoteAccessSession (Maybe Bool)

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_sshPublicKey :: Lens' CreateRemoteAccessSession (Maybe Text)

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_projectArn :: Lens' CreateRemoteAccessSession Text

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

createRemoteAccessSession_deviceArn :: Lens' CreateRemoteAccessSession Text

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

createRemoteAccessSessionResponse_remoteAccessSession :: Lens' CreateRemoteAccessSessionResponse (Maybe RemoteAccessSession)

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

createRemoteAccessSessionResponse_httpStatus :: Lens' CreateRemoteAccessSessionResponse Int

The response's http status code.

CreateTestGridProject

createTestGridProject_description :: Lens' CreateTestGridProject (Maybe Text)

Human-readable description of the project.

createTestGridProject_vpcConfig :: Lens' CreateTestGridProject (Maybe TestGridVpcConfig)

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

createTestGridProject_name :: Lens' CreateTestGridProject Text

Human-readable name of the Selenium testing project.

createTestGridProjectResponse_testGridProject :: Lens' CreateTestGridProjectResponse (Maybe TestGridProject)

ARN of the Selenium testing project that was created.

createTestGridProjectResponse_httpStatus :: Lens' CreateTestGridProjectResponse Int

The response's http status code.

CreateTestGridUrl

createTestGridUrl_projectArn :: Lens' CreateTestGridUrl Text

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

createTestGridUrl_expiresInSeconds :: Lens' CreateTestGridUrl Natural

Lifetime, in seconds, of the URL.

createTestGridUrlResponse_expires :: Lens' CreateTestGridUrlResponse (Maybe UTCTime)

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

createTestGridUrlResponse_url :: Lens' CreateTestGridUrlResponse (Maybe Text)

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

createTestGridUrlResponse_httpStatus :: Lens' CreateTestGridUrlResponse Int

The response's http status code.

CreateUpload

createUpload_contentType :: Lens' CreateUpload (Maybe Text)

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

createUpload_projectArn :: Lens' CreateUpload Text

The ARN of the project for the upload.

createUpload_name :: Lens' CreateUpload Text

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

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.

createUploadResponse_upload :: Lens' CreateUploadResponse (Maybe Upload)

The newly created upload.

createUploadResponse_httpStatus :: Lens' CreateUploadResponse Int

The response's http status code.

CreateVPCEConfiguration

createVPCEConfiguration_vpceConfigurationDescription :: Lens' CreateVPCEConfiguration (Maybe Text)

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

createVPCEConfiguration_vpceConfigurationName :: Lens' CreateVPCEConfiguration Text

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

createVPCEConfiguration_vpceServiceName :: Lens' CreateVPCEConfiguration Text

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

createVPCEConfiguration_serviceDnsName :: Lens' CreateVPCEConfiguration Text

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

createVPCEConfigurationResponse_vpceConfiguration :: Lens' CreateVPCEConfigurationResponse (Maybe VPCEConfiguration)

An object that contains information about your VPC endpoint configuration.

createVPCEConfigurationResponse_httpStatus :: Lens' CreateVPCEConfigurationResponse Int

The response's http status code.

DeleteDevicePool

deleteDevicePool_arn :: Lens' DeleteDevicePool Text

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

deleteDevicePoolResponse_httpStatus :: Lens' DeleteDevicePoolResponse Int

The response's http status code.

DeleteInstanceProfile

deleteInstanceProfile_arn :: Lens' DeleteInstanceProfile Text

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

deleteInstanceProfileResponse_httpStatus :: Lens' DeleteInstanceProfileResponse Int

The response's http status code.

DeleteNetworkProfile

deleteNetworkProfile_arn :: Lens' DeleteNetworkProfile Text

The ARN of the network profile to delete.

deleteNetworkProfileResponse_httpStatus :: Lens' DeleteNetworkProfileResponse Int

The response's http status code.

DeleteProject

deleteProject_arn :: Lens' DeleteProject Text

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

deleteProjectResponse_httpStatus :: Lens' DeleteProjectResponse Int

The response's http status code.

DeleteRemoteAccessSession

deleteRemoteAccessSession_arn :: Lens' DeleteRemoteAccessSession Text

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

deleteRemoteAccessSessionResponse_httpStatus :: Lens' DeleteRemoteAccessSessionResponse Int

The response's http status code.

DeleteRun

deleteRun_arn :: Lens' DeleteRun Text

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

deleteRunResponse_httpStatus :: Lens' DeleteRunResponse Int

The response's http status code.

DeleteTestGridProject

deleteTestGridProject_projectArn :: Lens' DeleteTestGridProject Text

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

deleteTestGridProjectResponse_httpStatus :: Lens' DeleteTestGridProjectResponse Int

The response's http status code.

DeleteUpload

deleteUpload_arn :: Lens' DeleteUpload Text

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

deleteUploadResponse_httpStatus :: Lens' DeleteUploadResponse Int

The response's http status code.

DeleteVPCEConfiguration

deleteVPCEConfiguration_arn :: Lens' DeleteVPCEConfiguration Text

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

deleteVPCEConfigurationResponse_httpStatus :: Lens' DeleteVPCEConfigurationResponse Int

The response's http status code.

GetAccountSettings

getAccountSettingsResponse_accountSettings :: Lens' GetAccountSettingsResponse (Maybe AccountSettings)

The account settings.

getAccountSettingsResponse_httpStatus :: Lens' GetAccountSettingsResponse Int

The response's http status code.

GetDevice

getDevice_arn :: Lens' GetDevice Text

The device type's ARN.

getDeviceResponse_device :: Lens' GetDeviceResponse (Maybe Device)

An object that contains information about the requested device.

getDeviceResponse_httpStatus :: Lens' GetDeviceResponse Int

The response's http status code.

GetDeviceInstance

getDeviceInstance_arn :: Lens' GetDeviceInstance Text

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

getDeviceInstanceResponse_deviceInstance :: Lens' GetDeviceInstanceResponse (Maybe DeviceInstance)

An object that contains information about your device instance.

getDeviceInstanceResponse_httpStatus :: Lens' GetDeviceInstanceResponse Int

The response's http status code.

GetDevicePool

getDevicePool_arn :: Lens' GetDevicePool Text

The device pool's ARN.

getDevicePoolResponse_devicePool :: Lens' GetDevicePoolResponse (Maybe DevicePool)

An object that contains information about the requested device pool.

getDevicePoolResponse_httpStatus :: Lens' GetDevicePoolResponse Int

The response's http status code.

GetDevicePoolCompatibility

getDevicePoolCompatibility_appArn :: Lens' GetDevicePoolCompatibility (Maybe Text)

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

getDevicePoolCompatibility_configuration :: Lens' GetDevicePoolCompatibility (Maybe ScheduleRunConfiguration)

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

getDevicePoolCompatibility_test :: Lens' GetDevicePoolCompatibility (Maybe ScheduleRunTest)

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

getDevicePoolCompatibility_testType :: Lens' GetDevicePoolCompatibility (Maybe TestType)

The test type for the specified device pool.

Allowed values include the following:

• BUILTIN_FUZZ.
• BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
• APPIUM_JAVA_JUNIT.
• APPIUM_JAVA_TESTNG.
• APPIUM_PYTHON.
• APPIUM_NODE.
• APPIUM_RUBY.
• APPIUM_WEB_JAVA_JUNIT.
• APPIUM_WEB_JAVA_TESTNG.
• APPIUM_WEB_PYTHON.
• APPIUM_WEB_NODE.
• APPIUM_WEB_RUBY.
• CALABASH.
• INSTRUMENTATION.
• UIAUTOMATION.
• UIAUTOMATOR.
• XCTEST.
• XCTEST_UI.

getDevicePoolCompatibility_devicePoolArn :: Lens' GetDevicePoolCompatibility Text

The device pool's ARN.

getDevicePoolCompatibilityResponse_compatibleDevices :: Lens' GetDevicePoolCompatibilityResponse (Maybe [DevicePoolCompatibilityResult])

Information about compatible devices.

getDevicePoolCompatibilityResponse_incompatibleDevices :: Lens' GetDevicePoolCompatibilityResponse (Maybe [DevicePoolCompatibilityResult])

Information about incompatible devices.

getDevicePoolCompatibilityResponse_httpStatus :: Lens' GetDevicePoolCompatibilityResponse Int

The response's http status code.

GetInstanceProfile

getInstanceProfile_arn :: Lens' GetInstanceProfile Text

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

getInstanceProfileResponse_instanceProfile :: Lens' GetInstanceProfileResponse (Maybe InstanceProfile)

An object that contains information about an instance profile.

getInstanceProfileResponse_httpStatus :: Lens' GetInstanceProfileResponse Int

The response's http status code.

GetJob

getJob_arn :: Lens' GetJob Text

The job's ARN.

getJobResponse_job :: Lens' GetJobResponse (Maybe Job)

An object that contains information about the requested job.

getJobResponse_httpStatus :: Lens' GetJobResponse Int

The response's http status code.

GetNetworkProfile

getNetworkProfile_arn :: Lens' GetNetworkProfile Text

The ARN of the network profile to return information about.

getNetworkProfileResponse_networkProfile :: Lens' GetNetworkProfileResponse (Maybe NetworkProfile)

The network profile.

getNetworkProfileResponse_httpStatus :: Lens' GetNetworkProfileResponse Int

The response's http status code.

GetOfferingStatus

getOfferingStatus_nextToken :: Lens' GetOfferingStatus (Maybe Text)

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_current :: Lens' GetOfferingStatusResponse (Maybe (HashMap Text OfferingStatus))

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

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

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

getOfferingStatusResponse_nextToken :: Lens' GetOfferingStatusResponse (Maybe Text)

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_httpStatus :: Lens' GetOfferingStatusResponse Int

The response's http status code.

GetProject

getProject_arn :: Lens' GetProject Text

The project's ARN.

getProjectResponse_project :: Lens' GetProjectResponse (Maybe Project)

The project to get information about.

getProjectResponse_httpStatus :: Lens' GetProjectResponse Int

The response's http status code.

GetRemoteAccessSession

getRemoteAccessSession_arn :: Lens' GetRemoteAccessSession Text

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

getRemoteAccessSessionResponse_remoteAccessSession :: Lens' GetRemoteAccessSessionResponse (Maybe RemoteAccessSession)

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

getRemoteAccessSessionResponse_httpStatus :: Lens' GetRemoteAccessSessionResponse Int

The response's http status code.

GetRun

getRun_arn :: Lens' GetRun Text

The run's ARN.

getRunResponse_run :: Lens' GetRunResponse (Maybe Run)

The run to get results from.

getRunResponse_httpStatus :: Lens' GetRunResponse Int

The response's http status code.

GetSuite

getSuite_arn :: Lens' GetSuite Text

The suite's ARN.

getSuiteResponse_suite :: Lens' GetSuiteResponse (Maybe Suite)

A collection of one or more tests.

getSuiteResponse_httpStatus :: Lens' GetSuiteResponse Int

The response's http status code.

GetTest

getTest_arn :: Lens' GetTest Text

The test's ARN.

getTestResponse_test :: Lens' GetTestResponse (Maybe Test)

A test condition that is evaluated.

getTestResponse_httpStatus :: Lens' GetTestResponse Int

The response's http status code.

GetTestGridProject

getTestGridProject_projectArn :: Lens' GetTestGridProject Text

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

getTestGridProjectResponse_testGridProject :: Lens' GetTestGridProjectResponse (Maybe TestGridProject)

A TestGridProject.

getTestGridProjectResponse_httpStatus :: Lens' GetTestGridProjectResponse Int

The response's http status code.

GetTestGridSession

getTestGridSession_projectArn :: Lens' GetTestGridSession (Maybe Text)

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

getTestGridSession_sessionArn :: Lens' GetTestGridSession (Maybe Text)

An ARN that uniquely identifies a TestGridSession.

getTestGridSession_sessionId :: Lens' GetTestGridSession (Maybe Text)

An ID associated with this session.

getTestGridSessionResponse_testGridSession :: Lens' GetTestGridSessionResponse (Maybe TestGridSession)

The TestGridSession that was requested.

getTestGridSessionResponse_httpStatus :: Lens' GetTestGridSessionResponse Int

The response's http status code.

GetUpload

getUpload_arn :: Lens' GetUpload Text

The upload's ARN.

getUploadResponse_upload :: Lens' GetUploadResponse (Maybe Upload)

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

getUploadResponse_httpStatus :: Lens' GetUploadResponse Int

The response's http status code.

GetVPCEConfiguration

getVPCEConfiguration_arn :: Lens' GetVPCEConfiguration Text

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

getVPCEConfigurationResponse_vpceConfiguration :: Lens' GetVPCEConfigurationResponse (Maybe VPCEConfiguration)

An object that contains information about your VPC endpoint configuration.

getVPCEConfigurationResponse_httpStatus :: Lens' GetVPCEConfigurationResponse Int

The response's http status code.

InstallToRemoteAccessSession

installToRemoteAccessSession_remoteAccessSessionArn :: Lens' InstallToRemoteAccessSession Text

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

installToRemoteAccessSession_appArn :: Lens' InstallToRemoteAccessSession Text

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

installToRemoteAccessSessionResponse_appUpload :: Lens' InstallToRemoteAccessSessionResponse (Maybe Upload)

An app to upload or that has been uploaded.

installToRemoteAccessSessionResponse_httpStatus :: Lens' InstallToRemoteAccessSessionResponse Int

The response's http status code.

ListArtifacts

listArtifacts_nextToken :: Lens' ListArtifacts (Maybe Text)

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

The run, job, suite, or test ARN.

listArtifacts_type :: Lens' ListArtifacts ArtifactCategory

The artifacts' type.

Allowed values include:

• FILE
• LOG
• SCREENSHOT

listArtifactsResponse_artifacts :: Lens' ListArtifactsResponse (Maybe [Artifact])

Information about the artifacts.

listArtifactsResponse_nextToken :: Lens' ListArtifactsResponse (Maybe Text)

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.

listArtifactsResponse_httpStatus :: Lens' ListArtifactsResponse Int

The response's http status code.

ListDeviceInstances

listDeviceInstances_maxResults :: Lens' ListDeviceInstances (Maybe Int)

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

listDeviceInstances_nextToken :: Lens' ListDeviceInstances (Maybe Text)

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.

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

An object that contains information about your device instances.

listDeviceInstancesResponse_nextToken :: Lens' ListDeviceInstancesResponse (Maybe Text)

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

listDeviceInstancesResponse_httpStatus :: Lens' ListDeviceInstancesResponse Int

The response's http status code.

ListDevicePools

listDevicePools_nextToken :: Lens' ListDevicePools (Maybe Text)

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)

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.

listDevicePools_arn :: Lens' ListDevicePools Text

The project ARN.

listDevicePoolsResponse_devicePools :: Lens' ListDevicePoolsResponse (Maybe [DevicePool])

Information about the device pools.

listDevicePoolsResponse_nextToken :: Lens' ListDevicePoolsResponse (Maybe Text)

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.

listDevicePoolsResponse_httpStatus :: Lens' ListDevicePoolsResponse Int

The response's http status code.

ListDevices

listDevices_arn :: Lens' ListDevices (Maybe Text)

The Amazon Resource Name (ARN) of the project.

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

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)

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_devices :: Lens' ListDevicesResponse (Maybe [Device])

Information about the devices.

listDevicesResponse_nextToken :: Lens' ListDevicesResponse (Maybe Text)

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.

listDevicesResponse_httpStatus :: Lens' ListDevicesResponse Int

The response's http status code.

ListInstanceProfiles

listInstanceProfiles_maxResults :: Lens' ListInstanceProfiles (Maybe Int)

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

listInstanceProfiles_nextToken :: Lens' ListInstanceProfiles (Maybe Text)

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.

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

An object that contains information about your instance profiles.

listInstanceProfilesResponse_nextToken :: Lens' ListInstanceProfilesResponse (Maybe Text)

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

listInstanceProfilesResponse_httpStatus :: Lens' ListInstanceProfilesResponse Int

The response's http status code.

ListJobs

listJobs_nextToken :: Lens' ListJobs (Maybe Text)

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

The run's Amazon Resource Name (ARN).

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

Information about the jobs.

listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text)

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

The response's http status code.

ListNetworkProfiles

listNetworkProfiles_nextToken :: Lens' ListNetworkProfiles (Maybe Text)

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)

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

listNetworkProfiles_arn :: Lens' ListNetworkProfiles Text

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

listNetworkProfilesResponse_networkProfiles :: Lens' ListNetworkProfilesResponse (Maybe [NetworkProfile])

A list of the available network profiles.

listNetworkProfilesResponse_nextToken :: Lens' ListNetworkProfilesResponse (Maybe Text)

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.

listNetworkProfilesResponse_httpStatus :: Lens' ListNetworkProfilesResponse Int

The response's http status code.

ListOfferingPromotions

listOfferingPromotions_nextToken :: Lens' ListOfferingPromotions (Maybe Text)

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)

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

listOfferingPromotionsResponse_offeringPromotions :: Lens' ListOfferingPromotionsResponse (Maybe [OfferingPromotion])

Information about the offering promotions.

listOfferingPromotionsResponse_httpStatus :: Lens' ListOfferingPromotionsResponse Int

The response's http status code.

ListOfferingTransactions

listOfferingTransactions_nextToken :: Lens' ListOfferingTransactions (Maybe Text)

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_nextToken :: Lens' ListOfferingTransactionsResponse (Maybe Text)

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])

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

listOfferingTransactionsResponse_httpStatus :: Lens' ListOfferingTransactionsResponse Int

The response's http status code.

ListOfferings

listOfferings_nextToken :: Lens' ListOfferings (Maybe Text)

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)

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])

A value that represents the list offering results.

listOfferingsResponse_httpStatus :: Lens' ListOfferingsResponse Int

The response's http status code.

ListProjects

listProjects_arn :: Lens' ListProjects (Maybe Text)

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)

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)

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.

listProjectsResponse_projects :: Lens' ListProjectsResponse (Maybe [Project])

Information about the projects.

listProjectsResponse_httpStatus :: Lens' ListProjectsResponse Int

The response's http status code.

ListRemoteAccessSessions

listRemoteAccessSessions_nextToken :: Lens' ListRemoteAccessSessions (Maybe Text)

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

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

listRemoteAccessSessionsResponse_nextToken :: Lens' ListRemoteAccessSessionsResponse (Maybe Text)

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])

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

listRemoteAccessSessionsResponse_httpStatus :: Lens' ListRemoteAccessSessionsResponse Int

The response's http status code.

ListRuns

listRuns_nextToken :: Lens' ListRuns (Maybe Text)

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

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

listRunsResponse_nextToken :: Lens' ListRunsResponse (Maybe Text)

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_runs :: Lens' ListRunsResponse (Maybe [Run])

Information about the runs.

listRunsResponse_httpStatus :: Lens' ListRunsResponse Int

The response's http status code.

ListSamples

listSamples_nextToken :: Lens' ListSamples (Maybe Text)

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

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

listSamplesResponse_nextToken :: Lens' ListSamplesResponse (Maybe Text)

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.

listSamplesResponse_samples :: Lens' ListSamplesResponse (Maybe [Sample])

Information about the samples.

listSamplesResponse_httpStatus :: Lens' ListSamplesResponse Int

The response's http status code.

ListSuites

listSuites_nextToken :: Lens' ListSuites (Maybe Text)

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

The job's Amazon Resource Name (ARN).

listSuitesResponse_nextToken :: Lens' ListSuitesResponse (Maybe Text)

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.

listSuitesResponse_suites :: Lens' ListSuitesResponse (Maybe [Suite])

Information about the suites.

listSuitesResponse_httpStatus :: Lens' ListSuitesResponse Int

The response's http status code.

ListTagsForResource

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text

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])

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.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int

The response's http status code.

ListTestGridProjects

listTestGridProjects_maxResult :: Lens' ListTestGridProjects (Maybe Natural)

Return no more than this number of results.

listTestGridProjects_nextToken :: Lens' ListTestGridProjects (Maybe Text)

From a response, used to continue a paginated listing.

listTestGridProjectsResponse_nextToken :: Lens' ListTestGridProjectsResponse (Maybe Text)

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

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

The list of TestGridProjects, based on a ListTestGridProjectsRequest.

listTestGridProjectsResponse_httpStatus :: Lens' ListTestGridProjectsResponse Int

The response's http status code.

ListTestGridSessionActions

listTestGridSessionActions_maxResult :: Lens' ListTestGridSessionActions (Maybe Natural)

The maximum number of sessions to return per response.

listTestGridSessionActions_nextToken :: Lens' ListTestGridSessionActions (Maybe Text)

Pagination token.

listTestGridSessionActions_sessionArn :: Lens' ListTestGridSessionActions Text

The ARN of the session to retrieve.

listTestGridSessionActionsResponse_actions :: Lens' ListTestGridSessionActionsResponse (Maybe [TestGridSessionAction])

The action taken by the session.

listTestGridSessionActionsResponse_nextToken :: Lens' ListTestGridSessionActionsResponse (Maybe Text)

Pagination token.

listTestGridSessionActionsResponse_httpStatus :: Lens' ListTestGridSessionActionsResponse Int

The response's http status code.

ListTestGridSessionArtifacts

listTestGridSessionArtifacts_maxResult :: Lens' ListTestGridSessionArtifacts (Maybe Natural)

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

listTestGridSessionArtifacts_nextToken :: Lens' ListTestGridSessionArtifacts (Maybe Text)

Pagination token.

listTestGridSessionArtifacts_type :: Lens' ListTestGridSessionArtifacts (Maybe TestGridSessionArtifactCategory)

Limit results to a specified type of artifact.

listTestGridSessionArtifacts_sessionArn :: Lens' ListTestGridSessionArtifacts Text

The ARN of a TestGridSession.

listTestGridSessionArtifactsResponse_artifacts :: Lens' ListTestGridSessionArtifactsResponse (Maybe [TestGridSessionArtifact])

A list of test grid session artifacts for a TestGridSession.

listTestGridSessionArtifactsResponse_nextToken :: Lens' ListTestGridSessionArtifactsResponse (Maybe Text)

Pagination token.

listTestGridSessionArtifactsResponse_httpStatus :: Lens' ListTestGridSessionArtifactsResponse Int

The response's http status code.

ListTestGridSessions

listTestGridSessions_creationTimeAfter :: Lens' ListTestGridSessions (Maybe UTCTime)

Return only sessions created after this time.

listTestGridSessions_creationTimeBefore :: Lens' ListTestGridSessions (Maybe UTCTime)

Return only sessions created before this time.

listTestGridSessions_endTimeAfter :: Lens' ListTestGridSessions (Maybe UTCTime)

Return only sessions that ended after this time.

listTestGridSessions_endTimeBefore :: Lens' ListTestGridSessions (Maybe UTCTime)

Return only sessions that ended before this time.

listTestGridSessions_maxResult :: Lens' ListTestGridSessions (Maybe Natural)

Return only this many results at a time.

listTestGridSessions_nextToken :: Lens' ListTestGridSessions (Maybe Text)

Pagination token.

listTestGridSessions_status :: Lens' ListTestGridSessions (Maybe TestGridSessionStatus)

Return only sessions in this state.

listTestGridSessions_projectArn :: Lens' ListTestGridSessions Text

ARN of a TestGridProject.

listTestGridSessionsResponse_nextToken :: Lens' ListTestGridSessionsResponse (Maybe Text)

Pagination token.

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

The sessions that match the criteria in a ListTestGridSessionsRequest.

listTestGridSessionsResponse_httpStatus :: Lens' ListTestGridSessionsResponse Int

The response's http status code.

ListTests

listTests_nextToken :: Lens' ListTests (Maybe Text)

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

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

listTestsResponse_nextToken :: Lens' ListTestsResponse (Maybe Text)

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_tests :: Lens' ListTestsResponse (Maybe [Test])

Information about the tests.

listTestsResponse_httpStatus :: Lens' ListTestsResponse Int

The response's http status code.

ListUniqueProblems

listUniqueProblems_nextToken :: Lens' ListUniqueProblems (Maybe Text)

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.

listUniqueProblems_arn :: Lens' ListUniqueProblems Text

The unique problems' ARNs.

listUniqueProblemsResponse_nextToken :: Lens' ListUniqueProblemsResponse (Maybe Text)

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]))

Information about the unique problems.

Allowed values include:

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

listUniqueProblemsResponse_httpStatus :: Lens' ListUniqueProblemsResponse Int

The response's http status code.

ListUploads

listUploads_nextToken :: Lens' ListUploads (Maybe Text)

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)

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

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

listUploadsResponse_nextToken :: Lens' ListUploadsResponse (Maybe Text)

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.

listUploadsResponse_uploads :: Lens' ListUploadsResponse (Maybe [Upload])

Information about the uploads.

listUploadsResponse_httpStatus :: Lens' ListUploadsResponse Int

The response's http status code.

ListVPCEConfigurations

listVPCEConfigurations_maxResults :: Lens' ListVPCEConfigurations (Maybe Int)

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

listVPCEConfigurations_nextToken :: Lens' ListVPCEConfigurations (Maybe Text)

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_nextToken :: Lens' ListVPCEConfigurationsResponse (Maybe Text)

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])

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

listVPCEConfigurationsResponse_httpStatus :: Lens' ListVPCEConfigurationsResponse Int

The response's http status code.

PurchaseOffering

purchaseOffering_offeringPromotionId :: Lens' PurchaseOffering (Maybe Text)

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

purchaseOffering_offeringId :: Lens' PurchaseOffering Text

The ID of the offering.

purchaseOffering_quantity :: Lens' PurchaseOffering Int

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

purchaseOfferingResponse_offeringTransaction :: Lens' PurchaseOfferingResponse (Maybe OfferingTransaction)

Represents the offering transaction for the purchase result.

purchaseOfferingResponse_httpStatus :: Lens' PurchaseOfferingResponse Int

The response's http status code.

RenewOffering

renewOffering_offeringId :: Lens' RenewOffering Text

The ID of a request to renew an offering.

renewOffering_quantity :: Lens' RenewOffering Int

The quantity requested in an offering renewal.

renewOfferingResponse_offeringTransaction :: Lens' RenewOfferingResponse (Maybe OfferingTransaction)

Represents the status of the offering transaction for the renewal.

renewOfferingResponse_httpStatus :: Lens' RenewOfferingResponse Int

The response's http status code.

ScheduleRun

scheduleRun_appArn :: Lens' ScheduleRun (Maybe Text)

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

scheduleRun_configuration :: Lens' ScheduleRun (Maybe ScheduleRunConfiguration)

Information about the settings for the run to be scheduled.

scheduleRun_devicePoolArn :: Lens' ScheduleRun (Maybe Text)

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

scheduleRun_deviceSelectionConfiguration :: Lens' ScheduleRun (Maybe DeviceSelectionConfiguration)

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

Either devicePoolArn or deviceSelectionConfiguration is required in a request.

scheduleRun_executionConfiguration :: Lens' ScheduleRun (Maybe ExecutionConfiguration)

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

scheduleRun_name :: Lens' ScheduleRun (Maybe Text)

The name for the run to be scheduled.

scheduleRun_projectArn :: Lens' ScheduleRun Text

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

scheduleRun_test :: Lens' ScheduleRun ScheduleRunTest

Information about the test for the run to be scheduled.

scheduleRunResponse_run :: Lens' ScheduleRunResponse (Maybe Run)

Information about the scheduled run.

scheduleRunResponse_httpStatus :: Lens' ScheduleRunResponse Int

The response's http status code.

StopJob

stopJob_arn :: Lens' StopJob Text

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

stopJobResponse_job :: Lens' StopJobResponse (Maybe Job)

The job that was stopped.

stopJobResponse_httpStatus :: Lens' StopJobResponse Int

The response's http status code.

StopRemoteAccessSession

stopRemoteAccessSession_arn :: Lens' StopRemoteAccessSession Text

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

stopRemoteAccessSessionResponse_remoteAccessSession :: Lens' StopRemoteAccessSessionResponse (Maybe RemoteAccessSession)

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

stopRemoteAccessSessionResponse_httpStatus :: Lens' StopRemoteAccessSessionResponse Int

The response's http status code.

StopRun

stopRun_arn :: Lens' StopRun Text

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

stopRunResponse_run :: Lens' StopRunResponse (Maybe Run)

The run that was stopped.

stopRunResponse_httpStatus :: Lens' StopRunResponse Int

The response's http status code.

TagResource

tagResource_resourceARN :: Lens' TagResource Text

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]

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.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int

The response's http status code.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text

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]

The keys of the tags to be removed.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int

The response's http status code.

UpdateDeviceInstance

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

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

updateDeviceInstance_profileArn :: Lens' UpdateDeviceInstance (Maybe Text)

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

updateDeviceInstance_arn :: Lens' UpdateDeviceInstance Text

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

updateDeviceInstanceResponse_deviceInstance :: Lens' UpdateDeviceInstanceResponse (Maybe DeviceInstance)

An object that contains information about your device instance.

updateDeviceInstanceResponse_httpStatus :: Lens' UpdateDeviceInstanceResponse Int

The response's http status code.

UpdateDevicePool

updateDevicePool_clearMaxDevices :: Lens' UpdateDevicePool (Maybe Bool)

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_description :: Lens' UpdateDevicePool (Maybe Text)

A description of the device pool to update.

updateDevicePool_maxDevices :: Lens' UpdateDevicePool (Maybe Int)

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

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

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

updateDevicePool_name :: Lens' UpdateDevicePool (Maybe Text)

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

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

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_arn :: Lens' UpdateDevicePool Text

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

updateDevicePoolResponse_devicePool :: Lens' UpdateDevicePoolResponse (Maybe DevicePool)

The device pool you just updated.

updateDevicePoolResponse_httpStatus :: Lens' UpdateDevicePoolResponse Int

The response's http status code.

UpdateInstanceProfile

updateInstanceProfile_description :: Lens' UpdateInstanceProfile (Maybe Text)

The updated description for your instance profile.

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

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_name :: Lens' UpdateInstanceProfile (Maybe Text)

The updated name for your instance profile.

updateInstanceProfile_packageCleanup :: Lens' UpdateInstanceProfile (Maybe Bool)

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

updateInstanceProfile_rebootAfterUse :: Lens' UpdateInstanceProfile (Maybe Bool)

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

updateInstanceProfile_arn :: Lens' UpdateInstanceProfile Text

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

updateInstanceProfileResponse_instanceProfile :: Lens' UpdateInstanceProfileResponse (Maybe InstanceProfile)

An object that contains information about your instance profile.

updateInstanceProfileResponse_httpStatus :: Lens' UpdateInstanceProfileResponse Int

The response's http status code.

UpdateNetworkProfile

updateNetworkProfile_description :: Lens' UpdateNetworkProfile (Maybe Text)

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

updateNetworkProfile_downlinkBandwidthBits :: Lens' UpdateNetworkProfile (Maybe Integer)

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

updateNetworkProfile_downlinkDelayMs :: Lens' UpdateNetworkProfile (Maybe Integer)

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

updateNetworkProfile_downlinkJitterMs :: Lens' UpdateNetworkProfile (Maybe Integer)

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

updateNetworkProfile_downlinkLossPercent :: Lens' UpdateNetworkProfile (Maybe Natural)

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

updateNetworkProfile_name :: Lens' UpdateNetworkProfile (Maybe Text)

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

updateNetworkProfile_type :: Lens' UpdateNetworkProfile (Maybe NetworkProfileType)

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

updateNetworkProfile_uplinkBandwidthBits :: Lens' UpdateNetworkProfile (Maybe Integer)

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

updateNetworkProfile_uplinkDelayMs :: Lens' UpdateNetworkProfile (Maybe Integer)

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

updateNetworkProfile_uplinkJitterMs :: Lens' UpdateNetworkProfile (Maybe Integer)

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

updateNetworkProfile_uplinkLossPercent :: Lens' UpdateNetworkProfile (Maybe Natural)

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

updateNetworkProfile_arn :: Lens' UpdateNetworkProfile Text

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

updateNetworkProfileResponse_networkProfile :: Lens' UpdateNetworkProfileResponse (Maybe NetworkProfile)

A list of the available network profiles.

updateNetworkProfileResponse_httpStatus :: Lens' UpdateNetworkProfileResponse Int

The response's http status code.

UpdateProject

updateProject_defaultJobTimeoutMinutes :: Lens' UpdateProject (Maybe Int)

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

updateProject_name :: Lens' UpdateProject (Maybe Text)

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

updateProject_vpcConfig :: Lens' UpdateProject (Maybe VpcConfig)

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

updateProject_arn :: Lens' UpdateProject Text

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

updateProjectResponse_project :: Lens' UpdateProjectResponse (Maybe Project)

The project to update.

updateProjectResponse_httpStatus :: Lens' UpdateProjectResponse Int

The response's http status code.

UpdateTestGridProject

updateTestGridProject_description :: Lens' UpdateTestGridProject (Maybe Text)

Human-readable description for the project.

updateTestGridProject_name :: Lens' UpdateTestGridProject (Maybe Text)

Human-readable name for the project.

updateTestGridProject_vpcConfig :: Lens' UpdateTestGridProject (Maybe TestGridVpcConfig)

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

updateTestGridProject_projectArn :: Lens' UpdateTestGridProject Text

ARN of the project to update.

updateTestGridProjectResponse_testGridProject :: Lens' UpdateTestGridProjectResponse (Maybe TestGridProject)

The project, including updated information.

updateTestGridProjectResponse_httpStatus :: Lens' UpdateTestGridProjectResponse Int

The response's http status code.

UpdateUpload

updateUpload_contentType :: Lens' UpdateUpload (Maybe Text)

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

updateUpload_editContent :: Lens' UpdateUpload (Maybe Bool)

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

updateUpload_name :: Lens' UpdateUpload (Maybe Text)

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_arn :: Lens' UpdateUpload Text

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

updateUploadResponse_upload :: Lens' UpdateUploadResponse (Maybe Upload)

A test spec uploaded to Device Farm.

updateUploadResponse_httpStatus :: Lens' UpdateUploadResponse Int

The response's http status code.

UpdateVPCEConfiguration

updateVPCEConfiguration_serviceDnsName :: Lens' UpdateVPCEConfiguration (Maybe Text)

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)

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

updateVPCEConfiguration_vpceConfigurationName :: Lens' UpdateVPCEConfiguration (Maybe Text)

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

updateVPCEConfiguration_vpceServiceName :: Lens' UpdateVPCEConfiguration (Maybe Text)

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

updateVPCEConfiguration_arn :: Lens' UpdateVPCEConfiguration Text

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

updateVPCEConfigurationResponse_vpceConfiguration :: Lens' UpdateVPCEConfigurationResponse (Maybe VPCEConfiguration)

An object that contains information about your VPC endpoint configuration.

updateVPCEConfigurationResponse_httpStatus :: Lens' UpdateVPCEConfigurationResponse Int

The response's http status code.

Types

AccountSettings

accountSettings_awsAccountNumber :: Lens' AccountSettings (Maybe Text)

The AWS account number specified in the AccountSettings container.

accountSettings_defaultJobTimeoutMinutes :: Lens' AccountSettings (Maybe Int)

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

accountSettings_maxJobTimeoutMinutes :: Lens' AccountSettings (Maybe Int)

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

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

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_skipAppResign :: Lens' AccountSettings (Maybe Bool)

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_trialMinutes :: Lens' AccountSettings (Maybe TrialMinutes)

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

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

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

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

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

Artifact

artifact_arn :: Lens' Artifact (Maybe Text)

The artifact's ARN.

artifact_extension :: Lens' Artifact (Maybe Text)

The artifact's file extension.

artifact_name :: Lens' Artifact (Maybe Text)

The artifact's name.

artifact_type :: Lens' Artifact (Maybe ArtifactType)

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

artifact_url :: Lens' Artifact (Maybe Text)

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

CPU

cpu_architecture :: Lens' CPU (Maybe Text)

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

cpu_clock :: Lens' CPU (Maybe Double)

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

cpu_frequency :: Lens' CPU (Maybe Text)

The CPU's frequency.

Counters

counters_errored :: Lens' Counters (Maybe Int)

The number of errored entities.

counters_failed :: Lens' Counters (Maybe Int)

The number of failed entities.

counters_passed :: Lens' Counters (Maybe Int)

The number of passed entities.

counters_skipped :: Lens' Counters (Maybe Int)

The number of skipped entities.

counters_stopped :: Lens' Counters (Maybe Int)

The number of stopped entities.

counters_total :: Lens' Counters (Maybe Int)

The total number of entities.

counters_warned :: Lens' Counters (Maybe Int)

The number of warned entities.

CreateRemoteAccessSessionConfiguration

createRemoteAccessSessionConfiguration_billingMethod :: Lens' CreateRemoteAccessSessionConfiguration (Maybe BillingMethod)

The billing method for the remote access session.

createRemoteAccessSessionConfiguration_vpceConfigurationArns :: Lens' CreateRemoteAccessSessionConfiguration (Maybe [Text])

An array of ARNs included in the VPC endpoint configuration.

CustomerArtifactPaths

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

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])

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])

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

Device

device_arn :: Lens' Device (Maybe Text)

The device's ARN.

device_availability :: Lens' Device (Maybe DeviceAvailability)

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

device_carrier :: Lens' Device (Maybe Text)

The device's carrier.

device_cpu :: Lens' Device (Maybe CPU)

Information about the device's CPU.

device_fleetName :: Lens' Device (Maybe Text)

The name of the fleet to which this device belongs.

device_fleetType :: Lens' Device (Maybe Text)

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

device_formFactor :: Lens' Device (Maybe DeviceFormFactor)

The device's form factor.

Allowed values include:

• PHONE
• TABLET

device_heapSize :: Lens' Device (Maybe Integer)

The device's heap size, expressed in bytes.

device_image :: Lens' Device (Maybe Text)

The device's image name.

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

The instances that belong to this device.

device_manufacturer :: Lens' Device (Maybe Text)

The device's manufacturer name.

device_memory :: Lens' Device (Maybe Integer)

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

device_model :: Lens' Device (Maybe Text)

The device's model name.

device_modelId :: Lens' Device (Maybe Text)

The device's model ID.

device_name :: Lens' Device (Maybe Text)

The device's display name.

device_os :: Lens' Device (Maybe Text)

The device's operating system type.

device_platform :: Lens' Device (Maybe DevicePlatform)

The device's platform.

Allowed values include:

• ANDROID
• IOS

device_radio :: Lens' Device (Maybe Text)

The device's radio.

device_remoteAccessEnabled :: Lens' Device (Maybe Bool)

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

device_remoteDebugEnabled :: Lens' Device (Maybe Bool)

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

Remote debugging is no longer supported.

device_resolution :: Lens' Device (Maybe Resolution)

The resolution of the device.

DeviceFilter

deviceFilter_attribute :: Lens' DeviceFilter DeviceFilterAttribute

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

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

deviceFilter_values :: Lens' DeviceFilter [Text]

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_arn :: Lens' DeviceInstance (Maybe Text)

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

deviceInstance_deviceArn :: Lens' DeviceInstance (Maybe Text)

The ARN of the device.

deviceInstance_instanceProfile :: Lens' DeviceInstance (Maybe InstanceProfile)

A object that contains information about the instance profile.

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

An array of strings that describe the device instance.

deviceInstance_status :: Lens' DeviceInstance (Maybe InstanceStatus)

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

deviceInstance_udid :: Lens' DeviceInstance (Maybe Text)

Unique device identifier for the device instance.

DeviceMinutes

deviceMinutes_metered :: Lens' DeviceMinutes (Maybe Double)

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

deviceMinutes_total :: Lens' DeviceMinutes (Maybe Double)

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

deviceMinutes_unmetered :: Lens' DeviceMinutes (Maybe Double)

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

DevicePool

devicePool_arn :: Lens' DevicePool (Maybe Text)

The device pool's ARN.

devicePool_description :: Lens' DevicePool (Maybe Text)

The device pool's description.

devicePool_maxDevices :: Lens' DevicePool (Maybe Int)

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

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

devicePool_name :: Lens' DevicePool (Maybe Text)

The device pool's name.

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

Information about the device pool's rules.

devicePool_type :: Lens' DevicePool (Maybe DevicePoolType)

The device pool's type.

Allowed values include:

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

DevicePoolCompatibilityResult

devicePoolCompatibilityResult_compatible :: Lens' DevicePoolCompatibilityResult (Maybe Bool)

Whether the result was compatible with the device pool.

devicePoolCompatibilityResult_device :: Lens' DevicePoolCompatibilityResult (Maybe Device)

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

devicePoolCompatibilityResult_incompatibilityMessages :: Lens' DevicePoolCompatibilityResult (Maybe [IncompatibilityMessage])

Information about the compatibility.

DeviceSelectionConfiguration

deviceSelectionConfiguration_filters :: Lens' DeviceSelectionConfiguration [DeviceFilter]

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

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

DeviceSelectionResult

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

The filters in a device selection result.

deviceSelectionResult_matchedDevicesCount :: Lens' DeviceSelectionResult (Maybe Int)

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

deviceSelectionResult_maxDevices :: Lens' DeviceSelectionResult (Maybe Int)

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

ExecutionConfiguration

executionConfiguration_accountsCleanup :: Lens' ExecutionConfiguration (Maybe Bool)

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

executionConfiguration_appPackagesCleanup :: Lens' ExecutionConfiguration (Maybe Bool)

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

executionConfiguration_jobTimeoutMinutes :: Lens' ExecutionConfiguration (Maybe Int)

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

executionConfiguration_skipAppResign :: Lens' ExecutionConfiguration (Maybe Bool)

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_videoCapture :: Lens' ExecutionConfiguration (Maybe Bool)

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

IncompatibilityMessage

incompatibilityMessage_message :: Lens' IncompatibilityMessage (Maybe Text)

A message about the incompatibility.

incompatibilityMessage_type :: Lens' IncompatibilityMessage (Maybe DeviceAttribute)

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)

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

instanceProfile_description :: Lens' InstanceProfile (Maybe Text)

The description of the instance profile.

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

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_name :: Lens' InstanceProfile (Maybe Text)

The name of the instance profile.

instanceProfile_packageCleanup :: Lens' InstanceProfile (Maybe Bool)

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

instanceProfile_rebootAfterUse :: Lens' InstanceProfile (Maybe Bool)

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

Job

job_arn :: Lens' Job (Maybe Text)

The job's ARN.

job_counters :: Lens' Job (Maybe Counters)

The job's result counters.

job_created :: Lens' Job (Maybe UTCTime)

When the job was created.

job_device :: Lens' Job (Maybe Device)

The device (phone or tablet).

job_deviceMinutes :: Lens' Job (Maybe DeviceMinutes)

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

job_instanceArn :: Lens' Job (Maybe Text)

The ARN of the instance.

job_message :: Lens' Job (Maybe Text)

A message about the job's result.

job_name :: Lens' Job (Maybe Text)

The job's name.

job_result :: Lens' Job (Maybe ExecutionResult)

The job's result.

Allowed values include:

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

job_started :: Lens' Job (Maybe UTCTime)

The job's start time.

job_status :: Lens' Job (Maybe ExecutionStatus)

The job's status.

Allowed values include:

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

job_stopped :: Lens' Job (Maybe UTCTime)

The job's stop time.

job_type :: Lens' Job (Maybe TestType)

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_videoCapture :: Lens' Job (Maybe Bool)

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

job_videoEndpoint :: Lens' Job (Maybe Text)

The endpoint for streaming device video.

Location

location_latitude :: Lens' Location Double

The latitude.

location_longitude :: Lens' Location Double

The longitude.

MonetaryAmount

monetaryAmount_amount :: Lens' MonetaryAmount (Maybe Double)

The numerical amount of an offering or transaction.

monetaryAmount_currencyCode :: Lens' MonetaryAmount (Maybe CurrencyCode)

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

NetworkProfile

networkProfile_arn :: Lens' NetworkProfile (Maybe Text)

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

networkProfile_description :: Lens' NetworkProfile (Maybe Text)

The description of the network profile.

networkProfile_downlinkBandwidthBits :: Lens' NetworkProfile (Maybe Integer)

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

networkProfile_downlinkDelayMs :: Lens' NetworkProfile (Maybe Integer)

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

networkProfile_downlinkJitterMs :: Lens' NetworkProfile (Maybe Integer)

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

networkProfile_downlinkLossPercent :: Lens' NetworkProfile (Maybe Natural)

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

networkProfile_name :: Lens' NetworkProfile (Maybe Text)

The name of the network profile.

networkProfile_type :: Lens' NetworkProfile (Maybe NetworkProfileType)

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

networkProfile_uplinkBandwidthBits :: Lens' NetworkProfile (Maybe Integer)

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

networkProfile_uplinkDelayMs :: Lens' NetworkProfile (Maybe Integer)

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

networkProfile_uplinkJitterMs :: Lens' NetworkProfile (Maybe Integer)

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

networkProfile_uplinkLossPercent :: Lens' NetworkProfile (Maybe Natural)

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

Offering

offering_description :: Lens' Offering (Maybe Text)

A string that describes the offering.

offering_id :: Lens' Offering (Maybe Text)

The ID that corresponds to a device offering.

offering_platform :: Lens' Offering (Maybe DevicePlatform)

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

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

Specifies whether there are recurring charges for the offering.

offering_type :: Lens' Offering (Maybe OfferingType)

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

OfferingPromotion

offeringPromotion_description :: Lens' OfferingPromotion (Maybe Text)

A string that describes the offering promotion.

offeringPromotion_id :: Lens' OfferingPromotion (Maybe Text)

The ID of the offering promotion.

OfferingStatus

offeringStatus_effectiveOn :: Lens' OfferingStatus (Maybe UTCTime)

The date on which the offering is effective.

offeringStatus_offering :: Lens' OfferingStatus (Maybe Offering)

Represents the metadata of an offering status.

offeringStatus_quantity :: Lens' OfferingStatus (Maybe Int)

The number of available devices in the offering.

offeringStatus_type :: Lens' OfferingStatus (Maybe OfferingTransactionType)

The type specified for the offering status.

OfferingTransaction

offeringTransaction_cost :: Lens' OfferingTransaction (Maybe MonetaryAmount)

The cost of an offering transaction.

offeringTransaction_createdOn :: Lens' OfferingTransaction (Maybe UTCTime)

The date on which an offering transaction was created.

offeringTransaction_offeringPromotionId :: Lens' OfferingTransaction (Maybe Text)

The ID that corresponds to a device offering promotion.

offeringTransaction_offeringStatus :: Lens' OfferingTransaction (Maybe OfferingStatus)

The status of an offering transaction.

offeringTransaction_transactionId :: Lens' OfferingTransaction (Maybe Text)

The transaction ID of the offering transaction.

Problem

problem_device :: Lens' Problem (Maybe Device)

Information about the associated device.

problem_job :: Lens' Problem (Maybe ProblemDetail)

Information about the associated job.

problem_message :: Lens' Problem (Maybe Text)

A message about the problem's result.

problem_result :: Lens' Problem (Maybe ExecutionResult)

The problem's result.

Allowed values include:

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

problem_run :: Lens' Problem (Maybe ProblemDetail)

Information about the associated run.

problem_suite :: Lens' Problem (Maybe ProblemDetail)

Information about the associated suite.

problem_test :: Lens' Problem (Maybe ProblemDetail)

Information about the associated test.

ProblemDetail

problemDetail_arn :: Lens' ProblemDetail (Maybe Text)

The problem detail's ARN.

problemDetail_name :: Lens' ProblemDetail (Maybe Text)

The problem detail's name.

Project

project_arn :: Lens' Project (Maybe Text)

The project's ARN.

project_created :: Lens' Project (Maybe UTCTime)

When the project was created.

project_defaultJobTimeoutMinutes :: Lens' Project (Maybe Int)

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

project_name :: Lens' Project (Maybe Text)

The project's name.

project_vpcConfig :: Lens' Project (Maybe VpcConfig)

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

Radios

radios_bluetooth :: Lens' Radios (Maybe Bool)

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

radios_gps :: Lens' Radios (Maybe Bool)

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

radios_nfc :: Lens' Radios (Maybe Bool)

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

radios_wifi :: Lens' Radios (Maybe Bool)

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

RecurringCharge

recurringCharge_cost :: Lens' RecurringCharge (Maybe MonetaryAmount)

The cost of the recurring charge.

recurringCharge_frequency :: Lens' RecurringCharge (Maybe RecurringChargeFrequency)

The frequency in which charges recur.

RemoteAccessSession

remoteAccessSession_arn :: Lens' RemoteAccessSession (Maybe Text)

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

remoteAccessSession_billingMethod :: Lens' RemoteAccessSession (Maybe BillingMethod)

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

remoteAccessSession_clientId :: Lens' RemoteAccessSession (Maybe Text)

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_created :: Lens' RemoteAccessSession (Maybe UTCTime)

The date and time the remote access session was created.

remoteAccessSession_device :: Lens' RemoteAccessSession (Maybe Device)

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

remoteAccessSession_deviceMinutes :: Lens' RemoteAccessSession (Maybe DeviceMinutes)

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

remoteAccessSession_deviceUdid :: Lens' RemoteAccessSession (Maybe Text)

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_endpoint :: Lens' RemoteAccessSession (Maybe Text)

The endpoint for the remote access sesssion.

remoteAccessSession_hostAddress :: Lens' RemoteAccessSession (Maybe Text)

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_instanceArn :: Lens' RemoteAccessSession (Maybe Text)

The ARN of the instance.

remoteAccessSession_interactionMode :: Lens' RemoteAccessSession (Maybe InteractionMode)

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

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

remoteAccessSession_message :: Lens' RemoteAccessSession (Maybe Text)

A message about the remote access session.

remoteAccessSession_name :: Lens' RemoteAccessSession (Maybe Text)

The name of the remote access session.

remoteAccessSession_remoteDebugEnabled :: Lens' RemoteAccessSession (Maybe Bool)

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

Remote debugging is no longer supported.

remoteAccessSession_remoteRecordAppArn :: Lens' RemoteAccessSession (Maybe Text)

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

remoteAccessSession_remoteRecordEnabled :: Lens' RemoteAccessSession (Maybe Bool)

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

remoteAccessSession_result :: Lens' RemoteAccessSession (Maybe ExecutionResult)

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

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

remoteAccessSession_skipAppResign :: Lens' RemoteAccessSession (Maybe Bool)

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_started :: Lens' RemoteAccessSession (Maybe UTCTime)

The date and time the remote access session was started.

remoteAccessSession_status :: Lens' RemoteAccessSession (Maybe ExecutionStatus)

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_stopped :: Lens' RemoteAccessSession (Maybe UTCTime)

The date and time the remote access session was stopped.

remoteAccessSession_vpcConfig :: Lens' RemoteAccessSession (Maybe VpcConfig)

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

Resolution

resolution_height :: Lens' Resolution (Maybe Int)

The screen resolution's height, expressed in pixels.

resolution_width :: Lens' Resolution (Maybe Int)

The screen resolution's width, expressed in pixels.

Rule

rule_attribute :: Lens' Rule (Maybe DeviceAttribute)

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)

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)

The rule's value.

Run

run_appUpload :: Lens' Run (Maybe Text)

An app to upload or that has been uploaded.

run_arn :: Lens' Run (Maybe Text)

The run's ARN.

run_billingMethod :: Lens' Run (Maybe BillingMethod)

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

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

run_completedJobs :: Lens' Run (Maybe Int)

The total number of completed jobs.

run_counters :: Lens' Run (Maybe Counters)

The run's result counters.

run_created :: Lens' Run (Maybe UTCTime)

When the run was created.

run_customerArtifactPaths :: Lens' Run (Maybe CustomerArtifactPaths)

Output CustomerArtifactPaths object for the test run.

run_deviceMinutes :: Lens' Run (Maybe DeviceMinutes)

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

run_devicePoolArn :: Lens' Run (Maybe Text)

The ARN of the device pool for the run.

run_deviceSelectionResult :: Lens' Run (Maybe DeviceSelectionResult)

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

run_eventCount :: Lens' Run (Maybe Int)

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

run_jobTimeoutMinutes :: Lens' Run (Maybe Int)

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

run_locale :: Lens' Run (Maybe Text)

Information about the locale that is used for the run.

run_location :: Lens' Run (Maybe Location)

Information about the location that is used for the run.

run_message :: Lens' Run (Maybe Text)

A message about the run's result.

run_name :: Lens' Run (Maybe Text)

The run's name.

run_networkProfile :: Lens' Run (Maybe NetworkProfile)

The network profile being used for a test run.

run_parsingResultUrl :: Lens' Run (Maybe Text)

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_platform :: Lens' Run (Maybe DevicePlatform)

The run's platform.

Allowed values include:

• ANDROID
• IOS

run_radios :: Lens' Run (Maybe Radios)

Information about the radio states for the run.

run_result :: Lens' Run (Maybe ExecutionResult)

The run's result.

Allowed values include:

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

run_resultCode :: Lens' Run (Maybe ExecutionResultCode)

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_seed :: Lens' Run (Maybe Int)

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

run_skipAppResign :: Lens' Run (Maybe Bool)

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_started :: Lens' Run (Maybe UTCTime)

The run's start time.

run_status :: Lens' Run (Maybe ExecutionStatus)

The run's status.

Allowed values include:

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

run_stopped :: Lens' Run (Maybe UTCTime)

The run's stop time.

run_testSpecArn :: Lens' Run (Maybe Text)

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

run_totalJobs :: Lens' Run (Maybe Int)

The total number of jobs for the run.

run_type :: Lens' Run (Maybe TestType)

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_vpcConfig :: Lens' Run (Maybe VpcConfig)

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

run_webUrl :: Lens' Run (Maybe Text)

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

Sample

sample_arn :: Lens' Sample (Maybe Text)

The sample's ARN.

sample_type :: Lens' Sample (Maybe SampleType)

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.

sample_url :: Lens' Sample (Maybe Text)

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

ScheduleRunConfiguration

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

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

scheduleRunConfiguration_billingMethod :: Lens' ScheduleRunConfiguration (Maybe BillingMethod)

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

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

scheduleRunConfiguration_customerArtifactPaths :: Lens' ScheduleRunConfiguration (Maybe CustomerArtifactPaths)

Input CustomerArtifactPaths object for the scheduled run configuration.

scheduleRunConfiguration_extraDataPackageArn :: Lens' ScheduleRunConfiguration (Maybe Text)

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_locale :: Lens' ScheduleRunConfiguration (Maybe Text)

Information about the locale that is used for the run.

scheduleRunConfiguration_location :: Lens' ScheduleRunConfiguration (Maybe Location)

Information about the location that is used for the run.

scheduleRunConfiguration_networkProfileArn :: Lens' ScheduleRunConfiguration (Maybe Text)

Reserved for internal use.

scheduleRunConfiguration_radios :: Lens' ScheduleRunConfiguration (Maybe Radios)

Information about the radio states for the run.

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

An array of ARNs for your VPC endpoint configurations.

ScheduleRunTest

scheduleRunTest_filter :: Lens' ScheduleRunTest (Maybe Text)

The test's filter.

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

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_testPackageArn :: Lens' ScheduleRunTest (Maybe Text)

The ARN of the uploaded test to be run.

scheduleRunTest_testSpecArn :: Lens' ScheduleRunTest (Maybe Text)

The ARN of the YAML-formatted test specification.

scheduleRunTest_type :: Lens' ScheduleRunTest TestType

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_arn :: Lens' Suite (Maybe Text)

The suite's ARN.

suite_counters :: Lens' Suite (Maybe Counters)

The suite's result counters.

suite_created :: Lens' Suite (Maybe UTCTime)

When the suite was created.

suite_deviceMinutes :: Lens' Suite (Maybe DeviceMinutes)

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

suite_message :: Lens' Suite (Maybe Text)

A message about the suite's result.

suite_name :: Lens' Suite (Maybe Text)

The suite's name.

suite_result :: Lens' Suite (Maybe ExecutionResult)

The suite's result.

Allowed values include:

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

suite_started :: Lens' Suite (Maybe UTCTime)

The suite's start time.

suite_status :: Lens' Suite (Maybe ExecutionStatus)

The suite's status.

Allowed values include:

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

suite_stopped :: Lens' Suite (Maybe UTCTime)

The suite's stop time.

suite_type :: Lens' Suite (Maybe TestType)

The suite's type.

Must be one of the following values:

• BUILTIN_FUZZ

• BUILTIN_EXPLORER

  Only available for Android; an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT
• APPIUM_JAVA_TESTNG
• APPIUM_PYTHON
• APPIUM_NODE
• APPIUM_RUBY
• APPIUM_WEB_JAVA_JUNIT
• APPIUM_WEB_JAVA_TESTNG
• APPIUM_WEB_PYTHON
• APPIUM_WEB_NODE
• APPIUM_WEB_RUBY
• CALABASH
• INSTRUMENTATION
• UIAUTOMATION
• UIAUTOMATOR
• XCTEST
• XCTEST_UI

Tag

tag_key :: Lens' Tag Text

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

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_arn :: Lens' Test (Maybe Text)

The test's ARN.

test_counters :: Lens' Test (Maybe Counters)

The test's result counters.

test_created :: Lens' Test (Maybe UTCTime)

When the test was created.

test_deviceMinutes :: Lens' Test (Maybe DeviceMinutes)

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

test_message :: Lens' Test (Maybe Text)

A message about the test's result.

test_name :: Lens' Test (Maybe Text)

The test's name.

test_result :: Lens' Test (Maybe ExecutionResult)

The test's result.

Allowed values include:

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

test_started :: Lens' Test (Maybe UTCTime)

The test's start time.

test_status :: Lens' Test (Maybe ExecutionStatus)

The test's status.

Allowed values include:

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

test_stopped :: Lens' Test (Maybe UTCTime)

The test's stop time.

test_type :: Lens' Test (Maybe TestType)

The test's type.

Must be one of the following values:

• BUILTIN_FUZZ

• BUILTIN_EXPLORER

  For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT
• APPIUM_JAVA_TESTNG
• APPIUM_PYTHON
• APPIUM_NODE
• APPIUM_RUBY
• APPIUM_WEB_JAVA_JUNIT
• APPIUM_WEB_JAVA_TESTNG
• APPIUM_WEB_PYTHON
• APPIUM_WEB_NODE
• APPIUM_WEB_RUBY
• CALABASH
• INSTRUMENTATION
• UIAUTOMATION
• UIAUTOMATOR
• XCTEST
• XCTEST_UI

TestGridProject

testGridProject_arn :: Lens' TestGridProject (Maybe Text)

The ARN for the project.

testGridProject_created :: Lens' TestGridProject (Maybe UTCTime)

When the project was created.

testGridProject_description :: Lens' TestGridProject (Maybe Text)

A human-readable description for the project.

testGridProject_name :: Lens' TestGridProject (Maybe Text)

A human-readable name for the project.

testGridProject_vpcConfig :: Lens' TestGridProject (Maybe TestGridVpcConfig)

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

TestGridSession

testGridSession_arn :: Lens' TestGridSession (Maybe Text)

The ARN of the session.

testGridSession_billingMinutes :: Lens' TestGridSession (Maybe Double)

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

testGridSession_created :: Lens' TestGridSession (Maybe UTCTime)

The time that the session was started.

testGridSession_ended :: Lens' TestGridSession (Maybe UTCTime)

The time the session ended.

testGridSession_seleniumProperties :: Lens' TestGridSession (Maybe Text)

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

testGridSession_status :: Lens' TestGridSession (Maybe TestGridSessionStatus)

The state of the session.

TestGridSessionAction

testGridSessionAction_action :: Lens' TestGridSessionAction (Maybe Text)

The action taken by the session.

testGridSessionAction_duration :: Lens' TestGridSessionAction (Maybe Integer)

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

testGridSessionAction_requestMethod :: Lens' TestGridSessionAction (Maybe Text)

HTTP method that the browser used to make the request.

testGridSessionAction_started :: Lens' TestGridSessionAction (Maybe UTCTime)

The time that the session invoked the action.

testGridSessionAction_statusCode :: Lens' TestGridSessionAction (Maybe Text)

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

TestGridSessionArtifact

testGridSessionArtifact_filename :: Lens' TestGridSessionArtifact (Maybe Text)

The file name of the artifact.

testGridSessionArtifact_type :: Lens' TestGridSessionArtifact (Maybe TestGridSessionArtifactType)

The kind of artifact.

testGridSessionArtifact_url :: Lens' TestGridSessionArtifact (Maybe Text)

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

TestGridVpcConfig

testGridVpcConfig_securityGroupIds :: Lens' TestGridVpcConfig (NonEmpty Text)

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

testGridVpcConfig_subnetIds :: Lens' TestGridVpcConfig (NonEmpty Text)

A list of VPC subnet IDs in your Amazon VPC.

testGridVpcConfig_vpcId :: Lens' TestGridVpcConfig Text

The ID of the Amazon VPC.

TrialMinutes

trialMinutes_remaining :: Lens' TrialMinutes (Maybe Double)

The number of free trial minutes remaining in the account.

trialMinutes_total :: Lens' TrialMinutes (Maybe Double)

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

UniqueProblem

uniqueProblem_message :: Lens' UniqueProblem (Maybe Text)

A message about the unique problems' result.

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

Information about the problems.

Upload

upload_arn :: Lens' Upload (Maybe Text)

The upload's ARN.

upload_category :: Lens' Upload (Maybe UploadCategory)

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_contentType :: Lens' Upload (Maybe Text)

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

upload_created :: Lens' Upload (Maybe UTCTime)

When the upload was created.

upload_message :: Lens' Upload (Maybe Text)

A message about the upload's result.

upload_metadata :: Lens' Upload (Maybe Text)

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_name :: Lens' Upload (Maybe Text)

The upload's file name.

upload_status :: Lens' Upload (Maybe UploadStatus)

The upload's status.

Must be one of the following values:

• FAILED
• INITIALIZED
• PROCESSING
• SUCCEEDED

upload_type :: Lens' Upload (Maybe UploadType)

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_url :: Lens' Upload (Maybe Text)

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

VPCEConfiguration

vPCEConfiguration_arn :: Lens' VPCEConfiguration (Maybe Text)

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

vPCEConfiguration_serviceDnsName :: Lens' VPCEConfiguration (Maybe Text)

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

vPCEConfiguration_vpceConfigurationDescription :: Lens' VPCEConfiguration (Maybe Text)

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

vPCEConfiguration_vpceConfigurationName :: Lens' VPCEConfiguration (Maybe Text)

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

vPCEConfiguration_vpceServiceName :: Lens' VPCEConfiguration (Maybe Text)

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

VpcConfig

vpcConfig_securityGroupIds :: Lens' VpcConfig (NonEmpty Text)

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

vpcConfig_subnetIds :: Lens' VpcConfig (NonEmpty Text)

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

vpcConfig_vpcId :: Lens' VpcConfig Text

The ID of the Amazon VPC.