Spec-Zone.ru › AWS CLI v2

[ aws . evidently ]

create-launch

Описание

Создает запуск заданного функционала. Перед созданием запуска необходимо создать функционал для использования в запуске.

Запуск можно использовать для безопасной проверки нового функционала, предоставляя его определенному проценту пользователей во время развёртывания. Вы можете отслеживать производительность нового функционала, чтобы определить, когда следует увеличить трафик для большего количества пользователей. Это помогает снизить риски и выявить непредвиденные последствия до полного запуска функционала.

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

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

Синтаксис

  create-launch
[--description <value>]
--groups <value>
[--metric-monitors <value>]
--name <value>
--project <value>
[--randomization-salt <value>]
[--scheduled-splits-config <value>]
[--tags <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 (строка)

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

--groups (список)

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

(структура)

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

description -> (строка)

Описание группы запуска.

feature -> (строка)

Функционал, используемый в этом запуске.

name -> (строка)

Имя этой группы запуска.

variation -> (строка)

Вариант функционала для этой группы запуска.

Сокращённый синтаксис:

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

Синтаксис JSON:

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

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

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

(структура)

Структура, определяющая метрику для мониторинга производительности вариантов во время запуска.

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

Структура, определяющая метрику.

entityIdKey -> (строка)

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

eventPattern -> (строка)

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

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

name -> (строка)

Имя метрики.

unitLabel -> (строка)

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

valueKey -> (строка)

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

Сокращённый синтаксис:

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

Синтаксис JSON:

[
  {
    "metricDefinition": {
      "entityIdKey": "string",
      "eventPattern": "string",
      "name": "string",
      "unitLabel": "string",
      "valueKey": "string"
    }
  }
  ...
]

--name (строка)

Название нового запуска.

--project (строка)

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

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

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

--scheduled-splits-config (структура)

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

steps -> (список)

Массив структур, определяющих процентное распределение трафика между вариантами функционала на каждом шаге запуска. Это также определяет время начала каждого шага.

(структура)

Эта структура определяет процентное распределение трафика между вариантами функционала на одном шаге запуска и время начала этого шага.

groupWeights -> (карта)

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

Значения выражаются в тысячных долях процента, поэтому присваивание веса 50000 соответствует 50% трафика этому варианту.

Если сумма весов всех вариантов в наборе переопределений сегмента не равна 100 000, оставшийся трафик, соответствующий этому сегменту, не будет распределен этим переопределением сегмента, а вместо этого перейдет к следующему переопределению сегмента или по умолчанию.

key -> (строка)

value -> (длинное целое)

segmentOverrides -> (список)

Используйте этот параметр для указания различных распределений трафика для одного или нескольких сегментов аудитории. Сегмент — это часть вашей аудитории, которая обладает общими характеристиками. Примеры: пользователи браузера Chrome, пользователи из Европы или пользователи браузера Firefox в Европе, которые также соответствуют другим критериям, собираемым вашим приложением, например, возраст.

Этот параметр представляет массив до шести объектов переопределения сегмента. Каждый из этих объектов определяет сегмент, который вы уже создали, и задает распределение трафика для этого сегмента.

(структура)

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

evaluationOrder -> (длинное целое)

Число, указывающее порядок оценки переопределений сегмента, если их несколько. Переопределения сегмента с меньшими числами оцениваются первыми.

segment -> (строка)

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

weights -> (карта)

Процентное распределение трафика между вариантами функционала, назначаемые этому сегменту. Это набор пар ключ-значение. Ключи — имена вариантов. Значения представляют количество трафика, которое следует распределить на этот вариант для этого сегмента. Это выражается в тысячных долях процента, поэтому вес 50000 соответствует 50% трафика.

key -> (строка)

value -> (длинное целое)

startTime -> (метка времени)

Дата и время начала этого шага запуска.

Синтаксис JSON:

{
  "steps": [
    {
      "groupWeights": {"string": long
        ...},
      "segmentOverrides": [
        {
          "evaluationOrder": long,
          "segment": "string",
          "weights": {"string": long
            ...}
        }
        ...
      ],
      "startTime": timestamp
    }
    ...
  ]
}

--tags (карта)

Присваивает один или несколько тегов (пар ключ-значение) запуску.

Теги могут помочь в организации и категоризации ваших ресурсов. Вы также можете использовать их для ограничения разрешений пользователей, предоставив пользователю разрешение на доступ или изменение только ресурсов с определенными значениями тегов.

Теги не имеют никакого семантического значения для Amazon Web Services и интерпретируются строго как строки символов.

Вы можете назначить до 50 тегов запуску.

Дополнительную информацию см. в разделе Tagging Amazon Web Services resources.

key -> (строка)

value -> (строка)

Сокращённый синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "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 (строка)

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

--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 (булево)

Отключить вывод AWS CLI для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

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

Структура, содержащая конфигурацию созданного запуска.

arn -> (строка)

ARN запуска.

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

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

description -> (строка)

Описание запуска.

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

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

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

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

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

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

groups -> (список)

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

(структура)

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

description -> (строка)

Описание группы запусков.

featureVariations -> (отображение)

Вариант функции для этой группы запусков. Это пара ключ-значение.

key -> (строка)

value -> (строка)

name -> (строка)

Название группы запусков.

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

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

metricMonitors -> (список)

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

(структура)

Структура, определяющая метрику, используемую для мониторинга производительности вариантов во время запуска.

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

Структура, определяющая метрику.

entityIdKey -> (строка)

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

eventPattern -> (строка)

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

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

name -> (строка)

Название метрики.

unitLabel -> (строка)

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

valueKey -> (строка)

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

name -> (строка)

Название запуска.

project -> (строка)

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

randomizationSalt -> (строка)

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

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

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

steps -> (список)

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

(структура)

Эта структура определяет процентное распределение трафика между вариантами функций на одном этапе запуска и время начала этого этапа.

groupWeights -> (отображение)

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

Значения выражены в тысячных долях процента, поэтому присвоение веса 50000 соответствует 50% трафика.

Если сумма весов для всех вариантов в переопределении сегмента не равна 100000, оставшийся трафик, соответствующий этому сегменту, не назначается этим переопределением сегмента, а вместо этого переходит к следующему переопределению сегмента или к значениям по умолчанию.

key -> (строка)

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

segmentOverrides -> (список)

Используйте этот параметр, чтобы указать разные распределения трафика для одного или нескольких сегментов аудитории. Сегмент — это часть аудитории, которая имеет одну или несколько общих характеристик. Примеры: пользователи браузера Chrome, пользователи в Европе, или пользователи браузера Firefox в Европе, которые также соответствуют другим критериям, которые собирает ваше приложение, например, возраст.

Этот параметр представляет собой массив до шести объектов переопределения сегмента. Каждый из этих объектов определяет сегмент, который вы уже создали, и определяет распределение трафика для этого сегмента.

(структура)

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

evaluationOrder -> (длинное целое число)

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

segment -> (строка)

ARN сегмента для использования.

weights -> (отображение)

Процентное распределение трафика между вариантами функций, которые следует назначить этому сегменту. Это набор пар ключ-значение. Ключи — имена вариантов. Значения представляют собой количество трафика, которое следует направить на этот вариант для этого сегмента. Это выражается в тысячных долях процента, поэтому вес 50000 соответствует 50% трафика.

key -> (строка)

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

startTime -> (метка времени)

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

status -> (строка)

Текущее состояние запуска.

statusReason -> (строка)

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

tags -> (отображение)

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

key -> (строка)

value -> (строка)

type -> (строка)

Тип запуска.

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

Spec-Zone.ru

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