Spec-Zone.ru › AWS CLI v2

[ aws . iam ]

list-roles

Описание

Перечисляет роли IAM, имеющие указанный префикс пути. Если таких ролей нет, операция возвращает пустой список. Дополнительную информацию о ролях см. в разделе «Роли IAM» в Руководстве пользователя IAM.

Примечание

Операции по перечислению ресурсов IAM возвращают подмножество доступных атрибутов для ресурса. Данная операция не возвращает следующие атрибуты, хотя они являются атрибутами возвращаемого объекта:

  • PermissionsBoundary
  • RoleLastUsed
  • Теги

Чтобы просмотреть всю информацию о роли, см. GetRole.

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

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

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

Синтаксис

  list-roles
[--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 (строка)

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

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

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

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

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

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

--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-roles перечисляет роли IAM для текущей учетной записи.

aws iam list-roles

Вывод:

{
    "Roles": [
        {
            "Path": "/",
            "RoleName": "ExampleRole",
            "RoleId": "AROAJ52OTH4H7LEXAMPLE",
            "Arn": "arn:aws:iam::123456789012:role/ExampleRole",
            "CreateDate": "2017-09-12T19:23:36+00:00",
            "AssumeRolePolicyDocument": {
                "Version": "2012-10-17",
                "Statement": [
                    {
                        "Sid": "",
                        "Effect": "Allow",
                        "Principal": {
                            "Service": "ec2.amazonaws.com"
                        },
                        "Action": "sts:AssumeRole"
                    }
                ]
            },
            "MaxSessionDuration": 3600
        },
        {
            "Path": "/example_path/",
            "RoleName": "ExampleRoleWithPath",
            "RoleId": "AROAI4QRP7UFT7EXAMPLE",
            "Arn": "arn:aws:iam::123456789012:role/example_path/ExampleRoleWithPath",
            "CreateDate": "2023-09-21T20:29:38+00:00",
            "AssumeRolePolicyDocument": {
                "Version": "2012-10-17",
                "Statement": [
                    {
                        "Sid": "",
                        "Effect": "Allow",
                        "Principal": {
                            "Service": "ec2.amazonaws.com"
                        },
                        "Action": "sts:AssumeRole"
                    }
                ]
            },
            "MaxSessionDuration": 3600
        }
    ]
}

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

Вывод

Роли -> (список)

Список ролей.

(структура)

Содержит информацию об IAM-роли. Эта структура возвращается в качестве элемента ответа в нескольких операциях API, которые взаимодействуют с ролями.

Путь -> (строка)

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

Имя роли -> (строка)

Дружественное имя, которое идентифицирует роль.

Идентификатор роли -> (строка)

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

ARN -> (строка)

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

Дата создания -> (временная метка)

Дата и время создания роли в формате ISO 8601.

Документ политики AssumeRole -> (строка)

Политика, предоставляющая субъекту разрешение на принятие роли.

Описание -> (строка)

Описание роли, которое вы предоставляете.

Максимальная продолжительность сеанса -> (целое число)

Максимальная продолжительность сеанса (в секундах) для указанной роли. Любой, кто использует командную строку или API для принятия роли, может указать продолжительность, используя необязательный параметр API или параметр командной строки.

Граница разрешений -> (структура)

ARN политики, используемой для установки границы разрешений для роли.

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

Тип границы разрешений -> (строка)

Тип использования границы разрешений, указывающий, какой тип IAM-ресурса используется в качестве границы разрешений для субъекта. Этот тип данных может иметь только значение Policy.

ARN границы разрешений -> (строка)

ARN политики, используемой для установки границы разрешений для пользователя или роли.

Теги -> (список)

Список тегов, прикрепленных к роли. Дополнительную информацию о тегах см. в руководстве по IAM.

(структура)

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

Ключ -> (строка)

Имя ключа, которое можно использовать для поиска или извлечения связанного значения. Например, Department или Cost Center — распространенные варианты.

Значение -> (строка)

Значение, связанное с этим тегом. Например, теги с именем ключа Department могут иметь значения, такие как Human Resources, Accounting и Support. Теги с именем ключа Cost Center могут иметь значения, состоящие из числа, связанного с различными центрами затрат в вашей компании. Обычно у многих ресурсов есть теги с одинаковым именем ключа, но с разными значениями.

Примечание

Amazon Web Services всегда интерпретирует тег Value как одну строку. Если вам нужно сохранить массив, вы можете сохранить значения, разделенные запятыми, в строке. Однако вы должны интерпретировать значение в вашем коде.

Последнее использование роли -> (структура)

Содержит информацию о последнем использовании IAM-роли. Это включает дату и время, а также регион, в котором роль была в последний раз использована. Данные о действиях отображаются только за последние 400 дней. Этот период может быть короче, если ваш регион начал поддерживать эти функции в течение последнего года. Возможно, роль была использована более 400 дней назад. Дополнительную информацию см. в руководстве по IAM.

Дата последнего использования -> (временная метка)

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

Это поле равно null, если роль не использовалась в течение периода отслеживания IAM. Дополнительную информацию о периоде отслеживания см. в руководстве по IAM.

Регион -> (строка)

Название Amazon Web Services региона, в котором роль была в последний раз использована.

IsTruncated -> (булево)

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

Маркер -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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