CloudWatchEvidently

Client

class CloudWatchEvidently.Client

A low-level client representing Amazon CloudWatch Evidently

You can use Amazon CloudWatch Evidently to safely validate new features by serving them to a specified percentage of your users while you roll out the feature. You can monitor the performance of the new feature to help you decide when to ramp up traffic to your users. This helps you reduce risk and identify unintended consequences before you fully launch the feature.

You can also conduct A/B experiments to make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it using statistical methods. It also provides clear recommendations about which variations perform better. You can test both user-facing features and backend features.

client = session.create_client('evidently')

These are the available methods:

batch_evaluate_feature(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.batch_evaluate_feature(
    project='string',
    requests=[
        {
            'entityId': 'string',
            'evaluationContext': 'string',
            'feature': 'string'
        },
    ]
)
Parameters
  • project (string) --

    [REQUIRED]

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

  • requests (list) --

    [REQUIRED]

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

    • (dict) --

      This structure assigns a feature variation to one user session.

      • entityId (string) -- [REQUIRED]

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

      • evaluationContext (string) --

        A JSON block of attributes that you can optionally pass in. This JSON block is included in the evaluation events sent to Evidently from the user session.

      • feature (string) -- [REQUIRED]

        The name of the feature being evaluated.

Return type

dict

Returns

Response Syntax

{
    'results': [
        {
            'details': 'string',
            'entityId': 'string',
            'feature': 'string',
            'project': 'string',
            'reason': 'string',
            'value': {
                'boolValue': True|False,
                'doubleValue': 123.0,
                'longValue': 123,
                'stringValue': 'string'
            },
            'variation': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • results (list) --

      An array of structures, where each structure displays the results of one feature evaluation assignment to one user session.

      • (dict) --

        This structure displays the results of one feature evaluation assignment to one user session.

        • details (string) --

          If this user was assigned to a launch or experiment, this field lists the launch or experiment name.

        • entityId (string) --

          An internal ID that represents a unique user session of the application.

        • feature (string) --

          The name of the feature being evaluated.

        • project (string) --

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

        • reason (string) --

          Specifies the reason that the user session was assigned this variation. Possible values include DEFAULT , meaning the user was served the default variation; LAUNCH_RULE_MATCH , if the user session was enrolled in a launch; or EXPERIMENT_RULE_MATCH , if the user session was enrolled in an experiment.

        • value (dict) --

          The value assigned to this variation to differentiate it from the other variations of this feature.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: boolValue, doubleValue, longValue, stringValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • boolValue (boolean) --

            If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.

          • doubleValue (float) --

            If this feature uses the double integer variation type, this field contains the double integer value of this variation.

          • longValue (integer) --

            If this feature uses the long variation type, this field contains the long value of this variation.

          • stringValue (string) --

            If this feature uses the string variation type, this field contains the string value of this variation.

        • variation (string) --

          The name of the variation that was served to the user session.

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_experiment(**kwargs)

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.

Don't use this operation to update an existing experiment. Instead, use UpdateExperiment .

See also: AWS API Documentation

Request Syntax

response = client.create_experiment(
    description='string',
    metricGoals=[
        {
            'desiredChange': 'INCREASE'|'DECREASE',
            'metricDefinition': {
                'entityIdKey': 'string',
                'eventPattern': 'string',
                'name': 'string',
                'unitLabel': 'string',
                'valueKey': 'string'
            }
        },
    ],
    name='string',
    onlineAbConfig={
        'controlTreatmentName': 'string',
        'treatmentWeights': {
            'string': 123
        }
    },
    project='string',
    randomizationSalt='string',
    samplingRate=123,
    tags={
        'string': 'string'
    },
    treatments=[
        {
            'description': 'string',
            'feature': 'string',
            'name': 'string',
            'variation': 'string'
        },
    ]
)
Parameters
  • description (string) -- An optional description of the experiment.
  • metricGoals (list) --

    [REQUIRED]

    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.

    • (dict) --

      Use this structure to tell Evidently whether higher or lower values are desired for a metric that is used in an experiment.

      • desiredChange (string) --
        INCREASE means that a variation with a higher number for this metric is performing better.

        DECREASE means that a variation with a lower number for this metric is performing better.

      • metricDefinition (dict) -- [REQUIRED]

        A structure that contains details about the metric.

        • entityIdKey (string) -- [REQUIRED]

          The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is userDetails.userID .

        • eventPattern (string) --

          The EventBridge event pattern that defines how the metric is recorded.

          For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

        • name (string) -- [REQUIRED]

          A name for the metric.

        • unitLabel (string) --

          A label for the units that the metric is measuring.

        • valueKey (string) -- [REQUIRED]

          The value that is tracked to produce the metric.

  • name (string) --

    [REQUIRED]

    A name for the new experiment.

  • onlineAbConfig (dict) --

    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.

    • controlTreatmentName (string) --

      The name of the variation that is to be the default variation that the other variations are compared to.

    • treatmentWeights (dict) --

      A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

      • (string) --
        • (integer) --
  • project (string) --

    [REQUIRED]

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

  • randomizationSalt (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 .
  • samplingRate (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.

  • tags (dict) --

    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.

    <p>You can associate as many as 50 tags with an experiment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
    • (string) --
      • (string) --
  • treatments (list) --

    [REQUIRED]

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

    • (dict) --

      A structure that defines one treatment in an experiment. A treatment is a variation of the feature that you are including in the experiment.

      • description (string) --

        A description for this treatment.

      • feature (string) -- [REQUIRED]

        The feature that this experiment is testing.

      • name (string) -- [REQUIRED]

        A name for this treatment.

      • variation (string) -- [REQUIRED]

        The name of the variation to use as this treatment in the experiment.

Return type

dict

Returns

Response Syntax

{
    'experiment': {
        'arn': 'string',
        'createdTime': datetime(2015, 1, 1),
        'description': 'string',
        'execution': {
            'endedTime': datetime(2015, 1, 1),
            'startedTime': datetime(2015, 1, 1)
        },
        'lastUpdatedTime': datetime(2015, 1, 1),
        'metricGoals': [
            {
                'desiredChange': 'INCREASE'|'DECREASE',
                'metricDefinition': {
                    'entityIdKey': 'string',
                    'eventPattern': 'string',
                    'name': 'string',
                    'unitLabel': 'string',
                    'valueKey': 'string'
                }
            },
        ],
        'name': 'string',
        'onlineAbDefinition': {
            'controlTreatmentName': 'string',
            'treatmentWeights': {
                'string': 123
            }
        },
        'project': 'string',
        'randomizationSalt': 'string',
        'samplingRate': 123,
        'schedule': {
            'analysisCompleteTime': datetime(2015, 1, 1)
        },
        'status': 'CREATED'|'UPDATING'|'RUNNING'|'COMPLETED'|'CANCELLED',
        'statusReason': 'string',
        'tags': {
            'string': 'string'
        },
        'treatments': [
            {
                'description': 'string',
                'featureVariations': {
                    'string': 'string'
                },
                'name': 'string'
            },
        ],
        'type': 'aws.evidently.onlineab'
    }
}

Response Structure

  • (dict) --

    • experiment (dict) --

      A structure containing the configuration details of the experiment that you created.

      • arn (string) --

        The ARN of the experiment.

      • createdTime (datetime) --

        The date and time that the experiment is first created.

      • description (string) --

        A description of the experiment.

      • execution (dict) --

        A structure that contains the date and time that the experiment started and ended.

        • endedTime (datetime) --

          The date and time that the experiment ended.

        • startedTime (datetime) --

          The date and time that the experiment started.

      • lastUpdatedTime (datetime) --

        The date and time that the experiment was most recently updated.

      • metricGoals (list) --

        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.

        • (dict) --

          A structure that tells Evidently whether higher or lower values are desired for a metric that is used in an experiment.

          • desiredChange (string) --

            INCREASE means that a variation with a higher number for this metric is performing better.

            DECREASE means that a variation with a lower number for this metric is performing better.

          • metricDefinition (dict) --

            A structure that contains details about the metric.

            • entityIdKey (string) --

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern (string) --

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

            • name (string) --

              The name of the metric.

            • unitLabel (string) --

              The label for the units that the metric is measuring.

            • valueKey (string) --

              The value that is tracked to produce the metric.

      • name (string) --

        The name of the experiment.

      • onlineAbDefinition (dict) --

        A structure that contains the configuration of which variation to 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.

        • controlTreatmentName (string) --

          The name of the variation that is the default variation that the other variations are compared to.

        • treatmentWeights (dict) --

          A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. The traffic portion is specified in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

          • (string) --
            • (integer) --
      • project (string) --

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

      • randomizationSalt (string) --

        This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt .

      • samplingRate (integer) --

        In thousandths of a percent, the amount of the available audience that is allocated to this experiment. 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, so a value of 10,000 is 10% of the available audience.

      • schedule (dict) --

        A structure that contains the time and date that Evidently completed the analysis of the experiment.

        • analysisCompleteTime (datetime) --

          The time and date that Evidently completed the analysis of the experiment.

      • status (string) --

        The current state of the experiment.

      • statusReason (string) --

        If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

      • tags (dict) --

        The list of tag keys and values associated with this experiment.

        • (string) --
          • (string) --
      • treatments (list) --

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

        • (dict) --

          A structure that defines one treatment in an experiment. A treatment is a variation of the feature that you are including in the experiment.

          • description (string) --

            The description of the treatment.

          • featureVariations (dict) --

            The feature variation used for this treatment. This is a key-value pair. The key is the feature name, and the value is the variation name.

            • (string) --
              • (string) --
          • name (string) --

            The name of this treatment.

      • type (string) --

        The type of this experiment. Currently, this value must be aws.experiment.onlineab .

Exceptions

create_feature(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.create_feature(
    defaultVariation='string',
    description='string',
    entityOverrides={
        'string': 'string'
    },
    evaluationStrategy='ALL_RULES'|'DEFAULT_VARIATION',
    name='string',
    project='string',
    tags={
        'string': 'string'
    },
    variations=[
        {
            'name': 'string',
            'value': {
                'boolValue': True|False,
                'doubleValue': 123.0,
                'longValue': 123,
                'stringValue': 'string'
            }
        },
    ]
)
Parameters
  • defaultVariation (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.
  • entityOverrides (dict) --

    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.

    • (string) --
      • (string) --
  • evaluationStrategy (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 (string) --

    [REQUIRED]

    The name for the new feature.

  • project (string) --

    [REQUIRED]

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

  • tags (dict) --

    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.

    <p>You can associate as many as 50 tags with a feature.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
    • (string) --
      • (string) --
  • variations (list) --

    [REQUIRED]

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

    • (dict) --

      This structure contains the name and variation value of one variation of a feature.

      • name (string) -- [REQUIRED]

        The name of the variation.

      • value (dict) -- [REQUIRED]

        The value assigned to this variation.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: boolValue, doubleValue, longValue, stringValue.

        • boolValue (boolean) --

          If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.

        • doubleValue (float) --

          If this feature uses the double integer variation type, this field contains the double integer value of this variation.

        • longValue (integer) --

          If this feature uses the long variation type, this field contains the long value of this variation.

        • stringValue (string) --

          If this feature uses the string variation type, this field contains the string value of this variation.

Return type

dict

Returns

Response Syntax

{
    'feature': {
        'arn': 'string',
        'createdTime': datetime(2015, 1, 1),
        'defaultVariation': 'string',
        'description': 'string',
        'entityOverrides': {
            'string': 'string'
        },
        'evaluationRules': [
            {
                'name': 'string',
                'type': 'string'
            },
        ],
        'evaluationStrategy': 'ALL_RULES'|'DEFAULT_VARIATION',
        'lastUpdatedTime': datetime(2015, 1, 1),
        'name': 'string',
        'project': 'string',
        'status': 'AVAILABLE'|'UPDATING',
        'tags': {
            'string': 'string'
        },
        'valueType': 'STRING'|'LONG'|'DOUBLE'|'BOOLEAN',
        'variations': [
            {
                'name': 'string',
                'value': {
                    'boolValue': True|False,
                    'doubleValue': 123.0,
                    'longValue': 123,
                    'stringValue': 'string'
                }
            },
        ]
    }
}

Response Structure

  • (dict) --

    • feature (dict) --

      A structure that contains information about the new feature.

      • arn (string) --

        The ARN of the feature.

      • createdTime (datetime) --

        The date and time that the feature is created.

      • defaultVariation (string) --

        The name of the variation that is used 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) --

        The description of the feature.

      • entityOverrides (dict) --

        A set of key-value pairs that specify users who should always be served a specific variation of a feature. Each key specifies a user using their user ID, account ID, or some other identifier. The value specifies the name of the variation that the user is to be served.

        For the override to be successful, the value of the key must match the entityId used in the EvaluateFeature operation.

        • (string) --
          • (string) --
      • evaluationRules (list) --

        An array of structures that define the evaluation rules for the feature.

        • (dict) --

          A structure that contains the information about an evaluation rule for this feature, if it is used in a launch or experiment.

          • name (string) --

            The name of the experiment or launch.

          • type (string) --

            This value is aws.evidently.splits if this is an evaluation rule for a launch, and it is aws.evidently.onlineab if this is an evaluation rule for an experiment.

      • evaluationStrategy (string) --

        If this value is ALL_RULES , the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION , the default variation is being served to all users.

      • lastUpdatedTime (datetime) --

        The date and time that the feature was most recently updated.

      • name (string) --

        The name of the feature.

      • project (string) --

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

      • status (string) --

        The current state of the feature.

      • tags (dict) --

        The list of tag keys and values associated with this feature.

        • (string) --
          • (string) --
      • valueType (string) --

        Defines the type of value used to define the different feature variations. For more information, see Variation types

      • variations (list) --

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

        • (dict) --

          This structure contains the name and variation value of one variation of a feature.

          • name (string) --

            The name of the variation.

          • value (dict) --

            The value assigned to this variation.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: boolValue, doubleValue, longValue, stringValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            
            • boolValue (boolean) --

              If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.

            • doubleValue (float) --

              If this feature uses the double integer variation type, this field contains the double integer value of this variation.

            • longValue (integer) --

              If this feature uses the long variation type, this field contains the long value of this variation.

            • stringValue (string) --

              If this feature uses the string variation type, this field contains the string value of this variation.

Exceptions

create_launch(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.create_launch(
    description='string',
    groups=[
        {
            'description': 'string',
            'feature': 'string',
            'name': 'string',
            'variation': 'string'
        },
    ],
    metricMonitors=[
        {
            'metricDefinition': {
                'entityIdKey': 'string',
                'eventPattern': 'string',
                'name': 'string',
                'unitLabel': 'string',
                'valueKey': 'string'
            }
        },
    ],
    name='string',
    project='string',
    randomizationSalt='string',
    scheduledSplitsConfig={
        'steps': [
            {
                'groupWeights': {
                    'string': 123
                },
                'startTime': datetime(2015, 1, 1)
            },
        ]
    },
    tags={
        'string': 'string'
    }
)
Parameters
  • description (string) -- An optional description for the launch.
  • groups (list) --

    [REQUIRED]

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

    • (dict) --

      A structure that defines one launch group in a launch. A launch group is a variation of the feature that you are including in the launch.

      • description (string) --

        A description of the launch group.

      • feature (string) -- [REQUIRED]

        The feature that this launch is using.

      • name (string) -- [REQUIRED]

        A name for this launch group.

      • variation (string) -- [REQUIRED]

        The feature variation to use for this launch group.

  • metricMonitors (list) --

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

    • (dict) --

      A structure that defines a metric to be used to monitor performance of the variations during a launch.

      • metricDefinition (dict) -- [REQUIRED]

        A structure that defines the metric.

        • entityIdKey (string) -- [REQUIRED]

          The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is userDetails.userID .

        • eventPattern (string) --

          The EventBridge event pattern that defines how the metric is recorded.

          For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

        • name (string) -- [REQUIRED]

          A name for the metric.

        • unitLabel (string) --

          A label for the units that the metric is measuring.

        • valueKey (string) -- [REQUIRED]

          The value that is tracked to produce the metric.

  • name (string) --

    [REQUIRED]

    The name for the new launch.

  • project (string) --

    [REQUIRED]

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

  • randomizationSalt (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 randomizationsSalt .
  • scheduledSplitsConfig (dict) --

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

    • steps (list) -- [REQUIRED]

      An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

      • (dict) --

        This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.

        • groupWeights (dict) -- [REQUIRED]

          The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

          • (string) --
            • (integer) --
        • startTime (datetime) -- [REQUIRED]

          The date and time that this step of the launch starts.

  • tags (dict) --

    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.

    <p>You can associate as many as 50 tags with a launch.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'launch': {
        'arn': 'string',
        'createdTime': datetime(2015, 1, 1),
        'description': 'string',
        'execution': {
            'endedTime': datetime(2015, 1, 1),
            'startedTime': datetime(2015, 1, 1)
        },
        'groups': [
            {
                'description': 'string',
                'featureVariations': {
                    'string': 'string'
                },
                'name': 'string'
            },
        ],
        'lastUpdatedTime': datetime(2015, 1, 1),
        'metricMonitors': [
            {
                'metricDefinition': {
                    'entityIdKey': 'string',
                    'eventPattern': 'string',
                    'name': 'string',
                    'unitLabel': 'string',
                    'valueKey': 'string'
                }
            },
        ],
        'name': 'string',
        'project': 'string',
        'randomizationSalt': 'string',
        'scheduledSplitsDefinition': {
            'steps': [
                {
                    'groupWeights': {
                        'string': 123
                    },
                    'startTime': datetime(2015, 1, 1)
                },
            ]
        },
        'status': 'CREATED'|'UPDATING'|'RUNNING'|'COMPLETED'|'CANCELLED',
        'statusReason': 'string',
        'tags': {
            'string': 'string'
        },
        'type': 'aws.evidently.splits'
    }
}

Response Structure

  • (dict) --

    • launch (dict) --

      A structure that contains the configuration of the launch that was created.

      • arn (string) --

        The ARN of the launch.

      • createdTime (datetime) --

        The date and time that the launch is created.

      • description (string) --

        The description of the launch.

      • execution (dict) --

        A structure that contains information about the start and end times of the launch.

        • endedTime (datetime) --

          The date and time that the launch ended.

        • startedTime (datetime) --

          The date and time that the launch started.

      • groups (list) --

        An array of structures that define the feature variations that are being used in the launch.

        • (dict) --

          A structure that defines one launch group in a launch. A launch group is a variation of the feature that you are including in the launch.

          • description (string) --

            A description of the launch group.

          • featureVariations (dict) --

            The feature variation for this launch group. This is a key-value pair.

            • (string) --
              • (string) --
          • name (string) --

            The name of the launch group.

      • lastUpdatedTime (datetime) --

        The date and time that the launch was most recently updated.

      • metricMonitors (list) --

        An array of structures that define the metrics that are being used to monitor the launch performance.

        • (dict) --

          A structure that defines a metric to be used to monitor performance of the variations during a launch.

          • metricDefinition (dict) --

            A structure that defines the metric.

            • entityIdKey (string) --

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern (string) --

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

            • name (string) --

              The name of the metric.

            • unitLabel (string) --

              The label for the units that the metric is measuring.

            • valueKey (string) --

              The value that is tracked to produce the metric.

      • name (string) --

        The name of the launch.

      • project (string) --

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

      • randomizationSalt (string) --

        This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt .

      • scheduledSplitsDefinition (dict) --

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

        • steps (list) --

          An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

          • (dict) --

            This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.

            • groupWeights (dict) --

              The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

              • (string) --
                • (integer) --
            • startTime (datetime) --

              The date and time that this step of the launch starts.

      • status (string) --

        The current state of the launch.

      • statusReason (string) --

        If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.

      • tags (dict) --

        The list of tag keys and values associated with this launch.

        • (string) --
          • (string) --
      • type (string) --

        The type of launch.

Exceptions

create_project(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.create_project(
    dataDelivery={
        'cloudWatchLogs': {
            'logGroup': 'string'
        },
        's3Destination': {
            'bucket': 'string',
            'prefix': 'string'
        }
    },
    description='string',
    name='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • dataDelivery (dict) --

    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.

    • cloudWatchLogs (dict) --

      If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.

      • logGroup (string) --

        The name of the log group where the project stores evaluation events.

    • s3Destination (dict) --

      If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

      • bucket (string) --

        The name of the bucket in which Evidently stores evaluation events.

      • prefix (string) --

        The bucket prefix in which Evidently stores evaluation events.

  • description (string) -- An optional description of the project.
  • name (string) --

    [REQUIRED]

    The name for the project.

  • tags (dict) --

    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.

    <p>You can associate as many as 50 tags with a project.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'project': {
        'activeExperimentCount': 123,
        'activeLaunchCount': 123,
        'arn': 'string',
        'createdTime': datetime(2015, 1, 1),
        'dataDelivery': {
            'cloudWatchLogs': {
                'logGroup': 'string'
            },
            's3Destination': {
                'bucket': 'string',
                'prefix': 'string'
            }
        },
        'description': 'string',
        'experimentCount': 123,
        'featureCount': 123,
        'lastUpdatedTime': datetime(2015, 1, 1),
        'launchCount': 123,
        'name': 'string',
        'status': 'AVAILABLE'|'UPDATING',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • project (dict) --

      A structure that contains information about the created project.

      • activeExperimentCount (integer) --

        The number of ongoing experiments currently in the project.

      • activeLaunchCount (integer) --

        The number of ongoing launches currently in the project.

      • arn (string) --

        The name or ARN of the project.

      • createdTime (datetime) --

        The date and time that the project is created.

      • dataDelivery (dict) --

        A structure that contains information about where Evidently is to store evaluation events for longer term storage.

        • cloudWatchLogs (dict) --

          If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.

          • logGroup (string) --

            The name of the log group where the project stores evaluation events.

        • s3Destination (dict) --

          If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

          • bucket (string) --

            The name of the bucket in which Evidently stores evaluation events.

          • prefix (string) --

            The bucket prefix in which Evidently stores evaluation events.

      • description (string) --

        The user-entered description of the project.

      • experimentCount (integer) --

        The number of experiments currently in the project. This includes all experiments that have been created and not deleted, whether they are ongoing or not.

      • featureCount (integer) --

        The number of features currently in the project.

      • lastUpdatedTime (datetime) --

        The date and time that the project was most recently updated.

      • launchCount (integer) --

        The number of launches currently in the project. This includes all launches that have been created and not deleted, whether they are ongoing or not.

      • name (string) --

        The name of the project.

      • status (string) --

        The current state of the project.

      • tags (dict) --

        The list of tag keys and values associated with this project.

        • (string) --
          • (string) --

Exceptions

delete_experiment(**kwargs)

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

To stop an experiment without deleting it, use StopExperiment .

See also: AWS API Documentation

Request Syntax

response = client.delete_experiment(
    experiment='string',
    project='string'
)
Parameters
  • experiment (string) --

    [REQUIRED]

    The name of the experiment to delete.

  • project (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_feature(**kwargs)

Deletes an Evidently feature.

See also: AWS API Documentation

Request Syntax

response = client.delete_feature(
    feature='string',
    project='string'
)
Parameters
  • feature (string) --

    [REQUIRED]

    The name of the feature to delete.

  • project (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_launch(**kwargs)

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

To stop a launch without deleting it, use StopLaunch .

See also: AWS API Documentation

Request Syntax

response = client.delete_launch(
    launch='string',
    project='string'
)
Parameters
  • launch (string) --

    [REQUIRED]

    The name of the launch to delete.

  • project (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_project(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.delete_project(
    project='string'
)
Parameters
project (string) --

[REQUIRED]

The name or ARN of the project to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

evaluate_feature(**kwargs)

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.

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.

See also: AWS API Documentation

Request Syntax

response = client.evaluate_feature(
    entityId='string',
    evaluationContext='string',
    feature='string',
    project='string'
)
Parameters
  • entityId (string) --

    [REQUIRED]

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

  • evaluationContext (string) -- A JSON block of attributes that you can optionally pass in. This JSON block is included in the evaluation events sent to Evidently from the user session.
  • feature (string) --

    [REQUIRED]

    The name of the feature being evaluated.

  • project (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'details': 'string',
    'reason': 'string',
    'value': {
        'boolValue': True|False,
        'doubleValue': 123.0,
        'longValue': 123,
        'stringValue': 'string'
    },
    'variation': 'string'
}

Response Structure

  • (dict) --

    • details (string) --

      If this user was assigned to a launch or experiment, this field lists the launch or experiment name.

    • reason (string) --

      Specifies the reason that the user session was assigned this variation. Possible values include DEFAULT , meaning the user was served the default variation; LAUNCH_RULE_MATCH , if the user session was enrolled in a launch; EXPERIMENT_RULE_MATCH , if the user session was enrolled in an experiment; or ENTITY_OVERRIDES_MATCH , if the user's entityId matches an override rule.

    • value (dict) --

      The value assigned to this variation to differentiate it from the other variations of this feature.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: boolValue, doubleValue, longValue, stringValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      
      • boolValue (boolean) --

        If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.

      • doubleValue (float) --

        If this feature uses the double integer variation type, this field contains the double integer value of this variation.

      • longValue (integer) --

        If this feature uses the long variation type, this field contains the long value of this variation.

      • stringValue (string) --

        If this feature uses the string variation type, this field contains the string value of this variation.

    • variation (string) --

      The name of the variation that was served to the user session.

Exceptions

get_experiment(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_experiment(
    experiment='string',
    project='string'
)
Parameters
  • experiment (string) --

    [REQUIRED]

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

  • project (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'experiment': {
        'arn': 'string',
        'createdTime': datetime(2015, 1, 1),
        'description': 'string',
        'execution': {
            'endedTime': datetime(2015, 1, 1),
            'startedTime': datetime(2015, 1, 1)
        },
        'lastUpdatedTime': datetime(2015, 1, 1),
        'metricGoals': [
            {
                'desiredChange': 'INCREASE'|'DECREASE',
                'metricDefinition': {
                    'entityIdKey': 'string',
                    'eventPattern': 'string',
                    'name': 'string',
                    'unitLabel': 'string',
                    'valueKey': 'string'
                }
            },
        ],
        'name': 'string',
        'onlineAbDefinition': {
            'controlTreatmentName': 'string',
            'treatmentWeights': {
                'string': 123
            }
        },
        'project': 'string',
        'randomizationSalt': 'string',
        'samplingRate': 123,
        'schedule': {
            'analysisCompleteTime': datetime(2015, 1, 1)
        },
        'status': 'CREATED'|'UPDATING'|'RUNNING'|'COMPLETED'|'CANCELLED',
        'statusReason': 'string',
        'tags': {
            'string': 'string'
        },
        'treatments': [
            {
                'description': 'string',
                'featureVariations': {
                    'string': 'string'
                },
                'name': 'string'
            },
        ],
        'type': 'aws.evidently.onlineab'
    }
}

Response Structure

  • (dict) --

    • experiment (dict) --

      A structure containing the configuration details of the experiment.

      • arn (string) --

        The ARN of the experiment.

      • createdTime (datetime) --

        The date and time that the experiment is first created.

      • description (string) --

        A description of the experiment.

      • execution (dict) --

        A structure that contains the date and time that the experiment started and ended.

        • endedTime (datetime) --

          The date and time that the experiment ended.

        • startedTime (datetime) --

          The date and time that the experiment started.

      • lastUpdatedTime (datetime) --

        The date and time that the experiment was most recently updated.

      • metricGoals (list) --

        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.

        • (dict) --

          A structure that tells Evidently whether higher or lower values are desired for a metric that is used in an experiment.

          • desiredChange (string) --

            INCREASE means that a variation with a higher number for this metric is performing better.

            DECREASE means that a variation with a lower number for this metric is performing better.

          • metricDefinition (dict) --

            A structure that contains details about the metric.

            • entityIdKey (string) --

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern (string) --

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

            • name (string) --

              The name of the metric.

            • unitLabel (string) --

              The label for the units that the metric is measuring.

            • valueKey (string) --

              The value that is tracked to produce the metric.

      • name (string) --

        The name of the experiment.

      • onlineAbDefinition (dict) --

        A structure that contains the configuration of which variation to 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.

        • controlTreatmentName (string) --

          The name of the variation that is the default variation that the other variations are compared to.

        • treatmentWeights (dict) --

          A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. The traffic portion is specified in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

          • (string) --
            • (integer) --
      • project (string) --

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

      • randomizationSalt (string) --

        This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt .

      • samplingRate (integer) --

        In thousandths of a percent, the amount of the available audience that is allocated to this experiment. 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, so a value of 10,000 is 10% of the available audience.

      • schedule (dict) --

        A structure that contains the time and date that Evidently completed the analysis of the experiment.

        • analysisCompleteTime (datetime) --

          The time and date that Evidently completed the analysis of the experiment.

      • status (string) --

        The current state of the experiment.

      • statusReason (string) --

        If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

      • tags (dict) --

        The list of tag keys and values associated with this experiment.

        • (string) --
          • (string) --
      • treatments (list) --

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

        • (dict) --

          A structure that defines one treatment in an experiment. A treatment is a variation of the feature that you are including in the experiment.

          • description (string) --

            The description of the treatment.

          • featureVariations (dict) --

            The feature variation used for this treatment. This is a key-value pair. The key is the feature name, and the value is the variation name.

            • (string) --
              • (string) --
          • name (string) --

            The name of this treatment.

      • type (string) --

        The type of this experiment. Currently, this value must be aws.experiment.onlineab .

Exceptions

get_experiment_results(**kwargs)

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.

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.

See also: AWS API Documentation

Request Syntax

response = client.get_experiment_results(
    baseStat='Mean',
    endTime=datetime(2015, 1, 1),
    experiment='string',
    metricNames=[
        'string',
    ],
    period=123,
    project='string',
    reportNames=[
        'BayesianInference',
    ],
    resultStats=[
        'BaseStat'|'TreatmentEffect'|'ConfidenceInterval'|'PValue',
    ],
    startTime=datetime(2015, 1, 1),
    treatmentNames=[
        'string',
    ]
)
Parameters
  • baseStat (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.
  • endTime (datetime) -- 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 (string) --

    [REQUIRED]

    The name of the experiment to retrieve the results of.

  • metricNames (list) --

    [REQUIRED]

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

    • (string) --
  • period (integer) -- In seconds, the amount of time to aggregate results together.
  • project (string) --

    [REQUIRED]

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

  • reportNames (list) --

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

    • (string) --
  • resultStats (list) --

    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.
    • (string) --
  • startTime (datetime) -- The date and time that the experiment started.
  • treatmentNames (list) --

    [REQUIRED]

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

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'details': 'string',
    'reports': [
        {
            'content': 'string',
            'metricName': 'string',
            'reportName': 'BayesianInference',
            'treatmentName': 'string'
        },
    ],
    'resultsData': [
        {
            'metricName': 'string',
            'resultStat': 'Mean'|'TreatmentEffect'|'ConfidenceIntervalUpperBound'|'ConfidenceIntervalLowerBound'|'PValue',
            'treatmentName': 'string',
            'values': [
                123.0,
            ]
        },
    ],
    'timestamps': [
        datetime(2015, 1, 1),
    ]
}

Response Structure

  • (dict) --

    • details (string) --

      If the experiment doesn't yet have enough events to provide valid results, this field is returned with the message Not enough events to generate results . If there are enough events to provide valid results, this field is not returned.

    • reports (list) --

      An array of structures that include the reports that you requested.

      • (dict) --

        A structure that contains results of an experiment.

        • content (string) --

          The content of the report.

        • metricName (string) --

          The name of the metric that is analyzed in this experiment report.

        • reportName (string) --

          The type of analysis used for this report.

        • treatmentName (string) --

          The name of the variation that this report pertains to.

    • resultsData (list) --

      An array of structures that include experiment results including metric names and values.

      • (dict) --

        A structure that contains experiment results for one metric that is monitored in the experiment.

        • metricName (string) --

          The name of the metric.

        • resultStat (string) --

          The experiment statistic that these results pertain to.

        • treatmentName (string) --

          The treatment, or variation, that returned the values in this structure.

        • values (list) --

          The values for the metricName that were recorded in the experiment.

          • (float) --
    • timestamps (list) --

      The timestamps of each result returned.

      • (datetime) --

Exceptions

get_feature(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_feature(
    feature='string',
    project='string'
)
Parameters
  • feature (string) --

    [REQUIRED]

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

  • project (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'feature': {
        'arn': 'string',
        'createdTime': datetime(2015, 1, 1),
        'defaultVariation': 'string',
        'description': 'string',
        'entityOverrides': {
            'string': 'string'
        },
        'evaluationRules': [
            {
                'name': 'string',
                'type': 'string'
            },
        ],
        'evaluationStrategy': 'ALL_RULES'|'DEFAULT_VARIATION',
        'lastUpdatedTime': datetime(2015, 1, 1),
        'name': 'string',
        'project': 'string',
        'status': 'AVAILABLE'|'UPDATING',
        'tags': {
            'string': 'string'
        },
        'valueType': 'STRING'|'LONG'|'DOUBLE'|'BOOLEAN',
        'variations': [
            {
                'name': 'string',
                'value': {
                    'boolValue': True|False,
                    'doubleValue': 123.0,
                    'longValue': 123,
                    'stringValue': 'string'
                }
            },
        ]
    }
}

Response Structure

  • (dict) --

    • feature (dict) --

      A structure containing the configuration details of the feature.

      • arn (string) --

        The ARN of the feature.

      • createdTime (datetime) --

        The date and time that the feature is created.

      • defaultVariation (string) --

        The name of the variation that is used 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) --

        The description of the feature.

      • entityOverrides (dict) --

        A set of key-value pairs that specify users who should always be served a specific variation of a feature. Each key specifies a user using their user ID, account ID, or some other identifier. The value specifies the name of the variation that the user is to be served.

        For the override to be successful, the value of the key must match the entityId used in the EvaluateFeature operation.

        • (string) --
          • (string) --
      • evaluationRules (list) --

        An array of structures that define the evaluation rules for the feature.

        • (dict) --

          A structure that contains the information about an evaluation rule for this feature, if it is used in a launch or experiment.

          • name (string) --

            The name of the experiment or launch.

          • type (string) --

            This value is aws.evidently.splits if this is an evaluation rule for a launch, and it is aws.evidently.onlineab if this is an evaluation rule for an experiment.

      • evaluationStrategy (string) --

        If this value is ALL_RULES , the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION , the default variation is being served to all users.

      • lastUpdatedTime (datetime) --

        The date and time that the feature was most recently updated.

      • name (string) --

        The name of the feature.

      • project (string) --

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

      • status (string) --

        The current state of the feature.

      • tags (dict) --

        The list of tag keys and values associated with this feature.

        • (string) --
          • (string) --
      • valueType (string) --

        Defines the type of value used to define the different feature variations. For more information, see Variation types

      • variations (list) --

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

        • (dict) --

          This structure contains the name and variation value of one variation of a feature.

          • name (string) --

            The name of the variation.

          • value (dict) --

            The value assigned to this variation.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: boolValue, doubleValue, longValue, stringValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            
            • boolValue (boolean) --

              If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.

            • doubleValue (float) --

              If this feature uses the double integer variation type, this field contains the double integer value of this variation.

            • longValue (integer) --

              If this feature uses the long variation type, this field contains the long value of this variation.

            • stringValue (string) --

              If this feature uses the string variation type, this field contains the string value of this variation.

Exceptions

get_launch(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_launch(
    launch='string',
    project='string'
)
Parameters
  • launch (string) --

    [REQUIRED]

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

  • project (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'launch': {
        'arn': 'string',
        'createdTime': datetime(2015, 1, 1),
        'description': 'string',
        'execution': {
            'endedTime': datetime(2015, 1, 1),
            'startedTime': datetime(2015, 1, 1)
        },
        'groups': [
            {
                'description': 'string',
                'featureVariations': {
                    'string': 'string'
                },
                'name': 'string'
            },
        ],
        'lastUpdatedTime': datetime(2015, 1, 1),
        'metricMonitors': [
            {
                'metricDefinition': {
                    'entityIdKey': 'string',
                    'eventPattern': 'string',
                    'name': 'string',
                    'unitLabel': 'string',
                    'valueKey': 'string'
                }
            },
        ],
        'name': 'string',
        'project': 'string',
        'randomizationSalt': 'string',
        'scheduledSplitsDefinition': {
            'steps': [
                {
                    'groupWeights': {
                        'string': 123
                    },
                    'startTime': datetime(2015, 1, 1)
                },
            ]
        },
        'status': 'CREATED'|'UPDATING'|'RUNNING'|'COMPLETED'|'CANCELLED',
        'statusReason': 'string',
        'tags': {
            'string': 'string'
        },
        'type': 'aws.evidently.splits'
    }
}

Response Structure

  • (dict) --

    • launch (dict) --

      A structure containing the configuration details of the launch.

      • arn (string) --

        The ARN of the launch.

      • createdTime (datetime) --

        The date and time that the launch is created.

      • description (string) --

        The description of the launch.

      • execution (dict) --

        A structure that contains information about the start and end times of the launch.

        • endedTime (datetime) --

          The date and time that the launch ended.

        • startedTime (datetime) --

          The date and time that the launch started.

      • groups (list) --

        An array of structures that define the feature variations that are being used in the launch.

        • (dict) --

          A structure that defines one launch group in a launch. A launch group is a variation of the feature that you are including in the launch.

          • description (string) --

            A description of the launch group.

          • featureVariations (dict) --

            The feature variation for this launch group. This is a key-value pair.

            • (string) --
              • (string) --
          • name (string) --

            The name of the launch group.

      • lastUpdatedTime (datetime) --

        The date and time that the launch was most recently updated.

      • metricMonitors (list) --

        An array of structures that define the metrics that are being used to monitor the launch performance.

        • (dict) --

          A structure that defines a metric to be used to monitor performance of the variations during a launch.

          • metricDefinition (dict) --

            A structure that defines the metric.

            • entityIdKey (string) --

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern (string) --

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

            • name (string) --

              The name of the metric.

            • unitLabel (string) --

              The label for the units that the metric is measuring.

            • valueKey (string) --

              The value that is tracked to produce the metric.

      • name (string) --

        The name of the launch.

      • project (string) --

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

      • randomizationSalt (string) --

        This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt .

      • scheduledSplitsDefinition (dict) --

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

        • steps (list) --

          An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

          • (dict) --

            This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.

            • groupWeights (dict) --

              The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

              • (string) --
                • (integer) --
            • startTime (datetime) --

              The date and time that this step of the launch starts.

      • status (string) --

        The current state of the launch.

      • statusReason (string) --

        If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.

      • tags (dict) --

        The list of tag keys and values associated with this launch.

        • (string) --
          • (string) --
      • type (string) --

        The type of launch.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_project(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_project(
    project='string'
)
Parameters
project (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'project': {
        'activeExperimentCount': 123,
        'activeLaunchCount': 123,
        'arn': 'string',
        'createdTime': datetime(2015, 1, 1),
        'dataDelivery': {
            'cloudWatchLogs': {
                'logGroup': 'string'
            },
            's3Destination': {
                'bucket': 'string',
                'prefix': 'string'
            }
        },
        'description': 'string',
        'experimentCount': 123,
        'featureCount': 123,
        'lastUpdatedTime': datetime(2015, 1, 1),
        'launchCount': 123,
        'name': 'string',
        'status': 'AVAILABLE'|'UPDATING',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • project (dict) --

      A structure containing the configuration details of the project.

      • activeExperimentCount (integer) --

        The number of ongoing experiments currently in the project.

      • activeLaunchCount (integer) --

        The number of ongoing launches currently in the project.

      • arn (string) --

        The name or ARN of the project.

      • createdTime (datetime) --

        The date and time that the project is created.

      • dataDelivery (dict) --

        A structure that contains information about where Evidently is to store evaluation events for longer term storage.

        • cloudWatchLogs (dict) --

          If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.

          • logGroup (string) --

            The name of the log group where the project stores evaluation events.

        • s3Destination (dict) --

          If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

          • bucket (string) --

            The name of the bucket in which Evidently stores evaluation events.

          • prefix (string) --

            The bucket prefix in which Evidently stores evaluation events.

      • description (string) --

        The user-entered description of the project.

      • experimentCount (integer) --

        The number of experiments currently in the project. This includes all experiments that have been created and not deleted, whether they are ongoing or not.

      • featureCount (integer) --

        The number of features currently in the project.

      • lastUpdatedTime (datetime) --

        The date and time that the project was most recently updated.

      • launchCount (integer) --

        The number of launches currently in the project. This includes all launches that have been created and not deleted, whether they are ongoing or not.

      • name (string) --

        The name of the project.

      • status (string) --

        The current state of the project.

      • tags (dict) --

        The list of tag keys and values associated with this project.

        • (string) --
          • (string) --

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_experiments(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_experiments(
    maxResults=123,
    nextToken='string',
    project='string',
    status='CREATED'|'UPDATING'|'RUNNING'|'COMPLETED'|'CANCELLED'
)
Parameters
  • maxResults (integer) -- The maximum number of results to include in the response.
  • nextToken (string) -- The token to use when requesting the next set of results. You received this token from a previous ListExperiments operation.
  • project (string) --

    [REQUIRED]

    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.
Return type

dict

Returns

Response Syntax

{
    'experiments': [
        {
            'arn': 'string',
            'createdTime': datetime(2015, 1, 1),
            'description': 'string',
            'execution': {
                'endedTime': datetime(2015, 1, 1),
                'startedTime': datetime(2015, 1, 1)
            },
            'lastUpdatedTime': datetime(2015, 1, 1),
            'metricGoals': [
                {
                    'desiredChange': 'INCREASE'|'DECREASE',
                    'metricDefinition': {
                        'entityIdKey': 'string',
                        'eventPattern': 'string',
                        'name': 'string',
                        'unitLabel': 'string',
                        'valueKey': 'string'
                    }
                },
            ],
            'name': 'string',
            'onlineAbDefinition': {
                'controlTreatmentName': 'string',
                'treatmentWeights': {
                    'string': 123
                }
            },
            'project': 'string',
            'randomizationSalt': 'string',
            'samplingRate': 123,
            'schedule': {
                'analysisCompleteTime': datetime(2015, 1, 1)
            },
            'status': 'CREATED'|'UPDATING'|'RUNNING'|'COMPLETED'|'CANCELLED',
            'statusReason': 'string',
            'tags': {
                'string': 'string'
            },
            'treatments': [
                {
                    'description': 'string',
                    'featureVariations': {
                        'string': 'string'
                    },
                    'name': 'string'
                },
            ],
            'type': 'aws.evidently.onlineab'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • experiments (list) --

      An array of structures that contain the configuration details of the experiments in the specified project.

      • (dict) --

        A structure containing the configuration details of an experiment.

        • arn (string) --

          The ARN of the experiment.

        • createdTime (datetime) --

          The date and time that the experiment is first created.

        • description (string) --

          A description of the experiment.

        • execution (dict) --

          A structure that contains the date and time that the experiment started and ended.

          • endedTime (datetime) --

            The date and time that the experiment ended.

          • startedTime (datetime) --

            The date and time that the experiment started.

        • lastUpdatedTime (datetime) --

          The date and time that the experiment was most recently updated.

        • metricGoals (list) --

          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.

          • (dict) --

            A structure that tells Evidently whether higher or lower values are desired for a metric that is used in an experiment.

            • desiredChange (string) --

              INCREASE means that a variation with a higher number for this metric is performing better.

              DECREASE means that a variation with a lower number for this metric is performing better.

            • metricDefinition (dict) --

              A structure that contains details about the metric.

              • entityIdKey (string) --

                The entity, such as a user or session, that does an action that causes a metric value to be recorded.

              • eventPattern (string) --

                The EventBridge event pattern that defines how the metric is recorded.

                For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

              • name (string) --

                The name of the metric.

              • unitLabel (string) --

                The label for the units that the metric is measuring.

              • valueKey (string) --

                The value that is tracked to produce the metric.

        • name (string) --

          The name of the experiment.

        • onlineAbDefinition (dict) --

          A structure that contains the configuration of which variation to 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.

          • controlTreatmentName (string) --

            The name of the variation that is the default variation that the other variations are compared to.

          • treatmentWeights (dict) --

            A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. The traffic portion is specified in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

            • (string) --
              • (integer) --
        • project (string) --

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

        • randomizationSalt (string) --

          This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt .

        • samplingRate (integer) --

          In thousandths of a percent, the amount of the available audience that is allocated to this experiment. 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, so a value of 10,000 is 10% of the available audience.

        • schedule (dict) --

          A structure that contains the time and date that Evidently completed the analysis of the experiment.

          • analysisCompleteTime (datetime) --

            The time and date that Evidently completed the analysis of the experiment.

        • status (string) --

          The current state of the experiment.

        • statusReason (string) --

          If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

        • tags (dict) --

          The list of tag keys and values associated with this experiment.

          • (string) --
            • (string) --
        • treatments (list) --

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

          • (dict) --

            A structure that defines one treatment in an experiment. A treatment is a variation of the feature that you are including in the experiment.

            • description (string) --

              The description of the treatment.

            • featureVariations (dict) --

              The feature variation used for this treatment. This is a key-value pair. The key is the feature name, and the value is the variation name.

              • (string) --
                • (string) --
            • name (string) --

              The name of this treatment.

        • type (string) --

          The type of this experiment. Currently, this value must be aws.experiment.onlineab .

    • nextToken (string) --

      The token to use in a subsequent ListExperiments operation to return the next set of results.

Exceptions

list_features(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_features(
    maxResults=123,
    nextToken='string',
    project='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results to include in the response.
  • nextToken (string) -- The token to use when requesting the next set of results. You received this token from a previous ListFeatures operation.
  • project (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'features': [
        {
            'arn': 'string',
            'createdTime': datetime(2015, 1, 1),
            'defaultVariation': 'string',
            'evaluationRules': [
                {
                    'name': 'string',
                    'type': 'string'
                },
            ],
            'evaluationStrategy': 'ALL_RULES'|'DEFAULT_VARIATION',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'name': 'string',
            'project': 'string',
            'status': 'AVAILABLE'|'UPDATING',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • features (list) --

      An array of structures that contain the configuration details of the features in the specified project.

      • (dict) --

        This structure contains information about one Evidently feature in your account.

        • arn (string) --

          The ARN of the feature.

        • createdTime (datetime) --

          The date and time that the feature is created.

        • defaultVariation (string) --

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

        • evaluationRules (list) --

          An array of structures that define

          • (dict) --

            A structure that contains the information about an evaluation rule for this feature, if it is used in a launch or experiment.

            • name (string) --

              The name of the experiment or launch.

            • type (string) --

              This value is aws.evidently.splits if this is an evaluation rule for a launch, and it is aws.evidently.onlineab if this is an evaluation rule for an experiment.

        • evaluationStrategy (string) --

          If this value is ALL_RULES , the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION , the default variation is being served to all users.

        • lastUpdatedTime (datetime) --

          The date and time that the feature was most recently updated.

        • name (string) --

          The name of the feature.

        • project (string) --

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

        • status (string) --

          The current state of the feature.

        • tags (dict) --

          The list of tag keys and values associated with this feature.

          • (string) --
            • (string) --
    • nextToken (string) --

      The token to use in a subsequent ListFeatures operation to return the next set of results.

Exceptions

list_launches(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_launches(
    maxResults=123,
    nextToken='string',
    project='string',
    status='CREATED'|'UPDATING'|'RUNNING'|'COMPLETED'|'CANCELLED'
)
Parameters
  • maxResults (integer) -- The maximum number of results to include in the response.
  • nextToken (string) -- The token to use when requesting the next set of results. You received this token from a previous ListLaunches operation.
  • project (string) --

    [REQUIRED]

    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.
Return type

dict

Returns

Response Syntax

{
    'launches': [
        {
            'arn': 'string',
            'createdTime': datetime(2015, 1, 1),
            'description': 'string',
            'execution': {
                'endedTime': datetime(2015, 1, 1),
                'startedTime': datetime(2015, 1, 1)
            },
            'groups': [
                {
                    'description': 'string',
                    'featureVariations': {
                        'string': 'string'
                    },
                    'name': 'string'
                },
            ],
            'lastUpdatedTime': datetime(2015, 1, 1),
            'metricMonitors': [
                {
                    'metricDefinition': {
                        'entityIdKey': 'string',
                        'eventPattern': 'string',
                        'name': 'string',
                        'unitLabel': 'string',
                        'valueKey': 'string'
                    }
                },
            ],
            'name': 'string',
            'project': 'string',
            'randomizationSalt': 'string',
            'scheduledSplitsDefinition': {
                'steps': [
                    {
                        'groupWeights': {
                            'string': 123
                        },
                        'startTime': datetime(2015, 1, 1)
                    },
                ]
            },
            'status': 'CREATED'|'UPDATING'|'RUNNING'|'COMPLETED'|'CANCELLED',
            'statusReason': 'string',
            'tags': {
                'string': 'string'
            },
            'type': 'aws.evidently.splits'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • launches (list) --

      An array of structures that contain the configuration details of the launches in the specified project.

      • (dict) --

        This structure contains the configuration details of one Evidently launch.

        • arn (string) --

          The ARN of the launch.

        • createdTime (datetime) --

          The date and time that the launch is created.

        • description (string) --

          The description of the launch.

        • execution (dict) --

          A structure that contains information about the start and end times of the launch.

          • endedTime (datetime) --

            The date and time that the launch ended.

          • startedTime (datetime) --

            The date and time that the launch started.

        • groups (list) --

          An array of structures that define the feature variations that are being used in the launch.

          • (dict) --

            A structure that defines one launch group in a launch. A launch group is a variation of the feature that you are including in the launch.

            • description (string) --

              A description of the launch group.

            • featureVariations (dict) --

              The feature variation for this launch group. This is a key-value pair.

              • (string) --
                • (string) --
            • name (string) --

              The name of the launch group.

        • lastUpdatedTime (datetime) --

          The date and time that the launch was most recently updated.

        • metricMonitors (list) --

          An array of structures that define the metrics that are being used to monitor the launch performance.

          • (dict) --

            A structure that defines a metric to be used to monitor performance of the variations during a launch.

            • metricDefinition (dict) --

              A structure that defines the metric.

              • entityIdKey (string) --

                The entity, such as a user or session, that does an action that causes a metric value to be recorded.

              • eventPattern (string) --

                The EventBridge event pattern that defines how the metric is recorded.

                For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

              • name (string) --

                The name of the metric.

              • unitLabel (string) --

                The label for the units that the metric is measuring.

              • valueKey (string) --

                The value that is tracked to produce the metric.

        • name (string) --

          The name of the launch.

        • project (string) --

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

        • randomizationSalt (string) --

          This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt .

        • scheduledSplitsDefinition (dict) --

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

          • steps (list) --

            An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

            • (dict) --

              This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.

              • groupWeights (dict) --

                The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

                • (string) --
                  • (integer) --
              • startTime (datetime) --

                The date and time that this step of the launch starts.

        • status (string) --

          The current state of the launch.

        • statusReason (string) --

          If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.

        • tags (dict) --

          The list of tag keys and values associated with this launch.

          • (string) --
            • (string) --
        • type (string) --

          The type of launch.

    • nextToken (string) --

      The token to use in a subsequent ListLaunches operation to return the next set of results.

Exceptions

list_projects(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_projects(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results to include in the response.
  • nextToken (string) -- The token to use when requesting the next set of results. You received this token from a previous ListProjects operation.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'projects': [
        {
            'activeExperimentCount': 123,
            'activeLaunchCount': 123,
            'arn': 'string',
            'createdTime': datetime(2015, 1, 1),
            'description': 'string',
            'experimentCount': 123,
            'featureCount': 123,
            'lastUpdatedTime': datetime(2015, 1, 1),
            'launchCount': 123,
            'name': 'string',
            'status': 'AVAILABLE'|'UPDATING',
            'tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The token to use in a subsequent ListProjects operation to return the next set of results.

    • projects (list) --

      An array of structures that contain the configuration details of the projects in the Region.

      • (dict) --

        A structure that contains configuration information about an Evidently project.

        • activeExperimentCount (integer) --

          The number of experiments currently in the project.

        • activeLaunchCount (integer) --

          The number of ongoing launches currently in the project.

        • arn (string) --

          The name or ARN of the project.

        • createdTime (datetime) --

          The date and time that the project is created.

        • description (string) --

          The description of the project.

        • experimentCount (integer) --

          The number of experiments currently in the project.

        • featureCount (integer) --

          The number of features currently in the project.

        • lastUpdatedTime (datetime) --

          The date and time that the project was most recently updated.

        • launchCount (integer) --

          The number of launches currently in the project, including launches that are ongoing, completed, and not started yet.

        • name (string) --

          The name of the project.

        • status (string) --

          The current state of the project.

        • tags (dict) --

          The list of tag keys and values associated with this project.

          • (string) --
            • (string) --

Exceptions

list_tags_for_resource(**kwargs)

Displays the tags associated with an Evidently resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --

      The list of tag keys and values associated with the resource you specified.

      • (string) --
        • (string) --

Exceptions

put_project_events(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.put_project_events(
    events=[
        {
            'data': 'string',
            'timestamp': datetime(2015, 1, 1),
            'type': 'aws.evidently.evaluation'|'aws.evidently.custom'
        },
    ],
    project='string'
)
Parameters
  • events (list) --

    [REQUIRED]

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

    • (dict) --

      A structure that contains the information about one evaluation event or custom event sent to Evidently. This is a JSON payload. If this event specifies a pre-defined event type, the payload must follow the defined event schema.

      • data (string) -- [REQUIRED]

        The event data.

      • timestamp (datetime) -- [REQUIRED]

        The timestamp of the event.

      • type (string) -- [REQUIRED]
        aws.evidently.evaluation specifies an evaluation event, which determines which feature variation that a user sees. aws.evidently.custom specifies a custom event, which generates metrics from user actions such as clicks and checkouts.
  • project (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'eventResults': [
        {
            'errorCode': 'string',
            'errorMessage': 'string',
            'eventId': 'string'
        },
    ],
    'failedEventCount': 123
}

Response Structure

  • (dict) --

    • eventResults (list) --

      A structure that contains Evidently's response to the sent events, including an event ID and error codes, if any.

      • (dict) --

        A structure that contains Evidently's response to the sent events, including an event ID and error codes, if any.

        • errorCode (string) --

          If the PutProjectEvents operation has an error, the error code is returned here.

        • errorMessage (string) --

          If the PutProjectEvents operation has an error, the error message is returned here.

        • eventId (string) --

          A unique ID assigned to this PutProjectEvents operation.

    • failedEventCount (integer) --

      The number of events in the operation that could not be used by Evidently.

Exceptions

start_experiment(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.start_experiment(
    analysisCompleteTime=datetime(2015, 1, 1),
    experiment='string',
    project='string'
)
Parameters
  • analysisCompleteTime (datetime) --

    [REQUIRED]

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

  • experiment (string) --

    [REQUIRED]

    The name of the experiment to start.

  • project (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'startedTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • startedTime (datetime) --

      A timestamp that indicates when the experiment started.

Exceptions

start_launch(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.start_launch(
    launch='string',
    project='string'
)
Parameters
  • launch (string) --

    [REQUIRED]

    The name of the launch to start.

  • project (string) --

    [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'launch': {
        'arn': 'string',
        'createdTime': datetime(2015, 1, 1),
        'description': 'string',
        'execution': {
            'endedTime': datetime(2015, 1, 1),
            'startedTime': datetime(2015, 1, 1)
        },
        'groups': [
            {
                'description': 'string',
                'featureVariations': {
                    'string': 'string'
                },
                'name': 'string'
            },
        ],
        'lastUpdatedTime': datetime(2015, 1, 1),
        'metricMonitors': [
            {
                'metricDefinition': {
                    'entityIdKey': 'string',
                    'eventPattern': 'string',
                    'name': 'string',
                    'unitLabel': 'string',
                    'valueKey': 'string'
                }
            },
        ],
        'name': 'string',
        'project': 'string',
        'randomizationSalt': 'string',
        'scheduledSplitsDefinition': {
            'steps': [
                {
                    'groupWeights': {
                        'string': 123
                    },
                    'startTime': datetime(2015, 1, 1)
                },
            ]
        },
        'status': 'CREATED'|'UPDATING'|'RUNNING'|'COMPLETED'|'CANCELLED',
        'statusReason': 'string',
        'tags': {
            'string': 'string'
        },
        'type': 'aws.evidently.splits'
    }
}

Response Structure

  • (dict) --

    • launch (dict) --

      A structure that contains information about the launch that was started.

      • arn (string) --

        The ARN of the launch.

      • createdTime (datetime) --

        The date and time that the launch is created.

      • description (string) --

        The description of the launch.

      • execution (dict) --

        A structure that contains information about the start and end times of the launch.

        • endedTime (datetime) --

          The date and time that the launch ended.

        • startedTime (datetime) --

          The date and time that the launch started.

      • groups (list) --

        An array of structures that define the feature variations that are being used in the launch.

        • (dict) --

          A structure that defines one launch group in a launch. A launch group is a variation of the feature that you are including in the launch.

          • description (string) --

            A description of the launch group.

          • featureVariations (dict) --

            The feature variation for this launch group. This is a key-value pair.

            • (string) --
              • (string) --
          • name (string) --

            The name of the launch group.

      • lastUpdatedTime (datetime) --

        The date and time that the launch was most recently updated.

      • metricMonitors (list) --

        An array of structures that define the metrics that are being used to monitor the launch performance.

        • (dict) --

          A structure that defines a metric to be used to monitor performance of the variations during a launch.

          • metricDefinition (dict) --

            A structure that defines the metric.

            • entityIdKey (string) --

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern (string) --

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

            • name (string) --

              The name of the metric.

            • unitLabel (string) --

              The label for the units that the metric is measuring.

            • valueKey (string) --

              The value that is tracked to produce the metric.

      • name (string) --

        The name of the launch.

      • project (string) --

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

      • randomizationSalt (string) --

        This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt .

      • scheduledSplitsDefinition (dict) --

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

        • steps (list) --

          An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

          • (dict) --

            This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.

            • groupWeights (dict) --

              The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

              • (string) --
                • (integer) --
            • startTime (datetime) --

              The date and time that this step of the launch starts.

      • status (string) --

        The current state of the launch.

      • statusReason (string) --

        If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.

      • tags (dict) --

        The list of tag keys and values associated with this launch.

        • (string) --
          • (string) --
      • type (string) --

        The type of launch.

Exceptions

stop_experiment(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.stop_experiment(
    desiredState='COMPLETED'|'CANCELLED',
    experiment='string',
    project='string',
    reason='string'
)
Parameters
  • desiredState (string) -- Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.
  • experiment (string) --

    [REQUIRED]

    The name of the experiment to stop.

  • project (string) --

    [REQUIRED]

    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.
Return type

dict

Returns

Response Syntax

{
    'endedTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • endedTime (datetime) --

      The date and time that the experiment stopped.

Exceptions

stop_launch(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.stop_launch(
    desiredState='COMPLETED'|'CANCELLED',
    launch='string',
    project='string',
    reason='string'
)
Parameters
  • desiredState (string) -- Specify whether to consider the launch as COMPLETED or CANCELLED after it stops.
  • launch (string) --

    [REQUIRED]

    The name of the launch to stop.

  • project (string) --

    [REQUIRED]

    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.
Return type

dict

Returns

Response Syntax

{
    'endedTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • endedTime (datetime) --

      The date and time that the launch stopped.

Exceptions

tag_resource(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

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

  • tags (dict) --

    [REQUIRED]

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

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes one or more tags from the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

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

  • tagKeys (list) --

    [REQUIRED]

    The list of tag keys to remove from the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_experiment(**kwargs)

Updates an Evidently experiment.

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

See also: AWS API Documentation

Request Syntax

response = client.update_experiment(
    description='string',
    experiment='string',
    metricGoals=[
        {
            'desiredChange': 'INCREASE'|'DECREASE',
            'metricDefinition': {
                'entityIdKey': 'string',
                'eventPattern': 'string',
                'name': 'string',
                'unitLabel': 'string',
                'valueKey': 'string'
            }
        },
    ],
    onlineAbConfig={
        'controlTreatmentName': 'string',
        'treatmentWeights': {
            'string': 123
        }
    },
    project='string',
    randomizationSalt='string',
    samplingRate=123,
    treatments=[
        {
            'description': 'string',
            'feature': 'string',
            'name': 'string',
            'variation': 'string'
        },
    ]
)
Parameters
  • description (string) -- An optional description of the experiment.
  • experiment (string) --

    [REQUIRED]

    The name of the experiment to update.

  • metricGoals (list) --

    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.

    • (dict) --

      Use this structure to tell Evidently whether higher or lower values are desired for a metric that is used in an experiment.

      • desiredChange (string) --
        INCREASE means that a variation with a higher number for this metric is performing better.

        DECREASE means that a variation with a lower number for this metric is performing better.

      • metricDefinition (dict) -- [REQUIRED]

        A structure that contains details about the metric.

        • entityIdKey (string) -- [REQUIRED]

          The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is userDetails.userID .

        • eventPattern (string) --

          The EventBridge event pattern that defines how the metric is recorded.

          For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

        • name (string) -- [REQUIRED]

          A name for the metric.

        • unitLabel (string) --

          A label for the units that the metric is measuring.

        • valueKey (string) -- [REQUIRED]

          The value that is tracked to produce the metric.

  • onlineAbConfig (dict) --

    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.

    • controlTreatmentName (string) --

      The name of the variation that is to be the default variation that the other variations are compared to.

    • treatmentWeights (dict) --

      A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

      • (string) --
        • (integer) --
  • project (string) --

    [REQUIRED]

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

  • randomizationSalt (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 .
  • samplingRate (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.

  • treatments (list) --

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

    • (dict) --

      A structure that defines one treatment in an experiment. A treatment is a variation of the feature that you are including in the experiment.

      • description (string) --

        A description for this treatment.

      • feature (string) -- [REQUIRED]

        The feature that this experiment is testing.

      • name (string) -- [REQUIRED]

        A name for this treatment.

      • variation (string) -- [REQUIRED]

        The name of the variation to use as this treatment in the experiment.

Return type

dict

Returns

Response Syntax

{
    'experiment': {
        'arn': 'string',
        'createdTime': datetime(2015, 1, 1),
        'description': 'string',
        'execution': {
            'endedTime': datetime(2015, 1, 1),
            'startedTime': datetime(2015, 1, 1)
        },
        'lastUpdatedTime': datetime(2015, 1, 1),
        'metricGoals': [
            {
                'desiredChange': 'INCREASE'|'DECREASE',
                'metricDefinition': {
                    'entityIdKey': 'string',
                    'eventPattern': 'string',
                    'name': 'string',
                    'unitLabel': 'string',
                    'valueKey': 'string'
                }
            },
        ],
        'name': 'string',
        'onlineAbDefinition': {
            'controlTreatmentName': 'string',
            'treatmentWeights': {
                'string': 123
            }
        },
        'project': 'string',
        'randomizationSalt': 'string',
        'samplingRate': 123,
        'schedule': {
            'analysisCompleteTime': datetime(2015, 1, 1)
        },
        'status': 'CREATED'|'UPDATING'|'RUNNING'|'COMPLETED'|'CANCELLED',
        'statusReason': 'string',
        'tags': {
            'string': 'string'
        },
        'treatments': [
            {
                'description': 'string',
                'featureVariations': {
                    'string': 'string'
                },
                'name': 'string'
            },
        ],
        'type': 'aws.evidently.onlineab'
    }
}

Response Structure

  • (dict) --

    • experiment (dict) --

      A structure containing the configuration details of the experiment that was updated.

      • arn (string) --

        The ARN of the experiment.

      • createdTime (datetime) --

        The date and time that the experiment is first created.

      • description (string) --

        A description of the experiment.

      • execution (dict) --

        A structure that contains the date and time that the experiment started and ended.

        • endedTime (datetime) --

          The date and time that the experiment ended.

        • startedTime (datetime) --

          The date and time that the experiment started.

      • lastUpdatedTime (datetime) --

        The date and time that the experiment was most recently updated.

      • metricGoals (list) --

        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.

        • (dict) --

          A structure that tells Evidently whether higher or lower values are desired for a metric that is used in an experiment.

          • desiredChange (string) --

            INCREASE means that a variation with a higher number for this metric is performing better.

            DECREASE means that a variation with a lower number for this metric is performing better.

          • metricDefinition (dict) --

            A structure that contains details about the metric.

            • entityIdKey (string) --

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern (string) --

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

            • name (string) --

              The name of the metric.

            • unitLabel (string) --

              The label for the units that the metric is measuring.

            • valueKey (string) --

              The value that is tracked to produce the metric.

      • name (string) --

        The name of the experiment.

      • onlineAbDefinition (dict) --

        A structure that contains the configuration of which variation to 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.

        • controlTreatmentName (string) --

          The name of the variation that is the default variation that the other variations are compared to.

        • treatmentWeights (dict) --

          A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. The traffic portion is specified in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

          • (string) --
            • (integer) --
      • project (string) --

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

      • randomizationSalt (string) --

        This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt .

      • samplingRate (integer) --

        In thousandths of a percent, the amount of the available audience that is allocated to this experiment. 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, so a value of 10,000 is 10% of the available audience.

      • schedule (dict) --

        A structure that contains the time and date that Evidently completed the analysis of the experiment.

        • analysisCompleteTime (datetime) --

          The time and date that Evidently completed the analysis of the experiment.

      • status (string) --

        The current state of the experiment.

      • statusReason (string) --

        If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

      • tags (dict) --

        The list of tag keys and values associated with this experiment.

        • (string) --
          • (string) --
      • treatments (list) --

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

        • (dict) --

          A structure that defines one treatment in an experiment. A treatment is a variation of the feature that you are including in the experiment.

          • description (string) --

            The description of the treatment.

          • featureVariations (dict) --

            The feature variation used for this treatment. This is a key-value pair. The key is the feature name, and the value is the variation name.

            • (string) --
              • (string) --
          • name (string) --

            The name of this treatment.

      • type (string) --

        The type of this experiment. Currently, this value must be aws.experiment.onlineab .

Exceptions

update_feature(**kwargs)

Updates an existing feature.

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

See also: AWS API Documentation

Request Syntax

response = client.update_feature(
    addOrUpdateVariations=[
        {
            'name': 'string',
            'value': {
                'boolValue': True|False,
                'doubleValue': 123.0,
                'longValue': 123,
                'stringValue': 'string'
            }
        },
    ],
    defaultVariation='string',
    description='string',
    entityOverrides={
        'string': 'string'
    },
    evaluationStrategy='ALL_RULES'|'DEFAULT_VARIATION',
    feature='string',
    project='string',
    removeVariations=[
        'string',
    ]
)
Parameters
  • addOrUpdateVariations (list) --

    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.

    • (dict) --

      This structure contains the name and variation value of one variation of a feature.

      • name (string) -- [REQUIRED]

        The name of the variation.

      • value (dict) -- [REQUIRED]

        The value assigned to this variation.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: boolValue, doubleValue, longValue, stringValue.

        • boolValue (boolean) --

          If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.

        • doubleValue (float) --

          If this feature uses the double integer variation type, this field contains the double integer value of this variation.

        • longValue (integer) --

          If this feature uses the long variation type, this field contains the long value of this variation.

        • stringValue (string) --

          If this feature uses the string variation type, this field contains the string value of this variation.

  • defaultVariation (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.
  • entityOverrides (dict) --

    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.

    • (string) --
      • (string) --
  • evaluationStrategy (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 (string) --

    [REQUIRED]

    The name of the feature to be updated.

  • project (string) --

    [REQUIRED]

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

  • removeVariations (list) --

    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.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'feature': {
        'arn': 'string',
        'createdTime': datetime(2015, 1, 1),
        'defaultVariation': 'string',
        'description': 'string',
        'entityOverrides': {
            'string': 'string'
        },
        'evaluationRules': [
            {
                'name': 'string',
                'type': 'string'
            },
        ],
        'evaluationStrategy': 'ALL_RULES'|'DEFAULT_VARIATION',
        'lastUpdatedTime': datetime(2015, 1, 1),
        'name': 'string',
        'project': 'string',
        'status': 'AVAILABLE'|'UPDATING',
        'tags': {
            'string': 'string'
        },
        'valueType': 'STRING'|'LONG'|'DOUBLE'|'BOOLEAN',
        'variations': [
            {
                'name': 'string',
                'value': {
                    'boolValue': True|False,
                    'doubleValue': 123.0,
                    'longValue': 123,
                    'stringValue': 'string'
                }
            },
        ]
    }
}

Response Structure

  • (dict) --

    • feature (dict) --

      A structure that contains information about the updated feature.

      • arn (string) --

        The ARN of the feature.

      • createdTime (datetime) --

        The date and time that the feature is created.

      • defaultVariation (string) --

        The name of the variation that is used 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) --

        The description of the feature.

      • entityOverrides (dict) --

        A set of key-value pairs that specify users who should always be served a specific variation of a feature. Each key specifies a user using their user ID, account ID, or some other identifier. The value specifies the name of the variation that the user is to be served.

        For the override to be successful, the value of the key must match the entityId used in the EvaluateFeature operation.

        • (string) --
          • (string) --
      • evaluationRules (list) --

        An array of structures that define the evaluation rules for the feature.

        • (dict) --

          A structure that contains the information about an evaluation rule for this feature, if it is used in a launch or experiment.

          • name (string) --

            The name of the experiment or launch.

          • type (string) --

            This value is aws.evidently.splits if this is an evaluation rule for a launch, and it is aws.evidently.onlineab if this is an evaluation rule for an experiment.

      • evaluationStrategy (string) --

        If this value is ALL_RULES , the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION , the default variation is being served to all users.

      • lastUpdatedTime (datetime) --

        The date and time that the feature was most recently updated.

      • name (string) --

        The name of the feature.

      • project (string) --

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

      • status (string) --

        The current state of the feature.

      • tags (dict) --

        The list of tag keys and values associated with this feature.

        • (string) --
          • (string) --
      • valueType (string) --

        Defines the type of value used to define the different feature variations. For more information, see Variation types

      • variations (list) --

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

        • (dict) --

          This structure contains the name and variation value of one variation of a feature.

          • name (string) --

            The name of the variation.

          • value (dict) --

            The value assigned to this variation.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: boolValue, doubleValue, longValue, stringValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            
            • boolValue (boolean) --

              If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.

            • doubleValue (float) --

              If this feature uses the double integer variation type, this field contains the double integer value of this variation.

            • longValue (integer) --

              If this feature uses the long variation type, this field contains the long value of this variation.

            • stringValue (string) --

              If this feature uses the string variation type, this field contains the string value of this variation.

Exceptions

update_launch(**kwargs)

Updates a launch of a given feature.

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

See also: AWS API Documentation

Request Syntax

response = client.update_launch(
    description='string',
    groups=[
        {
            'description': 'string',
            'feature': 'string',
            'name': 'string',
            'variation': 'string'
        },
    ],
    launch='string',
    metricMonitors=[
        {
            'metricDefinition': {
                'entityIdKey': 'string',
                'eventPattern': 'string',
                'name': 'string',
                'unitLabel': 'string',
                'valueKey': 'string'
            }
        },
    ],
    project='string',
    randomizationSalt='string',
    scheduledSplitsConfig={
        'steps': [
            {
                'groupWeights': {
                    'string': 123
                },
                'startTime': datetime(2015, 1, 1)
            },
        ]
    }
)
Parameters
  • description (string) -- An optional description for the launch.
  • groups (list) --

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

    • (dict) --

      A structure that defines one launch group in a launch. A launch group is a variation of the feature that you are including in the launch.

      • description (string) --

        A description of the launch group.

      • feature (string) -- [REQUIRED]

        The feature that this launch is using.

      • name (string) -- [REQUIRED]

        A name for this launch group.

      • variation (string) -- [REQUIRED]

        The feature variation to use for this launch group.

  • launch (string) --

    [REQUIRED]

    The name of the launch that is to be updated.

  • metricMonitors (list) --

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

    • (dict) --

      A structure that defines a metric to be used to monitor performance of the variations during a launch.

      • metricDefinition (dict) -- [REQUIRED]

        A structure that defines the metric.

        • entityIdKey (string) -- [REQUIRED]

          The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is userDetails.userID .

        • eventPattern (string) --

          The EventBridge event pattern that defines how the metric is recorded.

          For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

        • name (string) -- [REQUIRED]

          A name for the metric.

        • unitLabel (string) --

          A label for the units that the metric is measuring.

        • valueKey (string) -- [REQUIRED]

          The value that is tracked to produce the metric.

  • project (string) --

    [REQUIRED]

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

  • randomizationSalt (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 .
  • scheduledSplitsConfig (dict) --

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

    • steps (list) -- [REQUIRED]

      An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

      • (dict) --

        This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.

        • groupWeights (dict) -- [REQUIRED]

          The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

          • (string) --
            • (integer) --
        • startTime (datetime) -- [REQUIRED]

          The date and time that this step of the launch starts.

Return type

dict

Returns

Response Syntax

{
    'launch': {
        'arn': 'string',
        'createdTime': datetime(2015, 1, 1),
        'description': 'string',
        'execution': {
            'endedTime': datetime(2015, 1, 1),
            'startedTime': datetime(2015, 1, 1)
        },
        'groups': [
            {
                'description': 'string',
                'featureVariations': {
                    'string': 'string'
                },
                'name': 'string'
            },
        ],
        'lastUpdatedTime': datetime(2015, 1, 1),
        'metricMonitors': [
            {
                'metricDefinition': {
                    'entityIdKey': 'string',
                    'eventPattern': 'string',
                    'name': 'string',
                    'unitLabel': 'string',
                    'valueKey': 'string'
                }
            },
        ],
        'name': 'string',
        'project': 'string',
        'randomizationSalt': 'string',
        'scheduledSplitsDefinition': {
            'steps': [
                {
                    'groupWeights': {
                        'string': 123
                    },
                    'startTime': datetime(2015, 1, 1)
                },
            ]
        },
        'status': 'CREATED'|'UPDATING'|'RUNNING'|'COMPLETED'|'CANCELLED',
        'statusReason': 'string',
        'tags': {
            'string': 'string'
        },
        'type': 'aws.evidently.splits'
    }
}

Response Structure

  • (dict) --

    • launch (dict) --

      A structure that contains the new configuration of the launch that was updated.

      • arn (string) --

        The ARN of the launch.

      • createdTime (datetime) --

        The date and time that the launch is created.

      • description (string) --

        The description of the launch.

      • execution (dict) --

        A structure that contains information about the start and end times of the launch.

        • endedTime (datetime) --

          The date and time that the launch ended.

        • startedTime (datetime) --

          The date and time that the launch started.

      • groups (list) --

        An array of structures that define the feature variations that are being used in the launch.

        • (dict) --

          A structure that defines one launch group in a launch. A launch group is a variation of the feature that you are including in the launch.

          • description (string) --

            A description of the launch group.

          • featureVariations (dict) --

            The feature variation for this launch group. This is a key-value pair.

            • (string) --
              • (string) --
          • name (string) --

            The name of the launch group.

      • lastUpdatedTime (datetime) --

        The date and time that the launch was most recently updated.

      • metricMonitors (list) --

        An array of structures that define the metrics that are being used to monitor the launch performance.

        • (dict) --

          A structure that defines a metric to be used to monitor performance of the variations during a launch.

          • metricDefinition (dict) --

            A structure that defines the metric.

            • entityIdKey (string) --

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern (string) --

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

            • name (string) --

              The name of the metric.

            • unitLabel (string) --

              The label for the units that the metric is measuring.

            • valueKey (string) --

              The value that is tracked to produce the metric.

      • name (string) --

        The name of the launch.

      • project (string) --

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

      • randomizationSalt (string) --

        This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt .

      • scheduledSplitsDefinition (dict) --

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

        • steps (list) --

          An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

          • (dict) --

            This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.

            • groupWeights (dict) --

              The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

              • (string) --
                • (integer) --
            • startTime (datetime) --

              The date and time that this step of the launch starts.

      • status (string) --

        The current state of the launch.

      • statusReason (string) --

        If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.

      • tags (dict) --

        The list of tag keys and values associated with this launch.

        • (string) --
          • (string) --
      • type (string) --

        The type of launch.

Exceptions

update_project(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.update_project(
    description='string',
    project='string'
)
Parameters
  • description (string) -- An optional description of the project.
  • project (string) --

    [REQUIRED]

    The name or ARN of the project to update.

Return type

dict

Returns

Response Syntax

{
    'project': {
        'activeExperimentCount': 123,
        'activeLaunchCount': 123,
        'arn': 'string',
        'createdTime': datetime(2015, 1, 1),
        'dataDelivery': {
            'cloudWatchLogs': {
                'logGroup': 'string'
            },
            's3Destination': {
                'bucket': 'string',
                'prefix': 'string'
            }
        },
        'description': 'string',
        'experimentCount': 123,
        'featureCount': 123,
        'lastUpdatedTime': datetime(2015, 1, 1),
        'launchCount': 123,
        'name': 'string',
        'status': 'AVAILABLE'|'UPDATING',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • project (dict) --

      A structure containing information about the updated project.

      • activeExperimentCount (integer) --

        The number of ongoing experiments currently in the project.

      • activeLaunchCount (integer) --

        The number of ongoing launches currently in the project.

      • arn (string) --

        The name or ARN of the project.

      • createdTime (datetime) --

        The date and time that the project is created.

      • dataDelivery (dict) --

        A structure that contains information about where Evidently is to store evaluation events for longer term storage.

        • cloudWatchLogs (dict) --

          If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.

          • logGroup (string) --

            The name of the log group where the project stores evaluation events.

        • s3Destination (dict) --

          If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

          • bucket (string) --

            The name of the bucket in which Evidently stores evaluation events.

          • prefix (string) --

            The bucket prefix in which Evidently stores evaluation events.

      • description (string) --

        The user-entered description of the project.

      • experimentCount (integer) --

        The number of experiments currently in the project. This includes all experiments that have been created and not deleted, whether they are ongoing or not.

      • featureCount (integer) --

        The number of features currently in the project.

      • lastUpdatedTime (datetime) --

        The date and time that the project was most recently updated.

      • launchCount (integer) --

        The number of launches currently in the project. This includes all launches that have been created and not deleted, whether they are ongoing or not.

      • name (string) --

        The name of the project.

      • status (string) --

        The current state of the project.

      • tags (dict) --

        The list of tag keys and values associated with this project.

        • (string) --
          • (string) --

Exceptions

update_project_data_delivery(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_project_data_delivery(
    cloudWatchLogs={
        'logGroup': 'string'
    },
    project='string',
    s3Destination={
        'bucket': 'string',
        'prefix': 'string'
    }
)
Parameters
  • cloudWatchLogs (dict) --

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

    • logGroup (string) --

      The name of the log group where the project stores evaluation events.

  • project (string) --

    [REQUIRED]

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

  • s3Destination (dict) --

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

    • bucket (string) --

      The name of the bucket in which Evidently stores evaluation events.

    • prefix (string) --

      The bucket prefix in which Evidently stores evaluation events.

Return type

dict

Returns

Response Syntax

{
    'project': {
        'activeExperimentCount': 123,
        'activeLaunchCount': 123,
        'arn': 'string',
        'createdTime': datetime(2015, 1, 1),
        'dataDelivery': {
            'cloudWatchLogs': {
                'logGroup': 'string'
            },
            's3Destination': {
                'bucket': 'string',
                'prefix': 'string'
            }
        },
        'description': 'string',
        'experimentCount': 123,
        'featureCount': 123,
        'lastUpdatedTime': datetime(2015, 1, 1),
        'launchCount': 123,
        'name': 'string',
        'status': 'AVAILABLE'|'UPDATING',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • project (dict) --

      A structure containing details about the project that you updated.

      • activeExperimentCount (integer) --

        The number of ongoing experiments currently in the project.

      • activeLaunchCount (integer) --

        The number of ongoing launches currently in the project.

      • arn (string) --

        The name or ARN of the project.

      • createdTime (datetime) --

        The date and time that the project is created.

      • dataDelivery (dict) --

        A structure that contains information about where Evidently is to store evaluation events for longer term storage.

        • cloudWatchLogs (dict) --

          If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.

          • logGroup (string) --

            The name of the log group where the project stores evaluation events.

        • s3Destination (dict) --

          If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

          • bucket (string) --

            The name of the bucket in which Evidently stores evaluation events.

          • prefix (string) --

            The bucket prefix in which Evidently stores evaluation events.

      • description (string) --

        The user-entered description of the project.

      • experimentCount (integer) --

        The number of experiments currently in the project. This includes all experiments that have been created and not deleted, whether they are ongoing or not.

      • featureCount (integer) --

        The number of features currently in the project.

      • lastUpdatedTime (datetime) --

        The date and time that the project was most recently updated.

      • launchCount (integer) --

        The number of launches currently in the project. This includes all launches that have been created and not deleted, whether they are ongoing or not.

      • name (string) --

        The name of the project.

      • status (string) --

        The current state of the project.

      • tags (dict) --

        The list of tag keys and values associated with this project.

        • (string) --
          • (string) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class CloudWatchEvidently.Client.exceptions.AccessDeniedException

You do not have sufficient permissions to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient permissions to perform this action.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudWatchEvidently.Client.exceptions.ConflictException

A resource was in an inconsistent state during an update or a deletion.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceId': 'string',
    'resourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A resource was in an inconsistent state during an update or a deletion.

    • message (string) --

    • resourceId (string) --

      The ID of the resource that caused the exception.

    • resourceType (string) --

      The type of the resource that is associated with the error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudWatchEvidently.Client.exceptions.InternalServerException

Unexpected error while processing the request. Retry the request.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Unexpected error while processing the request. Retry the request.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudWatchEvidently.Client.exceptions.ResourceNotFoundException

The request references a resource that does not exist.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceId': 'string',
    'resourceType': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request references a resource that does not exist.

    • message (string) --

    • resourceId (string) --

      The ID of the resource that caused the exception.

    • resourceType (string) --

      The type of the resource that is associated with the error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudWatchEvidently.Client.exceptions.ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'quotaCode': 'string',
    'resourceId': 'string',
    'resourceType': 'string',
    'serviceCode': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request would cause a service quota to be exceeded.

    • message (string) --

    • quotaCode (string) --

      The ID of the service quota that was exceeded.

    • resourceId (string) --

      The ID of the resource that caused the exception.

    • resourceType (string) --

      The type of the resource that is associated with the error.

    • serviceCode (string) --

      The ID of the service that is associated with the error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudWatchEvidently.Client.exceptions.ServiceUnavailableException

The service was unavailable. Retry the request.

Example

try:
  ...
except client.exceptions.ServiceUnavailableException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The service was unavailable. Retry the request.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudWatchEvidently.Client.exceptions.ThrottlingException

The request was denied because of request throttling. Retry the request.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'quotaCode': 'string',
    'serviceCode': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied because of request throttling. Retry the request.

    • message (string) --

    • quotaCode (string) --

      The ID of the service quota that was exceeded.

    • serviceCode (string) --

      The ID of the service that is associated with the error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CloudWatchEvidently.Client.exceptions.ValidationException

The value of a parameter in the request caused an error.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'fieldList': [
        {
            'message': 'string',
            'name': 'string'
        },
    ],
    'message': 'string',
    'reason': 'unknownOperation'|'cannotParse'|'fieldValidationFailed'|'other',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The value of a parameter in the request caused an error.

    • fieldList (list) --

      The parameter that caused the exception.

      • (dict) --

        A structure containing an error name and message.

        • message (string) --

          The error message.

        • name (string) --

          The error name.

    • message (string) --

    • reason (string) --

      A reason for the error.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class CloudWatchEvidently.Paginator.ListExperiments
paginator = client.get_paginator('list_experiments')
paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchEvidently.Client.list_experiments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    project='string',
    status='CREATED'|'UPDATING'|'RUNNING'|'COMPLETED'|'CANCELLED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • project (string) --

    [REQUIRED]

    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.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'experiments': [
        {
            'arn': 'string',
            'createdTime': datetime(2015, 1, 1),
            'description': 'string',
            'execution': {
                'endedTime': datetime(2015, 1, 1),
                'startedTime': datetime(2015, 1, 1)
            },
            'lastUpdatedTime': datetime(2015, 1, 1),
            'metricGoals': [
                {
                    'desiredChange': 'INCREASE'|'DECREASE',
                    'metricDefinition': {
                        'entityIdKey': 'string',
                        'eventPattern': 'string',
                        'name': 'string',
                        'unitLabel': 'string',
                        'valueKey': 'string'
                    }
                },
            ],
            'name': 'string',
            'onlineAbDefinition': {
                'controlTreatmentName': 'string',
                'treatmentWeights': {
                    'string': 123
                }
            },
            'project': 'string',
            'randomizationSalt': 'string',
            'samplingRate': 123,
            'schedule': {
                'analysisCompleteTime': datetime(2015, 1, 1)
            },
            'status': 'CREATED'|'UPDATING'|'RUNNING'|'COMPLETED'|'CANCELLED',
            'statusReason': 'string',
            'tags': {
                'string': 'string'
            },
            'treatments': [
                {
                    'description': 'string',
                    'featureVariations': {
                        'string': 'string'
                    },
                    'name': 'string'
                },
            ],
            'type': 'aws.evidently.onlineab'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • experiments (list) --

      An array of structures that contain the configuration details of the experiments in the specified project.

      • (dict) --

        A structure containing the configuration details of an experiment.

        • arn (string) --

          The ARN of the experiment.

        • createdTime (datetime) --

          The date and time that the experiment is first created.

        • description (string) --

          A description of the experiment.

        • execution (dict) --

          A structure that contains the date and time that the experiment started and ended.

          • endedTime (datetime) --

            The date and time that the experiment ended.

          • startedTime (datetime) --

            The date and time that the experiment started.

        • lastUpdatedTime (datetime) --

          The date and time that the experiment was most recently updated.

        • metricGoals (list) --

          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.

          • (dict) --

            A structure that tells Evidently whether higher or lower values are desired for a metric that is used in an experiment.

            • desiredChange (string) --

              INCREASE means that a variation with a higher number for this metric is performing better.

              DECREASE means that a variation with a lower number for this metric is performing better.

            • metricDefinition (dict) --

              A structure that contains details about the metric.

              • entityIdKey (string) --

                The entity, such as a user or session, that does an action that causes a metric value to be recorded.

              • eventPattern (string) --

                The EventBridge event pattern that defines how the metric is recorded.

                For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

              • name (string) --

                The name of the metric.

              • unitLabel (string) --

                The label for the units that the metric is measuring.

              • valueKey (string) --

                The value that is tracked to produce the metric.

        • name (string) --

          The name of the experiment.

        • onlineAbDefinition (dict) --

          A structure that contains the configuration of which variation to 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.

          • controlTreatmentName (string) --

            The name of the variation that is the default variation that the other variations are compared to.

          • treatmentWeights (dict) --

            A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. The traffic portion is specified in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

            • (string) --
              • (integer) --
        • project (string) --

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

        • randomizationSalt (string) --

          This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt .

        • samplingRate (integer) --

          In thousandths of a percent, the amount of the available audience that is allocated to this experiment. 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, so a value of 10,000 is 10% of the available audience.

        • schedule (dict) --

          A structure that contains the time and date that Evidently completed the analysis of the experiment.

          • analysisCompleteTime (datetime) --

            The time and date that Evidently completed the analysis of the experiment.

        • status (string) --

          The current state of the experiment.

        • statusReason (string) --

          If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

        • tags (dict) --

          The list of tag keys and values associated with this experiment.

          • (string) --
            • (string) --
        • treatments (list) --

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

          • (dict) --

            A structure that defines one treatment in an experiment. A treatment is a variation of the feature that you are including in the experiment.

            • description (string) --

              The description of the treatment.

            • featureVariations (dict) --

              The feature variation used for this treatment. This is a key-value pair. The key is the feature name, and the value is the variation name.

              • (string) --
                • (string) --
            • name (string) --

              The name of this treatment.

        • type (string) --

          The type of this experiment. Currently, this value must be aws.experiment.onlineab .

    • NextToken (string) --

      A token to resume pagination.

class CloudWatchEvidently.Paginator.ListFeatures
paginator = client.get_paginator('list_features')
paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchEvidently.Client.list_features().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    project='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • project (string) --

    [REQUIRED]

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

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'features': [
        {
            'arn': 'string',
            'createdTime': datetime(2015, 1, 1),
            'defaultVariation': 'string',
            'evaluationRules': [
                {
                    'name': 'string',
                    'type': 'string'
                },
            ],
            'evaluationStrategy': 'ALL_RULES'|'DEFAULT_VARIATION',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'name': 'string',
            'project': 'string',
            'status': 'AVAILABLE'|'UPDATING',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • features (list) --

      An array of structures that contain the configuration details of the features in the specified project.

      • (dict) --

        This structure contains information about one Evidently feature in your account.

        • arn (string) --

          The ARN of the feature.

        • createdTime (datetime) --

          The date and time that the feature is created.

        • defaultVariation (string) --

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

        • evaluationRules (list) --

          An array of structures that define

          • (dict) --

            A structure that contains the information about an evaluation rule for this feature, if it is used in a launch or experiment.

            • name (string) --

              The name of the experiment or launch.

            • type (string) --

              This value is aws.evidently.splits if this is an evaluation rule for a launch, and it is aws.evidently.onlineab if this is an evaluation rule for an experiment.

        • evaluationStrategy (string) --

          If this value is ALL_RULES , the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION , the default variation is being served to all users.

        • lastUpdatedTime (datetime) --

          The date and time that the feature was most recently updated.

        • name (string) --

          The name of the feature.

        • project (string) --

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

        • status (string) --

          The current state of the feature.

        • tags (dict) --

          The list of tag keys and values associated with this feature.

          • (string) --
            • (string) --
    • NextToken (string) --

      A token to resume pagination.

class CloudWatchEvidently.Paginator.ListLaunches
paginator = client.get_paginator('list_launches')
paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchEvidently.Client.list_launches().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    project='string',
    status='CREATED'|'UPDATING'|'RUNNING'|'COMPLETED'|'CANCELLED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • project (string) --

    [REQUIRED]

    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.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'launches': [
        {
            'arn': 'string',
            'createdTime': datetime(2015, 1, 1),
            'description': 'string',
            'execution': {
                'endedTime': datetime(2015, 1, 1),
                'startedTime': datetime(2015, 1, 1)
            },
            'groups': [
                {
                    'description': 'string',
                    'featureVariations': {
                        'string': 'string'
                    },
                    'name': 'string'
                },
            ],
            'lastUpdatedTime': datetime(2015, 1, 1),
            'metricMonitors': [
                {
                    'metricDefinition': {
                        'entityIdKey': 'string',
                        'eventPattern': 'string',
                        'name': 'string',
                        'unitLabel': 'string',
                        'valueKey': 'string'
                    }
                },
            ],
            'name': 'string',
            'project': 'string',
            'randomizationSalt': 'string',
            'scheduledSplitsDefinition': {
                'steps': [
                    {
                        'groupWeights': {
                            'string': 123
                        },
                        'startTime': datetime(2015, 1, 1)
                    },
                ]
            },
            'status': 'CREATED'|'UPDATING'|'RUNNING'|'COMPLETED'|'CANCELLED',
            'statusReason': 'string',
            'tags': {
                'string': 'string'
            },
            'type': 'aws.evidently.splits'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • launches (list) --

      An array of structures that contain the configuration details of the launches in the specified project.

      • (dict) --

        This structure contains the configuration details of one Evidently launch.

        • arn (string) --

          The ARN of the launch.

        • createdTime (datetime) --

          The date and time that the launch is created.

        • description (string) --

          The description of the launch.

        • execution (dict) --

          A structure that contains information about the start and end times of the launch.

          • endedTime (datetime) --

            The date and time that the launch ended.

          • startedTime (datetime) --

            The date and time that the launch started.

        • groups (list) --

          An array of structures that define the feature variations that are being used in the launch.

          • (dict) --

            A structure that defines one launch group in a launch. A launch group is a variation of the feature that you are including in the launch.

            • description (string) --

              A description of the launch group.

            • featureVariations (dict) --

              The feature variation for this launch group. This is a key-value pair.

              • (string) --
                • (string) --
            • name (string) --

              The name of the launch group.

        • lastUpdatedTime (datetime) --

          The date and time that the launch was most recently updated.

        • metricMonitors (list) --

          An array of structures that define the metrics that are being used to monitor the launch performance.

          • (dict) --

            A structure that defines a metric to be used to monitor performance of the variations during a launch.

            • metricDefinition (dict) --

              A structure that defines the metric.

              • entityIdKey (string) --

                The entity, such as a user or session, that does an action that causes a metric value to be recorded.

              • eventPattern (string) --

                The EventBridge event pattern that defines how the metric is recorded.

                For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

              • name (string) --

                The name of the metric.

              • unitLabel (string) --

                The label for the units that the metric is measuring.

              • valueKey (string) --

                The value that is tracked to produce the metric.

        • name (string) --

          The name of the launch.

        • project (string) --

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

        • randomizationSalt (string) --

          This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt .

        • scheduledSplitsDefinition (dict) --

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

          • steps (list) --

            An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

            • (dict) --

              This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.

              • groupWeights (dict) --

                The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

                • (string) --
                  • (integer) --
              • startTime (datetime) --

                The date and time that this step of the launch starts.

        • status (string) --

          The current state of the launch.

        • statusReason (string) --

          If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.

        • tags (dict) --

          The list of tag keys and values associated with this launch.

          • (string) --
            • (string) --
        • type (string) --

          The type of launch.

    • NextToken (string) --

      A token to resume pagination.

class CloudWatchEvidently.Paginator.ListProjects
paginator = client.get_paginator('list_projects')
paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchEvidently.Client.list_projects().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'projects': [
        {
            'activeExperimentCount': 123,
            'activeLaunchCount': 123,
            'arn': 'string',
            'createdTime': datetime(2015, 1, 1),
            'description': 'string',
            'experimentCount': 123,
            'featureCount': 123,
            'lastUpdatedTime': datetime(2015, 1, 1),
            'launchCount': 123,
            'name': 'string',
            'status': 'AVAILABLE'|'UPDATING',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • projects (list) --

      An array of structures that contain the configuration details of the projects in the Region.

      • (dict) --

        A structure that contains configuration information about an Evidently project.

        • activeExperimentCount (integer) --

          The number of experiments currently in the project.

        • activeLaunchCount (integer) --

          The number of ongoing launches currently in the project.

        • arn (string) --

          The name or ARN of the project.

        • createdTime (datetime) --

          The date and time that the project is created.

        • description (string) --

          The description of the project.

        • experimentCount (integer) --

          The number of experiments currently in the project.

        • featureCount (integer) --

          The number of features currently in the project.

        • lastUpdatedTime (datetime) --

          The date and time that the project was most recently updated.

        • launchCount (integer) --

          The number of launches currently in the project, including launches that are ongoing, completed, and not started yet.

        • name (string) --

          The name of the project.

        • status (string) --

          The current state of the project.

        • tags (dict) --

          The list of tag keys and values associated with this project.

          • (string) --
            • (string) --
    • NextToken (string) --

      A token to resume pagination.