1. Packages
  2. AWS Native
  3. API Docs
  4. evidently
  5. getExperiment

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

aws-native.evidently.getExperiment

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

    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.
    MetricName string
    ValueKey string
    The JSON path to reference the numerical metric value 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.
    UnitLabel string
    DesiredChange ExperimentMetricGoalObjectDesiredChange
    EntityIdKey string
    The JSON path to reference the entity id in the event.
    MetricName string
    ValueKey string
    The JSON path to reference the numerical metric value 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.
    UnitLabel string
    desiredChange ExperimentMetricGoalObjectDesiredChange
    entityIdKey String
    The JSON path to reference the entity id in the event.
    metricName String
    valueKey String
    The JSON path to reference the numerical metric value 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.
    unitLabel String
    desiredChange ExperimentMetricGoalObjectDesiredChange
    entityIdKey string
    The JSON path to reference the entity id in the event.
    metricName string
    valueKey string
    The JSON path to reference the numerical metric value 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.
    unitLabel string
    desired_change ExperimentMetricGoalObjectDesiredChange
    entity_id_key str
    The JSON path to reference the entity id in the event.
    metric_name str
    value_key str
    The JSON path to reference the numerical metric value 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.
    unit_label str
    desiredChange "INCREASE" | "DECREASE"
    entityIdKey String
    The JSON path to reference the entity id in the event.
    metricName String
    valueKey String
    The JSON path to reference the numerical metric value 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.
    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

    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

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi