Module Smaws_Client_DeviceFarm.Types

type nonrec subnet_id = string
type nonrec vpc_subnet_ids = subnet_id list
type nonrec security_group_id = string
type nonrec vpc_security_group_ids = security_group_id list
type nonrec non_empty_string = string
type nonrec vpc_config = {
  1. vpc_id : non_empty_string;
    (*

    The ID of the Amazon VPC.

    *)
  2. subnet_ids : vpc_subnet_ids;
    (*

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

    *)
  3. security_group_ids : vpc_security_group_ids;
    (*

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

    *)
}

Contains the VPC configuration data necessary to interface with AWS Device Farm's services.

type nonrec video_capture = bool
type nonrec vpce_service_name = string
type nonrec amazon_resource_name = string
type nonrec vpce_configuration_name = string
type nonrec service_dns_name = string
type nonrec vpce_configuration_description = string
type nonrec vpce_configuration = {
  1. vpce_configuration_description : vpce_configuration_description option;
    (*

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

    *)
  2. service_dns_name : service_dns_name option;
    (*

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

    *)
  3. vpce_service_name : vpce_service_name option;
    (*

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

    *)
  4. vpce_configuration_name : vpce_configuration_name option;
    (*

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

    *)
  5. arn : amazon_resource_name option;
    (*

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

    *)
}

Represents an Amazon Virtual Private Cloud (VPC) endpoint configuration.

type nonrec vpce_configurations = vpce_configuration list
type nonrec name = string
type nonrec date_time = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec upload_type =
  1. | XCTEST_UI_TEST_SPEC
  2. | INSTRUMENTATION_TEST_SPEC
  3. | APPIUM_WEB_RUBY_TEST_SPEC
  4. | APPIUM_WEB_NODE_TEST_SPEC
  5. | APPIUM_WEB_PYTHON_TEST_SPEC
  6. | APPIUM_WEB_JAVA_TESTNG_TEST_SPEC
  7. | APPIUM_WEB_JAVA_JUNIT_TEST_SPEC
  8. | APPIUM_RUBY_TEST_SPEC
  9. | APPIUM_NODE_TEST_SPEC
  10. | APPIUM_PYTHON_TEST_SPEC
  11. | APPIUM_JAVA_TESTNG_TEST_SPEC
  12. | APPIUM_JAVA_JUNIT_TEST_SPEC
  13. | XCTEST_UI_TEST_PACKAGE
  14. | XCTEST_TEST_PACKAGE
  15. | UIAUTOMATOR_TEST_PACKAGE
  16. | UIAUTOMATION_TEST_PACKAGE
  17. | INSTRUMENTATION_TEST_PACKAGE
  18. | CALABASH_TEST_PACKAGE
  19. | APPIUM_WEB_RUBY_TEST_PACKAGE
  20. | APPIUM_WEB_NODE_TEST_PACKAGE
  21. | APPIUM_WEB_PYTHON_TEST_PACKAGE
  22. | APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE
  23. | APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE
  24. | APPIUM_RUBY_TEST_PACKAGE
  25. | APPIUM_NODE_TEST_PACKAGE
  26. | APPIUM_PYTHON_TEST_PACKAGE
  27. | APPIUM_JAVA_TESTNG_TEST_PACKAGE
  28. | APPIUM_JAVA_JUNIT_TEST_PACKAGE
  29. | EXTERNAL_DATA
  30. | WEB_APP
  31. | IOS_APP
  32. | ANDROID_APP
type nonrec upload_status =
  1. | FAILED
  2. | SUCCEEDED
  3. | PROCESSING
  4. | INITIALIZED
type nonrec sensitive_ur_l = string
type nonrec metadata = string
type nonrec content_type = string
type nonrec message = string
type nonrec upload_category =
  1. | PRIVATE
  2. | CURATED
type nonrec upload = {
  1. category : upload_category option;
    (*

    The upload's category. Allowed values include:

    • CURATED: An upload managed by AWS Device Farm.
    • PRIVATE: An upload managed by the AWS Device Farm customer.
    *)
  2. message : message option;
    (*

    A message about the upload's result.

    *)
  3. content_type : content_type option;
    (*

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

    *)
  4. metadata : metadata option;
    (*

    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.

    *)
  5. url : sensitive_ur_l option;
    (*

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

    *)
  6. status : upload_status option;
    (*

    The upload's status.

    Must be one of the following values:

    • FAILED
    • INITIALIZED
    • PROCESSING
    • SUCCEEDED
    *)
  7. type_ : upload_type option;
    (*

    The upload's type.

    Must be one of the following values:

    • ANDROID_APP
    • IOS_APP
    • WEB_APP
    • EXTERNAL_DATA
    • APPIUM_JAVA_JUNIT_TEST_PACKAGE
    • APPIUM_JAVA_TESTNG_TEST_PACKAGE
    • APPIUM_PYTHON_TEST_PACKAGE
    • APPIUM_NODE_TEST_PACKAGE
    • APPIUM_RUBY_TEST_PACKAGE
    • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE
    • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE
    • APPIUM_WEB_PYTHON_TEST_PACKAGE
    • APPIUM_WEB_NODE_TEST_PACKAGE
    • APPIUM_WEB_RUBY_TEST_PACKAGE
    • INSTRUMENTATION_TEST_PACKAGE
    • XCTEST_TEST_PACKAGE
    • XCTEST_UI_TEST_PACKAGE
    • APPIUM_JAVA_JUNIT_TEST_SPEC
    • APPIUM_JAVA_TESTNG_TEST_SPEC
    • APPIUM_PYTHON_TEST_SPEC
    • APPIUM_NODE_TEST_SPEC
    • APPIUM_RUBY_TEST_SPEC
    • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC
    • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC
    • APPIUM_WEB_PYTHON_TEST_SPEC
    • APPIUM_WEB_NODE_TEST_SPEC
    • APPIUM_WEB_RUBY_TEST_SPEC
    • INSTRUMENTATION_TEST_SPEC
    • XCTEST_UI_TEST_SPEC
    *)
  8. created : date_time option;
    (*

    When the upload was created.

    *)
  9. name : name option;
    (*

    The upload's file name.

    *)
  10. arn : amazon_resource_name option;
    (*

    The upload's ARN.

    *)
}

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

type nonrec uploads = upload list
type nonrec update_vpce_configuration_result = {
  1. vpce_configuration : vpce_configuration option;
    (*

    An object that contains information about your VPC endpoint configuration.

    *)
}
type nonrec update_vpce_configuration_request = {
  1. vpce_configuration_description : vpce_configuration_description option;
    (*

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

    *)
  2. service_dns_name : service_dns_name option;
    (*

    The DNS (domain) name used to connect to your private service in your VPC. The DNS name must not already be in use on the internet.

    *)
  3. vpce_service_name : vpce_service_name option;
    (*

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

    *)
  4. vpce_configuration_name : vpce_configuration_name option;
    (*

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

    *)
  5. arn : amazon_resource_name;
    (*

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

    *)
}
type nonrec service_account_exception = {
  1. message : message option;
    (*

    Any additional information about the exception.

    *)
}

There was a problem with the service account.

type nonrec not_found_exception = {
  1. message : message option;
    (*

    Any additional information about the exception.

    *)
}

The specified entity was not found.

type nonrec invalid_operation_exception = {
  1. message : message option;
}

There was an error with the update request, or you do not have sufficient permissions to update this VPC endpoint configuration.

type nonrec argument_exception = {
  1. message : message option;
    (*

    Any additional information about the exception.

    *)
}

An invalid argument was specified.

type nonrec update_upload_result = {
  1. upload : upload option;
    (*

    A test spec uploaded to Device Farm.

    *)
}
type nonrec boolean_ = bool
type nonrec update_upload_request = {
  1. edit_content : boolean_ option;
    (*

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

    *)
  2. content_type : content_type option;
    (*

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

    *)
  3. name : name option;
    (*

    The upload's test spec file name. The name must not contain any forward slashes (/). The test spec file name must end with the .yaml or .yml file extension.

    *)
  4. arn : amazon_resource_name;
    (*

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

    *)
}
type nonrec limit_exceeded_exception = {
  1. message : message option;
    (*

    Any additional information about the exception.

    *)
}

A limit was exceeded.

type nonrec device_farm_arn = string
type nonrec string_ = string
type nonrec security_group_ids = non_empty_string list
type nonrec subnet_ids = non_empty_string list
type nonrec test_grid_vpc_config = {
  1. vpc_id : non_empty_string;
    (*

    The ID of the Amazon VPC.

    *)
  2. subnet_ids : subnet_ids;
    (*

    A list of VPC subnet IDs in your Amazon VPC.

    *)
  3. security_group_ids : security_group_ids;
    (*

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

    *)
}

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

type nonrec test_grid_project = {
  1. created : date_time option;
    (*

    When the project was created.

    *)
  2. vpc_config : test_grid_vpc_config option;
    (*

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

    *)
  3. description : string_ option;
    (*

    A human-readable description for the project.

    *)
  4. name : string_ option;
    (*

    A human-readable name for the project.

    *)
  5. arn : device_farm_arn option;
    (*

    The ARN for the project.

    *)
}

A Selenium testing project. Projects are used to collect and collate sessions.

type nonrec update_test_grid_project_result = {
  1. test_grid_project : test_grid_project option;
    (*

    The project, including updated information.

    *)
}
type nonrec resource_name = string
type nonrec resource_description = string
type nonrec update_test_grid_project_request = {
  1. vpc_config : test_grid_vpc_config option;
    (*

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

    *)
  2. description : resource_description option;
    (*

    Human-readable description for the project.

    *)
  3. name : resource_name option;
    (*

    Human-readable name for the project.

    *)
  4. project_arn : device_farm_arn;
    (*

    ARN of the project to update.

    *)
}
type nonrec internal_service_exception = {
  1. message : message option;
}

An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this error.

type nonrec job_timeout_minutes = int
type nonrec environment_variable_name = string
type nonrec environment_variable_value = string
type nonrec environment_variable = {
  1. value : environment_variable_value;
    (*

    The value of the environment variable.

    *)
  2. name : environment_variable_name;
    (*

    The name of the environment variable.

    *)
}

Information about an environment variable for a project or a run.

type nonrec environment_variables = environment_variable list
type nonrec amazon_role_resource_name = string
type nonrec project = {
  1. execution_role_arn : amazon_role_resource_name option;
    (*

    The IAM execution role associated with the project.

    *)
  2. environment_variables : environment_variables option;
    (*

    Environment variables associated with the project.

    *)
  3. vpc_config : vpc_config option;
    (*

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

    *)
  4. created : date_time option;
    (*

    When the project was created.

    *)
  5. default_job_timeout_minutes : job_timeout_minutes option;
    (*

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

    *)
  6. name : name option;
    (*

    The project's name.

    *)
  7. arn : amazon_resource_name option;
    (*

    The project's ARN.

    *)
}

Represents an operating-system neutral workspace for running and managing tests.

type nonrec update_project_result = {
  1. project : project option;
    (*

    The project to update.

    *)
}

Represents the result of an update project request.

type nonrec update_project_request = {
  1. execution_role_arn : amazon_role_resource_name option;
    (*

    An IAM role to be assumed by the test host for all runs in the project.

    *)
  2. environment_variables : environment_variables option;
    (*

    A set of environment variables which are used by default for all runs in the project. These environment variables are applied to the test run during the execution of a test spec file.

    For more information about using test spec files, please see Custom test environments in AWS Device Farm.

    *)
  3. vpc_config : vpc_config option;
    (*

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

    *)
  4. default_job_timeout_minutes : job_timeout_minutes option;
    (*

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

    *)
  5. name : name option;
    (*

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

    *)
  6. arn : amazon_resource_name;
    (*

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

    *)
}

