Spec-Zone.ru › AWS CLI v2

[ aws . organizations ]

list-accounts-for-parent

Описание

Выводит список учётных записей в организации, содержащихся в указанном корневом элементе или организационной единице (OU). Если вы укажете корень, вы получите список всех учётных записей, которые не находятся ни в какой OU. Если вы укажете OU, вы получите список всех учётных записей только в этой OU, а не в каких-либо дочерних OU. Чтобы получить список всех учётных записей в организации, используйте операцию ListAccounts.

Примечание

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

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

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

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

Синтаксис

  list-accounts-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), учётные записи которой требуется получить.

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

aws organizations list-accounts-for-parent --parent-id ou-examplerootid111-exampleouid111

Вывод включает список объектов сводного обзора учётных записей.

{
        "Accounts": [
                {
                        "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333",
                        "JoinedMethod": "INVITED",
                        "JoinedTimestamp": 1481835795.536,
                        "Id": "333333333333",
                        "Name": "Development Account",
                        "Email": "juan@example.com",
                        "Status": "ACTIVE"
                },
                {
                        "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444",
                        "JoinedMethod": "INVITED",
                        "JoinedTimestamp": 1481835812.143,
                        "Id": "444444444444",
                        "Name": "Test Account",
                        "Email": "anika@example.com",
                        "Status": "ACTIVE"
                }
        ]
}

Вывод

Учётные записи -> (список)

Список учётных записей в указанном корневом элементе или OU.

(структура)

Содержит информацию об учётной записи Amazon Web Services, являющейся членом организации.

Id -> (строка)

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

Шаблон регулярных выражений для строки ID учётной записи требует ровно 12 цифр.

Arn -> (строка)

Amazon Resource Name (ARN) учётной записи.

Дополнительные сведения о значениях ARN в организациях см. в разделе Форматы ARN, поддерживаемые организациями, в Справочнике по авторизации служб Amazon Web Services.

Email -> (строка)

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

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

Name -> (строка)

Пользовательское имя учётной записи.

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

Status -> (строка)

Статус учётной записи в организации.

JoinedMethod -> (строка)

Способ присоединения учётной записи к организации.

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

Дата присоединения учётной записи к организации.

NextToken -> (строка)

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

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

Spec-Zone.ru

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