Interface EvidentlyClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface EvidentlyClient
extends AwsClient

Service client for accessing Amazon CloudWatch Evidently. This can be created using the static builder() method.

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	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default BatchEvaluateFeatureResponse	batchEvaluateFeature(Consumer<BatchEvaluateFeatureRequest.Builder> batchEvaluateFeatureRequest)	This operation assigns feature variation to user sessions.
default BatchEvaluateFeatureResponse	batchEvaluateFeature(BatchEvaluateFeatureRequest batchEvaluateFeatureRequest)	This operation assigns feature variation to user sessions.
static EvidentlyClientBuilder	builder()	Create a builder that can be used to configure and create a EvidentlyClient.
static EvidentlyClient	create()	Create a EvidentlyClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateExperimentResponse	createExperiment(Consumer<CreateExperimentRequest.Builder> createExperimentRequest)	Creates an Evidently experiment.
default CreateExperimentResponse	createExperiment(CreateExperimentRequest createExperimentRequest)	Creates an Evidently experiment.
default CreateFeatureResponse	createFeature(Consumer<CreateFeatureRequest.Builder> createFeatureRequest)	Creates an Evidently feature that you want to launch or test.
default CreateFeatureResponse	createFeature(CreateFeatureRequest createFeatureRequest)	Creates an Evidently feature that you want to launch or test.
default CreateLaunchResponse	createLaunch(Consumer<CreateLaunchRequest.Builder> createLaunchRequest)	Creates a launch of a given feature.
default CreateLaunchResponse	createLaunch(CreateLaunchRequest createLaunchRequest)	Creates a launch of a given feature.
default CreateProjectResponse	createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)	Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments.
default CreateProjectResponse	createProject(CreateProjectRequest createProjectRequest)	Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments.
default CreateSegmentResponse	createSegment(Consumer<CreateSegmentRequest.Builder> createSegmentRequest)	Use this operation to define a segment of your audience.
default CreateSegmentResponse	createSegment(CreateSegmentRequest createSegmentRequest)	Use this operation to define a segment of your audience.
default DeleteExperimentResponse	deleteExperiment(Consumer<DeleteExperimentRequest.Builder> deleteExperimentRequest)	Deletes an Evidently experiment.
default DeleteExperimentResponse	deleteExperiment(DeleteExperimentRequest deleteExperimentRequest)	Deletes an Evidently experiment.
default DeleteFeatureResponse	deleteFeature(Consumer<DeleteFeatureRequest.Builder> deleteFeatureRequest)	Deletes an Evidently feature.
default DeleteFeatureResponse	deleteFeature(DeleteFeatureRequest deleteFeatureRequest)	Deletes an Evidently feature.
default DeleteLaunchResponse	deleteLaunch(Consumer<DeleteLaunchRequest.Builder> deleteLaunchRequest)	Deletes an Evidently launch.
default DeleteLaunchResponse	deleteLaunch(DeleteLaunchRequest deleteLaunchRequest)	Deletes an Evidently launch.
default DeleteProjectResponse	deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)	Deletes an Evidently project.
default DeleteProjectResponse	deleteProject(DeleteProjectRequest deleteProjectRequest)	Deletes an Evidently project.
default DeleteSegmentResponse	deleteSegment(Consumer<DeleteSegmentRequest.Builder> deleteSegmentRequest)	Deletes a segment.
default DeleteSegmentResponse	deleteSegment(DeleteSegmentRequest deleteSegmentRequest)	Deletes a segment.
default EvaluateFeatureResponse	evaluateFeature(Consumer<EvaluateFeatureRequest.Builder> evaluateFeatureRequest)	This operation assigns a feature variation to one given user session.
default EvaluateFeatureResponse	evaluateFeature(EvaluateFeatureRequest evaluateFeatureRequest)	This operation assigns a feature variation to one given user session.
default GetExperimentResponse	getExperiment(Consumer<GetExperimentRequest.Builder> getExperimentRequest)	Returns the details about one experiment.
default GetExperimentResponse	getExperiment(GetExperimentRequest getExperimentRequest)	Returns the details about one experiment.
default GetExperimentResultsResponse	getExperimentResults(Consumer<GetExperimentResultsRequest.Builder> getExperimentResultsRequest)	Retrieves the results of a running or completed experiment.
default GetExperimentResultsResponse	getExperimentResults(GetExperimentResultsRequest getExperimentResultsRequest)	Retrieves the results of a running or completed experiment.
default GetFeatureResponse	getFeature(Consumer<GetFeatureRequest.Builder> getFeatureRequest)	Returns the details about one feature.
default GetFeatureResponse	getFeature(GetFeatureRequest getFeatureRequest)	Returns the details about one feature.
default GetLaunchResponse	getLaunch(Consumer<GetLaunchRequest.Builder> getLaunchRequest)	Returns the details about one launch.
default GetLaunchResponse	getLaunch(GetLaunchRequest getLaunchRequest)	Returns the details about one launch.
default GetProjectResponse	getProject(Consumer<GetProjectRequest.Builder> getProjectRequest)	Returns the details about one launch.
default GetProjectResponse	getProject(GetProjectRequest getProjectRequest)	Returns the details about one launch.
default GetSegmentResponse	getSegment(Consumer<GetSegmentRequest.Builder> getSegmentRequest)	Returns information about the specified segment.
default GetSegmentResponse	getSegment(GetSegmentRequest getSegmentRequest)	Returns information about the specified segment.
default ListExperimentsResponse	listExperiments(Consumer<ListExperimentsRequest.Builder> listExperimentsRequest)	Returns configuration details about all the experiments in the specified project.
default ListExperimentsResponse	listExperiments(ListExperimentsRequest listExperimentsRequest)	Returns configuration details about all the experiments in the specified project.
default ListExperimentsIterable	listExperimentsPaginator(Consumer<ListExperimentsRequest.Builder> listExperimentsRequest)	This is a variant of listExperiments(software.amazon.awssdk.services.evidently.model.ListExperimentsRequest) operation.
default ListExperimentsIterable	listExperimentsPaginator(ListExperimentsRequest listExperimentsRequest)	This is a variant of listExperiments(software.amazon.awssdk.services.evidently.model.ListExperimentsRequest) operation.
default ListFeaturesResponse	listFeatures(Consumer<ListFeaturesRequest.Builder> listFeaturesRequest)	Returns configuration details about all the features in the specified project.
default ListFeaturesResponse	listFeatures(ListFeaturesRequest listFeaturesRequest)	Returns configuration details about all the features in the specified project.
default ListFeaturesIterable	listFeaturesPaginator(Consumer<ListFeaturesRequest.Builder> listFeaturesRequest)	This is a variant of listFeatures(software.amazon.awssdk.services.evidently.model.ListFeaturesRequest) operation.
default ListFeaturesIterable	listFeaturesPaginator(ListFeaturesRequest listFeaturesRequest)	This is a variant of listFeatures(software.amazon.awssdk.services.evidently.model.ListFeaturesRequest) operation.
default ListLaunchesResponse	listLaunches(Consumer<ListLaunchesRequest.Builder> listLaunchesRequest)	Returns configuration details about all the launches in the specified project.
default ListLaunchesResponse	listLaunches(ListLaunchesRequest listLaunchesRequest)	Returns configuration details about all the launches in the specified project.
default ListLaunchesIterable	listLaunchesPaginator(Consumer<ListLaunchesRequest.Builder> listLaunchesRequest)	This is a variant of listLaunches(software.amazon.awssdk.services.evidently.model.ListLaunchesRequest) operation.
default ListLaunchesIterable	listLaunchesPaginator(ListLaunchesRequest listLaunchesRequest)	This is a variant of listLaunches(software.amazon.awssdk.services.evidently.model.ListLaunchesRequest) operation.
default ListProjectsResponse	listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)	Returns configuration details about all the projects in the current Region in your account.
default ListProjectsResponse	listProjects(ListProjectsRequest listProjectsRequest)	Returns configuration details about all the projects in the current Region in your account.
default ListProjectsIterable	listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest)	This is a variant of listProjects(software.amazon.awssdk.services.evidently.model.ListProjectsRequest) operation.
default ListProjectsIterable	listProjectsPaginator(ListProjectsRequest listProjectsRequest)	This is a variant of listProjects(software.amazon.awssdk.services.evidently.model.ListProjectsRequest) operation.
default ListSegmentReferencesResponse	listSegmentReferences(Consumer<ListSegmentReferencesRequest.Builder> listSegmentReferencesRequest)	Use this operation to find which experiments or launches are using a specified segment.
default ListSegmentReferencesResponse	listSegmentReferences(ListSegmentReferencesRequest listSegmentReferencesRequest)	Use this operation to find which experiments or launches are using a specified segment.
default ListSegmentReferencesIterable	listSegmentReferencesPaginator(Consumer<ListSegmentReferencesRequest.Builder> listSegmentReferencesRequest)	This is a variant of listSegmentReferences(software.amazon.awssdk.services.evidently.model.ListSegmentReferencesRequest) operation.
default ListSegmentReferencesIterable	listSegmentReferencesPaginator(ListSegmentReferencesRequest listSegmentReferencesRequest)	This is a variant of listSegmentReferences(software.amazon.awssdk.services.evidently.model.ListSegmentReferencesRequest) operation.
default ListSegmentsResponse	listSegments(Consumer<ListSegmentsRequest.Builder> listSegmentsRequest)	Returns a list of audience segments that you have created in your account in this Region.
default ListSegmentsResponse	listSegments(ListSegmentsRequest listSegmentsRequest)	Returns a list of audience segments that you have created in your account in this Region.
default ListSegmentsIterable	listSegmentsPaginator(Consumer<ListSegmentsRequest.Builder> listSegmentsRequest)	This is a variant of listSegments(software.amazon.awssdk.services.evidently.model.ListSegmentsRequest) operation.
default ListSegmentsIterable	listSegmentsPaginator(ListSegmentsRequest listSegmentsRequest)	This is a variant of listSegments(software.amazon.awssdk.services.evidently.model.ListSegmentsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Displays the tags associated with an Evidently resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Displays the tags associated with an Evidently resource.
default PutProjectEventsResponse	putProjectEvents(Consumer<PutProjectEventsRequest.Builder> putProjectEventsRequest)	Sends performance events to Evidently.
default PutProjectEventsResponse	putProjectEvents(PutProjectEventsRequest putProjectEventsRequest)	Sends performance events to Evidently.
default EvidentlyServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartExperimentResponse	startExperiment(Consumer<StartExperimentRequest.Builder> startExperimentRequest)	Starts an existing experiment.
default StartExperimentResponse	startExperiment(StartExperimentRequest startExperimentRequest)	Starts an existing experiment.
default StartLaunchResponse	startLaunch(Consumer<StartLaunchRequest.Builder> startLaunchRequest)	Starts an existing launch.
default StartLaunchResponse	startLaunch(StartLaunchRequest startLaunchRequest)	Starts an existing launch.
default StopExperimentResponse	stopExperiment(Consumer<StopExperimentRequest.Builder> stopExperimentRequest)	Stops an experiment that is currently running.
default StopExperimentResponse	stopExperiment(StopExperimentRequest stopExperimentRequest)	Stops an experiment that is currently running.
default StopLaunchResponse	stopLaunch(Consumer<StopLaunchRequest.Builder> stopLaunchRequest)	Stops a launch that is currently running.
default StopLaunchResponse	stopLaunch(StopLaunchRequest stopLaunchRequest)	Stops a launch that is currently running.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource.
default TestSegmentPatternResponse	testSegmentPattern(Consumer<TestSegmentPatternRequest.Builder> testSegmentPatternRequest)	Use this operation to test a rules pattern that you plan to use to create an audience segment.
default TestSegmentPatternResponse	testSegmentPattern(TestSegmentPatternRequest testSegmentPatternRequest)	Use this operation to test a rules pattern that you plan to use to create an audience segment.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes one or more tags from the specified resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes one or more tags from the specified resource.
default UpdateExperimentResponse	updateExperiment(Consumer<UpdateExperimentRequest.Builder> updateExperimentRequest)	Updates an Evidently experiment.
default UpdateExperimentResponse	updateExperiment(UpdateExperimentRequest updateExperimentRequest)	Updates an Evidently experiment.
default UpdateFeatureResponse	updateFeature(Consumer<UpdateFeatureRequest.Builder> updateFeatureRequest)	Updates an existing feature.
default UpdateFeatureResponse	updateFeature(UpdateFeatureRequest updateFeatureRequest)	Updates an existing feature.
default UpdateLaunchResponse	updateLaunch(Consumer<UpdateLaunchRequest.Builder> updateLaunchRequest)	Updates a launch of a given feature.
default UpdateLaunchResponse	updateLaunch(UpdateLaunchRequest updateLaunchRequest)	Updates a launch of a given feature.
default UpdateProjectResponse	updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)	Updates the description of an existing project.
default UpdateProjectResponse	updateProject(UpdateProjectRequest updateProjectRequest)	Updates the description of an existing project.
default UpdateProjectDataDeliveryResponse	updateProjectDataDelivery(Consumer<UpdateProjectDataDeliveryRequest.Builder> updateProjectDataDeliveryRequest)	Updates the data storage options for this project.
default UpdateProjectDataDeliveryResponse	updateProjectDataDelivery(UpdateProjectDataDeliveryRequest updateProjectDataDeliveryRequest)	Updates the data storage options for this project.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

