Skip to content

Latest commit

 

History

History
199 lines (170 loc) · 8.81 KB

types.md

File metadata and controls

199 lines (170 loc) · 8.81 KB
Raw

AWS.Evidently @ default

Resource AWS.Evidently/Experiment@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.Evidently/Feature@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.Evidently/FeatureProperties (Required): properties of the resource

Resource AWS.Evidently/Launch@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.Evidently/LaunchProperties (Required): properties of the resource

Resource AWS.Evidently/Project@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.Evidently/ProjectProperties (Required): properties of the resource

AWS.Evidently/ExperimentProperties

Properties

  • Arn: string (ReadOnly, Identifier)
  • Description: string
  • MetricGoals: MetricGoalObject[] (Required)
  • Name: string (Required)
  • OnlineAbConfig: OnlineAbConfigObject (Required)
  • Project: string (Required)
  • RandomizationSalt: string
  • RemoveSegment: bool
  • RunningStatus: RunningStatusObject: Start Experiment. Default is False
  • SamplingRate: int
  • Segment: string
  • Tags: Tag[]: An array of key-value pairs to apply to this resource.
  • Treatments: TreatmentObject[] (Required)

MetricGoalObject

Properties

  • DesiredChange: string (Required)
  • EntityIdKey: string (Required): The JSON path to reference the entity id in the event.
  • EventPattern: string: Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.
  • MetricName: string (Required)
  • UnitLabel: string
  • ValueKey: string (Required): The JSON path to reference the numerical metric value in the event.

OnlineAbConfigObject

Properties

TreatmentToWeight

Properties

  • SplitWeight: int (Required)
  • Treatment: string (Required)

RunningStatusObject

Properties

  • AnalysisCompleteTime: string: Provide the analysis Completion time for an experiment
  • DesiredState: string: Provide CANCELLED or COMPLETED desired state when stopping an experiment
  • Reason: string: Reason is a required input for stopping the experiment
  • Status: string (Required): Provide START or STOP action to apply on an experiment

Tag

Properties

  • Key: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
  • Value: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

TreatmentObject

Properties

  • Description: string
  • Feature: string (Required)
  • TreatmentName: string (Required)
  • Variation: string (Required)

AWS.Evidently/FeatureProperties

Properties

  • Arn: string (ReadOnly, Identifier)
  • DefaultVariation: string
  • Description: string
  • EntityOverrides: EntityOverride[]
  • EvaluationStrategy: string
  • Name: string (Required)
  • Project: string (Required)
  • Tags: Tag[]: An array of key-value pairs to apply to this resource.
  • Variations: VariationObject[] (Required)

EntityOverride

Properties

  • EntityId: string
  • Variation: string

Tag

Properties

  • Key: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
  • Value: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

VariationObject

Properties

  • BooleanValue: bool
  • DoubleValue: int
  • LongValue: int
  • StringValue: string
  • VariationName: string (Required)

AWS.Evidently/LaunchProperties

Properties

  • Arn: string (ReadOnly, Identifier)
  • Description: string
  • ExecutionStatus: ExecutionStatusObject: Start or Stop Launch Launch. Default is not started.
  • Groups: LaunchGroupObject[] (Required)
  • MetricMonitors: MetricDefinitionObject[]
  • Name: string (Required)
  • Project: string (Required)
  • RandomizationSalt: string
  • ScheduledSplitsConfig: StepConfig[] (Required)
  • Tags: Tag[]: An array of key-value pairs to apply to this resource.

ExecutionStatusObject

Properties

  • DesiredState: string: Provide CANCELLED or COMPLETED as the launch desired state. Defaults to Completed if not provided.
  • Reason: string: Provide a reason for stopping the launch. Defaults to empty if not provided.
  • Status: string (Required): Provide START or STOP action to apply on a launch

LaunchGroupObject

Properties

  • Description: string
  • Feature: string (Required)
  • GroupName: string (Required)
  • Variation: string (Required)

MetricDefinitionObject

Properties

  • EntityIdKey: string (Required): The JSON path to reference the entity id in the event.
  • EventPattern: string: Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.
  • MetricName: string (Required)
  • UnitLabel: string
  • ValueKey: string (Required): The JSON path to reference the numerical metric value in the event.

StepConfig

Properties

GroupToWeight

Properties

  • GroupName: string (Required)
  • SplitWeight: int (Required)

SegmentOverride

Properties

  • EvaluationOrder: int (Required)
  • Segment: string (Required)
  • Weights: GroupToWeight[] (Required)

Tag

Properties

  • Key: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
  • Value: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

AWS.Evidently/ProjectProperties

Properties

  • AppConfigResource: AppConfigResourceObject
  • Arn: string (ReadOnly, Identifier)
  • DataDelivery: DataDeliveryObject
  • Description: string
  • Name: string (Required)
  • Tags: Tag[]: An array of key-value pairs to apply to this resource.

AppConfigResourceObject

Properties

  • ApplicationId: string (Required)
  • EnvironmentId: string (Required)

DataDeliveryObject

Properties

S3Destination

Properties

  • BucketName: string (Required)
  • Prefix: string

Tag

Properties

  • Key: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
  • Value: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.