Represents a request to the update project operation.

type nonrec network_profile_type =
  1. | PRIVATE
  2. | CURATED
type nonrec long = Smaws_Lib.CoreTypes.Int64.t
type nonrec percent_integer = int
type nonrec network_profile = {
  1. type_ : network_profile_type option;
    (*

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

    *)
  2. description : message option;
    (*

    The description of the network profile.

    *)
  3. name : name option;
    (*

    The name of the network profile.

    *)
  4. arn : amazon_resource_name option;
    (*

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

    *)
}

An array of settings that describes characteristics of a network profile.

type nonrec update_network_profile_result = {
  1. network_profile : network_profile option;
    (*

    A list of the available network profiles.

    *)
}
type nonrec update_network_profile_request = {
  1. type_ : network_profile_type option;
    (*

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

    *)
  2. description : message option;
    (*

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

    *)
  3. name : name option;
    (*

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

    *)
  4. arn : amazon_resource_name;
    (*

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

    *)
}
type nonrec package_ids = string_ list
type nonrec instance_profile = {
  1. description : message option;
    (*

    The description of the instance profile.

    *)
  2. name : name option;
    (*

    The name of the instance profile.

    *)
  3. reboot_after_use : boolean_ option;
    (*

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

    *)
  4. exclude_app_packages_from_cleanup : package_ids option;
    (*

    An array of strings containing the list of app packages that should not be cleaned up from the device after a test run completes.

    The list of packages is considered only if you set packageCleanup to true.

    *)
  5. package_cleanup : boolean_ option;
    (*

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

    *)
  6. arn : amazon_resource_name option;
    (*

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

    *)
}

Represents the instance profile.

type nonrec update_instance_profile_result = {
  1. instance_profile : instance_profile option;
    (*

    An object that contains information about your instance profile.

    *)
}
type nonrec update_instance_profile_request = {
  1. reboot_after_use : boolean_ option;
    (*

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

    *)
  2. exclude_app_packages_from_cleanup : package_ids option;
    (*

    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run is over.

    The list of packages is only considered if you set packageCleanup to true.

    *)
  3. package_cleanup : boolean_ option;
    (*

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

    *)
  4. description : message option;
    (*

    The updated description for your instance profile.

    *)
  5. name : name option;
    (*

    The updated name for your instance profile.

    *)
  6. arn : amazon_resource_name;
    (*

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

    *)
}
type nonrec device_pool_type =
  1. | PRIVATE
  2. | CURATED
type nonrec device_attribute =
  1. | AVAILABILITY
  2. | MODEL
  3. | OS_VERSION
  4. | FLEET_TYPE
  5. | INSTANCE_LABELS
  6. | INSTANCE_ARN
  7. | APPIUM_VERSION
  8. | REMOTE_DEBUG_ENABLED
  9. | REMOTE_ACCESS_ENABLED
  10. | MANUFACTURER
  11. | FORM_FACTOR
  12. | PLATFORM
  13. | ARN
type nonrec rule_operator =
  1. | CONTAINS
  2. | NOT_IN
  3. | IN
  4. | GREATER_THAN_OR_EQUALS
  5. | GREATER_THAN
  6. | LESS_THAN_OR_EQUALS
  7. | LESS_THAN
  8. | EQUALS
type nonrec rule = {
  1. value : string_ option;
    (*

    The rule's value.

    *)
  2. operator : rule_operator option;
    (*

    Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.

    *)
  3. attribute : device_attribute option;
    (*

    The rule's stringified attribute. For example, specify the value as "\"abc\"".

    The supported operators for each attribute are provided in the following list.

    APPIUM_VERSION The Appium version for the test.

    Supported operators: CONTAINS

    ARN The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example.

    Supported operators: EQUALS, IN, NOT_IN

    AVAILABILITY The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

    Supported operators: EQUALS

    FLEET_TYPE The fleet type. Valid values are PUBLIC or PRIVATE.

    Supported operators: EQUALS

    FORM_FACTOR The device form factor. Valid values are PHONE or TABLET.

    Supported operators: EQUALS, IN, NOT_IN

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

    Supported operators: IN, NOT_IN

    INSTANCE_LABELS The label of the device instance.

    Supported operators: CONTAINS

    MANUFACTURER The device manufacturer (for example, Apple).

    Supported operators: EQUALS, IN, NOT_IN

    MODEL The device model, such as Apple iPad Air 2 or Google Pixel.

    Supported operators: CONTAINS, EQUALS, IN, NOT_IN

    OS_VERSION The operating system version (for example, 10.3.2).

    Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

    PLATFORM The device platform. Valid values are ANDROID or IOS.

    Supported operators: EQUALS, IN, NOT_IN

    REMOTE_ACCESS_ENABLED Whether the device is enabled for remote access. Valid values are TRUE or FALSE.

    Supported operators: EQUALS

    REMOTE_DEBUG_ENABLED Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.

    Supported operators: EQUALS

    Because remote debugging is no longer supported, this filter is ignored.

    *)
}

Represents a condition for a device pool.

type nonrec rules = rule list
type nonrec integer = int
type nonrec device_pool = {
  1. max_devices : integer option;
    (*

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

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

    *)
  2. rules : rules option;
    (*

    Information about the device pool's rules.

    *)
  3. type_ : device_pool_type option;
    (*

    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.
    *)
  4. description : message option;
    (*

    The device pool's description.

    *)
  5. name : name option;
    (*

    The device pool's name.

    *)
  6. arn : amazon_resource_name option;
    (*

    The device pool's ARN.

    *)
}

Represents a collection of device types.

type nonrec update_device_pool_result = {
  1. device_pool : device_pool option;
    (*

    The device pool you just updated.

    *)
}

Represents the result of an update device pool request.

type nonrec update_device_pool_request = {
  1. clear_max_devices : boolean_ option;
    (*

    Sets whether the maxDevices parameter applies to your device pool. If you set this parameter to true, the maxDevices parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria specified in the rules parameter.

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

    *)
  2. max_devices : integer option;
    (*

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

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

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

    *)
  3. rules : rules option;
    (*

    Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for your request, the update replaces the existing rules.

    *)
  4. description : message option;
    (*

    A description of the device pool to update.

    *)
  5. name : name option;
    (*

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

    *)
  6. arn : amazon_resource_name;
    (*

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

    *)
}

Represents a request to the update device pool operation.

type nonrec instance_labels = string_ list
type nonrec instance_status =
  1. | NOT_AVAILABLE
  2. | AVAILABLE
  3. | PREPARING
  4. | IN_USE
type nonrec device_instance = {
  1. instance_profile : instance_profile option;
    (*

    A object that contains information about the instance profile.

    *)
  2. udid : string_ option;
    (*

    Unique device identifier for the device instance.

    *)
  3. status : instance_status option;
    (*

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

    *)
  4. labels : instance_labels option;
    (*

    An array of strings that describe the device instance.

    *)
  5. device_arn : amazon_resource_name option;
    (*

    The ARN of the device.

    *)
  6. arn : amazon_resource_name option;
    (*

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

    *)
}

Represents the device instance.

type nonrec update_device_instance_result = {
  1. device_instance : device_instance option;
    (*

    An object that contains information about your device instance.

    *)
}
type nonrec update_device_instance_request = {
  1. labels : instance_labels option;
    (*

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

    *)
  2. profile_arn : amazon_resource_name option;
    (*

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

    *)
  3. arn : amazon_resource_name;
    (*

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

    *)
}
type nonrec untag_resource_response = unit
type nonrec tag_key = string
type nonrec tag_key_list = tag_key list
type nonrec untag_resource_request = {
  1. tag_keys : tag_key_list;
    (*

    The keys of the tags to be removed.

    *)
  2. resource_ar_n : device_farm_arn;
    (*

    The Amazon Resource Name (ARN) of the resource or resources from which to delete tags. You can associate tags with the following Device Farm resources: PROJECT, TESTGRID_PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.

    *)
}
type nonrec exception_message = string
type nonrec tag_operation_exception = {
  1. resource_name : amazon_resource_name option;
  2. message : exception_message option;
}

The operation was not successful. Try again.

type nonrec problem_detail = {
  1. name : name option;
    (*

    The problem detail's name.

    *)
  2. arn : amazon_resource_name option;
    (*

    The problem detail's ARN.

    *)
}

Information about a problem detail.

type nonrec device_form_factor =
  1. | TABLET
  2. | PHONE
type nonrec device_platform =
  1. | IOS
  2. | ANDROID
type nonrec double = float
type nonrec cp_u = {
  1. clock : double option;
    (*

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

    *)
  2. architecture : string_ option;
    (*

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

    *)
  3. frequency : string_ option;
    (*

    The CPU's frequency.

    *)
}

Represents the amount of CPU that an app is using on a physical device. Does not represent system-wide CPU usage.

type nonrec resolution = {
  1. height : integer option;
    (*

    The screen resolution's height, expressed in pixels.

    *)
  2. width : integer option;
    (*

    The screen resolution's width, expressed in pixels.

    *)
}

Represents the screen resolution of a device in height and width, expressed in pixels.

type nonrec device_instances = device_instance list
type nonrec device_availability =
  1. | HIGHLY_AVAILABLE
  2. | AVAILABLE
  3. | BUSY
  4. | TEMPORARY_NOT_AVAILABLE
type nonrec device = {
  1. availability : device_availability option;
    (*

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

    *)
  2. instances : device_instances option;
    (*

    The instances that belong to this device.

    *)
  3. fleet_name : string_ option;
    (*

    The name of the fleet to which this device belongs.

    *)
  4. fleet_type : string_ option;
    (*

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

    *)
  5. remote_debug_enabled : boolean_ option;
    (*

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

    Remote debugging is no longer supported.

    *)
  6. remote_access_enabled : boolean_ option;
    (*

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

    *)
  7. radio : string_ option;
    (*

    The device's radio.

    *)
  8. carrier : string_ option;
    (*

    The device's carrier.

    *)
  9. image : string_ option;
    (*

    The device's image name.

    *)
  10. memory : long option;
    (*

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

    *)
  11. heap_size : long option;
    (*

    The device's heap size, expressed in bytes.

    *)
  12. resolution : resolution option;
    (*

    The resolution of the device.

    *)
  13. cpu : cp_u option;
    (*

    Information about the device's CPU.

    *)
  14. os : string_ option;
    (*

    The device's operating system type.

    *)
  15. platform : device_platform option;
    (*

    The device's platform.

    Allowed values include:

    • ANDROID
    • IOS
    *)
  16. form_factor : device_form_factor option;
    (*

    The device's form factor.

    Allowed values include:

    • PHONE
    • TABLET
    *)
  17. model_id : string_ option;
    (*

    The device's model ID.

    *)
  18. model : string_ option;
    (*

    The device's model name.

    *)
  19. manufacturer : string_ option;
    (*

    The device's manufacturer name.

    *)
  20. name : name option;
    (*

    The device's display name.

    *)
  21. arn : amazon_resource_name option;
    (*

    The device's ARN.

    *)
}

Represents a device type that an app is tested against.

type nonrec execution_result =
  1. | STOPPED
  2. | ERRORED
  3. | SKIPPED
  4. | FAILED
  5. | WARNED
  6. | PASSED
  7. | PENDING
