Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- ArtifactCategory
- ArtifactType
- BillingMethod
- DeviceAttribute
- DeviceFormFactor
- DevicePlatform
- DevicePoolType
- ExecutionResult
- ExecutionStatus
- RuleOperator
- SampleType
- TestType
- UploadStatus
- UploadType
- AccountSettings
- Artifact
- CPU
- Counters
- Device
- DevicePool
- DevicePoolCompatibilityResult
- IncompatibilityMessage
- Job
- Location
- Problem
- ProblemDetail
- Project
- Radios
- Resolution
- Rule
- Run
- Sample
- ScheduleRunConfiguration
- ScheduleRunTest
- Suite
- Test
- UniqueProblem
- Upload
AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud.
See: AWS API Reference
- deviceFarm :: Service
- _IdempotencyException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ArgumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceAccountException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.DeviceFarm.ListProjects
- module Network.AWS.DeviceFarm.GetDevicePoolCompatibility
- module Network.AWS.DeviceFarm.ListTests
- module Network.AWS.DeviceFarm.CreateUpload
- module Network.AWS.DeviceFarm.ListArtifacts
- module Network.AWS.DeviceFarm.GetDevicePool
- module Network.AWS.DeviceFarm.GetUpload
- module Network.AWS.DeviceFarm.ListDevicePools
- module Network.AWS.DeviceFarm.GetTest
- module Network.AWS.DeviceFarm.CreateDevicePool
- module Network.AWS.DeviceFarm.ListRuns
- module Network.AWS.DeviceFarm.ListJobs
- module Network.AWS.DeviceFarm.GetDevice
- module Network.AWS.DeviceFarm.GetJob
- module Network.AWS.DeviceFarm.ScheduleRun
- module Network.AWS.DeviceFarm.GetRun
- module Network.AWS.DeviceFarm.ListSamples
- module Network.AWS.DeviceFarm.ListSuites
- module Network.AWS.DeviceFarm.GetAccountSettings
- module Network.AWS.DeviceFarm.ListUploads
- module Network.AWS.DeviceFarm.GetSuite
- module Network.AWS.DeviceFarm.GetProject
- module Network.AWS.DeviceFarm.ListDevices
- module Network.AWS.DeviceFarm.ListUniqueProblems
- module Network.AWS.DeviceFarm.CreateProject
- data ArtifactCategory
- = ACFile
- | ACLog
- | ACScreenshot
- data ArtifactType
- data BillingMethod
- data DeviceAttribute
- data DeviceFormFactor
- data DevicePlatform
- data DevicePoolType
- data ExecutionResult
- data ExecutionStatus
- data RuleOperator
- = Equals
- | GreaterThan
- | IN
- | LessThan
- | NotIn
- data SampleType
- data TestType
- data UploadStatus
- data UploadType
- data AccountSettings
- accountSettings :: AccountSettings
- asAwsAccountNumber :: Lens' AccountSettings (Maybe Text)
- asUnmeteredDevices :: Lens' AccountSettings (HashMap DevicePlatform Int)
- data Artifact
- artifact :: Artifact
- aArn :: Lens' Artifact (Maybe Text)
- aUrl :: Lens' Artifact (Maybe Text)
- aExtension :: Lens' Artifact (Maybe Text)
- aName :: Lens' Artifact (Maybe Text)
- aType :: Lens' Artifact (Maybe ArtifactType)
- data CPU
- cpu :: CPU
- cpuFrequency :: Lens' CPU (Maybe Text)
- cpuClock :: Lens' CPU (Maybe Double)
- cpuArchitecture :: Lens' CPU (Maybe Text)
- data Counters
- counters :: Counters
- cPassed :: Lens' Counters (Maybe Int)
- cSkipped :: Lens' Counters (Maybe Int)
- cWarned :: Lens' Counters (Maybe Int)
- cStopped :: Lens' Counters (Maybe Int)
- cTotal :: Lens' Counters (Maybe Int)
- cFailed :: Lens' Counters (Maybe Int)
- cErrored :: Lens' Counters (Maybe Int)
- data Device
- device :: Device
- dCarrier :: Lens' Device (Maybe Text)
- dImage :: Lens' Device (Maybe Text)
- dManufacturer :: Lens' Device (Maybe Text)
- dPlatform :: Lens' Device (Maybe DevicePlatform)
- dArn :: Lens' Device (Maybe Text)
- dFormFactor :: Lens' Device (Maybe DeviceFormFactor)
- dResolution :: Lens' Device (Maybe Resolution)
- dMemory :: Lens' Device (Maybe Integer)
- dRadio :: Lens' Device (Maybe Text)
- dOs :: Lens' Device (Maybe Text)
- dName :: Lens' Device (Maybe Text)
- dModel :: Lens' Device (Maybe Text)
- dCpu :: Lens' Device (Maybe CPU)
- dHeapSize :: Lens' Device (Maybe Integer)
- data DevicePool
- devicePool :: DevicePool
- dpArn :: Lens' DevicePool (Maybe Text)
- dpRules :: Lens' DevicePool [Rule]
- dpName :: Lens' DevicePool (Maybe Text)
- dpType :: Lens' DevicePool (Maybe DevicePoolType)
- dpDescription :: Lens' DevicePool (Maybe Text)
- data DevicePoolCompatibilityResult
- devicePoolCompatibilityResult :: DevicePoolCompatibilityResult
- dpcrDevice :: Lens' DevicePoolCompatibilityResult (Maybe Device)
- dpcrCompatible :: Lens' DevicePoolCompatibilityResult (Maybe Bool)
- dpcrIncompatibilityMessages :: Lens' DevicePoolCompatibilityResult [IncompatibilityMessage]
- data IncompatibilityMessage
- incompatibilityMessage :: IncompatibilityMessage
- imType :: Lens' IncompatibilityMessage (Maybe DeviceAttribute)
- imMessage :: Lens' IncompatibilityMessage (Maybe Text)
- data Job
- job :: Job
- jobStatus :: Lens' Job (Maybe ExecutionStatus)
- jobCounters :: Lens' Job (Maybe Counters)
- jobArn :: Lens' Job (Maybe Text)
- jobCreated :: Lens' Job (Maybe UTCTime)
- jobDevice :: Lens' Job (Maybe Device)
- jobStopped :: Lens' Job (Maybe UTCTime)
- jobResult :: Lens' Job (Maybe ExecutionResult)
- jobName :: Lens' Job (Maybe Text)
- jobType :: Lens' Job (Maybe TestType)
- jobMessage :: Lens' Job (Maybe Text)
- jobStarted :: Lens' Job (Maybe UTCTime)
- data Location
- location :: Double -> Double -> Location
- lLatitude :: Lens' Location Double
- lLongitude :: Lens' Location Double
- data Problem
- problem :: Problem
- pDevice :: Lens' Problem (Maybe Device)
- pTest :: Lens' Problem (Maybe ProblemDetail)
- pResult :: Lens' Problem (Maybe ExecutionResult)
- pRun :: Lens' Problem (Maybe ProblemDetail)
- pJob :: Lens' Problem (Maybe ProblemDetail)
- pMessage :: Lens' Problem (Maybe Text)
- pSuite :: Lens' Problem (Maybe ProblemDetail)
- data ProblemDetail
- problemDetail :: ProblemDetail
- pdArn :: Lens' ProblemDetail (Maybe Text)
- pdName :: Lens' ProblemDetail (Maybe Text)
- data Project
- project :: Project
- pArn :: Lens' Project (Maybe Text)
- pCreated :: Lens' Project (Maybe UTCTime)
- pName :: Lens' Project (Maybe Text)
- data Radios
- radios :: Radios
- rNfc :: Lens' Radios (Maybe Bool)
- rGps :: Lens' Radios (Maybe Bool)
- rBluetooth :: Lens' Radios (Maybe Bool)
- rWifi :: Lens' Radios (Maybe Bool)
- data Resolution
- resolution :: Resolution
- rHeight :: Lens' Resolution (Maybe Int)
- rWidth :: Lens' Resolution (Maybe Int)
- data Rule
- rule :: Rule
- rAttribute :: Lens' Rule (Maybe DeviceAttribute)
- rOperator :: Lens' Rule (Maybe RuleOperator)
- rValue :: Lens' Rule (Maybe Text)
- data Run
- run :: Run
- runStatus :: Lens' Run (Maybe ExecutionStatus)
- runBillingMethod :: Lens' Run (Maybe BillingMethod)
- runCounters :: Lens' Run (Maybe Counters)
- runPlatform :: Lens' Run (Maybe DevicePlatform)
- runArn :: Lens' Run (Maybe Text)
- runCreated :: Lens' Run (Maybe UTCTime)
- runCompletedJobs :: Lens' Run (Maybe Int)
- runStopped :: Lens' Run (Maybe UTCTime)
- runResult :: Lens' Run (Maybe ExecutionResult)
- runName :: Lens' Run (Maybe Text)
- runType :: Lens' Run (Maybe TestType)
- runMessage :: Lens' Run (Maybe Text)
- runTotalJobs :: Lens' Run (Maybe Int)
- runStarted :: Lens' Run (Maybe UTCTime)
- data Sample
- sample :: Sample
- sArn :: Lens' Sample (Maybe Text)
- sUrl :: Lens' Sample (Maybe Text)
- sType :: Lens' Sample (Maybe SampleType)
- data ScheduleRunConfiguration
- scheduleRunConfiguration :: ScheduleRunConfiguration
- srcBillingMethod :: Lens' ScheduleRunConfiguration (Maybe BillingMethod)
- srcRadios :: Lens' ScheduleRunConfiguration (Maybe Radios)
- srcLocation :: Lens' ScheduleRunConfiguration (Maybe Location)
- srcLocale :: Lens' ScheduleRunConfiguration (Maybe Text)
- srcNetworkProfileARN :: Lens' ScheduleRunConfiguration (Maybe Text)
- srcExtraDataPackageARN :: Lens' ScheduleRunConfiguration (Maybe Text)
- srcAuxiliaryApps :: Lens' ScheduleRunConfiguration [Text]
- data ScheduleRunTest
- scheduleRunTest :: TestType -> ScheduleRunTest
- srtTestPackageARN :: Lens' ScheduleRunTest (Maybe Text)
- srtParameters :: Lens' ScheduleRunTest (HashMap Text Text)
- srtFilter :: Lens' ScheduleRunTest (Maybe Text)
- srtType :: Lens' ScheduleRunTest TestType
- data Suite
- suite :: Suite
- suiStatus :: Lens' Suite (Maybe ExecutionStatus)
- suiCounters :: Lens' Suite (Maybe Counters)
- suiArn :: Lens' Suite (Maybe Text)
- suiCreated :: Lens' Suite (Maybe UTCTime)
- suiStopped :: Lens' Suite (Maybe UTCTime)
- suiResult :: Lens' Suite (Maybe ExecutionResult)
- suiName :: Lens' Suite (Maybe Text)
- suiType :: Lens' Suite (Maybe TestType)
- suiMessage :: Lens' Suite (Maybe Text)
- suiStarted :: Lens' Suite (Maybe UTCTime)
- data Test
- test :: Test
- tStatus :: Lens' Test (Maybe ExecutionStatus)
- tCounters :: Lens' Test (Maybe Counters)
- tArn :: Lens' Test (Maybe Text)
- tCreated :: Lens' Test (Maybe UTCTime)
- tStopped :: Lens' Test (Maybe UTCTime)
- tResult :: Lens' Test (Maybe ExecutionResult)
- tName :: Lens' Test (Maybe Text)
- tType :: Lens' Test (Maybe TestType)
- tMessage :: Lens' Test (Maybe Text)
- tStarted :: Lens' Test (Maybe UTCTime)
- data UniqueProblem
- uniqueProblem :: UniqueProblem
- upProblems :: Lens' UniqueProblem [Problem]
- upMessage :: Lens' UniqueProblem (Maybe Text)
- data Upload
- upload :: Upload
- uStatus :: Lens' Upload (Maybe UploadStatus)
- uArn :: Lens' Upload (Maybe Text)
- uCreated :: Lens' Upload (Maybe UTCTime)
- uUrl :: Lens' Upload (Maybe Text)
- uName :: Lens' Upload (Maybe Text)
- uMetadata :: Lens' Upload (Maybe Text)
- uType :: Lens' Upload (Maybe UploadType)
- uMessage :: Lens' Upload (Maybe Text)
- uContentType :: Lens' Upload (Maybe Text)
Service Configuration
API version '2015-06-23' of the Amazon Device Farm SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by DeviceFarm
.
IdempotencyException
_IdempotencyException :: AsError a => Getting (First ServiceError) a ServiceError Source
An entity with the same name already exists.
NotFoundException
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified entity was not found.
ArgumentException
_ArgumentException :: AsError a => Getting (First ServiceError) a ServiceError Source
An invalid argument was specified.
ServiceAccountException
_ServiceAccountException :: AsError a => Getting (First ServiceError) a ServiceError Source
There was a problem with the service account.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source
A limit was exceeded.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListProjects
GetDevicePoolCompatibility
ListTests
CreateUpload
ListArtifacts
GetDevicePool
GetUpload
ListDevicePools
GetTest
CreateDevicePool
ListRuns
ListJobs
GetDevice
GetJob
ScheduleRun
GetRun
ListSamples
ListSuites
GetAccountSettings
ListUploads
GetSuite
GetProject
ListDevices
ListUniqueProblems
CreateProject
Types
ArtifactCategory
data ArtifactCategory Source
ArtifactType
data ArtifactType Source
BillingMethod
data BillingMethod Source
DeviceAttribute
data DeviceAttribute Source
DeviceFormFactor
data DeviceFormFactor Source
DevicePlatform
data DevicePlatform Source
DevicePoolType
data DevicePoolType Source
ExecutionResult
data ExecutionResult Source
ExecutionStatus
data ExecutionStatus Source
RuleOperator
data RuleOperator Source
SampleType
data SampleType Source
TestType
UploadStatus
data UploadStatus Source
UploadType
data UploadType Source
AndroidApp | |
AppiumJavaJunitTestPackage | |
AppiumJavaTestngTestPackage | |
CalabashTestPackage | |
ExternalData | |
InstrumentationTestPackage | |
IosApp | |
UiautomationTestPackage | |
UiautomatorTestPackage | |
XctestTestPackage |
AccountSettings
data AccountSettings Source
A container for account-level settings within AWS Device Farm.
See: accountSettings
smart constructor.
accountSettings :: AccountSettings Source
Creates a value of AccountSettings
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asAwsAccountNumber :: Lens' AccountSettings (Maybe Text) Source
The AWS account number specified in the AccountSettings
container.
asUnmeteredDevices :: Lens' AccountSettings (HashMap DevicePlatform Int) Source
Returns the unmetered devices you have purchased.
Artifact
Represents the output of a test. Examples of artifacts include logs and screenshots.
See: artifact
smart constructor.
aUrl :: Lens' Artifact (Maybe Text) Source
The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the artifact's file.
aType :: Lens' Artifact (Maybe ArtifactType) Source
The artifact's type.
Allowed values include the following:
- APPIUM_JAVA_OUTPUT: The Appium Java output type.
- APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.
- APPIUM_SERVER_OUTPUT: The Appium server output type.
- AUTOMATION_OUTPUT: The automation output type.
- CALABASH_JSON_OUTPUT: The Calabash JSON output type.
- CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.
- CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.
- CALABASH_STANDARD_OUTPUT: The Calabash standard output type.
- DEVICE_LOG: The device log type.
- EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.
- INSTRUMENTATION_OUTPUT: The instrumentation type.
- MESSAGE_LOG: The message log type.
- RESULT_LOG: The result log type.
- SCREENSHOT: The screenshot type.
- SERVICE_LOG: The service log type.
- UNKNOWN: An unknown type.
CPU
Represents the amount of CPU that an app is using on a physical device.
Note that this does not represent system-wide CPU usage.
See: cpu
smart constructor.
Creates a value of CPU
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cpuClock :: Lens' CPU (Maybe Double) Source
The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.
Counters
Represents entity counters.
See: counters
smart constructor.
Device
Represents a device type that an app is tested against.
See: device
smart constructor.
Creates a value of Device
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dPlatform :: Lens' Device (Maybe DevicePlatform) Source
The device's platform.
Allowed values include:
- ANDROID: The Android platform.
- IOS: The iOS platform.
dFormFactor :: Lens' Device (Maybe DeviceFormFactor) Source
The device's form factor.
Allowed values include:
- PHONE: The phone form factor.
- TABLET: The tablet form factor.
dResolution :: Lens' Device (Maybe Resolution) Source
Undocumented member.
DevicePool
data DevicePool Source
Represents a collection of device types.
See: devicePool
smart constructor.
devicePool :: DevicePool Source
Creates a value of DevicePool
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dpRules :: Lens' DevicePool [Rule] Source
Information about the device pool's rules.
dpType :: Lens' DevicePool (Maybe DevicePoolType) Source
The device pool's type.
Allowed values include:
- CURATED: A device pool that is created and managed by AWS Device Farm.
- PRIVATE: A device pool that is created and managed by the device pool developer.
dpDescription :: Lens' DevicePool (Maybe Text) Source
The device pool's description.
DevicePoolCompatibilityResult
data DevicePoolCompatibilityResult Source
Represents a device pool compatibility result.
See: devicePoolCompatibilityResult
smart constructor.
devicePoolCompatibilityResult :: DevicePoolCompatibilityResult Source
Creates a value of DevicePoolCompatibilityResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dpcrDevice :: Lens' DevicePoolCompatibilityResult (Maybe Device) Source
Undocumented member.
dpcrCompatible :: Lens' DevicePoolCompatibilityResult (Maybe Bool) Source
Whether the result was compatible with the device pool.
dpcrIncompatibilityMessages :: Lens' DevicePoolCompatibilityResult [IncompatibilityMessage] Source
Information about the compatibility.
IncompatibilityMessage
data IncompatibilityMessage Source
Represents information about incompatibility.
See: incompatibilityMessage
smart constructor.
incompatibilityMessage :: IncompatibilityMessage Source
Creates a value of IncompatibilityMessage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
imType :: Lens' IncompatibilityMessage (Maybe DeviceAttribute) Source
The type of incompatibility.
Allowed values include:
- ARN: The ARN.
- FORM_FACTOR: The form factor (for example, phone or tablet).
- MANUFACTURER: The manufacturer.
- PLATFORM: The platform (for example, Android or iOS).
Job
Represents a device.
See: job
smart constructor.
Creates a value of Job
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jobStatus :: Lens' Job (Maybe ExecutionStatus) Source
The job's status.
Allowed values include:
- COMPLETED: A completed status.
- PENDING: A pending status.
- PROCESSING: A processing status.
- RUNNING: A running status.
- SCHEDULING: A scheduling status.
jobResult :: Lens' Job (Maybe ExecutionResult) Source
The job's result.
Allowed values include:
- ERRORED: An error condition.
- FAILED: A failed condition.
- SKIPPED: A skipped condition.
- STOPPED: A stopped condition.
- PASSED: A passing condition.
- PENDING: A pending condition.
- WARNED: A warning condition.
jobType :: Lens' Job (Maybe TestType) Source
The job's type.
Allowed values include the following:
- BUILTIN_FUZZ: The built-in fuzz type.
- BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
- APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
- APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
- CALABASH: The Calabash type.
- INSTRUMENTATION: The Instrumentation type.
- UIAUTOMATION: The uiautomation type.
- UIAUTOMATOR: The uiautomator type.
- XCTEST: The XCode test type.
Location
Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example 47.6204, -122.3491).
Elevation is currently not supported.
See: location
smart constructor.
Creates a value of Location
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lLongitude :: Lens' Location Double Source
The longitude.
Problem
Represents a specific warning or failure.
See: problem
smart constructor.
pResult :: Lens' Problem (Maybe ExecutionResult) Source
The problem's result.
Allowed values include:
- ERRORED: An error condition.
- FAILED: A failed condition.
- SKIPPED: A skipped condition.
- STOPPED: A stopped condition.
- PASSED: A passing condition.
- PENDING: A pending condition.
- WARNED: A warning condition.
ProblemDetail
data ProblemDetail Source
Information about a problem detail.
See: problemDetail
smart constructor.
problemDetail :: ProblemDetail Source
Creates a value of ProblemDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Project
Represents an operating-system neutral workspace for running and managing tests.
See: project
smart constructor.
Radios
Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.
See: radios
smart constructor.
Creates a value of Radios
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rNfc :: Lens' Radios (Maybe Bool) Source
True if NFC is enabled at the beginning of the test; otherwise, false.
rGps :: Lens' Radios (Maybe Bool) Source
True if GPS is enabled at the beginning of the test; otherwise, false.
rBluetooth :: Lens' Radios (Maybe Bool) Source
True if Bluetooth is enabled at the beginning of the test; otherwise, false.
rWifi :: Lens' Radios (Maybe Bool) Source
True if Wi-Fi is enabled at the beginning of the test; otherwise, false.
Resolution
data Resolution Source
Represents the screen resolution of a device in height and width, expressed in pixels.
See: resolution
smart constructor.
resolution :: Resolution Source
Creates a value of Resolution
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Rule
Represents a condition for a device pool.
See: rule
smart constructor.
Creates a value of Rule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rAttribute :: Lens' Rule (Maybe DeviceAttribute) Source
The rule's attribute.
Allowed values include:
- ARN: The ARN.
- FORM_FACTOR: The form factor (for example, phone or tablet).
- MANUFACTURER: The manufacturer.
- PLATFORM: The platform (for example, Android or iOS).
rOperator :: Lens' Rule (Maybe RuleOperator) Source
The rule's operator.
- EQUALS: The equals operator.
- GREATER_THAN: The greater-than operator.
- IN: The in operator.
- LESS_THAN: The less-than operator.
- NOT_IN: The not-in operator.
Run
Represents an app on a set of devices with a specific test and configuration.
See: run
smart constructor.
Creates a value of Run
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
runStatus :: Lens' Run (Maybe ExecutionStatus) Source
The run's status.
Allowed values include:
- COMPLETED: A completed status.
- PENDING: A pending status.
- PROCESSING: A processing status.
- RUNNING: A running status.
- SCHEDULING: A scheduling status.
runBillingMethod :: Lens' Run (Maybe BillingMethod) Source
Specifies the billing method for a test run: metered
or unmetered
.
If the parameter is not specified, the default value is unmetered
.
runPlatform :: Lens' Run (Maybe DevicePlatform) Source
The run's platform.
Allowed values include:
- ANDROID: The Android platform.
- IOS: The iOS platform.
runResult :: Lens' Run (Maybe ExecutionResult) Source
The run's result.
Allowed values include:
- ERRORED: An error condition.
- FAILED: A failed condition.
- SKIPPED: A skipped condition.
- STOPPED: A stopped condition.
- PASSED: A passing condition.
- PENDING: A pending condition.
- WARNED: A warning condition.
runType :: Lens' Run (Maybe TestType) Source
The run's type.
Must be one of the following values:
- BUILTIN_FUZZ: The built-in fuzz type.
- BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
- APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
- APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
- CALABASH: The Calabash type.
- INSTRUMENTATION: The Instrumentation type.
- UIAUTOMATION: The uiautomation type.
- UIAUTOMATOR: The uiautomator type.
- XCTEST: The XCode test type.
Sample
Represents a sample of performance data.
See: sample
smart constructor.
sUrl :: Lens' Sample (Maybe Text) Source
The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the sample's file.
sType :: Lens' Sample (Maybe SampleType) Source
The sample's type.
Must be one of the following values:
- CPU: A CPU sample type. This is expressed as the app processing CPU time (including child processes) as reported by process, as a percentage.
- MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app process, in kilobytes.
- NATIVE_AVG_DRAWTIME
- NATIVE_FPS
- NATIVE_FRAMES
- NATIVE_MAX_DRAWTIME
- NATIVE_MIN_DRAWTIME
- OPENGL_AVG_DRAWTIME
- OPENGL_FPS
- OPENGL_FRAMES
- OPENGL_MAX_DRAWTIME
- OPENGL_MIN_DRAWTIME
- RX
- RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, by app process.
- THREADS: A threads sample type. This is expressed as the total number of threads per app process.
- TX
- TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process.
ScheduleRunConfiguration
data ScheduleRunConfiguration Source
Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles.
See: scheduleRunConfiguration
smart constructor.
scheduleRunConfiguration :: ScheduleRunConfiguration Source
Creates a value of ScheduleRunConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srcBillingMethod :: Lens' ScheduleRunConfiguration (Maybe BillingMethod) Source
Specifies the billing method for a test run: metered
or unmetered
.
If the parameter is not specified, the default value is unmetered
.
srcRadios :: Lens' ScheduleRunConfiguration (Maybe Radios) Source
Information about the radio states for the run.
srcLocation :: Lens' ScheduleRunConfiguration (Maybe Location) Source
Information about the location that is used for the run.
srcLocale :: Lens' ScheduleRunConfiguration (Maybe Text) Source
Information about the locale that is used for the run.
srcNetworkProfileARN :: Lens' ScheduleRunConfiguration (Maybe Text) Source
Reserved for internal use.
srcExtraDataPackageARN :: Lens' ScheduleRunConfiguration (Maybe Text) Source
The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app's sandbox for iOS.
srcAuxiliaryApps :: Lens' ScheduleRunConfiguration [Text] Source
A list of auxiliary apps for the run.
ScheduleRunTest
data ScheduleRunTest Source
Represents additional test settings.
See: scheduleRunTest
smart constructor.
Creates a value of ScheduleRunTest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srtTestPackageARN :: Lens' ScheduleRunTest (Maybe Text) Source
The ARN of the uploaded test that will be run.
srtParameters :: Lens' ScheduleRunTest (HashMap Text Text) Source
The test's parameters, such as test framework parameters and fixture settings.
srtType :: Lens' ScheduleRunTest TestType Source
The test's type.
Must be one of the following values:
- BUILTIN_FUZZ: The built-in fuzz type.
- BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
- APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
- APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
- CALABASH: The Calabash type.
- INSTRUMENTATION: The Instrumentation type.
- UIAUTOMATION: The uiautomation type.
- UIAUTOMATOR: The uiautomator type.
- XCTEST: The XCode test type.
Suite
Represents a collection of one or more tests.
See: suite
smart constructor.
Creates a value of Suite
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
suiStatus :: Lens' Suite (Maybe ExecutionStatus) Source
The suite's status.
Allowed values include:
- COMPLETED: A completed status.
- PENDING: A pending status.
- PROCESSING: A processing status.
- RUNNING: A running status.
- SCHEDULING: A scheduling status.
suiResult :: Lens' Suite (Maybe ExecutionResult) Source
The suite's result.
Allowed values include:
- ERRORED: An error condition.
- FAILED: A failed condition.
- SKIPPED: A skipped condition.
- STOPPED: A stopped condition.
- PASSED: A passing condition.
- PENDING: A pending condition.
- WARNED: A warning condition.
suiType :: Lens' Suite (Maybe TestType) Source
The suite's type.
Must be one of the following values:
- BUILTIN_FUZZ: The built-in fuzz type.
- BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
- APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
- APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
- CALABASH: The Calabash type.
- INSTRUMENTATION: The Instrumentation type.
- UIAUTOMATION: The uiautomation type.
- UIAUTOMATOR: The uiautomator type.
- XCTEST: The XCode test type.
Test
Represents a condition that is evaluated.
See: test
smart constructor.
tStatus :: Lens' Test (Maybe ExecutionStatus) Source
The test's status.
Allowed values include:
- COMPLETED: A completed status.
- PENDING: A pending status.
- PROCESSING: A processing status.
- RUNNING: A running status.
- SCHEDULING: A scheduling status.
tResult :: Lens' Test (Maybe ExecutionResult) Source
The test's result.
Allowed values include:
- ERRORED: An error condition.
- FAILED: A failed condition.
- SKIPPED: A skipped condition.
- STOPPED: A stopped condition.
- PASSED: A passing condition.
- PENDING: A pending condition.
- WARNED: A warning condition.
tType :: Lens' Test (Maybe TestType) Source
The test's type.
Must be one of the following values:
- BUILTIN_FUZZ: The built-in fuzz type.
- BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
- APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
- APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
- CALABASH: The Calabash type.
- INSTRUMENTATION: The Instrumentation type.
- UIAUTOMATION: The uiautomation type.
- UIAUTOMATOR: The uiautomator type.
- XCTEST: The XCode test type.
UniqueProblem
data UniqueProblem Source
A collection of one or more problems, grouped by their result.
See: uniqueProblem
smart constructor.
uniqueProblem :: UniqueProblem Source
Creates a value of UniqueProblem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
upProblems :: Lens' UniqueProblem [Problem] Source
Information about the problems.
Upload
An app or a set of one or more tests to upload or that have been uploaded.
See: upload
smart constructor.
uStatus :: Lens' Upload (Maybe UploadStatus) Source
The upload's status.
Must be one of the following values:
- FAILED: A failed status.
- INITIALIZED: An initialized status.
- PROCESSING: A processing status.
- SUCCEEDED: A succeeded status.
uUrl :: Lens' Upload (Maybe Text) Source
The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.
uMetadata :: Lens' Upload (Maybe Text) Source
The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.
uType :: Lens' Upload (Maybe UploadType) Source
The upload's type.
Must be one of the following values:
- ANDROID_APP: An Android upload.
- IOS_APP: An iOS upload.
- EXTERNAL_DATA: An external data upload.
- APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
- APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
- CALABASH_TEST_PACKAGE: A Calabash test package upload.
- INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
- UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
- XCTEST_TEST_PACKAGE: An XCode test package upload.