Spec-Zone.ru › AWS CLI v2

[ aws . evidently ]

обновить-эксперимент

Описание

Обновляет эксперимент Evidently.

Не используйте эту операцию для обновления тега эксперимента. Используйте вместо этого TagResource.

См. также: Документация API AWS

Синтаксис

  update-experiment
[--description <value>]
--experiment <value>
[--metric-goals <value>]
[--online-ab-config <value>]
--project <value>
[--randomization-salt <value>]
[--remove-segment | --no-remove-segment]
[--sampling-rate <value>]
[--segment <value>]
[--treatments <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--description (строка)

Необязательное описание эксперимента.

--experiment (строка)

Имя эксперимента для обновления.

--metric-goals (список)

Массив структур, определяющих метрики, используемые в эксперименте, и то, является ли более высокое или более низкое значение для каждой метрики целевым.

(структура)

Используйте эту структуру, чтобы указать Evidently, какие значения метрики (более высокие или более низкие) предпочтительнее в эксперименте.

desiredChange -> (строка)

INCREASE означает, что вариация с более высоким значением по этой метрике показывает лучшие результаты.

DECREASE означает, что вариация с более низким значением по этой метрике показывает лучшие результаты.

metricDefinition -> (структура)

Структура, содержащая подробности о метрике.

entityIdKey -> (строка)

Сущность, например, пользователь или сеанс, выполняющая действие, которое приводит к записи значения метрики. Пример: userDetails.userID.

eventPattern -> (строка)

Шаблон события EventBridge, определяющий, как регистрируется метрика.

Дополнительную информацию о шаблонах событий EventBridge см. в разделе Шаблоны событий Amazon EventBridge.

name -> (строка)

Имя метрики.

unitLabel -> (строка)

Метка единиц измерения метрики.

valueKey -> (строка)

Значение, отслеживаемое для получения метрики.

Краткий синтаксис:

desiredChange=string,metricDefinition={entityIdKey=string,eventPattern=string,name=string,unitLabel=string,valueKey=string} ...

Синтаксис JSON:

[
  {
    "desiredChange": "INCREASE"|"DECREASE",
    "metricDefinition": {
      "entityIdKey": "string",
      "eventPattern": "string",
      "name": "string",
      "unitLabel": "string",
      "valueKey": "string"
    }
  }
  ...
]

--online-ab-config (структура)

Структура, содержащая конфигурацию, определяющую, какая вариация используется в качестве «контрольной» версии. «Контрольная» версия используется для сравнения с другими вариациями. Структура также указывает, какой процент трафика эксперимента выделяется каждой вариации.

controlTreatmentName -> (строка)

Название вариации, которая будет являться эталонной вариацией для сравнения с другими вариациями.

treatmentWeights -> (карта)

Набор пар ключ-значение. Ключи — имена вариаций, значения — доля трафика эксперимента, выделяемого этой вариации. Укажите долю трафика в тысячных процентах, например, 20000 для вариации означает 20% трафика эксперимента для этой вариации.

key -> (строка)

value -> (целое число)

Краткий синтаксис:

controlTreatmentName=string,treatmentWeights={KeyName1=long,KeyName2=long}

Синтаксис JSON:

{
  "controlTreatmentName": "string",
  "treatmentWeights": {"string": long
    ...}
}

--project (строка)

Имя или ARN проекта, содержащего эксперимент, который требуется обновить.

--randomization-salt (строка)

Когда Evidently назначает определенному пользователю сеанс эксперимента, он должен использовать идентификатор случайности для определения, какая вариация будет предоставлена пользователю. Этот идентификатор случайности — комбинация идентификатора сущности и randomizationSalt . Если вы опустите randomizationSalt, Evidently использует имя эксперимента как randomizationSalt.

--remove-segment | --no-remove-segment (булево значение)

Удаляет сегмент из использования в эксперименте. Этот параметр нельзя использовать, если эксперимент в настоящее время выполняется.

--sampling-rate (целое число)

Доля доступной аудитории, которую вы хотите выделить для этого эксперимента, в тысячных процентах. Доступная аудитория — это общая аудитория за вычетом аудитории, которую вы выделили для наложений или текущих запусков этой функции.

Это представлено в тысячных процентах. Например, укажите 20000, чтобы выделить 20% доступной аудитории.

--segment (строка)

Добавляет сегмент аудитории в эксперимент. Когда сегмент используется в эксперименте, в эксперименте используются только сеансы пользователей, которые соответствуют шаблону сегмента. Этот параметр нельзя использовать, если эксперимент в настоящее время выполняется.

--treatments (список)

Массив структур, определяющих вариации, тестируемые в эксперименте.

(структура)

Структура, определяющая одну вариацию в эксперименте. Вариация — это вариация функции, которую вы включаете в эксперимент.

description -> (строка)

Описание этой вариации.

feature -> (строка)

Функция, которую тестирует этот эксперимент.

name -> (строка)

Имя этой вариации.

variation -> (строка)

Имя вариации, используемой в качестве этой вариации в эксперименте.

Краткий синтаксис:

description=string,feature=string,name=string,variation=string ...

Синтаксис JSON:

[
  {
    "description": "string",
    "feature": "string",
    "name": "string",
    "variation": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, полученные из JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, поскольку строка будет взята буквально. Этот параметр не может быть указан вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. Если не указано значение или указано значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он проверит входные данные команд и вернёт пример выходного JSON для этой команды. Сгенерированный каркас JSON нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.

Глобальные параметры

--debug (булево значение)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (булево значение)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (булево значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команд.

  • json
  • текст
  • таблица
  • yaml
  • yaml-потоковый

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включено
  • выключено
  • автоматически

--no-sign-request (булево значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот параметр указан.

--ca-bundle (строка)

Файл CA-сертификатов для проверки сертификатов SSL. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная в base64 строка. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево значение)

Отключить кли-пагинатор для вывода.

--cli-auto-prompt (булево значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево значение)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

experiment -> (структура)

Структура, содержащая сведения о конфигурации обновлённого эксперимента.

arn -> (строка)

ARN эксперимента.

createdTime -> (временная метка)

Дата и время создания эксперимента.

description -> (строка)

Описание эксперимента.

execution -> (структура)

Структура, содержащая дату и время начала и окончания эксперимента.

endedTime -> (временная метка)

Дата и время окончания эксперимента.

startedTime -> (временная метка)

Дата и время начала эксперимента.

lastUpdatedTime -> (временная метка)

Дата и время последнего обновления эксперимента.

metricGoals -> (список)

Массив структур, определяющих метрики, используемые в эксперименте, и то, является ли более высокое или более низкое значение каждой метрики целью.

(структура)

Структура, указывающая Evidently, желательны ли более высокие или более низкие значения для метрики, используемой в эксперименте.

desiredChange -> (строка)

INCREASE означает, что вариант с более высоким числом по этой метрике показывает лучшие результаты.

DECREASE означает, что вариант с более низким числом по этой метрике показывает лучшие результаты.

metricDefinition -> (структура)

Структура, содержащая сведения о метрике.

entityIdKey -> (строка)

Сущность, например, пользователь или сессия, выполнившая действие, вызвавшее запись значения метрики.

eventPattern -> (строка)

Шаблон события EventBridge, определяющий способ записи метрики.

Дополнительную информацию о шаблонах событий EventBridge см. в разделе Шаблоны событий Amazon EventBridge.

name -> (строка)

Имя метрики.

unitLabel -> (строка)

Обозначение единиц измерения метрики.

valueKey -> (строка)

Значение, отслеживаемое для получения метрики.

name -> (строка)

Имя эксперимента.

onlineAbDefinition -> (структура)

Структура, содержащая конфигурацию, определяющую, какой вариант использовать в качестве варианта «контроля». Вариант «контроля» используется для сравнения с другими вариантами. Данная структура также указывает, какой объем трафика эксперимента выделяется каждому варианту.

controlTreatmentName -> (строка)

Имя варианта, который является стандартным вариантом, используемым для сравнения с другими вариантами.

treatmentWeights -> (карта)

Набор пар «ключ-значение». Ключи — имена вариантов, а значения — доля трафика эксперимента, назначаемая этому варианту. Доля трафика указывается в тысячных процентах. Так, значение 20 000 для варианта означает выделение 20% трафика эксперимента этому варианту.

key -> (строка)

value -> (целое число)

project -> (строка)

Имя или ARN проекта, содержащего этот эксперимент.

randomizationSalt -> (строка)

Это значение используется при назначении Evidently определённой пользовательской сессии эксперименту. Оно помогает создать идентификатор рандомизации для определения варианта, предоставляемого пользовательской сессии. Этот идентификатор рандомизации представляет собой комбинацию идентификатора сущности и randomizationSalt.

samplingRate -> (целое число)

Количество доступной аудитории, выделяемой этому эксперименту, в тысячных процентах. Доступная аудитория — это общая аудитория за вычетом аудитории, выделенной для переопределений или текущих запусков этой функции.

Это значение представлено в тысячных процентах; значение 10 000 соответствует 10% доступной аудитории.

schedule -> (структура)

Структура, содержащая время и дату завершения Evidently анализа эксперимента.

analysisCompleteTime -> (временная метка)

Время и дата завершения Evidently анализа эксперимента.

segment -> (строка)

Сегмент аудитории, используемый для эксперимента, если используется сегмент.

status -> (строка)

Текущее состояние эксперимента.

statusReason -> (строка)

Если эксперимент был остановлен, это строка, введённая пользователем, остановившим эксперимент, для объяснения причины остановки.

tags -> (карта)

Список ключей и значений тегов, связанных с этим экспериментом.

key -> (строка)

value -> (строка)

treatments -> (список)

Массив структур, описывающих конфигурацию каждого варианта функции, используемой в эксперименте.

(структура)

Структура, определяющая одно лечение в эксперименте. Лечение — это вариант функции, включённый в эксперимент.

description -> (строка)

Описание лечения.

featureVariations -> (карта)

Вариант функции, используемый для данного лечения. Это пара «ключ-значение». Ключ — имя функции, а значение — имя варианта.

key -> (строка)

value -> (строка)

name -> (строка)

Имя данного лечения.

type -> (строка)

Тип этого эксперимента. В настоящее время это значение должно быть aws.experiment.onlineab.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API