Class: Aws::CloudWatchEvidently::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb

Overview

An API client for CloudWatchEvidently. To construct a client, you need to configure a :region and :credentials.

client = Aws::CloudWatchEvidently::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::CloudWatchEvidently::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::CloudWatchEvidently::EndpointParameters

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



365
366
367
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 365

def initialize(*args)
  super
end

Instance Method Details

#batch_evaluate_feature(params = {}) ⇒ Types::BatchEvaluateFeatureResponse

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.

Examples:

Request syntax with placeholder values


resp = client.batch_evaluate_feature({
  project: "ProjectRef", # required
  requests: [ # required
    {
      entity_id: "EntityId", # required
      evaluation_context: "JsonValue",
      feature: "FeatureName", # required
    },
  ],
})

Response structure


resp.results #=> Array
resp.results[0].details #=> String
resp.results[0].entity_id #=> String
resp.results[0].feature #=> String
resp.results[0].project #=> String
resp.results[0].reason #=> String
resp.results[0].value.bool_value #=> Boolean
resp.results[0].value.double_value #=> Float
resp.results[0].value.long_value #=> Integer
resp.results[0].value.string_value #=> String
resp.results[0].variation #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :project (required, String) —

    The name or ARN of the project that contains the feature being evaluated.

  • :requests (required, Array<Types::EvaluationRequest>) —

    An array of structures, where each structure assigns a feature variation to one user session.

Returns:

See Also:



438
439
440
441
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 438

def batch_evaluate_feature(params = {}, options = {})
  req = build_request(:batch_evaluate_feature, params)
  req.send_request(options)
end

#create_experiment(params = {}) ⇒ Types::CreateExperimentResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_experiment({
  description: "Description",
  metric_goals: [ # required
    {
      desired_change: "INCREASE", # accepts INCREASE, DECREASE
      metric_definition: { # required
        entity_id_key: "JsonPath", # required
        event_pattern: "MetricDefinitionConfigEventPatternString",
        name: "CwDimensionSafeName", # required
        unit_label: "MetricUnitLabel",
        value_key: "JsonPath", # required
      },
    },
  ],
  name: "ExperimentName", # required
  online_ab_config: {
    control_treatment_name: "TreatmentName",
    treatment_weights: {
      "TreatmentName" => 1,
    },
  },
  project: "ProjectRef", # required
  randomization_salt: "RandomizationSalt",
  sampling_rate: 1,
  segment: "SegmentRef",
  tags: {
    "TagKey" => "TagValue",
  },
  treatments: [ # required
    {
      description: "Description",
      feature: "FeatureName", # required
      name: "TreatmentName", # required
      variation: "VariationName", # required
    },
  ],
})

Response structure


resp.experiment.arn #=> String
resp.experiment.created_time #=> Time
resp.experiment.description #=> String
resp.experiment.execution.ended_time #=> Time
resp.experiment.execution.started_time #=> Time
resp.experiment.last_updated_time #=> Time
resp.experiment.metric_goals #=> Array
resp.experiment.metric_goals[0].desired_change #=> String, one of "INCREASE", "DECREASE"
resp.experiment.metric_goals[0].metric_definition.entity_id_key #=> String
resp.experiment.metric_goals[0].metric_definition.event_pattern #=> String
resp.experiment.metric_goals[0].metric_definition.name #=> String
resp.experiment.metric_goals[0].metric_definition.unit_label #=> String
resp.experiment.metric_goals[0].metric_definition.value_key #=> String
resp.experiment.name #=> String
resp.experiment.online_ab_definition.control_treatment_name #=> String
resp.experiment.online_ab_definition.treatment_weights #=> Hash
resp.experiment.online_ab_definition.treatment_weights["TreatmentName"] #=> Integer
resp.experiment.project #=> String
resp.experiment.randomization_salt #=> String
resp.experiment.sampling_rate #=> Integer
resp.experiment.schedule.analysis_complete_time #=> Time
resp.experiment.segment #=> String
resp.experiment.status #=> String, one of "CREATED", "UPDATING", "RUNNING", "COMPLETED", "CANCELLED"
resp.experiment.status_reason #=> String
resp.experiment.tags #=> Hash
resp.experiment.tags["TagKey"] #=> String
resp.experiment.treatments #=> Array
resp.experiment.treatments[0].description #=> String
resp.experiment.treatments[0].feature_variations #=> Hash
resp.experiment.treatments[0].feature_variations["FeatureName"] #=> String
resp.experiment.treatments[0].name #=> String
resp.experiment.type #=> String, one of "aws.evidently.onlineab"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    An optional description of the experiment.

  • :metric_goals (required, Array<Types::MetricGoalConfig>) —

    An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.

  • :name (required, String) —

    A name for the new experiment.

  • :online_ab_config (Types::OnlineAbConfig) —

    A structure that contains the configuration of which variation to use as the "control" version. tThe "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

  • :project (required, String) —

    The name or ARN of the project that you want to create the new experiment in.

  • :randomization_salt (String) —

    When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the experiment name as the randomizationSalt.

  • :sampling_rate (Integer) —

    The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

    This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.

  • :segment (String) —

    Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.

  • :tags (Hash<String,String>) —

    Assigns one or more tags (key-value pairs) to the experiment.

    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 associate as many as 50 tags with an experiment.

    For more information, see Tagging Amazon Web Services resources.

  • :treatments (required, Array<Types::TreatmentConfig>) —

    An array of structures that describe the configuration of each feature variation used in the experiment.

Returns:

See Also:



611
612
613
614
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 611

def create_experiment(params = {}, options = {})
  req = build_request(:create_experiment, params)
  req.send_request(options)
end

#create_feature(params = {}) ⇒ Types::CreateFeatureResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_feature({
  default_variation: "VariationName",
  description: "Description",
  entity_overrides: {
    "EntityId" => "VariationName",
  },
  evaluation_strategy: "ALL_RULES", # accepts ALL_RULES, DEFAULT_VARIATION
  name: "FeatureName", # required
  project: "ProjectRef", # required
  tags: {
    "TagKey" => "TagValue",
  },
  variations: [ # required
    {
      name: "VariationName", # required
      value: { # required
        bool_value: false,
        double_value: 1.0,
        long_value: 1,
        string_value: "VariableValueStringValueString",
      },
    },
  ],
})

Response structure


resp.feature.arn #=> String
resp.feature.created_time #=> Time
resp.feature.default_variation #=> String
resp.feature.description #=> String
resp.feature.entity_overrides #=> Hash
resp.feature.entity_overrides["EntityId"] #=> String
resp.feature.evaluation_rules #=> Array
resp.feature.evaluation_rules[0].name #=> String
resp.feature.evaluation_rules[0].type #=> String
resp.feature.evaluation_strategy #=> String, one of "ALL_RULES", "DEFAULT_VARIATION"
resp.feature.last_updated_time #=> Time
resp.feature.name #=> String
resp.feature.project #=> String
resp.feature.status #=> String, one of "AVAILABLE", "UPDATING"
resp.feature.tags #=> Hash
resp.feature.tags["TagKey"] #=> String
resp.feature.value_type #=> String, one of "STRING", "LONG", "DOUBLE", "BOOLEAN"
resp.feature.variations #=> Array
resp.feature.variations[0].name #=> String
resp.feature.variations[0].value.bool_value #=> Boolean
resp.feature.variations[0].value.double_value #=> Float
resp.feature.variations[0].value.long_value #=> Integer
resp.feature.variations[0].value.string_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :default_variation (String) —

    The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

    This variation must also be listed in the variations structure.

    If you omit defaultVariation, the first variation listed in the variations structure is used as the default variation.

  • :description (String) —

    An optional description of the feature.

  • :entity_overrides (Hash<String,String>) —

    Specify users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.

    This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override.

  • :evaluation_strategy (String) —

    Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments. Specify DEFAULT_VARIATION to serve the default variation to all users instead.

  • :name (required, String) —

    The name for the new feature.

  • :project (required, String) —

    The name or ARN of the project that is to contain the new feature.

  • :tags (Hash<String,String>) —

    Assigns one or more tags (key-value pairs) to the feature.

    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 associate as many as 50 tags with a feature.

    For more information, see Tagging Amazon Web Services resources.

  • :variations (required, Array<Types::VariationConfig>) —

    An array of structures that contain the configuration of the feature's different variations.

