[ aws . configservice ]
describe-organization-config-rules
Описание
Возвращает список правил конфигурации организации.
Примечание
При указании лимита и маркера следующей страницы вы получаете постраничный ответ.
Лимит и маркер следующей страницы не применяются, если вы указываете имена правил конфигурации организации. Они применяются только в случае запроса всех правил конфигурации организации.
Если вы развернули организационное правило или набор соответствия в учетной записи администратора организации, а затем создали делегированного администратора и развернули организационное правило или набор соответствия в учетной записи делегированного администратора, вы не сможете увидеть организационное правило или набор соответствия в учетной записи администратора организации из учетной записи делегированного администратора или увидеть организационное правило или набор соответствия в учетной записи делегированного администратора из учетной записи администратора организации. API DescribeOrganizationConfigRules и DescribeOrganizationConformancePacks могут видеть и взаимодействовать только с ресурсами, относящимися к организации, которые были развернуты изнутри вызывающей эти API учетной записи.
См. также: Документацию API AWS
describe-organization-config-rules — это постраничная операция. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в постраничном ответе аргумент --query должен извлекать данные из результатов следующих выражений запроса: OrganizationConfigRules
Синтаксис
describe-organization-config-rules
[--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
- text
- table
- yaml
- yaml-stream
--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.
Вывод
OrganizationConfigRules -> (список)
Возвращает список OrganizationConfigRule объектов.
(структура)
Правило конфигурации организации, содержащее информацию о правилах конфигурации, создаваемых Config в учетных записях-членах.
OrganizationConfigRuleName -> (строка)
OrganizationConfigRuleArn -> (строка)
OrganizationManagedRuleMetadata -> (структура)
Объект OrganizationManagedRuleMetadata.
Description -> (строка)
RuleIdentifier -> (строка)
IAM_PASSWORD_POLICY — это управляемое правило. Для ссылки на управляемое правило см. Использование управляемых правил Config.InputParameters -> (строка)
MaximumExecutionFrequency -> (строка)
Максимальная частота выполнения оценок правила Config. Это относится к управляемому правилу Config, которое запускается с периодической частотой.
Примечание
По умолчанию правила с периодическим триггером оцениваются каждые 24 часа. Для изменения частоты укажите допустимое значение параметраMaximumExecutionFrequency.ResourceTypesScope -> (список)
Тип ресурса Amazon Web Services, который был оценен.
(строка)
ResourceIdScope -> (строка)
TagKeyScope -> (строка)
TagValueScope -> (строка)
OrganizationCustomRuleMetadata -> (структура)
Объект OrganizationCustomRuleMetadata.
Description -> (строка)
LambdaFunctionArn -> (строка)
OrganizationConfigRuleTriggerTypes -> (список)
Тип уведомления, который запускает Config для выполнения оценки правила. Вы можете указать следующие типы уведомлений:
-
ConfigurationItemChangeNotification— запускает оценку при доставке элемента конфигурации Config в результате изменения ресурса. -
OversizedConfigurationItemChangeNotification— запускает оценку при доставке чрезмерно большого элемента конфигурации. Config может генерировать этот тип уведомления при изменении ресурса, если уведомление превышает максимальный размер, разрешенный Amazon SNS. -
ScheduledNotification— запускает периодическую оценку с частотой, заданной дляMaximumExecutionFrequency.
(строка)
InputParameters -> (строка)
MaximumExecutionFrequency -> (строка)
Максимальная частота выполнения оценок правила Config. Ваше пользовательское правило запускается, когда Config предоставляет моментальный снимок конфигурации. Дополнительная информация в ConfigSnapshotDeliveryProperties.
Примечание
По умолчанию правила с периодическим триггером оцениваются каждые 24 часа. Для изменения частоты укажите допустимое значение для параметраMaximumExecutionFrequency.ResourceTypesScope -> (список)
Тип ресурса Amazon Web Services, который был оценен.
(строка)
ResourceIdScope -> (строка)
TagKeyScope -> (строка)
TagValueScope -> (строка)
ExcludedAccounts -> (список)
Список учетных записей, исключенных из правила конфигурации организации, разделенный запятыми.
(строка)
LastUpdateTime -> (метка времени)
OrganizationCustomPolicyRuleMetadata -> (структура)
Объект, который определяет метаданные для правила пользовательской политики конфигурации вашей организации. Метаданные включают используемую среду выполнения, учетные записи, для которых включен отладка протоколирование, и другие метаданные пользовательского правила, такие как тип ресурса, идентификатор ресурса ресурса Amazon Web Services и типы триггеров организации, которые запускают Config для оценки ресурсов Amazon Web Services по отношению к правилу.
Description -> (строка)
OrganizationConfigRuleTriggerTypes -> (список)
Тип уведомления, который запускает Config для выполнения оценки правила. Для правил пользовательской политики конфигурации Config поддерживает типы уведомлений при изменениях:
-
ConfigurationItemChangeNotification— запускает оценку при доставке элемента конфигурации Config в результате изменения ресурса. -
OversizedConfigurationItemChangeNotification— запускает оценку при доставке чрезмерно большого элемента конфигурации. Config может генерировать этот тип уведомления при изменении ресурса, если уведомление превышает максимальный размер, разрешенный Amazon SNS.
(строка)
InputParameters -> (строка)
MaximumExecutionFrequency -> (строка)
ResourceTypesScope -> (список)
Тип ресурса Amazon Web Services, который был оценен.
(строка)
ResourceIdScope -> (строка)
TagKeyScope -> (строка)
TagValueScope -> (строка)
PolicyRuntime -> (строка)
DebugLogDeliveryAccounts -> (список)
Список учетных записей, для которых можно включить отладку протоколирование для правила пользовательской политики конфигурации вашей организации. Список равен null, если отладка протоколирование включена для всех учетных записей.
(строка)
NextToken -> (строка)
nextToken, возвращенная на предыдущей странице, используемая для получения следующей страницы результатов в пагинации.
© Copyright 2025, Amazon Web Services. Created using Sphinx.