Spec-Zone.ru › AWS CLI v2

[ aws . ram ]

list-principals

Описание

Выводит список принципалов, с которыми вы или которые с вами делят ресурсы.

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

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

Синтаксис

  list-principals
--resource-owner <value>
[--resource-arn <value>]
[--principals <value>]
[--resource-type <value>]
[--resource-share-arns <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]

Параметры

--resource-owner (строка)

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

  • **SELF ** — принципалы, с которыми ваш аккаунт разделяет ресурсы
  • **OTHER-ACCOUNTS ** — принципалы, которые делят ресурсы с вашим аккаунтом

Возможные значения:

  • SELF
  • OTHER-ACCOUNTS

--resource-arn (строка)

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

--principals (список)

Указывает, что вы хотите получить информацию только для указанных принципалов.

Вы можете включить следующие значения:

  • Идентификатор аккаунта Amazon Web Services, например: 123456789012
  • Amazon Resource Name (ARN) организации в Organizations, например: organizations::123456789012:organization/o-exampleorgid
  • ARN подразделения организации (OU) в Organizations, например: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
  • ARN роли IAM, например: iam::123456789012:role/rolename
  • ARN пользователя IAM, например: iam::123456789012user/username

Примечание

Не все типы ресурсов могут быть разделены с ролями и пользователями IAM. Дополнительную информацию см. в разделе «Делится с ролями и пользователями IAM» в руководстве пользователя Resource Access Manager.

(строка)

Синтаксис:

"string" "string" ...

--resource-type (строка)

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

Для получения списка допустимых значений обратитесь к операции ListResourceTypes.

--resource-share-arns (список)

Указывает, что вы хотите получить информацию только о принципалах, связанных с ресурсными общими, указанными в списке Amazon Resource Names (ARN).

(строка)

Синтаксис:

"string" "string" ...

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

Для вывода списка принципалов с доступом к ресурсу

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

aws ram list-principals \
    --resource-type ec2:Subnet

Вывод:

{
    "principals": [
        {
            "id": "arn:aws:organizations::123456789012:ou/o-gx7EXAMPLE/ou-29c5-zEXAMPLE",
            "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE",
            "creationTime": 1565298209.737,
            "lastUpdatedTime": 1565298211.019,
            "external": false
        }
    ]
}

Вывод

principals -> (список)

Массив объектов, содержащих подробности о принципалах.

(структура)

Описывает принципал для использования с Resource Access Manager.

id -> (строка)

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

resourceShareArn -> (строка)

Amazon Resource Name (ARN) ресурсного общего, с которым связан принципал.

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

Дата и время, когда принципал был связан с ресурсным общим.

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

Дата и время последнего обновления ассоциации между ресурсным общим и принципалом.

external -> (булево)

Указывает взаимоотношение между аккаунтом Amazon Web Services, к которому принадлежит принципал, и аккаунтом, который владеет ресурсным общим:

  • True — Два аккаунта принадлежат одной организации.
  • False — Два аккаунта не принадлежат одной организации.

nextToken -> (строка)

При наличии это значение указывает, что доступно больше вывода, чем включено в текущем ответе. Используйте это значение в параметре запроса NextToken в последующем вызове операции для получения следующей части вывода. Вы должны повторять это до тех пор, пока элемент ответа NextToken не вернет null . Это указывает на то, что это последняя страница результатов.

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

Spec-Zone.ru

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