Spec-Zone.ru › AWS CLI v2

[ aws . securityhub ]

list-members

Описание

Отображает данные обо всех учетных записях-членах для текущей учетной записи администратора Security Hub.

Результаты включают учетные записи-члены, которые принадлежат организации, и учетные записи-члены, которые были приглашены вручную.

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

list-members является постраничной операцией. Для получения всего набора результатов могут быть выпущены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Members

Синтаксис

  list-members
[--only-associated | --no-only-associated]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--only-associated | --no-only-associated (логическое значение)

Определяет, какие учетные записи-члены включать в ответ на основе их статуса связи с учетной записью администратора. Значение по умолчанию — TRUE.

Если OnlyAssociated установлено в значение TRUE, ответ включает учетные записи-члены, статус связи которых с учетной записью администратора установлен на ENABLED.

Если OnlyAssociated установлено в значение FALSE, ответ включает все существующие учетные записи-члены.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставляемому --generate-cli-skeleton. Если другие аргументы предоставляются в командной строке, эти значения переопределяют значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Маркер для указания места начала постраничного вывода. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, возвращаемых в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время соединения сокета в секундах. Если значение установлено в 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.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Более подробная информация приведена в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования unix-подобных оболочек. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для получения списка учетных записей-членов

Следующий list-members пример возвращает список учетных записей-членов для запрашиваемой учетной записи администратора.

aws securityhub list-members

Вывод:

{
    "Members": [
        {
            "AccountId": "123456789111",
            "AdministratorId": "123456789012",
            "InvitedAt": 2020-06-01T20:15:15.289000+00:00,
            "MasterId": "123456789012",
            "MemberStatus": "ASSOCIATED",
            "UpdatedAt": 2020-06-01T20:15:15.289000+00:00
        },
        {
            "AccountId": "123456789222",
            "AdministratorId": "123456789012",
            "InvitedAt": 2020-06-01T20:15:15.289000+00:00,
            "MasterId": "123456789012",
            "MemberStatus": "ASSOCIATED",
            "UpdatedAt": 2020-06-01T20:15:15.289000+00:00
        }
    ],
}

Дополнительная информация приведена в разделе Управление учетными записями администратора и членов в Руководстве пользователя AWS Security Hub.

Вывод

Члены -> (список)

Подробная информация о членах, возвращенная операцией.

(структура)

Подробная информация об учетной записи-члене.

AccountId -> (строка)

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

Email -> (строка)

Электронный адрес учетной записи-члена.

MasterId -> (строка)

Это заменено на AdministratorID.

Идентификатор Amazon Web Services учетной записи администратора Security Hub, связанной с этой учетной записью-членом.

AdministratorId -> (строка)

Идентификатор Amazon Web Services учетной записи администратора Security Hub, связанной с этой учетной записью-членом.

MemberStatus -> (строка)

Статус связи между учетной записью-членом и учетной записью администратора.

Статус может иметь одно из следующих значений:

  • Created - Указывает, что учетная запись администратора добавила учетную запись-члена, но еще не пригласила ее.
  • Invited - Указывает, что учетная запись администратора пригласила учетную запись-члена. Учетная запись-член еще не ответила на приглашение.
  • Enabled - Указывает, что учетная запись-член в настоящее время активна. Для учетных записей-членов, приглашенных вручную, указывает, что учетная запись-член приняла приглашение.
  • Removed - Указывает, что учетная запись администратора отключила учетную запись-члена.
  • Resigned - Указывает, что учетная запись-член отключила себя от учетной записи администратора.
  • Deleted - Указывает, что учетная запись администратора удалила учетную запись-члена.
  • AccountSuspended - Указывает, что учетная запись организации была приостановлена в Amazon Web Services одновременно с попыткой учетной записи администратора включить учетную запись организации в качестве учетной записи-члена.

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

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

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

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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