Spec-Zone.ru › AWS CLI v2

[ aws . cleanroomsml ]

получить-задание-по-генерации-аудитории

Описание

Возвращает информацию о задании генерации аудитории.

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

Синтаксис

  get-audience-generation-job
--audience-generation-job-arn <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]

Параметры

--audience-generation-job-arn (строка)

Amazon Resource Name (ARN) задания генерации аудитории, которое вас интересует.

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

Вывод

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

Время создания задания генерации аудитории.

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

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

audienceGenerationJobArn -> (строка)

Amazon Resource Name (ARN) задания генерации аудитории.

name -> (строка)

Название задания генерации аудитории.

description -> (строка)

Описание задания генерации аудитории.

status -> (строка)

Статус задания генерации аудитории.

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

Подробности о статусе задания генерации аудитории.

statusCode -> (строка)

Возвращённый код состояния. Код состояния предназначен для программно-ориентированной обработки ошибок. Clean Rooms ML не будет изменять код состояния для существующих условий ошибки.

message -> (строка)

Возвращённое сообщение об ошибке. Сообщение предназначено для человека и может меняться в любое время. Используйте statusCode для программно-ориентированной обработки ошибок.

configuredAudienceModelArn -> (строка)

Amazon Resource Name (ARN) настроенной модели аудитории, используемой для этого задания генерации аудитории.

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

Семенная аудитория, которая использовалась для этого задания генерации аудитории. Это поле будет равно null, если учётная запись, вызывающая API, является учётной записью, которая запустила это задание генерации аудитории.

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

Определяет ведро Amazon S3, в котором хранится семенная аудитория для генерируемой аудитории. Допустимый источник данных — JSON-строка в следующем формате:

{"user_id": "111111"}

{"user_id": "222222"}

...

s3Uri -> (строка)

URI расположения Amazon S3.

roleArn -> (строка)

ARN IAM-роли, которая может читать ведро Amazon S3, в котором хранится семенная аудитория.

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

Защищённые параметры SQL-запроса.

queryString -> (строка)

Строка запроса, которая будет отправлена.

analysisTemplateArn -> (строка)

Amazon Resource Name (ARN), связанный с шаблоном анализа в рамках сотрудничества.

parameters -> (массив)

Защищённые параметры SQL-запроса.

key -> (строка)

value -> (строка)

sqlComputeConfiguration -> (структура помеченной комбинации)

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

Примечание

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

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

Экземпляры рабочих узлов, которые будут выполнять вычисления.

type -> (строка)

Тип экземпляра рабочих узлов для вычислений.

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

Количество рабочих узлов для вычислений.

includeSeedInOutput -> (логическое значение)

Настройка включения seed-пользователей в выходную аудиторию. По умолчанию Clean Rooms ML удаляет seed-пользователей из выходной аудитории. Если указано TRUE, seed-пользователи будут отображаться первыми в выводе. Clean Rooms ML не раскрывает явно, был ли пользователь в seed, но получатель аудитории будет знать, что первые minimumSeedSize пользователей из seed.

collaborationId -> (строка)

Идентификатор сотрудничества, с которым связано это задание генерации аудитории.

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

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

relevanceMetrics -> (список)

Скор оценки соответствия сгенерированной аудитории.

(структура)

Скор оценки соответствия сгенерированной аудитории.

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

Размер сгенерированной аудитории. Должен совпадать с одним из размеров в настроенной модели аудитории.

type -> (строка)

Указывает, определен ли размер аудитории в абсолютных значениях или в процентах. Вы можете использовать ABSOLUTE AudienceSize для настройки размеров аудитории, используя количество идентификаторов в выводе. Вы можете использовать Percentage AudienceSize для настройки размеров в диапазоне от 1 до 100 процентов.

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

Укажите значение размера аудитории.

score -> (двойное значение)

Скор оценки соответствия сгенерированной аудитории.

recallMetric -> (двойное значение)

Показатель полноты сгенерированной аудитории. Полнота — это процент наиболее похожих пользователей (по умолчанию 20% самых похожих) из выборки обучающих данных, которые включены в семенную аудиторию заданием генерации аудитории. Значения находятся в диапазоне от 0 до 1, более высокие значения указывают на лучшую аудиторию. Значение полноты, приблизительно равное максимальному размеру пакета, указывает на то, что модель аудитории эквивалентна случайному выбору.

startedBy -> (строка)

AWS-учётная запись, которая запустила это задание генерации аудитории.

tags -> (массив)

Теги, которые связаны с этим заданием генерации аудитории.

key -> (строка)

value -> (строка)

protectedQueryIdentifier -> (строка)

Уникальный идентификатор защищённого запроса для этого задания генерации аудитории.

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

Spec-Zone.ru

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