Class: Aws::DeviceFarm::Types::ScheduleRunConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::DeviceFarm::Types::ScheduleRunConfiguration

Defined in:

gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb

Overview

Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auxiliary_apps ⇒ Array<String>

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

• #billing_method ⇒ String

  Specifies the billing method for a test run: metered or unmetered.

• #customer_artifact_paths ⇒ Types::CustomerArtifactPaths

  Input CustomerArtifactPaths object for the scheduled run configuration.

• #device_proxy ⇒ Types::DeviceProxy

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

• #environment_variables ⇒ Array<Types::EnvironmentVariable>

  Environment variables associated with the run.

• #execution_role_arn ⇒ String

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

• #extra_data_package_arn ⇒ String

  The ARN of the extra data for the run.

• #insights_types ⇒ Array<String>

  The types of insights to generate for a run.

• #locale ⇒ String

  Information about the locale that is used for the run.

• #location ⇒ Types::Location

  Information about the location that is used for the run.

• #network_profile_arn ⇒ String

  Reserved for internal use.

• #radios ⇒ Types::Radios

  Information about the radio states for the run.

• #vpce_configuration_arns ⇒ Array<String>

  An array of ARNs for your VPC endpoint configurations.

Instance Attribute Details

#auxiliary_apps ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 5200

class ScheduleRunConfiguration < Struct.new(
  :extra_data_package_arn,
  :network_profile_arn,
  :locale,
  :location,
  :vpce_configuration_arns,
  :device_proxy,
  :customer_artifact_paths,
  :radios,
  :auxiliary_apps,
  :billing_method,
  :environment_variables,
  :execution_role_arn,
  :insights_types)
  SENSITIVE = []
  include Aws::Structure
end

#billing_method ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 5200

class ScheduleRunConfiguration < Struct.new(
  :extra_data_package_arn,
  :network_profile_arn,
  :locale,
  :location,
  :vpce_configuration_arns,
  :device_proxy,
  :customer_artifact_paths,
  :radios,
  :auxiliary_apps,
  :billing_method,
  :environment_variables,
  :execution_role_arn,
  :insights_types)
  SENSITIVE = []
  include Aws::Structure
end

#customer_artifact_paths ⇒ Types::CustomerArtifactPaths

Input CustomerArtifactPaths object for the scheduled run configuration.

Returns:

• (Types::CustomerArtifactPaths)

# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 5200

class ScheduleRunConfiguration < Struct.new(
  :extra_data_package_arn,
  :network_profile_arn,
  :locale,
  :location,
  :vpce_configuration_arns,
  :device_proxy,
  :customer_artifact_paths,
  :radios,
  :auxiliary_apps,
  :billing_method,
  :environment_variables,
  :execution_role_arn,
  :insights_types)
  SENSITIVE = []
  include Aws::Structure
end

#device_proxy ⇒ Types::DeviceProxy

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

Returns:

• (Types::DeviceProxy)

# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 5200

class ScheduleRunConfiguration < Struct.new(
  :extra_data_package_arn,
  :network_profile_arn,
  :locale,
  :location,
  :vpce_configuration_arns,
  :device_proxy,
  :customer_artifact_paths,
  :radios,
  :auxiliary_apps,
  :billing_method,
  :environment_variables,
  :execution_role_arn,
  :insights_types)
  SENSITIVE = []
  include Aws::Structure
end

#environment_variables ⇒ Array<Types::EnvironmentVariable>

Environment variables associated with the run.

Returns:

• (Array<Types::EnvironmentVariable>)

# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 5200

class ScheduleRunConfiguration < Struct.new(
  :extra_data_package_arn,
  :network_profile_arn,
  :locale,
  :location,
  :vpce_configuration_arns,
  :device_proxy,
  :customer_artifact_paths,
  :radios,
  :auxiliary_apps,
  :billing_method,
  :environment_variables,
  :execution_role_arn,
  :insights_types)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 5200

