Update Launch

cloudwatchevidently_update_launch

R Documentation

Updates a launch of a given feature

Description

Updates a launch of a given feature.

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

Usage

cloudwatchevidently_update_launch(description, groups, launch,
  metricMonitors, project, randomizationSalt, scheduledSplitsConfig)

Arguments

description

An optional description for the launch.

groups

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

launch

[required] The name of the launch that is to be updated.

metricMonitors

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

project

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

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.

scheduledSplitsConfig

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

Value

A list with the following syntax:

list(
  launch = list(
    arn = "string",
    createdTime = as.POSIXct(
      "2015-01-01"
    ),
    description = "string",
    execution = list(
      endedTime = as.POSIXct(
        "2015-01-01"
      ),
      startedTime = as.POSIXct(
        "2015-01-01"
      )
    ),
    groups = list(
      list(
        description = "string",
        featureVariations = list(
          "string"
        ),
        name = "string"
      )
    ),
    lastUpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    metricMonitors = list(
      list(
        metricDefinition = list(
          entityIdKey = "string",
          eventPattern = "string",
          name = "string",
          unitLabel = "string",
          valueKey = "string"
        )
      )
    ),
    name = "string",
    project = "string",
    randomizationSalt = "string",
    scheduledSplitsDefinition = list(
      steps = list(
        list(
          groupWeights = list(
            123
          ),
          segmentOverrides = list(
            list(
              evaluationOrder = 123,
              segment = "string",
              weights = list(
                123
              )
            )
          ),
          startTime = as.POSIXct(
            "2015-01-01"
          )
        )
      )
    ),
    status = "CREATED"|"UPDATING"|"RUNNING"|"COMPLETED"|"CANCELLED",
    statusReason = "string",
    tags = list(
      "string"
    ),
    type = "aws.evidently.splits"
  )
)

Request syntax

svc$update_launch(
  description = "string",
  groups = list(
    list(
      description = "string",
      feature = "string",
      name = "string",
      variation = "string"
    )
  ),
  launch = "string",
  metricMonitors = list(
    list(
      metricDefinition = list(
        entityIdKey = "string",
        eventPattern = "string",
        name = "string",
        unitLabel = "string",
        valueKey = "string"
      )
    )
  ),
  project = "string",
  randomizationSalt = "string",
  scheduledSplitsConfig = list(
    steps = list(
      list(
        groupWeights = list(
          123
        ),
        segmentOverrides = list(
          list(
            evaluationOrder = 123,
            segment = "string",
            weights = list(
              123
            )
          )
        ),
        startTime = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  )
)