batchEvaluateFeature

default BatchEvaluateFeatureResponse batchEvaluateFeature(BatchEvaluateFeatureRequest batchEvaluateFeatureRequest)
                                                   throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

batchEvaluateFeature

default BatchEvaluateFeatureResponse batchEvaluateFeature(Consumer<BatchEvaluateFeatureRequest.Builder> batchEvaluateFeatureRequest)
                                                   throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

This is a convenience which creates an instance of the BatchEvaluateFeatureRequest.Builder avoiding the need to create one manually via BatchEvaluateFeatureRequest.builder()

Parameters:

batchEvaluateFeatureRequest - A Consumer that will call methods on BatchEvaluateFeatureRequest.Builder to create a request.

Returns:

Result of the BatchEvaluateFeature operation returned by the service.

See Also:

• AWS API Documentation

createExperiment

default CreateExperimentResponse createExperiment(CreateExperimentRequest createExperimentRequest)
                                           throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

Parameters:

createExperimentRequest -

Returns:

Result of the CreateExperiment operation returned by the service.

See Also:

• AWS API Documentation

createExperiment

default CreateExperimentResponse createExperiment(Consumer<CreateExperimentRequest.Builder> createExperimentRequest)
                                           throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

This is a convenience which creates an instance of the CreateExperimentRequest.Builder avoiding the need to create one manually via CreateExperimentRequest.builder()

