Spec-Zone.ru › AWS CLI v2

[ aws . organizations ]

list-organizational-units-for-parent

Описание

Выводит организационные единицы (OU) в родительской организационной единице или корневой единице.

Примечание

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

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

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

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

Синтаксис

  list-organizational-units-for-parent
--parent-id <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]

Параметры

--parent-id (строка)

Уникальный идентификатор (ID) корня или OU, дочерние OU которого требуется вывести.

Шаблон регулярных выражений для строки идентификатора родителя требует одного из следующих:

  • Корень - Строка, начинающаяся с “r-” и содержащая от 4 до 32 строчных букв или цифр.
  • Организационная единица (OU) - Строка, начинающаяся с “ou-” и содержащая от 4 до 32 строчных букв или цифр (ID корня, в котором находится OU). Эта строка следуется вторым дефисом “-” и от 8 до 32 дополнительных строчных букв или цифр.

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

Чтобы получить список OU в родительском OU или корне

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

aws organizations list-organizational-units-for-parent --parent-id r-examplerootid111

Вывод показывает, что указанный корень содержит две OU и отображает подробности каждой:

{
        "OrganizationalUnits": [
                {
                        "Name": "AccountingDepartment",
                        "Arn": "arn:aws:organizations::o-exampleorgid:ou/r-examplerootid111/ou-examplerootid111-exampleouid111"
                },
                {
                        "Name": "ProductionDepartment",
                        "Arn": "arn:aws:organizations::o-exampleorgid:ou/r-examplerootid111/ou-examplerootid111-exampleouid222"
                }
        ]
}

Вывод

OrganizationalUnits -> (список)

Список OU в указанном корне или родительском OU.

(структура)

Содержит подробности об организационной единице (OU). OU — это контейнер учетных записей Amazon Web Services в корне организации. Политики, прикрепленные к OU, применяются ко всем учетным записям, содержащимся в этой OU и в любых дочерних OU.

Id -> (строка)

Уникальный идентификатор (ID), связанный с этой OU. ID уникален только для организации.

Шаблон регулярных выражений для строки идентификатора организационной единицы требует «ou-», за которым следуют от 4 до 32 строчных букв или цифр (ID корня, содержащего OU). Эта строка следуется вторым дефисом «-» и от 8 до 32 дополнительных строчных букв или цифр.

Arn -> (строка)

Amazon Resource Name (ARN) этой OU.

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

Name -> (строка)

Название этой OU.

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

NextToken -> (строка)

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

Spec-Zone.ru

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