Client

cloudwatchevidently

R Documentation

Amazon CloudWatch Evidently¶

Description¶

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.

Usage¶

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.

Value¶

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_feature: This operation assigns feature variation to user sessions
create_experiment: Creates an Evidently experiment
create_feature: Creates an Evidently feature that you want to launch or test
create_launch: Creates a launch of a given feature
create_project: Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments
create_segment: Use this operation to define a segment of your audience
delete_experiment: Deletes an Evidently experiment
delete_feature: Deletes an Evidently feature
delete_launch: Deletes an Evidently launch
delete_project: Deletes an Evidently project
delete_segment: Deletes a segment
evaluate_feature: This operation assigns a feature variation to one given user session
get_experiment: Returns the details about one experiment
get_experiment_results: Retrieves the results of a running or completed experiment
get_feature: Returns the details about one feature
get_launch: Returns the details about one launch
get_project: Returns the details about one launch
get_segment: Returns information about the specified segment
list_experiments: Returns configuration details about all the experiments in the specified project
list_features: Returns configuration details about all the features in the specified project
list_launches: Returns configuration details about all the launches in the specified project
list_projects: Returns configuration details about all the projects in the current Region in your account
list_segment_references: Use this operation to find which experiments or launches are using a specified segment
list_segments: Returns a list of audience segments that you have created in your account in this Region
list_tags_for_resource: Displays the tags associated with an Evidently resource
put_project_events: Sends performance events to Evidently
start_experiment: Starts an existing experiment
start_launch: Starts an existing launch
stop_experiment: Stops an experiment that is currently running
stop_launch: Stops a launch that is currently running
tag_resource: Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource
test_segment_pattern: Use this operation to test a rules pattern that you plan to use to create an audience segment
untag_resource: Removes one or more tags from the specified resource
update_experiment: Updates an Evidently experiment
update_feature: Updates an existing feature
update_launch: Updates a launch of a given feature
update_project: Updates the description of an existing project
update_project_data_delivery: Updates the data storage options for this project

Examples¶

## Not run: 
svc <- cloudwatchevidently()
svc$batch_evaluate_feature(
  Foo = 123
)

## End(Not run)