Spec-Zone.ru › AWS CLI v2

[ aws . organizations ]

list-policies

Описание

Получает список всех политик в организации указанного типа.

Примечание

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

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

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

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

Синтаксис

  list-policies
--filter <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]

Параметры

--filter (строка)

Указывает тип политики, который необходимо включить в ответ. Вы должны указать одно из следующих значений:

  • SERVICE_CONTROL_POLICY
  • RESOURCE_CONTROL_POLICY
  • DECLARATIVE_POLICY_EC2
  • BACKUP_POLICY
  • TAG_POLICY
  • CHATBOT_POLICY
  • AISERVICES_OPT_OUT_POLICY

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

  • SERVICE_CONTROL_POLICY
  • RESOURCE_CONTROL_POLICY
  • TAG_POLICY
  • BACKUP_POLICY
  • AISERVICES_OPT_OUT_POLICY
  • CHATBOT_POLICY
  • DECLARATIVE_POLICY_EC2

--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 Command Line Interface.

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

Примеры

Примечание

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

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

Получение списка всех политик в организации определенного типа

Следующий пример показывает, как получить список SCP, как указано в параметре фильтра:

aws organizations list-policies --filter SERVICE_CONTROL_POLICY

Вывод включает список политик с информацией о сводке:

{
        "Policies": [
                {
                        "Type": "SERVICE_CONTROL_POLICY",
                        "Name": "AllowAllS3Actions",
                        "AwsManaged": false,
                        "Id": "p-examplepolicyid111",
                        "Arn": "arn:aws:organizations::111111111111:policy/service_control_policy/p-examplepolicyid111",
                        "Description": "Enables account admins to delegate permissions for any S3 actions to users and roles in their accounts."
                },
                {
                        "Type": "SERVICE_CONTROL_POLICY",
                        "Name": "AllowAllEC2Actions",
                        "AwsManaged": false,
                        "Id": "p-examplepolicyid222",
                        "Arn": "arn:aws:organizations::111111111111:policy/service_control_policy/p-examplepolicyid222",
                        "Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts."
                },
                {
                        "AwsManaged": true,
                        "Description": "Allows access to every operation",
                        "Type": "SERVICE_CONTROL_POLICY",
                        "Id": "p-FullAWSAccess",
                        "Arn": "arn:aws:organizations::aws:policy/service_control_policy/p-FullAWSAccess",
                        "Name": "FullAWSAccess"
                }
        ]
}

Вывод

Policies -> (список)

Список политик, соответствующих критериям фильтра в запросе. Список вывода не включает содержимое политики. Чтобы увидеть содержимое политики, см. DescribePolicy.

(структура)

Содержит информацию о политике, но не включает содержимое. Чтобы просмотреть содержимое политики, см. DescribePolicy.

Id -> (строка)

Уникальный идентификатор (ID) политики.

Шаблон регулярного выражения для строки ID политики требует «p-», за которым следует от 8 до 128 строчных или прописных букв, цифр или символа подчеркивания (_).

Arn -> (строка)

Amazon Resource Name (ARN) политики.

Дополнительную информацию об ARN в Organizations см. в разделе ARN-форматы, поддерживаемые Organizations, в Справочнике по авторизации служб Amazon Web Services.

Name -> (строка)

Наименование политики.

Шаблон регулярного выражения, используемый для проверки этого параметра, представляет собой строку с любыми символами из диапазона ASCII-символов.

Description -> (строка)

Описание политики.

Type -> (строка)

Тип политики.

AwsManaged -> (булево)

Булево значение, указывающее, является ли указанная политика управляемой политикой Amazon Web Services. Если true, то вы можете подключить политику к корневому элементу, OU или учетной записи, но не можете ее редактировать.

NextToken -> (строка)

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

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

Spec-Zone.ru

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