Spec-Zone.ru › AWS CLI v2

[ aws . migrationhub-config ]

describe-home-region-controls

Описание

Этот API позволяет фильтрацию по полям ControlId и HomeRegion.

См. также: AWS API Documentation

Синтаксис

  describe-home-region-controls
[--control-id <value>]
[--home-region <value>]
[--target <value>]
[--max-results <value>]
[--next-token <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]

Параметры

--control-id (строка)

Строка уникального идентификатора вашего объекта HomeRegionControl.

--home-region (строка)

Имя домашней области, которую вы хотите просмотреть.

--target (структура)

Параметр target указывает идентификатор, к которому применяется домашняя область, который всегда является типа ACCOUNT. Он применяет домашнюю область к текущему ACCOUNT.

Тип -> (строка)

Тип целевого объекта всегда ACCOUNT.

Id -> (строка)

Идентификатор TargetID, 12-символьный идентификатор ACCOUNT, для которого был создан контроль. (Должен быть текущий аккаунт.)

Сокращенный синтаксис:

Type=string,Id=string

Синтаксис JSON:

{
  "Type": "ACCOUNT",
  "Id": "string"
}

--max-results (целое число)

Максимальное количество результатов фильтрации на странице.

--next-token (строка)

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

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

Вывод

HomeRegionControls -> (список)

Массив, содержащий ваши объекты HomeRegionControl.

(структура)

Управление домашней областью — это объект, который определяет домашнюю область для учетной записи с дополнительной информацией. Он содержит целевой объект (всегда типа ACCOUNT), идентификатор и время, когда была установлена домашняя область.

ControlId -> (строка)

Уникальный идентификатор, генерируемый для каждого управления домашней областью. Он всегда является строкой, начинающейся с «hrc-», за которой следуют 12 строчных букв и цифр.

HomeRegion -> (строка)

AWS Регион, установленный в качестве домашней области. Например, «us-west-2» или «eu-central-1» являются допустимыми домашними областями.

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

Параметр target указывает идентификатор, к которому применяется домашняя область, который всегда является ACCOUNT. Он применяет домашнюю область к текущему ACCOUNT.

Тип -> (строка)

Тип целевого объекта всегда ACCOUNT.

Id -> (строка)

Идентификатор TargetID, 12-символьный идентификатор ACCOUNT, для которого был создан контроль. (Должен быть текущий аккаунт.)

RequestedTime -> (временная метка)

Временная метка, представляющая время, когда пользователь вызвал CreateHomeregionControl и установил домашнюю область для учетной записи.

NextToken -> (строка)

Если предыдущим вызовом был возвращен NextToken, доступны дополнительные результаты. Чтобы получить следующую страницу результатов, сделайте вызов снова, используя возвращенный токен в NextToken.

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

Spec-Zone.ru

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