Class: Aws::AppConfig::Types::ExperimentRun

Inherits:

Struct

• Object
• Struct
• Aws::AppConfig::Types::ExperimentRun

Includes:

Structure

Defined in:

lib/aws-sdk-appconfig/types.rb

Overview

Describes an experiment run, including its status, exposure settings, and treatment overrides.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

  The application ID.

• #description ⇒ String

  A description of the experiment run.

• #ended_at ⇒ Time

  The date and time the experiment run ended, in ISO 8601 format.

• #experiment_definition_id ⇒ String

  The experiment definition ID.

• #experiment_definition_snapshot ⇒ Types::ExperimentDefinitionSnapshot

  A snapshot of the experiment definition at the time the run was started.

• #exposure_percentage ⇒ Float

  The percentage of the target audience exposed to treatments.

• #result ⇒ Types::ExperimentRunResult

  The result of the experiment run, including the executive summary and launch decision rationale.

• #run ⇒ Integer

  The experiment run number.

• #started_at ⇒ Time

  The date and time the experiment run started, in ISO 8601 format.

• #status ⇒ String

  The current status of the experiment run.

• #treatment_overrides ⇒ Types::TreatmentOverrides

  Treatment assignment overrides that assign specific entity IDs to treatments.

• #updated_at ⇒ Time

  The date and time the experiment run was last updated, in ISO 8601 format.

Instance Attribute Details

#application_id ⇒ String

The application ID.

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 1928

class ExperimentRun < Struct.new(
  :application_id,
  :experiment_definition_id,
  :run,
  :description,
  :status,
  :exposure_percentage,
  :treatment_overrides,
  :result,
  :started_at,
  :updated_at,
  :ended_at,
  :experiment_definition_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the experiment run.

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 1928

class ExperimentRun < Struct.new(
  :application_id,
  :experiment_definition_id,
  :run,
  :description,
  :status,
  :exposure_percentage,
  :treatment_overrides,
  :result,
  :started_at,
  :updated_at,
  :ended_at,
  :experiment_definition_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

#ended_at ⇒ Time

The date and time the experiment run ended, in ISO 8601 format.

Returns:

• (Time)

# File 'lib/aws-sdk-appconfig/types.rb', line 1928

class ExperimentRun < Struct.new(
  :application_id,
  :experiment_definition_id,
  :run,
  :description,
  :status,
  :exposure_percentage,
  :treatment_overrides,
  :result,
  :started_at,
  :updated_at,
  :ended_at,
  :experiment_definition_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

#experiment_definition_id ⇒ String

The experiment definition ID.

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 1928

class ExperimentRun < Struct.new(
  :application_id,
  :experiment_definition_id,
  :run,
  :description,
  :status,
  :exposure_percentage,
  :treatment_overrides,
  :result,
  :started_at,
  :updated_at,
  :ended_at,
  :experiment_definition_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

#experiment_definition_snapshot ⇒ Types::ExperimentDefinitionSnapshot

A snapshot of the experiment definition at the time the run was started.

Returns:

• (Types::ExperimentDefinitionSnapshot)

# File 'lib/aws-sdk-appconfig/types.rb', line 1928

class ExperimentRun < Struct.new(
  :application_id,
  :experiment_definition_id,
  :run,
  :description,
  :status,
  :exposure_percentage,
  :treatment_overrides,
  :result,
  :started_at,
  :updated_at,
  :ended_at,
  :experiment_definition_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

#exposure_percentage ⇒ Float

The percentage of the target audience exposed to treatments.

Returns:

• (Float)

# File 'lib/aws-sdk-appconfig/types.rb', line 1928

class ExperimentRun < Struct.new(
  :application_id,
  :experiment_definition_id,
  :run,
  :description,
  :status,
  :exposure_percentage,
  :treatment_overrides,
  :result,
  :started_at,
  :updated_at,
  :ended_at,
  :experiment_definition_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

#result ⇒ Types::ExperimentRunResult

The result of the experiment run, including the executive summary and launch decision rationale.

Returns:

• (Types::ExperimentRunResult)

# File 'lib/aws-sdk-appconfig/types.rb', line 1928

class ExperimentRun < Struct.new(
  :application_id,
  :experiment_definition_id,
  :run,
  :description,
  :status,
  :exposure_percentage,
  :treatment_overrides,
  :result,
  :started_at,
  :updated_at,
  :ended_at,
  :experiment_definition_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

#run ⇒ Integer

The experiment run number.

Returns:

• (Integer)

# File 'lib/aws-sdk-appconfig/types.rb', line 1928

class ExperimentRun < Struct.new(
  :application_id,
  :experiment_definition_id,
  :run,
  :description,
  :status,
  :exposure_percentage,
  :treatment_overrides,
  :result,
  :started_at,
  :updated_at,
  :ended_at,
  :experiment_definition_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

#started_at ⇒ Time

The date and time the experiment run started, in ISO 8601 format.

Returns:

• (Time)

# File 'lib/aws-sdk-appconfig/types.rb', line 1928

class ExperimentRun < Struct.new(
  :application_id,
  :experiment_definition_id,
  :run,
  :description,
  :status,
  :exposure_percentage,
  :treatment_overrides,
  :result,
  :started_at,
  :updated_at,
  :ended_at,
  :experiment_definition_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the experiment run. Valid values: RUNNING, DONE.

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 1928

class ExperimentRun < Struct.new(
  :application_id,
  :experiment_definition_id,
  :run,
  :description,
  :status,
  :exposure_percentage,
  :treatment_overrides,
  :result,
  :started_at,
  :updated_at,
  :ended_at,
  :experiment_definition_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

#treatment_overrides ⇒ Types::TreatmentOverrides

Treatment assignment overrides that assign specific entity IDs to treatments.

Returns:

• (Types::TreatmentOverrides)

# File 'lib/aws-sdk-appconfig/types.rb', line 1928

class ExperimentRun < Struct.new(
  :application_id,
  :experiment_definition_id,
  :run,
  :description,
  :status,
  :exposure_percentage,
  :treatment_overrides,
  :result,
  :started_at,
  :updated_at,
  :ended_at,
  :experiment_definition_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The date and time the experiment run was last updated, in ISO 8601 format.

Returns:

• (Time)

# File 'lib/aws-sdk-appconfig/types.rb', line 1928

class ExperimentRun < Struct.new(
  :application_id,
  :experiment_definition_id,
  :run,
  :description,
  :status,
  :exposure_percentage,
  :treatment_overrides,
  :result,
  :started_at,
  :updated_at,
  :ended_at,
  :experiment_definition_snapshot)
  SENSITIVE = []
  include Aws::Structure
end