Spec-Zone.ru › AWS CLI v2

[ aws . guardduty ]

Приглашение участников

Описание

Приглашает учетные записи Amazon Web Services для членства в организации, управляемой учетной записью Amazon Web Services, которая вызывает этот API. Если вы используете Amazon Web Services Organizations для управления средой GuardDuty, этот шаг не требуется. Дополнительную информацию см. в разделе Управление учетными записями с помощью организаций.

Чтобы пригласить учетные записи Amazon Web Services, первым шагом является обеспечение того, что GuardDuty включен в потенциальных учетных записях-участниках. Теперь вы можете вызвать этот API для добавления учетных записей по приглашению. Приглашенные учетные записи могут либо принять, либо отклонить приглашение из своих учетных записей GuardDuty. Каждая приглашенная учетная запись Amazon Web Services может выбрать принять приглашение только от одной учетной записи Amazon Web Services. Дополнительную информацию см. в разделе Управление учетными записями GuardDuty по приглашению.

После принятия приглашения и при выборе отсоединения учетной записи-участника (с помощью DisassociateMembers ) от вашей учетной записи, подробности учетной записи-участника, полученные путем вызова CreateMembers , включая связанные адреса электронной почты, будут сохранены. Это делается для того, чтобы вы могли вызвать InviteMembers без необходимости повторного вызова CreateMembers. Чтобы удалить данные, связанные с учетной записью-участником, необходимо также вызвать DeleteMembers.

Если вы отсоединяете учетную запись-участника, добавленную по приглашению, подробности учетной записи-участника, полученные с помощью этого API, включая связанные адреса электронной почты, будут сохранены. Это делается для того, чтобы делегированный администратор мог вызвать API InviteMembers без необходимости повторного вызова API CreateMembers. Чтобы удалить данные, связанные с учетной записью-участником, делегированный администратор должен вызвать API DeleteMembers.

Когда учетные записи-участники, добавленные через Organizations, позже отсоединяются, вы (администратор) не можете пригласить их, вызвав API InviteMembers. Вы можете снова создать ассоциацию с этими учетными записями-участниками только, вызвав API CreateMembers.

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

Синтаксис

  invite-members
--detector-id <value>
--account-ids <value>
[--disable-email-notification | --no-disable-email-notification]
[--message <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]

Параметры

--detector-id (строка)

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

Чтобы найти detectorId в текущем регионе, см. страницу Настройки в консоли GuardDuty или выполните API ListDetectors.

--account-ids (список)

Список идентификаторов учетных записей учетных записей, которых вы хотите пригласить в GuardDuty в качестве участников.

(строка)

Синтаксис:

"string" "string" ...

--disable-email-notification | --no-disable-email-notification (булево)

Булево значение, указывающее, хотите ли вы отключить уведомления по электронной почте для учетных записей, которые вы приглашаете в GuardDuty в качестве участников.

--message (строка)

Сообщение приглашения, которое вы хотите отправить учетным записям, которых вы приглашаете в GuardDuty в качестве участников.

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

Вывод

UnprocessedAccounts -> (список)

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

(структура)

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

AccountId -> (строка)

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

Result -> (строка)

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

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

Spec-Zone.ru

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