/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.cloudwatchevidently; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.cloudwatchevidently.model.*; /** * Interface for accessing Amazon CloudWatch Evidently. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.cloudwatchevidently.AbstractAmazonCloudWatchEvidently} instead. *

*

*

* 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. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCloudWatchEvidently { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "evidently"; /** *

* 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. *

* * @param batchEvaluateFeatureRequest * @return Result of the BatchEvaluateFeature operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.BatchEvaluateFeature * @see AWS * API Documentation */ BatchEvaluateFeatureResult batchEvaluateFeature(BatchEvaluateFeatureRequest batchEvaluateFeatureRequest); /** *

* 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. *

* * @param createExperimentRequest * @return Result of the CreateExperiment operation returned by the service. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ServiceQuotaExceededException * The request would cause a service quota to be exceeded. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.CreateExperiment * @see AWS API * Documentation */ CreateExperimentResult createExperiment(CreateExperimentRequest createExperimentRequest); /** *

* 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. *

*

* Don't use this operation to update an existing feature. Instead, use UpdateFeature. *

* * @param createFeatureRequest * @return Result of the CreateFeature operation returned by the service. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ServiceQuotaExceededException * The request would cause a service quota to be exceeded. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.CreateFeature * @see AWS API * Documentation */ CreateFeatureResult createFeature(CreateFeatureRequest createFeatureRequest); /** *

* 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. *

* * @param createLaunchRequest * @return Result of the CreateLaunch operation returned by the service. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ServiceQuotaExceededException * The request would cause a service quota to be exceeded. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.CreateLaunch * @see AWS API * Documentation */ CreateLaunchResult createLaunch(CreateLaunchRequest createLaunchRequest); /** *

* 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. *

* * @param createProjectRequest * @return Result of the CreateProject operation returned by the service. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ServiceQuotaExceededException * The request would cause a service quota to be exceeded. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.CreateProject * @see AWS API * Documentation */ CreateProjectResult createProject(CreateProjectRequest createProjectRequest); /** *

* 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. *

*

* The pattern that you define for a segment is matched against the value of evaluationContext, which * is passed into Evidently in the EvaluateFeature operation, when Evidently assigns a feature variation to a user. *

* * @param createSegmentRequest * @return Result of the CreateSegment operation returned by the service. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ServiceQuotaExceededException * The request would cause a service quota to be exceeded. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.CreateSegment * @see AWS API * Documentation */ CreateSegmentResult createSegment(CreateSegmentRequest createSegmentRequest); /** *

* Deletes an Evidently experiment. The feature used for the experiment is not deleted. *

*

* To stop an experiment without deleting it, use StopExperiment. *

* * @param deleteExperimentRequest * @return Result of the DeleteExperiment operation returned by the service. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws InternalServerException * Unexpected error while processing the request. Retry the request. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ServiceUnavailableException * The service was unavailable. Retry the request. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.DeleteExperiment * @see AWS API * Documentation */ DeleteExperimentResult deleteExperiment(DeleteExperimentRequest deleteExperimentRequest); /** *

* Deletes an Evidently feature. *

* * @param deleteFeatureRequest * @return Result of the DeleteFeature operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.DeleteFeature * @see AWS API * Documentation */ DeleteFeatureResult deleteFeature(DeleteFeatureRequest deleteFeatureRequest); /** *

* Deletes an Evidently launch. The feature used for the launch is not deleted. *

*

* To stop a launch without deleting it, use StopLaunch. *

* * @param deleteLaunchRequest * @return Result of the DeleteLaunch operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.DeleteLaunch * @see AWS API * Documentation */ DeleteLaunchResult deleteLaunch(DeleteLaunchRequest deleteLaunchRequest); /** *

* 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. *

* * @param deleteProjectRequest * @return Result of the DeleteProject operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.DeleteProject * @see AWS API * Documentation */ DeleteProjectResult deleteProject(DeleteProjectRequest deleteProjectRequest); /** *

* 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. *

* * @param deleteSegmentRequest * @return Result of the DeleteSegment operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.DeleteSegment * @see AWS API * Documentation */ DeleteSegmentResult deleteSegment(DeleteSegmentRequest deleteSegmentRequest); /** *

* 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 and Use * segments to focus your audience. *

*

* 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. *

* * @param evaluateFeatureRequest * @return Result of the EvaluateFeature operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.EvaluateFeature * @see AWS API * Documentation */ EvaluateFeatureResult evaluateFeature(EvaluateFeatureRequest evaluateFeatureRequest); /** *

* Returns the details about one experiment. You must already know the experiment name. To retrieve a list of * experiments in your account, use ListExperiments. *

* * @param getExperimentRequest * @return Result of the GetExperiment operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.GetExperiment * @see AWS API * Documentation */ GetExperimentResult getExperiment(GetExperimentRequest getExperimentRequest); /** *

* 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. *

* * @param getExperimentResultsRequest * @return Result of the GetExperimentResults operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.GetExperimentResults * @see AWS * API Documentation */ GetExperimentResultsResult getExperimentResults(GetExperimentResultsRequest getExperimentResultsRequest); /** *

* Returns the details about one feature. You must already know the feature name. To retrieve a list of features in * your account, use ListFeatures. *

* * @param getFeatureRequest * @return Result of the GetFeature operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.GetFeature * @see AWS API * Documentation */ GetFeatureResult getFeature(GetFeatureRequest getFeatureRequest); /** *

* Returns the details about one launch. You must already know the launch name. To retrieve a list of launches in * your account, use ListLaunches. *

* * @param getLaunchRequest * @return Result of the GetLaunch operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.GetLaunch * @see AWS API * Documentation */ GetLaunchResult getLaunch(GetLaunchRequest getLaunchRequest); /** *

* Returns the details about one launch. You must already know the project name. To retrieve a list of projects in * your account, use ListProjects. *

* * @param getProjectRequest * @return Result of the GetProject operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.GetProject * @see AWS API * Documentation */ GetProjectResult getProject(GetProjectRequest getProjectRequest); /** *

* Returns information about the specified segment. Specify the segment you want to view by specifying its ARN. *

* * @param getSegmentRequest * @return Result of the GetSegment operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.GetSegment * @see AWS API * Documentation */ GetSegmentResult getSegment(GetSegmentRequest getSegmentRequest); /** *

* Returns configuration details about all the experiments in the specified project. *

* * @param listExperimentsRequest * @return Result of the ListExperiments operation returned by the service. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.ListExperiments * @see AWS API * Documentation */ ListExperimentsResult listExperiments(ListExperimentsRequest listExperimentsRequest); /** *

* Returns configuration details about all the features in the specified project. *

* * @param listFeaturesRequest * @return Result of the ListFeatures operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.ListFeatures * @see AWS API * Documentation */ ListFeaturesResult listFeatures(ListFeaturesRequest listFeaturesRequest); /** *

* Returns configuration details about all the launches in the specified project. *

* * @param listLaunchesRequest * @return Result of the ListLaunches operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.ListLaunches * @see AWS API * Documentation */ ListLaunchesResult listLaunches(ListLaunchesRequest listLaunchesRequest); /** *

* Returns configuration details about all the projects in the current Region in your account. *

* * @param listProjectsRequest * @return Result of the ListProjects operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.ListProjects * @see AWS API * Documentation */ ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest); /** *

* Use this operation to find which experiments or launches are using a specified segment. *

* * @param listSegmentReferencesRequest * @return Result of the ListSegmentReferences operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.ListSegmentReferences * @see AWS API Documentation */ ListSegmentReferencesResult listSegmentReferences(ListSegmentReferencesRequest listSegmentReferencesRequest); /** *

* Returns a list of audience segments that you have created in your account in this Region. *

* * @param listSegmentsRequest * @return Result of the ListSegments operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.ListSegments * @see AWS API * Documentation */ ListSegmentsResult listSegments(ListSegmentsRequest listSegmentsRequest); /** *

* Displays the tags associated with an Evidently resource. *

* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @sample AmazonCloudWatchEvidently.ListTagsForResource * @see AWS * API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* Sends performance events to Evidently. These events can be used to evaluate a launch or an experiment. *

* * @param putProjectEventsRequest * @return Result of the PutProjectEvents operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.PutProjectEvents * @see AWS API * Documentation */ PutProjectEventsResult putProjectEvents(PutProjectEventsRequest putProjectEventsRequest); /** *

* Starts an existing experiment. To create an experiment, use CreateExperiment. *

* * @param startExperimentRequest * @return Result of the StartExperiment operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ServiceQuotaExceededException * The request would cause a service quota to be exceeded. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.StartExperiment * @see AWS API * Documentation */ StartExperimentResult startExperiment(StartExperimentRequest startExperimentRequest); /** *

* Starts an existing launch. To create a launch, use CreateLaunch. *

* * @param startLaunchRequest * @return Result of the StartLaunch operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ServiceQuotaExceededException * The request would cause a service quota to be exceeded. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.StartLaunch * @see AWS API * Documentation */ StartLaunchResult startLaunch(StartLaunchRequest startLaunchRequest); /** *

* Stops an experiment that is currently running. If you stop an experiment, you can't resume it or restart it. *

* * @param stopExperimentRequest * @return Result of the StopExperiment operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ServiceQuotaExceededException * The request would cause a service quota to be exceeded. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.StopExperiment * @see AWS API * Documentation */ StopExperimentResult stopExperiment(StopExperimentRequest stopExperimentRequest); /** *

* 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. *

* * @param stopLaunchRequest * @return Result of the StopLaunch operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.StopLaunch * @see AWS API * Documentation */ StopLaunchResult stopLaunch(StopLaunchRequest stopLaunchRequest); /** *

* 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. *

* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @sample AmazonCloudWatchEvidently.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** *

* 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. *

* * @param testSegmentPatternRequest * @return Result of the TestSegmentPattern operation returned by the service. * @throws ThrottlingException * The request was denied because of request throttling. Retry the request. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.TestSegmentPattern * @see AWS * API Documentation */ TestSegmentPatternResult testSegmentPattern(TestSegmentPatternRequest testSegmentPatternRequest); /** *

* Removes one or more tags from the specified resource. *

* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @sample AmazonCloudWatchEvidently.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** *

* Updates an Evidently experiment. *

*

* Don't use this operation to update an experiment's tag. Instead, use TagResource. *

* * @param updateExperimentRequest * @return Result of the UpdateExperiment operation returned by the service. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.UpdateExperiment * @see AWS API * Documentation */ UpdateExperimentResult updateExperiment(UpdateExperimentRequest updateExperimentRequest); /** *

* Updates an existing feature. *

*

* You can't use this operation to update the tags of an existing feature. Instead, use TagResource. *

* * @param updateFeatureRequest * @return Result of the UpdateFeature operation returned by the service. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ServiceQuotaExceededException * The request would cause a service quota to be exceeded. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.UpdateFeature * @see AWS API * Documentation */ UpdateFeatureResult updateFeature(UpdateFeatureRequest updateFeatureRequest); /** *

* Updates a launch of a given feature. *

*

* Don't use this operation to update the tags of an existing launch. Instead, use TagResource. *

* * @param updateLaunchRequest * @return Result of the UpdateLaunch operation returned by the service. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.UpdateLaunch * @see AWS API * Documentation */ UpdateLaunchResult updateLaunch(UpdateLaunchRequest updateLaunchRequest); /** *

* Updates the description of an existing project. *

*

* To create a new project, use CreateProject. *

*

* Don't use this operation to update the data storage options of a project. Instead, use UpdateProjectDataDelivery. *

*

* Don't use this operation to update the tags of a project. Instead, use TagResource. *

* * @param updateProjectRequest * @return Result of the UpdateProject operation returned by the service. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ServiceQuotaExceededException * The request would cause a service quota to be exceeded. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.UpdateProject * @see AWS API * Documentation */ UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest); /** *

* 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. *

* * @param updateProjectDataDeliveryRequest * @return Result of the UpdateProjectDataDelivery operation returned by the service. * @throws ValidationException * The value of a parameter in the request caused an error. * @throws ConflictException * A resource was in an inconsistent state during an update or a deletion. * @throws ServiceQuotaExceededException * The request would cause a service quota to be exceeded. * @throws ResourceNotFoundException * The request references a resource that does not exist. * @throws AccessDeniedException * You do not have sufficient permissions to perform this action. * @sample AmazonCloudWatchEvidently.UpdateProjectDataDelivery * @see AWS API Documentation */ UpdateProjectDataDeliveryResult updateProjectDataDelivery(UpdateProjectDataDeliveryRequest updateProjectDataDeliveryRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *

* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }