Skip to content

ScheduleRunConfiguration

Source code in docs_src/capo_device_farm/types/schedule_run_configuration.py
class ScheduleRunConfiguration(TypedDict, closed=True):
    extra_data_package_arn: NotRequired[
        "capo_device_farm.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>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.</p>"""
    network_profile_arn: NotRequired[
        "capo_device_farm.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>Reserved for internal use.</p>"""
    locale: NotRequired["capo_device_farm.types.string.String"]
    """<p>Information about the locale that is used for the run.</p>"""
    location: NotRequired["capo_device_farm.types.location.Location"]
    """<p>Information about the location that is used for the run.</p>"""
    vpce_configuration_arns: NotRequired[
        "capo_device_farm.types.amazon_resource_names.AmazonResourceNames"
    ]
    """<p>An array of ARNs for your VPC endpoint configurations.</p>"""
    device_proxy: NotRequired["capo_device_farm.types.device_proxy.DeviceProxy"]
    """<p>The device proxy to be configured on the device for the run.</p>"""
    customer_artifact_paths: NotRequired[
        "capo_device_farm.types.customer_artifact_paths.CustomerArtifactPaths"
    ]
    """<p>Input <code>CustomerArtifactPaths</code> object for the scheduled run configuration.</p>"""
    radios: NotRequired["capo_device_farm.types.radios.Radios"]
    """<p>Information about the radio states for the run.</p>"""
    auxiliary_apps: NotRequired[
        "capo_device_farm.types.amazon_resource_names.AmazonResourceNames"
    ]
    """<p>A list of upload ARNs for app packages to be installed with your app.</p>"""
    billing_method: NotRequired["capo_device_farm.types.billing_method.BillingMethod"]
    """<p>Specifies the billing method for a test run: <code>metered</code> or <code>unmetered</code>. If the parameter is not specified, the default value is <code>metered</code>.</p> <note> <p>If you have purchased unmetered device slots, you must set this parameter to <code>unmetered</code> to make use of them. Otherwise, your run counts against your metered time.</p> </note>"""
    environment_variables: NotRequired[
        "capo_device_farm.types.environment_variables.EnvironmentVariables"
    ]
    """<p>Environment variables associated with the run.</p>"""
    execution_role_arn: NotRequired[
        "capo_device_farm.types.amazon_role_resource_name.AmazonRoleResourceName"
    ]
    """<p>An IAM role to be assumed by the test host for the run.</p>"""
    insights_types: NotRequired["capo_device_farm.types.insights_types.InsightsTypes"]
    """<p>The types of insights to generate for a run. Specify one or more values to opt in to insights generation when scheduling a run.</p> <p>Insights are currently supported for custom mode runs with Instrumentation, Appium Java TestNG, and XCTest UI test types.</p>"""

auxiliary_apps instance-attribute

auxiliary_apps: NotRequired[AmazonResourceNames]

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

billing_method instance-attribute

billing_method: NotRequired[BillingMethod]

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

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

customer_artifact_paths instance-attribute

customer_artifact_paths: NotRequired[CustomerArtifactPaths]

Input CustomerArtifactPaths object for the scheduled run configuration.

device_proxy instance-attribute

device_proxy: NotRequired[DeviceProxy]

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

environment_variables instance-attribute

environment_variables: NotRequired[EnvironmentVariables]

Environment variables associated with the run.

execution_role_arn instance-attribute

execution_role_arn: NotRequired[AmazonRoleResourceName]

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

extra_data_package_arn instance-attribute

extra_data_package_arn: NotRequired[AmazonResourceName]

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.

insights_types instance-attribute

insights_types: NotRequired[InsightsTypes]

The types of insights to generate for a run. Specify one or more values to opt in to insights generation when scheduling a run.

Insights are currently supported for custom mode runs with Instrumentation, Appium Java TestNG, and XCTest UI test types.

locale instance-attribute

locale: NotRequired[String]

Information about the locale that is used for the run.

location instance-attribute

location: NotRequired[Location]

Information about the location that is used for the run.

network_profile_arn instance-attribute

network_profile_arn: NotRequired[AmazonResourceName]

Reserved for internal use.

radios instance-attribute

radios: NotRequired[Radios]

Information about the radio states for the run.

vpce_configuration_arns instance-attribute

vpce_configuration_arns: NotRequired[AmazonResourceNames]

An array of ARNs for your VPC endpoint configurations.