type nonrec problem = {
  1. message : message option;
    (*

    A message about the problem's result.

    *)
  2. result_ : execution_result option;
    (*

    The problem's result.

    Allowed values include:

    • PENDING
    • PASSED
    • WARNED
    • FAILED
    • SKIPPED
    • ERRORED
    • STOPPED
    *)
  3. device : device option;
    (*

    Information about the associated device.

    *)
  4. test : problem_detail option;
    (*

    Information about the associated test.

    *)
  5. suite : problem_detail option;
    (*

    Information about the associated suite.

    *)
  6. job : problem_detail option;
    (*

    Information about the associated job.

    *)
  7. run : problem_detail option;
    (*

    Information about the associated run.

    *)
}

Represents a specific warning or failure.

type nonrec problems = problem list
type nonrec unique_problem = {
  1. problems : problems option;
    (*

    Information about the problems.

    *)
  2. message : message option;
    (*

    A message about the unique problems' result.

    *)
}

A collection of one or more problems, grouped by their result.

type nonrec unique_problems = unique_problem list
type nonrec unique_problems_by_execution_result_map = (execution_result * unique_problems) list
type nonrec ur_l = string
type nonrec trial_minutes = {
  1. remaining : double option;
    (*

    The number of free trial minutes remaining in the account.

    *)
  2. total : double option;
    (*

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

    *)
}

Represents information about free trial device minutes for an AWS account.

type nonrec transaction_identifier = string
type nonrec too_many_tags_exception = {
  1. resource_name : amazon_resource_name option;
  2. message : exception_message option;
}

The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.

type nonrec test_type =
  1. | XCTEST_UI
  2. | XCTEST
  3. | INSTRUMENTATION
  4. | APPIUM_WEB_RUBY
  5. | APPIUM_WEB_NODE
  6. | APPIUM_WEB_PYTHON
  7. | APPIUM_WEB_JAVA_TESTNG
  8. | APPIUM_WEB_JAVA_JUNIT
  9. | APPIUM_RUBY
  10. | APPIUM_NODE
  11. | APPIUM_PYTHON
  12. | APPIUM_JAVA_TESTNG
  13. | APPIUM_JAVA_JUNIT
  14. | BUILTIN_FUZZ
type nonrec execution_status =
  1. | STOPPING
  2. | COMPLETED
  3. | RUNNING
  4. | PREPARING
  5. | SCHEDULING
  6. | PROCESSING
  7. | PENDING_DEVICE
  8. | PENDING_CONCURRNECY
  9. | PENDING
type nonrec counters = {
  1. skipped : integer option;
    (*

    The number of skipped entities.

    *)
  2. stopped : integer option;
    (*

    The number of stopped entities.

    *)
  3. errored : integer option;
    (*

    The number of errored entities.

    *)
  4. warned : integer option;
    (*

    The number of warned entities.

    *)
  5. failed : integer option;
    (*

    The number of failed entities.

    *)
  6. passed : integer option;
    (*

    The number of passed entities.

    *)
  7. total : integer option;
    (*

    The total number of entities.

    *)
}

Represents entity counters.

type nonrec device_minutes = {
  1. unmetered : double option;
    (*

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

    *)
  2. metered : double option;
    (*

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

    *)
  3. total : double option;
    (*

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

    *)
}

Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.

type nonrec test = {
  1. device_minutes : device_minutes option;
    (*

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

    *)
  2. message : message option;
    (*

    A message about the test's result.

    *)
  3. counters : counters option;
    (*

    The test's result counters.

    *)
  4. stopped : date_time option;
    (*

    The test's stop time.

    *)
  5. started : date_time option;
    (*

    The test's start time.

    *)
  6. result_ : execution_result option;
    (*

    The test's result.

    Allowed values include:

    • PENDING
    • PASSED
    • WARNED
    • FAILED
    • SKIPPED
    • ERRORED
    • STOPPED
    *)
  7. status : execution_status option;
    (*

    The test's status.

    Allowed values include:

    • PENDING
    • PENDING_CONCURRENCY
    • PENDING_DEVICE
    • PROCESSING
    • SCHEDULING
    • PREPARING
    • RUNNING
    • COMPLETED
    • STOPPING
    *)
  8. created : date_time option;
    (*

    When the test was created.

    *)
  9. type_ : test_type option;
    (*

    The test's type.

    Must be one of the following values:

    • BUILTIN_FUZZ
    • APPIUM_JAVA_JUNIT
    • APPIUM_JAVA_TESTNG
    • APPIUM_PYTHON
    • APPIUM_NODE
    • APPIUM_RUBY
    • APPIUM_WEB_JAVA_JUNIT
    • APPIUM_WEB_JAVA_TESTNG
    • APPIUM_WEB_PYTHON
    • APPIUM_WEB_NODE
    • APPIUM_WEB_RUBY
    • INSTRUMENTATION
    • XCTEST
    • XCTEST_UI
    *)
  10. name : name option;
    (*

    The test's name.

    *)
  11. arn : amazon_resource_name option;
    (*

    The test's ARN.

    *)
}

Represents a condition that is evaluated.

type nonrec tests = test list
type nonrec test_parameters = (string_ * string_) list
type nonrec test_grid_url_expires_in_seconds_input = int
type nonrec test_grid_session_status =
  1. | ERRORED
  2. | CLOSED
  3. | ACTIVE
type nonrec test_grid_session = {
  1. selenium_properties : string_ option;
    (*

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

    *)
  2. billing_minutes : double option;
    (*

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

    *)
  3. ended : date_time option;
    (*

    The time the session ended.

    *)
  4. created : date_time option;
    (*

    The time that the session was started.

    *)
  5. status : test_grid_session_status option;
    (*

    The state of the session.

    *)
  6. arn : device_farm_arn option;
    (*

    The ARN of the session.

    *)
}

A TestGridSession is a single instance of a browser launched from the URL provided by a call to CreateTestGridUrl.

type nonrec test_grid_sessions = test_grid_session list
type nonrec test_grid_session_artifact_type =
  1. | SELENIUM_LOG
  2. | VIDEO
  3. | UNKNOWN
type nonrec sensitive_string = string
type nonrec test_grid_session_artifact = {
  1. url : sensitive_string option;
    (*

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

    *)
  2. type_ : test_grid_session_artifact_type option;
    (*

    The kind of artifact.

    *)
  3. filename : string_ option;
    (*

    The file name of the artifact.

    *)
}

Artifacts are video and other files that are produced in the process of running a browser in an automated context.

Video elements might be broken up into multiple artifacts as they grow in size during creation.

type nonrec test_grid_session_artifacts = test_grid_session_artifact list
type nonrec test_grid_session_artifact_category =
  1. | LOG
  2. | VIDEO
type nonrec test_grid_session_action = {
  1. request_method : string_ option;
    (*

    HTTP method that the browser used to make the request.

    *)
  2. status_code : string_ option;
    (*

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

    *)
  3. duration : long option;
    (*

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

    *)
  4. started : date_time option;
    (*

    The time that the session invoked the action.

    *)
  5. action : string_ option;
    (*

    The action taken by the session.

    *)
}

An action taken by a TestGridSession browser instance.

type nonrec test_grid_session_actions = test_grid_session_action list
type nonrec test_grid_projects = test_grid_project list
type nonrec tag_value = string
type nonrec tag_resource_response = unit
type nonrec tag = {
  1. value : tag_value;
    (*

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

    *)
  2. key : tag_key;
    (*

    One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

    *)
}

The metadata that you apply to a resource to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.

type nonrec tag_list = tag list
type nonrec tag_resource_request = {
  1. tags : tag_list;
    (*

    The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.

    *)
  2. resource_ar_n : device_farm_arn;
    (*

    The Amazon Resource Name (ARN) of the resource or resources to which to add tags. You can associate tags with the following Device Farm resources: PROJECT, TESTGRID_PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.

    *)
}
type nonrec tag_policy_exception = {
  1. resource_name : amazon_resource_name option;
  2. message : exception_message option;
}

The request doesn't comply with the AWS Identity and Access Management (IAM) tag policy. Correct your request and then retry it.

type nonrec suite = {
  1. device_minutes : device_minutes option;
    (*

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

    *)
  2. message : message option;
    (*

    A message about the suite's result.

    *)
  3. counters : counters option;
    (*

    The suite's result counters.

    *)
  4. stopped : date_time option;
    (*

    The suite's stop time.

    *)
  5. started : date_time option;
    (*

    The suite's start time.

    *)
  6. result_ : execution_result option;
    (*

    The suite's result.

    Allowed values include:

    • PENDING
    • PASSED
    • WARNED
    • FAILED
    • SKIPPED
    • ERRORED
    • STOPPED
    *)
  7. status : execution_status option;
    (*

    The suite's status.

    Allowed values include:

    • PENDING
    • PENDING_CONCURRENCY
    • PENDING_DEVICE
    • PROCESSING
    • SCHEDULING
    • PREPARING
    • RUNNING
    • COMPLETED
    • STOPPING
    *)
  8. created : date_time option;
    (*

    When the suite was created.

    *)
  9. type_ : test_type option;
    (*

    The suite's type.

    Must be one of the following values:

    • BUILTIN_FUZZ
    • APPIUM_JAVA_JUNIT
    • APPIUM_JAVA_TESTNG
    • APPIUM_PYTHON
    • APPIUM_NODE
    • APPIUM_RUBY
    • APPIUM_WEB_JAVA_JUNIT
    • APPIUM_WEB_JAVA_TESTNG
    • APPIUM_WEB_PYTHON
    • APPIUM_WEB_NODE
    • APPIUM_WEB_RUBY
    • INSTRUMENTATION
    • XCTEST
    • XCTEST_UI
    *)
  10. name : name option;
    (*

    The suite's name.

    *)
  11. arn : amazon_resource_name option;
    (*

    The suite's ARN.

    *)
}

Represents a collection of one or more tests.

type nonrec suites = suite list
type nonrec billing_method =
  1. | UNMETERED
  2. | METERED
type nonrec device_proxy_host = string
type nonrec device_proxy_port = int
type nonrec device_proxy = {
  1. port : device_proxy_port;
    (*

    The port number on which the http/s proxy is listening.

    *)
  2. host : device_proxy_host;
    (*

    Hostname or IPv4 address of the proxy.

    *)
}

Represents the http/s proxy configuration that will be applied to a device during a run.

type nonrec execution_result_code =
  1. | VPC_ENDPOINT_SETUP_FAILED
  2. | PARSING_FAILED
type nonrec radios = {
  1. gps : boolean_ option;
    (*

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

    *)
  2. nfc : boolean_ option;
    (*

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

    *)
  3. bluetooth : boolean_ option;
    (*

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

    *)
  4. wifi : boolean_ option;
    (*

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

    *)
}

Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.

type nonrec location = {
  1. longitude : double;
    (*

    The longitude.

    *)
  2. latitude : double;
    (*

    The latitude.

    *)
}

Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example, 47.6204, -122.3491).

Elevation is currently not supported.

type nonrec ios_paths = string_ list
type nonrec android_paths = string_ list
type nonrec device_host_paths = string_ list
type nonrec customer_artifact_paths = {
  1. device_host_paths : device_host_paths option;
    (*

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

    *)
  2. android_paths : android_paths option;
    (*

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

    *)
  3. ios_paths : ios_paths option;
    (*

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

    *)
}

A JSON object that specifies the paths where the artifacts generated by the customer's tests, on the device or in the test environment, are pulled from.

