project (p. 16)
The name or ARN of the project that you want to create the launch in.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: ([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)
Required: Yes
Request Body
The request accepts the following data in JSON format.
description (p. 16)
An optional description for the launch.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 160.
Pattern: .*
Required: No groups (p. 16)
An array of structures that contains the feature and variations that are to be used for the launch.
Type: Array of LaunchGroupConfig (p. 134) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes metricMonitors (p. 16)
An array of structures that define the metrics that will be used to monitor the launch performance.
Type: Array of MetricMonitorConfig (p. 143) objects
Array Members: Minimum number of 0 items. Maximum number of 3 items.
Required: No name (p. 16)
The name for the new launch.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern: ^[-a-zA-Z0-9._]*$
Required: Yes
randomizationSalt (p. 16)
When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the
Response Syntax
entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the launch name as the randomizationsSalt.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 127.
Pattern: .*
Required: No
scheduledSplitsConfig (p. 16)
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
Type: ScheduledSplitsLaunchConfig (p. 159) object Required: No
tags (p. 16)
Assigns one or more tags (key-value pairs) to the launch.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with a launch.
For more information, see Tagging AWS resources.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No "description": "string", "execution": {
Response Elements
"name": "string"
} ],
"lastUpdatedTime": number, "metricMonitors": [
"randomizationSalt": "string", "scheduledSplitsDefinition": { "steps": [ "statusReason": "string", "tags": {
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
launch (p. 18)
A structure that contains the configuration of the launch that was created.
Type: Launch (p. 129) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 170).
AccessDeniedException
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403 ConflictException
A resource was in an inconsistent state during an update or a deletion.
See Also
HTTP Status Code: 409 ResourceNotFoundException
The request references a resource that does not exist.
HTTP Status Code: 404 ServiceQuotaExceededException
The request would cause a service quota to be exceeded.
HTTP Status Code: 402 ValidationException
The value of a parameter in the request caused an error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateProject
CreateProject
Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together.
To update an existing project, use UpdateProject.
Request Syntax
"description": "string", "name": "string",
"tags": {
"string" : "string"
}}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
dataDelivery (p. 21)
A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so. If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view.
Type: ProjectDataDeliveryConfig (p. 150) object Required: No
description (p. 21)
An optional description of the project.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 160.
Pattern: .*
Required: No
Response Syntax
name (p. 21)
The name for the project.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern: ^[-a-zA-Z0-9._]*$
Required: Yes tags (p. 21)
Assigns one or more tags (key-value pairs) to the project.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with a project.
For more information, see Tagging AWS resources.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json { "project": {
"activeExperimentCount": number, "activeLaunchCount": number, "arn": "string",
"description": "string", "experimentCount": number, "featureCount": number, "lastUpdatedTime": number, "launchCount": number, "name": "string", "status": "string",
Response Elements
"tags": {
"string" : "string"
} } }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
project (p. 22)
A structure that contains information about the created project.
Type: Project (p. 146) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 170).
AccessDeniedException
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403 ConflictException
A resource was in an inconsistent state during an update or a deletion.
HTTP Status Code: 409 ServiceQuotaExceededException
The request would cause a service quota to be exceeded.
HTTP Status Code: 402 ValidationException
The value of a parameter in the request caused an error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
See Also
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteExperiment
DeleteExperiment
Deletes an Evidently experiment. The feature used for the experiment is not deleted.
To stop an experiment without deleting it, use StopExperiment.
Request Syntax
DELETE /projects/project/experiments/experiment HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
experiment (p. 25)
The name of the experiment to delete.
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern: ^[-a-zA-Z0-9._]*$
Required: Yes project (p. 25)
The name or ARN of the project that contains the experiment to delete.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: ([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 170).
AccessDeniedException
You do not have sufficient permissions to perform this action.
See Also
HTTP Status Code: 403 ConflictException
A resource was in an inconsistent state during an update or a deletion.
HTTP Status Code: 409 InternalServerException
Unexpected error while processing the request. Retry the request.
HTTP Status Code: 500 ResourceNotFoundException
The request references a resource that does not exist.
HTTP Status Code: 404 ServiceUnavailableException
The service was unavailable. Retry the request.
HTTP Status Code: 503 ValidationException
The value of a parameter in the request caused an error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteFeature
DeleteFeature
Deletes an Evidently feature.
Request Syntax
DELETE /projects/project/features/feature HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
feature (p. 27)
The name of the feature to delete.
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern: ^[-a-zA-Z0-9._]*$
Required: Yes project (p. 27)
The name or ARN of the project that contains the feature to delete.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: ([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 170).
AccessDeniedException
You do not have sufficient permissions to perform this action.
See Also
HTTP Status Code: 403 ConflictException
A resource was in an inconsistent state during an update or a deletion.
HTTP Status Code: 409 ResourceNotFoundException
The request references a resource that does not exist.
HTTP Status Code: 404 ThrottlingException
The request was denied because of request throttling. Retry the request.
HTTP Status Code: 429 ValidationException
The value of a parameter in the request caused an error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteLaunch
DeleteLaunch
Deletes an Evidently launch. The feature used for the launch is not deleted.
To stop a launch without deleting it, use StopLaunch.
Request Syntax
DELETE /projects/project/launches/launch HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
launch (p. 29)
The name of the launch to delete.
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern: ^[-a-zA-Z0-9._]*$
Required: Yes project (p. 29)
The name or ARN of the project that contains the launch to delete.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: ([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 170).
AccessDeniedException
You do not have sufficient permissions to perform this action.
See Also
HTTP Status Code: 403 ConflictException
A resource was in an inconsistent state during an update or a deletion.
HTTP Status Code: 409 ResourceNotFoundException
The request references a resource that does not exist.
HTTP Status Code: 404 ThrottlingException
The request was denied because of request throttling. Retry the request.
HTTP Status Code: 429 ValidationException
The value of a parameter in the request caused an error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteProject
DeleteProject
Deletes an Evidently project. Before you can delete a project, you must delete all the features that the project contains. To delete a feature, use DeleteFeature.
Request Syntax
DELETE /projects/project HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
project (p. 31)
The name or ARN of the project to delete.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: ([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 170).
AccessDeniedException
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403 ConflictException
A resource was in an inconsistent state during an update or a deletion.
HTTP Status Code: 409
See Also
ResourceNotFoundException
The request references a resource that does not exist.
HTTP Status Code: 404 ThrottlingException
The request was denied because of request throttling. Retry the request.
HTTP Status Code: 429 ValidationException
The value of a parameter in the request caused an error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
EvaluateFeature
EvaluateFeature
This operation assigns a feature variation to one given user session. You pass in an entityID that represents the user. Evidently then checks the evaluation rules and assigns the variation.
The first rules that are evaluated are the override rules. If the user's entityID matches an override rule, the user is served the variation specified by that rule.
Next, if there is a launch of the feature, the user might be assigned to a variation in the launch. The chance of this depends on the percentage of users that are allocated to that launch. If the user is enrolled in the launch, the variation they are served depends on the allocation of the various feature variations used for the launch.
If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might be assigned to a variation in the experiment. The chance of this depends on the percentage of users that are allocated to that experiment. If the user is enrolled in the experiment, the variation they are served depends on the allocation of the various feature variations used for the experiment.
If the user is not assigned to a launch or experiment, they are served the default variation.
Request Syntax
POST /projects/project/evaluations/feature HTTP/1.1 Content-type: application/json
{ "entityId": "string",
"evaluationContext": "string"
}
URI Request Parameters
The request uses the following URI parameters.
feature (p. 33)
The name of the feature being evaluated.
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern: ^[-a-zA-Z0-9._]*$
Required: Yes project (p. 33)
The name or ARN of the project that contains this feature.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: ([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)
Required: Yes
Request Body
The request accepts the following data in JSON format.
Response Syntax
entityId (p. 33)
An internal ID that represents a unique user of the application. This entityID is checked against any override rules assigned for this feature.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern: .*
Required: Yes
evaluationContext (p. 33)
A JSON block of attributes that you can optionally pass in. This JSON block is included in the evaluation events sent to Evidently from the user session.
Type: String Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json { "details": "string",
"reason": "string", "value": {
"boolValue": boolean, "doubleValue": number, "longValue": number, "stringValue": "string"
},
"variation": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
details (p. 34)
If this user was assigned to a launch or experiment, this field lists the launch or experiment name.
Type: String reason (p. 34)
Specifies the reason that the user session was assigned this variation. Possible values include DEFAULT, meaning the user was served the default variation; LAUNCH_RULE_MATCH, if the user session was enrolled in a launch; EXPERIMENT_RULE_MATCH, if the user session was enrolled in an experiment; or ENTITY_OVERRIDES_MATCH, if the user's entityId matches an override rule.
Type: String
Errors
value (p. 34)
The value assigned to this variation to differentiate it from the other variations of this feature.
Type: VariableValue (p. 165) object variation (p. 34)
The name of the variation that was served to the user session.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 170).
AccessDeniedException
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403 ResourceNotFoundException
The request references a resource that does not exist.
HTTP Status Code: 404 ThrottlingException
The request was denied because of request throttling. Retry the request.
HTTP Status Code: 429 ValidationException
The value of a parameter in the request caused an error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetExperiment
GetExperiment
Returns the details about one experiment. You must already know the experiment name. To retrieve a list of experiments in your account, use ListExperiments.
Request Syntax
GET /projects/project/experiments/experiment HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
experiment (p. 36)
The name of the experiment that you want to see the details of.
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern: ^[-a-zA-Z0-9._]*$
Required: Yes project (p. 36)
The name or ARN of the project that contains the experiment.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: ([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
"description": "string", "execution": {"endedTime": number, "startedTime": number },
"lastUpdatedTime": number, "metricGoals": [
{
"desiredChange": "string",
Response Elements
"controlTreatmentName": "string", "treatmentWeights": {
"string" : number }
},
"project": "string",
"randomizationSalt": "string", "samplingRate": number, "schedule": {
"analysisCompleteTime": number },
"status": "string", "statusReason": "string", "tags": {
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
experiment (p. 36)
A structure containing the configuration details of the experiment.
Type: Experiment (p. 115) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 170).
AccessDeniedException
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
See Also
ResourceNotFoundException
The request references a resource that does not exist.
HTTP Status Code: 404 ThrottlingException
The request was denied because of request throttling. Retry the request.
HTTP Status Code: 429 ValidationException
The value of a parameter in the request caused an error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetExperimentResults
GetExperimentResults
Retrieves the results of a running or completed experiment. Experiment results are available up to 63 days after the start of the experiment. They are not available after that because of CloudWatch data retention policies.
Request Syntax
POST /projects/project/experiments/experiment/results HTTP/1.1 Content-type: application/json
{
"baseStat": "string", "endTime": number,
"metricNames": [ "string" ], "period": number,
"reportNames": [ "string" ], "resultStats": [ "string" ], "startTime": number,
"treatmentNames": [ "string" ] }
URI Request Parameters
The request uses the following URI parameters.
experiment (p. 39)
The name of the experiment to retrieve the results of.
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern: ^[-a-zA-Z0-9._]*$
Required: Yes project (p. 39)
The name or ARN of the project that contains the experiment that you want to see the results of.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: ([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)
Required: Yes
Request Body
The request accepts the following data in JSON format.
baseStat (p. 39)
The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.
The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.