Get Experiment

cloudwatchevidently_get_experiment

R Documentation

Returns the details about one experiment

Description

Returns the details about one experiment. You must already know the experiment name. To retrieve a list of experiments in your account, use list_experiments.

Usage

cloudwatchevidently_get_experiment(experiment, project)

Arguments

experiment

[required] The name of the experiment that you want to see the details of.

project

[required] The name or ARN of the project that contains the experiment.

Value

A list with the following syntax:

list(
  experiment = list(
    arn = "string",
    createdTime = as.POSIXct(
      "2015-01-01"
    ),
    description = "string",
    execution = list(
      endedTime = as.POSIXct(
        "2015-01-01"
      ),
      startedTime = as.POSIXct(
        "2015-01-01"
      )
    ),
    lastUpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    metricGoals = list(
      list(
        desiredChange = "INCREASE"|"DECREASE",
        metricDefinition = list(
          entityIdKey = "string",
          eventPattern = "string",
          name = "string",
          unitLabel = "string",
          valueKey = "string"
        )
      )
    ),
    name = "string",
    onlineAbDefinition = list(
      controlTreatmentName = "string",
      treatmentWeights = list(
        123
      )
    ),
    project = "string",
    randomizationSalt = "string",
    samplingRate = 123,
    schedule = list(
      analysisCompleteTime = as.POSIXct(
        "2015-01-01"
      )
    ),
    segment = "string",
    status = "CREATED"|"UPDATING"|"RUNNING"|"COMPLETED"|"CANCELLED",
    statusReason = "string",
    tags = list(
      "string"
    ),
    treatments = list(
      list(
        description = "string",
        featureVariations = list(
          "string"
        ),
        name = "string"
      )
    ),
    type = "aws.evidently.onlineab"
  )
)

Request syntax

svc$get_experiment(
  experiment = "string",
  project = "string"
)