Spec-Zone.ru › AWS CLI v2

[ aws . ds-data ]

list-groups-for-member

Описание

Возвращает информацию о группах для указанного участника.

Данная операция поддерживает пагинацию с использованием параметров запроса и ответа NextToken. Если доступно больше результатов, член ListGroupsForMember.NextToken содержит маркер, который вы передаёте в следующий вызов ListGroupsForMember. Это позволяет получить следующий набор элементов.

Вы также можете указать максимальное количество возвращаемых результатов с помощью параметра MaxResults.

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

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

Синтаксис

  list-groups-for-member
--directory-id <value>
[--member-realm <value>]
[--realm <value>]
--sam-account-name <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]

Параметры

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

Идентификатор (ID) каталога, связанного с участником.

--member-realm (строка)

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

Примечание

Этот параметр необязателен, поэтому вы можете ограничить результаты участниками групп в определённом домене.

Этот параметр нечувствителен к регистру и по умолчанию равен Realm

--realm (строка)

Имя домена, связанное с группой.

Примечание

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

Это значение нечувствительно к регистру и по умолчанию равно вашему домену управляемой Microsoft AD.

--sam-account-name (строка)

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

--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 (целое число)

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

Для перечисления членства в группах каталога

Следующий пример list-groups-for-member перечисляет членство в группах для указанного пользователя в указанном каталоге.

aws ds-data list-groups-for-member \
    --directory-id d-1234567890 \
    --sam-account-name 'john.doe'

Вывод:

{
    "Groups": [
        {
            "GroupScope": "Global",
            "GroupType": "Security",
            "SAMAccountName": "Domain Users",
            "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567"
        }
    ],
    "DirectoryId": "d-1234567890",
    "MemberRealm": "corp.example.com",
    "Realm": "corp.example.com"
}

Для получения дополнительной информации см. раздел Просмотр и обновление пользователя управляемой AWS Microsoft AD в Руководстве по администрированию AWS Directory Service.

Вывод

DirectoryId -> (строка)

Идентификатор (ID) каталога, связанного с участником.

Groups -> (список)

Информация о группе, возвращаемая запросом.

(структура)

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

GroupScope -> (строка)

Область действия группы AD. Подробнее см. в разделе Безопасные группы Active Directory.

GroupType -> (строка)

Тип группы AD. Подробнее см. в разделе Тип безопасной группы Active Directory.

SAMAccountName -> (строка)

Название группы.

SID -> (строка)

Уникальный идентификатор безопасности (SID) группы.

MemberRealm -> (строка)

Домен, связанный с участником.

NextToken -> (строка)

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

Realm -> (строка)

Домен, связанный с группой.

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

Spec-Zone.ru

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