Parameters:

createExperimentRequest - A Consumer that will call methods on CreateExperimentRequest.Builder to create a request.

Returns:

Result of the CreateExperiment operation returned by the service.

See Also:

• AWS API Documentation

createFeature

default CreateFeatureResponse createFeature(CreateFeatureRequest createFeatureRequest)
                                     throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

createFeature

default CreateFeatureResponse createFeature(Consumer<CreateFeatureRequest.Builder> createFeatureRequest)
                                     throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

This is a convenience which creates an instance of the CreateFeatureRequest.Builder avoiding the need to create one manually via CreateFeatureRequest.builder()

Parameters:

createFeatureRequest - A Consumer that will call methods on CreateFeatureRequest.Builder to create a request.

Returns:

Result of the CreateFeature operation returned by the service.

See Also:

• AWS API Documentation

createLaunch

default CreateLaunchResponse createLaunch(CreateLaunchRequest createLaunchRequest)
                                   throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

createLaunch

default CreateLaunchResponse createLaunch(Consumer<CreateLaunchRequest.Builder> createLaunchRequest)
                                   throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

This is a convenience which creates an instance of the CreateLaunchRequest.Builder avoiding the need to create one manually via CreateLaunchRequest.builder()

Parameters:

createLaunchRequest - A Consumer that will call methods on CreateLaunchRequest.Builder to create a request.

Returns:

Result of the CreateLaunch operation returned by the service.

See Also:

• AWS API Documentation

createProject

default CreateProjectResponse createProject(CreateProjectRequest createProjectRequest)
                                     throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

createProject

default CreateProjectResponse createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)
                                     throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

This is a convenience which creates an instance of the CreateProjectRequest.Builder avoiding the need to create one manually via CreateProjectRequest.builder()

Parameters:

createProjectRequest - A Consumer that will call methods on CreateProjectRequest.Builder to create a request.

Returns:

Result of the CreateProject operation returned by the service.

See Also:

• AWS API Documentation

createSegment

default CreateSegmentResponse createSegment(CreateSegmentRequest createSegmentRequest)
                                     throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

Parameters:

createSegmentRequest -

Returns:

Result of the CreateSegment operation returned by the service.

See Also:

• AWS API Documentation

createSegment

default CreateSegmentResponse createSegment(Consumer<CreateSegmentRequest.Builder> createSegmentRequest)
                                     throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

This is a convenience which creates an instance of the CreateSegmentRequest.Builder avoiding the need to create one manually via CreateSegmentRequest.builder()

Parameters:

createSegmentRequest - A Consumer that will call methods on CreateSegmentRequest.Builder to create a request.

Returns:

Result of the CreateSegment operation returned by the service.

See Also:

• AWS API Documentation

deleteExperiment

default DeleteExperimentResponse deleteExperiment(DeleteExperimentRequest deleteExperimentRequest)
                                           throws ValidationException,
InternalServerException,
ConflictException,
ServiceUnavailableException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

deleteExperiment

default DeleteExperimentResponse deleteExperiment(Consumer<DeleteExperimentRequest.Builder> deleteExperimentRequest)
                                           throws ValidationException,
InternalServerException,
ConflictException,
ServiceUnavailableException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

