Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-ipam-resource-discoveries

Описание

Описывает открытия ресурсов IPAM. Открытие ресурса — это компонент IPAM, который позволяет IPAM управлять и отслеживать ресурсы, принадлежащие учетной записи-владельцу.

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

describe-ipam-resource-discoveries является постраничным запросом. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную навигацию, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: IpamResourceDiscoveries

Синтаксис

  describe-ipam-resource-discoveries
[--dry-run | --no-dry-run]
[--ipam-resource-discovery-ids <value>]
[--filters <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]

Параметры

--dry-run | --no-dry-run (boolean)

Проверка наличия необходимых разрешений для действия без фактического выполнения запроса и предоставление ответа об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке будет DryRunOperation . В противном случае, он будет UnauthorizedOperation .

--ipam-resource-discovery-ids (список)

Идентификаторы открытий ресурсов IPAM.

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

Фильтры открытий ресурсов.

(структура)

Пара имя-значение фильтра, используемая для получения более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.

Если вы указываете несколько фильтров, они соединяются с помощью AND , и запрос возвращает только результаты, которые соответствуют всем указанным фильтрам.

Дополнительную информацию см. в разделе «Списки и фильтры с помощью CLI и API» в руководстве пользователя Amazon EC2.

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Значения фильтра. Значения фильтров чувствительны к регистру. Если вы указываете несколько значений для фильтра, они соединяются с помощью OR , и запрос возвращает все результаты, которые соответствуют любому из указанных значений.