Specify deviceHostPaths and optionally specify either iosPaths or androidPaths.

For web app tests, you can specify both iosPaths and androidPaths.

type nonrec skip_app_resign = bool
type nonrec device_filter_attribute =
  1. | FLEET_TYPE
  2. | INSTANCE_LABELS
  3. | INSTANCE_ARN
  4. | REMOTE_DEBUG_ENABLED
  5. | REMOTE_ACCESS_ENABLED
  6. | MANUFACTURER
  7. | FORM_FACTOR
  8. | AVAILABILITY
  9. | MODEL
  10. | OS_VERSION
  11. | PLATFORM
  12. | ARN
type nonrec device_filter_values = string_ list
type nonrec device_filter = {
  1. values : device_filter_values;
    (*

    An array of one or more filter values used in a device filter.

    Operator Values

    • The IN and NOT_IN operators can take a values array that has more than one element.
    • The other operators require an array with a single element.

    Attribute Values

    • The PLATFORM attribute can be set to ANDROID or IOS.
    • The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
    • The FORM_FACTOR attribute can be set to PHONE or TABLET.
    • The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.
    *)
  2. operator : rule_operator;
    (*

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

    *)
  3. attribute : device_filter_attribute;
    (*

    The aspect of a device such as platform or model used as the selection criteria in a device filter.

    The supported operators for each attribute are provided in the following list.

    ARN The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).

    Supported operators: EQUALS, IN, NOT_IN

    PLATFORM The device platform. Valid values are ANDROID or IOS.

    Supported operators: EQUALS

    OS_VERSION The operating system version (for example, 10.3.2).

    Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

    MODEL The device model (for example, iPad 5th Gen).

    Supported operators: CONTAINS, EQUALS, IN, NOT_IN

    AVAILABILITY The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

    Supported operators: EQUALS

    FORM_FACTOR The device form factor. Valid values are PHONE or TABLET.

    Supported operators: EQUALS

    MANUFACTURER The device manufacturer (for example, Apple).

    Supported operators: EQUALS, IN, NOT_IN

    REMOTE_ACCESS_ENABLED Whether the device is enabled for remote access. Valid values are TRUE or FALSE.

    Supported operators: EQUALS

    REMOTE_DEBUG_ENABLED Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.

    Supported operators: EQUALS

    Because remote debugging is no longer supported, this filter is ignored.

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

    Supported operators: EQUALS, IN, NOT_IN

    INSTANCE_LABELS The label of the device instance.

    Supported operators: CONTAINS

    FLEET_TYPE The fleet type. Valid values are PUBLIC or PRIVATE.

    Supported operators: EQUALS

    *)
}

Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the deviceSelectionConfiguration parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.

It is also passed in as the filters parameter to ListDevices. For an example of the JSON request syntax, see ListDevices.

type nonrec device_filters = device_filter list
type nonrec device_selection_result = {
  1. max_devices : integer option;
    (*

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

    *)
  2. matched_devices_count : integer option;
    (*

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

    *)
  3. filters : device_filters option;
    (*

    The filters in a device selection result.

    *)
}

Contains the run results requested by the device selection configuration and how many devices were returned. For an example of the JSON response syntax, see ScheduleRun.

type nonrec run = {
  1. environment_variables : environment_variables option;
    (*

    Environment variables associated with the run.

    *)
  2. execution_role_arn : amazon_role_resource_name option;
    (*

    The IAM role associated with the run.

    *)
  3. vpc_config : vpc_config option;
    (*

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

    *)
  4. device_selection_result : device_selection_result option;
    (*

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

    *)
  5. test_spec_arn : amazon_resource_name option;
    (*

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

    *)
  6. skip_app_resign : skip_app_resign option;
    (*

    When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

    For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

    *)
  7. web_url : string_ option;
    (*

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

    *)
  8. customer_artifact_paths : customer_artifact_paths option;
    (*

    Output CustomerArtifactPaths object for the test run.

    *)
  9. location : location option;
    (*

    Information about the location that is used for the run.

    *)
  10. radios : radios option;
    (*

    Information about the radio states for the run.

    *)
  11. locale : string_ option;
    (*

    Information about the locale that is used for the run.

    *)
  12. device_pool_arn : amazon_resource_name option;
    (*

    The ARN of the device pool for the run.

    *)
  13. job_timeout_minutes : job_timeout_minutes option;
    (*

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

    *)
  14. event_count : integer option;
    (*

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

    *)
  15. app_upload : amazon_resource_name option;
    (*

    An app to upload or that has been uploaded.

    *)
  16. seed : integer option;
    (*

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

    *)
  17. result_code : execution_result_code option;
    (*

    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.

    *)
  18. parsing_result_url : string_ option;
    (*

    Read-only URL for an object in an S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.

    *)
  19. device_proxy : device_proxy option;
    (*

    The device proxy configured for the devices in the run.

    *)
  20. network_profile : network_profile option;
    (*

    The network profile being used for a test run.

    *)
  21. device_minutes : device_minutes option;
    (*

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

    *)
  22. billing_method : billing_method option;
    (*

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

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

    *)
  23. completed_jobs : integer option;
    (*

    The total number of completed jobs.

    *)
  24. total_jobs : integer option;
    (*

    The total number of jobs for the run.

    *)
  25. message : message option;
    (*

    A message about the run's result.

    *)
  26. counters : counters option;
    (*

    The run's result counters.

    *)
  27. stopped : date_time option;
    (*

    The run's stop time.

    *)
  28. started : date_time option;
    (*

    The run's start time.

    *)
  29. result_ : execution_result option;
    (*

    The run's result.

    Allowed values include:

    • PENDING
    • PASSED
    • WARNED
    • FAILED
    • SKIPPED
    • ERRORED
    • STOPPED
    *)
  30. status : execution_status option;
    (*

    The run's status.

    Allowed values include:

    • PENDING
    • PENDING_CONCURRENCY
    • PENDING_DEVICE
    • PROCESSING
    • SCHEDULING
    • PREPARING
    • RUNNING
    • COMPLETED
    • STOPPING
    *)
  31. created : date_time option;
    (*

    When the run was created.

    *)
  32. platform : device_platform option;
    (*

    The run's platform.

    Allowed values include:

    • ANDROID
    • IOS
    *)
  33. type_ : test_type option;
    (*

    The run's type.

    Must be one of the following values:

    • BUILTIN_FUZZ
    • APPIUM_JAVA_JUNIT
    • APPIUM_JAVA_TESTNG
    • APPIUM_PYTHON
    • APPIUM_NODE
    • APPIUM_RUBY
    • APPIUM_WEB_JAVA_JUNIT
    • APPIUM_WEB_JAVA_TESTNG
    • APPIUM_WEB_PYTHON
    • APPIUM_WEB_NODE
    • APPIUM_WEB_RUBY
    • INSTRUMENTATION
    • XCTEST
    • XCTEST_UI
    *)
  34. name : name option;
    (*

    The run's name.

    *)
  35. arn : amazon_resource_name option;
    (*

    The run's ARN.

    *)
}

Represents a test run on a set of devices with a given app package, test parameters, and so on.

type nonrec stop_run_result = {
  1. run : run option;
    (*

    The run that was stopped.

    *)
}

Represents the results of your stop run attempt.

type nonrec stop_run_request = {
  1. arn : amazon_resource_name;
    (*

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

    *)
}

Represents the request to stop a specific run.

type nonrec interaction_mode =
  1. | VIDEO_ONLY
  2. | NO_VIDEO
  3. | INTERACTIVE
type nonrec remote_access_endpoints = {
  1. interactive_endpoint : sensitive_ur_l option;
    (*

    URL for viewing and interacting with the device during the remote access session.

    *)
  2. remote_driver_endpoint : sensitive_ur_l option;
    (*

    URL for controlling the device using WebDriver-compliant clients, like Appium, during the remote access session.

    *)
}

Represents the remote endpoints for viewing and controlling a device during a remote access session.

type nonrec remote_access_session = {
  1. endpoints : remote_access_endpoints option;
  2. app_upload : amazon_resource_name option;
    (*

    The ARN for the app to be installed onto your device.

    *)
  3. device_proxy : device_proxy option;
    (*

    The device proxy configured for the remote access session.

    *)
  4. vpc_config : vpc_config option;
    (*

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

    *)
  5. skip_app_resign : skip_app_resign option;
    (*

    When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

    For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

    *)
  6. interaction_mode : interaction_mode option;
    (*

    The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available.

    *)
  7. device_udid : string_ option;
    (*

    Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.

    Remote debugging is no longer supported.

    *)
  8. endpoint : string_ option;
    (*

    The endpoint for the remote access session. This field is deprecated, and is replaced by the new endpoints.interactiveEndpoint field.

    *)
  9. device_minutes : device_minutes option;
    (*

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

    *)
  10. billing_method : billing_method option;
    (*

    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.

    *)
  11. instance_arn : amazon_resource_name option;
    (*

    The ARN of the instance.

    *)
  12. device : device option;
    (*

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

    *)
  13. stopped : date_time option;
    (*

    The date and time the remote access session was stopped.

    *)
  14. started : date_time option;
    (*

    The date and time the remote access session was started.

    *)
  15. message : message option;
    (*

    A message about the remote access session.

    *)
  16. result_ : execution_result option;
    (*

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

    • PENDING.
    • PASSED.
    • WARNED.
    • FAILED.
    • SKIPPED.
    • ERRORED.
    • STOPPED.
    *)
  17. status : execution_status option;
    (*

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

    • PENDING.
    • PENDING_CONCURRENCY.
    • PENDING_DEVICE.
    • PROCESSING.
    • SCHEDULING.
    • PREPARING.
    • RUNNING.
    • COMPLETED.
    • STOPPING.
    *)
  18. created : date_time option;
    (*

    The date and time the remote access session was created.

    *)
  19. name : name option;
    (*

    The name of the remote access session.

    *)
  20. arn : amazon_resource_name option;
    (*

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

    *)
}

Represents information about the remote access session.

type nonrec stop_remote_access_session_result = {
  1. remote_access_session : remote_access_session option;
    (*

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

    *)
}

Represents the response from the server that describes the remote access session when AWS Device Farm stops the session.

type nonrec stop_remote_access_session_request = {
  1. arn : amazon_resource_name;
    (*

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

    *)
}

Represents the request to stop the remote access session.

type nonrec job = {
  1. video_capture : video_capture option;
    (*

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

    *)
  2. video_endpoint : string_ option;
    (*

    The endpoint for streaming device video.

    *)
  3. device_minutes : device_minutes option;
    (*

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

    *)
  4. instance_arn : amazon_resource_name option;
    (*

    The ARN of the instance.

    *)
  5. device : device option;
    (*

    The device (phone or tablet).

    *)
  6. message : message option;
    (*

    A message about the job's result.

    *)
  7. counters : counters option;
    (*

    The job's result counters.

    *)
  8. stopped : date_time option;
    (*

    The job's stop time.

    *)
  9. started : date_time option;
    (*

    The job's start time.

    *)
  10. result_ : execution_result option;
    (*

    The job's result.

    Allowed values include:

    • PENDING
    • PASSED
    • WARNED
    • FAILED
    • SKIPPED
    • ERRORED
    • STOPPED
    *)
  11. status : execution_status option;
    (*

    The job's status.

    Allowed values include:

    • PENDING
    • PENDING_CONCURRENCY
    • PENDING_DEVICE
    • PROCESSING
    • SCHEDULING
    • PREPARING
    • RUNNING
    • COMPLETED
    • STOPPING
    *)
  12. created : date_time option;
    (*

    When the job was created.

    *)
  13. type_ : test_type option;
    (*

    The job's type.

    Allowed values include the following:

    • BUILTIN_FUZZ
    • APPIUM_JAVA_JUNIT
    • APPIUM_JAVA_TESTNG
    • APPIUM_PYTHON
    • APPIUM_NODE
    • APPIUM_RUBY
    • APPIUM_WEB_JAVA_JUNIT
    • APPIUM_WEB_JAVA_TESTNG
    • APPIUM_WEB_PYTHON
    • APPIUM_WEB_NODE
    • APPIUM_WEB_RUBY
    • INSTRUMENTATION
    • XCTEST
    • XCTEST_UI
    *)
  14. name : name option;
    (*

    The job's name.

    *)
  15. arn : amazon_resource_name option;
    (*

    The job's ARN.

    *)
}