To stop an experiment without deleting it, use StopExperiment.

This is a convenience which creates an instance of the DeleteExperimentRequest.Builder avoiding the need to create one manually via DeleteExperimentRequest.builder()

Parameters:

deleteExperimentRequest - A Consumer that will call methods on DeleteExperimentRequest.Builder to create a request.

Returns:

Result of the DeleteExperiment operation returned by the service.

See Also:

• AWS API Documentation

deleteFeature

default DeleteFeatureResponse deleteFeature(DeleteFeatureRequest deleteFeatureRequest)
                                     throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

Deletes an Evidently feature.

Parameters:

deleteFeatureRequest -

Returns:

Result of the DeleteFeature operation returned by the service.

See Also:

• AWS API Documentation

deleteFeature

default DeleteFeatureResponse deleteFeature(Consumer<DeleteFeatureRequest.Builder> deleteFeatureRequest)
                                     throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

Deletes an Evidently feature.

This is a convenience which creates an instance of the DeleteFeatureRequest.Builder avoiding the need to create one manually via DeleteFeatureRequest.builder()

Parameters:

deleteFeatureRequest - A Consumer that will call methods on DeleteFeatureRequest.Builder to create a request.

Returns:

Result of the DeleteFeature operation returned by the service.

See Also:

• AWS API Documentation

deleteLaunch

default DeleteLaunchResponse deleteLaunch(DeleteLaunchRequest deleteLaunchRequest)
                                   throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

deleteLaunch

default DeleteLaunchResponse deleteLaunch(Consumer<DeleteLaunchRequest.Builder> deleteLaunchRequest)
                                   throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

To stop a launch without deleting it, use StopLaunch.

This is a convenience which creates an instance of the DeleteLaunchRequest.Builder avoiding the need to create one manually via DeleteLaunchRequest.builder()

Parameters:

deleteLaunchRequest - A Consumer that will call methods on DeleteLaunchRequest.Builder to create a request.

Returns:

Result of the DeleteLaunch operation returned by the service.

See Also:

• AWS API Documentation

deleteProject

default DeleteProjectResponse deleteProject(DeleteProjectRequest deleteProjectRequest)
                                     throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

deleteProject

default DeleteProjectResponse deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)
                                     throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

This is a convenience which creates an instance of the DeleteProjectRequest.Builder avoiding the need to create one manually via DeleteProjectRequest.builder()

Parameters:

deleteProjectRequest - A Consumer that will call methods on DeleteProjectRequest.Builder to create a request.

Returns:

Result of the DeleteProject operation returned by the service.

See Also:

• AWS API Documentation

deleteSegment

default DeleteSegmentResponse deleteSegment(DeleteSegmentRequest deleteSegmentRequest)
                                     throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

Parameters:

deleteSegmentRequest -

Returns:

Result of the DeleteSegment operation returned by the service.

See Also:

• AWS API Documentation

deleteSegment

default DeleteSegmentResponse deleteSegment(Consumer<DeleteSegmentRequest.Builder> deleteSegmentRequest)
                                     throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

This is a convenience which creates an instance of the DeleteSegmentRequest.Builder avoiding the need to create one manually via DeleteSegmentRequest.builder()

Parameters:

deleteSegmentRequest - A Consumer that will call methods on DeleteSegmentRequest.Builder to create a request.

Returns:

Result of the DeleteSegment operation returned by the service.

See Also:

• AWS API Documentation

evaluateFeature

default EvaluateFeatureResponse evaluateFeature(EvaluateFeatureRequest evaluateFeatureRequest)
                                         throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

Parameters:

evaluateFeatureRequest -

Returns:

Result of the EvaluateFeature operation returned by the service.

See Also:

• AWS API Documentation

evaluateFeature

default EvaluateFeatureResponse evaluateFeature(Consumer<EvaluateFeatureRequest.Builder> evaluateFeatureRequest)
                                         throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

This is a convenience which creates an instance of the EvaluateFeatureRequest.Builder avoiding the need to create one manually via EvaluateFeatureRequest.builder()

Parameters:

evaluateFeatureRequest - A Consumer that will call methods on EvaluateFeatureRequest.Builder to create a request.

Returns:

Result of the EvaluateFeature operation returned by the service.

See Also:

• AWS API Documentation

getExperiment

default GetExperimentResponse getExperiment(GetExperimentRequest getExperimentRequest)
                                     throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

getExperiment

default GetExperimentResponse getExperiment(Consumer<GetExperimentRequest.Builder> getExperimentRequest)
                                     throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

This is a convenience which creates an instance of the GetExperimentRequest.Builder avoiding the need to create one manually via GetExperimentRequest.builder()

Parameters:

getExperimentRequest - A Consumer that will call methods on GetExperimentRequest.Builder to create a request.

Returns:

Result of the GetExperiment operation returned by the service.

See Also:

• AWS API Documentation

getExperimentResults

default GetExperimentResultsResponse getExperimentResults(GetExperimentResultsRequest getExperimentResultsRequest)
                                                   throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

Parameters:

getExperimentResultsRequest -

Returns:

Result of the GetExperimentResults operation returned by the service.

See Also:

• AWS API Documentation

getExperimentResults

default GetExperimentResultsResponse getExperimentResults(Consumer<GetExperimentResultsRequest.Builder> getExperimentResultsRequest)
                                                   throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

This is a convenience which creates an instance of the GetExperimentResultsRequest.Builder avoiding the need to create one manually via GetExperimentResultsRequest.builder()

Parameters:

getExperimentResultsRequest - A Consumer that will call methods on GetExperimentResultsRequest.Builder to create a request.

Returns:

Result of the GetExperimentResults operation returned by the service.

See Also:

• AWS API Documentation

getFeature

default GetFeatureResponse getFeature(GetFeatureRequest getFeatureRequest)
                               throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

getFeature

default GetFeatureResponse getFeature(Consumer<GetFeatureRequest.Builder> getFeatureRequest)
                               throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

