Spec-Zone.ru › AWS CLI v2

[ aws . securityhub ]

describe-organization-configuration

Описание

Возвращает информацию о настройках вашей организации в Security Hub. Вызвать эту операцию может только учетная запись администратора Security Hub.

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

Синтаксис

  describe-organization-configuration
[--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
  • текст
  • таблица
  • 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-auto-prompt (логическое значение)

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

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

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для просмотра конфигурации Security Hub для организации

Следующий describe-organization-configuration пример возвращает информацию о конфигурации организации в Security Hub. В этом примере организация использует централизованную конфигурацию. Выполнить эту команду может только учетная запись администратора Security Hub.

aws securityhub describe-organization-configuration

Вывод:

{
    "AutoEnable": false,
    "MemberAccountLimitReached": false,
    "AutoEnableStandards": "NONE",
    "OrganizationConfiguration": {
        "ConfigurationType": "LOCAL",
        "Status": "ENABLED",
        "StatusMessage": "Central configuration has been enabled successfully"
    }
}

Дополнительную информацию см. в разделе Управление учетными записями с помощью AWS Organizations в Руководстве пользователя AWS Security Hub.

Вывод

AutoEnable -> (логическое значение)

Автоматически включить Security Hub в новых учетных записях-членах при их присоединении к организации.

Если установлено true, Security Hub автоматически включен в новых учетных записях. Если установлено false, Security Hub не включается в новые учетные записи автоматически. Значение по умолчанию - false.

Если ConfigurationType вашей организации установлено в CENTRAL, это поле установлено в false и не может быть изменено в домашнем регионе и связанных регионах. Однако в этом случае делегированный администратор может создать политику конфигурации, в которой Security Hub включен, и связать политику с новыми учетными записями организации.

MemberAccountLimitReached -> (логическое значение)

Превышено ли максимальное количество разрешенных учетных записей-членов, уже связанных с учетной записью администратора Security Hub.

AutoEnableStandards -> (строка)

Автоматически включать стандартные настройки Security Hub в новых учетных записях-членах при их присоединении к организации.

Если равно DEFAULT, то стандартные настройки Security Hub автоматически включены для новых учетных записей-членов. Если равно NONE, то стандартные настройки не включаются автоматически для новых учетных записей-членов. Значение по умолчанию для этого параметра равно DEFAULT.

Если ConfigurationType вашей организации установлено в CENTRAL, это поле установлено в NONE и не может быть изменено в домашнем регионе и связанных регионах. Однако в этом случае делегированный администратор может создать политику конфигурации, в которой включены определенные стандарты безопасности, и связать эту политику с новыми учетными записями организации.

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

Предоставляет информацию о конфигурации организации в Security Hub.

ConfigurationType -> (строка)

Указывает, использует ли организация локальную или централизованную конфигурацию.

Если вы используете локальную конфигурацию, делегированный администратор Security Hub может установить AutoEnable в значение true и AutoEnableStandards в значение DEFAULT. Это автоматически включает Security Hub и стандартные настройки безопасности в новых учетных записях организации. Эти новые настройки учетных записей должны быть установлены отдельно в каждом регионе Amazon Web Services, и настройки могут отличаться в каждом регионе.

Если вы используете централизованную конфигурацию, делегированный администратор может создавать политики конфигурации. Политики конфигурации могут использоваться для настройки Security Hub, стандартов безопасности и средств контроля безопасности в нескольких учетных записях и регионах. Если вы хотите, чтобы новые учетные записи организации использовали определенную конфигурацию, вы можете создать политику конфигурации и связать ее с корнем или конкретными организационными единицами (OU). Новые учетные записи унаследуют политику от корня или их назначенной OU.

Status -> (строка)

Описание того, можно ли включить централизованную конфигурацию в качестве ConfigurationType для организации. Если ваша ConfigurationType – это локальная конфигурация, то значение Status всегда равно ENABLED.

StatusMessage -> (строка)

Предоставляет объяснение, если значение Status равно FAILED, когда ConfigurationType равно CENTRAL.

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

Spec-Zone.ru

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