Represents a device.

type nonrec stop_job_result = {
  1. job : job option;
    (*

    The job that was stopped.

    *)
}
type nonrec stop_job_request = {
  1. arn : amazon_resource_name;
    (*

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

    *)
}
type nonrec filter = string
type nonrec schedule_run_test = {
  1. parameters : test_parameters option;
    (*

    The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.

    For all tests:

    • app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to false to disable it.

    For Appium tests (all types):

    • appium_version: The Appium version. Currently supported values are 1.6.5 (and later), latest, and default.

      • latest runs the latest Appium version supported by Device Farm (1.9.1).
      • For default, Device Farm selects a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier and 1.7.2 for iOS 10 and later.
      • This behavior is subject to change.

    For fuzz tests (Android only):

    • event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.
    • throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.
    • seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.

    For 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
    *)
  2. filter : filter option;
    (*

    The test's filter.

    *)
  3. test_spec_arn : amazon_resource_name option;
    (*

    The ARN of the YAML-formatted test specification.

    *)
  4. test_package_arn : amazon_resource_name option;
    (*

    The ARN of the uploaded test to be run.

    *)
  5. type_ : test_type;
    (*

    The test's type.

    Must be one of the following values:

    • BUILTIN_FUZZ
    • APPIUM_JAVA_JUNIT
    • APPIUM_JAVA_TESTNG
    • APPIUM_PYTHON
    • APPIUM_NODE
    • APPIUM_RUBY
    • APPIUM_WEB_JAVA_JUNIT
    • APPIUM_WEB_JAVA_TESTNG
    • APPIUM_WEB_PYTHON
    • APPIUM_WEB_NODE
    • APPIUM_WEB_RUBY
    • INSTRUMENTATION
    • XCTEST
    • XCTEST_UI
    *)
}

Represents test settings. This data structure is passed in as the test parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.

type nonrec schedule_run_result = {
  1. run : run option;
    (*

    Information about the scheduled run.

    *)
}

Represents the result of a schedule run request.

type nonrec device_selection_configuration = {
  1. max_devices : integer;
    (*

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

    *)
  2. filters : device_filters;
    (*

    Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values.

    • Attribute

      The aspect of a device such as platform or model used as the selection criteria in a device filter.

      Allowed values include:

      • ARN: The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).
      • PLATFORM: The device platform. Valid values are ANDROID or IOS.
      • OS_VERSION: The operating system version (for example, 10.3.2).
      • MODEL: The device model (for example, iPad 5th Gen).
      • AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
      • FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.
      • MANUFACTURER: The device manufacturer (for example, Apple).
      • REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
      • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is no longer supported, this filter is ignored.
      • INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
      • INSTANCE_LABELS: The label of the device instance.
      • FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.
    • Operator

      The filter operator.

      • The EQUALS operator is available for every attribute except INSTANCE_LABELS.
      • The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.
      • The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.
      • The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.
    • Values

      An array of one or more filter values.

      Operator Values

      • The IN and NOT_IN operators can take a values array that has more than one element.
      • The other operators require an array with a single element.

      Attribute Values

      • The PLATFORM attribute can be set to ANDROID or IOS.
      • The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
      • The FORM_FACTOR attribute can be set to PHONE or TABLET.
      • The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.
    *)
}

Represents the device filters used in a test run and the maximum number of devices to be included in the run. It is passed in as the deviceSelectionConfiguration request parameter in ScheduleRun.

type nonrec amazon_resource_names = amazon_resource_name list
type nonrec schedule_run_configuration = {
  1. execution_role_arn : amazon_role_resource_name option;
    (*

    An IAM role to be assumed by the test host for the run.

    *)
  2. environment_variables : environment_variables option;
    (*

    Environment variables associated with the run.

    *)
  3. billing_method : billing_method option;
    (*

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

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

    *)
  4. auxiliary_apps : amazon_resource_names option;
    (*

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

    *)
  5. radios : radios option;
    (*

    Information about the radio states for the run.

    *)
  6. customer_artifact_paths : customer_artifact_paths option;
    (*

    Input CustomerArtifactPaths object for the scheduled run configuration.

    *)
  7. device_proxy : device_proxy option;
    (*

    The device proxy to be configured on the device for the run.

    *)
  8. vpce_configuration_arns : amazon_resource_names option;
    (*

    An array of ARNs for your VPC endpoint configurations.

    *)
  9. location : location option;
    (*

    Information about the location that is used for the run.

    *)
  10. locale : string_ option;
    (*

    Information about the locale that is used for the run.

    *)
  11. network_profile_arn : amazon_resource_name option;
    (*

    Reserved for internal use.

    *)
  12. extra_data_package_arn : amazon_resource_name option;
    (*

    The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm extracts to external data for Android or the app's sandbox for iOS.

    *)
}

Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles.

type nonrec accounts_cleanup = bool
type nonrec app_packages_cleanup = bool
type nonrec execution_configuration = {
  1. skip_app_resign : skip_app_resign option;
    (*

    When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

    For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

    *)
  2. video_capture : video_capture option;
    (*

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

    *)
  3. app_packages_cleanup : app_packages_cleanup option;
    (*

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

    *)
  4. accounts_cleanup : accounts_cleanup option;
    (*

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

    *)
  5. job_timeout_minutes : job_timeout_minutes option;
    (*

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

    *)
}

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

type nonrec schedule_run_request = {
  1. execution_configuration : execution_configuration option;
    (*

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

    *)
  2. configuration : schedule_run_configuration option;
    (*

    Information about the settings for the run to be scheduled.

    *)
  3. test : schedule_run_test;
    (*

    Information about the test for the run to be scheduled.

    *)
  4. name : name option;
    (*

    The name for the run to be scheduled.

    *)
  5. device_selection_configuration : device_selection_configuration option;
    (*

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

    Either devicePoolArn or deviceSelectionConfiguration is required in a request.

    *)
  6. device_pool_arn : amazon_resource_name option;
    (*

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

    *)
  7. app_arn : amazon_resource_name option;
    (*

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

    *)
  8. project_arn : amazon_resource_name;
    (*

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

    *)
}

Represents a request to the schedule run operation.

type nonrec idempotency_exception = {
  1. message : message option;
    (*

    Any additional information about the exception.

    *)
}

An entity with the same name already exists.

type nonrec sample_type =
  1. | OPENGL_MAX_DRAWTIME
  2. | OPENGL_AVG_DRAWTIME
  3. | OPENGL_MIN_DRAWTIME
  4. | OPENGL_FPS
  5. | OPENGL_FRAMES
  6. | NATIVE_MAX_DRAWTIME
  7. | NATIVE_AVG_DRAWTIME
  8. | NATIVE_MIN_DRAWTIME
  9. | NATIVE_FPS
  10. | NATIVE_FRAMES
  11. | TX
  12. | RX
  13. | TX_RATE
  14. | RX_RATE
  15. | THREADS
  16. | MEMORY
  17. | CPU
type nonrec sample = {
  1. url : ur_l option;
    (*

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

    *)
  2. type_ : sample_type option;
    (*

    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.
    *)
  3. arn : amazon_resource_name option;
    (*

    The sample's ARN.

    *)
}

Represents a sample of performance data.

type nonrec samples = sample list
type nonrec runs = run list
type nonrec resource_id = string
type nonrec offering_transaction_type =
  1. | SYSTEM
  2. | RENEW
  3. | PURCHASE
type nonrec offering_identifier = string
type nonrec offering_type =
  1. | RECURRING
type nonrec currency_code =
  1. | USD
type nonrec monetary_amount = {
  1. currency_code : currency_code option;
    (*

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

    *)
  2. amount : double option;
    (*

    The numerical amount of an offering or transaction.

    *)
}

A number that represents the monetary amount for an offering or transaction.

type nonrec recurring_charge_frequency =
  1. | MONTHLY
type nonrec recurring_charge = {
  1. frequency : recurring_charge_frequency option;
    (*

    The frequency in which charges recur.

    *)
  2. cost : monetary_amount option;
    (*

    The cost of the recurring charge.

    *)
}

Specifies whether charges for devices are recurring.

type nonrec recurring_charges = recurring_charge list
type nonrec offering = {
  1. recurring_charges : recurring_charges option;
    (*

    Specifies whether there are recurring charges for the offering.

    *)
  2. platform : device_platform option;
    (*

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

    *)
  3. type_ : offering_type option;
    (*

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

    *)
  4. description : message option;
    (*

    A string that describes the offering.

    *)
  5. id : offering_identifier option;
    (*

    The ID that corresponds to a device offering.

    *)
}

Represents the metadata of a device offering.

type nonrec offering_status = {
  1. effective_on : date_time option;
    (*

    The date on which the offering is effective.

    *)
  2. quantity : integer option;
    (*

    The number of available devices in the offering.

    *)
  3. offering : offering option;
    (*

    Represents the metadata of an offering status.

    *)
  4. type_ : offering_transaction_type option;
    (*

    The type specified for the offering status.

    *)
}

The status of the offering.

type nonrec offering_promotion_identifier = string
type nonrec offering_transaction = {
  1. cost : monetary_amount option;
    (*

    The cost of an offering transaction.

    *)
  2. created_on : date_time option;
    (*

    The date on which an offering transaction was created.

    *)
  3. offering_promotion_id : offering_promotion_identifier option;
    (*

    The ID that corresponds to a device offering promotion.

    *)
  4. transaction_id : transaction_identifier option;
    (*

    The transaction ID of the offering transaction.

    *)
  5. offering_status : offering_status option;
    (*

    The status of an offering transaction.

    *)
}

Represents the metadata of an offering transaction.

type nonrec renew_offering_result = {
  1. offering_transaction : offering_transaction option;
    (*

    Represents the status of the offering transaction for the renewal.

    *)
}

The result of a renewal offering.

type nonrec renew_offering_request = {
  1. quantity : integer;
    (*

    The quantity requested in an offering renewal.

    *)
  2. offering_id : offering_identifier;
    (*

    The ID of a request to renew an offering.

    *)
}

A request that represents an offering renewal.

type nonrec not_eligible_exception = {
  1. message : message option;
    (*

    The HTTP response code of a Not Eligible exception.

    *)
}

Exception gets thrown when a user is not eligible to perform the specified transaction.

type nonrec remote_access_sessions = remote_access_session list
type nonrec purchased_devices_map = (device_platform * integer) list
type nonrec purchase_offering_result = {
  1. offering_transaction : offering_transaction option;
    (*

    Represents the offering transaction for the purchase result.

    *)
}

The result of the purchase offering (for example, success or failure).

