CloudWatchEvidentlyClient#
Index > CloudWatchEvidently > CloudWatchEvidentlyClient
Auto-generated documentation for CloudWatchEvidently type annotations stubs module mypy-boto3-evidently.
CloudWatchEvidentlyClient#
Type annotations and code completion for boto3.client("evidently")
.
boto3 documentation
# CloudWatchEvidentlyClient usage example
from boto3.session import Session
from mypy_boto3_evidently.client import CloudWatchEvidentlyClient
def get_evidently_client() -> CloudWatchEvidentlyClient:
return Session().client("evidently")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("evidently").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("evidently")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ServiceUnavailableException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_evidently.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
batch_evaluate_feature#
This operation assigns feature variation to user sessions.
Type annotations and code completion for boto3.client("evidently").batch_evaluate_feature
method.
boto3 documentation
# batch_evaluate_feature method definition
def batch_evaluate_feature(
self,
*,
project: str,
requests: Sequence[EvaluationRequestTypeDef], # (1)
) -> BatchEvaluateFeatureResponseTypeDef: # (2)
...
# batch_evaluate_feature method usage example with argument unpacking
kwargs: BatchEvaluateFeatureRequestRequestTypeDef = { # (1)
"project": ...,
"requests": ...,
}
parent.batch_evaluate_feature(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("evidently").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("evidently").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_experiment#
Creates an Evidently experiment.
Type annotations and code completion for boto3.client("evidently").create_experiment
method.
boto3 documentation
# create_experiment method definition
def create_experiment(
self,
*,
metricGoals: Sequence[MetricGoalConfigTypeDef], # (1)
name: str,
project: str,
treatments: Sequence[TreatmentConfigTypeDef], # (2)
description: str = ...,
onlineAbConfig: OnlineAbConfigTypeDef = ..., # (3)
randomizationSalt: str = ...,
samplingRate: int = ...,
segment: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateExperimentResponseTypeDef: # (4)
...
- See MetricGoalConfigTypeDef
- See TreatmentConfigTypeDef
- See OnlineAbConfigTypeDef
- See CreateExperimentResponseTypeDef
# create_experiment method usage example with argument unpacking
kwargs: CreateExperimentRequestRequestTypeDef = { # (1)
"metricGoals": ...,
"name": ...,
"project": ...,
"treatments": ...,
}
parent.create_experiment(**kwargs)
create_feature#
Creates an Evidently feature that you want to launch or test.
Type annotations and code completion for boto3.client("evidently").create_feature
method.
boto3 documentation
# create_feature method definition
def create_feature(
self,
*,
name: str,
project: str,
variations: Sequence[VariationConfigTypeDef], # (1)
defaultVariation: str = ...,
description: str = ...,
entityOverrides: Mapping[str, str] = ...,
evaluationStrategy: FeatureEvaluationStrategyType = ..., # (2)
tags: Mapping[str, str] = ...,
) -> CreateFeatureResponseTypeDef: # (3)
...
# create_feature method usage example with argument unpacking
kwargs: CreateFeatureRequestRequestTypeDef = { # (1)
"name": ...,
"project": ...,
"variations": ...,
}
parent.create_feature(**kwargs)
create_launch#
Creates a launch of a given feature.
Type annotations and code completion for boto3.client("evidently").create_launch
method.
boto3 documentation
# create_launch method definition
def create_launch(
self,
*,
groups: Sequence[LaunchGroupConfigTypeDef], # (1)
name: str,
project: str,
description: str = ...,
metricMonitors: Sequence[MetricMonitorConfigTypeDef] = ..., # (2)
randomizationSalt: str = ...,
scheduledSplitsConfig: ScheduledSplitsLaunchConfigTypeDef = ..., # (3)
tags: Mapping[str, str] = ...,
) -> CreateLaunchResponseTypeDef: # (4)
...
- See LaunchGroupConfigTypeDef
- See MetricMonitorConfigTypeDef
- See ScheduledSplitsLaunchConfigTypeDef
- See CreateLaunchResponseTypeDef
# create_launch method usage example with argument unpacking
kwargs: CreateLaunchRequestRequestTypeDef = { # (1)
"groups": ...,
"name": ...,
"project": ...,
}
parent.create_launch(**kwargs)
create_project#
Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments.
Type annotations and code completion for boto3.client("evidently").create_project
method.
boto3 documentation
# create_project method definition
def create_project(
self,
*,
name: str,
appConfigResource: ProjectAppConfigResourceConfigTypeDef = ..., # (1)
dataDelivery: ProjectDataDeliveryConfigTypeDef = ..., # (2)
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateProjectResponseTypeDef: # (3)
...
- See ProjectAppConfigResourceConfigTypeDef
- See ProjectDataDeliveryConfigTypeDef
- See CreateProjectResponseTypeDef
# create_project method usage example with argument unpacking
kwargs: CreateProjectRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_project(**kwargs)
create_segment#
Use this operation to define a segment of your audience.
Type annotations and code completion for boto3.client("evidently").create_segment
method.
boto3 documentation
# create_segment method definition
def create_segment(
self,
*,
name: str,
pattern: str,
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateSegmentResponseTypeDef: # (1)
...
# create_segment method usage example with argument unpacking
kwargs: CreateSegmentRequestRequestTypeDef = { # (1)
"name": ...,
"pattern": ...,
}
parent.create_segment(**kwargs)
delete_experiment#
Deletes an Evidently experiment.
Type annotations and code completion for boto3.client("evidently").delete_experiment
method.
boto3 documentation
# delete_experiment method definition
def delete_experiment(
self,
*,
experiment: str,
project: str,
) -> Dict[str, Any]:
...
# delete_experiment method usage example with argument unpacking
kwargs: DeleteExperimentRequestRequestTypeDef = { # (1)
"experiment": ...,
"project": ...,
}
parent.delete_experiment(**kwargs)
delete_feature#
Deletes an Evidently feature.
Type annotations and code completion for boto3.client("evidently").delete_feature
method.
boto3 documentation
# delete_feature method definition
def delete_feature(
self,
*,
feature: str,
project: str,
) -> Dict[str, Any]:
...
# delete_feature method usage example with argument unpacking
kwargs: DeleteFeatureRequestRequestTypeDef = { # (1)
"feature": ...,
"project": ...,
}
parent.delete_feature(**kwargs)
delete_launch#
Deletes an Evidently launch.
Type annotations and code completion for boto3.client("evidently").delete_launch
method.
boto3 documentation
# delete_launch method definition
def delete_launch(
self,
*,
launch: str,
project: str,
) -> Dict[str, Any]:
...
# delete_launch method usage example with argument unpacking
kwargs: DeleteLaunchRequestRequestTypeDef = { # (1)
"launch": ...,
"project": ...,
}
parent.delete_launch(**kwargs)
delete_project#
Deletes an Evidently project.
Type annotations and code completion for boto3.client("evidently").delete_project
method.
boto3 documentation
# delete_project method definition
def delete_project(
self,
*,
project: str,
) -> Dict[str, Any]:
...
# delete_project method usage example with argument unpacking
kwargs: DeleteProjectRequestRequestTypeDef = { # (1)
"project": ...,
}
parent.delete_project(**kwargs)
delete_segment#
Deletes a segment.
Type annotations and code completion for boto3.client("evidently").delete_segment
method.
boto3 documentation
# delete_segment method definition
def delete_segment(
self,
*,
segment: str,
) -> Dict[str, Any]:
...
# delete_segment method usage example with argument unpacking
kwargs: DeleteSegmentRequestRequestTypeDef = { # (1)
"segment": ...,
}
parent.delete_segment(**kwargs)
evaluate_feature#
This operation assigns a feature variation to one given user session.
Type annotations and code completion for boto3.client("evidently").evaluate_feature
method.
boto3 documentation
# evaluate_feature method definition
def evaluate_feature(
self,
*,
entityId: str,
feature: str,
project: str,
evaluationContext: str = ...,
) -> EvaluateFeatureResponseTypeDef: # (1)
...
# evaluate_feature method usage example with argument unpacking
kwargs: EvaluateFeatureRequestRequestTypeDef = { # (1)
"entityId": ...,
"feature": ...,
"project": ...,
}
parent.evaluate_feature(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("evidently").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_experiment#
Returns the details about one experiment.
Type annotations and code completion for boto3.client("evidently").get_experiment
method.
boto3 documentation
# get_experiment method definition
def get_experiment(
self,
*,
experiment: str,
project: str,
) -> GetExperimentResponseTypeDef: # (1)
...
# get_experiment method usage example with argument unpacking
kwargs: GetExperimentRequestRequestTypeDef = { # (1)
"experiment": ...,
"project": ...,
}
parent.get_experiment(**kwargs)
get_experiment_results#
Retrieves the results of a running or completed experiment.
Type annotations and code completion for boto3.client("evidently").get_experiment_results
method.