Returns:

See Also:



747
748
749
750
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 747

def create_feature(params = {}, options = {})
  req = build_request(:create_feature, params)
  req.send_request(options)
end

#create_launch(params = {}) ⇒ Types::CreateLaunchResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_launch({
  description: "Description",
  groups: [ # required
    {
      description: "Description",
      feature: "FeatureName", # required
      name: "GroupName", # required
      variation: "VariationName", # required
    },
  ],
  metric_monitors: [
    {
      metric_definition: { # required
        entity_id_key: "JsonPath", # required
        event_pattern: "MetricDefinitionConfigEventPatternString",
        name: "CwDimensionSafeName", # required
        unit_label: "MetricUnitLabel",
        value_key: "JsonPath", # required
      },
    },
  ],
  name: "LaunchName", # required
  project: "ProjectRef", # required
  randomization_salt: "RandomizationSalt",
  scheduled_splits_config: {
    steps: [ # required
      {
        group_weights: { # required
          "GroupName" => 1,
        },
        segment_overrides: [
          {
            evaluation_order: 1, # required
            segment: "SegmentRef", # required
            weights: { # required
              "GroupName" => 1,
            },
          },
        ],
        start_time: Time.now, # required
      },
    ],
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.launch.arn #=> String
resp.launch.created_time #=> Time
resp.launch.description #=> String
resp.launch.execution.ended_time #=> Time
resp.launch.execution.started_time #=> Time
resp.launch.groups #=> Array
resp.launch.groups[0].description #=> String
resp.launch.groups[0].feature_variations #=> Hash
resp.launch.groups[0].feature_variations["FeatureName"] #=> String
resp.launch.groups[0].name #=> String
resp.launch.last_updated_time #=> Time
resp.launch.metric_monitors #=> Array
resp.launch.metric_monitors[0].metric_definition.entity_id_key #=> String
resp.launch.metric_monitors[0].metric_definition.event_pattern #=> String
resp.launch.metric_monitors[0].metric_definition.name #=> String
resp.launch.metric_monitors[0].metric_definition.unit_label #=> String
resp.launch.metric_monitors[0].metric_definition.value_key #=> String
resp.launch.name #=> String
resp.launch.project #=> String
resp.launch.randomization_salt #=> String
resp.launch.scheduled_splits_definition.steps #=> Array
resp.launch.scheduled_splits_definition.steps[0].group_weights #=> Hash
resp.launch.scheduled_splits_definition.steps[0].group_weights["GroupName"] #=> Integer
resp.launch.scheduled_splits_definition.steps[0].segment_overrides #=> Array
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].evaluation_order #=> Integer
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].segment #=> String
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].weights #=> Hash
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].weights["GroupName"] #=> Integer
resp.launch.scheduled_splits_definition.steps[0].start_time #=> Time
resp.launch.status #=> String, one of "CREATED", "UPDATING", "RUNNING", "COMPLETED", "CANCELLED"
resp.launch.status_reason #=> String
resp.launch.tags #=> Hash
resp.launch.tags["TagKey"] #=> String
resp.launch.type #=> String, one of "aws.evidently.splits"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    An optional description for the launch.

  • :groups (required, Array<Types::LaunchGroupConfig>) —

    An array of structures that contains the feature and variations that are to be used for the launch.

  • :metric_monitors (Array<Types::MetricMonitorConfig>) —

    An array of structures that define the metrics that will be used to monitor the launch performance.

  • :name (required, String) —

    The name for the new launch.

  • :project (required, String) —

    The name or ARN of the project that you want to create the launch in.

  • :randomization_salt (String) —

    When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the launch name as the randomizationSalt.

  • :scheduled_splits_config (Types::ScheduledSplitsLaunchConfig) —

    An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

  • :tags (Hash<String,String>) —

    Assigns one or more tags (key-value pairs) to the launch.

    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 associate as many as 50 tags with a launch.

    For more information, see Tagging Amazon Web Services resources.

Returns:

See Also:



910
911
912
913
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 910

def create_launch(params = {}, options = {})
  req = build_request(:create_launch, params)
  req.send_request(options)
end

#create_project(params = {}) ⇒ Types::CreateProjectResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_project({
  app_config_resource: {
    application_id: "AppConfigResourceId",
    environment_id: "AppConfigResourceId",
  },
  data_delivery: {
    cloud_watch_logs: {
      log_group: "CwLogGroupSafeName",
    },
    s3_destination: {
      bucket: "S3BucketSafeName",
      prefix: "S3PrefixSafeName",
    },
  },
  description: "Description",
  name: "ProjectName", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.project.active_experiment_count #=> Integer
resp.project.active_launch_count #=> Integer
resp.project.app_config_resource.application_id #=> String
resp.project.app_config_resource.configuration_profile_id #=> String
resp.project.app_config_resource.environment_id #=> String
resp.project.arn #=> String
resp.project.created_time #=> Time
resp.project.data_delivery.cloud_watch_logs.log_group #=> String
resp.project.data_delivery.s3_destination.bucket #=> String
resp.project.data_delivery.s3_destination.prefix #=> String
resp.project.description #=> String
resp.project.experiment_count #=> Integer
resp.project.feature_count #=> Integer
resp.project.last_updated_time #=> Time
resp.project.launch_count #=> Integer
resp.project.name #=> String
resp.project.status #=> String, one of "AVAILABLE", "UPDATING"
resp.project.tags #=> Hash
resp.project.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :app_config_resource (Types::ProjectAppConfigResourceConfig) —

    Use this parameter if the project will use client-side evaluation powered by AppConfig. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. For more information, see Client-side evaluation - powered by AppConfig.

    This parameter is a structure that contains information about the AppConfig application and environment that will be used as for client-side evaluation.

    To create a project that uses client-side evaluation, you must have the evidently:ExportProjectAsConfiguration permission.

  • :data_delivery (Types::ProjectDataDeliveryConfig) —

    A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so. If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view.

  • :description (String) —

    An optional description of the project.

  • :name (required, String) —

    The name for the project.

  • :tags (Hash<String,String>) —

    Assigns one or more tags (key-value pairs) to the project.

    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 associate as many as 50 tags with a project.

    For more information, see Tagging Amazon Web Services resources.

Returns:

See Also:



1029
1030
1031
1032
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1029

def create_project(params = {}, options = {})
  req = build_request(:create_project, params)
  req.send_request(options)
end

#create_segment(params = {}) ⇒ Types::CreateSegmentResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_segment({
  description: "Description",
  name: "SegmentName", # required
  pattern: "SegmentPattern", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.segment.arn #=> String
resp.segment.created_time #=> Time
resp.segment.description #=> String
resp.segment.experiment_count #=> Integer
resp.segment.last_updated_time #=> Time
resp.segment.launch_count #=> Integer
resp.segment.name #=> String
resp.segment.pattern #=> String
resp.segment.tags #=> Hash
resp.segment.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    An optional description for this segment.

  • :name (required, String) —

    A name for the segment.

  • :pattern (required, String) —

    The pattern to use for the segment. For more information about pattern syntax, see Segment rule pattern syntax.

    SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.

  • :tags (Hash<String,String>) —

    Assigns one or more tags (key-value pairs) to the segment.

    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 associate as many as 50 tags with a segment.

    For more information, see Tagging Amazon Web Services resources.

