Spec-Zone.ru › AWS CLI v2

[ aws . cleanrooms ]

start-protected-job

Описание

Создаёт защищённую задачу, которая запускается Clean Rooms.

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

Синтаксис

  start-protected-job
--type <value>
--membership-identifier <value>
--job-parameters <value>
[--result-configuration <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]

Параметры

--type (строка)

Тип защищённой задачи для запуска.

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

  • PYSPARK

--membership-identifier (строка)

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

--job-parameters (структура)

Параметры задачи.

analysisTemplateArn -> (строка)

ARN шаблона анализа.

Синтаксис сокращённого задания:

analysisTemplateArn=string

Синтаксис JSON:

{
  "analysisTemplateArn": "string"
}

--result-configuration (структура)

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

outputConfiguration -> (структура помеченных объединений)

Конфигурация вывода результата защищённой задачи.

Примечание

Это структура помеченных объединений. Можно задать только один из следующих верхних ключей: member.

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

Член конфигурации вывода результата защищённой задачи.

accountId -> (строка)

Идентификатор учётной записи.

Синтаксис сокращённого задания:

outputConfiguration={member={accountId=string}}

Синтаксис JSON:

{
  "outputConfiguration": {
    "member": {
      "accountId": "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
  • text
  • таблица
  • 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 для вывода.

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

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

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

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

Вывод

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

Защищённая задача.

id -> (строка)

Идентификатор экземпляра защищённой задачи.

membershipId -> (строка)

Идентификатор членства.

membershipArn -> (строка)

ARN членства.

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

Время создания защищённой задачи.

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

Параметры задачи для защищённой задачи.

analysisTemplateArn -> (строка)

ARN шаблона анализа.

status -> (строка)

Состояние защищённой задачи.

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

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

outputConfiguration -> (структура помеченных объединений)

Конфигурация вывода.

Примечание

Это структура помеченных объединений. Можно задать только один из следующих верхних ключей: s3, member.

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

Если присутствует, вывод для защищённой задачи с типом вывода S3.

bucket -> (строка)

Ведро S3 для вывода результатов задачи.

keyPrefix -> (строка)

Префикс S3 для выгрузки результатов защищённой задачи.

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

Конфигурация вывода для члена защищённой задачи.

accountId -> (строка)

Идентификатор учётной записи.

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

Статистика защищённой задачи.

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

Продолжительность защищённой задачи с момента создания до завершения задачи в миллисекундах.

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

Использованные ресурсы, подлежащие оплате, для защищённой задачи.

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

Количество часов использования ресурсов Clean Rooms Processing Unit (CRPU), за которые начисляется плата.

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

Результат защищённой задачи.

output -> (структура помеченных объединений)

Вывод защищённой задачи.

Примечание

Это структура помеченных объединений. Можно задать только один из следующих верхних ключей: s3, memberList.

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

Если присутствует, вывод для защищённой задачи с типом вывода S3.

location -> (строка)

Местоположение S3 для вывода защищённой задачи.

memberList -> (список)

Список учётных записей Amazon Web Services членов, получивших результаты задачи.

(структура)

Подробности о члене, получившем результат задачи.

accountId -> (строка)

Идентификатор учётной записи Amazon Web Services члена сотрудничества, который может получать результаты анализов.

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

Ошибка защищённой задачи.

message -> (строка)

Сообщение об ошибке защищённой задачи.

code -> (строка)

Код ошибки защищённой задачи.

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

Spec-Zone.ru

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