Spec-Zone.ru › AWS CLI v2

[ aws . guardduty ]

list-members

Описание

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

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

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

Синтаксис

  list-members
--detector-id <value>
[--only-associated <value>]
[--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]

Параметры

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

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

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

--only-associated (строка)

Указывает, нужно ли возвращать только связанные члены или все члены (включая членов, которые еще не были приглашены или от которых была разорвана связь). Учетные записи-члены должны быть предварительно связаны с учетной записью администратора GuardDuty с помощью ` Create Members https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html`__ .

--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
  • текст
  • таблица
  • 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.

Примеры

Примечание

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

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

Пример 1: Чтобы отобразить только текущих членов в текущем регионе

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

aws guardduty list-members \
    --detector-id 12abc34d567e8fa901bc2d34eexample \
    --only-associated="true"

Вывод:

{
    "Members": [
        {
            "RelationshipStatus": "Enabled",
            "InvitedAt": "2020-06-09T22:49:00.910Z",
            "MasterId": "111122223333",
            "DetectorId": "7ab8b2f61b256c87f793f6a86example",
            "UpdatedAt": "2020-06-09T23:08:22.512Z",
            "Email": "your+member@example.com",
            "AccountId": "123456789012"
        }
    ]
}

Дополнительную информацию см. в разделе Отношения между учетной записью администратора GuardDuty и учетными записями-членами в Руководстве пользователя GuardDuty.

Пример 2: Чтобы отобразить всех членов в текущем регионе

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

aws guardduty list-members \
    --detector-id 12abc34d567e8fa901bc2d34eexample \
    --only-associated="false"

Вывод:

{
    "Members": [
        {
            "RelationshipStatus": "Enabled",
            "InvitedAt": "2020-06-09T22:49:00.910Z",
            "MasterId": "111122223333",
            "DetectorId": "7ab8b2f61b256c87f793f6a86example",
            "UpdatedAt": "2020-06-09T23:08:22.512Z",
            "Email": "your+other+member@example.com",
            "AccountId": "555555555555"
        }
    ]
}

Дополнительную информацию см. в разделе Отношения между учетной записью администратора GuardDuty и учетными записями-членами в Руководстве пользователя GuardDuty.

Вывод

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

Список членов.

Примечание

Значения email и invitedAt доступны только в том случае, если учетные записи-члены добавлены по приглашению.

(структура)

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

AccountId -> (строка)

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

DetectorId -> (строка)

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

MasterId -> (строка)

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

Email -> (строка)

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

RelationshipStatus -> (строка)

Статус отношений между членом и администратором.

InvitedAt -> (строка)

Отметка времени, когда было отправлено приглашение.

UpdatedAt -> (строка)

Отметка времени последнего обновления члена.

AdministratorId -> (строка)

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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