Returns:

See Also:



1126
1127
1128
1129
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1126

def create_segment(params = {}, options = {})
  req = build_request(:create_segment, params)
  req.send_request(options)
end

#delete_experiment(params = {}) ⇒ Struct

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

To stop an experiment without deleting it, use StopExperiment.

Examples:

Request syntax with placeholder values


resp = client.delete_experiment({
  experiment: "ExperimentName", # required
  project: "ProjectRef", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :experiment (required, String) —

    The name of the experiment to delete.

  • :project (required, String) —

    The name or ARN of the project that contains the experiment to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1159
1160
1161
1162
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1159

def delete_experiment(params = {}, options = {})
  req = build_request(:delete_experiment, params)
  req.send_request(options)
end

#delete_feature(params = {}) ⇒ Struct

Deletes an Evidently feature.

Examples:

Request syntax with placeholder values


resp = client.delete_feature({
  feature: "FeatureName", # required
  project: "ProjectRef", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :feature (required, String) —

    The name of the feature to delete.

  • :project (required, String) —

    The name or ARN of the project that contains the feature to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1185
1186
1187
1188
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1185

def delete_feature(params = {}, options = {})
  req = build_request(:delete_feature, params)
  req.send_request(options)
end

#delete_launch(params = {}) ⇒ Struct

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

To stop a launch without deleting it, use StopLaunch.

Examples:

Request syntax with placeholder values


resp = client.delete_launch({
  launch: "LaunchName", # required
  project: "ProjectRef", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :launch (required, String) —

    The name of the launch to delete.

  • :project (required, String) —

    The name or ARN of the project that contains the launch to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1218
1219
1220
1221
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1218

def delete_launch(params = {}, options = {})
  req = build_request(:delete_launch, params)
  req.send_request(options)
end

#delete_project(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_project({
  project: "ProjectRef", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :project (required, String) —

    The name or ARN of the project to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1246
1247
1248
1249
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1246

def delete_project(params = {}, options = {})
  req = build_request(:delete_project, params)
  req.send_request(options)
end

#delete_segment(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_segment({
  segment: "SegmentRef", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :segment (required, String) —

    Specifies the segment to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1270
1271
1272
1273
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1270

def delete_segment(params = {}, options = {})
  req = build_request(:delete_segment, params)
  req.send_request(options)
end

#evaluate_feature(params = {}) ⇒ Types::EvaluateFeatureResponse

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.

Examples:

Request syntax with placeholder values


resp = client.evaluate_feature({
  entity_id: "EntityId", # required
  evaluation_context: "JsonValue",
  feature: "FeatureName", # required
  project: "ProjectRef", # required
})

Response structure


resp.details #=> String
resp.reason #=> String
resp.value.bool_value #=> Boolean
resp.value.double_value #=> Float
resp.value.long_value #=> Integer
resp.value.string_value #=> String
resp.variation #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :entity_id (required, String) —

    An internal ID that represents a unique user of the application. This entityID is checked against any override rules assigned for this feature.

  • :evaluation_context (String) —

    A JSON object of attributes that you can optionally pass in as part of the evaluation event sent to Evidently from the user session. Evidently can use this value to match user sessions with defined audience segments. For more information, see Use segments to focus your audience.

    If you include this parameter, the value must be a JSON object. A JSON array is not supported.

    SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.

  • :feature (required, String) —

    The name of the feature being evaluated.

  • :project (required, String) —

    The name or ARN of the project that contains this feature.

Returns:

See Also:



1375
1376
1377
1378
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1375

def evaluate_feature(params = {}, options = {})
  req = build_request(:evaluate_feature, params)
  req.send_request(options)
end

#get_experiment(params = {}) ⇒ Types::GetExperimentResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_experiment({
  experiment: "ExperimentName", # required
  project: "ProjectRef", # required
})

Response structure


resp.experiment.arn #=> String
resp.experiment.created_time #=> Time
resp.experiment.description #=> String
resp.experiment.execution.ended_time #=> Time
resp.experiment.execution.started_time #=> Time
resp.experiment.last_updated_time #=> Time
resp.experiment.metric_goals #=> Array
resp.experiment.metric_goals[0].desired_change #=> String, one of "INCREASE", "DECREASE"
resp.experiment.metric_goals[0].metric_definition.entity_id_key #=> String
resp.experiment.metric_goals[0].metric_definition.event_pattern #=> String
resp.experiment.metric_goals[0].metric_definition.name #=> String
resp.experiment.metric_goals[0].metric_definition.unit_label #=> String
resp.experiment.metric_goals[0].metric_definition.value_key #=> String
resp.experiment.name #=> String
resp.experiment.online_ab_definition.control_treatment_name #=> String
resp.experiment.online_ab_definition.treatment_weights #=> Hash
resp.experiment.online_ab_definition.treatment_weights["TreatmentName"] #=> Integer
resp.experiment.project #=> String
resp.experiment.randomization_salt #=> String
resp.experiment.sampling_rate #=> Integer
resp.experiment.schedule.analysis_complete_time #=> Time
resp.experiment.segment #=> String
resp.experiment.status #=> String, one of "CREATED", "UPDATING", "RUNNING", "COMPLETED", "CANCELLED"
resp.experiment.status_reason #=> String
resp.experiment.tags #=> Hash
resp.experiment.tags["TagKey"] #=> String
resp.experiment.treatments #=> Array
resp.experiment.treatments[0].description #=> String
resp.experiment.treatments[0].feature_variations #=> Hash
resp.experiment.treatments[0].feature_variations["FeatureName"] #=> String
resp.experiment.treatments[0].name #=> String
resp.experiment.type #=> String, one of "aws.evidently.onlineab"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :experiment (required, String) —

    The name of the experiment that you want to see the details of.

  • :project (required, String) —

    The name or ARN of the project that contains the experiment.

Returns:

See Also:



1444
1445
1446
1447
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1444

def get_experiment(params = {}, options = {})
  req = build_request(:get_experiment, params)
  req.send_request(options)
end

#get_experiment_results(params = {}) ⇒ Types::GetExperimentResultsResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_experiment_results({
  base_stat: "Mean", # accepts Mean
  end_time: Time.now,
  experiment: "ExperimentName", # required
  metric_names: ["CwDimensionSafeName"], # required
  period: 1,
  project: "ProjectRef", # required
  report_names: ["BayesianInference"], # accepts BayesianInference
  result_stats: ["BaseStat"], # accepts BaseStat, TreatmentEffect, ConfidenceInterval, PValue
  start_time: Time.now,
  treatment_names: ["TreatmentName"], # required
})

Response structure


resp.details #=> String
resp.reports #=> Array
resp.reports[0].content #=> String
resp.reports[0].metric_name #=> String
resp.reports[0].report_name #=> String, one of "BayesianInference"
resp.reports[0].treatment_name #=> String
resp.results_data #=> Array
resp.results_data[0].metric_name #=> String
resp.results_data[0].result_stat #=> String, one of "Mean", "TreatmentEffect", "ConfidenceIntervalUpperBound", "ConfidenceIntervalLowerBound", "PValue"
resp.results_data[0].treatment_name #=> String
resp.results_data[0].values #=> Array
resp.results_data[0].values[0] #=> Float
resp.timestamps #=> Array
resp.timestamps[0] #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :base_stat (String) —

    The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.

  • :end_time (Time, DateTime, Date, Integer, String) —

    The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.

  • :experiment (required, String) —

    The name of the experiment to retrieve the results of.

  • :metric_names (required, Array<String>) —

    The names of the experiment metrics that you want to see the results of.

  • :period (Integer) —

    In seconds, the amount of time to aggregate results together.

  • :project (required, String) —

    The name or ARN of the project that contains the experiment that you want to see the results of.

  • :report_names (Array<String>) —

    The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

  • :result_stats (Array<String>) —

    The statistics that you want to see in the returned results.

    • PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

    • ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

    • TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

    • BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

  • :start_time (Time, DateTime, Date, Integer, String) —

    The date and time that the experiment started.

  • :treatment_names (required, Array<String>) —

    The names of the experiment treatments that you want to see the results for.

Returns:

See Also:



1563
1564
1565
1566
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1563

def get_experiment_results(params = {}, options = {})
  req = build_request(:get_experiment_results, params)
  req.send_request(options)
end

#get_feature(params = {}) ⇒ Types::GetFeatureResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_feature({
  feature: "FeatureName", # required
  project: "ProjectRef", # required
})

