Spec-Zone.ru › AWS CLI v2

[ aws . cleanrooms ]

создать-совместную-работу

Описание

Создает новую совместную работу.

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

Синтаксис

  create-collaboration
--members <value>
--name <value>
--description <value>
--creator-member-abilities <value>
[--creator-ml-member-abilities <value>]
--creator-display-name <value>
[--data-encryption-metadata <value>]
--query-log-status <value>
[--job-log-status <value>]
[--tags <value>]
[--creator-payment-configuration <value>]
[--analytics-engine <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]

Параметры

--members (список)

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

(структура)

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

accountId -> (строка)

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

memberAbilities -> (список)

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

(строка)

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

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

customMLMemberAbilities -> (список)

Настраиваемые возможности участника совместной работы в области машинного обучения.

(строка)

displayName -> (строка)

Имя участника для отображения.

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

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

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

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

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

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

Указывает, настроился ли создатель совместной работы для данного участника оплату за вычислительные затраты запроса (TRUE ) или не настроился (FALSE ).

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

Если создатель совместной работы не указал, кто платит за вычислительные затраты запроса, то участник, имеющий право на запрос, является платёжеспособным по умолчанию. Возвращается ошибка, если создатель совместной работы задаёт значение FALSE для участника, имеющего право на запрос.

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

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

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

Ответственность участника по оплате за обучение моделей.

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

Указывает, настроился ли создатель совместной работы для данного участника оплату за затраты на обучение моделей (TRUE ) или не настроился (FALSE ).

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

Если создатель совместной работы не указал, кто платит за затраты на обучение моделей, то участник, имеющий право на запрос, является платёжеспособным по умолчанию. Возвращается ошибка, если создатель совместной работы задаёт значение FALSE для участника, имеющего право на запрос.

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

Ответственность участника за оплату вывода моделей.

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

Указывает, настроился ли создатель совместной работы для данного участника оплату за затраты на вывод моделей (TRUE ) или не настроился (FALSE ).

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

Если создатель совместной работы не указал, кто платит за затраты на вывод моделей, то участник, имеющий право на запрос, является платёжеспособным по умолчанию. Возвращается ошибка, если создатель совместной работы задаёт значение FALSE для участника, имеющего право на запрос.

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

Настройка вычислений для задания.

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

Указывает, настроился ли создатель совместной работы для данного участника оплату за вычислительные затраты запросов и заданий (TRUE ) или не настроился (FALSE ).

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

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

JSON Синтаксис:

[
  {
    "accountId": "string",
    "memberAbilities": ["CAN_QUERY"|"CAN_RECEIVE_RESULTS"|"CAN_RUN_JOB", ...],
    "mlMemberAbilities": {
      "customMLMemberAbilities": ["CAN_RECEIVE_MODEL_OUTPUT"|"CAN_RECEIVE_INFERENCE_OUTPUT", ...]
    },
    "displayName": "string",
    "paymentConfiguration": {
      "queryCompute": {
        "isResponsible": true|false
      },
      "machineLearning": {
        "modelTraining": {
          "isResponsible": true|false
        },
        "modelInference": {
          "isResponsible": true|false
        }
      },
      "jobCompute": {
        "isResponsible": true|false
      }
    }
  }
  ...
]

--name (строка)

Имя для отображения совместной работы.

--description (строка)

Описание совместной работы, предоставленное владельцем.

--creator-member-abilities (список)

Доступные возможности для создателя совместной работы.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  CAN_QUERY
  CAN_RECEIVE_RESULTS
  CAN_RUN_JOB

--creator-ml-member-abilities (структура)

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

customMLMemberAbilities -> (список)

Настраиваемые возможности участника совместной работы в области машинного обучения.

(строка)

Краткая форма записи:

customMLMemberAbilities=string,string

JSON Синтаксис:

{
  "customMLMemberAbilities": ["CAN_RECEIVE_MODEL_OUTPUT"|"CAN_RECEIVE_INFERENCE_OUTPUT", ...]
}

--creator-display-name (строка)

Имя для отображения создателя совместной работы.

--data-encryption-metadata (структура)

Настройки шифрования на стороне клиента с помощью криптографических вычислений для чистых комнат.

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

Указывает, могут ли зашифрованные таблицы содержать открытые данные (TRUE ) или обрабатывать каждый столбец криптографически (FALSE ).

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

Указывает, могут ли столбцы отпечатков пальцев содержать дубликаты (TRUE ) или только уникальные значения (FALSE ).

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

Указывает, могут ли столбцы отпечатков пальцев быть объединены с любым другим столбцом отпечатков пальцев с другим именем (TRUE ) или только с столбцами отпечатков пальцев с одинаковым именем (FALSE ).

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

Указывает, должны ли значения NULL копироваться в зашифрованные таблицы как NULL (TRUE ) или обрабатываться криптографически (FALSE ).

Краткая форма записи:

allowCleartext=boolean,allowDuplicates=boolean,allowJoinsOnColumnsWithDifferentNames=boolean,preserveNulls=boolean

JSON Синтаксис:

{
  "allowCleartext": true|false,
  "allowDuplicates": true|false,
  "allowJoinsOnColumnsWithDifferentNames": true|false,
  "preserveNulls": true|false
}

