aws_devicefarm_session

account_id

Type: STRING

arn

Type: STRING
Provider name: arn
Description: The Amazon Resource Name (ARN) of the remote access session.

billing_method

Type: STRING
Provider name: billingMethod
Description: 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.

client_id

Type: STRING
Provider name: clientId
Description: Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session. Remote debugging is no longer supported.

created

Type: TIMESTAMP
Provider name: created
Description: The date and time the remote access session was created.

device

Type: STRUCT
Provider name: device
Description: The device (phone or tablet) used in the remote access session.

• arn
  Type: STRING
  Provider name: arn
  Description: The device’s ARN.
  
• availability
  Type: STRING
  Provider name: availability
  Description: Indicates how likely a device is available for a test run. Currently available in the ListDevices and GetDevice API methods.
  
• carrier
  Type: STRING
  Provider name: carrier
  Description: The device’s carrier.
  
• cpu
  Type: STRUCT
  Provider name: cpu
  Description: Information about the device’s CPU.
  
  • architecture
    Type: STRING
    Provider name: architecture
    Description: The CPU’s architecture (for example, x86 or ARM).
    
  • clock
    Type: DOUBLE
    Provider name: clock
    Description: The clock speed of the device’s CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.
    
  • frequency
    Type: STRING
    Provider name: frequency
    Description: The CPU’s frequency.
    
• fleet_name
  Type: STRING
  Provider name: fleetName
  Description: The name of the fleet to which this device belongs.
  
• fleet_type
  Type: STRING
  Provider name: fleetType
  Description: The type of fleet to which this device belongs. Possible values are PRIVATE and PUBLIC.
  
• form_factor
  Type: STRING
  Provider name: formFactor
  Description: The device’s form factor. Allowed values include:
  • PHONE
  • TABLET
• heap_size
  Type: INT64
  Provider name: heapSize
  Description: The device’s heap size, expressed in bytes.
  
• image
  Type: STRING
  Provider name: image
  Description: The device’s image name.
  
• instances
  Type: UNORDERED_LIST_STRUCT
  Provider name: instances
  Description: The instances that belong to this device.
  
  • arn
    Type: STRING
    Provider name: arn
    Description: The Amazon Resource Name (ARN) of the device instance.
    
  • device_arn
    Type: STRING
    Provider name: deviceArn
    Description: The ARN of the device.
    
  • instance_profile
    Type: STRUCT
    Provider name: instanceProfile
    Description: A object that contains information about the instance profile.
    
    • arn
      Type: STRING
      Provider name: arn
      Description: The Amazon Resource Name (ARN) of the instance profile.
      
    • description
      Type: STRING
      Provider name: description
      Description: The description of the instance profile.
      
    • exclude_app_packages_from_cleanup
      Type: UNORDERED_LIST_STRING
      Provider name: excludeAppPackagesFromCleanup
      Description: 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.
      
    • name
      Type: STRING
      Provider name: name
      Description: The name of the instance profile.
      
    • package_cleanup
      Type: BOOLEAN
      Provider name: packageCleanup
      Description: When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
      
    • reboot_after_use
      Type: BOOLEAN
      Provider name: rebootAfterUse
      Description: When set to true, Device Farm reboots the instance after a test run. The default value is true.
      
  • labels
    Type: UNORDERED_LIST_STRING
    Provider name: labels
    Description: An array of strings that describe the device instance.
    
  • status
    Type: STRING
    Provider name: status
    Description: The status of the device instance. Valid values are listed here.
    
  • udid
    Type: STRING
    Provider name: udid
    Description: Unique device identifier for the device instance.
    
• manufacturer
  Type: STRING
  Provider name: manufacturer
  Description: The device’s manufacturer name.
  
• memory
  Type: INT64
  Provider name: memory
  Description: The device’s total memory size, expressed in bytes.
  
• model
  Type: STRING
  Provider name: model
  Description: The device’s model name.
  
• model_id
  Type: STRING
  Provider name: modelId
  Description: The device’s model ID.
  
• name
  Type: STRING
  Provider name: name
  Description: The device’s display name.
  
• os
  Type: STRING
  Provider name: os
  Description: The device’s operating system type.
  