Response structure


resp.feature.arn #=> String
resp.feature.created_time #=> Time
resp.feature.default_variation #=> String
resp.feature.description #=> String
resp.feature.entity_overrides #=> Hash
resp.feature.entity_overrides["EntityId"] #=> String
resp.feature.evaluation_rules #=> Array
resp.feature.evaluation_rules[0].name #=> String
resp.feature.evaluation_rules[0].type #=> String
resp.feature.evaluation_strategy #=> String, one of "ALL_RULES", "DEFAULT_VARIATION"
resp.feature.last_updated_time #=> Time
resp.feature.name #=> String
resp.feature.project #=> String
resp.feature.status #=> String, one of "AVAILABLE", "UPDATING"
resp.feature.tags #=> Hash
resp.feature.tags["TagKey"] #=> String
resp.feature.value_type #=> String, one of "STRING", "LONG", "DOUBLE", "BOOLEAN"
resp.feature.variations #=> Array
resp.feature.variations[0].name #=> String
resp.feature.variations[0].value.bool_value #=> Boolean
resp.feature.variations[0].value.double_value #=> Float
resp.feature.variations[0].value.long_value #=> Integer
resp.feature.variations[0].value.string_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :feature (required, String) —

    The name of the feature that you want to retrieve information for.

  • :project (required, String) —

    The name or ARN of the project that contains the feature.

Returns:

See Also:



1623
1624
1625
1626
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1623

def get_feature(params = {}, options = {})
  req = build_request(:get_feature, params)
  req.send_request(options)
end

#get_launch(params = {}) ⇒ Types::GetLaunchResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_launch({
  launch: "LaunchName", # required
  project: "ProjectRef", # required
})

Response structure


resp.launch.arn #=> String
resp.launch.created_time #=> Time
resp.launch.description #=> String
resp.launch.execution.ended_time #=> Time
resp.launch.execution.started_time #=> Time
resp.launch.groups #=> Array
resp.launch.groups[0].description #=> String
resp.launch.groups[0].feature_variations #=> Hash
resp.launch.groups[0].feature_variations["FeatureName"] #=> String
resp.launch.groups[0].name #=> String
resp.launch.last_updated_time #=> Time
resp.launch.metric_monitors #=> Array
resp.launch.metric_monitors[0].metric_definition.entity_id_key #=> String
resp.launch.metric_monitors[0].metric_definition.event_pattern #=> String
resp.launch.metric_monitors[0].metric_definition.name #=> String
resp.launch.metric_monitors[0].metric_definition.unit_label #=> String
resp.launch.metric_monitors[0].metric_definition.value_key #=> String
resp.launch.name #=> String
resp.launch.project #=> String
resp.launch.randomization_salt #=> String
resp.launch.scheduled_splits_definition.steps #=> Array
resp.launch.scheduled_splits_definition.steps[0].group_weights #=> Hash
resp.launch.scheduled_splits_definition.steps[0].group_weights["GroupName"] #=> Integer
resp.launch.scheduled_splits_definition.steps[0].segment_overrides #=> Array
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].evaluation_order #=> Integer
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].segment #=> String
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].weights #=> Hash
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].weights["GroupName"] #=> Integer
resp.launch.scheduled_splits_definition.steps[0].start_time #=> Time
resp.launch.status #=> String, one of "CREATED", "UPDATING", "RUNNING", "COMPLETED", "CANCELLED"
resp.launch.status_reason #=> String
resp.launch.tags #=> Hash
resp.launch.tags["TagKey"] #=> String
resp.launch.type #=> String, one of "aws.evidently.splits"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :launch (required, String) —

    The name of the launch that you want to see the details of.

  • :project (required, String) —

    The name or ARN of the project that contains the launch.

Returns:

See Also:



1694
1695
1696
1697
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1694

def get_launch(params = {}, options = {})
  req = build_request(:get_launch, params)
  req.send_request(options)
end

#get_project(params = {}) ⇒ Types::GetProjectResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_project({
  project: "ProjectRef", # required
})

Response structure


resp.project.active_experiment_count #=> Integer
resp.project.active_launch_count #=> Integer
resp.project.app_config_resource.application_id #=> String
resp.project.app_config_resource.configuration_profile_id #=> String
resp.project.app_config_resource.environment_id #=> String
resp.project.arn #=> String
resp.project.created_time #=> Time
resp.project.data_delivery.cloud_watch_logs.log_group #=> String
resp.project.data_delivery.s3_destination.bucket #=> String
resp.project.data_delivery.s3_destination.prefix #=> String
resp.project.description #=> String
resp.project.experiment_count #=> Integer
resp.project.feature_count #=> Integer
resp.project.last_updated_time #=> Time
resp.project.launch_count #=> Integer
resp.project.name #=> String
resp.project.status #=> String, one of "AVAILABLE", "UPDATING"
resp.project.tags #=> Hash
resp.project.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :project (required, String) —

    The name or ARN of the project that you want to see the details of.

Returns:

See Also:



1746
1747
1748
1749
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1746

def get_project(params = {}, options = {})
  req = build_request(:get_project, params)
  req.send_request(options)
end

#get_segment(params = {}) ⇒ Types::GetSegmentResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_segment({
  segment: "SegmentRef", # required
})

Response structure


resp.segment.arn #=> String
resp.segment.created_time #=> Time
resp.segment.description #=> String
resp.segment.experiment_count #=> Integer
resp.segment.last_updated_time #=> Time
resp.segment.launch_count #=> Integer
resp.segment.name #=> String
resp.segment.pattern #=> String
resp.segment.tags #=> Hash
resp.segment.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :segment (required, String) —

    The ARN of the segment to return information for.

Returns:

See Also:



1784
1785
1786
1787
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1784

def get_segment(params = {}, options = {})
  req = build_request(:get_segment, params)
  req.send_request(options)
end

#list_experiments(params = {}) ⇒ Types::ListExperimentsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_experiments({
  max_results: 1,
  next_token: "NextToken",
  project: "ProjectRef", # required
  status: "CREATED", # accepts CREATED, UPDATING, RUNNING, COMPLETED, CANCELLED
})

Response structure