--query-log-status (строка)

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

При значении ENABLED Clean Rooms записывает подробности запросов, выполняемых в рамках данной совместной работы, и эти журналы можно просмотреть в Amazon CloudWatch Logs. Значение по умолчанию — DISABLED .

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

  • ENABLED
  • DISABLED

--job-log-status (строка)

Указывает, включены ли журналы заданий для данной совместной работы.

При значении ENABLED Clean Rooms записывает подробности заданий, выполняемых в рамках данной совместной работы; эти журналы можно просмотреть в Amazon CloudWatch Logs. Значение по умолчанию — DISABLED .

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

  • ENABLED
  • DISABLED

--tags (карта)

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

key -> (строка)

value -> (строка)

Краткая форма записи:

KeyName1=string,KeyName2=string

JSON Синтаксис:

{"string": "string"
  ...}

--creator-payment-configuration (структура)

Ответственность за платежи создателя коллаборации, установленная им.

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

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

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

isResponsible -> (булево)

Указывает, настроен ли создатель коллаборации на оплату затрат на вычисления запросов участником коллаборации (TRUE ) или не настроен (FALSE ).

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

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

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

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

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

Ответственность участника за оплату обучения моделей.

isResponsible -> (булево)

Указывает, настроен ли создатель коллаборации на оплату затрат на обучение моделей участником коллаборации (TRUE ) или не настроен (FALSE ).

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

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

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

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

isResponsible -> (булево)

Указывает, настроен ли создатель коллаборации на оплату затрат на использование моделей участником коллаборации (TRUE ) или не настроен (FALSE ).

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

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

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

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

isResponsible -> (булево)

Указывает, настроен ли создатель коллаборации на оплату затрат на вычисления запросов и заданий участником коллаборации (TRUE ) или не настроен (FALSE ).

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

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

Сокращенная синтаксическая запись:

queryCompute={isResponsible=boolean},machineLearning={modelTraining={isResponsible=boolean},modelInference={isResponsible=boolean}},jobCompute={isResponsible=boolean}

Синтаксис JSON:

{
  "queryCompute": {
    "isResponsible": true|false
  },
  "machineLearning": {
    "modelTraining": {
      "isResponsible": true|false
    },
    "modelInference": {
      "isResponsible": true|false
    }
  },
  "jobCompute": {
    "isResponsible": true|false
  }
}

--analytics-engine (строка)

Двигатель аналитики.

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

  • SPARK
  • CLEAN_ROOMS_SQL

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

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

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

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

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

Вывод

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

Информация о сотрудничестве.

id -> (строка)

Уникальный идентификатор сотрудничества.

arn -> (строка)

Уникальный ARN для сотрудничества.

name -> (строка)

Идентификатор, понятный человеку, предоставленный владельцем сотрудничества. Имена для отображения не уникальны.

description -> (строка)

Описание сотрудничества, предоставленное владельцем сотрудничества.

creatorAccountId -> (строка)

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

creatorDisplayName -> (строка)

Имя для отображения создателя сотрудничества.

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

Время создания сотрудничества.

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

Время последнего обновления метаданных сотрудничества.

memberStatus -> (строка)

Статус участника в рамках сотрудничества.

membershipId -> (строка)

Уникальный идентификатор вашей принадлежности к сотрудничеству.

membershipArn -> (строка)

Уникальный ARN для вашей принадлежности к сотрудничеству.

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

Настройки шифрования данных на стороне клиента для криптографических вычислений.

allowCleartext -> (булево)

Указывает, могут ли зашифрованные таблицы содержать открытый текст (TRUE ) или должны криптографически обрабатывать каждый столбец (FALSE ).

allowDuplicates -> (булево)

Указывает, могут ли столбцы отпечатков пальцев содержать дублированные записи (TRUE ) или должны содержать только уникальные значения (FALSE ).

allowJoinsOnColumnsWithDifferentNames -> (булево)

Указывает, могут ли столбцы отпечатков пальцев быть объединены с любым другим столбцом отпечатков пальцев с другим именем (TRUE ) или только с столбцами отпечатков пальцев с одинаковым именем (FALSE ).

preserveNulls -> (булево)

Указывает, должны ли значения NULL копироваться как NULL в зашифрованные таблицы (TRUE ) или обрабатываться криптографически (FALSE ).

queryLogStatus -> (строка)

Указатель, включена или выключена регистрация запросов для сотрудничества.

При ENABLED Clean Rooms регистрирует подробности о запросах, выполняемых в рамках этого сотрудничества, и эти журналы можно просмотреть в Amazon CloudWatch Logs. Значение по умолчанию - DISABLED .

jobLogStatus -> (строка)

Указатель, включена или выключена регистрация задач для сотрудничества.

При ENABLED Clean Rooms регистрирует подробности о задачах, выполняемых в рамках этого сотрудничества, и эти журналы можно просмотреть в Amazon CloudWatch Logs. Значение по умолчанию - DISABLED .

analyticsEngine -> (строка)

Двигатель аналитики для сотрудничества.

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

Spec-Zone.ru

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