Spec-Zone.ru › AWS CLI v2

[ aws . configservice ]

describe-organization-config-rule-statuses

Описание

Предоставляет состояние развертывания правил конфигурации организации для организации.

Примечание

Состояние не считается успешным до тех пор, пока правило конфигурации организации не будет успешно развернуто во всех учетных записях-членах за исключением исключённых.

Когда вы указываете лимит и маркер следующей страницы, вы получаете постраничный ответ. Лимит и маркер следующей страницы не применимы, если вы указываете имена правил конфигурации организации. Они применимы только при запросе всех правил конфигурации организации.

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

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

Синтаксис

  describe-organization-config-rule-statuses
[--organization-config-rule-names <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]

Параметры

--organization-config-rule-names (список)

Имена правил конфигурации организации, для которых требуются подробности о состоянии. Если вы не укажете никаких имён, Config вернёт сведения обо всех ваших правилах конфигурации организации.

(строка)

Синтаксис:

"string" "string" ...

--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 (логическое значение)

Отключить тулбар кли AWS для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

OrganizationConfigRuleStatuses -> (список)

Список объектов OrganizationConfigRuleStatus.

(структура)

Возвращает состояние правила конфигурации организации в организации.

OrganizationConfigRuleName -> (строка)

Наименование, которое вы присваиваете правилу конфигурации организации.

OrganizationRuleStatus -> (строка)

Указывает состояние развертывания правила конфигурации организации. Когда управляющая учетная запись в первый раз вызывает действие PutOrganizationConfigRule, состояние правила конфигурации создаётся во всех учетных записях-членах. Когда управляющая учетная запись во второй раз вызывает действие PutOrganizationConfigRule, состояние правила конфигурации обновляется во всех учетных записях-членах. Кроме того, состояние правила конфигурации обновляется, когда одна или несколько учетных записей-членов присоединяются или покидают организацию. Состояние правила конфигурации удаляется, когда управляющая учетная запись удаляет OrganizationConfigRule во всех учетных записях-членах и отключает доступ к службе для config-multiaccountsetup.amazonaws.com.

Config устанавливает состояние правила следующим образом:

  • CREATE_SUCCESSFUL, когда правило конфигурации организации было успешно создано во всех учетных записях-членах.
  • CREATE_IN_PROGRESS, когда создание правила конфигурации организации в процессе.
  • CREATE_FAILED, когда создание правила конфигурации организации завершилось неудачей в одной или нескольких учетных записях-членах в этой организации.
  • DELETE_FAILED, когда удаление правила конфигурации организации завершилось неудачей в одной или нескольких учетных записях-членах в этой организации.
  • DELETE_IN_PROGRESS, когда удаление правила конфигурации организации в процессе.
  • DELETE_SUCCESSFUL, когда правило конфигурации организации было успешно удалено из всех учетных записей-членов.
  • UPDATE_SUCCESSFUL, когда правило конфигурации организации было успешно обновлено во всех учетных записях-членах.
  • UPDATE_IN_PROGRESS, когда обновление правила конфигурации организации в процессе.
  • UPDATE_FAILED, когда обновление правила конфигурации организации завершилось неудачей в одной или нескольких учетных записях-членах в этой организации.

ErrorCode -> (строка)

Код ошибки, возвращаемый, когда создание или удаление правила конфигурации организации завершилось неудачей.

ErrorMessage -> (строка)

Сообщение об ошибке, указывающее, что создание или удаление правила конфигурации организации завершилось неудачей из-за ошибки.

LastUpdateTime -> (отметка времени)

Отметка времени последнего обновления.

NextToken -> (строка)

Строка nextToken, возвращённая на предыдущей странице, которую вы используете для получения следующей страницы результатов в постраничном ответе.

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

Spec-Zone.ru

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