resp.experiments #=> Array
resp.experiments[0].arn #=> String
resp.experiments[0].created_time #=> Time
resp.experiments[0].description #=> String
resp.experiments[0].execution.ended_time #=> Time
resp.experiments[0].execution.started_time #=> Time
resp.experiments[0].last_updated_time #=> Time
resp.experiments[0].metric_goals #=> Array
resp.experiments[0].metric_goals[0].desired_change #=> String, one of "INCREASE", "DECREASE"
resp.experiments[0].metric_goals[0].metric_definition.entity_id_key #=> String
resp.experiments[0].metric_goals[0].metric_definition.event_pattern #=> String
resp.experiments[0].metric_goals[0].metric_definition.name #=> String
resp.experiments[0].metric_goals[0].metric_definition.unit_label #=> String
resp.experiments[0].metric_goals[0].metric_definition.value_key #=> String
resp.experiments[0].name #=> String
resp.experiments[0].online_ab_definition.control_treatment_name #=> String
resp.experiments[0].online_ab_definition.treatment_weights #=> Hash
resp.experiments[0].online_ab_definition.treatment_weights["TreatmentName"] #=> Integer
resp.experiments[0].project #=> String
resp.experiments[0].randomization_salt #=> String
resp.experiments[0].sampling_rate #=> Integer
resp.experiments[0].schedule.analysis_complete_time #=> Time
resp.experiments[0].segment #=> String
resp.experiments[0].status #=> String, one of "CREATED", "UPDATING", "RUNNING", "COMPLETED", "CANCELLED"
resp.experiments[0].status_reason #=> String
resp.experiments[0].tags #=> Hash
resp.experiments[0].tags["TagKey"] #=> String
resp.experiments[0].treatments #=> Array
resp.experiments[0].treatments[0].description #=> String
resp.experiments[0].treatments[0].feature_variations #=> Hash
resp.experiments[0].treatments[0].feature_variations["FeatureName"] #=> String
resp.experiments[0].treatments[0].name #=> String
resp.experiments[0].type #=> String, one of "aws.evidently.onlineab"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to include in the response.

  • :next_token (String) —

    The token to use when requesting the next set of results. You received this token from a previous ListExperiments operation.

  • :project (required, String) —

    The name or ARN of the project to return the experiment list from.

  • :status (String) —

    Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.

Returns:

See Also:



1863
1864
1865
1866
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1863

def list_experiments(params = {}, options = {})
  req = build_request(:list_experiments, params)
  req.send_request(options)
end

#list_features(params = {}) ⇒ Types::ListFeaturesResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_features({
  max_results: 1,
  next_token: "NextToken",
  project: "ProjectRef", # required
})

Response structure


resp.features #=> Array
resp.features[0].arn #=> String
resp.features[0].created_time #=> Time
resp.features[0].default_variation #=> String
resp.features[0].evaluation_rules #=> Array
resp.features[0].evaluation_rules[0].name #=> String
resp.features[0].evaluation_rules[0].type #=> String
resp.features[0].evaluation_strategy #=> String, one of "ALL_RULES", "DEFAULT_VARIATION"
resp.features[0].last_updated_time #=> Time
resp.features[0].name #=> String
resp.features[0].project #=> String
resp.features[0].status #=> String, one of "AVAILABLE", "UPDATING"
resp.features[0].tags #=> Hash
resp.features[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to include in the response.

  • :next_token (String) —

    The token to use when requesting the next set of results. You received this token from a previous ListFeatures operation.

  • :project (required, String) —

    The name or ARN of the project to return the feature list from.

Returns:

See Also:



1918
1919
1920
1921
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1918

def list_features(params = {}, options = {})
  req = build_request(:list_features, params)
  req.send_request(options)
end

#list_launches(params = {}) ⇒ Types::ListLaunchesResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_launches({
  max_results: 1,
  next_token: "NextToken",
  project: "ProjectRef", # required
  status: "CREATED", # accepts CREATED, UPDATING, RUNNING, COMPLETED, CANCELLED
})

Response structure


resp.launches #=> Array
resp.launches[0].arn #=> String
resp.launches[0].created_time #=> Time
resp.launches[0].description #=> String
resp.launches[0].execution.ended_time #=> Time
resp.launches[0].execution.started_time #=> Time
resp.launches[0].groups #=> Array
resp.launches[0].groups[0].description #=> String
resp.launches[0].groups[0].feature_variations #=> Hash
resp.launches[0].groups[0].feature_variations["FeatureName"] #=> String
resp.launches[0].groups[0].name #=> String
resp.launches[0].last_updated_time #=> Time
resp.launches[0].metric_monitors #=> Array
resp.launches[0].metric_monitors[0].metric_definition.entity_id_key #=> String
resp.launches[0].metric_monitors[0].metric_definition.event_pattern #=> String
resp.launches[0].metric_monitors[0].metric_definition.name #=> String
resp.launches[0].metric_monitors[0].metric_definition.unit_label #=> String
resp.launches[0].metric_monitors[0].metric_definition.value_key #=> String
resp.launches[0].name #=> String
resp.launches[0].project #=> String
resp.launches[0].randomization_salt #=> String
resp.launches[0].scheduled_splits_definition.steps #=> Array
resp.launches[0].scheduled_splits_definition.steps[0].group_weights #=> Hash
resp.launches[0].scheduled_splits_definition.steps[0].group_weights["GroupName"] #=> Integer
resp.launches[0].scheduled_splits_definition.steps[0].segment_overrides #=> Array
resp.launches[0].scheduled_splits_definition.steps[0].segment_overrides[0].evaluation_order #=> Integer
resp.launches[0].scheduled_splits_definition.steps[0].segment_overrides[0].segment #=> String
resp.launches[0].scheduled_splits_definition.steps[0].segment_overrides[0].weights #=> Hash
resp.launches[0].scheduled_splits_definition.steps[0].segment_overrides[0].weights["GroupName"] #=> Integer
resp.launches[0].scheduled_splits_definition.steps[0].start_time #=> Time
resp.launches[0].status #=> String, one of "CREATED", "UPDATING", "RUNNING", "COMPLETED", "CANCELLED"
resp.launches[0].status_reason #=> String
resp.launches[0].tags #=> Hash
resp.launches[0].tags["TagKey"] #=> String
resp.launches[0].type #=> String, one of "aws.evidently.splits"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to include in the response.

  • :next_token (String) —

    The token to use when requesting the next set of results. You received this token from a previous ListLaunches operation.

  • :project (required, String) —

    The name or ARN of the project to return the launch list from.

  • :status (String) —

    Use this optional parameter to limit the returned results to only the launches with the status that you specify here.

Returns:

See Also:



1999
2000
2001
2002
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 1999

def list_launches(params = {}, options = {})
  req = build_request(:list_launches, params)
  req.send_request(options)
end

#list_projects(params = {}) ⇒ Types::ListProjectsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_projects({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.projects #=> Array
resp.projects[0].active_experiment_count #=> Integer
resp.projects[0].active_launch_count #=> Integer
resp.projects[0].arn #=> String
resp.projects[0].created_time #=> Time
resp.projects[0].description #=> String
resp.projects[0].experiment_count #=> Integer
resp.projects[0].feature_count #=> Integer
resp.projects[0].last_updated_time #=> Time
resp.projects[0].launch_count #=> Integer
resp.projects[0].name #=> String
resp.projects[0].status #=> String, one of "AVAILABLE", "UPDATING"
resp.projects[0].tags #=> Hash
resp.projects[0].tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to include in the response.

  • :next_token (String) —

    The token to use when requesting the next set of results. You received this token from a previous ListProjects operation.

Returns:

See Also:



2050
2051
2052
2053
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 2050

def list_projects(params = {}, options = {})
  req = build_request(:list_projects, params)
  req.send_request(options)
end

#list_segment_references(params = {}) ⇒ Types::ListSegmentReferencesResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_segment_references({
  max_results: 1,
  next_token: "NextToken",
  segment: "SegmentRef", # required
  type: "EXPERIMENT", # required, accepts EXPERIMENT, LAUNCH
})

Response structure


