Get Ab Test

bedrockagentcore_get_ab_test

R Documentation

Retrieves detailed information about an A/B test, including its configuration, status, and statistical results

Description

Retrieves detailed information about an A/B test, including its configuration, status, and statistical results.

Usage

bedrockagentcore_get_ab_test(abTestId)

Arguments

abTestId

[required] The unique identifier of the A/B test to retrieve.

Value

A list with the following syntax:

list(
  abTestId = "string",
  abTestArn = "string",
  name = "string",
  description = "string",
  status = "CREATING"|"ACTIVE"|"CREATE_FAILED"|"UPDATING"|"UPDATE_FAILED"|"DELETING"|"DELETE_FAILED"|"FAILED",
  executionStatus = "PAUSED"|"RUNNING"|"STOPPED"|"NOT_STARTED",
  gatewayArn = "string",
  variants = list(
    list(
      name = "string",
      weight = 123,
      variantConfiguration = list(
        configurationBundle = list(
          bundleArn = "string",
          bundleVersion = "string"
        ),
        target = list(
          name = "string"
        )
      )
    )
  ),
  gatewayFilter = list(
    targetPaths = list(
      "string"
    )
  ),
  evaluationConfig = list(
    onlineEvaluationConfigArn = "string",
    perVariantOnlineEvaluationConfig = list(
      list(
        name = "string",
        onlineEvaluationConfigArn = "string"
      )
    )
  ),
  roleArn = "string",
  currentRunId = "string",
  errorDetails = list(
    "string"
  ),
  startedAt = as.POSIXct(
    "2015-01-01"
  ),
  stoppedAt = as.POSIXct(
    "2015-01-01"
  ),
  maxDurationExpiresAt = as.POSIXct(
    "2015-01-01"
  ),
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  updatedAt = as.POSIXct(
    "2015-01-01"
  ),
  results = list(
    analysisTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    evaluatorMetrics = list(
      list(
        evaluatorArn = "string",
        controlStats = list(
          variantName = "string",
          sampleSize = 123,
          mean = 123.0
        ),
        variantResults = list(
          list(
            variantName = "string",
            sampleSize = 123,
            mean = 123.0,
            absoluteChange = 123.0,
            percentChange = 123.0,
            pValue = 123.0,
            confidenceInterval = list(
              lower = 123.0,
              upper = 123.0
            ),
            isSignificant = TRUE|FALSE
          )
        )
      )
    )
  )
)

Request syntax

svc$get_ab_test(
  abTestId = "string"
)