type nonrec purchase_offering_request = {
  1. offering_promotion_id : offering_promotion_identifier option;
    (*

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

    *)
  2. quantity : integer;
    (*

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

    *)
  3. offering_id : offering_identifier;
    (*

    The ID of the offering.

    *)
}

Represents a request for a purchase offering.

type nonrec projects = project list
type nonrec pagination_token = string
type nonrec offerings = offering list
type nonrec offering_transactions = offering_transaction list
type nonrec offering_status_map = (offering_identifier * offering_status) list
type nonrec offering_promotion = {
  1. description : message option;
    (*

    A string that describes the offering promotion.

    *)
  2. id : offering_promotion_identifier option;
    (*

    The ID of the offering promotion.

    *)
}

Represents information about an offering promotion.

type nonrec offering_promotions = offering_promotion list
type nonrec network_profiles = network_profile list
type nonrec max_slot_map = (string_ * integer) list
type nonrec max_page_size = int
type nonrec list_vpce_configurations_result = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. vpce_configurations : vpce_configurations option;
    (*

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

    *)
}
type nonrec list_vpce_configurations_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. max_results : integer option;
    (*

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

    *)
}
type nonrec list_uploads_result = {
  1. next_token : pagination_token option;
    (*

    If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

    *)
  2. uploads : uploads option;
    (*

    Information about the uploads.

    *)
}

Represents the result of a list uploads request.

type nonrec list_uploads_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. type_ : upload_type option;
    (*

    The type of upload.

    Must be one of the following values:

    • ANDROID_APP
    • IOS_APP
    • WEB_APP
    • EXTERNAL_DATA
    • APPIUM_JAVA_JUNIT_TEST_PACKAGE
    • APPIUM_JAVA_TESTNG_TEST_PACKAGE
    • APPIUM_PYTHON_TEST_PACKAGE
    • APPIUM_NODE_TEST_PACKAGE
    • APPIUM_RUBY_TEST_PACKAGE
    • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE
    • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE
    • APPIUM_WEB_PYTHON_TEST_PACKAGE
    • APPIUM_WEB_NODE_TEST_PACKAGE
    • APPIUM_WEB_RUBY_TEST_PACKAGE
    • INSTRUMENTATION_TEST_PACKAGE
    • XCTEST_TEST_PACKAGE
    • XCTEST_UI_TEST_PACKAGE
    • APPIUM_JAVA_JUNIT_TEST_SPEC
    • APPIUM_JAVA_TESTNG_TEST_SPEC
    • APPIUM_PYTHON_TEST_SPEC
    • APPIUM_NODE_TEST_SPEC
    • APPIUM_RUBY_TEST_SPEC
    • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC
    • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC
    • APPIUM_WEB_PYTHON_TEST_SPEC
    • APPIUM_WEB_NODE_TEST_SPEC
    • APPIUM_WEB_RUBY_TEST_SPEC
    • INSTRUMENTATION_TEST_SPEC
    • XCTEST_UI_TEST_SPEC
    *)
  3. arn : amazon_resource_name;
    (*

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

    *)
}

Represents a request to the list uploads operation.

type nonrec list_unique_problems_result = {
  1. next_token : pagination_token option;
    (*

    If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

    *)
  2. unique_problems : unique_problems_by_execution_result_map option;
    (*

    Information about the unique problems.

    Allowed values include:

    • PENDING
    • PASSED
    • WARNED
    • FAILED
    • SKIPPED
    • ERRORED
    • STOPPED
    *)
}

Represents the result of a list unique problems request.

type nonrec list_unique_problems_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. arn : amazon_resource_name;
    (*

    The unique problems' ARNs.

    *)
}

Represents a request to the list unique problems operation.

type nonrec list_tests_result = {
  1. next_token : pagination_token option;
    (*

    If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

    *)
  2. tests : tests option;
    (*

    Information about the tests.

    *)
}

Represents the result of a list tests request.

type nonrec list_tests_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. arn : amazon_resource_name;
    (*

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

    *)
}

Represents a request to the list tests operation.

type nonrec list_test_grid_sessions_result = {
  1. next_token : pagination_token option;
    (*

    Pagination token.

    *)
  2. test_grid_sessions : test_grid_sessions option;
    (*

    The sessions that match the criteria in a ListTestGridSessionsRequest.

    *)
}
type nonrec list_test_grid_sessions_request = {
  1. next_token : pagination_token option;
    (*

    Pagination token.

    *)
  2. max_result : max_page_size option;
    (*

    Return only this many results at a time.

    *)
  3. end_time_before : date_time option;
    (*

    Return only sessions that ended before this time.

    *)
  4. end_time_after : date_time option;
    (*

    Return only sessions that ended after this time.

    *)
  5. creation_time_before : date_time option;
    (*

    Return only sessions created before this time.

    *)
  6. creation_time_after : date_time option;
    (*

    Return only sessions created after this time.

    *)
  7. status : test_grid_session_status option;
    (*

    Return only sessions in this state.

    *)
  8. project_arn : device_farm_arn;
    (*

    ARN of a TestGridProject.

    *)
}
type nonrec list_test_grid_session_artifacts_result = {
  1. next_token : pagination_token option;
    (*

    Pagination token.

    *)
  2. artifacts : test_grid_session_artifacts option;
    (*

    A list of test grid session artifacts for a TestGridSession.

    *)
}
type nonrec list_test_grid_session_artifacts_request = {
  1. next_token : pagination_token option;
    (*

    Pagination token.

    *)
  2. max_result : max_page_size option;
    (*

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

    *)
  3. type_ : test_grid_session_artifact_category option;
    (*

    Limit results to a specified type of artifact.

    *)
  4. session_arn : device_farm_arn;
    (*

    The ARN of a TestGridSession.

    *)
}
type nonrec list_test_grid_session_actions_result = {
  1. next_token : pagination_token option;
    (*

    Pagination token.

    *)
  2. actions : test_grid_session_actions option;
    (*

    The action taken by the session.

    *)
}
type nonrec list_test_grid_session_actions_request = {
  1. next_token : pagination_token option;
    (*

    Pagination token.

    *)
  2. max_result : max_page_size option;
    (*

    The maximum number of sessions to return per response.

    *)
  3. session_arn : device_farm_arn;
    (*

    The ARN of the session to retrieve.

    *)
}
type nonrec list_test_grid_projects_result = {
  1. next_token : pagination_token option;
    (*

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

    *)
  2. test_grid_projects : test_grid_projects option;
    (*

    The list of TestGridProjects, based on a ListTestGridProjectsRequest.

    *)
}
type nonrec list_test_grid_projects_request = {
  1. next_token : pagination_token option;
    (*

    From a response, used to continue a paginated listing.

    *)
  2. max_result : max_page_size option;
    (*

    Return no more than this number of results.

    *)
}
type nonrec list_tags_for_resource_response = {
  1. tags : tag_list option;
    (*

    The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.

    *)
}
type nonrec list_tags_for_resource_request = {
  1. resource_ar_n : device_farm_arn;
    (*

    The Amazon Resource Name (ARN) of the resource or resources for which to list tags. You can associate tags with the following Device Farm resources: PROJECT, TESTGRID_PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.

    *)
}
type nonrec list_suites_result = {
  1. next_token : pagination_token option;
    (*

    If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

    *)
  2. suites : suites option;
    (*

    Information about the suites.

    *)
}

Represents the result of a list suites request.

type nonrec list_suites_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. arn : amazon_resource_name;
    (*

    The job's Amazon Resource Name (ARN).

    *)
}

Represents a request to the list suites operation.

type nonrec list_samples_result = {
  1. next_token : pagination_token option;
    (*

    If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

    *)
  2. samples : samples option;
    (*

    Information about the samples.

    *)
}

Represents the result of a list samples request.

type nonrec list_samples_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. arn : amazon_resource_name;
    (*

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

    *)
}

Represents a request to the list samples operation.

type nonrec list_runs_result = {
  1. next_token : pagination_token option;
    (*

    If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

    *)
  2. runs : runs option;
    (*

    Information about the runs.

    *)
}

Represents the result of a list runs request.

type nonrec list_runs_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. arn : amazon_resource_name;
    (*

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

    *)
}

Represents a request to the list runs operation.

type nonrec list_remote_access_sessions_result = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. remote_access_sessions : remote_access_sessions option;
    (*

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

    *)
}

Represents the response from the server after AWS Device Farm makes a request to return information about the remote access session.

type nonrec list_remote_access_sessions_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. arn : amazon_resource_name;
    (*

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

    *)
}

Represents the request to return information about the remote access session.

type nonrec list_projects_result = {
  1. next_token : pagination_token option;
    (*

    If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

    *)
  2. projects : projects option;
    (*

    Information about the projects.

    *)
}

Represents the result of a list projects request.

type nonrec list_projects_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. arn : amazon_resource_name option;
    (*

    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.

    *)
}

Represents a request to the list projects operation.

type nonrec list_offerings_result = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. offerings : offerings option;
    (*

    A value that represents the list offering results.

    *)
}

Represents the return values of the list of offerings.

type nonrec list_offerings_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
}

Represents the request to list all offerings.

type nonrec list_offering_transactions_result = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. offering_transactions : offering_transactions option;
    (*

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

    *)
}

Returns the transaction log of the specified offerings.

type nonrec list_offering_transactions_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
}

Represents the request to list the offering transaction history.

type nonrec list_offering_promotions_result = {
  1. next_token : pagination_token option;
    (*

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

    *)
  2. offering_promotions : offering_promotions option;
    (*

    Information about the offering promotions.

    *)
}
type nonrec list_offering_promotions_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
}
type nonrec list_network_profiles_result = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. network_profiles : network_profiles option;
    (*

    A list of the available network profiles.

    *)
}
type nonrec list_network_profiles_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. type_ : network_profile_type option;
    (*

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

    *)
  3. arn : amazon_resource_name;
    (*

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

    *)
}
type nonrec jobs = job list
type nonrec list_jobs_result = {
  1. next_token : pagination_token option;
    (*

    If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

    *)
  2. jobs : jobs option;
    (*

    Information about the jobs.

    *)
}

Represents the result of a list jobs request.

type nonrec list_jobs_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. arn : amazon_resource_name;
    (*

    The run's Amazon Resource Name (ARN).

    *)
}

Represents a request to the list jobs operation.

type nonrec instance_profiles = instance_profile list
type nonrec list_instance_profiles_result = {
  1. next_token : pagination_token option;
    (*

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

    *)
  2. instance_profiles : instance_profiles option;
    (*

    An object that contains information about your instance profiles.

    *)
}
type nonrec list_instance_profiles_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. max_results : integer option;
    (*

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

    *)
}
type nonrec devices = device list
type nonrec list_devices_result = {
  1. next_token : pagination_token option;
    (*

    If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

    *)
  2. devices : devices option;
    (*

    Information about the devices.

    *)
}

Represents the result of a list devices operation.

type nonrec list_devices_request = {
  1. filters : device_filters option;
    (*

    Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.

    • Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.

      Allowed values include:

      • ARN: The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).
      • PLATFORM: The device platform. Valid values are ANDROID or IOS.
      • OS_VERSION: The operating system version (for example, 10.3.2).
      • MODEL: The device model (for example, iPad 5th Gen).
      • AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
      • FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.
      • MANUFACTURER: The device manufacturer (for example, Apple).
      • REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
      • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is no longer supported, this attribute is ignored.
      • INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
      • INSTANCE_LABELS: The label of the device instance.
      • FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.
    • Operator: The filter operator.

      • The EQUALS operator is available for every attribute except INSTANCE_LABELS.
      • The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.
      • The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.
      • The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.
    • Values: An array of one or more filter values.

      • The IN and NOT_IN operators take a values array that has one or more elements.
      • The other operators require an array with a single element.
      • In a request, the AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
    *)
  2. next_token : pagination_token option;
    (*

    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.

    *)
  3. arn : amazon_resource_name option;
    (*

    The Amazon Resource Name (ARN) of the project.

    *)
}

