Spec-Zone.ru › AWS CLI v2

[ aws . identitystore ]

list-groups

Описание

Выводит список всех групп в хранилище идентификаторов. Возвращает постраничный список полных Group объектов. Фильтрация по Group по атрибуту DisplayName устарела. Используйте вместо этого действие API GetGroupId.

Примечание

Если у вас есть доступ администратора к учётной записи участника, вы можете использовать этот API из учётной записи участника. Подробнее об учётных записях участников см. в руководстве пользователя Organizations.

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

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

Синтаксис

  list-groups
--identity-store-id <value>
[--filters <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]

Параметры

--identity-store-id (строка)

Глобально уникальный идентификатор хранилища идентификаторов, например, d-1234567890. В этом примере d- — это фиксированный префикс, а 1234567890 — случайная строка, содержащая цифры и строчные буквы. Это значение генерируется при создании нового хранилища идентификаторов.

--filters (список)

Список Filter объектов, используемых в запросах ListUsers и ListGroups.

(структура)

Фильтр запроса, используемый в ListUsers и ListGroups. Этот объект фильтра предоставляет имя атрибута и значение атрибута для поиска пользователей или групп.

AttributePath -> (строка)

Путь к атрибуту, используемый для указания имени атрибута для поиска. Максимальная длина 255 символов. Например, UserName — допустимый путь к атрибуту для API ListUsers, а DisplayName — допустимый путь к атрибуту для API ListGroups.

AttributeValue -> (строка)

Представляет данные для атрибута. Каждое значение атрибута описывается как пара «имя-значение».

Сокращённый синтаксис:

AttributePath=string,AttributeValue=string ...

Синтаксис JSON:

[
  {
    "AttributePath": "string",
    "AttributeValue": "string"
  }
  ...
]

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

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

Токен для указания точки начала постраничной обработки. Это NextToken из ранее обрезанного ответа.

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

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

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

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

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

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

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

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

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

Groups -> (список)

Список Group объектов в хранилище идентификаторов.

(структура)

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

GroupId -> (строка)

Идентификатор группы в хранилище идентификаторов.

DisplayName -> (строка)

Значение отображаемого имени группы. Максимальная длина 1024 символа. Это значение может содержать буквы, символы с диакритическими знаками, символы, цифры, знаки препинания, табуляцию, новые строки, возврат каретки, пробелы и неразрывные пробелы в этом атрибуте. Это значение указывается при создании группы и хранится как атрибут объекта группы в хранилище идентификаторов.

ExternalIds -> (список)

Список ExternalId объектов, содержащих идентификаторы, выданные этому ресурсу внешним поставщиком удостоверений.

(структура)

Идентификатор, выданный этому ресурсу внешним поставщиком удостоверений.

Issuer -> (строка)

Выдавший внешний идентификатор.

Id -> (строка)

Идентификатор, выданный этому ресурсу внешним поставщиком удостоверений.

Description -> (строка)

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

IdentityStoreId -> (строка)

Глобально уникальный идентификатор хранилища идентификаторов.

NextToken -> (строка)

Токен постраничной обработки, используемый для операций API ListUsers и ListGroups. Это значение генерируется службой хранилища идентификаторов. Оно возвращается в ответе API, если общее количество результатов превышает размер одной страницы. Этот токен также возвращается, если он1 используется в запросе API для поиска следующей страницы.

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

Spec-Zone.ru

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