Struct aws_sdk_evidently::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for Amazon CloudWatch Evidently
Client for invoking operations on Amazon CloudWatch Evidently. Each operation on Amazon CloudWatch Evidently is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_evidently::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_evidently::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_evidently::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn batch_evaluate_feature(&self) -> BatchEvaluateFeature
pub fn batch_evaluate_feature(&self) -> BatchEvaluateFeature
Constructs a fluent builder for the BatchEvaluateFeature
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains the feature being evaluated.
requests(Vec<EvaluationRequest>)
/set_requests(Option<Vec<EvaluationRequest>>)
:An array of structures, where each structure assigns a feature variation to one user session.
- On success, responds with
BatchEvaluateFeatureOutput
with field(s):results(Option<Vec<EvaluationResult>>)
:An array of structures, where each structure displays the results of one feature evaluation assignment to one user session.
- On failure, responds with
SdkError<BatchEvaluateFeatureError>
sourcepub fn create_experiment(&self) -> CreateExperiment
pub fn create_experiment(&self) -> CreateExperiment
Constructs a fluent builder for the CreateExperiment
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that you want to create the new experiment in.
name(impl Into<String>)
/set_name(Option<String>)
:A name for the new experiment.
description(impl Into<String>)
/set_description(Option<String>)
:An optional description of the experiment.
treatments(Vec<TreatmentConfig>)
/set_treatments(Option<Vec<TreatmentConfig>>)
:An array of structures that describe the configuration of each feature variation used in the experiment.
metric_goals(Vec<MetricGoalConfig>)
/set_metric_goals(Option<Vec<MetricGoalConfig>>)
:An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.
randomization_salt(impl Into<String>)
/set_randomization_salt(Option<String>)
:When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and
randomizationSalt
. If you omitrandomizationSalt
, Evidently uses the experiment name as therandomizationSalt
.sampling_rate(i64)
/set_sampling_rate(Option<i64>)
:The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.
This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.
online_ab_config(OnlineAbConfig)
/set_online_ab_config(Option<OnlineAbConfig>)
:A structure that contains the configuration of which variation to use as the “control” version. tThe “control” version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:Assigns one or more tags (key-value pairs) to the experiment.
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 associate as many as 50 tags with an experiment.
For more information, see Tagging Amazon Web Services resources.
- On success, responds with
CreateExperimentOutput
with field(s):experiment(Option<Experiment>)
:A structure containing the configuration details of the experiment that you created.
- On failure, responds with
SdkError<CreateExperimentError>
sourcepub fn create_feature(&self) -> CreateFeature
pub fn create_feature(&self) -> CreateFeature
Constructs a fluent builder for the CreateFeature
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that is to contain the new feature.
name(impl Into<String>)
/set_name(Option<String>)
:The name for the new feature.
evaluation_strategy(FeatureEvaluationStrategy)
/set_evaluation_strategy(Option<FeatureEvaluationStrategy>)
:Specify
ALL_RULES
to activate the traffic allocation specified by any ongoing launches or experiments. SpecifyDEFAULT_VARIATION
to serve the default variation to all users instead.description(impl Into<String>)
/set_description(Option<String>)
:An optional description of the feature.
variations(Vec<VariationConfig>)
/set_variations(Option<Vec<VariationConfig>>)
:An array of structures that contain the configuration of the feature’s different variations.
default_variation(impl Into<String>)
/set_default_variation(Option<String>)
:The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.
This variation must also be listed in the
variations
structure.If you omit
defaultVariation
, the first variation listed in thevariations
structure is used as the default variation.tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:Assigns one or more tags (key-value pairs) to the feature.
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 associate as many as 50 tags with a feature.
For more information, see Tagging Amazon Web Services resources.
entity_overrides(HashMap<String, String>)
/set_entity_overrides(Option<HashMap<String, String>>)
:Specify users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.
- On success, responds with
CreateFeatureOutput
with field(s):feature(Option<Feature>)
:A structure that contains information about the new feature.
- On failure, responds with
SdkError<CreateFeatureError>
sourcepub fn create_launch(&self) -> CreateLaunch
pub fn create_launch(&self) -> CreateLaunch
Constructs a fluent builder for the CreateLaunch
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that you want to create the launch in.
name(impl Into<String>)
/set_name(Option<String>)
:The name for the new launch.
description(impl Into<String>)
/set_description(Option<String>)
:An optional description for the launch.
scheduled_splits_config(ScheduledSplitsLaunchConfig)
/set_scheduled_splits_config(Option<ScheduledSplitsLaunchConfig>)
:An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
metric_monitors(Vec<MetricMonitorConfig>)
/set_metric_monitors(Option<Vec<MetricMonitorConfig>>)
:An array of structures that define the metrics that will be used to monitor the launch performance.
groups(Vec<LaunchGroupConfig>)
/set_groups(Option<Vec<LaunchGroupConfig>>)
:An array of structures that contains the feature and variations that are to be used for the launch.
randomization_salt(impl Into<String>)
/set_randomization_salt(Option<String>)
: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 entity ID and
randomizationSalt
. If you omitrandomizationSalt
, Evidently uses the launch name as therandomizationsSalt
.tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
: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 Amazon Web Services and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with a launch.
For more information, see Tagging Amazon Web Services resources.
- On success, responds with
CreateLaunchOutput
with field(s):launch(Option<Launch>)
:A structure that contains the configuration of the launch that was created.
- On failure, responds with
SdkError<CreateLaunchError>
sourcepub fn create_project(&self) -> CreateProject
pub fn create_project(&self) -> CreateProject
Constructs a fluent builder for the CreateProject
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name for the project.
description(impl Into<String>)
/set_description(Option<String>)
:An optional description of the project.
data_delivery(ProjectDataDeliveryConfig)
/set_data_delivery(Option<ProjectDataDeliveryConfig>)
: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.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
: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 Amazon Web Services and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with a project.
For more information, see Tagging Amazon Web Services resources.
- On success, responds with
CreateProjectOutput
with field(s):project(Option<Project>)
:A structure that contains information about the created project.
- On failure, responds with
SdkError<CreateProjectError>
sourcepub fn delete_experiment(&self) -> DeleteExperiment
pub fn delete_experiment(&self) -> DeleteExperiment
Constructs a fluent builder for the DeleteExperiment
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains the experiment to delete.
experiment(impl Into<String>)
/set_experiment(Option<String>)
:The name of the experiment to delete.
- On success, responds with
DeleteExperimentOutput
- On failure, responds with
SdkError<DeleteExperimentError>
sourcepub fn delete_feature(&self) -> DeleteFeature
pub fn delete_feature(&self) -> DeleteFeature
Constructs a fluent builder for the DeleteFeature
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains the feature to delete.
feature(impl Into<String>)
/set_feature(Option<String>)
:The name of the feature to delete.
- On success, responds with
DeleteFeatureOutput
- On failure, responds with
SdkError<DeleteFeatureError>
sourcepub fn delete_launch(&self) -> DeleteLaunch
pub fn delete_launch(&self) -> DeleteLaunch
Constructs a fluent builder for the DeleteLaunch
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains the launch to delete.
launch(impl Into<String>)
/set_launch(Option<String>)
:The name of the launch to delete.
- On success, responds with
DeleteLaunchOutput
- On failure, responds with
SdkError<DeleteLaunchError>
sourcepub fn delete_project(&self) -> DeleteProject
pub fn delete_project(&self) -> DeleteProject
Constructs a fluent builder for the DeleteProject
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project to delete.
- On success, responds with
DeleteProjectOutput
- On failure, responds with
SdkError<DeleteProjectError>
sourcepub fn evaluate_feature(&self) -> EvaluateFeature
pub fn evaluate_feature(&self) -> EvaluateFeature
Constructs a fluent builder for the EvaluateFeature
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains this feature.
feature(impl Into<String>)
/set_feature(Option<String>)
:The name of the feature being evaluated.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:An internal ID that represents a unique user of the application. This
entityID
is checked against any override rules assigned for this feature.evaluation_context(impl Into<String>)
/set_evaluation_context(Option<String>)
: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.
- On success, responds with
EvaluateFeatureOutput
with field(s):variation(Option<String>)
:The name of the variation that was served to the user session.
value(Option<VariableValue>)
:The value assigned to this variation to differentiate it from the other variations of this feature.
reason(Option<String>)
: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; orENTITY_OVERRIDES_MATCH
, if the user’sentityId
matches an override rule.details(Option<String>)
:If this user was assigned to a launch or experiment, this field lists the launch or experiment name.
- On failure, responds with
SdkError<EvaluateFeatureError>
sourcepub fn get_experiment(&self) -> GetExperiment
pub fn get_experiment(&self) -> GetExperiment
Constructs a fluent builder for the GetExperiment
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains the experiment.
experiment(impl Into<String>)
/set_experiment(Option<String>)
:The name of the experiment that you want to see the details of.
- On success, responds with
GetExperimentOutput
with field(s):experiment(Option<Experiment>)
:A structure containing the configuration details of the experiment.
- On failure, responds with
SdkError<GetExperimentError>
sourcepub fn get_experiment_results(&self) -> GetExperimentResults
pub fn get_experiment_results(&self) -> GetExperimentResults
Constructs a fluent builder for the GetExperimentResults
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains the experiment that you want to see the results of.
experiment(impl Into<String>)
/set_experiment(Option<String>)
:The name of the experiment to retrieve the results of.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:The date and time that the experiment started.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.
metric_names(Vec<String>)
/set_metric_names(Option<Vec<String>>)
:The names of the experiment metrics that you want to see the results of.
treatment_names(Vec<String>)
/set_treatment_names(Option<Vec<String>>)
:The names of the experiment treatments that you want to see the results for.
base_stat(ExperimentBaseStat)
/set_base_stat(Option<ExperimentBaseStat>)
: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.result_stats(Vec<ExperimentResultRequestType>)
/set_result_stats(Option<Vec<ExperimentResultRequestType>>)
:The statistics that you want to see in the returned results.
-
PValue
specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05. -
ConfidenceInterval
specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between thebaseStat
of a variation and the baseline. Evidently returns the 95% confidence interval. -
TreatmentEffect
is the difference in the statistic specified by thebaseStat
parameter between each variation and the default variation. -
BaseStat
returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in thebaseStat
parameter. Therefore, ifbaseStat
ismean
, this returns the mean of the values collected for each variation.
-
report_names(Vec<ExperimentReportName>)
/set_report_names(Option<Vec<ExperimentReportName>>)
:The names of the report types that you want to see. Currently,
BayesianInference
is the only valid value.period(i64)
/set_period(i64)
:In seconds, the amount of time to aggregate results together.
- On success, responds with
GetExperimentResultsOutput
with field(s):results_data(Option<Vec<ExperimentResultsData>>)
:An array of structures that include experiment results including metric names and values.
reports(Option<Vec<ExperimentReport>>)
:An array of structures that include the reports that you requested.
timestamps(Option<Vec<DateTime>>)
:The timestamps of each result returned.
details(Option<String>)
:If the experiment doesn’t yet have enough events to provide valid results, this field is returned with the message
Not enough events to generate results
. If there are enough events to provide valid results, this field is not returned.
- On failure, responds with
SdkError<GetExperimentResultsError>
sourcepub fn get_feature(&self) -> GetFeature
pub fn get_feature(&self) -> GetFeature
Constructs a fluent builder for the GetFeature
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains the feature.
feature(impl Into<String>)
/set_feature(Option<String>)
:The name of the feature that you want to retrieve information for.
- On success, responds with
GetFeatureOutput
with field(s):feature(Option<Feature>)
:A structure containing the configuration details of the feature.
- On failure, responds with
SdkError<GetFeatureError>
sourcepub fn get_launch(&self) -> GetLaunch
pub fn get_launch(&self) -> GetLaunch
Constructs a fluent builder for the GetLaunch
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains the launch.
launch(impl Into<String>)
/set_launch(Option<String>)
:The name of the launch that you want to see the details of.
- On success, responds with
GetLaunchOutput
with field(s):launch(Option<Launch>)
:A structure containing the configuration details of the launch.
- On failure, responds with
SdkError<GetLaunchError>
sourcepub fn get_project(&self) -> GetProject
pub fn get_project(&self) -> GetProject
Constructs a fluent builder for the GetProject
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that you want to see the details of.
- On success, responds with
GetProjectOutput
with field(s):project(Option<Project>)
:A structure containing the configuration details of the project.
- On failure, responds with
SdkError<GetProjectError>
sourcepub fn list_experiments(&self) -> ListExperiments
pub fn list_experiments(&self) -> ListExperiments
Constructs a fluent builder for the ListExperiments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project to return the experiment list from.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to include in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use when requesting the next set of results. You received this token from a previous
ListExperiments
operation.status(ExperimentStatus)
/set_status(Option<ExperimentStatus>)
:Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.
- On success, responds with
ListExperimentsOutput
with field(s):experiments(Option<Vec<Experiment>>)
:An array of structures that contain the configuration details of the experiments in the specified project.
next_token(Option<String>)
:The token to use in a subsequent
ListExperiments
operation to return the next set of results.
- On failure, responds with
SdkError<ListExperimentsError>
sourcepub fn list_features(&self) -> ListFeatures
pub fn list_features(&self) -> ListFeatures
Constructs a fluent builder for the ListFeatures
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project to return the feature list from.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to include in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use when requesting the next set of results. You received this token from a previous
ListFeatures
operation.
- On success, responds with
ListFeaturesOutput
with field(s):features(Option<Vec<FeatureSummary>>)
:An array of structures that contain the configuration details of the features in the specified project.
next_token(Option<String>)
:The token to use in a subsequent
ListFeatures
operation to return the next set of results.
- On failure, responds with
SdkError<ListFeaturesError>
sourcepub fn list_launches(&self) -> ListLaunches
pub fn list_launches(&self) -> ListLaunches
Constructs a fluent builder for the ListLaunches
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project to return the launch list from.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to include in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use when requesting the next set of results. You received this token from a previous
ListLaunches
operation.status(LaunchStatus)
/set_status(Option<LaunchStatus>)
:Use this optional parameter to limit the returned results to only the launches with the status that you specify here.
- On success, responds with
ListLaunchesOutput
with field(s):launches(Option<Vec<Launch>>)
:An array of structures that contain the configuration details of the launches in the specified project.
next_token(Option<String>)
:The token to use in a subsequent
ListLaunches
operation to return the next set of results.
- On failure, responds with
SdkError<ListLaunchesError>
sourcepub fn list_projects(&self) -> ListProjects
pub fn list_projects(&self) -> ListProjects
Constructs a fluent builder for the ListProjects
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to include in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to use when requesting the next set of results. You received this token from a previous
ListProjects
operation.
- On success, responds with
ListProjectsOutput
with field(s):projects(Option<Vec<ProjectSummary>>)
:An array of structures that contain the configuration details of the projects in the Region.
next_token(Option<String>)
:The token to use in a subsequent
ListProjects
operation to return the next set of results.
- On failure, responds with
SdkError<ListProjectsError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of the resource that you want to see the tags of.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap<String, String>>)
:The list of tag keys and values associated with the resource you specified.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn put_project_events(&self) -> PutProjectEvents
pub fn put_project_events(&self) -> PutProjectEvents
Constructs a fluent builder for the PutProjectEvents
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project to write the events to.
events(Vec<Event>)
/set_events(Option<Vec<Event>>)
:An array of event structures that contain the performance data that is being sent to Evidently.
- On success, responds with
PutProjectEventsOutput
with field(s):failed_event_count(Option<i32>)
:The number of events in the operation that could not be used by Evidently.
event_results(Option<Vec<PutProjectEventsResultEntry>>)
:A structure that contains Evidently’s response to the sent events, including an event ID and error codes, if any.
- On failure, responds with
SdkError<PutProjectEventsError>
sourcepub fn start_experiment(&self) -> StartExperiment
pub fn start_experiment(&self) -> StartExperiment
Constructs a fluent builder for the StartExperiment
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains the experiment to start.
experiment(impl Into<String>)
/set_experiment(Option<String>)
:The name of the experiment to start.
analysis_complete_time(DateTime)
/set_analysis_complete_time(Option<DateTime>)
:The date and time to end the experiment. This must be no more than 30 days after the experiment starts.
- On success, responds with
StartExperimentOutput
with field(s):started_time(Option<DateTime>)
:A timestamp that indicates when the experiment started.
- On failure, responds with
SdkError<StartExperimentError>
sourcepub fn start_launch(&self) -> StartLaunch
pub fn start_launch(&self) -> StartLaunch
Constructs a fluent builder for the StartLaunch
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains the launch to start.
launch(impl Into<String>)
/set_launch(Option<String>)
:The name of the launch to start.
- On success, responds with
StartLaunchOutput
with field(s):launch(Option<Launch>)
:A structure that contains information about the launch that was started.
- On failure, responds with
SdkError<StartLaunchError>
sourcepub fn stop_experiment(&self) -> StopExperiment
pub fn stop_experiment(&self) -> StopExperiment
Constructs a fluent builder for the StopExperiment
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains the experiment to stop.
experiment(impl Into<String>)
/set_experiment(Option<String>)
:The name of the experiment to stop.
desired_state(ExperimentStopDesiredState)
/set_desired_state(Option<ExperimentStopDesiredState>)
:Specify whether the experiment is to be considered
COMPLETED
orCANCELLED
after it stops.reason(impl Into<String>)
/set_reason(Option<String>)
:A string that describes why you are stopping the experiment.
- On success, responds with
StopExperimentOutput
with field(s):ended_time(Option<DateTime>)
:The date and time that the experiment stopped.
- On failure, responds with
SdkError<StopExperimentError>
sourcepub fn stop_launch(&self) -> StopLaunch
pub fn stop_launch(&self) -> StopLaunch
Constructs a fluent builder for the StopLaunch
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains the launch that you want to stop.
launch(impl Into<String>)
/set_launch(Option<String>)
:The name of the launch to stop.
desired_state(LaunchStopDesiredState)
/set_desired_state(Option<LaunchStopDesiredState>)
:Specify whether to consider the launch as
COMPLETED
orCANCELLED
after it stops.reason(impl Into<String>)
/set_reason(Option<String>)
:A string that describes why you are stopping the launch.
- On success, responds with
StopLaunchOutput
with field(s):ended_time(Option<DateTime>)
:The date and time that the launch stopped.
- On failure, responds with
SdkError<StopLaunchError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of the CloudWatch Evidently resource that you’re adding tags to.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The list of key-value pairs to associate with the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of the CloudWatch Evidently resource that you’re removing tags from.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The list of tag keys to remove from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_experiment(&self) -> UpdateExperiment
pub fn update_experiment(&self) -> UpdateExperiment
Constructs a fluent builder for the UpdateExperiment
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains the experiment that you want to update.
experiment(impl Into<String>)
/set_experiment(Option<String>)
:The name of the experiment to update.
description(impl Into<String>)
/set_description(Option<String>)
:An optional description of the experiment.
treatments(Vec<TreatmentConfig>)
/set_treatments(Option<Vec<TreatmentConfig>>)
:An array of structures that define the variations being tested in the experiment.
metric_goals(Vec<MetricGoalConfig>)
/set_metric_goals(Option<Vec<MetricGoalConfig>>)
:An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.
randomization_salt(impl Into<String>)
/set_randomization_salt(Option<String>)
:When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and
randomizationSalt
. If you omitrandomizationSalt
, Evidently uses the experiment name as therandomizationSalt
.sampling_rate(i64)
/set_sampling_rate(Option<i64>)
:The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.
This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.
online_ab_config(OnlineAbConfig)
/set_online_ab_config(Option<OnlineAbConfig>)
:A structure that contains the configuration of which variation o use as the “control” version. The “control” version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
- On success, responds with
UpdateExperimentOutput
with field(s):experiment(Option<Experiment>)
:A structure containing the configuration details of the experiment that was updated.
- On failure, responds with
SdkError<UpdateExperimentError>
sourcepub fn update_feature(&self) -> UpdateFeature
pub fn update_feature(&self) -> UpdateFeature
Constructs a fluent builder for the UpdateFeature
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains the feature to be updated.
feature(impl Into<String>)
/set_feature(Option<String>)
:The name of the feature to be updated.
evaluation_strategy(FeatureEvaluationStrategy)
/set_evaluation_strategy(Option<FeatureEvaluationStrategy>)
:Specify
ALL_RULES
to activate the traffic allocation specified by any ongoing launches or experiments. SpecifyDEFAULT_VARIATION
to serve the default variation to all users instead.description(impl Into<String>)
/set_description(Option<String>)
:An optional description of the feature.
add_or_update_variations(Vec<VariationConfig>)
/set_add_or_update_variations(Option<Vec<VariationConfig>>)
:To update variation configurations for this feature, or add new ones, specify this structure. In this array, include any variations that you want to add or update. If the array includes a variation name that already exists for this feature, it is updated. If it includes a new variation name, it is added as a new variation.
remove_variations(Vec<String>)
/set_remove_variations(Option<Vec<String>>)
:Removes a variation from the feature. If the variation you specify doesn’t exist, then this makes no change and does not report an error.
This operation fails if you try to remove a variation that is part of an ongoing launch or experiment.
default_variation(impl Into<String>)
/set_default_variation(Option<String>)
:The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.
entity_overrides(HashMap<String, String>)
/set_entity_overrides(Option<HashMap<String, String>>)
:Specified users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.
- On success, responds with
UpdateFeatureOutput
with field(s):feature(Option<Feature>)
:A structure that contains information about the updated feature.
- On failure, responds with
SdkError<UpdateFeatureError>
sourcepub fn update_launch(&self) -> UpdateLaunch
pub fn update_launch(&self) -> UpdateLaunch
Constructs a fluent builder for the UpdateLaunch
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that contains the launch that you want to update.
launch(impl Into<String>)
/set_launch(Option<String>)
:The name of the launch that is to be updated.
description(impl Into<String>)
/set_description(Option<String>)
:An optional description for the launch.
groups(Vec<LaunchGroupConfig>)
/set_groups(Option<Vec<LaunchGroupConfig>>)
:An array of structures that contains the feature and variations that are to be used for the launch.
metric_monitors(Vec<MetricMonitorConfig>)
/set_metric_monitors(Option<Vec<MetricMonitorConfig>>)
:An array of structures that define the metrics that will be used to monitor the launch performance.
randomization_salt(impl Into<String>)
/set_randomization_salt(Option<String>)
: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 entity ID and
randomizationSalt
. If you omitrandomizationSalt
, Evidently uses the launch name as therandomizationSalt
.scheduled_splits_config(ScheduledSplitsLaunchConfig)
/set_scheduled_splits_config(Option<ScheduledSplitsLaunchConfig>)
:An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
- On success, responds with
UpdateLaunchOutput
with field(s):launch(Option<Launch>)
:A structure that contains the new configuration of the launch that was updated.
- On failure, responds with
SdkError<UpdateLaunchError>
sourcepub fn update_project(&self) -> UpdateProject
pub fn update_project(&self) -> UpdateProject
Constructs a fluent builder for the UpdateProject
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project to update.
description(impl Into<String>)
/set_description(Option<String>)
:An optional description of the project.
- On success, responds with
UpdateProjectOutput
with field(s):project(Option<Project>)
:A structure containing information about the updated project.
- On failure, responds with
SdkError<UpdateProjectError>
sourcepub fn update_project_data_delivery(&self) -> UpdateProjectDataDelivery
pub fn update_project_data_delivery(&self) -> UpdateProjectDataDelivery
Constructs a fluent builder for the UpdateProjectDataDelivery
operation.
- The fluent builder is configurable:
project(impl Into<String>)
/set_project(Option<String>)
:The name or ARN of the project that you want to modify the data storage options for.
s3_destination(S3DestinationConfig)
/set_s3_destination(Option<S3DestinationConfig>)
:A structure containing the S3 bucket name and bucket prefix where you want to store evaluation events.
cloud_watch_logs(CloudWatchLogsDestinationConfig)
/set_cloud_watch_logs(Option<CloudWatchLogsDestinationConfig>)
:A structure containing the CloudWatch Logs log group where you want to store evaluation events.
- On success, responds with
UpdateProjectDataDeliveryOutput
with field(s):project(Option<Project>)
:A structure containing details about the project that you updated.
- On failure, responds with
SdkError<UpdateProjectDataDeliveryError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more