Represents the result of a list devices request.

type nonrec device_pools = device_pool list
type nonrec list_device_pools_result = {
  1. next_token : pagination_token option;
    (*

    If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

    *)
  2. device_pools : device_pools option;
    (*

    Information about the device pools.

    *)
}

Represents the result of a list device pools request.

type nonrec list_device_pools_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. type_ : device_pool_type option;
    (*

    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.
    *)
  3. arn : amazon_resource_name;
    (*

    The project ARN.

    *)
}

Represents the result of a list device pools request.

type nonrec list_device_instances_result = {
  1. next_token : pagination_token option;
    (*

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

    *)
  2. device_instances : device_instances option;
    (*

    An object that contains information about your device instances.

    *)
}
type nonrec list_device_instances_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. max_results : integer option;
    (*

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

    *)
}
type nonrec artifact_type =
  1. | TESTSPEC_OUTPUT
  2. | CUSTOMER_ARTIFACT_LOG
  3. | CUSTOMER_ARTIFACT
  4. | VIDEO
  5. | XCTEST_LOG
  6. | APPLICATION_CRASH_REPORT
  7. | EXPLORER_SUMMARY_LOG
  8. | EXPLORER_EVENT_LOG
  9. | APPIUM_PYTHON_XML_OUTPUT
  10. | APPIUM_PYTHON_OUTPUT
  11. | APPIUM_JAVA_XML_OUTPUT
  12. | APPIUM_JAVA_OUTPUT
  13. | APPIUM_SERVER_OUTPUT
  14. | AUTOMATION_OUTPUT
  15. | CALABASH_JAVA_XML_OUTPUT
  16. | CALABASH_STANDARD_OUTPUT
  17. | CALABASH_PRETTY_OUTPUT
  18. | CALABASH_JSON_OUTPUT
  19. | EXERCISER_MONKEY_OUTPUT
  20. | INSTRUMENTATION_OUTPUT
  21. | WEBKIT_LOG
  22. | SERVICE_LOG
  23. | RESULT_LOG
  24. | VIDEO_LOG
  25. | MESSAGE_LOG
  26. | DEVICE_LOG
  27. | SCREENSHOT
  28. | UNKNOWN
type nonrec artifact = {
  1. url : ur_l option;
    (*

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

    *)
  2. extension : string_ option;
    (*

    The artifact's file extension.

    *)
  3. type_ : artifact_type option;
    (*

    The artifact's type.

    Allowed values include the following:

    • UNKNOWN
    • SCREENSHOT
    • DEVICE_LOG
    • MESSAGE_LOG
    • VIDEO_LOG
    • RESULT_LOG
    • SERVICE_LOG
    • WEBKIT_LOG
    • INSTRUMENTATION_OUTPUT
    • EXERCISER_MONKEY_OUTPUT: the artifact (log) generated by an Android fuzz test.
    • APPIUM_SERVER_OUTPUT
    • APPIUM_JAVA_OUTPUT
    • APPIUM_JAVA_XML_OUTPUT
    • APPIUM_PYTHON_OUTPUT
    • APPIUM_PYTHON_XML_OUTPUT
    • APPLICATION_CRASH_REPORT
    • XCTEST_LOG
    • VIDEO
    • CUSTOMER_ARTIFACT
    • CUSTOMER_ARTIFACT_LOG
    • TESTSPEC_OUTPUT
    *)
  4. name : name option;
    (*

    The artifact's name.

    *)
  5. arn : amazon_resource_name option;
    (*

    The artifact's ARN.

    *)
}

Represents the output of a test. Examples of artifacts include logs and screenshots.

type nonrec artifacts = artifact list
type nonrec list_artifacts_result = {
  1. next_token : pagination_token option;
    (*

    If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

    *)
  2. artifacts : artifacts option;
    (*

    Information about the artifacts.

    *)
}

Represents the result of a list artifacts operation.

type nonrec artifact_category =
  1. | LOG
  2. | FILE
  3. | SCREENSHOT
type nonrec list_artifacts_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. type_ : artifact_category;
    (*

    The artifacts' type.

    Allowed values include:

    • FILE
    • LOG
    • SCREENSHOT
    *)
  3. arn : amazon_resource_name;
    (*

    The run, job, suite, or test ARN.

    *)
}

Represents a request to the list artifacts operation.

type nonrec install_to_remote_access_session_result = {
  1. app_upload : upload option;
    (*

    An app to upload or that has been uploaded.

    *)
}

Represents the response from the server after AWS Device Farm makes a request to install to a remote access session.

type nonrec install_to_remote_access_session_request = {
  1. app_arn : amazon_resource_name;
    (*

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

    *)
  2. remote_access_session_arn : amazon_resource_name;
    (*

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

    *)
}

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.

type nonrec incompatibility_message = {
  1. type_ : device_attribute option;
    (*

    The type of incompatibility.

    Allowed values include:

    • ARN
    • FORM_FACTOR (for example, phone or tablet)
    • MANUFACTURER
    • PLATFORM (for example, Android or iOS)
    • REMOTE_ACCESS_ENABLED
    • APPIUM_VERSION
    *)
  2. message : message option;
    (*

    A message about the incompatibility.

    *)
}

Represents information about incompatibility.

type nonrec incompatibility_messages = incompatibility_message list
type nonrec get_vpce_configuration_result = {
  1. vpce_configuration : vpce_configuration option;
    (*

    An object that contains information about your VPC endpoint configuration.

    *)
}
type nonrec get_vpce_configuration_request = {
  1. arn : amazon_resource_name;
    (*

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

    *)
}
type nonrec get_upload_result = {
  1. upload : upload option;
    (*

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

    *)
}

Represents the result of a get upload request.

type nonrec get_upload_request = {
  1. arn : amazon_resource_name;
    (*

    The upload's ARN.

    *)
}

Represents a request to the get upload operation.

type nonrec get_test_result = {
  1. test : test option;
    (*

    A test condition that is evaluated.

    *)
}

Represents the result of a get test request.

type nonrec get_test_request = {
  1. arn : amazon_resource_name;
    (*

    The test's ARN.

    *)
}

Represents a request to the get test operation.

type nonrec get_test_grid_session_result = {
  1. test_grid_session : test_grid_session option;
    (*

    The TestGridSession that was requested.

    *)
}
type nonrec get_test_grid_session_request = {
  1. session_arn : device_farm_arn option;
    (*

    An ARN that uniquely identifies a TestGridSession.

    *)
  2. session_id : resource_id option;
    (*

    An ID associated with this session.

    *)
  3. project_arn : device_farm_arn option;
    (*

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

    *)
}
type nonrec get_test_grid_project_result = {
  1. test_grid_project : test_grid_project option;
    (*

    A TestGridProject.

    *)
}
type nonrec get_test_grid_project_request = {
  1. project_arn : device_farm_arn;
    (*

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

    *)
}
type nonrec get_suite_result = {
  1. suite : suite option;
    (*

    A collection of one or more tests.

    *)
}

Represents the result of a get suite request.

type nonrec get_suite_request = {
  1. arn : amazon_resource_name;
    (*

    The suite's ARN.

    *)
}

Represents a request to the get suite operation.

type nonrec get_run_result = {
  1. run : run option;
    (*

    The run to get results from.

    *)
}

Represents the result of a get run request.

type nonrec get_run_request = {
  1. arn : amazon_resource_name;
    (*

    The run's ARN.

    *)
}

Represents a request to the get run operation.

type nonrec get_remote_access_session_result = {
  1. remote_access_session : remote_access_session option;
    (*

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

    *)
}

Represents the response from the server that lists detailed information about the remote access session.

type nonrec get_remote_access_session_request = {
  1. arn : amazon_resource_name;
    (*

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

    *)
}

Represents the request to get information about the specified remote access session.

type nonrec get_project_result = {
  1. project : project option;
    (*

    The project to get information about.

    *)
}

Represents the result of a get project request.

type nonrec get_project_request = {
  1. arn : amazon_resource_name;
    (*

    The project's ARN.

    *)
}

Represents a request to the get project operation.

type nonrec get_offering_status_result = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
  2. next_period : offering_status_map option;
    (*

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

    *)
  3. current : offering_status_map option;
    (*

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

    *)
}

Returns the status result for a device offering.

type nonrec get_offering_status_request = {
  1. next_token : pagination_token option;
    (*

    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.

    *)
}

Represents the request to retrieve the offering status for the specified customer or account.

type nonrec get_network_profile_result = {
  1. network_profile : network_profile option;
    (*

    The network profile.

    *)
}
type nonrec get_network_profile_request = {
  1. arn : amazon_resource_name;
    (*

    The ARN of the network profile to return information about.

    *)
}
type nonrec get_job_result = {
  1. job : job option;
    (*

    An object that contains information about the requested job.

    *)
}

Represents the result of a get job request.

type nonrec get_job_request = {
  1. arn : amazon_resource_name;
    (*

    The job's ARN.

    *)
}

Represents a request to the get job operation.

type nonrec get_instance_profile_result = {
  1. instance_profile : instance_profile option;
    (*

    An object that contains information about an instance profile.

    *)
}
type nonrec get_instance_profile_request = {
  1. arn : amazon_resource_name;
    (*

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

    *)
}
type nonrec get_device_result = {
  1. device : device option;
    (*

    An object that contains information about the requested device.

    *)
}

Represents the result of a get device request.

type nonrec get_device_request = {
  1. arn : amazon_resource_name;
    (*

    The device type's ARN.

    *)
}

Represents a request to the get device request.

type nonrec get_device_pool_result = {
  1. device_pool : device_pool option;
    (*

    An object that contains information about the requested device pool.

    *)
}

Represents the result of a get device pool request.

type nonrec get_device_pool_request = {
  1. arn : amazon_resource_name;
    (*

    The device pool's ARN.

    *)
}

Represents a request to the get device pool operation.

type nonrec device_pool_compatibility_result = {
  1. incompatibility_messages : incompatibility_messages option;
    (*

    Information about the compatibility.

    *)
  2. compatible : boolean_ option;
    (*

    Whether the result was compatible with the device pool.

    *)
  3. device : device option;
    (*

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

    *)
}

Represents a device pool compatibility result.

type nonrec device_pool_compatibility_results = device_pool_compatibility_result list
type nonrec get_device_pool_compatibility_result = {
  1. incompatible_devices : device_pool_compatibility_results option;
    (*

    Information about incompatible devices.

    *)
  2. compatible_devices : device_pool_compatibility_results option;
    (*

    Information about compatible devices.

    *)
}

Represents the result of describe device pool compatibility request.