resp.next_token #=> String
resp.referenced_by #=> Array
resp.referenced_by[0].arn #=> String
resp.referenced_by[0].end_time #=> String
resp.referenced_by[0].last_updated_on #=> String
resp.referenced_by[0].name #=> String
resp.referenced_by[0].start_time #=> String
resp.referenced_by[0].status #=> String
resp.referenced_by[0].type #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to include in the response. If you omit this, the default of 50 is used.

  • :next_token (String) —

    The token to use when requesting the next set of results. You received this token from a previous ListSegmentReferences operation.

  • :segment (required, String) —

    The ARN of the segment that you want to view information for.

  • :type (required, String) —

    Specifies whether to return information about launches or experiments that use this segment.

Returns:

See Also:



2105
2106
2107
2108
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 2105

def list_segment_references(params = {}, options = {})
  req = build_request(:list_segment_references, params)
  req.send_request(options)
end

#list_segments(params = {}) ⇒ Types::ListSegmentsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_segments({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.segments #=> Array
resp.segments[0].arn #=> String
resp.segments[0].created_time #=> Time
resp.segments[0].description #=> String
resp.segments[0].experiment_count #=> Integer
resp.segments[0].last_updated_time #=> Time
resp.segments[0].launch_count #=> Integer
resp.segments[0].name #=> String
resp.segments[0].pattern #=> String
resp.segments[0].tags #=> Hash
resp.segments[0].tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to include in the response. If you omit this, the default of 50 is used.

  • :next_token (String) —

    The token to use when requesting the next set of results. You received this token from a previous ListSegments operation.

Returns:

See Also:



2154
2155
2156
2157
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 2154

def list_segments(params = {}, options = {})
  req = build_request(:list_segments, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Displays the tags associated with an Evidently resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource that you want to see the tags of.

Returns:

See Also:



2183
2184
2185
2186
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 2183

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_project_events(params = {}) ⇒ Types::PutProjectEventsResponse

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

Examples:

Request syntax with placeholder values


resp = client.put_project_events({
  events: [ # required
    {
      data: "JsonValue", # required
      timestamp: Time.now, # required
      type: "aws.evidently.evaluation", # required, accepts aws.evidently.evaluation, aws.evidently.custom
    },
  ],
  project: "ProjectRef", # required
})

Response structure


resp.event_results #=> Array
resp.event_results[0].error_code #=> String
resp.event_results[0].error_message #=> String
resp.event_results[0].event_id #=> String
resp.failed_event_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :events (required, Array<Types::Event>) —

    An array of event structures that contain the performance data that is being sent to Evidently.

  • :project (required, String) —

    The name or ARN of the project to write the events to.

Returns:

See Also:



2228
2229
2230
2231
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 2228

def put_project_events(params = {}, options = {})
  req = build_request(:put_project_events, params)
  req.send_request(options)
end

#start_experiment(params = {}) ⇒ Types::StartExperimentResponse

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

Examples:

Request syntax with placeholder values


resp = client.start_experiment({
  analysis_complete_time: Time.now, # required
  experiment: "ExperimentName", # required
  project: "ProjectRef", # required
})

Response structure


resp.started_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :analysis_complete_time (required, Time, DateTime, Date, Integer, String) —

    The date and time to end the experiment. This must be no more than 30 days after the experiment starts.

  • :experiment (required, String) —

    The name of the experiment to start.

  • :project (required, String) —

    The name or ARN of the project that contains the experiment to start.

Returns:

See Also:



2270
2271
2272
2273
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 2270

def start_experiment(params = {}, options = {})
  req = build_request(:start_experiment, params)
  req.send_request(options)
end

#start_launch(params = {}) ⇒ Types::StartLaunchResponse

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

Examples:

Request syntax with placeholder values


resp = client.start_launch({
  launch: "LaunchName", # required
  project: "ProjectRef", # required
})

Response structure


resp.launch.arn #=> String
resp.launch.created_time #=> Time
resp.launch.description #=> String
resp.launch.execution.ended_time #=> Time
resp.launch.execution.started_time #=> Time
resp.launch.groups #=> Array
resp.launch.groups[0].description #=> String
resp.launch.groups[0].feature_variations #=> Hash
resp.launch.groups[0].feature_variations["FeatureName"] #=> String
resp.launch.groups[0].name #=> String
resp.launch.last_updated_time #=> Time
resp.launch.metric_monitors #=> Array
resp.launch.metric_monitors[0].metric_definition.entity_id_key #=> String
resp.launch.metric_monitors[0].metric_definition.event_pattern #=> String
resp.launch.metric_monitors[0].metric_definition.name #=> String
resp.launch.metric_monitors[0].metric_definition.unit_label #=> String
resp.launch.metric_monitors[0].metric_definition.value_key #=> String
resp.launch.name #=> String
resp.launch.project #=> String
resp.launch.randomization_salt #=> String
resp.launch.scheduled_splits_definition.steps #=> Array
resp.launch.scheduled_splits_definition.steps[0].group_weights #=> Hash
resp.launch.scheduled_splits_definition.steps[0].group_weights["GroupName"] #=> Integer
resp.launch.scheduled_splits_definition.steps[0].segment_overrides #=> Array
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].evaluation_order #=> Integer
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].segment #=> String
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].weights #=> Hash
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].weights["GroupName"] #=> Integer
resp.launch.scheduled_splits_definition.steps[0].start_time #=> Time
resp.launch.status #=> String, one of "CREATED", "UPDATING", "RUNNING", "COMPLETED", "CANCELLED"
resp.launch.status_reason #=> String
resp.launch.tags #=> Hash
resp.launch.tags["TagKey"] #=> String
resp.launch.type #=> String, one of "aws.evidently.splits"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :launch (required, String) —

    The name of the launch to start.

  • :project (required, String) —

    The name or ARN of the project that contains the launch to start.

Returns:

See Also:



2339
2340
2341
2342
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 2339

def start_launch(params = {}, options = {})
  req = build_request(:start_launch, params)
  req.send_request(options)
end

#stop_experiment(params = {}) ⇒ Types::StopExperimentResponse

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

Examples:

Request syntax with placeholder values


resp = client.stop_experiment({
  desired_state: "COMPLETED", # accepts COMPLETED, CANCELLED
  experiment: "ExperimentName", # required
  project: "ProjectRef", # required
  reason: "Description",
})

Response structure


resp.ended_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :desired_state (String) —

    Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.

  • :experiment (required, String) —

    The name of the experiment to stop.

  • :project (required, String) —

    The name or ARN of the project that contains the experiment to stop.

  • :reason (String) —

    A string that describes why you are stopping the experiment.

Returns:

See Also:



2381
2382
2383
2384
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 2381

def stop_experiment(params = {}, options = {})
  req = build_request(:stop_experiment, params)
  req.send_request(options)
end

#stop_launch(params = {}) ⇒ Types::StopLaunchResponse

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.

Examples:

Request syntax with placeholder values


resp = client.stop_launch({
  desired_state: "COMPLETED", # accepts COMPLETED, CANCELLED
  launch: "LaunchName", # required
  project: "ProjectRef", # required
  reason: "Description",
})

Response structure


resp.ended_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :desired_state (String) —

    Specify whether to consider the launch as COMPLETED or CANCELLED after it stops.

  • :launch (required, String) —

    The name of the launch to stop.

  • :project (required, String) —

    The name or ARN of the project that contains the launch that you want to stop.

  • :reason (String) —

    A string that describes why you are stopping the launch.

Returns:

See Also:



2428
2429
2430
2431
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 2428

