AmazonCloudWatchEvidentlyClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.cloudwatchevidently.AmazonCloudWatchEvidentlyClient

All Implemented Interfaces:

AmazonCloudWatchEvidently

Direct Known Subclasses:

AmazonCloudWatchEvidentlyAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonCloudWatchEvidentlyClient
extends AmazonWebServiceClient
implements AmazonCloudWatchEvidently
```
Client for accessing Amazon CloudWatch Evidently. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.cloudwatchevidently.AmazonCloudWatchEvidently
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchEvaluateFeatureResult`	`batchEvaluateFeature(BatchEvaluateFeatureRequest request)` This operation assigns feature variation to user sessions.
`static AmazonCloudWatchEvidentlyClientBuilder`	`builder()`
`CreateExperimentResult`	`createExperiment(CreateExperimentRequest request)` Creates an Evidently experiment.
`CreateFeatureResult`	`createFeature(CreateFeatureRequest request)` Creates an Evidently feature that you want to launch or test.
`CreateLaunchResult`	`createLaunch(CreateLaunchRequest request)` Creates a launch of a given feature.
`CreateProjectResult`	`createProject(CreateProjectRequest request)` Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments.
`CreateSegmentResult`	`createSegment(CreateSegmentRequest request)` Use this operation to define a segment of your audience.
`DeleteExperimentResult`	`deleteExperiment(DeleteExperimentRequest request)` Deletes an Evidently experiment.
`DeleteFeatureResult`	`deleteFeature(DeleteFeatureRequest request)` Deletes an Evidently feature.
`DeleteLaunchResult`	`deleteLaunch(DeleteLaunchRequest request)` Deletes an Evidently launch.
`DeleteProjectResult`	`deleteProject(DeleteProjectRequest request)` Deletes an Evidently project.
`DeleteSegmentResult`	`deleteSegment(DeleteSegmentRequest request)` Deletes a segment.
`EvaluateFeatureResult`	`evaluateFeature(EvaluateFeatureRequest request)` 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 request)` Returns the details about one experiment.
`GetExperimentResultsResult`	`getExperimentResults(GetExperimentResultsRequest request)` Retrieves the results of a running or completed experiment.
`GetFeatureResult`	`getFeature(GetFeatureRequest request)` Returns the details about one feature.
`GetLaunchResult`	`getLaunch(GetLaunchRequest request)` Returns the details about one launch.
`GetProjectResult`	`getProject(GetProjectRequest request)` Returns the details about one launch.
`GetSegmentResult`	`getSegment(GetSegmentRequest request)` Returns information about the specified segment.
`ListExperimentsResult`	`listExperiments(ListExperimentsRequest request)` Returns configuration details about all the experiments in the specified project.
`ListFeaturesResult`	`listFeatures(ListFeaturesRequest request)` Returns configuration details about all the features in the specified project.
`ListLaunchesResult`	`listLaunches(ListLaunchesRequest request)` Returns configuration details about all the launches in the specified project.
`ListProjectsResult`	`listProjects(ListProjectsRequest request)` Returns configuration details about all the projects in the current Region in your account.
`ListSegmentReferencesResult`	`listSegmentReferences(ListSegmentReferencesRequest request)` Use this operation to find which experiments or launches are using a specified segment.
`ListSegmentsResult`	`listSegments(ListSegmentsRequest request)` Returns a list of audience segments that you have created in your account in this Region.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Displays the tags associated with an Evidently resource.
`PutProjectEventsResult`	`putProjectEvents(PutProjectEventsRequest request)` Sends performance events to Evidently.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartExperimentResult`	`startExperiment(StartExperimentRequest request)` Starts an existing experiment.
`StartLaunchResult`	`startLaunch(StartLaunchRequest request)` Starts an existing launch.
`StopExperimentResult`	`stopExperiment(StopExperimentRequest request)` Stops an experiment that is currently running.
`StopLaunchResult`	`stopLaunch(StopLaunchRequest request)` Stops a launch that is currently running.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource.
`TestSegmentPatternResult`	`testSegmentPattern(TestSegmentPatternRequest request)` Use this operation to test a rules pattern that you plan to use to create an audience segment.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes one or more tags from the specified resource.
`UpdateExperimentResult`	`updateExperiment(UpdateExperimentRequest request)` Updates an Evidently experiment.
`UpdateFeatureResult`	`updateFeature(UpdateFeatureRequest request)` Updates an existing feature.
`UpdateLaunchResult`	`updateLaunch(UpdateLaunchRequest request)` Updates a launch of a given feature.
`UpdateProjectResult`	`updateProject(UpdateProjectRequest request)` Updates the description of an existing project.
`UpdateProjectDataDeliveryResult`	`updateProjectDataDelivery(UpdateProjectDataDeliveryRequest request)` Updates the data storage options for this project.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AmazonCloudWatchEvidentlyClientBuilder builder()
```
  - batchEvaluateFeature
```
public BatchEvaluateFeatureResult batchEvaluateFeature(BatchEvaluateFeatureRequest request)
```
    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.
    
    Specified by:
    
    batchEvaluateFeature in interface AmazonCloudWatchEvidently
    
    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
```
public CreateExperimentResult createExperiment(CreateExperimentRequest request)
```
    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.
    
    Specified by:
    
    createExperiment in interface AmazonCloudWatchEvidently
    
    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
```
public CreateFeatureResult createFeature(CreateFeatureRequest request)
```
    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.
    
    Specified by:
    
    createFeature in interface AmazonCloudWatchEvidently
    
    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
```
public CreateLaunchResult createLaunch(CreateLaunchRequest request)
```
    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.
    
    Specified by:
    
    createLaunch in interface AmazonCloudWatchEvidently
    
    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
```
public CreateProjectResult createProject(CreateProjectRequest request)
```
    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.
    
    Specified by:
    
    createProject in interface AmazonCloudWatchEvidently
    
    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
  - createSegment
```
public CreateSegmentResult createSegment(CreateSegmentRequest request)
```
    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.
    
    Specified by:
    
    createSegment in interface AmazonCloudWatchEvidently
    
    Parameters:
    
    createSegmentRequest -
    
    Returns:
    
    Result of the CreateSegment 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
```
public DeleteExperimentResult deleteExperiment(DeleteExperimentRequest request)
```
    Deletes an Evidently experiment. The feature used for the experiment is not deleted.
    
    To stop an experiment without deleting it, use StopExperiment.
    
    Specified by:
    
    deleteExperiment in interface AmazonCloudWatchEvidently
    
    Parameters:
    
    deleteExperimentRequest -
    
    Returns:
    
    Result of the DeleteExperiment operation returned by the service.
    
    Throws:
    
    ValidationException - The value of a parameter in the request caused an error.
    
    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
```
public DeleteFeatureResult deleteFeature(DeleteFeatureRequest request)
```
    Deletes an Evidently feature.
    
    Specified by:
    
    deleteFeature in interface AmazonCloudWatchEvidently
    
    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
```
public DeleteLaunchResult deleteLaunch(DeleteLaunchRequest request)
```
    Deletes an Evidently launch. The feature used for the launch is not deleted.
    
    To stop a launch without deleting it, use StopLaunch.
    
    Specified by:
    
    deleteLaunch in interface AmazonCloudWatchEvidently
    
    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
```
public DeleteProjectResult deleteProject(DeleteProjectRequest request)
```
    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.
    
    Specified by:
    
    deleteProject in interface AmazonCloudWatchEvidently
    
    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
  - deleteSegment
```
public DeleteSegmentResult deleteSegment(DeleteSegmentRequest request)
```
    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.
    
    Specified by:
    
    deleteSegment in interface AmazonCloudWatchEvidently
    
    Parameters:
    
    deleteSegmentRequest -
    
    Returns:
    
    Result of the DeleteSegment 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
```
public EvaluateFeatureResult evaluateFeature(EvaluateFeatureRequest request)
```
    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.
    
    Specified by:
    
    evaluateFeature in interface AmazonCloudWatchEvidently
    
    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
```
public GetExperimentResult getExperiment(GetExperimentRequest request)
```
    Returns the details about one experiment. You must already know the experiment name. To retrieve a list of experiments in your account, use ListExperiments.
    
    Specified by:
    
    getExperiment in interface AmazonCloudWatchEvidently
    
    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.
    
    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
  - getExperimentResults
```
public GetExperimentResultsResult getExperimentResults(GetExperimentResultsRequest request)
```
    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.
    
    Specified by:
    
    getExperimentResults in interface AmazonCloudWatchEvidently
    
    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
```
public GetFeatureResult getFeature(GetFeatureRequest request)
```
    Returns the details about one feature. You must already know the feature name. To retrieve a list of features in your account, use ListFeatures.
    
    Specified by:
    
    getFeature in interface AmazonCloudWatchEvidently
    
    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
```
public GetLaunchResult getLaunch(GetLaunchRequest request)
```
    Returns the details about one launch. You must already know the launch name. To retrieve a list of launches in your account, use ListLaunches.
    
    Specified by:
    
    getLaunch in interface AmazonCloudWatchEvidently
    
    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.
    
    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
  - getProject
```
public GetProjectResult getProject(GetProjectRequest request)
```
    Returns the details about one launch. You must already know the project name. To retrieve a list of projects in your account, use ListProjects.
    
    Specified by:
    
    getProject in interface AmazonCloudWatchEvidently
    
    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
  - getSegment
```
public GetSegmentResult getSegment(GetSegmentRequest request)
```
    Returns information about the specified segment. Specify the segment you want to view by specifying its ARN.
    
    Specified by:
    
    getSegment in interface AmazonCloudWatchEvidently
    
    Parameters:
    
    getSegmentRequest -
    
    Returns:
    
    Result of the GetSegment 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
```
public ListExperimentsResult listExperiments(ListExperimentsRequest request)
```
    Returns configuration details about all the experiments in the specified project.
    
    Specified by:
    
    listExperiments in interface AmazonCloudWatchEvidently
    
    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.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action.
    
    See Also:
    
    AWS API Documentation
  - listFeatures
```
public ListFeaturesResult listFeatures(ListFeaturesRequest request)
```
    Returns configuration details about all the features in the specified project.
    
    Specified by:
    
    listFeatures in interface AmazonCloudWatchEvidently
    
    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
```
public ListLaunchesResult listLaunches(ListLaunchesRequest request)
```
    Returns configuration details about all the launches in the specified project.
    
    Specified by:
    
    listLaunches in interface AmazonCloudWatchEvidently
    
    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
```
public ListProjectsResult listProjects(ListProjectsRequest request)
```
    Returns configuration details about all the projects in the current Region in your account.
    
    Specified by:
    
    listProjects in interface AmazonCloudWatchEvidently
    
    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
  - listSegmentReferences
```
public ListSegmentReferencesResult listSegmentReferences(ListSegmentReferencesRequest request)
```
    Use this operation to find which experiments or launches are using a specified segment.
    
    Specified by:
    
    listSegmentReferences in interface AmazonCloudWatchEvidently
    
    Parameters:
    
    listSegmentReferencesRequest -
    
    Returns:
    
    Result of the ListSegmentReferences 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
  - listSegments
```
public ListSegmentsResult listSegments(ListSegmentsRequest request)
```
    Returns a list of audience segments that you have created in your account in this Region.
    
    Specified by:
    
    listSegments in interface AmazonCloudWatchEvidently
    
    Parameters:
    
    listSegmentsRequest -
    
    Returns:
    
    Result of the ListSegments 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
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Displays the tags associated with an Evidently resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonCloudWatchEvidently
    
    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
```
public PutProjectEventsResult putProjectEvents(PutProjectEventsRequest request)
```
    Sends performance events to Evidently. These events can be used to evaluate a launch or an experiment.
    
    Specified by:
    
    putProjectEvents in interface AmazonCloudWatchEvidently
    
    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
```
public StartExperimentResult startExperiment(StartExperimentRequest request)
```
    Starts an existing experiment. To create an experiment, use CreateExperiment.
    
    Specified by:
    
    startExperiment in interface AmazonCloudWatchEvidently
    
    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
```
public StartLaunchResult startLaunch(StartLaunchRequest request)
```
    Starts an existing launch. To create a launch, use CreateLaunch.
    
    Specified by:
    
    startLaunch in interface AmazonCloudWatchEvidently
    
    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.
    
    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
  - stopExperiment
```
public StopExperimentResult stopExperiment(StopExperimentRequest request)
```
    Stops an experiment that is currently running. If you stop an experiment, you can't resume it or restart it.
    
    Specified by:
    
    stopExperiment in interface AmazonCloudWatchEvidently
    
    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
```
public StopLaunchResult stopLaunch(StopLaunchRequest request)
```
    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.
    
    Specified by:
    
    stopLaunch in interface AmazonCloudWatchEvidently
    
    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
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    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.
    
    Specified by:
    
    tagResource in interface AmazonCloudWatchEvidently
    
    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
  - testSegmentPattern
```
public TestSegmentPatternResult testSegmentPattern(TestSegmentPatternRequest request)
```
    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.
    
    Specified by:
    
    testSegmentPattern in interface AmazonCloudWatchEvidently
    
    Parameters:
    
    testSegmentPatternRequest -
    
    Returns:
    
    Result of the TestSegmentPattern 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
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes one or more tags from the specified resource.
    
    Specified by:
    
    untagResource in interface AmazonCloudWatchEvidently
    
    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
```
public UpdateExperimentResult updateExperiment(UpdateExperimentRequest request)
```
    Updates an Evidently experiment.
    
    Don't use this operation to update an experiment's tag. Instead, use TagResource.
    
    Specified by:
    
    updateExperiment in interface AmazonCloudWatchEvidently
    
    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
```
public UpdateFeatureResult updateFeature(UpdateFeatureRequest request)
```
    Updates an existing feature.
    
    You can't use this operation to update the tags of an existing feature. Instead, use TagResource.
    
    Specified by:
    
    updateFeature in interface AmazonCloudWatchEvidently
    
    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
```
public UpdateLaunchResult updateLaunch(UpdateLaunchRequest request)
```
    Updates a launch of a given feature.
    
    Don't use this operation to update the tags of an existing launch. Instead, use TagResource.
    
    Specified by:
    
    updateLaunch in interface AmazonCloudWatchEvidently
    
    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
```
public UpdateProjectResult updateProject(UpdateProjectRequest request)
```
    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.
    
    Specified by:
    
    updateProject in interface AmazonCloudWatchEvidently
    
    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.
    
    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
  - updateProjectDataDelivery
```
public UpdateProjectDataDeliveryResult updateProjectDataDelivery(UpdateProjectDataDeliveryRequest request)
```
    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.
    
    Specified by:
    
    updateProjectDataDelivery in interface AmazonCloudWatchEvidently
    
    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
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonCloudWatchEvidently
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonCloudWatchEvidently
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AmazonCloudWatchEvidentlyClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.cloudwatchevidently.AmazonCloudWatchEvidently

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

batchEvaluateFeature

createExperiment

createFeature

createLaunch

createProject

createSegment

deleteExperiment

deleteFeature

deleteLaunch

deleteProject

deleteSegment

evaluateFeature

getExperiment

getExperimentResults

getFeature

getLaunch

getProject

getSegment

listExperiments

listFeatures

listLaunches

listProjects

listSegmentReferences

listSegments

listTagsForResource

putProjectEvents

startExperiment

startLaunch

stopExperiment

stopLaunch

tagResource

testSegmentPattern

untagResource

updateExperiment

updateFeature

updateLaunch

updateProject

updateProjectDataDelivery

getCachedResponseMetadata

shutdown