[ aws . organizations ]
list-children
Описание
Выводит список всех организационных подразделений (OU) или учётных записей, содержащихся в указанном родительском OU или корневом элементе. Эта операция, наряду с ListParents, позволяет вам переходить по структуре дерева, составляющего этот корень.
Примечание
Всегда проверяйте параметр ответаNextToken на наличие значения null при вызове операции List*. Эти операции могут иногда возвращать пустой набор результатов, даже когда доступно больше результатов. Значение параметра ответа NextToken равно null только в том случае, если больше результатов для отображения нет.Эта операция может вызываться только из учётной записи управления организацией или учётной записью-членом, являющейся делегированным администратором сервиса Amazon Web Services.
См. также: Документация API AWS
list-children — это операция с постраничной передачей. Для получения всего набора результатов может потребоваться несколько API-вызовов. Вы можете отключить постраничную передачу, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей аргумент --query должен извлекать данные из результатов следующих выражений запроса: Children
Синтаксис
list-children
--parent-id <value>
--child-type <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, список дочерних элементов которого требуется получить.
Шаблон регулярного выражения для строки идентификатора родителя требует одного из следующего:
- Корень - Строка, начинающаяся с «r-», за которой следуют от 4 до 32 строчных букв или цифр.
- Организационное подразделение (OU) - Строка, начинающаяся с «ou-», за которой следуют от 4 до 32 строчных букв или цифр (ID корня, в котором находится OU). Эта строка следует за вторым дефисом «-» и от 8 до 32 дополнительных строчных букв или цифр.
--child-type (строка)
Фильтрует вывод, включая только указанный тип дочернего элемента.
Возможные значения:
ACCOUNTORGANIZATIONAL_UNIT
--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 для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы параметров входных данных CLI.
Примеры
Примечание
Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Подробности см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, во всех примерах используются правила цитирования по аналогии с UNIX. Эти примеры потребуют адаптации к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.
Чтобы получить дочерние учётные записи и OU родительского OU или корня
Следующий пример показывает, как получить список корня или OU, содержащего учётную запись 444444444444:
aws organizations list-children --child-type ORGANIZATIONAL_UNIT --parent-id ou-examplerootid111-exampleouid111
Вывод отображает два дочерних OU, содержащихся в родительском элементе:
{
"Children": [
{
"Id": "ou-examplerootid111-exampleouid111",
"Type":"ORGANIZATIONAL_UNIT"
},
{
"Id":"ou-examplerootid111-exampleouid222",
"Type":"ORGANIZATIONAL_UNIT"
}
]
}
Вывод
Дочерние элементы -> (список)
Список дочерних элементов указанного родительского контейнера.
(структура)
Содержит список дочерних сущностей, OU или учётных записей.
Id -> (строка)
Уникальный идентификатор (ID) этой дочерней сущности.
Шаблон регулярного выражения для строки идентификатора дочернего элемента требует одного из следующего:
- Учётная запись - Строка, состоящая ровно из 12 цифр.
- Организационное подразделение (OU) - Строка, начинающаяся с «ou-», за которой следуют от 4 до 32 строчных букв или цифр (ID корня, содержащего OU). Эта строка следует за вторым дефисом «-» и от 8 до 32 дополнительных строчных букв или цифр.
Тип -> (строка)
NextToken -> (строка)
NextToken в последующем вызове операции, чтобы получить следующую часть вывода. Вы должны повторять это до тех пор, пока элемент ответа NextToken не вернётся со значением null.
© Copyright 2025, Amazon Web Services. Created using Sphinx.