def stop_launch(params = {}, options = {})
  req = build_request(:stop_launch, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the CloudWatch Evidently resource that you're adding tags to.

  • :tags (required, Hash<String,String>) —

    The list of key-value pairs to associate with the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2480
2481
2482
2483
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 2480

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#test_segment_pattern(params = {}) ⇒ Types::TestSegmentPatternResponse

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.

Examples:

Request syntax with placeholder values


resp = client.test_segment_pattern({
  pattern: "SegmentPattern", # required
  payload: "JsonValue", # required
})

Response structure


resp.match #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pattern (required, String) —

    The pattern to test.

    SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.

  • :payload (required, String) —

    A sample evaluationContext JSON block to test against the specified pattern.

    SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.

Returns:

See Also:



2527
2528
2529
2530
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 2527

def test_segment_pattern(params = {}, options = {})
  req = build_request(:test_segment_pattern, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the CloudWatch Evidently resource that you're removing tags from.

  • :tag_keys (required, Array<String>) —

    The list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2554
2555
2556
2557
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 2554

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_experiment(params = {}) ⇒ Types::UpdateExperimentResponse

Updates an Evidently experiment.

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

Examples:

Request syntax with placeholder values


resp = client.update_experiment({
  description: "Description",
  experiment: "ExperimentName", # required
  metric_goals: [
    {
      desired_change: "INCREASE", # accepts INCREASE, DECREASE
      metric_definition: { # required
        entity_id_key: "JsonPath", # required
        event_pattern: "MetricDefinitionConfigEventPatternString",
        name: "CwDimensionSafeName", # required
        unit_label: "MetricUnitLabel",
        value_key: "JsonPath", # required
      },
    },
  ],
  online_ab_config: {
    control_treatment_name: "TreatmentName",
    treatment_weights: {
      "TreatmentName" => 1,
    },
  },
  project: "ProjectRef", # required
  randomization_salt: "RandomizationSalt",
  remove_segment: false,
  sampling_rate: 1,
  segment: "SegmentRef",
  treatments: [
    {
      description: "Description",
      feature: "FeatureName", # required
      name: "TreatmentName", # required
      variation: "VariationName", # required
    },
  ],
})

Response structure


resp.experiment.arn #=> String
resp.experiment.created_time #=> Time
resp.experiment.description #=> String
resp.experiment.execution.ended_time #=> Time
resp.experiment.execution.started_time #=> Time
resp.experiment.last_updated_time #=> Time
resp.experiment.metric_goals #=> Array
resp.experiment.metric_goals[0].desired_change #=> String, one of "INCREASE", "DECREASE"
resp.experiment.metric_goals[0].metric_definition.entity_id_key #=> String
resp.experiment.metric_goals[0].metric_definition.event_pattern #=> String
resp.experiment.metric_goals[0].metric_definition.name #=> String
resp.experiment.metric_goals[0].metric_definition.unit_label #=> String
resp.experiment.metric_goals[0].metric_definition.value_key #=> String
resp.experiment.name #=> String
resp.experiment.online_ab_definition.control_treatment_name #=> String
resp.experiment.online_ab_definition.treatment_weights #=> Hash
resp.experiment.online_ab_definition.treatment_weights["TreatmentName"] #=> Integer
resp.experiment.project #=> String
resp.experiment.randomization_salt #=> String
resp.experiment.sampling_rate #=> Integer
resp.experiment.schedule.analysis_complete_time #=> Time
resp.experiment.segment #=> String
resp.experiment.status #=> String, one of "CREATED", "UPDATING", "RUNNING", "COMPLETED", "CANCELLED"
resp.experiment.status_reason #=> String
resp.experiment.tags #=> Hash
resp.experiment.tags["TagKey"] #=> String
resp.experiment.treatments #=> Array
resp.experiment.treatments[0].description #=> String
resp.experiment.treatments[0].feature_variations #=> Hash
resp.experiment.treatments[0].feature_variations["FeatureName"] #=> String
resp.experiment.treatments[0].name #=> String
resp.experiment.type #=> String, one of "aws.evidently.onlineab"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    An optional description of the experiment.

  • :experiment (required, String) —

    The name of the experiment to update.

  • :metric_goals (Array<Types::MetricGoalConfig>) —

    An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.

  • :online_ab_config (Types::OnlineAbConfig) —

    A structure that contains the configuration of which variation o use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

  • :project (required, String) —

    The name or ARN of the project that contains the experiment that you want to update.

  • :randomization_salt (String) —

    When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the experiment name as the randomizationSalt.

  • :remove_segment (Boolean) —

    Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.

  • :sampling_rate (Integer) —

    The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

    This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.

  • :segment (String) —

    Adds an audience segment to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.

  • :treatments (Array<Types::TreatmentConfig>) —

    An array of structures that define the variations being tested in the experiment.

Returns:

See Also:



2700
2701
2702
2703
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 2700

def update_experiment(params = {}, options = {})
  req = build_request(:update_experiment, params)
  req.send_request(options)
end

#update_feature(params = {}) ⇒ Types::UpdateFeatureResponse

Updates an existing feature.

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

Examples:

Request syntax with placeholder values


resp = client.update_feature({
  add_or_update_variations: [
    {
      name: "VariationName", # required
      value: { # required
        bool_value: false,
        double_value: 1.0,
        long_value: 1,
        string_value: "VariableValueStringValueString",
      },
    },
  ],
  default_variation: "VariationName",
  description: "Description",
  entity_overrides: {
    "EntityId" => "VariationName",
  },
  evaluation_strategy: "ALL_RULES", # accepts ALL_RULES, DEFAULT_VARIATION
  feature: "FeatureName", # required
  project: "ProjectRef", # required
  remove_variations: ["VariationName"],
})

Response structure


resp.feature.arn #=> String
resp.feature.created_time #=> Time
resp.feature.default_variation #=> String
resp.feature.description #=> String
resp.feature.entity_overrides #=> Hash
resp.feature.entity_overrides["EntityId"] #=> String
resp.feature.evaluation_rules #=> Array
resp.feature.evaluation_rules[0].name #=> String
resp.feature.evaluation_rules[0].type #=> String
resp.feature.evaluation_strategy #=> String, one of "ALL_RULES", "DEFAULT_VARIATION"
resp.feature.last_updated_time #=> Time
resp.feature.name #=> String
resp.feature.project #=> String
resp.feature.status #=> String, one of "AVAILABLE", "UPDATING"
resp.feature.tags #=> Hash
resp.feature.tags["TagKey"] #=> String
resp.feature.value_type #=> String, one of "STRING", "LONG", "DOUBLE", "BOOLEAN"
resp.feature.variations #=> Array
resp.feature.variations[0].name #=> String
resp.feature.variations[0].value.bool_value #=> Boolean
resp.feature.variations[0].value.double_value #=> Float
resp.feature.variations[0].value.long_value #=> Integer
resp.feature.variations[0].value.string_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :add_or_update_variations (Array<Types::VariationConfig>) —

    To update variation configurations for this feature, or add new ones, specify this structure. In this array, include any variations that you want to add or update. If the array includes a variation name that already exists for this feature, it is updated. If it includes a new variation name, it is added as a new variation.

  • :default_variation (String) —

    The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

  • :description (String) —

    An optional description of the feature.

  • :entity_overrides (Hash<String,String>) —

    Specified users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.

    This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override.

  • :evaluation_strategy (String) —

    Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments. Specify DEFAULT_VARIATION to serve the default variation to all users instead.

  • :feature (required, String) —

    The name of the feature to be updated.

  • :project (required, String) —

    The name or ARN of the project that contains the feature to be updated.

  • :remove_variations (Array<String>) —

    Removes a variation from the feature. If the variation you specify doesn't exist, then this makes no change and does not report an error.

    This operation fails if you try to remove a variation that is part of an ongoing launch or experiment.

Returns:

See Also:



2818
2819
2820
2821
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 2818

def update_feature(params = {}, options = {})
  req = build_request(:update_feature, params)
  req.send_request(options)
end

#update_launch(params = {}) ⇒ Types::UpdateLaunchResponse

Updates a launch of a given feature.

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

Examples:

Request syntax with placeholder values


resp = client.update_launch({
  description: "Description",
  groups: [
    {
      description: "Description",
      feature: "FeatureName", # required
      name: "GroupName", # required
      variation: "VariationName", # required
    },
  ],
  launch: "LaunchName", # required
  metric_monitors: [
    {
      metric_definition: { # required
        entity_id_key: "JsonPath", # required
        event_pattern: "MetricDefinitionConfigEventPatternString",
        name: "CwDimensionSafeName", # required
        unit_label: "MetricUnitLabel",
        value_key: "JsonPath", # required
      },
    },
  ],
  project: "ProjectRef", # required
  randomization_salt: "RandomizationSalt",
  scheduled_splits_config: {
    steps: [ # required
      {
        group_weights: { # required
          "GroupName" => 1,
        },
        segment_overrides: [
          {
            evaluation_order: 1, # required
            segment: "SegmentRef", # required
            weights: { # required
              "GroupName" => 1,
            },
          },
        ],
        start_time: Time.now, # required
      },
    ],
  },
})

Response structure


resp.launch.arn #=> String
resp.launch.created_time #=> Time
resp.launch.description #=> String
resp.launch.execution.ended_time #=> Time
resp.launch.execution.started_time #=> Time
resp.launch.groups #=> Array
resp.launch.groups[0].description #=> String
resp.launch.groups[0].feature_variations #=> Hash
resp.launch.groups[0].feature_variations["FeatureName"] #=> String
resp.launch.groups[0].name #=> String
resp.launch.last_updated_time #=> Time
resp.launch.metric_monitors #=> Array
resp.launch.metric_monitors[0].metric_definition.entity_id_key #=> String
resp.launch.metric_monitors[0].metric_definition.event_pattern #=> String
resp.launch.metric_monitors[0].metric_definition.name #=> String
resp.launch.metric_monitors[0].metric_definition.unit_label #=> String
resp.launch.metric_monitors[0].metric_definition.value_key #=> String
resp.launch.name #=> String
resp.launch.project #=> String
resp.launch.randomization_salt #=> String
resp.launch.scheduled_splits_definition.steps #=> Array
resp.launch.scheduled_splits_definition.steps[0].group_weights #=> Hash
resp.launch.scheduled_splits_definition.steps[0].group_weights["GroupName"] #=> Integer
resp.launch.scheduled_splits_definition.steps[0].segment_overrides #=> Array
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].evaluation_order #=> Integer
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].segment #=> String
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].weights #=> Hash
resp.launch.scheduled_splits_definition.steps[0].segment_overrides[0].weights["GroupName"] #=> Integer
resp.launch.scheduled_splits_definition.steps[0].start_time #=> Time
resp.launch.status #=> String, one of "CREATED", "UPDATING", "RUNNING", "COMPLETED", "CANCELLED"
resp.launch.status_reason #=> String
resp.launch.tags #=> Hash
resp.launch.tags["TagKey"] #=> String
resp.launch.type #=> String, one of "aws.evidently.splits"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    An optional description for the launch.

  • :groups (Array<Types::LaunchGroupConfig>) —

    An array of structures that contains the feature and variations that are to be used for the launch.

  • :launch (required, String) —

    The name of the launch that is to be updated.

  • :metric_monitors (Array<Types::MetricMonitorConfig>) —

    An array of structures that define the metrics that will be used to monitor the launch performance.

  • :project (required, String) —

    The name or ARN of the project that contains the launch that you want to update.

  • :randomization_salt (String) —

    When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the launch name as the randomizationSalt.

  • :scheduled_splits_config (Types::ScheduledSplitsLaunchConfig) —

    An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

