Skip to content

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)
    ...
  1. See EvaluationRequestTypeDef
  2. See BatchEvaluateFeatureResponseTypeDef
# batch_evaluate_feature method usage example with argument unpacking

kwargs: BatchEvaluateFeatureRequestRequestTypeDef = {  # (1)
    "project": ...,
    "requests": ...,
}

parent.batch_evaluate_feature(**kwargs)
  1. See BatchEvaluateFeatureRequestRequestTypeDef

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)
    ...
  1. See MetricGoalConfigTypeDef
  2. See TreatmentConfigTypeDef
  3. See OnlineAbConfigTypeDef
  4. See CreateExperimentResponseTypeDef
# create_experiment method usage example with argument unpacking

kwargs: CreateExperimentRequestRequestTypeDef = {  # (1)
    "metricGoals": ...,
    "name": ...,
    "project": ...,
    "treatments": ...,
}

parent.create_experiment(**kwargs)
  1. See CreateExperimentRequestRequestTypeDef

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)
    ...
  1. See VariationConfigTypeDef
  2. See FeatureEvaluationStrategyType
  3. See CreateFeatureResponseTypeDef
# create_feature method usage example with argument unpacking

kwargs: CreateFeatureRequestRequestTypeDef = {  # (1)
    "name": ...,
    "project": ...,
    "variations": ...,
}

parent.create_feature(**kwargs)
  1. See CreateFeatureRequestRequestTypeDef

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)
    ...
  1. See LaunchGroupConfigTypeDef
  2. See MetricMonitorConfigTypeDef
  3. See ScheduledSplitsLaunchConfigTypeDef
  4. See CreateLaunchResponseTypeDef
# create_launch method usage example with argument unpacking

kwargs: CreateLaunchRequestRequestTypeDef = {  # (1)
    "groups": ...,
    "name": ...,
    "project": ...,
}

parent.create_launch(**kwargs)
  1. See CreateLaunchRequestRequestTypeDef

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)
    ...
  1. See ProjectAppConfigResourceConfigTypeDef
  2. See ProjectDataDeliveryConfigTypeDef
  3. See CreateProjectResponseTypeDef
# create_project method usage example with argument unpacking

kwargs: CreateProjectRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_project(**kwargs)
  1. See CreateProjectRequestRequestTypeDef

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)
    ...
  1. See CreateSegmentResponseTypeDef
# create_segment method usage example with argument unpacking

kwargs: CreateSegmentRequestRequestTypeDef = {  # (1)
    "name": ...,
    "pattern": ...,
}

parent.create_segment(**kwargs)
  1. See CreateSegmentRequestRequestTypeDef

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)
  1. See DeleteExperimentRequestRequestTypeDef

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)
  1. See DeleteFeatureRequestRequestTypeDef

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)
  1. See DeleteLaunchRequestRequestTypeDef

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)
  1. See DeleteProjectRequestRequestTypeDef

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)
  1. See DeleteSegmentRequestRequestTypeDef

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)
    ...
  1. See EvaluateFeatureResponseTypeDef
# evaluate_feature method usage example with argument unpacking

kwargs: EvaluateFeatureRequestRequestTypeDef = {  # (1)
    "entityId": ...,
    "feature": ...,
    "project": ...,
}

parent.evaluate_feature(**kwargs)
  1. See EvaluateFeatureRequestRequestTypeDef

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)
    ...
  1. See GetExperimentResponseTypeDef
# get_experiment method usage example with argument unpacking

kwargs: GetExperimentRequestRequestTypeDef = {  # (1)
    "experiment": ...,
    "project": ...,
}

parent.get_experiment(**kwargs)
  1. See GetExperimentRequestRequestTypeDef

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. boto3 documentation

# get_experiment_results method definition

def get_experiment_results(
    self,
    *,
    experiment: str,
    metricNames: Sequence[str],
    project: str,
    treatmentNames: Sequence[str],
    baseStat: ExperimentBaseStatType = ...,  # (1)
    endTime: Union[datetime, str] = ...,
    period: int = ...,
    reportNames: Sequence[ExperimentReportNameType] = ...,  # (2)
    resultStats: Sequence[ExperimentResultRequestTypeType] = ...,  # (3)
    startTime: Union[datetime, str] = ...,
) -> GetExperimentResultsResponseTypeDef:  # (4)
    ...
  1. See ExperimentBaseStatType
  2. See ExperimentReportNameType
  3. See ExperimentResultRequestTypeType
  4. See GetExperimentResultsResponseTypeDef
# get_experiment_results method usage example with argument unpacking

kwargs: GetExperimentResultsRequestRequestTypeDef = {  # (1)
    "experiment": ...,
    "metricNames": ...,
    "project": ...,
    "treatmentNames": ...,
}

parent.get_experiment_results(**kwargs)
  1. See GetExperimentResultsRequestRequestTypeDef

get_feature#

Returns the details about one feature.

Type annotations and code completion for boto3.client("evidently").get_feature method. boto3 documentation

# get_feature method definition

def get_feature(
    self,
    *,
    feature: str,
    project: str,
) -> GetFeatureResponseTypeDef:  # (1)
    ...
  1. See GetFeatureResponseTypeDef
# get_feature method usage example with argument unpacking

kwargs: GetFeatureRequestRequestTypeDef = {  # (1)
    "feature": ...,
    "project": ...,
}

parent.get_feature(**kwargs)
  1. See GetFeatureRequestRequestTypeDef

get_launch#

Returns the details about one launch.

Type annotations and code completion for boto3.client("evidently").get_launch method. boto3 documentation

# get_launch method definition

def get_launch(
    self,
    *,
    launch: str,
    project: str,
) -> GetLaunchResponseTypeDef:  # (1)
    ...
  1. See GetLaunchResponseTypeDef
# get_launch method usage example with argument unpacking

kwargs: GetLaunchRequestRequestTypeDef = {  # (1)
    "launch": ...,
    "project": ...,
}

parent.get_launch(**kwargs)
  1. See GetLaunchRequestRequestTypeDef

get_project#

Returns the details about one launch.

Type annotations and code completion for boto3.client("evidently").get_project method. boto3 documentation

# get_project method definition

def get_project(
    self,
    *,
    project: str,
) -> GetProjectResponseTypeDef:  # (1)
    ...
  1. See GetProjectResponseTypeDef
# get_project method usage example with argument unpacking

kwargs: GetProjectRequestRequestTypeDef = {  # (1)
    "project": ...,
}

parent.get_project(**kwargs)
  1. See GetProjectRequestRequestTypeDef

get_segment#

Returns information about the specified segment.

Type annotations and code completion for boto3.client("evidently").get_segment method. boto3 documentation

# get_segment method definition

def get_segment(
    self,
    *,
    segment: str,
) -> GetSegmentResponseTypeDef:  # (1)
    ...
  1. See GetSegmentResponseTypeDef
# get_segment method usage example with argument unpacking

kwargs: GetSegmentRequestRequestTypeDef = {  # (1)
    "segment": ...,
}

parent.get_segment(**kwargs)
  1. See GetSegmentRequestRequestTypeDef

list_experiments#

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

Type annotations and code completion for boto3.client("evidently").list_experiments method. boto3 documentation

# list_experiments method definition

def list_experiments(
    self,
    *,
    project: str,
    maxResults: int = ...,
    nextToken: str = ...,
    status: ExperimentStatusType = ...,  # (1)
) -> ListExperimentsResponseTypeDef:  # (2)
    ...
  1. See ExperimentStatusType
  2. See ListExperimentsResponseTypeDef
# list_experiments method usage example with argument unpacking

kwargs: ListExperimentsRequestRequestTypeDef = {  # (1)
    "project": ...,
}

parent.list_experiments(**kwargs)
  1. See ListExperimentsRequestRequestTypeDef

list_features#

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

Type annotations and code completion for boto3.client("evidently").list_features method. boto3 documentation

# list_features method definition

def list_features(
    self,
    *,
    project: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListFeaturesResponseTypeDef:  # (1)
    ...
  1. See ListFeaturesResponseTypeDef
# list_features method usage example with argument unpacking

kwargs: ListFeaturesRequestRequestTypeDef = {  # (1)
    "project": ...,
}

parent.list_features(**kwargs)
  1. See ListFeaturesRequestRequestTypeDef

list_launches#

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

Type annotations and code completion for boto3.client("evidently").list_launches method. boto3 documentation

# list_launches method definition

def list_launches(
    self,
    *,
    project: str,
    maxResults: int = ...,
    nextToken: str = ...,
    status: LaunchStatusType = ...,  # (1)
) -> ListLaunchesResponseTypeDef:  # (2)
    ...
  1. See LaunchStatusType
  2. See ListLaunchesResponseTypeDef
# list_launches method usage example with argument unpacking

kwargs: ListLaunchesRequestRequestTypeDef = {  # (1)
    "project": ...,
}

parent.list_launches(**kwargs)
  1. See ListLaunchesRequestRequestTypeDef

list_projects#

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

Type annotations and code completion for boto3.client("evidently").list_projects method. boto3 documentation

# list_projects method definition

def list_projects(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListProjectsResponseTypeDef:  # (1)
    ...
  1. See ListProjectsResponseTypeDef
# list_projects method usage example with argument unpacking

kwargs: ListProjectsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_projects(**kwargs)
  1. See ListProjectsRequestRequestTypeDef

list_segment_references#

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

Type annotations and code completion for boto3.client("evidently").list_segment_references method. boto3 documentation

# list_segment_references method definition

def list_segment_references(
    self,
    *,
    segment: str,
    type: SegmentReferenceResourceTypeType,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSegmentReferencesResponseTypeDef:  # (2)
    ...
  1. See SegmentReferenceResourceTypeType
  2. See ListSegmentReferencesResponseTypeDef
# list_segment_references method usage example with argument unpacking

kwargs: ListSegmentReferencesRequestRequestTypeDef = {  # (1)
    "segment": ...,
    "type": ...,
}

parent.list_segment_references(**kwargs)
  1. See ListSegmentReferencesRequestRequestTypeDef

list_segments#

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

Type annotations and code completion for boto3.client("evidently").list_segments method. boto3 documentation

# list_segments method definition

def list_segments(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSegmentsResponseTypeDef:  # (1)
    ...
  1. See ListSegmentsResponseTypeDef
# list_segments method usage example with argument unpacking

kwargs: ListSegmentsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_segments(**kwargs)
  1. See ListSegmentsRequestRequestTypeDef

list_tags_for_resource#

Displays the tags associated with an Evidently resource.

Type annotations and code completion for boto3.client("evidently").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

put_project_events#

Sends performance events to Evidently.

Type annotations and code completion for boto3.client("evidently").put_project_events method. boto3 documentation

# put_project_events method definition

def put_project_events(
    self,
    *,
    events: Sequence[EventTypeDef],  # (1)
    project: str,
) -> PutProjectEventsResponseTypeDef:  # (2)
    ...
  1. See EventTypeDef
  2. See PutProjectEventsResponseTypeDef
# put_project_events method usage example with argument unpacking

kwargs: PutProjectEventsRequestRequestTypeDef = {  # (1)
    "events": ...,
    "project": ...,
}

parent.put_project_events(**kwargs)
  1. See PutProjectEventsRequestRequestTypeDef

start_experiment#

Starts an existing experiment.

Type annotations and code completion for boto3.client("evidently").start_experiment method. boto3 documentation

# start_experiment method definition

def start_experiment(
    self,
    *,
    analysisCompleteTime: Union[datetime, str],
    experiment: str,
    project: str,
) -> StartExperimentResponseTypeDef:  # (1)
    ...
  1. See StartExperimentResponseTypeDef
# start_experiment method usage example with argument unpacking

kwargs: StartExperimentRequestRequestTypeDef = {  # (1)
    "analysisCompleteTime": ...,
    "experiment": ...,
    "project": ...,
}

parent.start_experiment(**kwargs)
  1. See StartExperimentRequestRequestTypeDef

start_launch#

Starts an existing launch.

Type annotations and code completion for boto3.client("evidently").start_launch method. boto3 documentation

# start_launch method definition

def start_launch(
    self,
    *,
    launch: str,
    project: str,
) -> StartLaunchResponseTypeDef:  # (1)
    ...
  1. See StartLaunchResponseTypeDef
# start_launch method usage example with argument unpacking

kwargs: StartLaunchRequestRequestTypeDef = {  # (1)
    "launch": ...,
    "project": ...,
}

parent.start_launch(**kwargs)
  1. See StartLaunchRequestRequestTypeDef

stop_experiment#

Stops an experiment that is currently running.

Type annotations and code completion for boto3.client("evidently").stop_experiment method. boto3 documentation

# stop_experiment method definition

def stop_experiment(
    self,
    *,
    experiment: str,
    project: str,
    desiredState: ExperimentStopDesiredStateType = ...,  # (1)
    reason: str = ...,
) -> StopExperimentResponseTypeDef:  # (2)
    ...
  1. See ExperimentStopDesiredStateType
  2. See StopExperimentResponseTypeDef
# stop_experiment method usage example with argument unpacking

kwargs: StopExperimentRequestRequestTypeDef = {  # (1)
    "experiment": ...,
    "project": ...,
}

parent.stop_experiment(**kwargs)
  1. See StopExperimentRequestRequestTypeDef

stop_launch#

Stops a launch that is currently running.

Type annotations and code completion for boto3.client("evidently").stop_launch method. boto3 documentation

# stop_launch method definition

def stop_launch(
    self,
    *,
    launch: str,
    project: str,
    desiredState: LaunchStopDesiredStateType = ...,  # (1)
    reason: str = ...,
) -> StopLaunchResponseTypeDef:  # (2)
    ...
  1. See LaunchStopDesiredStateType
  2. See StopLaunchResponseTypeDef
# stop_launch method usage example with argument unpacking

kwargs: StopLaunchRequestRequestTypeDef = {  # (1)
    "launch": ...,
    "project": ...,
}

parent.stop_launch(**kwargs)
  1. See StopLaunchRequestRequestTypeDef

tag_resource#

Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource.

Type annotations and code completion for boto3.client("evidently").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

test_segment_pattern#

Use this operation to test a rules pattern that you plan to use to create an audience segment.

Type annotations and code completion for boto3.client("evidently").test_segment_pattern method. boto3 documentation

# test_segment_pattern method definition

def test_segment_pattern(
    self,
    *,
    pattern: str,
    payload: str,
) -> TestSegmentPatternResponseTypeDef:  # (1)
    ...
  1. See TestSegmentPatternResponseTypeDef
# test_segment_pattern method usage example with argument unpacking

kwargs: TestSegmentPatternRequestRequestTypeDef = {  # (1)
    "pattern": ...,
    "payload": ...,
}

parent.test_segment_pattern(**kwargs)
  1. See TestSegmentPatternRequestRequestTypeDef

untag_resource#

Removes one or more tags from the specified resource.

Type annotations and code completion for boto3.client("evidently").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_experiment#

Updates an Evidently experiment.

Type annotations and code completion for boto3.client("evidently").update_experiment method. boto3 documentation

# update_experiment method definition

def update_experiment(
    self,
    *,
    experiment: str,
    project: str,
    description: str = ...,
    metricGoals: Sequence[MetricGoalConfigTypeDef] = ...,  # (1)
    onlineAbConfig: OnlineAbConfigTypeDef = ...,  # (2)
    randomizationSalt: str = ...,
    removeSegment: bool = ...,
    samplingRate: int = ...,
    segment: str = ...,
    treatments: Sequence[TreatmentConfigTypeDef] = ...,  # (3)
) -> UpdateExperimentResponseTypeDef:  # (4)
    ...
  1. See MetricGoalConfigTypeDef
  2. See OnlineAbConfigTypeDef
  3. See TreatmentConfigTypeDef
  4. See UpdateExperimentResponseTypeDef
# update_experiment method usage example with argument unpacking

kwargs: UpdateExperimentRequestRequestTypeDef = {  # (1)
    "experiment": ...,
    "project": ...,
}

parent.update_experiment(**kwargs)
  1. See UpdateExperimentRequestRequestTypeDef

update_feature#

Updates an existing feature.

Type annotations and code completion for boto3.client("evidently").update_feature method. boto3 documentation

# update_feature method definition

def update_feature(
    self,
    *,
    feature: str,
    project: str,
    addOrUpdateVariations: Sequence[VariationConfigTypeDef] = ...,  # (1)
    defaultVariation: str = ...,
    description: str = ...,
    entityOverrides: Mapping[str, str] = ...,
    evaluationStrategy: FeatureEvaluationStrategyType = ...,  # (2)
    removeVariations: Sequence[str] = ...,
) -> UpdateFeatureResponseTypeDef:  # (3)
    ...
  1. See VariationConfigTypeDef
  2. See FeatureEvaluationStrategyType
  3. See UpdateFeatureResponseTypeDef
# update_feature method usage example with argument unpacking

kwargs: UpdateFeatureRequestRequestTypeDef = {  # (1)
    "feature": ...,
    "project": ...,
}

parent.update_feature(**kwargs)
  1. See UpdateFeatureRequestRequestTypeDef

update_launch#

Updates a launch of a given feature.

Type annotations and code completion for boto3.client("evidently").update_launch method. boto3 documentation

# update_launch method definition

def update_launch(
    self,
    *,
    launch: str,
    project: str,
    description: str = ...,
    groups: Sequence[LaunchGroupConfigTypeDef] = ...,  # (1)
    metricMonitors: Sequence[MetricMonitorConfigTypeDef] = ...,  # (2)
    randomizationSalt: str = ...,
    scheduledSplitsConfig: ScheduledSplitsLaunchConfigTypeDef = ...,  # (3)
) -> UpdateLaunchResponseTypeDef:  # (4)
    ...
  1. See LaunchGroupConfigTypeDef
  2. See MetricMonitorConfigTypeDef
  3. See ScheduledSplitsLaunchConfigTypeDef
  4. See UpdateLaunchResponseTypeDef
# update_launch method usage example with argument unpacking

kwargs: UpdateLaunchRequestRequestTypeDef = {  # (1)
    "launch": ...,
    "project": ...,
}

parent.update_launch(**kwargs)
  1. See UpdateLaunchRequestRequestTypeDef

update_project#

Updates the description of an existing project.

Type annotations and code completion for boto3.client("evidently").update_project method. boto3 documentation

# update_project method definition

def update_project(
    self,
    *,
    project: str,
    appConfigResource: ProjectAppConfigResourceConfigTypeDef = ...,  # (1)
    description: str = ...,
) -> UpdateProjectResponseTypeDef:  # (2)
    ...
  1. See ProjectAppConfigResourceConfigTypeDef
  2. See UpdateProjectResponseTypeDef
# update_project method usage example with argument unpacking

kwargs: UpdateProjectRequestRequestTypeDef = {  # (1)
    "project": ...,
}

parent.update_project(**kwargs)
  1. See UpdateProjectRequestRequestTypeDef

update_project_data_delivery#

Updates the data storage options for this project.

Type annotations and code completion for boto3.client("evidently").update_project_data_delivery method. boto3 documentation

# update_project_data_delivery method definition

def update_project_data_delivery(
    self,
    *,
    project: str,
    cloudWatchLogs: CloudWatchLogsDestinationConfigTypeDef = ...,  # (1)
    s3Destination: S3DestinationConfigTypeDef = ...,  # (2)
) -> UpdateProjectDataDeliveryResponseTypeDef:  # (3)
    ...
  1. See CloudWatchLogsDestinationConfigTypeDef
  2. See S3DestinationConfigTypeDef
  3. See UpdateProjectDataDeliveryResponseTypeDef
# update_project_data_delivery method usage example with argument unpacking

kwargs: UpdateProjectDataDeliveryRequestRequestTypeDef = {  # (1)
    "project": ...,
}

parent.update_project_data_delivery(**kwargs)
  1. See UpdateProjectDataDeliveryRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("evidently").get_paginator method with overloads.