AmazonCloudWatchEvidently (AWS SDK for Java

All Known Subinterfaces:

AmazonCloudWatchEvidentlyAsync

All Known Implementing Classes:

AbstractAmazonCloudWatchEvidently, AbstractAmazonCloudWatchEvidentlyAsync, AmazonCloudWatchEvidentlyAsyncClient, AmazonCloudWatchEvidentlyClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCloudWatchEvidently
```
Interface for accessing Amazon CloudWatch Evidently.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from 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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BatchEvaluateFeatureResult`	`batchEvaluateFeature(BatchEvaluateFeatureRequest batchEvaluateFeatureRequest)` This operation assigns feature variation to user sessions.
`CreateExperimentResult`	`createExperiment(CreateExperimentRequest createExperimentRequest)` Creates an Evidently experiment.
`CreateFeatureResult`	`createFeature(CreateFeatureRequest createFeatureRequest)` Creates an Evidently feature that you want to launch or test.
`CreateLaunchResult`	`createLaunch(CreateLaunchRequest createLaunchRequest)` Creates a launch of a given feature.
`CreateProjectResult`	`createProject(CreateProjectRequest createProjectRequest)` Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments.
`DeleteExperimentResult`	`deleteExperiment(DeleteExperimentRequest deleteExperimentRequest)` Deletes an Evidently experiment.
`DeleteFeatureResult`	`deleteFeature(DeleteFeatureRequest deleteFeatureRequest)` Deletes an Evidently feature.
`DeleteLaunchResult`	`deleteLaunch(DeleteLaunchRequest deleteLaunchRequest)` Deletes an Evidently launch.
`DeleteProjectResult`	`deleteProject(DeleteProjectRequest deleteProjectRequest)` Deletes an Evidently project.
`EvaluateFeatureResult`	`evaluateFeature(EvaluateFeatureRequest evaluateFeatureRequest)` This operation assigns a feature variation to one given user session.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetExperimentResult`	`getExperiment(GetExperimentRequest getExperimentRequest)` Returns the details about one experiment.
`GetExperimentResultsResult`	`getExperimentResults(GetExperimentResultsRequest getExperimentResultsRequest)` Retrieves the results of a running or completed experiment.
`GetFeatureResult`	`getFeature(GetFeatureRequest getFeatureRequest)` Returns the details about one feature.
`GetLaunchResult`	`getLaunch(GetLaunchRequest getLaunchRequest)` Returns the details about one launch.
`GetProjectResult`	`getProject(GetProjectRequest getProjectRequest)` Returns the details about one launch.
`ListExperimentsResult`	`listExperiments(ListExperimentsRequest listExperimentsRequest)` Returns configuration details about all the experiments in the specified project.
`ListFeaturesResult`	`listFeatures(ListFeaturesRequest listFeaturesRequest)` Returns configuration details about all the features in the specified project.
`ListLaunchesResult`	`listLaunches(ListLaunchesRequest listLaunchesRequest)` Returns configuration details about all the launches in the specified project.
`ListProjectsResult`	`listProjects(ListProjectsRequest listProjectsRequest)` Returns configuration details about all the projects in the current Region in your account.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Displays the tags associated with an Evidently resource.
`PutProjectEventsResult`	`putProjectEvents(PutProjectEventsRequest putProjectEventsRequest)` Sends performance events to Evidently.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartExperimentResult`	`startExperiment(StartExperimentRequest startExperimentRequest)` Starts an existing experiment.
`StartLaunchResult`	`startLaunch(StartLaunchRequest startLaunchRequest)` Starts an existing launch.
`StopExperimentResult`	`stopExperiment(StopExperimentRequest stopExperimentRequest)` Stops an experiment that is currently running.
`StopLaunchResult`	`stopLaunch(StopLaunchRequest stopLaunchRequest)` Stops a launch that is currently running.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes one or more tags from the specified resource.
`UpdateExperimentResult`	`updateExperiment(UpdateExperimentRequest updateExperimentRequest)` Updates an Evidently experiment.
`UpdateFeatureResult`	`updateFeature(UpdateFeatureRequest updateFeatureRequest)` Updates an existing feature.
`UpdateLaunchResult`	`updateLaunch(UpdateLaunchRequest updateLaunchRequest)` Updates a launch of a given feature.
`UpdateProjectResult`	`updateProject(UpdateProjectRequest updateProjectRequest)` Updates the description of an existing project.
`UpdateProjectDataDeliveryResult`	`updateProjectDataDelivery(UpdateProjectDataDeliveryRequest updateProjectDataDeliveryRequest)` Updates the data storage options for this project.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    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 Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - batchEvaluateFeature
```
BatchEvaluateFeatureResult batchEvaluateFeature(BatchEvaluateFeatureRequest batchEvaluateFeatureRequest)
```
    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.
    
    Parameters:
    
    batchEvaluateFeatureRequest -
    
    Returns:
    
    Result of the BatchEvaluateFeature operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - createExperiment
```
CreateExperimentResult createExperiment(CreateExperimentRequest createExperimentRequest)
```
    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.
    
    Don't use this operation to update an existing experiment. Instead, use UpdateExperiment.
    
    Parameters:
    
    createExperimentRequest -
    
    Returns:
    
    Result of the CreateExperiment operation returned by the service.
    
    Throws:
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - createFeature
```
CreateFeatureResult createFeature(CreateFeatureRequest createFeatureRequest)
```
    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.
    
    Parameters:
    
    createFeatureRequest -
    
    Returns:
    
    Result of the CreateFeature operation returned by the service.
    
    Throws:
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - createLaunch
```
CreateLaunchResult createLaunch(CreateLaunchRequest createLaunchRequest)
```
    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.
    
    Parameters:
    
    createLaunchRequest -
    
    Returns:
    
    Result of the CreateLaunch operation returned by the service.
    
    Throws:
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - createProject
```
CreateProjectResult createProject(CreateProjectRequest createProjectRequest)
```
    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.
    
    Parameters:
    
    createProjectRequest -
    
    Returns:
    
    Result of the CreateProject operation returned by the service.
    
    Throws:
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - deleteExperiment
```
DeleteExperimentResult deleteExperiment(DeleteExperimentRequest deleteExperimentRequest)
```
    Deletes an Evidently experiment. The feature used for the experiment is not deleted.
    
    To stop an experiment without deleting it, use StopExperiment.
    
    Parameters:
    
    deleteExperimentRequest -
    
    Returns:
    
    Result of the DeleteExperiment operation returned by the service.
    
    Throws:
    
    InternalServerException - Unexpected error while processing the request. Retry the request.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ServiceUnavailableException - The service was unavailable. Retry the request.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - deleteFeature
```
DeleteFeatureResult deleteFeature(DeleteFeatureRequest deleteFeatureRequest)
```
    Deletes an Evidently feature.
    
    Parameters:
    
    deleteFeatureRequest -
    
    Returns:
    
    Result of the DeleteFeature operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - deleteLaunch
```
DeleteLaunchResult deleteLaunch(DeleteLaunchRequest deleteLaunchRequest)
```
    Deletes an Evidently launch. The feature used for the launch is not deleted.
    
    To stop a launch without deleting it, use StopLaunch.
    
    Parameters:
    
    deleteLaunchRequest -
    
    Returns:
    
    Result of the DeleteLaunch operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - deleteProject
```
DeleteProjectResult deleteProject(DeleteProjectRequest deleteProjectRequest)
```
    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.
    
    Parameters:
    
    deleteProjectRequest -
    
    Returns:
    
    Result of the DeleteProject operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - evaluateFeature
```
EvaluateFeatureResult evaluateFeature(EvaluateFeatureRequest evaluateFeatureRequest)
```
    This operation assigns a feature variation to one given user session. You pass in an entityID that represents the user. Evidently then checks the evaluation rules and assigns the variation.
    
    The first rules that are evaluated are the override rules. If the user's entityID matches an override rule, the user is served the variation specified by that rule.
    
    Next, if there is a launch of the feature, the user might be assigned to a variation in the launch. The chance of this depends on the percentage of users that are allocated to that launch. If the user is enrolled in the launch, the variation they are served depends on the allocation of the various feature variations used for the launch.
    
    If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might be assigned to a variation in the experiment. The chance of this depends on the percentage of users that are allocated to that experiment. If the user is enrolled in the experiment, the variation they are served depends on the allocation of the various feature variations used for the experiment.
    
    If the user is not assigned to a launch or experiment, they are served the default variation.
    
    Parameters:
    
    evaluateFeatureRequest -
    
    Returns:
    
    Result of the EvaluateFeature operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - getExperiment
```
GetExperimentResult getExperiment(GetExperimentRequest getExperimentRequest)
```
    Returns the details about one experiment. You must already know the experiment name. To retrieve a list of experiments in your account, use ListExperiments.
    
    Parameters:
    
    getExperimentRequest -
    
    Returns:
    
    Result of the GetExperiment operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - getExperimentResults
```
GetExperimentResultsResult getExperimentResults(GetExperimentResultsRequest getExperimentResultsRequest)
```
    Retrieves the results of a running or completed experiment.
    
    Parameters:
    
    getExperimentResultsRequest -
    
    Returns:
    
    Result of the GetExperimentResults operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - getFeature
```
GetFeatureResult getFeature(GetFeatureRequest getFeatureRequest)
```
    Returns the details about one feature. You must already know the feature name. To retrieve a list of features in your account, use ListFeatures.
    
    Parameters:
    
    getFeatureRequest -
    
    Returns:
    
    Result of the GetFeature operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - getLaunch
```
GetLaunchResult getLaunch(GetLaunchRequest getLaunchRequest)
```
    Returns the details about one launch. You must already know the launch name. To retrieve a list of launches in your account, use ListLaunches.
    
    Parameters:
    
    getLaunchRequest -
    
    Returns:
    
    Result of the GetLaunch operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - getProject
```
GetProjectResult getProject(GetProjectRequest getProjectRequest)
```
    Returns the details about one launch. You must already know the project name. To retrieve a list of projects in your account, use ListProjects.
    
    Parameters:
    
    getProjectRequest -
    
    Returns:
    
    Result of the GetProject operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - listExperiments
```
ListExperimentsResult listExperiments(ListExperimentsRequest listExperimentsRequest)
```
    Returns configuration details about all the experiments in the specified project.
    
    Parameters:
    
    listExperimentsRequest -
    
    Returns:
    
    Result of the ListExperiments operation returned by the service.
    
    Throws:
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    See Also:
    
    AWS API Documentation
  - listFeatures
```
ListFeaturesResult listFeatures(ListFeaturesRequest listFeaturesRequest)
```
    Returns configuration details about all the features in the specified project.
    
    Parameters:
    
    listFeaturesRequest -
    
    Returns:
    
    Result of the ListFeatures operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - listLaunches
```
ListLaunchesResult listLaunches(ListLaunchesRequest listLaunchesRequest)
```
    Returns configuration details about all the launches in the specified project.
    
    Parameters:
    
    listLaunchesRequest -
    
    Returns:
    
    Result of the ListLaunches operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - listProjects
```
ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest)
```
    Returns configuration details about all the projects in the current Region in your account.
    
    Parameters:
    
    listProjectsRequest -
    
    Returns:
    
    Result of the ListProjects operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Displays the tags associated with an Evidently resource.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    See Also:
    
    AWS API Documentation
  - putProjectEvents
```
PutProjectEventsResult putProjectEvents(PutProjectEventsRequest putProjectEventsRequest)
```
    Sends performance events to Evidently. These events can be used to evaluate a launch or an experiment.
    
    Parameters:
    
    putProjectEventsRequest -
    
    Returns:
    
    Result of the PutProjectEvents operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - startExperiment
```
StartExperimentResult startExperiment(StartExperimentRequest startExperimentRequest)
```
    Starts an existing experiment. To create an experiment, use CreateExperiment.
    
    Parameters:
    
    startExperimentRequest -
    
    Returns:
    
    Result of the StartExperiment operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - startLaunch
```
StartLaunchResult startLaunch(StartLaunchRequest startLaunchRequest)
```
    Starts an existing launch. To create a launch, use CreateLaunch.
    
    Parameters:
    
    startLaunchRequest -
    
    Returns:
    
    Result of the StartLaunch operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - stopExperiment
```
StopExperimentResult stopExperiment(StopExperimentRequest stopExperimentRequest)
```
    Stops an experiment that is currently running. If you stop an experiment, you can't resume it or restart it.
    
    Parameters:
    
    stopExperimentRequest -
    
    Returns:
    
    Result of the StopExperiment operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - stopLaunch
```
StopLaunchResult stopLaunch(StopLaunchRequest stopLaunchRequest)
```
    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.
    
    Parameters:
    
    stopLaunchRequest -
    
    Returns:
    
    Result of the StopLaunch operation returned by the service.
    
    Throws:
    
    ThrottlingException - The request was denied because of request throttling. Retry the request.
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    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.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes one or more tags from the specified resource.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    See Also:
    
    AWS API Documentation
  - updateExperiment
```
UpdateExperimentResult updateExperiment(UpdateExperimentRequest updateExperimentRequest)
```
    Updates an Evidently experiment.
    
    Don't use this operation to update an experiment's tag. Instead, use TagResource.
    
    Parameters:
    
    updateExperimentRequest -
    
    Returns:
    
    Result of the UpdateExperiment operation returned by the service.
    
    Throws:
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - updateFeature
```
UpdateFeatureResult updateFeature(UpdateFeatureRequest updateFeatureRequest)
```
    Updates an existing feature.
    
    You can't use this operation to update the tags of an existing feature. Instead, use TagResource.
    
    Parameters:
    
    updateFeatureRequest -
    
    Returns:
    
    Result of the UpdateFeature operation returned by the service.
    
    Throws:
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - updateLaunch
```
UpdateLaunchResult updateLaunch(UpdateLaunchRequest updateLaunchRequest)
```
    Updates a launch of a given feature.
    
    Don't use this operation to update the tags of an existing launch. Instead, use TagResource.
    
    Parameters:
    
    updateLaunchRequest -
    
    Returns:
    
    Result of the UpdateLaunch operation returned by the service.
    
    Throws:
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - updateProject
```
UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest)
```
    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.
    
    Parameters:
    
    updateProjectRequest -
    
    Returns:
    
    Result of the UpdateProject operation returned by the service.
    
    Throws:
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - updateProjectDataDelivery
```
UpdateProjectDataDeliveryResult updateProjectDataDelivery(UpdateProjectDataDeliveryRequest updateProjectDataDeliveryRequest)
```
    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.
    
    Parameters:
    
    updateProjectDataDeliveryRequest -
    
    Returns:
    
    Result of the UpdateProjectDataDelivery operation returned by the service.
    
    Throws:
    
    ValidationException - The value of a parameter in the request caused an error.
    
    ConflictException - A resource was in an inconsistent state during an update or a deletion.
    
    ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
    
    ResourceNotFoundException - The request references a resource that does not exist.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonCloudWatchEvidently

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

batchEvaluateFeature

createExperiment

createFeature

createLaunch

createProject

deleteExperiment

deleteFeature

deleteLaunch

deleteProject

evaluateFeature

getExperiment

getExperimentResults

getFeature

getLaunch

getProject

listExperiments

listFeatures

listLaunches

listProjects

listTagsForResource

putProjectEvents

startExperiment

startLaunch

stopExperiment

stopLaunch

tagResource

untagResource

updateExperiment

updateFeature

updateLaunch

updateProject

updateProjectDataDelivery

shutdown

getCachedResponseMetadata