We are excited to announce our new API Documentation.
Protected
Returns the details about one experiment. You must already know the experiment name. To retrieve a list of experiments in your account, use ListExperiments.
Use a bare-bones client and the command you need to make an API call.
import { EvidentlyClient, GetExperimentCommand } from "@aws-sdk/client-evidently"; // ES Modules import// const { EvidentlyClient, GetExperimentCommand } = require("@aws-sdk/client-evidently"); // CommonJS importconst client = new EvidentlyClient(config);const input = { // GetExperimentRequest project: "STRING_VALUE", // required experiment: "STRING_VALUE", // required};const command = new GetExperimentCommand(input);const response = await client.send(command);// { // GetExperimentResponse// experiment: { // Experiment// arn: "STRING_VALUE", // required// name: "STRING_VALUE", // required// project: "STRING_VALUE",// status: "STRING_VALUE", // required// statusReason: "STRING_VALUE",// description: "STRING_VALUE",// createdTime: new Date("TIMESTAMP"), // required// lastUpdatedTime: new Date("TIMESTAMP"), // required// schedule: { // ExperimentSchedule// analysisCompleteTime: new Date("TIMESTAMP"),// },// execution: { // ExperimentExecution// startedTime: new Date("TIMESTAMP"),// endedTime: new Date("TIMESTAMP"),// },// treatments: [ // TreatmentList// { // Treatment// name: "STRING_VALUE", // required// description: "STRING_VALUE",// featureVariations: { // FeatureToVariationMap// "<keys>": "STRING_VALUE",// },// },// ],// metricGoals: [ // MetricGoalsList// { // MetricGoal// metricDefinition: { // MetricDefinition// name: "STRING_VALUE",// entityIdKey: "STRING_VALUE",// valueKey: "STRING_VALUE",// eventPattern: "STRING_VALUE",// unitLabel: "STRING_VALUE",// },// desiredChange: "STRING_VALUE",// },// ],// randomizationSalt: "STRING_VALUE",// samplingRate: Number("long"),// segment: "STRING_VALUE",// type: "STRING_VALUE", // required// onlineAbDefinition: { // OnlineAbDefinition// controlTreatmentName: "STRING_VALUE",// treatmentWeights: { // TreatmentToWeightMap// "<keys>": Number("long"),// },// },// tags: { // TagMap// "<keys>": "STRING_VALUE",// },// },// };
GetExperimentCommandInput
GetExperimentCommandOutput
input
response
config
AccessDeniedException (client fault)
You do not have sufficient permissions to perform this action.
ResourceNotFoundException (client fault)
The request references a resource that does not exist.
ThrottlingException (client fault)
The request was denied because of request throttling. Retry the request.
ValidationException (client fault)
The value of a parameter in the request caused an error.
EvidentlyServiceException
Base exception class for all service exceptions from Evidently service.
Readonly
Static
Returns the details about one experiment. You must already know the experiment name. To retrieve a list of experiments in your account, use ListExperiments.
Example
Use a bare-bones client and the command you need to make an API call.
Param
GetExperimentCommandInput
Returns
GetExperimentCommandOutput
See
input
shape.response
shape.config
shape.Throws
AccessDeniedException (client fault)
You do not have sufficient permissions to perform this action.
Throws
ResourceNotFoundException (client fault)
The request references a resource that does not exist.
Throws
ThrottlingException (client fault)
The request was denied because of request throttling. Retry the request.
Throws
ValidationException (client fault)
The value of a parameter in the request caused an error.
Throws
EvidentlyServiceException
Base exception class for all service exceptions from Evidently service.