Spec-Zone.ru › AWS CLI v2

[ aws . organizations ]

list-parents

Описание

Выводит корневые или организационные единицы (OU), которые являются непосредственными родительскими элементами указанной дочерней OU или учетной записи. Эта операция, вместе с ListChildren, позволяет вам перемещаться по древовидной структуре, которая составляет этот корень.

Примечание

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

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

Примечание

В текущем релизе у дочернего элемента может быть только один родитель.

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

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

Синтаксис

  list-parents
--child-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]

Параметры

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

Уникальный идентификатор (ID) OU или учетной записи, родительские контейнеры которой вы хотите получить. Не указывайте корень.

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

  • Учетная запись - строка, состоящая ровно из 12 цифр.
  • Организационная единица (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
  • текст
  • таблица
  • 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-parents --child-id 444444444444

Вывод показывает, что указанная учетная запись находится в OU с указанным ID:

{
  "Parents": [
        {
          "Id": "ou-examplerootid111-exampleouid111",
          "Type": "ORGANIZATIONAL_UNIT"
        }
  ]
}

Вывод

Родители -> (список)

Список родителей указанной дочерней учетной записи или OU.

(структура)

Содержит информацию о корне или организационной единице (OU), которые могут содержать OU или учетные записи в организации.

Id -> (строка)

Уникальный идентификатор (ID) родительского элемента.

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

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

Тип -> (строка)

Тип родительского элемента.

NextToken -> (строка)

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

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

Spec-Zone.ru

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