This is a convenience which creates an instance of the GetFeatureRequest.Builder avoiding the need to create one manually via GetFeatureRequest.builder()

Parameters:

getFeatureRequest - A Consumer that will call methods on GetFeatureRequest.Builder to create a request.

Returns:

Result of the GetFeature operation returned by the service.

See Also:

• AWS API Documentation

getLaunch

default GetLaunchResponse getLaunch(GetLaunchRequest getLaunchRequest)
                             throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

getLaunch

default GetLaunchResponse getLaunch(Consumer<GetLaunchRequest.Builder> getLaunchRequest)
                             throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

This is a convenience which creates an instance of the GetLaunchRequest.Builder avoiding the need to create one manually via GetLaunchRequest.builder()

Parameters:

getLaunchRequest - A Consumer that will call methods on GetLaunchRequest.Builder to create a request.

Returns:

Result of the GetLaunch operation returned by the service.

See Also:

• AWS API Documentation

getProject

default GetProjectResponse getProject(GetProjectRequest getProjectRequest)
                               throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

getProject

default GetProjectResponse getProject(Consumer<GetProjectRequest.Builder> getProjectRequest)
                               throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

This is a convenience which creates an instance of the GetProjectRequest.Builder avoiding the need to create one manually via GetProjectRequest.builder()

Parameters:

getProjectRequest - A Consumer that will call methods on GetProjectRequest.Builder to create a request.

Returns:

Result of the GetProject operation returned by the service.

See Also:

• AWS API Documentation

getSegment

default GetSegmentResponse getSegment(GetSegmentRequest getSegmentRequest)
                               throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

Parameters:

getSegmentRequest -

Returns:

Result of the GetSegment operation returned by the service.

See Also:

• AWS API Documentation

getSegment

default GetSegmentResponse getSegment(Consumer<GetSegmentRequest.Builder> getSegmentRequest)
                               throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

This is a convenience which creates an instance of the GetSegmentRequest.Builder avoiding the need to create one manually via GetSegmentRequest.builder()

Parameters:

getSegmentRequest - A Consumer that will call methods on GetSegmentRequest.Builder to create a request.

Returns:

Result of the GetSegment operation returned by the service.

See Also:

• AWS API Documentation

listExperiments

default ListExperimentsResponse listExperiments(ListExperimentsRequest listExperimentsRequest)
                                         throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

Parameters:

listExperimentsRequest -

Returns:

Result of the ListExperiments operation returned by the service.

See Also:

• AWS API Documentation

listExperiments

default ListExperimentsResponse listExperiments(Consumer<ListExperimentsRequest.Builder> listExperimentsRequest)
                                         throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

This is a convenience which creates an instance of the ListExperimentsRequest.Builder avoiding the need to create one manually via ListExperimentsRequest.builder()

Parameters:

listExperimentsRequest - A Consumer that will call methods on ListExperimentsRequest.Builder to create a request.

Returns:

Result of the ListExperiments operation returned by the service.

See Also:

• AWS API Documentation

listExperimentsPaginator

default ListExperimentsIterable listExperimentsPaginator(ListExperimentsRequest listExperimentsRequest)
                                                  throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

