Skip to content

Run

Source code in docs_src/capo_device_farm/types/run.py
class Run(TypedDict, closed=True):
    arn: NotRequired["capo_device_farm.types.amazon_resource_name.AmazonResourceName"]
    """<p>The run's ARN.</p>"""
    name: NotRequired["capo_device_farm.types.name.Name"]
    """<p>The run's name.</p>"""
    type: NotRequired["capo_device_farm.types.test_type.TestType"]
    """<p>The run's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ</p> </li> <li> <p>APPIUM_JAVA_JUNIT</p> </li> <li> <p>APPIUM_JAVA_TESTNG</p> </li> <li> <p>APPIUM_PYTHON</p> </li> <li> <p>APPIUM_NODE</p> </li> <li> <p>APPIUM_RUBY</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG</p> </li> <li> <p>APPIUM_WEB_PYTHON</p> </li> <li> <p>APPIUM_WEB_NODE</p> </li> <li> <p>APPIUM_WEB_RUBY</p> </li> <li> <p>INSTRUMENTATION</p> </li> <li> <p>XCTEST</p> </li> <li> <p>XCTEST_UI</p> </li> </ul>"""
    platform: NotRequired["capo_device_farm.types.device_platform.DevicePlatform"]
    """<p>The run's platform.</p> <p>Allowed values include:</p> <ul> <li> <p>ANDROID</p> </li> <li> <p>IOS</p> </li> </ul>"""
    created: NotRequired["capo_device_farm.types.date_time.DateTime"]
    """<p>When the run was created.</p>"""
    status: NotRequired["capo_device_farm.types.execution_status.ExecutionStatus"]
    """<p>The run's status.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>PENDING_CONCURRENCY</p> </li> <li> <p>PENDING_DEVICE</p> </li> <li> <p>PROCESSING</p> </li> <li> <p>SCHEDULING</p> </li> <li> <p>PREPARING</p> </li> <li> <p>RUNNING</p> </li> <li> <p>COMPLETED</p> </li> <li> <p>STOPPING</p> </li> </ul>"""
    result: NotRequired["capo_device_farm.types.execution_result.ExecutionResult"]
    """<p>The run's result.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>PASSED</p> </li> <li> <p>WARNED</p> </li> <li> <p>FAILED</p> </li> <li> <p>SKIPPED</p> </li> <li> <p>ERRORED</p> </li> <li> <p>STOPPED</p> </li> </ul>"""
    started: NotRequired["capo_device_farm.types.date_time.DateTime"]
    """<p>The run's start time.</p>"""
    stopped: NotRequired["capo_device_farm.types.date_time.DateTime"]
    """<p>The run's stop time.</p>"""
    counters: NotRequired["capo_device_farm.types.counters.Counters"]
    """<p>The run's result counters.</p>"""
    message: NotRequired["capo_device_farm.types.message.Message"]
    """<p>A message about the run's result.</p>"""
    total_jobs: NotRequired["capo_device_farm.types.integer.Integer"]
    """<p>The total number of jobs for the run.</p>"""
    completed_jobs: NotRequired["capo_device_farm.types.integer.Integer"]
    """<p>The total number of completed jobs.</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 unmetered device slots, you must set this to <code>unmetered</code> to use them. Otherwise, the run is counted toward metered device minutes.</p> </note>"""
    device_minutes: NotRequired["capo_device_farm.types.device_minutes.DeviceMinutes"]
    """<p>Represents the total (metered or unmetered) minutes used by the test run.</p>"""
    network_profile: NotRequired[
        "capo_device_farm.types.network_profile.NetworkProfile"
    ]
    """<p>The network profile being used for a test run.</p>"""
    device_proxy: NotRequired["capo_device_farm.types.device_proxy.DeviceProxy"]
    """<p>The device proxy configured for the devices in the run.</p>"""
    parsing_result_url: NotRequired["capo_device_farm.types.string.String"]
    """<p>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.</p>"""
    result_code: NotRequired[
        "capo_device_farm.types.execution_result_code.ExecutionResultCode"
    ]
    """<p>Supporting field for the result field. Set only if <code>result</code> is <code>SKIPPED</code>. <code>PARSING_FAILED</code> if the result is skipped because of test package parsing failure.</p>"""
    seed: NotRequired["capo_device_farm.types.integer.Integer"]
    """<p>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.</p>"""
    app_upload: NotRequired[
        "capo_device_farm.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>An app to upload or that has been uploaded.</p>"""
    event_count: NotRequired["capo_device_farm.types.integer.Integer"]
    """<p>For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.</p>"""
    job_timeout_minutes: NotRequired[
        "capo_device_farm.types.job_timeout_minutes.JobTimeoutMinutes"
    ]
    """<p>The number of minutes the job executes before it times out.</p>"""
    device_pool_arn: NotRequired[
        "capo_device_farm.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>The ARN of the device pool for the run.</p>"""
    locale: NotRequired["capo_device_farm.types.string.String"]
    """<p>Information about the locale that is used for the run.</p>"""
    radios: NotRequired["capo_device_farm.types.radios.Radios"]
    """<p>Information about the radio states for the run.</p>"""
    location: NotRequired["capo_device_farm.types.location.Location"]
    """<p>Information about the location that is used for the run.</p>"""
    customer_artifact_paths: NotRequired[
        "capo_device_farm.types.customer_artifact_paths.CustomerArtifactPaths"
    ]
    """<p>Output <code>CustomerArtifactPaths</code> object for the test run.</p>"""
    web_url: NotRequired["capo_device_farm.types.string.String"]
    """<p>The Device Farm console URL for the recording of the run.</p>"""
    skip_app_resign: NotRequired["capo_device_farm.types.skip_app_resign.SkipAppResign"]
    """<p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.</p> <p>For more information about how Device Farm re-signs your apps, see <a href="http://aws.amazon.com/device-farm/faqs/">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>"""
    test_spec_arn: NotRequired[
        "capo_device_farm.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>The ARN of the YAML-formatted test specification for the run.</p>"""
    device_selection_result: NotRequired[
        "capo_device_farm.types.device_selection_result.DeviceSelectionResult"
    ]
    """<p>The results of a device filter used to select the devices for a test run.</p>"""
    vpc_config: NotRequired["capo_device_farm.types.vpc_config.VpcConfig"]
    """<p>The VPC security groups and subnets that are attached to a project.</p>"""
    execution_role_arn: NotRequired[
        "capo_device_farm.types.amazon_role_resource_name.AmazonRoleResourceName"
    ]
    """<p>The IAM role associated with the run.</p>"""
    environment_variables: NotRequired[
        "capo_device_farm.types.environment_variables.EnvironmentVariables"
    ]
    """<p>Environment variables associated with the run.</p>"""
    insights_types: NotRequired["capo_device_farm.types.insights_types.InsightsTypes"]
    """<p>The types of insights requested for the run.</p>"""
    insights: NotRequired["capo_device_farm.types.run_insights.RunInsights"]
    """<p>The insights for the run, including the report status and job-level metrics. This field contains data only if you specified <code>insightsTypes</code> when you scheduled the run.</p>"""

app_upload instance-attribute

app_upload: NotRequired[AmazonResourceName]

An app to upload or that has been uploaded.

arn instance-attribute

arn: NotRequired[AmazonResourceName]

The run's ARN.

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 unmetered device slots, you must set this to unmetered to use them. Otherwise, the run is counted toward metered device minutes.

completed_jobs instance-attribute

completed_jobs: NotRequired[Integer]

The total number of completed jobs.

counters instance-attribute

counters: NotRequired[Counters]

The run's result counters.

created instance-attribute

created: NotRequired[DateTime]

When the run was created.

customer_artifact_paths instance-attribute

customer_artifact_paths: NotRequired[CustomerArtifactPaths]

Output CustomerArtifactPaths object for the test run.

device_minutes instance-attribute

device_minutes: NotRequired[DeviceMinutes]

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

device_pool_arn instance-attribute

device_pool_arn: NotRequired[AmazonResourceName]

The ARN of the device pool for the run.

device_proxy instance-attribute

device_proxy: NotRequired[DeviceProxy]

The device proxy configured for the devices in the run.

device_selection_result instance-attribute

device_selection_result: NotRequired[DeviceSelectionResult]

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

environment_variables instance-attribute

environment_variables: NotRequired[EnvironmentVariables]

Environment variables associated with the run.

event_count instance-attribute

event_count: NotRequired[Integer]

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

execution_role_arn instance-attribute

execution_role_arn: NotRequired[AmazonRoleResourceName]

The IAM role associated with the run.

insights instance-attribute

insights: NotRequired[RunInsights]

The insights for the run, including the report status and job-level metrics. This field contains data only if you specified insightsTypes when you scheduled the run.

insights_types instance-attribute

insights_types: NotRequired[InsightsTypes]

The types of insights requested for the run.

job_timeout_minutes instance-attribute

job_timeout_minutes: NotRequired[JobTimeoutMinutes]

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

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.

message instance-attribute

message: NotRequired[Message]

A message about the run's result.

name instance-attribute

name: NotRequired[Name]

The run's name.

network_profile instance-attribute

network_profile: NotRequired[NetworkProfile]

The network profile being used for a test run.

parsing_result_url instance-attribute

parsing_result_url: NotRequired[String]

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.

platform instance-attribute

platform: NotRequired[DevicePlatform]

The run's platform.

Allowed values include:

  • ANDROID

  • IOS

radios instance-attribute

radios: NotRequired[Radios]

Information about the radio states for the run.

result instance-attribute

result: NotRequired[ExecutionResult]

The run's result.

Allowed values include:

  • PENDING

  • PASSED

  • WARNED

  • FAILED

  • SKIPPED

  • ERRORED

  • STOPPED

result_code instance-attribute

result_code: NotRequired[ExecutionResultCode]

Supporting field for the result field. Set only if result is SKIPPED. PARSING_FAILED if the result is skipped because of test package parsing failure.

seed instance-attribute

seed: NotRequired[Integer]

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.

skip_app_resign instance-attribute

skip_app_resign: NotRequired[SkipAppResign]

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.

started instance-attribute

started: NotRequired[DateTime]

The run's start time.

status instance-attribute

status: NotRequired[ExecutionStatus]

The run's status.

Allowed values include:

  • PENDING

  • PENDING_CONCURRENCY

  • PENDING_DEVICE

  • PROCESSING

  • SCHEDULING

  • PREPARING

  • RUNNING

  • COMPLETED

  • STOPPING

stopped instance-attribute

stopped: NotRequired[DateTime]

The run's stop time.

test_spec_arn instance-attribute

test_spec_arn: NotRequired[AmazonResourceName]

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

total_jobs instance-attribute

total_jobs: NotRequired[Integer]

The total number of jobs for the run.

type instance-attribute

type: NotRequired[TestType]

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

vpc_config instance-attribute

vpc_config: NotRequired[VpcConfig]

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

web_url instance-attribute

web_url: NotRequired[String]

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