Class: Aws::AppConfig::Types::ExperimentDefinition

Inherits:

Struct

• Object
• Struct
• Aws::AppConfig::Types::ExperimentDefinition

Includes:

Structure

Defined in:

lib/aws-sdk-appconfig/types.rb

Overview

Describes an experiment definition, including the target audience, feature flag, treatments, and current status.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

  The application ID.

• #audience_description ⇒ String

  A description of the intended audience for the experiment.

• #audience_rule ⇒ String

  The rule that defines which users are eligible to be assigned to treatments.

• #configuration_profile_id ⇒ String

  The configuration profile ID associated with the experiment.

• #control ⇒ Types::Treatment

  The control treatment used as the baseline for comparison.

• #created_at ⇒ Time

  The date and time the experiment definition was created, in ISO 8601 format.

• #environment_id ⇒ String

  The environment ID where the experiment runs.

• #flag_key ⇒ String

  The key of the feature flag used by the experiment.

• #hypothesis ⇒ String

  The hypothesis that the experiment is designed to validate.

• #id ⇒ String

  The experiment definition ID.

• #kms_key_identifier ⇒ String

  The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.

• #launch_criteria ⇒ String

  The conditions under which the winning treatment should be launched.

• #name ⇒ String

  The name of the experiment definition.

• #status ⇒ String

  The current status of the experiment definition.

• #treatments ⇒ Array<Types::Treatment>

  The list of treatments defined for the experiment.

• #updated_at ⇒ Time

  The date and time the experiment definition 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 1697

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#audience_description ⇒ String

A description of the intended audience for the experiment.

Returns:

• (String)

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

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#audience_rule ⇒ String

The rule that defines which users are eligible to be assigned to treatments.

Returns:

• (String)

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

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_profile_id ⇒ String

The configuration profile ID associated with the experiment.

Returns:

• (String)

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

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#control ⇒ Types::Treatment

The control treatment used as the baseline for comparison.

Returns:

• (Types::Treatment)

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

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The date and time the experiment definition was created, in ISO 8601 format.

Returns:

• (Time)

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

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#environment_id ⇒ String

The environment ID where the experiment runs.

Returns:

• (String)

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

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#flag_key ⇒ String

The key of the feature flag used by the experiment.

Returns:

• (String)

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

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#hypothesis ⇒ String

The hypothesis that the experiment is designed to validate.

Returns:

• (String)

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

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The experiment definition ID.

Returns:

• (String)

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

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_identifier ⇒ String

The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.

Returns:

• (String)

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

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#launch_criteria ⇒ String

The conditions under which the winning treatment should be launched.

Returns:

• (String)

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

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the experiment definition.

Returns:

• (String)

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

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the experiment definition. Valid values: ACTIVE, IDLE, ARCHIVED.

Returns:

• (String)

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

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#treatments ⇒ Array<Types::Treatment>

The list of treatments defined for the experiment.

Returns:

• (Array<Types::Treatment>)

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

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

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

Returns:

• (Time)

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

class ExperimentDefinition < Struct.new(
  :application_id,
  :id,
  :name,
  :hypothesis,
  :status,
  :configuration_profile_id,
  :environment_id,
  :flag_key,
  :audience_rule,
  :audience_description,
  :launch_criteria,
  :treatments,
  :control,
  :created_at,
  :updated_at,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end