Docs Packages
  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.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.evidently.getExperiment

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

    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
    The ARN of the experiment. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment
    Arn string
    The ARN of the experiment. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment
    arn String
    The ARN of the experiment. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment
    arn string
    The ARN of the experiment. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment
    arn str
    The ARN of the experiment. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment
    arn String
    The ARN of the experiment. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment

    getExperiment Result

    The following output properties are available:

    Arn string
    The ARN of the experiment. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment
    Description string
    An optional description of the experiment.
    MetricGoals List<Pulumi.AwsNative.Evidently.Outputs.ExperimentMetricGoalObject>
    An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal. You can use up to three metrics in an experiment.
    OnlineAbConfig Pulumi.AwsNative.Evidently.Outputs.ExperimentOnlineAbConfigObject
    A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
    RandomizationSalt string
    When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the experiment name as the randomizationSalt .
    RemoveSegment bool
    Set this to true to remove the segment that is associated with this experiment. You can't use this parameter if the experiment is currently running.
    RunningStatus Pulumi.AwsNative.Evidently.Outputs.ExperimentRunningStatusObject
    Start Experiment. Default is False
    SamplingRate int

    The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

    This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.

    Segment string

    Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.

    For more information, see Segment rule pattern syntax .

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    Treatments List<Pulumi.AwsNative.Evidently.Outputs.ExperimentTreatmentObject>
    An array of structures that describe the configuration of each feature variation used in the experiment.
    Arn string
    The ARN of the experiment. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment
    Description string
    An optional description of the experiment.
    MetricGoals []ExperimentMetricGoalObject
    An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal. You can use up to three metrics in an experiment.
    OnlineAbConfig ExperimentOnlineAbConfigObject
    A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
    RandomizationSalt string
    When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the experiment name as the randomizationSalt .
    RemoveSegment bool
    Set this to true to remove the segment that is associated with this experiment. You can't use this parameter if the experiment is currently running.
    RunningStatus ExperimentRunningStatusObject
    Start Experiment. Default is False
    SamplingRate int

    The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

    This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.

    Segment string

    Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.

    For more information, see Segment rule pattern syntax .

    Tags Tag
    An array of key-value pairs to apply to this resource.
    Treatments []ExperimentTreatmentObject
    An array of structures that describe the configuration of each feature variation used in the experiment.
    arn String
    The ARN of the experiment. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment
    description String
    An optional description of the experiment.
    metricGoals List<ExperimentMetricGoalObject>
    An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal. You can use up to three metrics in an experiment.
    onlineAbConfig ExperimentOnlineAbConfigObject
    A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
    randomizationSalt String
    When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the experiment name as the randomizationSalt .
    removeSegment Boolean
    Set this to true to remove the segment that is associated with this experiment. You can't use this parameter if the experiment is currently running.
    runningStatus ExperimentRunningStatusObject
    Start Experiment. Default is False
    samplingRate Integer

    The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

    This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.

    segment String

    Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.

    For more information, see Segment rule pattern syntax .

    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    treatments List<ExperimentTreatmentObject>
    An array of structures that describe the configuration of each feature variation used in the experiment.
    arn string
    The ARN of the experiment. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment
    description string
    An optional description of the experiment.
    metricGoals ExperimentMetricGoalObject[]
    An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal. You can use up to three metrics in an experiment.
    onlineAbConfig ExperimentOnlineAbConfigObject
    A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
    randomizationSalt string
    When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the experiment name as the randomizationSalt .
    removeSegment boolean
    Set this to true to remove the segment that is associated with this experiment. You can't use this parameter if the experiment is currently running.
    runningStatus ExperimentRunningStatusObject
    Start Experiment. Default is False
    samplingRate number

    The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

    This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.

    segment string

    Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.

    For more information, see Segment rule pattern syntax .

    tags Tag[]
    An array of key-value pairs to apply to this resource.
    treatments ExperimentTreatmentObject[]
    An array of structures that describe the configuration of each feature variation used in the experiment.
    arn str
    The ARN of the experiment. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment
    description str
    An optional description of the experiment.
    metric_goals Sequence[ExperimentMetricGoalObject]
    An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal. You can use up to three metrics in an experiment.
    online_ab_config ExperimentOnlineAbConfigObject
    A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
    randomization_salt str
    When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the experiment name as the randomizationSalt .
    remove_segment bool
    Set this to true to remove the segment that is associated with this experiment. You can't use this parameter if the experiment is currently running.
    running_status ExperimentRunningStatusObject
    Start Experiment. Default is False
    sampling_rate int

    The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

    This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.

    segment str

    Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.

    For more information, see Segment rule pattern syntax .

    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    treatments Sequence[ExperimentTreatmentObject]
    An array of structures that describe the configuration of each feature variation used in the experiment.
    arn String
    The ARN of the experiment. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment
    description String
    An optional description of the experiment.
    metricGoals List<Property Map>
    An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal. You can use up to three metrics in an experiment.
    onlineAbConfig Property Map
    A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
    randomizationSalt String
    When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the experiment name as the randomizationSalt .
    removeSegment Boolean
    Set this to true to remove the segment that is associated with this experiment. You can't use this parameter if the experiment is currently running.
    runningStatus Property Map
    Start Experiment. Default is False
    samplingRate Number

    The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

    This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.

    segment String

    Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.

    For more information, see Segment rule pattern syntax .

    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    treatments List<Property Map>
    An array of structures that describe the configuration of each feature variation used in the experiment.

    Supporting Types

    ExperimentMetricGoalObject

    DesiredChange Pulumi.AwsNative.Evidently.ExperimentMetricGoalObjectDesiredChange

    INCREASE means that a variation with a higher number for this metric is performing better.

    DECREASE means that a variation with a lower number for this metric is performing better.

    EntityIdKey string
    The JSON path to reference the entity id in the event.
    MetricName string
    A name for the metric. It can include up to 255 characters.
    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
    A label for the units that the metric is measuring.
    DesiredChange ExperimentMetricGoalObjectDesiredChange

    INCREASE means that a variation with a higher number for this metric is performing better.

    DECREASE means that a variation with a lower number for this metric is performing better.

    EntityIdKey string
    The JSON path to reference the entity id in the event.
    MetricName string
    A name for the metric. It can include up to 255 characters.
    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
    A label for the units that the metric is measuring.
    desiredChange ExperimentMetricGoalObjectDesiredChange

    INCREASE means that a variation with a higher number for this metric is performing better.

    DECREASE means that a variation with a lower number for this metric is performing better.

    entityIdKey String
    The JSON path to reference the entity id in the event.
    metricName String
    A name for the metric. It can include up to 255 characters.
    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
    A label for the units that the metric is measuring.
    desiredChange ExperimentMetricGoalObjectDesiredChange

    INCREASE means that a variation with a higher number for this metric is performing better.

    DECREASE means that a variation with a lower number for this metric is performing better.

    entityIdKey string
    The JSON path to reference the entity id in the event.
    metricName string
    A name for the metric. It can include up to 255 characters.
    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
    A label for the units that the metric is measuring.
    desired_change ExperimentMetricGoalObjectDesiredChange

    INCREASE means that a variation with a higher number for this metric is performing better.

    DECREASE means that a variation with a lower number for this metric is performing better.

    entity_id_key str
    The JSON path to reference the entity id in the event.
    metric_name str
    A name for the metric. It can include up to 255 characters.
    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
    A label for the units that the metric is measuring.
    desiredChange "INCREASE" | "DECREASE"

    INCREASE means that a variation with a higher number for this metric is performing better.

    DECREASE means that a variation with a lower number for this metric is performing better.

    entityIdKey String
    The JSON path to reference the entity id in the event.
    metricName String
    A name for the metric. It can include up to 255 characters.
    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
    A label for the units that the metric is measuring.

    ExperimentMetricGoalObjectDesiredChange

    ExperimentOnlineAbConfigObject

    ControlTreatmentName string
    The name of the variation that is to be the default variation that the other variations are compared to.
    TreatmentWeights List<Pulumi.AwsNative.Evidently.Inputs.ExperimentTreatmentToWeight>
    A set of key-value pairs. The keys are treatment names, and the values are the portion of experiment traffic to be assigned to that treatment. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
    ControlTreatmentName string
    The name of the variation that is to be the default variation that the other variations are compared to.
    TreatmentWeights []ExperimentTreatmentToWeight
    A set of key-value pairs. The keys are treatment names, and the values are the portion of experiment traffic to be assigned to that treatment. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
    controlTreatmentName String
    The name of the variation that is to be the default variation that the other variations are compared to.
    treatmentWeights List<ExperimentTreatmentToWeight>
    A set of key-value pairs. The keys are treatment names, and the values are the portion of experiment traffic to be assigned to that treatment. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
    controlTreatmentName string
    The name of the variation that is to be the default variation that the other variations are compared to.
    treatmentWeights ExperimentTreatmentToWeight[]
    A set of key-value pairs. The keys are treatment names, and the values are the portion of experiment traffic to be assigned to that treatment. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
    control_treatment_name str
    The name of the variation that is to be the default variation that the other variations are compared to.
    treatment_weights Sequence[ExperimentTreatmentToWeight]
    A set of key-value pairs. The keys are treatment names, and the values are the portion of experiment traffic to be assigned to that treatment. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
    controlTreatmentName String
    The name of the variation that is to be the default variation that the other variations are compared to.
    treatmentWeights List<Property Map>
    A set of key-value pairs. The keys are treatment names, and the values are the portion of experiment traffic to be assigned to that treatment. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

    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
    The name of the feature for this experiment.
    TreatmentName string
    A name for this treatment. It can include up to 127 characters.
    Variation string
    The name of the variation to use for this treatment.
    Description string
    The description of the treatment.
    Feature string
    The name of the feature for this experiment.
    TreatmentName string
    A name for this treatment. It can include up to 127 characters.
    Variation string
    The name of the variation to use for this treatment.
    Description string
    The description of the treatment.
    feature String
    The name of the feature for this experiment.
    treatmentName String
    A name for this treatment. It can include up to 127 characters.
    variation String
    The name of the variation to use for this treatment.
    description String
    The description of the treatment.
    feature string
    The name of the feature for this experiment.
    treatmentName string
    A name for this treatment. It can include up to 127 characters.
    variation string
    The name of the variation to use for this treatment.
    description string
    The description of the treatment.
    feature str
    The name of the feature for this experiment.
    treatment_name str
    A name for this treatment. It can include up to 127 characters.
    variation str
    The name of the variation to use for this treatment.
    description str
    The description of the treatment.
    feature String
    The name of the feature for this experiment.
    treatmentName String
    A name for this treatment. It can include up to 127 characters.
    variation String
    The name of the variation to use for this treatment.
    description String
    The description of the treatment.

    ExperimentTreatmentToWeight

    SplitWeight int
    The portion of experiment traffic to allocate to this treatment. Specify the traffic portion in thousandths of a percent, so 20,000 allocated to a treatment would allocate 20% of the experiment traffic to that treatment.
    Treatment string
    The name of the treatment.
    SplitWeight int
    The portion of experiment traffic to allocate to this treatment. Specify the traffic portion in thousandths of a percent, so 20,000 allocated to a treatment would allocate 20% of the experiment traffic to that treatment.
    Treatment string
    The name of the treatment.
    splitWeight Integer
    The portion of experiment traffic to allocate to this treatment. Specify the traffic portion in thousandths of a percent, so 20,000 allocated to a treatment would allocate 20% of the experiment traffic to that treatment.
    treatment String
    The name of the treatment.
    splitWeight number
    The portion of experiment traffic to allocate to this treatment. Specify the traffic portion in thousandths of a percent, so 20,000 allocated to a treatment would allocate 20% of the experiment traffic to that treatment.
    treatment string
    The name of the treatment.
    split_weight int
    The portion of experiment traffic to allocate to this treatment. Specify the traffic portion in thousandths of a percent, so 20,000 allocated to a treatment would allocate 20% of the experiment traffic to that treatment.
    treatment str
    The name of the treatment.
    splitWeight Number
    The portion of experiment traffic to allocate to this treatment. Specify the traffic portion in thousandths of a percent, so 20,000 allocated to a treatment would allocate 20% of the experiment traffic to that treatment.
    treatment String
    The name of the treatment.

    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.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native