Class: Aws::CloudWatchEvidently::Types::Feature

Inherits:

Struct

Object
Struct
Aws::CloudWatchEvidently::Types::Feature

show all

Defined in:: gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb

Overview

This structure contains information about one Evidently feature in your account.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#arn ⇒ String
The ARN of the feature.
#created_time ⇒ Time
The date and time that the feature is created.
#default_variation ⇒ String
The name of the variation that is used as the default variation.
#description ⇒ String
The description of the feature.
#entity_overrides ⇒ Hash<String,String>
A set of key-value pairs that specify users who should always be served a specific variation of a feature.
#evaluation_rules ⇒ Array<Types::EvaluationRule>
An array of structures that define the evaluation rules for the feature.
#evaluation_strategy ⇒ String
If this value is ALL_RULES, the traffic allocation specified by any ongoing launches or experiments is being used.
#last_updated_time ⇒ Time
The date and time that the feature was most recently updated.
#name ⇒ String
The name of the feature.
#project ⇒ String
The name or ARN of the project that contains the feature.
#status ⇒ String
The current state of the feature.
#tags ⇒ Hash<String,String>
The list of tag keys and values associated with this feature.
#value_type ⇒ String
Defines the type of value used to define the different feature variations.
#variations ⇒ Array<Types::Variation>
An array of structures that contain the configuration of the feature's different variations.

Instance Attribute Details

#arn ⇒ `String`

The ARN of the feature.

Returns:

(String)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 1153

class Feature < Struct.new(
  :arn,
  :created_time,
  :default_variation,
  :description,
  :entity_overrides,
  :evaluation_rules,
  :evaluation_strategy,
  :last_updated_time,
  :name,
  :project,
  :status,
  :tags,
  :value_type,
  :variations)
  SENSITIVE = []
  include Aws::Structure
end

#created_time ⇒ `Time`

The date and time that the feature is created.

Returns:

(Time)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 1153

class Feature < Struct.new(
  :arn,
  :created_time,
  :default_variation,
  :description,
  :entity_overrides,
  :evaluation_rules,
  :evaluation_strategy,
  :last_updated_time,
  :name,
  :project,
  :status,
  :tags,
  :value_type,
  :variations)
  SENSITIVE = []
  include Aws::Structure
end

#default_variation ⇒ `String`

The name of the variation that is used as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

This variation must also be listed in the variations structure.

If you omit defaultVariation, the first variation listed in the variations structure is used as the default variation.

Returns:

(String)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 1153

class Feature < Struct.new(
  :arn,
  :created_time,
  :default_variation,
  :description,
  :entity_overrides,
  :evaluation_rules,
  :evaluation_strategy,
  :last_updated_time,
  :name,
  :project,
  :status,
  :tags,
  :value_type,
  :variations)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

The description of the feature.

Returns:

(String)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 1153

class Feature < Struct.new(
  :arn,
  :created_time,
  :default_variation,
  :description,
  :entity_overrides,
  :evaluation_rules,
  :evaluation_strategy,
  :last_updated_time,
  :name,
  :project,
  :status,
  :tags,
  :value_type,
  :variations)
  SENSITIVE = []
  include Aws::Structure
end

#entity_overrides ⇒ `Hash<String,String>`

A set of key-value pairs that specify users who should always be served a specific variation of a feature. Each key specifies a user using their user ID, account ID, or some other identifier. The value specifies the name of the variation that the user is to be served.

For the override to be successful, the value of the key must match the entityId used in the EvaluateFeature operation.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 1153

class Feature < Struct.new(
  :arn,
  :created_time,
  :default_variation,
  :description,
  :entity_overrides,
  :evaluation_rules,
  :evaluation_strategy,
  :last_updated_time,
  :name,
  :project,
  :status,
  :tags,
  :value_type,
  :variations)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_rules ⇒ `Array<Types::EvaluationRule>`

An array of structures that define the evaluation rules for the feature.

Returns:

(Array<Types::EvaluationRule>)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 1153

class Feature < Struct.new(
  :arn,
  :created_time,
  :default_variation,
  :description,
  :entity_overrides,
  :evaluation_rules,
  :evaluation_strategy,
  :last_updated_time,
  :name,
  :project,
  :status,
  :tags,
  :value_type,
  :variations)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_strategy ⇒ `String`

If this value is ALL_RULES, the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION, the default variation is being served to all users.

Returns:

(String)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 1153

class Feature < Struct.new(
  :arn,
  :created_time,
  :default_variation,
  :description,
  :entity_overrides,
  :evaluation_rules,
  :evaluation_strategy,
  :last_updated_time,
  :name,
  :project,
  :status,
  :tags,
  :value_type,
  :variations)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time ⇒ `Time`

The date and time that the feature was most recently updated.

Returns:

(Time)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 1153

class Feature < Struct.new(
  :arn,
  :created_time,
  :default_variation,
  :description,
  :entity_overrides,
  :evaluation_rules,
  :evaluation_strategy,
  :last_updated_time,
  :name,
  :project,
  :status,
  :tags,
  :value_type,
  :variations)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the feature.

Returns:

(String)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 1153

class Feature < Struct.new(
  :arn,
  :created_time,
  :default_variation,
  :description,
  :entity_overrides,
  :evaluation_rules,
  :evaluation_strategy,
  :last_updated_time,
  :name,
  :project,
  :status,
  :tags,
  :value_type,
  :variations)
  SENSITIVE = []
  include Aws::Structure
end

#project ⇒ `String`

The name or ARN of the project that contains the feature.

Returns:

(String)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 1153

class Feature < Struct.new(
  :arn,
  :created_time,
  :default_variation,
  :description,
  :entity_overrides,
  :evaluation_rules,
  :evaluation_strategy,
  :last_updated_time,
  :name,
  :project,
  :status,
  :tags,
  :value_type,
  :variations)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The current state of the feature.

Returns:

(String)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 1153

class Feature < Struct.new(
  :arn,
  :created_time,
  :default_variation,
  :description,
  :entity_overrides,
  :evaluation_rules,
  :evaluation_strategy,
  :last_updated_time,
  :name,
  :project,
  :status,
  :tags,
  :value_type,
  :variations)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

The list of tag keys and values associated with this feature.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 1153

class Feature < Struct.new(
  :arn,
  :created_time,
  :default_variation,
  :description,
  :entity_overrides,
  :evaluation_rules,
  :evaluation_strategy,
  :last_updated_time,
  :name,
  :project,
  :status,
  :tags,
  :value_type,
  :variations)
  SENSITIVE = []
  include Aws::Structure
end

#value_type ⇒ `String`

Defines the type of value used to define the different feature variations. For more information, see Variation types

Returns:

(String)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 1153

class Feature < Struct.new(
  :arn,
  :created_time,
  :default_variation,
  :description,
  :entity_overrides,
  :evaluation_rules,
  :evaluation_strategy,
  :last_updated_time,
  :name,
  :project,
  :status,
  :tags,
  :value_type,
  :variations)
  SENSITIVE = []
  include Aws::Structure
end

#variations ⇒ `Array<Types::Variation>`

An array of structures that contain the configuration of the feature's different variations.

Returns:

(Array<Types::Variation>)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 1153

class Feature < Struct.new(
  :arn,
  :created_time,
  :default_variation,
  :description,
  :entity_overrides,
  :evaluation_rules,
  :evaluation_strategy,
  :last_updated_time,
  :name,
  :project,
  :status,
  :tags,
  :value_type,
  :variations)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::CloudWatchEvidently::Types::Feature

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

#created_time ⇒ Time

#default_variation ⇒ String

#description ⇒ String

#entity_overrides ⇒ Hash<String,String>

#evaluation_rules ⇒ Array<Types::EvaluationRule>

#evaluation_strategy ⇒ String

#last_updated_time ⇒ Time

#name ⇒ String

#project ⇒ String

#status ⇒ String

#tags ⇒ Hash<String,String>

#value_type ⇒ String

#variations ⇒ Array<Types::Variation>

#arn ⇒ `String`

#created_time ⇒ `Time`

#default_variation ⇒ `String`

#description ⇒ `String`

#entity_overrides ⇒ `Hash<String,String>`

#evaluation_rules ⇒ `Array<Types::EvaluationRule>`

#evaluation_strategy ⇒ `String`

#last_updated_time ⇒ `Time`

#name ⇒ `String`

#project ⇒ `String`

#status ⇒ `String`

#tags ⇒ `Hash<String,String>`

#value_type ⇒ `String`

#variations ⇒ `Array<Types::Variation>`