Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateLaunch

Updates a launch of a given feature.

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

Request Syntax


PATCH /projects/project/launches/launch HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "groups": [ 
      { 
         "description": "string",
         "feature": "string",
         "name": "string",
         "variation": "string"
      }
   ],
   "metricMonitors": [ 
      { 
         "metricDefinition": { 
            "entityIdKey": "string",
            "eventPattern": "string",
            "name": "string",
            "unitLabel": "string",
            "valueKey": "string"
         }
      }
   ],
   "randomizationSalt": "string",
   "scheduledSplitsConfig": { 
      "steps": [ 
         { 
            "groupWeights": { 
               "string" : number 
            },
            "segmentOverrides": [ 
               { 
                  "evaluationOrder": number,
                  "segment": "string",
                  "weights": { 
                     "string" : number 
                  }
               }
            ],
            "startTime": number
         }
      ]
   }
}

URI Request Parameters

The request uses the following URI parameters.

launch

The name of the launch that is to be updated.

Length Constraints: Minimum length of 1. Maximum length of 127.

Pattern: ^[-a-zA-Z0-9._]*$

Required: Yes

project

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

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: (^[a-zA-Z0-9._-]*$)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[a-zA-Z0-9._-]*)

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

An optional description for the launch.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 160.

Pattern: .*

Required: No

groups

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

Type: Array of LaunchGroupConfig objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Required: No

metricMonitors

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

Type: Array of MetricMonitorConfig objects

Array Members: Minimum number of 0 items. Maximum number of 3 items.

Required: No

randomizationSalt

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 127.

Pattern: .*

Required: No

scheduledSplitsConfig

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

Type: ScheduledSplitsLaunchConfig object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "launch": { 
      "arn": "string",
      "createdTime": number,
      "description": "string",
      "execution": { 
         "endedTime": number,
         "startedTime": number
      },
      "groups": [ 
         { 
            "description": "string",
            "featureVariations": { 
               "string" : "string" 
            },
            "name": "string"
         }
      ],
      "lastUpdatedTime": number,
      "metricMonitors": [ 
         { 
            "metricDefinition": { 
               "entityIdKey": "string",
               "eventPattern": "string",
               "name": "string",
               "unitLabel": "string",
               "valueKey": "string"
            }
         }
      ],
      "name": "string",
      "project": "string",
      "randomizationSalt": "string",
      "scheduledSplitsDefinition": { 
         "steps": [ 
            { 
               "groupWeights": { 
                  "string" : number 
               },
               "segmentOverrides": [ 
                  { 
                     "evaluationOrder": number,
                     "segment": "string",
                     "weights": { 
                        "string" : number 
                     }
                  }
               ],
               "startTime": number
            }
         ]
      },
      "status": "string",
      "statusReason": "string",
      "tags": { 
         "string" : "string" 
      },
      "type": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

launch

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

Type: Launch object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

ConflictException

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

HTTP Status Code: 409

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ValidationException

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

HTTP Status Code: 400