Spec-Zone.ru › AWS CLI v2

[ aws . evidently ]

list-experiments

Описание

Возвращает подробную информацию о всех экспериментах в указанном проекте.

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

list-experiments — это операция с постраничной выдачей. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничную выдачу, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной выдачей, аргумент --query должен извлекать данные из результатов следующих выражений запроса: experiments

Синтаксис

  list-experiments
--project <value>
[--status <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--project (строка)

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

--status (строка)

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

Возможные значения:

  • CREATED
  • UPDATING
  • RUNNING
  • COMPLETED
  • CANCELLED

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

--starting-token (строка)

Маркер для указания места начала постраничной выдачи. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе «Постраничная выдача» в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе «Постраничная выдача» в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной выдачи предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничная выдача» в Руководстве пользователя AWS Command Line Interface.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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.

Вывод

experiments -> (список)

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

(структура)

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

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.

nextToken -> (строка)

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

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

Spec-Zone.ru

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