class ScheduleRunConfiguration < Struct.new(
  :extra_data_package_arn,
  :network_profile_arn,
  :locale,
  :location,
  :vpce_configuration_arns,
  :device_proxy,
  :customer_artifact_paths,
  :radios,
  :auxiliary_apps,
  :billing_method,
  :environment_variables,
  :execution_role_arn,
  :insights_types)
  SENSITIVE = []
  include Aws::Structure
end

#extra_data_package_arn ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 5200

class ScheduleRunConfiguration < Struct.new(
  :extra_data_package_arn,
  :network_profile_arn,
  :locale,
  :location,
  :vpce_configuration_arns,
  :device_proxy,
  :customer_artifact_paths,
  :radios,
  :auxiliary_apps,
  :billing_method,
  :environment_variables,
  :execution_role_arn,
  :insights_types)
  SENSITIVE = []
  include Aws::Structure
end

#insights_types ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 5200

class ScheduleRunConfiguration < Struct.new(
  :extra_data_package_arn,
  :network_profile_arn,
  :locale,
  :location,
  :vpce_configuration_arns,
  :device_proxy,
  :customer_artifact_paths,
  :radios,
  :auxiliary_apps,
  :billing_method,
  :environment_variables,
  :execution_role_arn,
  :insights_types)
  SENSITIVE = []
  include Aws::Structure
end

#locale ⇒ String

Information about the locale that is used for the run.

Returns:

• (String)

# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 5200

class ScheduleRunConfiguration < Struct.new(
  :extra_data_package_arn,
  :network_profile_arn,
  :locale,
  :location,
  :vpce_configuration_arns,
  :device_proxy,
  :customer_artifact_paths,
  :radios,
  :auxiliary_apps,
  :billing_method,
  :environment_variables,
  :execution_role_arn,
  :insights_types)
  SENSITIVE = []
  include Aws::Structure
end

#location ⇒ Types::Location

Information about the location that is used for the run.

Returns:

• (Types::Location)

# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 5200

class ScheduleRunConfiguration < Struct.new(
  :extra_data_package_arn,
  :network_profile_arn,
  :locale,
  :location,
  :vpce_configuration_arns,
  :device_proxy,
  :customer_artifact_paths,
  :radios,
  :auxiliary_apps,
  :billing_method,
  :environment_variables,
  :execution_role_arn,
  :insights_types)
  SENSITIVE = []
  include Aws::Structure
end

#network_profile_arn ⇒ String

Reserved for internal use.

Returns:

• (String)

# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 5200

class ScheduleRunConfiguration < Struct.new(
  :extra_data_package_arn,
  :network_profile_arn,
  :locale,
  :location,
  :vpce_configuration_arns,
  :device_proxy,
  :customer_artifact_paths,
  :radios,
  :auxiliary_apps,
  :billing_method,
  :environment_variables,
  :execution_role_arn,
  :insights_types)
  SENSITIVE = []
  include Aws::Structure
end

#radios ⇒ Types::Radios

Information about the radio states for the run.

Returns:

• (Types::Radios)

# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 5200

class ScheduleRunConfiguration < Struct.new(
  :extra_data_package_arn,
  :network_profile_arn,
  :locale,
  :location,
  :vpce_configuration_arns,
  :device_proxy,
  :customer_artifact_paths,
  :radios,
  :auxiliary_apps,
  :billing_method,
  :environment_variables,
  :execution_role_arn,
  :insights_types)
  SENSITIVE = []
  include Aws::Structure
end

#vpce_configuration_arns ⇒ Array<String>

An array of ARNs for your VPC endpoint configurations.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 5200

class ScheduleRunConfiguration < Struct.new(
  :extra_data_package_arn,
  :network_profile_arn,
  :locale,
  :location,
  :vpce_configuration_arns,
  :device_proxy,
  :customer_artifact_paths,
  :radios,
  :auxiliary_apps,
  :billing_method,
  :environment_variables,
  :execution_role_arn,
  :insights_types)
  SENSITIVE = []
  include Aws::Structure
end