This is a variant of listExperiments(software.amazon.awssdk.services.evidently.model.ListExperimentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.evidently.paginators.ListExperimentsIterable responses = client.listExperimentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evidently.paginators.ListExperimentsIterable responses = client
             .listExperimentsPaginator(request);
     for (software.amazon.awssdk.services.evidently.model.ListExperimentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evidently.paginators.ListExperimentsIterable responses = client.listExperimentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listExperiments(software.amazon.awssdk.services.evidently.model.ListExperimentsRequest) operation.

Parameters:

listExperimentsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listExperimentsPaginator

default ListExperimentsIterable listExperimentsPaginator(Consumer<ListExperimentsRequest.Builder> listExperimentsRequest)
                                                  throws ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

This is a variant of listExperiments(software.amazon.awssdk.services.evidently.model.ListExperimentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.evidently.paginators.ListExperimentsIterable responses = client.listExperimentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evidently.paginators.ListExperimentsIterable responses = client
             .listExperimentsPaginator(request);
     for (software.amazon.awssdk.services.evidently.model.ListExperimentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evidently.paginators.ListExperimentsIterable responses = client.listExperimentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listExperiments(software.amazon.awssdk.services.evidently.model.ListExperimentsRequest) operation.

This is a convenience which creates an instance of the ListExperimentsRequest.Builder avoiding the need to create one manually via ListExperimentsRequest.builder()

Parameters:

listExperimentsRequest - A Consumer that will call methods on ListExperimentsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFeatures

default ListFeaturesResponse listFeatures(ListFeaturesRequest listFeaturesRequest)
                                   throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

Parameters:

listFeaturesRequest -

Returns:

Result of the ListFeatures operation returned by the service.

See Also:

• AWS API Documentation

listFeatures

default ListFeaturesResponse listFeatures(Consumer<ListFeaturesRequest.Builder> listFeaturesRequest)
                                   throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

This is a convenience which creates an instance of the ListFeaturesRequest.Builder avoiding the need to create one manually via ListFeaturesRequest.builder()

Parameters:

listFeaturesRequest - A Consumer that will call methods on ListFeaturesRequest.Builder to create a request.

Returns:

Result of the ListFeatures operation returned by the service.

See Also:

• AWS API Documentation

listFeaturesPaginator

default ListFeaturesIterable listFeaturesPaginator(ListFeaturesRequest listFeaturesRequest)
                                            throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

This is a variant of listFeatures(software.amazon.awssdk.services.evidently.model.ListFeaturesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.evidently.paginators.ListFeaturesIterable responses = client.listFeaturesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evidently.paginators.ListFeaturesIterable responses = client.listFeaturesPaginator(request);
     for (software.amazon.awssdk.services.evidently.model.ListFeaturesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evidently.paginators.ListFeaturesIterable responses = client.listFeaturesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listFeatures(software.amazon.awssdk.services.evidently.model.ListFeaturesRequest) operation.

Parameters:

listFeaturesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFeaturesPaginator

default ListFeaturesIterable listFeaturesPaginator(Consumer<ListFeaturesRequest.Builder> listFeaturesRequest)
                                            throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

This is a variant of listFeatures(software.amazon.awssdk.services.evidently.model.ListFeaturesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.evidently.paginators.ListFeaturesIterable responses = client.listFeaturesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evidently.paginators.ListFeaturesIterable responses = client.listFeaturesPaginator(request);
     for (software.amazon.awssdk.services.evidently.model.ListFeaturesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evidently.paginators.ListFeaturesIterable responses = client.listFeaturesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listFeatures(software.amazon.awssdk.services.evidently.model.ListFeaturesRequest) operation.

This is a convenience which creates an instance of the ListFeaturesRequest.Builder avoiding the need to create one manually via ListFeaturesRequest.builder()

Parameters:

listFeaturesRequest - A Consumer that will call methods on ListFeaturesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listLaunches

default ListLaunchesResponse listLaunches(ListLaunchesRequest listLaunchesRequest)
                                   throws ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

Parameters:

listLaunchesRequest -

Returns:

Result of the ListLaunches operation returned by the service.

See Also:

• AWS API Documentation

listLaunches

default ListLaunchesResponse listLaunches(Consumer<ListLaunchesRequest.Builder> listLaunchesRequest)
                                   throws ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

This is a convenience which creates an instance of the ListLaunchesRequest.Builder avoiding the need to create one manually via ListLaunchesRequest.builder()

Parameters:

listLaunchesRequest - A Consumer that will call methods on ListLaunchesRequest.Builder to create a request.

Returns:

Result of the ListLaunches operation returned by the service.

See Also:

• AWS API Documentation

listLaunchesPaginator

default ListLaunchesIterable listLaunchesPaginator(ListLaunchesRequest listLaunchesRequest)
                                            throws ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

This is a variant of listLaunches(software.amazon.awssdk.services.evidently.model.ListLaunchesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.evidently.paginators.ListLaunchesIterable responses = client.listLaunchesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evidently.paginators.ListLaunchesIterable responses = client.listLaunchesPaginator(request);
     for (software.amazon.awssdk.services.evidently.model.ListLaunchesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evidently.paginators.ListLaunchesIterable responses = client.listLaunchesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listLaunches(software.amazon.awssdk.services.evidently.model.ListLaunchesRequest) operation.

Parameters:

listLaunchesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listLaunchesPaginator

default ListLaunchesIterable listLaunchesPaginator(Consumer<ListLaunchesRequest.Builder> listLaunchesRequest)
                                            throws ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

This is a variant of listLaunches(software.amazon.awssdk.services.evidently.model.ListLaunchesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.evidently.paginators.ListLaunchesIterable responses = client.listLaunchesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evidently.paginators.ListLaunchesIterable responses = client.listLaunchesPaginator(request);
     for (software.amazon.awssdk.services.evidently.model.ListLaunchesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evidently.paginators.ListLaunchesIterable responses = client.listLaunchesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listLaunches(software.amazon.awssdk.services.evidently.model.ListLaunchesRequest) operation.

This is a convenience which creates an instance of the ListLaunchesRequest.Builder avoiding the need to create one manually via ListLaunchesRequest.builder()

Parameters:

listLaunchesRequest - A Consumer that will call methods on ListLaunchesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProjects

default ListProjectsResponse listProjects(ListProjectsRequest listProjectsRequest)
                                   throws ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

listProjects

default ListProjectsResponse listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
                                   throws ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

This is a convenience which creates an instance of the ListProjectsRequest.Builder avoiding the need to create one manually via ListProjectsRequest.builder()

Parameters:

listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request.

Returns:

Result of the ListProjects operation returned by the service.

See Also:

• AWS API Documentation

listProjectsPaginator

default ListProjectsIterable listProjectsPaginator(ListProjectsRequest listProjectsRequest)
                                            throws ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

This is a variant of listProjects(software.amazon.awssdk.services.evidently.model.ListProjectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.evidently.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evidently.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
     for (software.amazon.awssdk.services.evidently.model.ListProjectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evidently.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProjects(software.amazon.awssdk.services.evidently.model.ListProjectsRequest) operation.

Parameters:

listProjectsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProjectsPaginator

default ListProjectsIterable listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
                                            throws ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

This is a variant of listProjects(software.amazon.awssdk.services.evidently.model.ListProjectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.evidently.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evidently.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
     for (software.amazon.awssdk.services.evidently.model.ListProjectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evidently.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProjects(software.amazon.awssdk.services.evidently.model.ListProjectsRequest) operation.

This is a convenience which creates an instance of the ListProjectsRequest.Builder avoiding the need to create one manually via ListProjectsRequest.builder()

Parameters:

listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSegmentReferences

default ListSegmentReferencesResponse listSegmentReferences(ListSegmentReferencesRequest listSegmentReferencesRequest)
                                                     throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

Parameters:

listSegmentReferencesRequest -

Returns:

Result of the ListSegmentReferences operation returned by the service.

See Also:

• AWS API Documentation

listSegmentReferences

default ListSegmentReferencesResponse listSegmentReferences(Consumer<ListSegmentReferencesRequest.Builder> listSegmentReferencesRequest)
                                                     throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

This is a convenience which creates an instance of the ListSegmentReferencesRequest.Builder avoiding the need to create one manually via ListSegmentReferencesRequest.builder()

Parameters:

listSegmentReferencesRequest - A Consumer that will call methods on ListSegmentReferencesRequest.Builder to create a request.

Returns:

Result of the ListSegmentReferences operation returned by the service.

See Also:

• AWS API Documentation

listSegmentReferencesPaginator

default ListSegmentReferencesIterable listSegmentReferencesPaginator(ListSegmentReferencesRequest listSegmentReferencesRequest)
                                                              throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

This is a variant of listSegmentReferences(software.amazon.awssdk.services.evidently.model.ListSegmentReferencesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.evidently.paginators.ListSegmentReferencesIterable responses = client.listSegmentReferencesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evidently.paginators.ListSegmentReferencesIterable responses = client
             .listSegmentReferencesPaginator(request);
     for (software.amazon.awssdk.services.evidently.model.ListSegmentReferencesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evidently.paginators.ListSegmentReferencesIterable responses = client.listSegmentReferencesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSegmentReferences(software.amazon.awssdk.services.evidently.model.ListSegmentReferencesRequest) operation.

Parameters:

listSegmentReferencesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSegmentReferencesPaginator

default ListSegmentReferencesIterable listSegmentReferencesPaginator(Consumer<ListSegmentReferencesRequest.Builder> listSegmentReferencesRequest)
                                                              throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

This is a variant of listSegmentReferences(software.amazon.awssdk.services.evidently.model.ListSegmentReferencesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.evidently.paginators.ListSegmentReferencesIterable responses = client.listSegmentReferencesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evidently.paginators.ListSegmentReferencesIterable responses = client
             .listSegmentReferencesPaginator(request);
     for (software.amazon.awssdk.services.evidently.model.ListSegmentReferencesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evidently.paginators.ListSegmentReferencesIterable responses = client.listSegmentReferencesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSegmentReferences(software.amazon.awssdk.services.evidently.model.ListSegmentReferencesRequest) operation.

This is a convenience which creates an instance of the ListSegmentReferencesRequest.Builder avoiding the need to create one manually via ListSegmentReferencesRequest.builder()

Parameters:

listSegmentReferencesRequest - A Consumer that will call methods on ListSegmentReferencesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSegments

default ListSegmentsResponse listSegments(ListSegmentsRequest listSegmentsRequest)
                                   throws ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

Parameters:

listSegmentsRequest -

Returns:

Result of the ListSegments operation returned by the service.

See Also:

• AWS API Documentation

listSegments

default ListSegmentsResponse listSegments(Consumer<ListSegmentsRequest.Builder> listSegmentsRequest)
                                   throws ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

This is a convenience which creates an instance of the ListSegmentsRequest.Builder avoiding the need to create one manually via ListSegmentsRequest.builder()

Parameters:

listSegmentsRequest - A Consumer that will call methods on ListSegmentsRequest.Builder to create a request.

Returns:

Result of the ListSegments operation returned by the service.

See Also:

• AWS API Documentation

listSegmentsPaginator

default ListSegmentsIterable listSegmentsPaginator(ListSegmentsRequest listSegmentsRequest)
                                            throws ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

This is a variant of listSegments(software.amazon.awssdk.services.evidently.model.ListSegmentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.evidently.paginators.ListSegmentsIterable responses = client.listSegmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evidently.paginators.ListSegmentsIterable responses = client.listSegmentsPaginator(request);
     for (software.amazon.awssdk.services.evidently.model.ListSegmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evidently.paginators.ListSegmentsIterable responses = client.listSegmentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSegments(software.amazon.awssdk.services.evidently.model.ListSegmentsRequest) operation.

Parameters:

listSegmentsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSegmentsPaginator

default ListSegmentsIterable listSegmentsPaginator(Consumer<ListSegmentsRequest.Builder> listSegmentsRequest)
                                            throws ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

This is a variant of listSegments(software.amazon.awssdk.services.evidently.model.ListSegmentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.evidently.paginators.ListSegmentsIterable responses = client.listSegmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.evidently.paginators.ListSegmentsIterable responses = client.listSegmentsPaginator(request);
     for (software.amazon.awssdk.services.evidently.model.ListSegmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.evidently.paginators.ListSegmentsIterable responses = client.listSegmentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSegments(software.amazon.awssdk.services.evidently.model.ListSegmentsRequest) operation.

This is a convenience which creates an instance of the ListSegmentsRequest.Builder avoiding the need to create one manually via ListSegmentsRequest.builder()

Parameters:

listSegmentsRequest - A Consumer that will call methods on ListSegmentsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ValidationException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvidentlyException

Displays the tags associated with an Evidently resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ValidationException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvidentlyException

Displays the tags associated with an Evidently resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

putProjectEvents

default PutProjectEventsResponse putProjectEvents(PutProjectEventsRequest putProjectEventsRequest)
                                           throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

putProjectEvents

default PutProjectEventsResponse putProjectEvents(Consumer<PutProjectEventsRequest.Builder> putProjectEventsRequest)
                                           throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

This is a convenience which creates an instance of the PutProjectEventsRequest.Builder avoiding the need to create one manually via PutProjectEventsRequest.builder()

Parameters:

putProjectEventsRequest - A Consumer that will call methods on PutProjectEventsRequest.Builder to create a request.

Returns:

Result of the PutProjectEvents operation returned by the service.

See Also:

• AWS API Documentation

startExperiment

default StartExperimentResponse startExperiment(StartExperimentRequest startExperimentRequest)
                                         throws ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

Parameters:

startExperimentRequest -

Returns:

Result of the StartExperiment operation returned by the service.

See Also:

• AWS API Documentation

startExperiment

default StartExperimentResponse startExperiment(Consumer<StartExperimentRequest.Builder> startExperimentRequest)
                                         throws ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

This is a convenience which creates an instance of the StartExperimentRequest.Builder avoiding the need to create one manually via StartExperimentRequest.builder()

Parameters:

startExperimentRequest - A Consumer that will call methods on StartExperimentRequest.Builder to create a request.

Returns:

Result of the StartExperiment operation returned by the service.

See Also:

• AWS API Documentation

startLaunch

default StartLaunchResponse startLaunch(StartLaunchRequest startLaunchRequest)
                                 throws ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

Parameters:

startLaunchRequest -

Returns:

Result of the StartLaunch operation returned by the service.

See Also:

• AWS API Documentation

startLaunch

default StartLaunchResponse startLaunch(Consumer<StartLaunchRequest.Builder> startLaunchRequest)
                                 throws ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

This is a convenience which creates an instance of the StartLaunchRequest.Builder avoiding the need to create one manually via StartLaunchRequest.builder()

Parameters:

startLaunchRequest - A Consumer that will call methods on StartLaunchRequest.Builder to create a request.

Returns:

Result of the StartLaunch operation returned by the service.

See Also:

• AWS API Documentation

stopExperiment

default StopExperimentResponse stopExperiment(StopExperimentRequest stopExperimentRequest)
                                       throws ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

stopExperiment

default StopExperimentResponse stopExperiment(Consumer<StopExperimentRequest.Builder> stopExperimentRequest)
                                       throws ThrottlingException,
ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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

This is a convenience which creates an instance of the StopExperimentRequest.Builder avoiding the need to create one manually via StopExperimentRequest.builder()

Parameters:

stopExperimentRequest - A Consumer that will call methods on StopExperimentRequest.Builder to create a request.

Returns:

Result of the StopExperiment operation returned by the service.

See Also:

• AWS API Documentation

stopLaunch

default StopLaunchResponse stopLaunch(StopLaunchRequest stopLaunchRequest)
                               throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

stopLaunch

default StopLaunchResponse stopLaunch(Consumer<StopLaunchRequest.Builder> stopLaunchRequest)
                               throws ThrottlingException,
ValidationException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

This is a convenience which creates an instance of the StopLaunchRequest.Builder avoiding the need to create one manually via StopLaunchRequest.builder()

Parameters:

stopLaunchRequest - A Consumer that will call methods on StopLaunchRequest.Builder to create a request.

Returns:

Result of the StopLaunch operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ValidationException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ValidationException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

testSegmentPattern

default TestSegmentPatternResponse testSegmentPattern(TestSegmentPatternRequest testSegmentPatternRequest)
                                               throws ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

Parameters:

testSegmentPatternRequest -

Returns:

Result of the TestSegmentPattern operation returned by the service.

See Also:

• AWS API Documentation

testSegmentPattern

default TestSegmentPatternResponse testSegmentPattern(Consumer<TestSegmentPatternRequest.Builder> testSegmentPatternRequest)
                                               throws ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

This is a convenience which creates an instance of the TestSegmentPatternRequest.Builder avoiding the need to create one manually via TestSegmentPatternRequest.builder()

Parameters:

testSegmentPatternRequest - A Consumer that will call methods on TestSegmentPatternRequest.Builder to create a request.

Returns:

Result of the TestSegmentPattern operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ValidationException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvidentlyException

Removes one or more tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ValidationException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
EvidentlyException

Removes one or more tags from the specified resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateExperiment

default UpdateExperimentResponse updateExperiment(UpdateExperimentRequest updateExperimentRequest)
                                           throws ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

updateExperiment

default UpdateExperimentResponse updateExperiment(Consumer<UpdateExperimentRequest.Builder> updateExperimentRequest)
                                           throws ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

Updates an Evidently experiment.

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

This is a convenience which creates an instance of the UpdateExperimentRequest.Builder avoiding the need to create one manually via UpdateExperimentRequest.builder()

Parameters:

updateExperimentRequest - A Consumer that will call methods on UpdateExperimentRequest.Builder to create a request.

Returns:

Result of the UpdateExperiment operation returned by the service.

See Also:

• AWS API Documentation

updateFeature

default UpdateFeatureResponse updateFeature(UpdateFeatureRequest updateFeatureRequest)
                                     throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

updateFeature

default UpdateFeatureResponse updateFeature(Consumer<UpdateFeatureRequest.Builder> updateFeatureRequest)
                                     throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

Updates an existing feature.

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

This is a convenience which creates an instance of the UpdateFeatureRequest.Builder avoiding the need to create one manually via UpdateFeatureRequest.builder()

Parameters:

updateFeatureRequest - A Consumer that will call methods on UpdateFeatureRequest.Builder to create a request.

Returns:

Result of the UpdateFeature operation returned by the service.

See Also:

• AWS API Documentation

updateLaunch

default UpdateLaunchResponse updateLaunch(UpdateLaunchRequest updateLaunchRequest)
                                   throws ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

updateLaunch

default UpdateLaunchResponse updateLaunch(Consumer<UpdateLaunchRequest.Builder> updateLaunchRequest)
                                   throws ValidationException,
ConflictException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

Updates a launch of a given feature.

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

This is a convenience which creates an instance of the UpdateLaunchRequest.Builder avoiding the need to create one manually via UpdateLaunchRequest.builder()

Parameters:

updateLaunchRequest - A Consumer that will call methods on UpdateLaunchRequest.Builder to create a request.

Returns:

Result of the UpdateLaunch operation returned by the service.

See Also:

• AWS API Documentation

updateProject

default UpdateProjectResponse updateProject(UpdateProjectRequest updateProjectRequest)
                                     throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

updateProject

default UpdateProjectResponse updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)
                                     throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

This is a convenience which creates an instance of the UpdateProjectRequest.Builder avoiding the need to create one manually via UpdateProjectRequest.builder()

Parameters:

updateProjectRequest - A Consumer that will call methods on UpdateProjectRequest.Builder to create a request.

Returns:

Result of the UpdateProject operation returned by the service.

See Also:

• AWS API Documentation

updateProjectDataDelivery

default UpdateProjectDataDeliveryResponse updateProjectDataDelivery(UpdateProjectDataDeliveryRequest updateProjectDataDeliveryRequest)
                                                             throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

See Also:

• AWS API Documentation

updateProjectDataDelivery

default UpdateProjectDataDeliveryResponse updateProjectDataDelivery(Consumer<UpdateProjectDataDeliveryRequest.Builder> updateProjectDataDeliveryRequest)
                                                             throws ValidationException,
ConflictException,
ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
EvidentlyException

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.

This is a convenience which creates an instance of the UpdateProjectDataDeliveryRequest.Builder avoiding the need to create one manually via UpdateProjectDataDeliveryRequest.builder()

Parameters:

updateProjectDataDeliveryRequest - A Consumer that will call methods on UpdateProjectDataDeliveryRequest.Builder to create a request.

Returns:

Result of the UpdateProjectDataDelivery operation returned by the service.

See Also:

• AWS API Documentation

create

static EvidentlyClient create()

Create a EvidentlyClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static EvidentlyClientBuilder builder()

Create a builder that can be used to configure and create a EvidentlyClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default EvidentlyServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration