cloudwatchevidently function

Amazon CloudWatch Evidently

Amazon CloudWatch Evidently

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.

cloudwatchevidently( config = list(), credentials = list(), endpoint = NULL, region = NULL )

Arguments

  • config: Optional configuration of credentials, endpoint, and/or region.

    • credentials :

      • creds :

        • access_key_id : AWS access key ID
        • secret_access_key : AWS secret access key
        • session_token : AWS temporary session token
      • profile : The name of a profile to use. If not given, then the default profile is used.

      • anonymous : Set anonymous credentials.

    • endpoint : The complete URL to use for the constructed client.

    • region : The AWS Region used in instantiating the client.

    • close_connection : Immediately close all HTTP connections.

    • timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

    • s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

    • sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

  • credentials: Optional credentials shorthand for the config parameter

    • creds :

      • access_key_id : AWS access key ID
      • secret_access_key : AWS secret access key
      • session_token : AWS temporary session token
    • profile : The name of a profile to use. If not given, then the default profile is used.

    • anonymous : Set anonymous credentials.

  • endpoint: Optional shorthand for complete URL to use for the constructed client.

  • region: Optional shorthand for AWS Region used in instantiating the client.

Returns

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- cloudwatchevidently(
  config = list(
    credentials = list(
 creds = list(
   access_key_id = "string",
   secret_access_key = "string",
   session_token = "string"
 ),
 profile = "string",
 anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
 access_key_id = "string",
 secret_access_key = "string",
 session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

batch_evaluate_featureThis operation assigns feature variation to user sessions
create_experimentCreates an Evidently experiment
create_featureCreates an Evidently feature that you want to launch or test
create_launchCreates a launch of a given feature
create_projectCreates a project, which is the logical object in Evidently that can contain features, launches, and experiments
create_segmentUse this operation to define a segment of your audience
delete_experimentDeletes an Evidently experiment
delete_featureDeletes an Evidently feature
delete_launchDeletes an Evidently launch
delete_projectDeletes an Evidently project
delete_segmentDeletes a segment
evaluate_featureThis operation assigns a feature variation to one given user session
get_experimentReturns the details about one experiment
get_experiment_resultsRetrieves the results of a running or completed experiment
get_featureReturns the details about one feature
get_launchReturns the details about one launch
get_projectReturns the details about one launch
get_segmentReturns information about the specified segment
list_experimentsReturns configuration details about all the experiments in the specified project
list_featuresReturns configuration details about all the features in the specified project
list_launchesReturns configuration details about all the launches in the specified project
list_projectsReturns configuration details about all the projects in the current Region in your account
list_segment_referencesUse this operation to find which experiments or launches are using a specified segment
list_segmentsReturns a list of audience segments that you have created in your account in this Region
list_tags_for_resourceDisplays the tags associated with an Evidently resource
put_project_eventsSends performance events to Evidently
start_experimentStarts an existing experiment
start_launchStarts an existing launch
stop_experimentStops an experiment that is currently running
stop_launchStops a launch that is currently running
tag_resourceAssigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource
test_segment_patternUse this operation to test a rules pattern that you plan to use to create an audience segment
untag_resourceRemoves one or more tags from the specified resource
update_experimentUpdates an Evidently experiment
update_featureUpdates an existing feature
update_launchUpdates a launch of a given feature
update_projectUpdates the description of an existing project
update_project_data_deliveryUpdates the data storage options for this project

Examples

## Not run: svc <- cloudwatchevidently() svc$batch_evaluate_feature( Foo = 123 ) ## End(Not run)
  • Maintainer: Dyfan Jones
  • License: Apache License (>= 2.0)
  • Last published: 2025-03-17

Downloads (last 30 days):