Spec-Zone.ru › AWS CLI v2

[ aws . cleanrooms ]

получить-совместную-работу

Описание

Возвращает метаданные о совместной работе.

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

Синтаксис

  get-collaboration
--collaboration-identifier <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]

Параметры

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

Идентификатор совместной работы.

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

Вывод

совместная_работа -> (структура)

Полная информация о совместной работе по этому идентификатору.

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