(строка)

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

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["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 (boolean)

Включить отладочную запись в журнал.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • вкл
  • выкл
  • авто

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл-сборник сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь ограничения по времени. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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 (boolean)

Отключить постраничную навигацию cli для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Пример 1: Просмотр полных деталей открытий ресурсов

В этом примере вы являетесь делегированным администратором IPAM, который хочет создать и поделиться открытием ресурса с администратором IPAM в другой организации AWS, чтобы администратор мог управлять и отслеживать IP-адреса ресурсов в вашей организации.

Этот пример может быть полезен, если:

  • Вы пытались создать открытие ресурса, но получили ошибку, что вы достигли лимита 1. Вы понимаете, что возможно вы уже создали открытие ресурса и хотите просмотреть его в своей учетной записи.
  • У вас есть ресурсы в регионе, которые не обнаруживаются IPAM. Вы хотите просмотреть определенные для ресурса --operating-regions и убедиться, что вы добавили правильный регион в качестве рабочего региона, чтобы ресурсы там можно было обнаружить.

Следующий describe-ipam-resource-discoveries пример перечисляет сведения об открытии ресурса в вашей учетной записи AWS. Вы можете иметь одно открытие ресурса на AWS-регион.

aws ec2 describe-ipam-resource-discoveries \
    --region us-east-1

Вывод:

{
    "IpamResourceDiscoveries": [
        {
            "OwnerId": "149977607591",
            "IpamResourceDiscoveryId": "ipam-res-disco-0f8bdee9067137c0d",
            "IpamResourceDiscoveryArn": "arn:aws:ec2::149977607591:ipam-resource-discovery/ipam-res-disco-0f8bdee9067137c0d",
            "IpamResourceDiscoveryRegion": "us-east-1",
            "OperatingRegions": [
                {
                    "RegionName": "us-east-1"
                }
            ],
            "IsDefault": false,
            "State": "create-complete",
            "Tags": []
    }
]
}

Дополнительную информацию см. в разделе «Интеграция IPAM с учетными записями за пределами вашей организации» в Руководстве пользователя Amazon VPC IPAM.

Пример 2: Просмотр только идентификаторов открытий ресурсов

Следующий describe-ipam-resource-discoveries пример перечисляет идентификатор открытия ресурса в вашей учетной записи AWS. Вы можете иметь одно открытие ресурса на AWS-регион.

aws ec2 describe-ipam-resource-discoveries \
    --query "IpamResourceDiscoveries[*].IpamResourceDiscoveryId" \
    --output text

Вывод:

ipam-res-disco-0481e39b242860333

Дополнительную информацию см. в разделе «Интеграция IPAM с учетными записями за пределами вашей организации» в Руководстве пользователя Amazon VPC IPAM.

Вывод

IpamResourceDiscoveries -> (список)

Открытия ресурсов.

(структура)

Открытие ресурса — это компонент IPAM, который позволяет IPAM управлять и контролировать ресурсы, принадлежащие владеющему аккаунту.

OwnerId -> (строка)

Идентификатор владельца.

IpamResourceDiscoveryId -> (строка)

Идентификатор открытия ресурса.

IpamResourceDiscoveryArn -> (строка)

Amazon Resource Name (ARN) открытия ресурса.

IpamResourceDiscoveryRegion -> (строка)

Регион открытия ресурса.

Description -> (строка)

Описание открытия ресурса.

OperatingRegions -> (список)

Операционные регионы для открытия ресурса. Операционные регионы — это регионы Amazon Web Services, в которых IPAM разрешено управлять CIDR адресами IP-адресов. IPAM обнаруживает и контролирует ресурсы только в регионах Amazon Web Services, которые вы выбираете как операционные регионы.

(структура)

Операционные регионы для IPAM. Операционные регионы — это регионы Amazon Web Services, в которых IPAM разрешено управлять CIDR адресами IP-адресов. IPAM обнаруживает и контролирует ресурсы только в регионах Amazon Web Services, которые вы выбираете как операционные регионы.

Дополнительную информацию об операционных регионах см. в разделе Создание IPAM в руководстве пользователя Amazon VPC IPAM.

RegionName -> (строка)

Название операционного региона.

IsDefault -> (булево)

Определяет, является ли открытие ресурса стандартным. Стандартное открытие ресурса — это открытие ресурса, автоматически созданное при создании IPAM.

State -> (строка)

Состояние жизненного цикла открытия ресурса.

  • create-in-progress - Открытие ресурса создается.
  • create-complete - Создание открытия ресурса завершено.
  • create-failed - Создание открытия ресурса завершилось неудачно.
  • modify-in-progress - Открытие ресурса изменяется.
  • modify-complete - Изменение открытия ресурса завершено.
  • modify-failed - Изменение открытия ресурса завершилось неудачно.
  • delete-in-progress - Открытие ресурса удаляется.
  • delete-complete - Удаление открытия ресурса завершено.
  • delete-failed - Удаление открытия ресурса завершилось неудачно.
  • isolate-in-progress - Аккаунт Amazon Web Services, который создал открытие ресурса, был удален, и открытие ресурса изолируется.
  • isolate-complete - Изоляция открытия ресурса завершена.
  • restore-in-progress - Аккаунт Amazon Web Services, создавший и изолировавший открытие ресурса, восстановлен.

Tags -> (список)

Тег — это метка, которую вы назначаете ресурсу Amazon Web Services. Каждый тег состоит из ключа и необязательного значения. Вы можете использовать теги для поиска и фильтрации ресурсов или отслеживания расходов Amazon Web Services.

(структура)

Описание тега.

Key -> (строка)

Ключ тега.

Ограничения: ключи тегов чувствительны к регистру и принимают максимум 127 символов Юникода. Не может начинаться с aws:.

Value -> (строка)

Значение тега.

Ограничения: значения тегов чувствительны к регистру и принимают максимум 256 символов Юникода.

OrganizationalUnitExclusions -> (список)

Если ваш IPAM интегрирован с Amazon Web Services Organizations и вы добавляете исключение организационной единицы (OU), IPAM не будет управлять IP-адресами в учетных записях в этом исключении OU.

(структура)

Если ваш IPAM интегрирован с Amazon Web Services Organizations и вы добавляете исключение организационной единицы (OU), IPAM не будет управлять IP-адресами в учетных записях в этом исключении OU.

OrganizationsEntityPath -> (строка)

Путь сущности Amazon Web Services Organizations. Дополнительную информацию о пути сущности см. в разделе Понимание пути сущности Amazon Web Services Organizations в руководстве пользователя Amazon Web Services Identity and Access Management.

NextToken -> (строка)

Укажите токен постраничной навигации из предыдущего запроса для получения следующей страницы результатов.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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