Spec-Zone.ru › AWS CLI v2

[ aws . outposts ]

list-sites

Описание

Выводит список сайтов Outpost для вашей учетной записи Amazon Web Services. Используйте фильтры для получения конкретных результатов.

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

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

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

Синтаксис

  list-sites
[--operating-address-country-code-filter <value>]
[--operating-address-state-or-region-filter <value>]
[--operating-address-city-filter <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]

Параметры

--operating-address-country-code-filter (list)

Фильтры результаты по коду страны.

(строка)

Синтаксис:

"string" "string" ...

--operating-address-state-or-region-filter (list)

Фильтры результаты по штату или региону.

(строка)

Синтаксис:

"string" "string" ...

--operating-address-city-filter (list)

Фильтры результаты по городу.

(строка)

Синтаксис:

"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 (строка)

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

  • on
  • off
  • auto

--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.

Примеры

Примечание

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

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

Для вывода списка сайтов

Следующий list-sites пример выводит доступные сайты Outpost в вашей учетной записи AWS.

aws outposts list-sites

Вывод:

{
    "Sites": [
        {
            "SiteId": "os-0ab12c3456EXAMPLE",
            "AccountId": "123456789012",
            "Name": "EXAMPLE",
            "Description": "example",
            "Tags": {}
        }
    ]
}

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

Вывод

Sites -> (list)

Информация о сайтах.

(структура)

Информация о сайте.

SiteId -> (строка)

Идентификатор сайта.

AccountId -> (строка)

Идентификатор учетной записи Amazon Web Services.

Name -> (строка)

Название сайта.

Description -> (строка)

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

Tags -> (карта)

Теги сайта.

key -> (строка)

value -> (строка)

SiteArn -> (строка)

Amazon Resource Name (ARN) сайта.

Notes -> (строка)

Примечания о сайте.

OperatingAddressCountryCode -> (строка)

Двухбуквенный код страны ISO-3166, где установлено и включено оборудование.

OperatingAddressStateOrRegion -> (строка)

Штат или регион, где установлено и включено оборудование.

OperatingAddressCity -> (строка)

Город, где установлено и включено оборудование.

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

Информация о физических и логистических деталях стойки на сайте.

PowerDrawKva -> (строка)

Мощность, доступная в месте размещения оборудования для стойки.

PowerPhase -> (строка)

Вариант электропитания, который вы можете предоставить для оборудования.

PowerConnector -> (строка)

Разъем электропитания для оборудования.

PowerFeedDrop -> (строка)

Положение подачи электропитания.

UplinkGbps -> (строка)

Скорость подключения, которую поддерживает стойка для соединения с регионом.

UplinkCount -> (строка)

Количество подключений к сети каждого устройства Outpost.

FiberOpticCableType -> (строка)

Тип оптоволокна, используемого для подключения Outpost к сети.

OpticalStandard -> (строка)

Тип оптического стандарта, используемого для подключения Outpost к сети. Этот параметр зависит от скорости подключения, типа оптоволокна и расстояния до устройства upstream. Дополнительную информацию о требованиях к сети для стоек см. в Руководстве пользователя Amazon Web Services Outposts в разделе Network.

MaximumSupportedWeightLbs -> (строка)

Максимальный вес стойки, который может выдержать этот сайт. NO_LIMIT превышает 2000 фунтов (907 кг).

NextToken -> (строка)

Токен постраничной обработки.

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

Spec-Zone.ru

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