Spec-Zone.ru › AWS CLI v2

[ aws . organizations ]

describe-organization

Описание

Получает информацию об организации, к которой принадлежит учетная запись пользователя.

Этот оператор может быть вызван из любой учетной записи в организации.

Примечание

Даже если тип политики отображается как доступный в организации, вы можете отключить его отдельно на уровне корневого элемента с помощью DisablePolicyType . Используйте ListRoots для просмотра состояния типов политик для указанного корневого элемента.

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

Синтаксис

  describe-organization
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставляемому --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Передача произвольных двоичных значений с помощью значения, предоставленного в JSON, невозможна, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Получение информации о текущей организации

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

aws organizations describe-organization

Вывод включает объект организации, содержащий подробности об организации:

{
        "Organization": {
                "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111",
                "MasterAccountEmail": "bill@example.com",
                "MasterAccountId": "111111111111",
                "Id": "o-exampleorgid",
                "FeatureSet": "ALL",
                "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid",
                "AvailablePolicyTypes": [
                        {
                                "Status": "ENABLED",
                                "Type": "SERVICE_CONTROL_POLICY"
                        }
                ]
        }
}

Вывод

Organization -> (структура)

Структура, содержащая информацию об организации.

Предупреждение

Часть AvailablePolicyTypes ответа устарела и не должна использоваться в приложениях. Она не включает никакие типы политик, поддерживаемые Organizations, кроме SCP. В регионе Китая (Нинся) никакие типы политик не включены. Чтобы определить, какие типы политик включены в вашей организации, используйте операцию `` ListRoots ``.

Id -> (строка)

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

Шаблон регулярных выражений для строки идентификатора организации требует «o-», за которым следуют от 10 до 32 строчных букв или цифр.

Arn -> (строка)

Amazon Resource Name (ARN) организации.

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

FeatureSet -> (строка)

Указывает функциональные возможности, которые в настоящее время доступны организации. Если установлено значение «ALL», то все функции включены, и политики могут применяться к учетным записям в организации. Если установлено значение «CONSOLIDATED_BILLING», то доступна только функция консолидированного выставления счетов. Дополнительная информация приведена в разделе Включение всех функций в вашей организации в Руководстве пользователя Organizations.

MasterAccountArn -> (строка)

Amazon Resource Name (ARN) учетной записи, назначенной в качестве учетной записи управления организацией.

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

MasterAccountId -> (строка)

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

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

MasterAccountEmail -> (строка)

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

AvailablePolicyTypes -> (список)

Предупреждение

Не использовать. Это поле устарело и не предоставляет полную информацию о политиках в вашей организации.

Для определения политик, включенных и доступных для использования в вашей организации, используйте вместо этого операцию ListRoots.

(структура)

Содержит информацию о типе политики и его состоянии в связанном корневом элементе.

Type -> (строка)

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

Status -> (строка)

Состояние типа политики по отношению к связанному корневому элементу. Для подключения политики указанного типа к корню, OU или учетной записи в этом корне она должна быть доступна в организации и включена для этого корня.

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

Spec-Zone.ru

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