getExperiment

Resource Type definition for AWS::Evidently::Experiment.

Using getExperiment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getExperiment(args: GetExperimentArgs, opts?: InvokeOptions): Promise<GetExperimentResult>
function getExperimentOutput(args: GetExperimentOutputArgs, opts?: InvokeOptions): Output<GetExperimentResult>
def get_experiment(arn: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetExperimentResult
def get_experiment_output(arn: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetExperimentResult]
func LookupExperiment(ctx *Context, args *LookupExperimentArgs, opts ...InvokeOption) (*LookupExperimentResult, error)
func LookupExperimentOutput(ctx *Context, args *LookupExperimentOutputArgs, opts ...InvokeOption) LookupExperimentResultOutput

> Note: This function is named LookupExperiment in the Go SDK.

public static class GetExperiment 
{
    public static Task<GetExperimentResult> InvokeAsync(GetExperimentArgs args, InvokeOptions? opts = null)
    public static Output<GetExperimentResult> Invoke(GetExperimentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetExperimentResult> getExperiment(GetExperimentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws-native:evidently:getExperiment
  arguments:
    # arguments dictionary

The following arguments are supported:

Arn string
Arn string
arn String
arn string
arn str
arn String

getExperiment Result

The following output properties are available:

arn String
description String
metricGoals List<Property Map>
onlineAbConfig Property Map
randomizationSalt String
removeSegment Boolean
runningStatus Property Map

Start Experiment. Default is False

samplingRate Number
segment String
tags List<Property Map>

An array of key-value pairs to apply to this resource.

treatments List<Property Map>

Supporting Types

ExperimentMetricGoalObject

DesiredChange Pulumi.AwsNative.Evidently.ExperimentMetricGoalObjectDesiredChange
EntityIdKey string

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
ValueKey string

The JSON path to reference the numerical metric value in the event.

UnitLabel string
DesiredChange ExperimentMetricGoalObjectDesiredChange
EntityIdKey string

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
ValueKey string

The JSON path to reference the numerical metric value in the event.

UnitLabel string
desiredChange ExperimentMetricGoalObjectDesiredChange
entityIdKey String

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
valueKey String

The JSON path to reference the numerical metric value in the event.

unitLabel String
desiredChange ExperimentMetricGoalObjectDesiredChange
entityIdKey string

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
valueKey string

The JSON path to reference the numerical metric value in the event.

unitLabel string
desired_change ExperimentMetricGoalObjectDesiredChange
entity_id_key str

The JSON path to reference the entity id in the event.

event_pattern str

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.

metric_name str
value_key str

The JSON path to reference the numerical metric value in the event.

unit_label str
desiredChange "INCREASE" | "DECREASE"
entityIdKey String

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
valueKey String

The JSON path to reference the numerical metric value in the event.

unitLabel String

ExperimentMetricGoalObjectDesiredChange

ExperimentOnlineAbConfigObject

ExperimentRunningStatusObject

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

Provide START or STOP action to apply on an experiment

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

Provide START or STOP action to apply on an experiment

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

Provide START or STOP action to apply on an experiment

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

Provide START or STOP action to apply on an experiment

analysis_complete_time str

Provide the analysis Completion time for an experiment

desired_state str

Provide CANCELLED or COMPLETED desired state when stopping an experiment

reason str

Reason is a required input for stopping the experiment

status str

Provide START or STOP action to apply on an experiment

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

Provide START or STOP action to apply on an experiment

ExperimentTag

Key string

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

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 -.

Key string

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

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 -.

key String

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

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 -.

key string

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

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 -.

key str

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 str

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 -.

key String

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

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 -.

ExperimentTreatmentObject

Feature string
TreatmentName string
Variation string
Description string
Feature string
TreatmentName string
Variation string
Description string
feature String
treatmentName String
variation String
description String
feature string
treatmentName string
variation string
description string
feature String
treatmentName String
variation String
description String

ExperimentTreatmentToWeight

splitWeight Integer
treatment String
splitWeight number
treatment string
splitWeight Number
treatment String

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0