• platform
  Type: STRING
  Provider name: platform
  Description: The device’s platform. Allowed values include:
  • ANDROID
  • IOS
• radio
  Type: STRING
  Provider name: radio
  Description: The device’s radio.
  
• remote_access_enabled
  Type: BOOLEAN
  Provider name: remoteAccessEnabled
  Description: Specifies whether remote access has been enabled for the specified device.
  
• remote_debug_enabled
  Type: BOOLEAN
  Provider name: remoteDebugEnabled
  Description: This flag is set to true if remote debugging is enabled for the device. Remote debugging is no longer supported.
  
• resolution
  Type: STRUCT
  Provider name: resolution
  Description: The resolution of the device.
  
  • height
    Type: INT32
    Provider name: height
    Description: The screen resolution’s height, expressed in pixels.
    
  • width
    Type: INT32
    Provider name: width
    Description: The screen resolution’s width, expressed in pixels.
    

device_minutes

Type: STRUCT
Provider name: deviceMinutes
Description: The number of minutes a device is used in a remote access session (including setup and teardown minutes).

• metered
  Type: DOUBLE
  Provider name: metered
  Description: When specified, represents only the sum of metered minutes used by the resource to run tests.
  
• total
  Type: DOUBLE
  Provider name: total
  Description: When specified, represents the total minutes used by the resource to run tests.
  
• unmetered
  Type: DOUBLE
  Provider name: unmetered
  Description: When specified, represents only the sum of unmetered minutes used by the resource to run tests.
  

device_proxy

Type: STRUCT
Provider name: deviceProxy
Description: The device proxy configured for the remote access session.

• host
  Type: STRING
  Provider name: host
  Description: Hostname or IPv4 address of the proxy.
  
• port
  Type: INT32
  Provider name: port
  Description: The port number on which the http/s proxy is listening.
  

device_udid

Type: STRING
Provider name: deviceUdid
Description: 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

Type: STRING
Provider name: endpoint
Description: The endpoint for the remote access sesssion.

host_address

Type: STRING
Provider name: hostAddress
Description: IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session. Remote debugging is no longer supported.

instance_arn

Type: STRING
Provider name: instanceArn
Description: The ARN of the instance.

interaction_mode

Type: STRING
Provider name: interactionMode
Description: The interaction mode of the remote access session. Valid values are:

• INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.
• NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.
• VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.

message

Type: STRING
Provider name: message
Description: A message about the remote access session.

name

Type: STRING
Provider name: name
Description: The name of the remote access session.

remote_debug_enabled

Type: BOOLEAN
Provider name: remoteDebugEnabled
Description: This flag is set to true if remote debugging is enabled for the remote access session. Remote debugging is no longer supported.

remote_record_app_arn

Type: STRING
Provider name: remoteRecordAppArn
Description: The ARN for the app to be recorded in the remote access session.

remote_record_enabled

Type: BOOLEAN
Provider name: remoteRecordEnabled
Description: This flag is set to true if remote recording is enabled for the remote access session.

result

Type: STRING
Provider name: result
Description: The result of the remote access session. Can be any of the following:

• PENDING.
• PASSED.
• WARNED.
• FAILED.
• SKIPPED.
• ERRORED.
• STOPPED.

skip_app_resign

Type: BOOLEAN
Provider name: skipAppResign
Description: 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

Type: TIMESTAMP
Provider name: started
Description: The date and time the remote access session was started.

status

Type: STRING
Provider name: status
Description: 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

Type: TIMESTAMP
Provider name: stopped
Description: The date and time the remote access session was stopped.

tags

Type: UNORDERED_LIST_STRING

vpc_config

Type: STRUCT
Provider name: vpcConfig
Description: The VPC security groups and subnets that are attached to a project.

• security_group_ids
  Type: UNORDERED_LIST_STRING
  Provider name: securityGroupIds
  Description: An array of one or more security groups IDs in your Amazon VPC.
  
• subnet_ids
  Type: UNORDERED_LIST_STRING
  Provider name: subnetIds
  Description: An array of one or more subnet IDs in your Amazon VPC.
  
• vpc_id
  Type: STRING
  Provider name: vpcId
  Description: The ID of the Amazon VPC.