Returns:

See Also:



2953
2954
2955
2956
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 2953

def update_launch(params = {}, options = {})
  req = build_request(:update_launch, params)
  req.send_request(options)
end

#update_project(params = {}) ⇒ Types::UpdateProjectResponse

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.

Examples:

Request syntax with placeholder values


resp = client.update_project({
  app_config_resource: {
    application_id: "AppConfigResourceId",
    environment_id: "AppConfigResourceId",
  },
  description: "Description",
  project: "ProjectRef", # required
})

Response structure


resp.project.active_experiment_count #=> Integer
resp.project.active_launch_count #=> Integer
resp.project.app_config_resource.application_id #=> String
resp.project.app_config_resource.configuration_profile_id #=> String
resp.project.app_config_resource.environment_id #=> String
resp.project.arn #=> String
resp.project.created_time #=> Time
resp.project.data_delivery.cloud_watch_logs.log_group #=> String
resp.project.data_delivery.s3_destination.bucket #=> String
resp.project.data_delivery.s3_destination.prefix #=> String
resp.project.description #=> String
resp.project.experiment_count #=> Integer
resp.project.feature_count #=> Integer
resp.project.last_updated_time #=> Time
resp.project.launch_count #=> Integer
resp.project.name #=> String
resp.project.status #=> String, one of "AVAILABLE", "UPDATING"
resp.project.tags #=> Hash
resp.project.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :app_config_resource (Types::ProjectAppConfigResourceConfig) —

    Use this parameter if the project will use client-side evaluation powered by AppConfig. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. allows you to

    This parameter is a structure that contains information about the AppConfig application that will be used for client-side evaluation.

  • :description (String) —

    An optional description of the project.

  • :project (required, String) —

    The name or ARN of the project to update.

Returns:

See Also:



3035
3036
3037
3038
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 3035

def update_project(params = {}, options = {})
  req = build_request(:update_project, params)
  req.send_request(options)
end

#update_project_data_delivery(params = {}) ⇒ Types::UpdateProjectDataDeliveryResponse

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.

Examples:

Request syntax with placeholder values


resp = client.update_project_data_delivery({
  cloud_watch_logs: {
    log_group: "CwLogGroupSafeName",
  },
  project: "ProjectRef", # required
  s3_destination: {
    bucket: "S3BucketSafeName",
    prefix: "S3PrefixSafeName",
  },
})

Response structure


resp.project.active_experiment_count #=> Integer
resp.project.active_launch_count #=> Integer
resp.project.app_config_resource.application_id #=> String
resp.project.app_config_resource.configuration_profile_id #=> String
resp.project.app_config_resource.environment_id #=> String
resp.project.arn #=> String
resp.project.created_time #=> Time
resp.project.data_delivery.cloud_watch_logs.log_group #=> String
resp.project.data_delivery.s3_destination.bucket #=> String
resp.project.data_delivery.s3_destination.prefix #=> String
resp.project.description #=> String
resp.project.experiment_count #=> Integer
resp.project.feature_count #=> Integer
resp.project.last_updated_time #=> Time
resp.project.launch_count #=> Integer
resp.project.name #=> String
resp.project.status #=> String, one of "AVAILABLE", "UPDATING"
resp.project.tags #=> Hash
resp.project.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cloud_watch_logs (Types::CloudWatchLogsDestinationConfig) —

    A structure containing the CloudWatch Logs log group where you want to store evaluation events.

  • :project (required, String) —

    The name or ARN of the project that you want to modify the data storage options for.

  • :s3_destination (Types::S3DestinationConfig) —

    A structure containing the S3 bucket name and bucket prefix where you want to store evaluation events.

Returns:

See Also:



3104
3105
3106
3107
 
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/client.rb', line 3104

def update_project_data_delivery(params = {}, options = {})
  req = build_request(:update_project_data_delivery, params)
  req.send_request(options)
end