Spec-Zone.ru › AWS CLI v2

[ aws . iam ]

list-groups

Описание

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

Вы можете выполнить постраничную обработку результатов, используя параметры MaxItems и Marker.

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

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

Синтаксис

  list-groups
[--path-prefix <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <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]

Параметры

--path-prefix (строка)

Префикс пути для фильтрации результатов. Например, префикс /division_abc/subdivision_xyz/ получает все группы, путь к которым начинается с /division_abc/subdivision_xyz/.

Этот параметр необязателен. Если он не указан, по умолчанию используется косая черта (/), перечисляя все группы. Этот параметр позволяет (через свой шаблон регулярных выражений) строку символов, состоящую либо из одной косой черты (/), либо из строки, которая должна начинаться и заканчиваться косыми чертами. Кроме того, он может содержать любой ASCII-символ от ! (\u0021) до символа DEL (\u007F), включая большинство знаков препинания, цифр и прописных и строчных букв.

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

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

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

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

--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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Чтобы перечислить группы IAM для текущей учетной записи

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

aws iam list-groups

Вывод:

{
    "Groups": [
        {
            "Path": "/",
            "CreateDate": "2013-06-04T20:27:27.972Z",
            "GroupId": "AIDACKCEVSQ6C2EXAMPLE",
            "Arn": "arn:aws:iam::123456789012:group/Admins",
            "GroupName": "Admins"
        },
        {
            "Path": "/",
            "CreateDate": "2013-04-16T20:30:42Z",
            "GroupId": "AIDGPMS9RO4H3FEXAMPLE",
            "Arn": "arn:aws:iam::123456789012:group/S3-Admins",
            "GroupName": "S3-Admins"
        }
    ]
}

Дополнительную информацию см. в разделе Управление группами пользователей IAM в Руководстве пользователя AWS IAM.

Вывод

Groups -> (список)

Список групп.

(структура)

Содержит информацию об объекте группы IAM.

Этот тип данных используется в качестве элемента ответа в следующих операциях:

  • CreateGroup
  • GetGroup
  • ListGroups

Path -> (строка)

Путь к группе. Дополнительную информацию о путях см. в разделе Идентификаторы IAM в Руководстве пользователя IAM.

GroupName -> (строка)

Дружественное имя, идентифицирующее группу.

GroupId -> (строка)

Устойчивая и уникальная строка, идентифицирующая группу. Дополнительную информацию об идентификаторах см. в разделе Идентификаторы IAM в Руководстве пользователя IAM.

Arn -> (строка)

Amazon Resource Name (ARN), определяющий группу. Дополнительную информацию об ARN и о том, как их использовать в политиках, см. в разделе Идентификаторы IAM в Руководстве пользователя IAM.

CreateDate -> (метка времени)

Дата и время создания группы в формате даты и времени ISO 8601.

IsTruncated -> (логическое значение)

Флаг, указывающий, есть ли больше элементов для возврата. Если результаты были урезаны, вы можете выполнить последующий запрос постраничной обработки, используя параметр запроса Marker, чтобы получить больше элементов. Обратите внимание, что IAM может вернуть меньше, чем указанное в MaxItems количество результатов, даже если больше результатов доступны. Рекомендуется проверять IsTruncated после каждого вызова, чтобы убедиться, что вы получаете все свои результаты.

Marker -> (строка)

Когда IsTruncated равно true, этот элемент присутствует и содержит значение для использования в качестве параметра Marker в последующем запросе постраничной обработки.

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

Spec-Zone.ru

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