CloudWatchEvidently / Client / update_feature

update_feature#

CloudWatchEvidently.Client.update_feature(**kwargs)#

Updates an existing feature.

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

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.

This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override.
- (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

CloudWatchEvidently.Client.exceptions.ValidationException
CloudWatchEvidently.Client.exceptions.ConflictException
CloudWatchEvidently.Client.exceptions.ServiceQuotaExceededException
CloudWatchEvidently.Client.exceptions.ResourceNotFoundException
CloudWatchEvidently.Client.exceptions.AccessDeniedException