Skip to content

Job

Source code in docs_src/capo_device_farm/types/job.py
class Job(TypedDict, closed=True):
    arn: NotRequired["capo_device_farm.types.amazon_resource_name.AmazonResourceName"]
    """<p>The job's ARN.</p>"""
    name: NotRequired["capo_device_farm.types.name.Name"]
    """<p>The job's name.</p>"""
    type: NotRequired["capo_device_farm.types.test_type.TestType"]
    """<p>The job's type.</p> <p>Allowed values include the following:</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>"""
    created: NotRequired["capo_device_farm.types.date_time.DateTime"]
    """<p>When the job was created.</p>"""
    status: NotRequired["capo_device_farm.types.execution_status.ExecutionStatus"]
    """<p>The job'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 job'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 job's start time.</p>"""
    stopped: NotRequired["capo_device_farm.types.date_time.DateTime"]
    """<p>The job's stop time.</p>"""
    counters: NotRequired["capo_device_farm.types.counters.Counters"]
    """<p>The job's result counters.</p>"""
    message: NotRequired["capo_device_farm.types.message.Message"]
    """<p>A message about the job's result.</p>"""
    device: NotRequired["capo_device_farm.types.device.Device"]
    """<p>The device (phone or tablet).</p>"""
    instance_arn: NotRequired[
        "capo_device_farm.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>The ARN of the instance.</p>"""
    device_minutes: NotRequired["capo_device_farm.types.device_minutes.DeviceMinutes"]
    """<p>Represents the total (metered or unmetered) minutes used by the job.</p>"""
    video_endpoint: NotRequired["capo_device_farm.types.string.String"]
    """<p>The endpoint for streaming device video.</p>"""
    video_capture: NotRequired["capo_device_farm.types.video_capture.VideoCapture"]
    """<p>This value is set to true if video capture is enabled. Otherwise, it is set to false.</p>"""
    insights: NotRequired["capo_device_farm.types.job_insights.JobInsights"]
    """<p>The insights for the job, including the report status and test-level metrics. This field contains data only if you specified <code>insightsTypes</code> when you scheduled the run.</p>"""

arn instance-attribute

arn: NotRequired[AmazonResourceName]

The job's ARN.

counters instance-attribute

counters: NotRequired[Counters]

The job's result counters.

created instance-attribute

created: NotRequired[DateTime]

When the job was created.

device instance-attribute

device: NotRequired[Device]

The device (phone or tablet).

device_minutes instance-attribute

device_minutes: NotRequired[DeviceMinutes]

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

insights instance-attribute

insights: NotRequired[JobInsights]

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

instance_arn instance-attribute

instance_arn: NotRequired[AmazonResourceName]

The ARN of the instance.

message instance-attribute

message: NotRequired[Message]

A message about the job's result.

name instance-attribute

name: NotRequired[Name]

The job's name.

result instance-attribute

result: NotRequired[ExecutionResult]

The job's result.

Allowed values include:

  • PENDING

  • PASSED

  • WARNED

  • FAILED

  • SKIPPED

  • ERRORED

  • STOPPED

started instance-attribute

started: NotRequired[DateTime]

The job's start time.

status instance-attribute

status: NotRequired[ExecutionStatus]

The job's status.

Allowed values include:

  • PENDING

  • PENDING_CONCURRENCY

  • PENDING_DEVICE

  • PROCESSING

  • SCHEDULING

  • PREPARING

  • RUNNING

  • COMPLETED

  • STOPPING

stopped instance-attribute

stopped: NotRequired[DateTime]

The job's stop time.

type instance-attribute

type: NotRequired[TestType]

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

video_capture instance-attribute

video_capture: NotRequired[VideoCapture]

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

video_endpoint instance-attribute

video_endpoint: NotRequired[String]

The endpoint for streaming device video.