# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.Evidently do
@moduledoc """
You can use Amazon CloudWatch Evidently to safely validate new features by
serving
them to a specified percentage
of your users while you roll out the feature.
You can monitor the performance of the new feature
to help you decide when to ramp up traffic to your users. This helps you
reduce risk and identify unintended consequences before you fully launch the
feature.
You can also conduct A/B experiments to make feature design decisions based on
evidence
and data. An experiment can test as many as five variations at once. Evidently
collects
experiment data and analyzes it using statistical methods. It also provides
clear
recommendations about which variations perform better. You can test both
user-facing features
and backend features.
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
evaluation_request() :: %{
"entityId" => String.t() | atom(),
"evaluationContext" => String.t() | atom(),
"feature" => String.t() | atom()
}
"""
@type evaluation_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_experiments_response() :: %{
optional("experiments") => list(experiment()),
optional("nextToken") => String.t() | atom()
}
"""
@type list_experiments_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_experiment_response() :: %{}
"""
@type delete_experiment_response() :: %{}
@typedoc """
## Example:
treatment_config() :: %{
"description" => String.t() | atom(),
"feature" => String.t() | atom(),
"name" => String.t() | atom(),
"variation" => String.t() | atom()
}
"""
@type treatment_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
launch_group() :: %{
"description" => String.t() | atom(),
"featureVariations" => map(),
"name" => String.t() | atom()
}
"""
@type launch_group() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
required("tags") => map()
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_launches_response() :: %{
optional("launches") => list(launch()),
optional("nextToken") => String.t() | atom()
}
"""
@type list_launches_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_feature_request() :: %{
optional("defaultVariation") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("entityOverrides") => map(),
optional("evaluationStrategy") => String.t() | atom(),
optional("tags") => map(),
required("name") => String.t() | atom(),
required("variations") => list(variation_config())
}
"""
@type create_feature_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_feature_response() :: %{
optional("feature") => feature()
}
"""
@type create_feature_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_project_data_delivery_response() :: %{
required("project") => project()
}
"""
@type update_project_data_delivery_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_experiment_response() :: %{
optional("experiment") => experiment()
}
"""
@type get_experiment_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
test_segment_pattern_request() :: %{
required("pattern") => String.t() | atom(),
required("payload") => String.t() | atom()
}
"""
@type test_segment_pattern_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
feature() :: %{
"arn" => String.t() | atom(),
"createdTime" => [non_neg_integer()],
"defaultVariation" => String.t() | atom(),
"description" => String.t() | atom(),
"entityOverrides" => map(),
"evaluationRules" => list(evaluation_rule()),
"evaluationStrategy" => String.t() | atom(),
"lastUpdatedTime" => [non_neg_integer()],
"name" => String.t() | atom(),
"project" => String.t() | atom(),
"status" => String.t() | atom(),
"tags" => map(),
"valueType" => String.t() | atom(),
"variations" => list(variation())
}
"""
@type feature() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
online_ab_definition() :: %{
"controlTreatmentName" => String.t() | atom(),
"treatmentWeights" => map()
}
"""
@type online_ab_definition() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
scheduled_splits_launch_definition() :: %{
"steps" => list(scheduled_split())
}
"""
@type scheduled_splits_launch_definition() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
project_summary() :: %{
"activeExperimentCount" => [float()],
"activeLaunchCount" => [float()],
"arn" => String.t() | atom(),
"createdTime" => [non_neg_integer()],
"description" => String.t() | atom(),
"experimentCount" => [float()],
"featureCount" => [float()],
"lastUpdatedTime" => [non_neg_integer()],
"launchCount" => [float()],
"name" => String.t() | atom(),
"status" => String.t() | atom(),
"tags" => map()
}
"""
@type project_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_response() :: %{}
"""
@type untag_resource_response() :: %{}
@typedoc """
## Example:
get_launch_response() :: %{
optional("launch") => launch()
}
"""
@type get_launch_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_segment_request() :: %{}
"""
@type get_segment_request() :: %{}
@typedoc """
## Example:
put_project_events_response() :: %{
optional("eventResults") => list(put_project_events_result_entry()),
optional("failedEventCount") => [integer()]
}
"""
@type put_project_events_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
variation_config() :: %{
"name" => String.t() | atom(),
"value" => list()
}
"""
@type variation_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
test_segment_pattern_response() :: %{
required("match") => [boolean()]
}
"""
@type test_segment_pattern_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_project_request() :: %{}
"""
@type get_project_request() :: %{}
@typedoc """
## Example:
list_segment_references_response() :: %{
optional("nextToken") => String.t() | atom(),
optional("referencedBy") => list(ref_resource())
}
"""
@type list_segment_references_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cloud_watch_logs_destination() :: %{
"logGroup" => String.t() | atom()
}
"""
@type cloud_watch_logs_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_project_events_result_entry() :: %{
"errorCode" => String.t() | atom(),
"errorMessage" => String.t() | atom(),
"eventId" => String.t() | atom()
}
"""
@type put_project_events_result_entry() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_features_response() :: %{
optional("features") => list(feature_summary()),
optional("nextToken") => String.t() | atom()
}
"""
@type list_features_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
metric_definition_config() :: %{
"entityIdKey" => String.t() | atom(),
"eventPattern" => String.t() | atom(),
"name" => String.t() | atom(),
"unitLabel" => String.t() | atom(),
"valueKey" => String.t() | atom()
}
"""
@type metric_definition_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_experiment_response() :: %{
required("experiment") => experiment()
}
"""
@type create_experiment_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
segment_override() :: %{
"evaluationOrder" => [float()],
"segment" => String.t() | atom(),
"weights" => map()
}
"""
@type segment_override() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_launches_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("status") => String.t() | atom()
}
"""
@type list_launches_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_launch_response() :: %{}
"""
@type delete_launch_response() :: %{}
@typedoc """
## Example:
list_features_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_features_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
metric_definition() :: %{
"entityIdKey" => String.t() | atom(),
"eventPattern" => String.t() | atom(),
"name" => String.t() | atom(),
"unitLabel" => String.t() | atom(),
"valueKey" => String.t() | atom()
}
"""
@type metric_definition() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_launch_request() :: %{
optional("description") => String.t() | atom(),
optional("metricMonitors") => list(metric_monitor_config()),
optional("randomizationSalt") => String.t() | atom(),
optional("scheduledSplitsConfig") => scheduled_splits_launch_config(),
optional("tags") => map(),
required("groups") => list(launch_group_config()),
required("name") => String.t() | atom()
}
"""
@type create_launch_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_project_data_delivery_request() :: %{
optional("cloudWatchLogs") => cloud_watch_logs_destination_config(),
optional("s3Destination") => s3_destination_config()
}
"""
@type update_project_data_delivery_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
variation() :: %{
"name" => String.t() | atom(),
"value" => list()
}
"""
@type variation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("tagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_project_response() :: %{
required("project") => project()
}
"""
@type update_project_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
evaluate_feature_response() :: %{
optional("details") => String.t() | atom(),
optional("reason") => [String.t() | atom()],
optional("value") => list(),
optional("variation") => [String.t() | atom()]
}
"""
@type evaluate_feature_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_feature_request() :: %{
optional("addOrUpdateVariations") => list(variation_config()),
optional("defaultVariation") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("entityOverrides") => map(),
optional("evaluationStrategy") => String.t() | atom(),
optional("removeVariations") => list(String.t() | atom())
}
"""
@type update_feature_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
segment() :: %{
"arn" => String.t() | atom(),
"createdTime" => [non_neg_integer()],
"description" => String.t() | atom(),
"experimentCount" => [float()],
"lastUpdatedTime" => [non_neg_integer()],
"launchCount" => [float()],
"name" => String.t() | atom(),
"pattern" => String.t() | atom(),
"tags" => map()
}
"""
@type segment() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_project_events_request() :: %{
required("events") => list(event())
}
"""
@type put_project_events_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
project_data_delivery_config() :: %{
"cloudWatchLogs" => cloud_watch_logs_destination_config(),
"s3Destination" => s3_destination_config()
}
"""
@type project_data_delivery_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_segment_response() :: %{
required("segment") => segment()
}
"""
@type create_segment_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
project_app_config_resource() :: %{
"applicationId" => String.t() | atom(),
"configurationProfileId" => String.t() | atom(),
"environmentId" => String.t() | atom()
}
"""
@type project_app_config_resource() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_segments_response() :: %{
optional("nextToken") => String.t() | atom(),
optional("segments") => list(segment())
}
"""
@type list_segments_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
evaluate_feature_request() :: %{
optional("evaluationContext") => String.t() | atom(),
required("entityId") => String.t() | atom()
}
"""
@type evaluate_feature_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
scheduled_split_config() :: %{
"groupWeights" => map(),
"segmentOverrides" => list(segment_override()),
"startTime" => [non_neg_integer()]
}
"""
@type scheduled_split_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_project_response() :: %{
required("project") => project()
}
"""
@type create_project_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
conflict_exception() :: %{
"message" => [String.t() | atom()],
"resourceId" => [String.t() | atom()],
"resourceType" => [String.t() | atom()]
}
"""
@type conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_not_found_exception() :: %{
"message" => [String.t() | atom()],
"resourceId" => [String.t() | atom()],
"resourceType" => [String.t() | atom()]
}
"""
@type resource_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_experiment_request() :: %{}
"""
@type delete_experiment_request() :: %{}
@typedoc """
## Example:
get_experiment_request() :: %{}
"""
@type get_experiment_request() :: %{}
@typedoc """
## Example:
project() :: %{
"activeExperimentCount" => [float()],
"activeLaunchCount" => [float()],
"appConfigResource" => project_app_config_resource(),
"arn" => String.t() | atom(),
"createdTime" => [non_neg_integer()],
"dataDelivery" => project_data_delivery(),
"description" => String.t() | atom(),
"experimentCount" => [float()],
"featureCount" => [float()],
"lastUpdatedTime" => [non_neg_integer()],
"launchCount" => [float()],
"name" => String.t() | atom(),
"status" => String.t() | atom(),
"tags" => map()
}
"""
@type project() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
launch_group_config() :: %{
"description" => String.t() | atom(),
"feature" => String.t() | atom(),
"name" => String.t() | atom(),
"variation" => String.t() | atom()
}
"""
@type launch_group_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
metric_monitor() :: %{
"metricDefinition" => metric_definition()
}
"""
@type metric_monitor() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_quota_exceeded_exception() :: %{
"message" => [String.t() | atom()],
"quotaCode" => [String.t() | atom()],
"resourceId" => [String.t() | atom()],
"resourceType" => [String.t() | atom()],
"serviceCode" => [String.t() | atom()]
}
"""
@type service_quota_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_feature_response() :: %{
required("feature") => feature()
}
"""
@type update_feature_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
metric_goal_config() :: %{
"desiredChange" => String.t() | atom(),
"metricDefinition" => metric_definition_config()
}
"""
@type metric_goal_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_projects_response() :: %{
optional("nextToken") => String.t() | atom(),
optional("projects") => list(project_summary())
}
"""
@type list_projects_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_project_response() :: %{
required("project") => project()
}
"""
@type get_project_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
optional("tags") => map()
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
feature_summary() :: %{
"arn" => String.t() | atom(),
"createdTime" => [non_neg_integer()],
"defaultVariation" => String.t() | atom(),
"evaluationRules" => list(evaluation_rule()),
"evaluationStrategy" => String.t() | atom(),
"lastUpdatedTime" => [non_neg_integer()],
"name" => String.t() | atom(),
"project" => String.t() | atom(),
"status" => String.t() | atom(),
"tags" => map()
}
"""
@type feature_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
validation_exception_field() :: %{
"message" => [String.t() | atom()],
"name" => [String.t() | atom()]
}
"""
@type validation_exception_field() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_unavailable_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type service_unavailable_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
experiment_report() :: %{
"content" => String.t() | atom(),
"metricName" => String.t() | atom(),
"reportName" => String.t() | atom(),
"treatmentName" => String.t() | atom()
}
"""
@type experiment_report() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_evaluate_feature_response() :: %{
optional("results") => list(evaluation_result())
}
"""
@type batch_evaluate_feature_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_segment_response() :: %{
required("segment") => segment()
}
"""
@type get_segment_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
ref_resource() :: %{
"arn" => [String.t() | atom()],
"endTime" => [String.t() | atom()],
"lastUpdatedOn" => [String.t() | atom()],
"name" => [String.t() | atom()],
"startTime" => [String.t() | atom()],
"status" => [String.t() | atom()],
"type" => [String.t() | atom()]
}
"""
@type ref_resource() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
scheduled_splits_launch_config() :: %{
"steps" => list(scheduled_split_config())
}
"""
@type scheduled_splits_launch_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_segment_request() :: %{
optional("description") => String.t() | atom(),
optional("tags") => map(),
required("name") => String.t() | atom(),
required("pattern") => String.t() | atom()
}
"""
@type create_segment_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cloud_watch_logs_destination_config() :: %{
"logGroup" => String.t() | atom()
}
"""
@type cloud_watch_logs_destination_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s3_destination() :: %{
"bucket" => String.t() | atom(),
"prefix" => String.t() | atom()
}
"""
@type s3_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_experiment_request() :: %{
optional("description") => String.t() | atom(),
optional("metricGoals") => list(metric_goal_config()),
optional("onlineAbConfig") => online_ab_config(),
optional("randomizationSalt") => String.t() | atom(),
optional("removeSegment") => [boolean()],
optional("samplingRate") => float(),
optional("segment") => String.t() | atom(),
optional("treatments") => list(treatment_config())
}
"""
@type update_experiment_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_experiment_request() :: %{
optional("description") => String.t() | atom(),
optional("onlineAbConfig") => online_ab_config(),
optional("randomizationSalt") => String.t() | atom(),
optional("samplingRate") => float(),
optional("segment") => String.t() | atom(),
optional("tags") => map(),
required("metricGoals") => list(metric_goal_config()),
required("name") => String.t() | atom(),
required("treatments") => list(treatment_config())
}
"""
@type create_experiment_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_segment_response() :: %{}
"""
@type delete_segment_response() :: %{}
@typedoc """
## Example:
experiment_results_data() :: %{
"metricName" => String.t() | atom(),
"resultStat" => String.t() | atom(),
"treatmentName" => String.t() | atom(),
"values" => list([float()]())
}
"""
@type experiment_results_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
experiment_schedule() :: %{
"analysisCompleteTime" => [non_neg_integer()]
}
"""
@type experiment_schedule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
evaluation_rule() :: %{
"name" => String.t() | atom(),
"type" => String.t() | atom()
}
"""
@type evaluation_rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
experiment_execution() :: %{
"endedTime" => [non_neg_integer()],
"startedTime" => [non_neg_integer()]
}
"""
@type experiment_execution() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
stop_experiment_request() :: %{
optional("desiredState") => String.t() | atom(),
optional("reason") => String.t() | atom()
}
"""
@type stop_experiment_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
internal_server_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type internal_server_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_project_response() :: %{}
"""
@type delete_project_response() :: %{}
@typedoc """
## Example:
update_project_request() :: %{
optional("appConfigResource") => project_app_config_resource_config(),
optional("description") => String.t() | atom()
}
"""
@type update_project_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
event() :: %{
"data" => String.t() | atom(),
"timestamp" => [non_neg_integer()],
"type" => String.t() | atom()
}
"""
@type event() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
online_ab_config() :: %{
"controlTreatmentName" => String.t() | atom(),
"treatmentWeights" => map()
}
"""
@type online_ab_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
treatment() :: %{
"description" => String.t() | atom(),
"featureVariations" => map(),
"name" => String.t() | atom()
}
"""
@type treatment() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_experiment_response() :: %{
optional("startedTime") => [non_neg_integer()]
}
"""
@type start_experiment_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_launch_response() :: %{
required("launch") => launch()
}
"""
@type update_launch_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
access_denied_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type access_denied_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
project_data_delivery() :: %{
"cloudWatchLogs" => cloud_watch_logs_destination(),
"s3Destination" => s3_destination()
}
"""
@type project_data_delivery() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_response() :: %{}
"""
@type tag_resource_response() :: %{}
@typedoc """
## Example:
validation_exception() :: %{
"fieldList" => list(validation_exception_field()),
"message" => [String.t() | atom()],
"reason" => String.t() | atom()
}
"""
@type validation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{}
"""
@type list_tags_for_resource_request() :: %{}
@typedoc """
## Example:
batch_evaluate_feature_request() :: %{
required("requests") => list(evaluation_request())
}
"""
@type batch_evaluate_feature_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_experiments_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("status") => String.t() | atom()
}
"""
@type list_experiments_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
throttling_exception() :: %{
"message" => [String.t() | atom()],
"quotaCode" => [String.t() | atom()],
"serviceCode" => [String.t() | atom()]
}
"""
@type throttling_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_project_request() :: %{
optional("appConfigResource") => project_app_config_resource_config(),
optional("dataDelivery") => project_data_delivery_config(),
optional("description") => String.t() | atom(),
optional("tags") => map(),
required("name") => String.t() | atom()
}
"""
@type create_project_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_experiment_request() :: %{
required("analysisCompleteTime") => [non_neg_integer()]
}
"""
@type start_experiment_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_projects_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_projects_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_segments_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_segments_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_segment_references_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
required("type") => String.t() | atom()
}
"""
@type list_segment_references_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
metric_goal() :: %{
"desiredChange" => String.t() | atom(),
"metricDefinition" => metric_definition()
}
"""
@type metric_goal() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
launch_execution() :: %{
"endedTime" => [non_neg_integer()],
"startedTime" => [non_neg_integer()]
}
"""
@type launch_execution() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_segment_request() :: %{}
"""
@type delete_segment_request() :: %{}
@typedoc """
## Example:
metric_monitor_config() :: %{
"metricDefinition" => metric_definition_config()
}
"""
@type metric_monitor_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
project_app_config_resource_config() :: %{
"applicationId" => String.t() | atom(),
"environmentId" => String.t() | atom()
}
"""
@type project_app_config_resource_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
evaluation_result() :: %{
"details" => String.t() | atom(),
"entityId" => String.t() | atom(),
"feature" => String.t() | atom(),
"project" => String.t() | atom(),
"reason" => [String.t() | atom()],
"value" => list(),
"variation" => [String.t() | atom()]
}
"""
@type evaluation_result() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
stop_experiment_response() :: %{
optional("endedTime") => [non_neg_integer()]
}
"""
@type stop_experiment_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
stop_launch_request() :: %{
optional("desiredState") => String.t() | atom(),
optional("reason") => String.t() | atom()
}
"""
@type stop_launch_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_feature_response() :: %{}
"""
@type delete_feature_response() :: %{}
@typedoc """
## Example:
start_launch_response() :: %{
required("launch") => launch()
}
"""
@type start_launch_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_feature_response() :: %{
required("feature") => feature()
}
"""
@type get_feature_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_launch_request() :: %{}
"""
@type start_launch_request() :: %{}
@typedoc """
## Example:
launch() :: %{
"arn" => String.t() | atom(),
"createdTime" => [non_neg_integer()],
"description" => String.t() | atom(),
"execution" => launch_execution(),
"groups" => list(launch_group()),
"lastUpdatedTime" => [non_neg_integer()],
"metricMonitors" => list(metric_monitor()),
"name" => String.t() | atom(),
"project" => String.t() | atom(),
"randomizationSalt" => String.t() | atom(),
"scheduledSplitsDefinition" => scheduled_splits_launch_definition(),
"status" => String.t() | atom(),
"statusReason" => String.t() | atom(),
"tags" => map(),
"type" => String.t() | atom()
}
"""
@type launch() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_experiment_results_response() :: %{
optional("details") => [String.t() | atom()],
optional("reports") => list(experiment_report()),
optional("resultsData") => list(experiment_results_data()),
optional("timestamps") => list([non_neg_integer()]())
}
"""
@type get_experiment_results_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
scheduled_split() :: %{
"groupWeights" => map(),
"segmentOverrides" => list(segment_override()),
"startTime" => [non_neg_integer()]
}
"""
@type scheduled_split() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
experiment() :: %{
"arn" => String.t() | atom(),
"createdTime" => [non_neg_integer()],
"description" => String.t() | atom(),
"execution" => experiment_execution(),
"lastUpdatedTime" => [non_neg_integer()],
"metricGoals" => list(metric_goal()),
"name" => String.t() | atom(),
"onlineAbDefinition" => online_ab_definition(),
"project" => String.t() | atom(),
"randomizationSalt" => String.t() | atom(),
"samplingRate" => float(),
"schedule" => experiment_schedule(),
"segment" => String.t() | atom(),
"status" => String.t() | atom(),
"statusReason" => String.t() | atom(),
"tags" => map(),
"treatments" => list(treatment()),
"type" => String.t() | atom()
}
"""
@type experiment() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_project_request() :: %{}
"""
@type delete_project_request() :: %{}
@typedoc """
## Example:
stop_launch_response() :: %{
optional("endedTime") => [non_neg_integer()]
}
"""
@type stop_launch_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_experiment_response() :: %{
required("experiment") => experiment()
}
"""
@type update_experiment_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_launch_request() :: %{}
"""
@type get_launch_request() :: %{}
@typedoc """
## Example:
s3_destination_config() :: %{
"bucket" => String.t() | atom(),
"prefix" => String.t() | atom()
}
"""
@type s3_destination_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_experiment_results_request() :: %{
optional("baseStat") => String.t() | atom(),
optional("endTime") => [non_neg_integer()],
optional("period") => float(),
optional("reportNames") => list(String.t() | atom()),
optional("resultStats") => list(String.t() | atom()),
optional("startTime") => [non_neg_integer()],
required("metricNames") => list(String.t() | atom()),
required("treatmentNames") => list(String.t() | atom())
}
"""
@type get_experiment_results_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_feature_request() :: %{}
"""
@type delete_feature_request() :: %{}
@typedoc """
## Example:
delete_launch_request() :: %{}
"""
@type delete_launch_request() :: %{}
@typedoc """
## Example:
get_feature_request() :: %{}
"""
@type get_feature_request() :: %{}
@typedoc """
## Example:
create_launch_response() :: %{
required("launch") => launch()
}
"""
@type create_launch_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_launch_request() :: %{
optional("description") => String.t() | atom(),
optional("groups") => list(launch_group_config()),
optional("metricMonitors") => list(metric_monitor_config()),
optional("randomizationSalt") => String.t() | atom(),
optional("scheduledSplitsConfig") => scheduled_splits_launch_config()
}
"""
@type update_launch_request() :: %{(String.t() | atom()) => any()}
@type batch_evaluate_feature_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
@type create_experiment_errors() ::
validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_feature_errors() ::
validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_launch_errors() ::
validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_project_errors() ::
validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type create_segment_errors() ::
validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type delete_experiment_errors() ::
validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_unavailable_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_feature_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_launch_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_project_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_segment_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
| conflict_exception()
@type evaluate_feature_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
@type get_experiment_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
@type get_experiment_results_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
| conflict_exception()
@type get_feature_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
@type get_launch_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
@type get_project_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
@type get_segment_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
@type list_experiments_errors() ::
validation_exception() | access_denied_exception() | resource_not_found_exception()
@type list_features_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
@type list_launches_errors() ::
throttling_exception() | validation_exception() | access_denied_exception()
@type list_projects_errors() ::
throttling_exception() | validation_exception() | access_denied_exception()
@type list_segment_references_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
@type list_segments_errors() ::
throttling_exception() | validation_exception() | access_denied_exception()
@type list_tags_for_resource_errors() ::
validation_exception() | resource_not_found_exception() | conflict_exception()
@type put_project_events_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
@type start_experiment_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type start_launch_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type stop_experiment_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type stop_launch_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| resource_not_found_exception()
@type tag_resource_errors() ::
validation_exception() | resource_not_found_exception() | conflict_exception()
@type test_segment_pattern_errors() ::
throttling_exception() | validation_exception() | access_denied_exception()
@type untag_resource_errors() ::
validation_exception() | resource_not_found_exception() | conflict_exception()
@type update_experiment_errors() ::
validation_exception()
| access_denied_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_feature_errors() ::
validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_launch_errors() ::
validation_exception()
| access_denied_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_project_errors() ::
validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_project_data_delivery_errors() ::
validation_exception()
| access_denied_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
def metadata do
%{
api_version: "2021-02-01",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "evidently",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "Evidently",
signature_version: "v4",
signing_name: "evidently",
target_prefix: nil
}
end
@doc """
This operation assigns feature variation to user sessions.
For each 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.
"""
@spec batch_evaluate_feature(
map(),
String.t() | atom(),
batch_evaluate_feature_request(),
list()
) ::
{:ok, batch_evaluate_feature_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, batch_evaluate_feature_errors()}
def batch_evaluate_feature(%Client{} = client, project, input, options \\ []) do
url_path = "/projects/#{AWS.Util.encode_uri(project)}/evaluations"
headers = []
custom_headers = []
query_params = []
meta = metadata() |> Map.put_new(:host_prefix, "dataplane.")
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates an Evidently *experiment*.
Before you create an experiment,
you must create the feature to use for the experiment.
An experiment helps you make feature design
decisions based on evidence and data. An experiment can test as
many as five variations at once. Evidently collects experiment data and analyzes
it by statistical methods, and provides
clear recommendations about which variations perform better.
You can optionally specify a `segment` to have the experiment consider only
certain audience
types in the experiment, such as using only user sessions from a certain
location or who use a certain internet browser.
Don't use this operation to update an existing experiment. Instead, use
[UpdateExperiment](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateExperiment.html).
"""
@spec create_experiment(map(), String.t() | atom(), create_experiment_request(), list()) ::
{:ok, create_experiment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_experiment_errors()}
def create_experiment(%Client{} = client, project, input, options \\ []) do
url_path = "/projects/#{AWS.Util.encode_uri(project)}/experiments"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates an Evidently *feature* that you want to launch or test.
You can define up to
five variations of a feature, and use these variations in your launches and
experiments. A feature must be created in
a project. For information about creating a project, see
[CreateProject](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateProject.html). Don't use this operation to update an existing feature. Instead, use
[UpdateFeature](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateFeature.html).
"""
@spec create_feature(map(), String.t() | atom(), create_feature_request(), list()) ::
{:ok, create_feature_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_feature_errors()}
def create_feature(%Client{} = client, project, input, options \\ []) do
url_path = "/projects/#{AWS.Util.encode_uri(project)}/features"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a *launch* of a given feature.
Before you create a launch, you
must create the feature to use for the launch.
You can use a launch to safely validate new features by serving them to a
specified
percentage of your users while you roll out the feature. You can monitor the
performance of
the new feature to help you decide when to ramp up traffic to more users. This
helps you
reduce risk and identify unintended consequences before you fully launch the
feature.
Don't use this operation to update an existing launch. Instead, use
[UpdateLaunch](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateLaunch.html).
"""
@spec create_launch(map(), String.t() | atom(), create_launch_request(), list()) ::
{:ok, create_launch_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_launch_errors()}
def create_launch(%Client{} = client, project, input, options \\ []) do
url_path = "/projects/#{AWS.Util.encode_uri(project)}/launches"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateProject.html).
"""
@spec create_project(map(), create_project_request(), list()) ::
{:ok, create_project_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_project_errors()}
def create_project(%Client{} = client, input, options \\ []) do
url_path = "/projects"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Use this operation to define a *segment* of your audience.
A segment
is a portion of your audience that share one or more characteristics. Examples
could be Chrome browser users,
users in Europe, or Firefox browser users in Europe who also fit other criteria
that your application collects,
such as age.
Using a segment in an experiment limits that experiment to evaluate only the
users who match the segment
criteria. Using one or more segments in a launch allows you to define different
traffic splits for the different
audience segments.
For more information about segment pattern syntax, see
[
Segment rule pattern
syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax.html).
The pattern that you define for a segment is matched against the value of
`evaluationContext`, which
is passed into Evidently in the
[EvaluateFeature](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html)
operation,
when Evidently assigns a feature variation to a user.
"""
@spec create_segment(map(), create_segment_request(), list()) ::
{:ok, create_segment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_segment_errors()}
def create_segment(%Client{} = client, input, options \\ []) do
url_path = "/segments"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes an Evidently experiment.
The feature used for the experiment is not deleted.
To stop an experiment without deleting it, use
[StopExperiment](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_StopExperiment.html).
"""
@spec delete_experiment(
map(),
String.t() | atom(),
String.t() | atom(),
delete_experiment_request(),
list()
) ::
{:ok, delete_experiment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_experiment_errors()}
def delete_experiment(%Client{} = client, experiment, project, input, options \\ []) do
url_path =
"/projects/#{AWS.Util.encode_uri(project)}/experiments/#{AWS.Util.encode_uri(experiment)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes an Evidently feature.
"""
@spec delete_feature(
map(),
String.t() | atom(),
String.t() | atom(),
delete_feature_request(),
list()
) ::
{:ok, delete_feature_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_feature_errors()}
def delete_feature(%Client{} = client, feature, project, input, options \\ []) do
url_path =
"/projects/#{AWS.Util.encode_uri(project)}/features/#{AWS.Util.encode_uri(feature)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes an Evidently launch.
The feature used for the launch is not deleted.
To stop a launch without deleting it, use
[StopLaunch](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_StopLaunch.html).
"""
@spec delete_launch(
map(),
String.t() | atom(),
String.t() | atom(),
delete_launch_request(),
list()
) ::
{:ok, delete_launch_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_launch_errors()}
def delete_launch(%Client{} = client, launch, project, input, options \\ []) do
url_path = "/projects/#{AWS.Util.encode_uri(project)}/launches/#{AWS.Util.encode_uri(launch)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_DeleteFeature.html).
"""
@spec delete_project(map(), String.t() | atom(), delete_project_request(), list()) ::
{:ok, delete_project_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_project_errors()}
def delete_project(%Client{} = client, project, input, options \\ []) do
url_path = "/projects/#{AWS.Util.encode_uri(project)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes a segment.
You can't delete a segment that is being used in a launch or experiment, even if
that
launch or experiment is not currently running.
"""
@spec delete_segment(map(), String.t() | atom(), delete_segment_request(), list()) ::
{:ok, delete_segment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_segment_errors()}
def delete_segment(%Client{} = client, segment, input, options \\ []) do
url_path = "/segments/#{AWS.Util.encode_uri(segment)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
If there is a current launch with this feature that uses segment overrides, and
if the user session's `evaluationContext` matches a segment rule defined in a
segment override, the configuration in the segment overrides is used. For more
information
about segments, see
[CreateSegment](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateSegment.html) and
[Use segments to focus your
audience](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html).
If there is a launch with no segment overrides, 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 experiment uses a segment, then only
user sessions with `evaluationContext` values that match the segment rule are
used in the 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.
"""
@spec evaluate_feature(
map(),
String.t() | atom(),
String.t() | atom(),
evaluate_feature_request(),
list()
) ::
{:ok, evaluate_feature_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, evaluate_feature_errors()}
def evaluate_feature(%Client{} = client, feature, project, input, options \\ []) do
url_path =
"/projects/#{AWS.Util.encode_uri(project)}/evaluations/#{AWS.Util.encode_uri(feature)}"
headers = []
custom_headers = []
query_params = []
meta = metadata() |> Map.put_new(:host_prefix, "dataplane.")
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Returns the details about one experiment.
You must already know the
experiment name. To retrieve a list of experiments in your account, use
[ListExperiments](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListExperiments.html).
"""
@spec get_experiment(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_experiment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_experiment_errors()}
def get_experiment(%Client{} = client, experiment, project, options \\ []) do
url_path =
"/projects/#{AWS.Util.encode_uri(project)}/experiments/#{AWS.Util.encode_uri(experiment)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves the results of a running or completed experiment.
No results are available until
there have been 100 events for each variation and at least 10 minutes have
passed since the start of the experiment.
To increase the statistical power, Evidently performs an additional offline
p-value analysis at the end of the experiment.
Offline p-value analysis can detect statistical significance in some cases where
the anytime p-values used during
the experiment do not find statistical significance.
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.
"""
@spec get_experiment_results(
map(),
String.t() | atom(),
String.t() | atom(),
get_experiment_results_request(),
list()
) ::
{:ok, get_experiment_results_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_experiment_results_errors()}
def get_experiment_results(%Client{} = client, experiment, project, input, options \\ []) do
url_path =
"/projects/#{AWS.Util.encode_uri(project)}/experiments/#{AWS.Util.encode_uri(experiment)}/results"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Returns the details about one feature.
You must already know the feature name. To
retrieve a list of features in your account, use
[ListFeatures](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListFeatures.html).
"""
@spec get_feature(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_feature_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_feature_errors()}
def get_feature(%Client{} = client, feature, project, options \\ []) do
url_path =
"/projects/#{AWS.Util.encode_uri(project)}/features/#{AWS.Util.encode_uri(feature)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns the details about one launch.
You must already know the
launch name. To retrieve a list of launches in your account, use
[ListLaunches](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListLaunches.html).
"""
@spec get_launch(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_launch_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_launch_errors()}
def get_launch(%Client{} = client, launch, project, options \\ []) do
url_path = "/projects/#{AWS.Util.encode_uri(project)}/launches/#{AWS.Util.encode_uri(launch)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns the details about one launch.
You must already know the
project name. To retrieve a list of projects in your account, use
[ListProjects](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListProjects.html).
"""
@spec get_project(map(), String.t() | atom(), list()) ::
{:ok, get_project_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_project_errors()}
def get_project(%Client{} = client, project, options \\ []) do
url_path = "/projects/#{AWS.Util.encode_uri(project)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns information about the specified segment.
Specify the segment you want to view
by specifying its ARN.
"""
@spec get_segment(map(), String.t() | atom(), list()) ::
{:ok, get_segment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_segment_errors()}
def get_segment(%Client{} = client, segment, options \\ []) do
url_path = "/segments/#{AWS.Util.encode_uri(segment)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns configuration details about all the experiments in the specified
project.
"""
@spec list_experiments(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_experiments_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_experiments_errors()}
def list_experiments(
%Client{} = client,
project,
max_results \\ nil,
next_token \\ nil,
status \\ nil,
options \\ []
) do
url_path = "/projects/#{AWS.Util.encode_uri(project)}/experiments"
headers = []
query_params = []
query_params =
if !is_nil(status) do
[{"status", status} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns configuration details about all the features in the specified project.
"""
@spec list_features(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_features_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_features_errors()}
def list_features(
%Client{} = client,
project,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/projects/#{AWS.Util.encode_uri(project)}/features"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns configuration details about all the launches in the specified project.
"""
@spec list_launches(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_launches_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_launches_errors()}
def list_launches(
%Client{} = client,
project,
max_results \\ nil,
next_token \\ nil,
status \\ nil,
options \\ []
) do
url_path = "/projects/#{AWS.Util.encode_uri(project)}/launches"
headers = []
query_params = []
query_params =
if !is_nil(status) do
[{"status", status} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns configuration details about all the projects in the current Region in
your
account.
"""
@spec list_projects(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_projects_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_projects_errors()}
def list_projects(%Client{} = client, max_results \\ nil, next_token \\ nil, options \\ []) do
url_path = "/projects"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Use this operation to find which experiments or launches are using a specified
segment.
"""
@spec list_segment_references(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, list_segment_references_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_segment_references_errors()}
def list_segment_references(
%Client{} = client,
segment,
max_results \\ nil,
next_token \\ nil,
type,
options \\ []
) do
url_path = "/segments/#{AWS.Util.encode_uri(segment)}/references"
headers = []
query_params = []
query_params =
if !is_nil(type) do
[{"type", type} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a list of audience segments that you have created in your account in
this Region.
"""
@spec list_segments(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_segments_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_segments_errors()}
def list_segments(%Client{} = client, max_results \\ nil, next_token \\ nil, options \\ []) do
url_path = "/segments"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Displays the tags associated with an Evidently resource.
"""
@spec list_tags_for_resource(map(), String.t() | atom(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, resource_arn, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Sends performance events to Evidently.
These events can be used to evaluate a launch or
an experiment.
"""
@spec put_project_events(map(), String.t() | atom(), put_project_events_request(), list()) ::
{:ok, put_project_events_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_project_events_errors()}
def put_project_events(%Client{} = client, project, input, options \\ []) do
url_path = "/events/projects/#{AWS.Util.encode_uri(project)}"
headers = []
custom_headers = []
query_params = []
meta = metadata() |> Map.put_new(:host_prefix, "dataplane.")
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Starts an existing experiment.
To create an experiment,
use
[CreateExperiment](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateExperiment.html).
"""
@spec start_experiment(
map(),
String.t() | atom(),
String.t() | atom(),
start_experiment_request(),
list()
) ::
{:ok, start_experiment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, start_experiment_errors()}
def start_experiment(%Client{} = client, experiment, project, input, options \\ []) do
url_path =
"/projects/#{AWS.Util.encode_uri(project)}/experiments/#{AWS.Util.encode_uri(experiment)}/start"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Starts an existing launch.
To create a launch,
use
[CreateLaunch](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateLaunch.html).
"""
@spec start_launch(
map(),
String.t() | atom(),
String.t() | atom(),
start_launch_request(),
list()
) ::
{:ok, start_launch_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, start_launch_errors()}
def start_launch(%Client{} = client, launch, project, input, options \\ []) do
url_path =
"/projects/#{AWS.Util.encode_uri(project)}/launches/#{AWS.Util.encode_uri(launch)}/start"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Stops an experiment that is currently running.
If you stop an experiment, you can't
resume it or restart it.
"""
@spec stop_experiment(
map(),
String.t() | atom(),
String.t() | atom(),
stop_experiment_request(),
list()
) ::
{:ok, stop_experiment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, stop_experiment_errors()}
def stop_experiment(%Client{} = client, experiment, project, input, options \\ []) do
url_path =
"/projects/#{AWS.Util.encode_uri(project)}/experiments/#{AWS.Util.encode_uri(experiment)}/cancel"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Stops a launch that is currently running.
After you stop a launch, you will not be able to resume it or restart it.
Also, it
will not be evaluated as a rule for traffic allocation, and the traffic that was
allocated to the launch
will instead be available to the feature's experiment, if there is one.
Otherwise, all traffic
will be served the default variation after the launch is stopped.
"""
@spec stop_launch(
map(),
String.t() | atom(),
String.t() | atom(),
stop_launch_request(),
list()
) ::
{:ok, stop_launch_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, stop_launch_errors()}
def stop_launch(%Client{} = client, launch, project, input, options \\ []) do
url_path =
"/projects/#{AWS.Util.encode_uri(project)}/launches/#{AWS.Util.encode_uri(launch)}/cancel"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently
resource.
Projects,
features, launches, and experiments can be tagged.
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 Amazon Web Services and are interpreted
strictly as strings of characters.
You can use the `TagResource` action with a resource that already has tags.
If you specify a new tag key for the resource,
this tag is appended to the list of tags associated
with the alarm. If you specify a tag key that is already associated with the
resource, the new tag value that you specify replaces
the previous value for that tag.
You can associate as many as 50 tags with a resource.
For more information, see [Tagging Amazon Web Services resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
"""
@spec tag_resource(map(), String.t() | atom(), tag_resource_request(), list()) ::
{:ok, tag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Use this operation to test a rules pattern that you plan to use to create an
audience segment.
For more information about segments, see
[CreateSegment](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateSegment.html).
"""
@spec test_segment_pattern(map(), test_segment_pattern_request(), list()) ::
{:ok, test_segment_pattern_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, test_segment_pattern_errors()}
def test_segment_pattern(%Client{} = client, input, options \\ []) do
url_path = "/test-segment-pattern"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Removes one or more tags from the specified resource.
"""
@spec untag_resource(map(), String.t() | atom(), untag_resource_request(), list()) ::
{:ok, untag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"tagKeys", "tagKeys"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an Evidently experiment.
Don't use this operation to update an experiment's tag. Instead, use
[TagResource](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html).
"""
@spec update_experiment(
map(),
String.t() | atom(),
String.t() | atom(),
update_experiment_request(),
list()
) ::
{:ok, update_experiment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_experiment_errors()}
def update_experiment(%Client{} = client, experiment, project, input, options \\ []) do
url_path =
"/projects/#{AWS.Util.encode_uri(project)}/experiments/#{AWS.Util.encode_uri(experiment)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing feature.
You can't use this operation to update the tags of an existing feature. Instead,
use
[TagResource](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html).
"""
@spec update_feature(
map(),
String.t() | atom(),
String.t() | atom(),
update_feature_request(),
list()
) ::
{:ok, update_feature_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_feature_errors()}
def update_feature(%Client{} = client, feature, project, input, options \\ []) do
url_path =
"/projects/#{AWS.Util.encode_uri(project)}/features/#{AWS.Util.encode_uri(feature)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates a launch of a given feature.
Don't use this operation to update the tags of an existing launch. Instead, use
[TagResource](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html).
"""
@spec update_launch(
map(),
String.t() | atom(),
String.t() | atom(),
update_launch_request(),
list()
) ::
{:ok, update_launch_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_launch_errors()}
def update_launch(%Client{} = client, launch, project, input, options \\ []) do
url_path = "/projects/#{AWS.Util.encode_uri(project)}/launches/#{AWS.Util.encode_uri(launch)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates the description of an existing project.
To create a new project, use
[CreateProject](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateProject.html). Don't use this operation to update the data storage options of a project.
Instead, use
[UpdateProjectDataDelivery](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateProjectDataDelivery.html).
Don't use this operation to update the tags of a project. Instead, use
[TagResource](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html).
"""
@spec update_project(map(), String.t() | atom(), update_project_request(), list()) ::
{:ok, update_project_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_project_errors()}
def update_project(%Client{} = client, project, input, options \\ []) do
url_path = "/projects/#{AWS.Util.encode_uri(project)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates the data storage options for this project.
If you store evaluation events, you an
keep them and analyze them on your own. If you choose not to store evaluation
events,
Evidently deletes them after using them to produce metrics and other experiment
results that
you can view.
You can't specify both `cloudWatchLogs` and `s3Destination` in the same
operation.
"""
@spec update_project_data_delivery(
map(),
String.t() | atom(),
update_project_data_delivery_request(),
list()
) ::
{:ok, update_project_data_delivery_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_project_data_delivery_errors()}
def update_project_data_delivery(%Client{} = client, project, input, options \\ []) do
url_path = "/projects/#{AWS.Util.encode_uri(project)}/data-delivery"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end