type nonrec get_device_pool_compatibility_request = {
  1. project_arn : amazon_resource_name option;
    (*

    The ARN of the project for which you want to check device pool compatibility.

    *)
  2. configuration : schedule_run_configuration option;
    (*

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

    *)
  3. test : schedule_run_test option;
    (*

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

    *)
  4. test_type : test_type option;
    (*

    The test type for the specified device pool.

    Allowed values include the following:

    • BUILTIN_FUZZ.
    • APPIUM_JAVA_JUNIT.
    • APPIUM_JAVA_TESTNG.
    • APPIUM_PYTHON.
    • APPIUM_NODE.
    • APPIUM_RUBY.
    • APPIUM_WEB_JAVA_JUNIT.
    • APPIUM_WEB_JAVA_TESTNG.
    • APPIUM_WEB_PYTHON.
    • APPIUM_WEB_NODE.
    • APPIUM_WEB_RUBY.
    • INSTRUMENTATION.
    • XCTEST.
    • XCTEST_UI.
    *)
  5. app_arn : amazon_resource_name option;
    (*

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

    *)
  6. device_pool_arn : amazon_resource_name;
    (*

    The device pool's ARN.

    *)
}

Represents a request to the get device pool compatibility operation.

type nonrec get_device_instance_result = {
  1. device_instance : device_instance option;
    (*

    An object that contains information about your device instance.

    *)
}
type nonrec get_device_instance_request = {
  1. arn : amazon_resource_name;
    (*

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

    *)
}
type nonrec aws_account_number = string
type nonrec account_settings = {
  1. skip_app_resign : skip_app_resign option;
    (*

    When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

    For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

    *)
  2. default_job_timeout_minutes : job_timeout_minutes option;
    (*

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

    *)
  3. max_slots : max_slot_map option;
    (*

    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.

    *)
  4. trial_minutes : trial_minutes option;
    (*

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

    *)
  5. max_job_timeout_minutes : job_timeout_minutes option;
    (*

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

    *)
  6. unmetered_remote_access_devices : purchased_devices_map option;
    (*

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

    *)
  7. unmetered_devices : purchased_devices_map option;
    (*

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

    *)
  8. aws_account_number : aws_account_number option;
    (*

    The AWS account number specified in the AccountSettings container.

    *)
}

A container for account-level settings in AWS Device Farm.

type nonrec get_account_settings_result = {
  1. account_settings : account_settings option;
    (*

    The account settings.

    *)
}

Represents the account settings return values from the GetAccountSettings request.

type nonrec get_account_settings_request = unit
type nonrec delete_vpce_configuration_result = unit
type nonrec delete_vpce_configuration_request = {
  1. arn : amazon_resource_name;
    (*

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

    *)
}
type nonrec delete_upload_result = unit
type nonrec delete_upload_request = {
  1. arn : amazon_resource_name;
    (*

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

    *)
}

Represents a request to the delete upload operation.

type nonrec cannot_delete_exception = {
  1. message : message option;
}

The requested object could not be deleted.

type nonrec delete_test_grid_project_result = unit
type nonrec delete_test_grid_project_request = {
  1. project_arn : device_farm_arn;
    (*

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

    *)
}
type nonrec delete_run_result = unit
type nonrec delete_run_request = {
  1. arn : amazon_resource_name;
    (*

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

    *)
}

Represents a request to the delete run operation.

type nonrec delete_remote_access_session_result = unit
type nonrec delete_remote_access_session_request = {
  1. arn : amazon_resource_name;
    (*

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

    *)
}

Represents the request to delete the specified remote access session.

type nonrec delete_project_result = unit
type nonrec delete_project_request = {
  1. arn : amazon_resource_name;
    (*

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

    *)
}

Represents a request to the delete project operation.

type nonrec delete_network_profile_result = unit
type nonrec delete_network_profile_request = {
  1. arn : amazon_resource_name;
    (*

    The ARN of the network profile to delete.

    *)
}
type nonrec delete_instance_profile_result = unit
type nonrec delete_instance_profile_request = {
  1. arn : amazon_resource_name;
    (*

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

    *)
}
type nonrec delete_device_pool_result = unit
type nonrec delete_device_pool_request = {
  1. arn : amazon_resource_name;
    (*

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

    *)
}

Represents a request to the delete device pool operation.

type nonrec create_vpce_configuration_result = {
  1. vpce_configuration : vpce_configuration option;
    (*

    An object that contains information about your VPC endpoint configuration.

    *)
}
type nonrec create_vpce_configuration_request = {
  1. vpce_configuration_description : vpce_configuration_description option;
    (*

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

    *)
  2. service_dns_name : service_dns_name;
    (*

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

    *)
  3. vpce_service_name : vpce_service_name;
    (*

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

    *)
  4. vpce_configuration_name : vpce_configuration_name;
    (*

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

    *)
}
type nonrec create_upload_result = {
  1. upload : upload option;
    (*

    The newly created upload.

    *)
}

Represents the result of a create upload request.

type nonrec create_upload_request = {
  1. content_type : content_type option;
    (*

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

    *)
  2. type_ : upload_type;
    (*

    The upload's upload type.

    Must be one of the following values:

    • ANDROID_APP
    • IOS_APP
    • WEB_APP
    • EXTERNAL_DATA
    • APPIUM_JAVA_JUNIT_TEST_PACKAGE
    • APPIUM_JAVA_TESTNG_TEST_PACKAGE
    • APPIUM_PYTHON_TEST_PACKAGE
    • APPIUM_NODE_TEST_PACKAGE
    • APPIUM_RUBY_TEST_PACKAGE
    • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE
    • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE
    • APPIUM_WEB_PYTHON_TEST_PACKAGE
    • APPIUM_WEB_NODE_TEST_PACKAGE
    • APPIUM_WEB_RUBY_TEST_PACKAGE
    • INSTRUMENTATION_TEST_PACKAGE
    • XCTEST_TEST_PACKAGE
    • XCTEST_UI_TEST_PACKAGE
    • APPIUM_JAVA_JUNIT_TEST_SPEC
    • APPIUM_JAVA_TESTNG_TEST_SPEC
    • APPIUM_PYTHON_TEST_SPEC
    • APPIUM_NODE_TEST_SPEC
    • APPIUM_RUBY_TEST_SPEC
    • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC
    • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC
    • APPIUM_WEB_PYTHON_TEST_SPEC
    • APPIUM_WEB_NODE_TEST_SPEC
    • APPIUM_WEB_RUBY_TEST_SPEC
    • INSTRUMENTATION_TEST_SPEC
    • XCTEST_UI_TEST_SPEC

    If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.

    *)
  3. name : name;
    (*

    The upload's file name. The name should not contain any forward slashes (/). If you are uploading an iOS app, the file name must end with the .ipa extension. If you are uploading an Android app, the file name must end with the .apk extension. For all others, the file name must end with the .zip file extension.

    *)
  4. project_arn : amazon_resource_name;
    (*

    The ARN of the project for the upload.

    *)
}

Represents a request to the create upload operation.

type nonrec create_test_grid_url_result = {
  1. expires : date_time option;
    (*

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

    *)
  2. url : sensitive_string option;
    (*

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

    *)
}
type nonrec create_test_grid_url_request = {
  1. expires_in_seconds : test_grid_url_expires_in_seconds_input;
    (*

    Lifetime, in seconds, of the URL.

    *)
  2. project_arn : device_farm_arn;
    (*

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

    *)
}
type nonrec create_test_grid_project_result = {
  1. test_grid_project : test_grid_project option;
    (*

    ARN of the Selenium testing project that was created.

    *)
}
type nonrec create_test_grid_project_request = {
  1. vpc_config : test_grid_vpc_config option;
    (*

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

    *)
  2. description : resource_description option;
    (*

    Human-readable description of the project.

    *)
  3. name : resource_name;
    (*

    Human-readable name of the Selenium testing project.

    *)
}
type nonrec create_remote_access_session_result = {
  1. remote_access_session : remote_access_session option;
    (*

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

    *)
}

Represents the server response from a request to create a remote access session.

type nonrec auxiliary_app_arn_list = amazon_resource_name list
type nonrec create_remote_access_session_configuration = {
  1. device_proxy : device_proxy option;
    (*

    The device proxy to be configured on the device for the remote access session.

    *)
  2. vpce_configuration_arns : amazon_resource_names option;
    (*

    An array of ARNs included in the VPC endpoint configuration.

    *)
  3. billing_method : billing_method option;
    (*

    The billing method for the remote access session.

    *)
  4. auxiliary_apps : auxiliary_app_arn_list option;
    (*

    A list of upload ARNs for app packages to be installed onto your device. (Maximum 3)

    *)
}

Configuration settings for a remote access session, including billing method.

type nonrec create_remote_access_session_request = {
  1. skip_app_resign : boolean_ option;
    (*

    When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

    For more information on how Device Farm modifies your uploads during tests, see Do you modify my app?

    *)
  2. interaction_mode : interaction_mode option;
    (*

    The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available.

    *)
  3. configuration : create_remote_access_session_configuration option;
    (*

    The configuration information for the remote access session request.

    *)
  4. name : name option;
    (*

    The name of the remote access session to create.

    *)
  5. instance_arn : amazon_resource_name option;
    (*

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

    *)
  6. app_arn : amazon_resource_name option;
    (*

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

    *)
  7. device_arn : amazon_resource_name;
    (*

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

    *)
  8. project_arn : amazon_resource_name;
    (*

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

    *)
}

Creates and submits a request to start a remote access session.

type nonrec create_project_result = {
  1. project : project option;
    (*

    The newly created project.

    *)
}

Represents the result of a create project request.

type nonrec create_project_request = {
  1. execution_role_arn : amazon_role_resource_name option;
    (*

    An IAM role to be assumed by the test host for all runs in the project.

    *)
  2. environment_variables : environment_variables option;
    (*

    A set of environment variables which are used by default for all runs in the project. These environment variables are applied to the test run during the execution of a test spec file.

    For more information about using test spec files, please see Custom test environments in AWS Device Farm.

    *)
  3. vpc_config : vpc_config option;
    (*

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

    *)
  4. default_job_timeout_minutes : job_timeout_minutes option;
    (*

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

    *)
  5. name : name;
    (*

    The project's name.

    *)
}

Represents a request to the create project operation.

type nonrec create_network_profile_result = {
  1. network_profile : network_profile option;
    (*

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

    *)
}
type nonrec create_network_profile_request = {
  1. type_ : network_profile_type option;
    (*

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

    *)
  2. description : message option;
    (*

    The description of the network profile.

    *)
  3. name : name;
    (*

    The name for the new network profile.

    *)
  4. project_arn : amazon_resource_name;
    (*

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

    *)
}
type nonrec create_instance_profile_result = {
  1. instance_profile : instance_profile option;
    (*

    An object that contains information about your instance profile.

    *)
}
type nonrec create_instance_profile_request = {
  1. reboot_after_use : boolean_ option;
    (*

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

    *)
  2. exclude_app_packages_from_cleanup : package_ids option;
    (*

    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.

    The list of packages is considered only if you set packageCleanup to true.

    *)
  3. package_cleanup : boolean_ option;
    (*

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

    *)
  4. description : message option;
    (*

    The description of your instance profile.

    *)
  5. name : name;
    (*

    The name of your instance profile.

    *)
}
type nonrec create_device_pool_result = {
  1. device_pool : device_pool option;
    (*

    The newly created device pool.

    *)
}

Represents the result of a create device pool request.

type nonrec create_device_pool_request = {
  1. max_devices : integer option;
    (*

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

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

    *)
  2. rules : rules;
    (*

    The device pool's rules.

    *)
  3. description : message option;
    (*

    The device pool's description.

    *)
  4. name : name;
    (*

    The device pool's name.

    *)
  5. project_arn : amazon_resource_name;
    (*

    The ARN of the project for the device pool.

    *)
}

Represents a request to the create device pool operation.