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.
", "operations": { "CreateDevicePool": "Creates a device pool.
", "CreateNetworkProfile": "Creates a network profile.
", "CreateProject": "Creates a new project.
", "CreateRemoteAccessSession": "Specifies and starts a remote access session.
", "CreateUpload": "Uploads an app or test scripts.
", "DeleteDevicePool": "Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
", "DeleteNetworkProfile": "Deletes a network profile.
", "DeleteProject": "Deletes an AWS Device Farm project, given the project ARN.
Note Deleting this resource does not stop an in-progress run.
", "DeleteRemoteAccessSession": "Deletes a completed remote access session and its results.
", "DeleteRun": "Deletes the run, given the run ARN.
Note Deleting this resource does not stop an in-progress run.
", "DeleteUpload": "Deletes an upload given the upload ARN.
", "GetAccountSettings": "Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.
", "GetDevice": "Gets information about a unique device type.
", "GetDevicePool": "Gets information about a device pool.
", "GetDevicePoolCompatibility": "Gets information about compatibility with a device pool.
", "GetJob": "Gets information about a job.
", "GetNetworkProfile": "Returns information about a network profile.
", "GetOfferingStatus": "Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Gets information about a project.
", "GetRemoteAccessSession": "Returns a link to a currently running remote access session.
", "GetRun": "Gets information about a run.
", "GetSuite": "Gets information about a suite.
", "GetTest": "Gets information about a test.
", "GetUpload": "Gets information about an upload.
", "InstallToRemoteAccessSession": "Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.
", "ListArtifacts": "Gets information about artifacts.
", "ListDevicePools": "Gets information about device pools.
", "ListDevices": "Gets information about unique device types.
", "ListJobs": "Gets information about jobs.
", "ListNetworkProfiles": "Returns the list of available network profiles.
", "ListOfferingPromotions": "Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Gets information about projects.
", "ListRemoteAccessSessions": "Returns a list of all currently running remote access sessions.
", "ListRuns": "Gets information about runs, given an AWS Device Farm project ARN.
", "ListSamples": "Gets information about samples, given an AWS Device Farm project ARN
", "ListSuites": "Gets information about suites.
", "ListTests": "Gets information about tests.
", "ListUniqueProblems": "Gets information about unique problems.
", "ListUploads": "Gets information about uploads, given an AWS Device Farm project ARN.
", "PurchaseOffering": "Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Schedules a run.
", "StopRemoteAccessSession": "Ends a specified remote access session.
", "StopRun": "Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
", "UpdateDevicePool": "Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).
", "UpdateNetworkProfile": "Updates the network profile with specific settings.
", "UpdateProject": "Modifies the specified project name, given the project ARN and a new name.
" }, "shapes": { "AWSAccountNumber": { "base": null, "refs": { "AccountSettings$awsAccountNumber": "The AWS account number specified in the AccountSettings container.
A container for account-level settings within AWS Device Farm.
", "refs": { "GetAccountSettingsResult$accountSettings": "The account settings.
" } }, "AccountsCleanup": { "base": null, "refs": { "ExecutionConfiguration$accountsCleanup": "True if account cleanup is enabled at the beginning of the test; otherwise, false.
" } }, "AmazonResourceName": { "base": null, "refs": { "AmazonResourceNames$member": null, "Artifact$arn": "The artifact's ARN.
", "CreateDevicePoolRequest$projectArn": "The ARN of the project for the device pool.
", "CreateNetworkProfileRequest$projectArn": "The Amazon Resource Name (ARN) of the project for which you want to create a network profile.
", "CreateRemoteAccessSessionRequest$projectArn": "The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
", "CreateRemoteAccessSessionRequest$deviceArn": "The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.
", "CreateUploadRequest$projectArn": "The ARN of the project for the upload.
", "DeleteDevicePoolRequest$arn": "Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete.
", "DeleteNetworkProfileRequest$arn": "The Amazon Resource Name (ARN) of the network profile you want to delete.
", "DeleteProjectRequest$arn": "Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete.
", "DeleteRemoteAccessSessionRequest$arn": "The Amazon Resource Name (ARN) of the sesssion for which you want to delete remote access.
", "DeleteRunRequest$arn": "The Amazon Resource Name (ARN) for the run you wish to delete.
", "DeleteUploadRequest$arn": "Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete.
", "Device$arn": "The device's ARN.
", "DevicePool$arn": "The device pool's ARN.
", "GetDevicePoolCompatibilityRequest$devicePoolArn": "The device pool's ARN.
", "GetDevicePoolCompatibilityRequest$appArn": "The ARN of the app that is associated with the specified device pool.
", "GetDevicePoolRequest$arn": "The device pool's ARN.
", "GetDeviceRequest$arn": "The device type's ARN.
", "GetJobRequest$arn": "The job's ARN.
", "GetNetworkProfileRequest$arn": "The Amazon Resource Name (ARN) of the network profile you want to return information about.
", "GetProjectRequest$arn": "The project's ARN.
", "GetRemoteAccessSessionRequest$arn": "The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.
", "GetRunRequest$arn": "The run's ARN.
", "GetSuiteRequest$arn": "The suite's ARN.
", "GetTestRequest$arn": "The test's ARN.
", "GetUploadRequest$arn": "The upload's ARN.
", "InstallToRemoteAccessSessionRequest$remoteAccessSessionArn": "The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.
", "InstallToRemoteAccessSessionRequest$appArn": "The Amazon Resource Name (ARN) of the app about which you are requesting information.
", "Job$arn": "The job's ARN.
", "ListArtifactsRequest$arn": "The Run, Job, Suite, or Test ARN.
", "ListDevicePoolsRequest$arn": "The project ARN.
", "ListDevicesRequest$arn": "The Amazon Resource Name (ARN) of the project.
", "ListJobsRequest$arn": "The jobs' ARNs.
", "ListNetworkProfilesRequest$arn": "The Amazon Resource Name (ARN) of the project for which you want to list network profiles.
", "ListProjectsRequest$arn": "Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.
", "ListRemoteAccessSessionsRequest$arn": "The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.
", "ListRunsRequest$arn": "The Amazon Resource Name (ARN) of the project for which you want to list runs.
", "ListSamplesRequest$arn": "The Amazon Resource Name (ARN) of the project for which you want to list samples.
", "ListSuitesRequest$arn": "The suites' ARNs.
", "ListTestsRequest$arn": "The tests' ARNs.
", "ListUniqueProblemsRequest$arn": "The unique problems' ARNs.
", "ListUploadsRequest$arn": "The Amazon Resource Name (ARN) of the project for which you want to list uploads.
", "NetworkProfile$arn": "The Amazon Resource Name (ARN) of the network profile.
", "ProblemDetail$arn": "The problem detail's ARN.
", "Project$arn": "The project's ARN.
", "RemoteAccessSession$arn": "The Amazon Resource Name (ARN) of the remote access session.
", "Run$arn": "The run's ARN.
", "Sample$arn": "The sample's ARN.
", "ScheduleRunConfiguration$extraDataPackageArn": "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.
", "ScheduleRunConfiguration$networkProfileArn": "Reserved for internal use.
", "ScheduleRunRequest$projectArn": "The ARN of the project for the run to be scheduled.
", "ScheduleRunRequest$appArn": "The ARN of the app to schedule a run.
", "ScheduleRunRequest$devicePoolArn": "The ARN of the device pool for the run to be scheduled.
", "ScheduleRunTest$testPackageArn": "The ARN of the uploaded test that will be run.
", "StopRemoteAccessSessionRequest$arn": "The Amazon Resource Name (ARN) of the remote access session you wish to stop.
", "StopRunRequest$arn": "Represents the Amazon Resource Name (ARN) of the Device Farm run you wish to stop.
", "Suite$arn": "The suite's ARN.
", "Test$arn": "The test's ARN.
", "UpdateDevicePoolRequest$arn": "The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.
", "UpdateNetworkProfileRequest$arn": "The Amazon Resource Name (ARN) of the project that you wish to update network profile settings.
", "UpdateProjectRequest$arn": "The Amazon Resource Name (ARN) of the project whose name you wish to update.
", "Upload$arn": "The upload's ARN.
" } }, "AmazonResourceNames": { "base": null, "refs": { "ScheduleRunConfiguration$auxiliaryApps": "A list of auxiliary apps for the run.
" } }, "AndroidPaths": { "base": null, "refs": { "CustomerArtifactPaths$androidPaths": "Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests will be pulled from.
" } }, "AppPackagesCleanup": { "base": null, "refs": { "ExecutionConfiguration$appPackagesCleanup": "True if app package cleanup is enabled at the beginning of the test; otherwise, false.
" } }, "ArgumentException": { "base": "An invalid argument was specified.
", "refs": { } }, "Artifact": { "base": "Represents the output of a test. Examples of artifacts include logs and screenshots.
", "refs": { "Artifacts$member": null } }, "ArtifactCategory": { "base": null, "refs": { "ListArtifactsRequest$type": "The artifacts' type.
Allowed values include:
FILE: The artifacts are files.
LOG: The artifacts are logs.
SCREENSHOT: The artifacts are screenshots.
The artifact's type.
Allowed values include the following:
UNKNOWN: An unknown type.
SCREENSHOT: The screenshot type.
DEVICE_LOG: The device log type.
MESSAGE_LOG: The message log type.
RESULT_LOG: The result log type.
SERVICE_LOG: The service log type.
WEBKIT_LOG: The web kit log type.
INSTRUMENTATION_OUTPUT: The instrumentation type.
EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.
CALABASH_JSON_OUTPUT: The Calabash JSON output type.
CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.
CALABASH_STANDARD_OUTPUT: The Calabash standard output type.
CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.
AUTOMATION_OUTPUT: The automation output type.
APPIUM_SERVER_OUTPUT: The Appium server output type.
APPIUM_JAVA_OUTPUT: The Appium Java output type.
APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.
APPIUM_PYTHON_OUTPUT: The Appium Python output type.
APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.
EXPLORER_EVENT_LOG: The Explorer event log output type.
EXPLORER_SUMMARY_LOG: The Explorer summary log output type.
APPLICATION_CRASH_REPORT: The application crash report output type.
XCTEST_LOG: The XCode test output type.
Information about the artifacts.
" } }, "BillingMethod": { "base": null, "refs": { "CreateRemoteAccessSessionConfiguration$billingMethod": "Returns the billing method for purposes of configuring a remote access session.
", "RemoteAccessSession$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.\"
Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.
Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.
Set to true if you want to access devices remotely for debugging in your remote access session.
Specifies whether remote access has been enabled for the specified device.
", "Device$remoteDebugEnabled": "This flag is set to true if remote debugging is enabled for the device.
Whether the result was compatible with the device pool.
", "Radios$wifi": "True if Wi-Fi is enabled at the beginning of the test; otherwise, false.
", "Radios$bluetooth": "True if Bluetooth is enabled at the beginning of the test; otherwise, false.
", "Radios$nfc": "True if NFC is enabled at the beginning of the test; otherwise, false.
", "Radios$gps": "True if GPS is enabled at the beginning of the test; otherwise, false.
", "RemoteAccessSession$remoteDebugEnabled": "This flag is set to true if remote debugging is enabled for the remote access session.
Represents the amount of CPU that an app is using on a physical device.
Note that this does not represent system-wide CPU usage.
", "refs": { "Device$cpu": "Information about the device's CPU.
" } }, "ClientId": { "base": null, "refs": { "CreateRemoteAccessSessionRequest$clientId": "Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId value in each call to CreateRemoteAccessSession. This is required only if remoteDebugEnabled is set to true true.
Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.
" } }, "ContentType": { "base": null, "refs": { "CreateUploadRequest$contentType": "The upload's content type (for example, \"application/octet-stream\").
", "Upload$contentType": "The upload's content type (for example, \"application/octet-stream\").
" } }, "Counters": { "base": "Represents entity counters.
", "refs": { "Job$counters": "The job's result counters.
", "Run$counters": "The run's result counters.
", "Suite$counters": "The suite's result counters.
", "Test$counters": "The test's result counters.
" } }, "CreateDevicePoolRequest": { "base": "Represents a request to the create device pool operation.
", "refs": { } }, "CreateDevicePoolResult": { "base": "Represents the result of a create device pool request.
", "refs": { } }, "CreateNetworkProfileRequest": { "base": null, "refs": { } }, "CreateNetworkProfileResult": { "base": null, "refs": { } }, "CreateProjectRequest": { "base": "Represents a request to the create project operation.
", "refs": { } }, "CreateProjectResult": { "base": "Represents the result of a create project request.
", "refs": { } }, "CreateRemoteAccessSessionConfiguration": { "base": "Creates the configuration settings for a remote access session, including the device model and type.
", "refs": { "CreateRemoteAccessSessionRequest$configuration": "The configuration information for the remote access session request.
" } }, "CreateRemoteAccessSessionRequest": { "base": "Creates and submits a request to start a remote access session.
", "refs": { } }, "CreateRemoteAccessSessionResult": { "base": "Represents the server response from a request to create a remote access session.
", "refs": { } }, "CreateUploadRequest": { "base": "Represents a request to the create upload operation.
", "refs": { } }, "CreateUploadResult": { "base": "Represents the result of a create upload request.
", "refs": { } }, "CurrencyCode": { "base": null, "refs": { "MonetaryAmount$currencyCode": "The currency code of a monetary amount. For example, USD means \"U.S. dollars.\"
A JSON object specifying the paths where the artifacts generated by the customer's tests, on the device or in the test environment, will be pulled from.
Specify deviceHostPaths and optionally specify either iosPaths or androidPaths.
For web app tests, you can specify both iosPaths and androidPaths.
Output CustomerArtifactPaths object for the test run.
Input CustomerArtifactPaths object for the scheduled run configuration.
When the job was created.
", "Job$started": "The job's start time.
", "Job$stopped": "The job's stop time.
", "OfferingStatus$effectiveOn": "The date on which the offering is effective.
", "OfferingTransaction$createdOn": "The date on which an offering transaction was created.
", "Project$created": "When the project was created.
", "RemoteAccessSession$created": "The date and time the remote access session was created.
", "RemoteAccessSession$started": "The date and time the remote access session was started.
", "RemoteAccessSession$stopped": "The date and time the remote access session was stopped.
", "Run$created": "When the run was created.
", "Run$started": "The run's start time.
", "Run$stopped": "The run's stop time.
", "Suite$created": "When the suite was created.
", "Suite$started": "The suite's start time.
", "Suite$stopped": "The suite's stop time.
", "Test$created": "When the test was created.
", "Test$started": "The test's start time.
", "Test$stopped": "The test's stop time.
", "Upload$created": "When the upload was created.
" } }, "DeleteDevicePoolRequest": { "base": "Represents a request to the delete device pool operation.
", "refs": { } }, "DeleteDevicePoolResult": { "base": "Represents the result of a delete device pool request.
", "refs": { } }, "DeleteNetworkProfileRequest": { "base": null, "refs": { } }, "DeleteNetworkProfileResult": { "base": null, "refs": { } }, "DeleteProjectRequest": { "base": "Represents a request to the delete project operation.
", "refs": { } }, "DeleteProjectResult": { "base": "Represents the result of a delete project request.
", "refs": { } }, "DeleteRemoteAccessSessionRequest": { "base": "Represents the request to delete the specified remote access session.
", "refs": { } }, "DeleteRemoteAccessSessionResult": { "base": "The response from the server when a request is made to delete the remote access session.
", "refs": { } }, "DeleteRunRequest": { "base": "Represents a request to the delete run operation.
", "refs": { } }, "DeleteRunResult": { "base": "Represents the result of a delete run request.
", "refs": { } }, "DeleteUploadRequest": { "base": "Represents a request to the delete upload operation.
", "refs": { } }, "DeleteUploadResult": { "base": "Represents the result of a delete upload request.
", "refs": { } }, "Device": { "base": "Represents a device type that an app is tested against.
", "refs": { "DevicePoolCompatibilityResult$device": "The device (phone or tablet) that you wish to return information about.
", "Devices$member": null, "GetDeviceResult$device": "An object containing information about the requested device.
", "Job$device": "The device (phone or tablet).
", "Problem$device": "Information about the associated device.
", "RemoteAccessSession$device": "The device (phone or tablet) used in the remote access session.
" } }, "DeviceAttribute": { "base": null, "refs": { "IncompatibilityMessage$type": "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).
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
APPIUM_VERSION: The Appium version for the test.
The rule's stringified attribute. For example, specify the value as \"\\\"abc\\\"\".
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).
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
APPIUM_VERSION: The Appium version for the test.
The device's form factor.
Allowed values include:
PHONE: The phone form factor.
TABLET: The tablet form factor.
Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests will be pulled from.
" } }, "DeviceMinutes": { "base": "Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.
", "refs": { "Job$deviceMinutes": "Represents the total (metered or unmetered) minutes used by the job.
", "RemoteAccessSession$deviceMinutes": "The number of minutes a device is used in a remote access sesssion (including setup and teardown minutes).
", "Run$deviceMinutes": "Represents the total (metered or unmetered) minutes used by the test run.
", "Suite$deviceMinutes": "Represents the total (metered or unmetered) minutes used by the test suite.
", "Test$deviceMinutes": "Represents the total (metered or unmetered) minutes used by the test.
" } }, "DevicePlatform": { "base": null, "refs": { "Device$platform": "The device's platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
The platform of the device (e.g., ANDROID or IOS).
", "PurchasedDevicesMap$key": null, "Run$platform": "The run's platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
Represents a collection of device types.
", "refs": { "CreateDevicePoolResult$devicePool": "The newly created device pool.
", "DevicePools$member": null, "GetDevicePoolResult$devicePool": "An object containing information about the requested device pool.
", "UpdateDevicePoolResult$devicePool": "The device pool you just updated.
" } }, "DevicePoolCompatibilityResult": { "base": "Represents a device pool compatibility result.
", "refs": { "DevicePoolCompatibilityResults$member": null } }, "DevicePoolCompatibilityResults": { "base": null, "refs": { "GetDevicePoolCompatibilityResult$compatibleDevices": "Information about compatible devices.
", "GetDevicePoolCompatibilityResult$incompatibleDevices": "Information about incompatible devices.
" } }, "DevicePoolType": { "base": null, "refs": { "DevicePool$type": "The device pool's type.
Allowed values include:
CURATED: A device pool that is created and managed by AWS Device Farm.
PRIVATE: A device pool that is created and managed by the device pool developer.
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.
Information about the device pools.
" } }, "Devices": { "base": null, "refs": { "ListDevicesResult$devices": "Information about the devices.
" } }, "Double": { "base": null, "refs": { "CPU$clock": "The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.
", "DeviceMinutes$total": "When specified, represents the total minutes used by the resource to run tests.
", "DeviceMinutes$metered": "When specified, represents only the sum of metered minutes used by the resource to run tests.
", "DeviceMinutes$unmetered": "When specified, represents only the sum of unmetered minutes used by the resource to run tests.
", "Location$latitude": "The latitude.
", "Location$longitude": "The longitude.
", "MonetaryAmount$amount": "The numerical amount of an offering or transaction.
", "TrialMinutes$total": "The total number of free trial minutes that the account started with.
", "TrialMinutes$remaining": "The number of free trial minutes remaining in the account.
" } }, "ExecutionConfiguration": { "base": "Represents configuration information about a test run, such as the execution timeout (in minutes).
", "refs": { "ScheduleRunRequest$executionConfiguration": "Specifies configuration information about a test run, such as the execution timeout (in minutes).
" } }, "ExecutionResult": { "base": null, "refs": { "Job$result": "The job's result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
The problem's result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
The result of the remote access session. Can be any of the following:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
The run's result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
The suite's result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
The test's result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
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.
The job's status.
Allowed values include:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
The status of the remote access session. Can be any of the following:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
The run's status.
Allowed values include:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
The suite's status.
Allowed values include:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
The test's status.
Allowed values include:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
The test's filter.
" } }, "GetAccountSettingsRequest": { "base": "Represents the request sent to retrieve the account settings.
", "refs": { } }, "GetAccountSettingsResult": { "base": "Represents the account settings return values from the GetAccountSettings request.
Represents a request to the get device pool compatibility operation.
", "refs": { } }, "GetDevicePoolCompatibilityResult": { "base": "Represents the result of describe device pool compatibility request.
", "refs": { } }, "GetDevicePoolRequest": { "base": "Represents a request to the get device pool operation.
", "refs": { } }, "GetDevicePoolResult": { "base": "Represents the result of a get device pool request.
", "refs": { } }, "GetDeviceRequest": { "base": "Represents a request to the get device request.
", "refs": { } }, "GetDeviceResult": { "base": "Represents the result of a get device request.
", "refs": { } }, "GetJobRequest": { "base": "Represents a request to the get job operation.
", "refs": { } }, "GetJobResult": { "base": "Represents the result of a get job request.
", "refs": { } }, "GetNetworkProfileRequest": { "base": null, "refs": { } }, "GetNetworkProfileResult": { "base": null, "refs": { } }, "GetOfferingStatusRequest": { "base": "Represents the request to retrieve the offering status for the specified customer or account.
", "refs": { } }, "GetOfferingStatusResult": { "base": "Returns the status result for a device offering.
", "refs": { } }, "GetProjectRequest": { "base": "Represents a request to the get project operation.
", "refs": { } }, "GetProjectResult": { "base": "Represents the result of a get project request.
", "refs": { } }, "GetRemoteAccessSessionRequest": { "base": "Represents the request to get information about the specified remote access session.
", "refs": { } }, "GetRemoteAccessSessionResult": { "base": "Represents the response from the server that lists detailed information about the remote access session.
", "refs": { } }, "GetRunRequest": { "base": "Represents a request to the get run operation.
", "refs": { } }, "GetRunResult": { "base": "Represents the result of a get run request.
", "refs": { } }, "GetSuiteRequest": { "base": "Represents a request to the get suite operation.
", "refs": { } }, "GetSuiteResult": { "base": "Represents the result of a get suite request.
", "refs": { } }, "GetTestRequest": { "base": "Represents a request to the get test operation.
", "refs": { } }, "GetTestResult": { "base": "Represents the result of a get test request.
", "refs": { } }, "GetUploadRequest": { "base": "Represents a request to the get upload operation.
", "refs": { } }, "GetUploadResult": { "base": "Represents the result of a get upload request.
", "refs": { } }, "HostAddress": { "base": null, "refs": { "RemoteAccessSession$hostAddress": "IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.
" } }, "IdempotencyException": { "base": "An entity with the same name already exists.
", "refs": { } }, "IncompatibilityMessage": { "base": "Represents information about incompatibility.
", "refs": { "IncompatibilityMessages$member": null } }, "IncompatibilityMessages": { "base": null, "refs": { "DevicePoolCompatibilityResult$incompatibilityMessages": "Information about the compatibility.
" } }, "InstallToRemoteAccessSessionRequest": { "base": "Represents the request to install an Android application (in .apk format) or an iOS application (in .ipa format) as part of a remote access session.
", "refs": { } }, "InstallToRemoteAccessSessionResult": { "base": "Represents the response from the server after AWS Device Farm makes a request to install to a remote access session.
", "refs": { } }, "Integer": { "base": null, "refs": { "Counters$total": "The total number of entities.
", "Counters$passed": "The number of passed entities.
", "Counters$failed": "The number of failed entities.
", "Counters$warned": "The number of warned entities.
", "Counters$errored": "The number of errored entities.
", "Counters$stopped": "The number of stopped entities.
", "Counters$skipped": "The number of skipped entities.
", "MaxSlotMap$value": null, "OfferingStatus$quantity": "The number of available devices in the offering.
", "PurchaseOfferingRequest$quantity": "The number of device slots you wish to purchase in an offering request.
", "PurchasedDevicesMap$value": null, "RenewOfferingRequest$quantity": "The quantity requested in an offering renewal.
", "Resolution$width": "The screen resolution's width, expressed in pixels.
", "Resolution$height": "The screen resolution's height, expressed in pixels.
", "Run$totalJobs": "The total number of jobs for the run.
", "Run$completedJobs": "The total number of completed jobs.
" } }, "IosPaths": { "base": null, "refs": { "CustomerArtifactPaths$iosPaths": "Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests will be pulled from.
" } }, "Job": { "base": "Represents a device.
", "refs": { "GetJobResult$job": "An object containing information about the requested job.
", "Jobs$member": null } }, "JobTimeoutMinutes": { "base": null, "refs": { "AccountSettings$maxJobTimeoutMinutes": "The maximum number of minutes a test run will execute before it times out.
", "AccountSettings$defaultJobTimeoutMinutes": "The default number of minutes (at the account level) a test run will execute before it times out. Default value is 60 minutes.
", "CreateProjectRequest$defaultJobTimeoutMinutes": "Sets the execution timeout value (in minutes) for a project. All test runs in this project will use the specified execution timeout value unless overridden when scheduling a run.
", "ExecutionConfiguration$jobTimeoutMinutes": "The number of minutes a test run will execute before it times out.
", "Project$defaultJobTimeoutMinutes": "The default number of minutes (at the project level) a test run will execute before it times out. Default value is 60 minutes.
", "UpdateProjectRequest$defaultJobTimeoutMinutes": "The number of minutes a test run in the project will execute before it times out.
" } }, "Jobs": { "base": null, "refs": { "ListJobsResult$jobs": "Information about the jobs.
" } }, "LimitExceededException": { "base": "A limit was exceeded.
", "refs": { } }, "ListArtifactsRequest": { "base": "Represents a request to the list artifacts operation.
", "refs": { } }, "ListArtifactsResult": { "base": "Represents the result of a list artifacts operation.
", "refs": { } }, "ListDevicePoolsRequest": { "base": "Represents the result of a list device pools request.
", "refs": { } }, "ListDevicePoolsResult": { "base": "Represents the result of a list device pools request.
", "refs": { } }, "ListDevicesRequest": { "base": "Represents the result of a list devices request.
", "refs": { } }, "ListDevicesResult": { "base": "Represents the result of a list devices operation.
", "refs": { } }, "ListJobsRequest": { "base": "Represents a request to the list jobs operation.
", "refs": { } }, "ListJobsResult": { "base": "Represents the result of a list jobs request.
", "refs": { } }, "ListNetworkProfilesRequest": { "base": null, "refs": { } }, "ListNetworkProfilesResult": { "base": null, "refs": { } }, "ListOfferingPromotionsRequest": { "base": null, "refs": { } }, "ListOfferingPromotionsResult": { "base": null, "refs": { } }, "ListOfferingTransactionsRequest": { "base": "Represents the request to list the offering transaction history.
", "refs": { } }, "ListOfferingTransactionsResult": { "base": "Returns the transaction log of the specified offerings.
", "refs": { } }, "ListOfferingsRequest": { "base": "Represents the request to list all offerings.
", "refs": { } }, "ListOfferingsResult": { "base": "Represents the return values of the list of offerings.
", "refs": { } }, "ListProjectsRequest": { "base": "Represents a request to the list projects operation.
", "refs": { } }, "ListProjectsResult": { "base": "Represents the result of a list projects request.
", "refs": { } }, "ListRemoteAccessSessionsRequest": { "base": "Represents the request to return information about the remote access session.
", "refs": { } }, "ListRemoteAccessSessionsResult": { "base": "Represents the response from the server after AWS Device Farm makes a request to return information about the remote access session.
", "refs": { } }, "ListRunsRequest": { "base": "Represents a request to the list runs operation.
", "refs": { } }, "ListRunsResult": { "base": "Represents the result of a list runs request.
", "refs": { } }, "ListSamplesRequest": { "base": "Represents a request to the list samples operation.
", "refs": { } }, "ListSamplesResult": { "base": "Represents the result of a list samples request.
", "refs": { } }, "ListSuitesRequest": { "base": "Represents a request to the list suites operation.
", "refs": { } }, "ListSuitesResult": { "base": "Represents the result of a list suites request.
", "refs": { } }, "ListTestsRequest": { "base": "Represents a request to the list tests operation.
", "refs": { } }, "ListTestsResult": { "base": "Represents the result of a list tests request.
", "refs": { } }, "ListUniqueProblemsRequest": { "base": "Represents a request to the list unique problems operation.
", "refs": { } }, "ListUniqueProblemsResult": { "base": "Represents the result of a list unique problems request.
", "refs": { } }, "ListUploadsRequest": { "base": "Represents a request to the list uploads operation.
", "refs": { } }, "ListUploadsResult": { "base": "Represents the result of a list uploads request.
", "refs": { } }, "Location": { "base": "Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example 47.6204, -122.3491).
Elevation is currently not supported.
", "refs": { "ScheduleRunConfiguration$location": "Information about the location that is used for the run.
" } }, "Long": { "base": null, "refs": { "CreateNetworkProfileRequest$uplinkBandwidthBits": "The data throughput rate in bits per second, as an integer from 0 to 104857600.
", "CreateNetworkProfileRequest$downlinkBandwidthBits": "The data throughput rate in bits per second, as an integer from 0 to 104857600.
", "CreateNetworkProfileRequest$uplinkDelayMs": "Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
", "CreateNetworkProfileRequest$downlinkDelayMs": "Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
", "CreateNetworkProfileRequest$uplinkJitterMs": "Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
", "CreateNetworkProfileRequest$downlinkJitterMs": "Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
", "Device$heapSize": "The device's heap size, expressed in bytes.
", "Device$memory": "The device's total memory size, expressed in bytes.
", "NetworkProfile$uplinkBandwidthBits": "The data throughput rate in bits per second, as an integer from 0 to 104857600.
", "NetworkProfile$downlinkBandwidthBits": "The data throughput rate in bits per second, as an integer from 0 to 104857600.
", "NetworkProfile$uplinkDelayMs": "Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
", "NetworkProfile$downlinkDelayMs": "Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
", "NetworkProfile$uplinkJitterMs": "Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
", "NetworkProfile$downlinkJitterMs": "Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
", "UpdateNetworkProfileRequest$uplinkBandwidthBits": "The data throughput rate in bits per second, as an integer from 0 to 104857600.
", "UpdateNetworkProfileRequest$downlinkBandwidthBits": "The data throughput rate in bits per second, as an integer from 0 to 104857600.
", "UpdateNetworkProfileRequest$uplinkDelayMs": "Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
", "UpdateNetworkProfileRequest$downlinkDelayMs": "Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
", "UpdateNetworkProfileRequest$uplinkJitterMs": "Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
", "UpdateNetworkProfileRequest$downlinkJitterMs": "Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
" } }, "MaxSlotMap": { "base": null, "refs": { "AccountSettings$maxSlots": "The maximum number of device slots that the AWS account can purchase. Each maximum is expressed as an offering-id:number pair, where the offering-id represents one of the IDs returned by the ListOfferings command.
Any additional information about the exception.
", "CreateDevicePoolRequest$description": "The device pool's description.
", "CreateNetworkProfileRequest$description": "The description of the network profile.
", "DevicePool$description": "The device pool's description.
", "IdempotencyException$message": "Any additional information about the exception.
", "IncompatibilityMessage$message": "A message about the incompatibility.
", "Job$message": "A message about the job's result.
", "LimitExceededException$message": "Any additional information about the exception.
", "NetworkProfile$description": "The description of the network profile.
", "NotEligibleException$message": "The HTTP response code of a Not Eligible exception.
", "NotFoundException$message": "Any additional information about the exception.
", "Offering$description": "A string describing the offering.
", "OfferingPromotion$description": "A string describing the offering promotion.
", "Problem$message": "A message about the problem's result.
", "RemoteAccessSession$message": "A message about the remote access session.
", "Run$message": "A message about the run's result.
", "ServiceAccountException$message": "Any additional information about the exception.
", "Suite$message": "A message about the suite's result.
", "Test$message": "A message about the test's result.
", "UniqueProblem$message": "A message about the unique problems' result.
", "UpdateDevicePoolRequest$description": "A description of the device pool you wish to update.
", "UpdateNetworkProfileRequest$description": "The descriptoin of the network profile about which you are returning information.
", "Upload$message": "A message about the upload's result.
" } }, "Metadata": { "base": null, "refs": { "Upload$metadata": "The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.
" } }, "MonetaryAmount": { "base": "A number representing the monetary amount for an offering or transaction.
", "refs": { "OfferingTransaction$cost": "The cost of an offering transaction.
", "RecurringCharge$cost": "The cost of the recurring charge.
" } }, "Name": { "base": null, "refs": { "Artifact$name": "The artifact's name.
", "CreateDevicePoolRequest$name": "The device pool's name.
", "CreateNetworkProfileRequest$name": "The name you wish to specify for the new network profile.
", "CreateProjectRequest$name": "The project's name.
", "CreateRemoteAccessSessionRequest$name": "The name of the remote access session that you wish to create.
", "CreateUploadRequest$name": "The upload's file name. The name should not contain the '/' character. If uploading an iOS app, the file name needs to end with the .ipa extension. If uploading an Android app, the file name needs to end with the .apk extension. For all others, the file name must end with the .zip file extension.
The device's display name.
", "DevicePool$name": "The device pool's name.
", "Job$name": "The job's name.
", "NetworkProfile$name": "The name of the network profile.
", "ProblemDetail$name": "The problem detail's name.
", "Project$name": "The project's name.
", "RemoteAccessSession$name": "The name of the remote access session.
", "Run$name": "The run's name.
", "ScheduleRunRequest$name": "The name for the run to be scheduled.
", "Suite$name": "The suite's name.
", "Test$name": "The test's name.
", "UpdateDevicePoolRequest$name": "A string representing the name of the device pool you wish to update.
", "UpdateNetworkProfileRequest$name": "The name of the network profile about which you are returning information.
", "UpdateProjectRequest$name": "A string representing the new name of the project that you are updating.
", "Upload$name": "The upload's file name.
" } }, "NetworkProfile": { "base": "An array of settings that describes characteristics of a network profile.
", "refs": { "CreateNetworkProfileResult$networkProfile": "The network profile that is returned by the create network profile request.
", "GetNetworkProfileResult$networkProfile": "The network profile.
", "NetworkProfiles$member": null, "Run$networkProfile": "The network profile being used for a test run.
", "UpdateNetworkProfileResult$networkProfile": "A list of the available network profiles.
" } }, "NetworkProfileType": { "base": null, "refs": { "CreateNetworkProfileRequest$type": "The type of network profile you wish to create. Valid values are listed below.
", "ListNetworkProfilesRequest$type": "The type of network profile you wish to return information about. Valid values are listed below.
", "NetworkProfile$type": "The type of network profile. Valid values are listed below.
", "UpdateNetworkProfileRequest$type": "The type of network profile you wish to return information about. Valid values are listed below.
" } }, "NetworkProfiles": { "base": null, "refs": { "ListNetworkProfilesResult$networkProfiles": "A list of the available network profiles.
" } }, "NotEligibleException": { "base": "Exception gets thrown when a user is not eligible to perform the specified transaction.
", "refs": { } }, "NotFoundException": { "base": "The specified entity was not found.
", "refs": { } }, "Offering": { "base": "Represents the metadata of a device offering.
", "refs": { "OfferingStatus$offering": "Represents the metadata of an offering status.
", "Offerings$member": null } }, "OfferingIdentifier": { "base": null, "refs": { "Offering$id": "The ID that corresponds to a device offering.
", "OfferingStatusMap$key": null, "PurchaseOfferingRequest$offeringId": "The ID of the offering.
", "RenewOfferingRequest$offeringId": "The ID of a request to renew an offering.
" } }, "OfferingPromotion": { "base": "Represents information about an offering promotion.
", "refs": { "OfferingPromotions$member": null } }, "OfferingPromotionIdentifier": { "base": null, "refs": { "OfferingPromotion$id": "The ID of the offering promotion.
", "OfferingTransaction$offeringPromotionId": "The ID that corresponds to a device offering promotion.
", "PurchaseOfferingRequest$offeringPromotionId": "The ID of the offering promotion to be applied to the purchase.
" } }, "OfferingPromotions": { "base": null, "refs": { "ListOfferingPromotionsResult$offeringPromotions": "Information about the offering promotions.
" } }, "OfferingStatus": { "base": "The status of the offering.
", "refs": { "OfferingStatusMap$value": null, "OfferingTransaction$offeringStatus": "The status of an offering transaction.
" } }, "OfferingStatusMap": { "base": null, "refs": { "GetOfferingStatusResult$current": "When specified, gets the offering status for the current period.
", "GetOfferingStatusResult$nextPeriod": "When specified, gets the offering status for the next period.
" } }, "OfferingTransaction": { "base": "Represents the metadata of an offering transaction.
", "refs": { "OfferingTransactions$member": null, "PurchaseOfferingResult$offeringTransaction": "Represents the offering transaction for the purchase result.
", "RenewOfferingResult$offeringTransaction": "Represents the status of the offering transaction for the renewal.
" } }, "OfferingTransactionType": { "base": null, "refs": { "OfferingStatus$type": "The type specified for the offering status.
" } }, "OfferingTransactions": { "base": null, "refs": { "ListOfferingTransactionsResult$offeringTransactions": "The audit log of subscriptions you have purchased and modified through AWS Device Farm.
" } }, "OfferingType": { "base": null, "refs": { "Offering$type": "The type of offering (e.g., \"RECURRING\") for a device.
" } }, "Offerings": { "base": null, "refs": { "ListOfferingsResult$offerings": "A value representing the list offering results.
" } }, "PaginationToken": { "base": null, "refs": { "GetOfferingStatusRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "GetOfferingStatusResult$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListArtifactsRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListArtifactsResult$nextToken": "If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
", "ListDevicePoolsRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListDevicePoolsResult$nextToken": "If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
", "ListDevicesRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListDevicesResult$nextToken": "If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
", "ListJobsRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListJobsResult$nextToken": "If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
", "ListNetworkProfilesRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListNetworkProfilesResult$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListOfferingPromotionsRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListOfferingPromotionsResult$nextToken": "An identifier to be used in the next call to this operation, to return the next set of items in the list.
", "ListOfferingTransactionsRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListOfferingTransactionsResult$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListOfferingsRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListOfferingsResult$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListProjectsRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListProjectsResult$nextToken": "If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
", "ListRemoteAccessSessionsRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListRemoteAccessSessionsResult$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListRunsRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListRunsResult$nextToken": "If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
", "ListSamplesRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListSamplesResult$nextToken": "If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
", "ListSuitesRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListSuitesResult$nextToken": "If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
", "ListTestsRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListTestsResult$nextToken": "If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
", "ListUniqueProblemsRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListUniqueProblemsResult$nextToken": "If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
", "ListUploadsRequest$nextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListUploadsResult$nextToken": "If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
" } }, "PercentInteger": { "base": null, "refs": { "CreateNetworkProfileRequest$uplinkLossPercent": "Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
", "CreateNetworkProfileRequest$downlinkLossPercent": "Proportion of received packets that fail to arrive from 0 to 100 percent.
", "NetworkProfile$uplinkLossPercent": "Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
", "NetworkProfile$downlinkLossPercent": "Proportion of received packets that fail to arrive from 0 to 100 percent.
", "UpdateNetworkProfileRequest$uplinkLossPercent": "Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
", "UpdateNetworkProfileRequest$downlinkLossPercent": "Proportion of received packets that fail to arrive from 0 to 100 percent.
" } }, "Problem": { "base": "Represents a specific warning or failure.
", "refs": { "Problems$member": null } }, "ProblemDetail": { "base": "Information about a problem detail.
", "refs": { "Problem$run": "Information about the associated run.
", "Problem$job": "Information about the associated job.
", "Problem$suite": "Information about the associated suite.
", "Problem$test": "Information about the associated test.
" } }, "Problems": { "base": null, "refs": { "UniqueProblem$problems": "Information about the problems.
" } }, "Project": { "base": "Represents an operating-system neutral workspace for running and managing tests.
", "refs": { "CreateProjectResult$project": "The newly created project.
", "GetProjectResult$project": "The project you wish to get information about.
", "Projects$member": null, "UpdateProjectResult$project": "The project you wish to update.
" } }, "Projects": { "base": null, "refs": { "ListProjectsResult$projects": "Information about the projects.
" } }, "PurchaseOfferingRequest": { "base": "Represents a request for a purchase offering.
", "refs": { } }, "PurchaseOfferingResult": { "base": "The result of the purchase offering (e.g., success or failure).
", "refs": { } }, "PurchasedDevicesMap": { "base": null, "refs": { "AccountSettings$unmeteredDevices": "Returns the unmetered devices you have purchased or want to purchase.
", "AccountSettings$unmeteredRemoteAccessDevices": "Returns the unmetered remote access devices you have purchased or want to purchase.
" } }, "Radios": { "base": "Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.
", "refs": { "ScheduleRunConfiguration$radios": "Information about the radio states for the run.
" } }, "RecurringCharge": { "base": "Specifies whether charges for devices will be recurring.
", "refs": { "RecurringCharges$member": null } }, "RecurringChargeFrequency": { "base": null, "refs": { "RecurringCharge$frequency": "The frequency in which charges will recur.
" } }, "RecurringCharges": { "base": null, "refs": { "Offering$recurringCharges": "Specifies whether there are recurring charges for the offering.
" } }, "RemoteAccessSession": { "base": "Represents information about the remote access session.
", "refs": { "CreateRemoteAccessSessionResult$remoteAccessSession": "A container that describes the remote access session when the request to create a remote access session is sent.
", "GetRemoteAccessSessionResult$remoteAccessSession": "A container that lists detailed information about the remote access session.
", "RemoteAccessSessions$member": null, "StopRemoteAccessSessionResult$remoteAccessSession": "A container representing the metadata from the service about the remote access session you are stopping.
" } }, "RemoteAccessSessions": { "base": null, "refs": { "ListRemoteAccessSessionsResult$remoteAccessSessions": "A container representing the metadata from the service about each remote access session you are requesting.
" } }, "RenewOfferingRequest": { "base": "A request representing an offering renewal.
", "refs": { } }, "RenewOfferingResult": { "base": "The result of a renewal offering.
", "refs": { } }, "Resolution": { "base": "Represents the screen resolution of a device in height and width, expressed in pixels.
", "refs": { "Device$resolution": "The resolution of the device.
" } }, "Rule": { "base": "Represents a condition for a device pool.
", "refs": { "Rules$member": null } }, "RuleOperator": { "base": null, "refs": { "Rule$operator": "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.
CONTAINS: The contains operator.
The device pool's rules.
", "DevicePool$rules": "Information about the device pool's rules.
", "UpdateDevicePoolRequest$rules": "Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.
" } }, "Run": { "base": "Represents a test run on a set of devices with a given app package, test parameters, etc.
", "refs": { "GetRunResult$run": "The run you wish to get results from.
", "Runs$member": null, "ScheduleRunResult$run": "Information about the scheduled run.
", "StopRunResult$run": "The run that was stopped.
" } }, "Runs": { "base": null, "refs": { "ListRunsResult$runs": "Information about the runs.
" } }, "Sample": { "base": "Represents a sample of performance data.
", "refs": { "Samples$member": null } }, "SampleType": { "base": null, "refs": { "Sample$type": "The sample's type.
Must be one of the following values:
CPU: A CPU sample type. This is expressed as the app processing CPU time (including child processes) as reported by process, as a percentage.
MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app process, in kilobytes.
NATIVE_AVG_DRAWTIME
NATIVE_FPS
NATIVE_FRAMES
NATIVE_MAX_DRAWTIME
NATIVE_MIN_DRAWTIME
OPENGL_AVG_DRAWTIME
OPENGL_FPS
OPENGL_FRAMES
OPENGL_MAX_DRAWTIME
OPENGL_MIN_DRAWTIME
RX
RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, by app process.
THREADS: A threads sample type. This is expressed as the total number of threads per app process.
TX
TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process.
Information about the samples.
" } }, "ScheduleRunConfiguration": { "base": "Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles.
", "refs": { "ScheduleRunRequest$configuration": "Information about the settings for the run to be scheduled.
" } }, "ScheduleRunRequest": { "base": "Represents a request to the schedule run operation.
", "refs": { } }, "ScheduleRunResult": { "base": "Represents the result of a schedule run request.
", "refs": { } }, "ScheduleRunTest": { "base": "Represents additional test settings.
", "refs": { "GetDevicePoolCompatibilityRequest$test": "Information about the uploaded test to be run against the device pool.
", "ScheduleRunRequest$test": "Information about the test for the run to be scheduled.
" } }, "ServiceAccountException": { "base": "There was a problem with the service account.
", "refs": { } }, "SshPublicKey": { "base": null, "refs": { "CreateRemoteAccessSessionRequest$sshPublicKey": "The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This is only required if remoteDebugEnabled is set to true.
Represents the request to stop the remote access session.
", "refs": { } }, "StopRemoteAccessSessionResult": { "base": "Represents the response from the server that describes the remote access session when AWS Device Farm stops the session.
", "refs": { } }, "StopRunRequest": { "base": "Represents the request to stop a specific run.
", "refs": { } }, "StopRunResult": { "base": "Represents the results of your stop run attempt.
", "refs": { } }, "String": { "base": null, "refs": { "AndroidPaths$member": null, "Artifact$extension": "The artifact's file extension.
", "CPU$frequency": "The CPU's frequency.
", "CPU$architecture": "The CPU's architecture, for example x86 or ARM.
", "Device$manufacturer": "The device's manufacturer name.
", "Device$model": "The device's model name.
", "Device$os": "The device's operating system type.
", "Device$image": "The device's image name.
", "Device$carrier": "The device's carrier.
", "Device$radio": "The device's radio.
", "Device$fleetType": "The type of fleet to which this device belongs. Possible values for fleet type are PRIVATE and PUBLIC.
", "Device$fleetName": "The name of the fleet to which this device belongs.
", "DeviceHostPaths$member": null, "IosPaths$member": null, "MaxSlotMap$key": null, "RemoteAccessSession$endpoint": "The endpoint for the remote access sesssion.
", "RemoteAccessSession$deviceUdid": "Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.
", "Rule$value": "The rule's value.
", "Run$parsingResultUrl": "Read-only URL for an object in 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.
", "ScheduleRunConfiguration$locale": "Information about the locale that is used for the run.
", "TestParameters$key": null, "TestParameters$value": null } }, "Suite": { "base": "Represents a collection of one or more tests.
", "refs": { "GetSuiteResult$suite": "A collection of one or more tests.
", "Suites$member": null } }, "Suites": { "base": null, "refs": { "ListSuitesResult$suites": "Information about the suites.
" } }, "Test": { "base": "Represents a condition that is evaluated.
", "refs": { "GetTestResult$test": "A test condition that is evaluated.
", "Tests$member": null } }, "TestParameters": { "base": null, "refs": { "ScheduleRunTest$parameters": "The test's parameters, such as the following test framework parameters and fixture settings:
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.4.16\", \"1.6.3\", \"latest\", and \"default\".
“latest” will run the latest Appium version supported by Device Farm (1.6.3).
For “default”, Device Farm will choose a compatible version of Appium for the device. The current behavior is to run 1.4.16 on Android devices and iOS 9 and earlier, 1.6.3 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 username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.
password: A password to use if the Explorer encounters a login form. If not supplied, no password will be 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\"
The test type for the specified device pool.
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.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
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.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
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.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
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.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
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.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
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.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
Information about the tests.
" } }, "TransactionIdentifier": { "base": null, "refs": { "OfferingTransaction$transactionId": "The transaction ID of the offering transaction.
" } }, "TrialMinutes": { "base": "Represents information about free trial device minutes for an AWS account.
", "refs": { "AccountSettings$trialMinutes": "Information about an AWS account's usage of free trial device minutes.
" } }, "URL": { "base": null, "refs": { "Artifact$url": "The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the artifact's file.
", "Sample$url": "The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the sample's file.
", "Upload$url": "The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.
" } }, "UniqueProblem": { "base": "A collection of one or more problems, grouped by their result.
", "refs": { "UniqueProblems$member": null } }, "UniqueProblems": { "base": null, "refs": { "UniqueProblemsByExecutionResultMap$value": null } }, "UniqueProblemsByExecutionResultMap": { "base": null, "refs": { "ListUniqueProblemsResult$uniqueProblems": "Information about the unique problems.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
Represents a request to the update device pool operation.
", "refs": { } }, "UpdateDevicePoolResult": { "base": "Represents the result of an update device pool request.
", "refs": { } }, "UpdateNetworkProfileRequest": { "base": null, "refs": { } }, "UpdateNetworkProfileResult": { "base": null, "refs": { } }, "UpdateProjectRequest": { "base": "Represents a request to the update project operation.
", "refs": { } }, "UpdateProjectResult": { "base": "Represents the result of an update project request.
", "refs": { } }, "Upload": { "base": "An app or a set of one or more tests to upload or that have been uploaded.
", "refs": { "CreateUploadResult$upload": "The newly created upload.
", "GetUploadResult$upload": "An app or a set of one or more tests to upload or that have been uploaded.
", "InstallToRemoteAccessSessionResult$appUpload": "An app to upload or that has been uploaded.
", "Uploads$member": null } }, "UploadStatus": { "base": null, "refs": { "Upload$status": "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.
The upload's upload type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web appliction 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.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
Note If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.
The upload's type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web appliction 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.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
Information about the uploads.
" } } } }