Spec-Zone.ru › AWS CLI v2

[ aws . fms ]

получить-административный-охват

Описание

Возвращает информацию об административном охвате указанной учетной записи. Административный охват определяет ресурсы, которые может управлять администратор Firewall Manager.

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

Синтаксис

  get-admin-scope
--admin-account <value>
[--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]

Параметры

--admin-account (строка)

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

--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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

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

Содержит подробную информацию об административном охвате запрошенной учетной записи.

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

Определяет учетные записи, к которым указанный администратор Firewall Manager может применять политики.

Accounts -> (список)

Список учетных записей в организации, к которым указанный администратор Firewall Manager может или не может применять политики, в зависимости от значения ExcludeSpecifiedAccounts . Если ExcludeSpecifiedAccounts установлено в true , то администратор Firewall Manager может применять политики ко всем членам организации, за исключением учетных записей в этом списке. Если ExcludeSpecifiedAccounts установлено в false , то администратор Firewall Manager может применять политики только к учетным записям в этом списке.

(строка)

AllAccountsEnabled -> (булево)

Булево значение, указывающее, может ли администратор применять политики ко всем учетным записям в организации. Если true, администратор может применять политики ко всем учетным записям в организации. Вы можете либо включить управление всеми учетными записями с помощью этой операции, либо указать список учетных записей для управления в AccountScope$Accounts. Вы не можете указать оба варианта.

ExcludeSpecifiedAccounts -> (булево)

Булево значение, исключающее учетные записи в AccountScope$Accounts из охвата администратора. Если true, администратор Firewall Manager может применять политики ко всем членам организации, за исключением учетных записей, перечисленных в AccountScope$Accounts. Вы можете либо указать список учетных записей для исключения с помощью AccountScope$Accounts, либо включить управление всеми учетными записями с помощью AccountScope$AllAccountsEnabled. Вы не можете указать оба варианта.

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

Определяет организационные подразделения Organizations, к которым указанный администратор Firewall Manager может применять политики. Для получения дополнительной информации об OU в Organizations см. Управление организационными подразделениями (OU) в руководстве пользователя Organizations.

OrganizationalUnits -> (список)

Список OU в организации, к которым указанный администратор Firewall Manager может или не может применять политики, в зависимости от значения OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits . Если OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits установлено в true , то администратор Firewall Manager может применять политики ко всем OU в организации, за исключением OU в этом списке. Если OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits установлено в false , то администратор Firewall Manager может применять политики только к OU в этом списке.

(строка)

AllOrganizationalUnitsEnabled -> (булево)

Булево значение, указывающее, может ли администратор применять политики ко всем OU в организации. Если true, администратор может управлять всеми OU в организации. Вы можете либо включить управление всеми OU с помощью этой операции, либо указать OU для управления в OrganizationalUnitScope$OrganizationalUnits. Вы не можете указать оба варианта.

ExcludeSpecifiedOrganizationalUnits -> (булево)

Булево значение, исключающее OU в OrganizationalUnitScope$OrganizationalUnits из охвата администратора. Если true, администратор Firewall Manager может применять политики ко всем OU в организации, за исключением OU, перечисленных в OrganizationalUnitScope$OrganizationalUnits. Вы можете либо указать список OU для исключения с помощью OrganizationalUnitScope$OrganizationalUnits, либо включить управление всеми OU с помощью OrganizationalUnitScope$AllOrganizationalUnitsEnabled. Вы не можете указать оба варианта.

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

Определяет регионы Amazon Web Services, в которых указанный администратор Firewall Manager может выполнять действия.

Regions -> (список)

Регионы Amazon Web Services, в которых указанный администратор Firewall Manager может выполнять действия.

(строка)

AllRegionsEnabled -> (булево)

Позволяет указанному администратору Firewall Manager управлять всеми регионами Amazon Web Services.

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

Определяет типы политик Firewall Manager, которые может создавать и управлять указанный администратор Firewall Manager.

PolicyTypes -> (список)

Список типов политик, которыми может управлять указанный администратор Firewall Manager.

(строка)

AllPolicyTypesEnabled -> (булево)

Позволяет указанному администратору Firewall Manager управлять всеми типами политик Firewall Manager, кроме типов политик сторонних производителей. Типы политик сторонних производителей могут управляться только администратором по умолчанию Firewall Manager.

Status -> (строка)

Текущий статус запроса по включению учетной записи участника в качестве администратора Firewall Manager.

  • ONBOARDING - Учетная запись проходит процесс включения в Firewall Manager в качестве администратора.
  • ONBOARDING_COMPLETE - Учетная запись включена в Firewall Manager в качестве администратора и может выполнять действия с ресурсами, определенными в AdminScope.
  • OFFBOARDING - Учетная запись удаляется в качестве администратора Firewall Manager.
  • OFFBOARDING_COMPLETE - Учетная запись удалена в качестве администратора Firewall Manager.

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

Spec-Zone.ru

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