Skip to content

RemoteAccessSession

Source code in docs_src/capo_device_farm/types/remote_access_session.py
class RemoteAccessSession(TypedDict, closed=True):
    arn: NotRequired["capo_device_farm.types.amazon_resource_name.AmazonResourceName"]
    """<p>The Amazon Resource Name (ARN) of the remote access session.</p>"""
    name: NotRequired["capo_device_farm.types.name.Name"]
    """<p>The name of the remote access session.</p>"""
    created: NotRequired["capo_device_farm.types.date_time.DateTime"]
    """<p>The date and time the remote access session was created.</p>"""
    status: NotRequired["capo_device_farm.types.execution_status.ExecutionStatus"]
    """<p>The status of the remote access session. Can be any of the following:</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 result of the remote access session. Can be any of the following:</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>"""
    message: NotRequired["capo_device_farm.types.message.Message"]
    """<p>A message about the remote access session.</p>"""
    started: NotRequired["capo_device_farm.types.date_time.DateTime"]
    """<p>The date and time the remote access session was started.</p>"""
    stopped: NotRequired["capo_device_farm.types.date_time.DateTime"]
    """<p>The date and time the remote access session was stopped.</p>"""
    device: NotRequired["capo_device_farm.types.device.Device"]
    """<p>The device (phone or tablet) used in the remote access session.</p>"""
    instance_arn: NotRequired[
        "capo_device_farm.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>The ARN of the instance.</p>"""
    billing_method: NotRequired["capo_device_farm.types.billing_method.BillingMethod"]
    """<p>The billing method of the remote access session. Possible values include <code>METERED</code> or <code>UNMETERED</code>. For more information about metered devices, see <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology">AWS Device Farm terminology</a>.</p>"""
    device_minutes: NotRequired["capo_device_farm.types.device_minutes.DeviceMinutes"]
    """<p>The number of minutes a device is used in a remote access session (including setup and teardown minutes).</p>"""
    endpoint: NotRequired["capo_device_farm.types.string.String"]
    """<p>The endpoint for the remote access session. This field is deprecated, and is replaced by the new <code>endpoints.interactiveEndpoint</code> field.</p>"""
    device_udid: NotRequired["capo_device_farm.types.string.String"]
    """<p>Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.</p> <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>.</p>"""
    interaction_mode: NotRequired[
        "capo_device_farm.types.interaction_mode.InteractionMode"
    ]
    """<p>The interaction mode of the remote access session. Changing the interactive mode of remote access sessions is no longer available.</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>"""
    vpc_config: NotRequired["capo_device_farm.types.vpc_config.VpcConfig"]
    """<p>The VPC security groups and subnets that are attached to a project.</p>"""
    device_proxy: NotRequired["capo_device_farm.types.device_proxy.DeviceProxy"]
    """<p>The device proxy configured for the remote access session.</p>"""
    app_upload: NotRequired[
        "capo_device_farm.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>The ARN for the app to be installed onto your device.</p>"""
    endpoints: NotRequired[
        "capo_device_farm.types.remote_access_endpoints.RemoteAccessEndpoints"
    ]

app_upload instance-attribute

app_upload: NotRequired[AmazonResourceName]

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

arn instance-attribute

arn: NotRequired[AmazonResourceName]

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

billing_method instance-attribute

billing_method: NotRequired[BillingMethod]

The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology.

created instance-attribute

created: NotRequired[DateTime]

The date and time the remote access session was created.

device instance-attribute

device: NotRequired[Device]

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

device_minutes instance-attribute

device_minutes: NotRequired[DeviceMinutes]

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

device_proxy instance-attribute

device_proxy: NotRequired[DeviceProxy]

The device proxy configured for the remote access session.

device_udid instance-attribute

device_udid: NotRequired[String]

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.

endpoint instance-attribute

endpoint: NotRequired[String]

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

endpoints instance-attribute

endpoints: NotRequired[RemoteAccessEndpoints]

instance_arn instance-attribute

instance_arn: NotRequired[AmazonResourceName]

The ARN of the instance.

interaction_mode instance-attribute

interaction_mode: NotRequired[InteractionMode]

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

message instance-attribute

message: NotRequired[Message]

A message about the remote access session.

name instance-attribute

name: NotRequired[Name]

The name of the remote access session.

result instance-attribute

result: NotRequired[ExecutionResult]

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

  • PENDING.

  • PASSED.

  • WARNED.

  • FAILED.

  • SKIPPED.

  • ERRORED.

  • STOPPED.

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 date and time the remote access session was started.

status instance-attribute

status: NotRequired[ExecutionStatus]

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

  • PENDING.

  • PENDING_CONCURRENCY.

  • PENDING_DEVICE.

  • PROCESSING.

  • SCHEDULING.

  • PREPARING.

  • RUNNING.

  • COMPLETED.

  • STOPPING.

stopped instance-attribute

stopped: NotRequired[DateTime]

The date and time the remote access session was stopped.

vpc_config instance-attribute

vpc_config: NotRequired[VpcConfig]

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