Spec-Zone.ru › AWS CLI v2

[ aws . workspaces-web ]

list-portals

Описание

Получает список веб-порталов.

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

Синтаксис

  list-portals
[--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]

Параметры

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

Максимальное количество результатов на следующей странице.

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

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

--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
  • text
  • таблица
  • 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.

Вывод

nextToken -> (строка)

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

portals -> (список)

Список веб-порталов.

(структура)

Краткое описание портала.

authenticationType -> (строка)

Тип интеграции аутентификации, используемой при входе на веб-портал. По умолчанию Standard .

Standard веб-порталы аутентифицируются напрямую через ваш поставщик удостоверений. Вам необходимо вызвать CreateIdentityProvider для интеграции вашего поставщика удостоверений с вашим веб-порталом. Доступ пользователей и групп к вашему веб-порталу контролируется вашим поставщиком удостоверений.

IAM Identity Center веб-порталы аутентифицируются через IAM Identity Center. Источники удостоверений (включая интеграцию внешнего поставщика удостоверений), а также доступ пользователей и групп к вашему веб-порталу можно настроить в IAM Identity Center.

browserSettingsArn -> (строка)

ARN настроек браузера, связанных с веб-порталом.

browserType -> (строка)

Тип браузера веб-портала.

creationDate -> (метка времени)

Дата создания веб-портала.

dataProtectionSettingsArn -> (строка)

ARN настроек защиты данных.

displayName -> (строка)

Название веб-портала.

instanceType -> (строка)

Тип и ресурсы базовой виртуальной машины.

ipAccessSettingsArn -> (строка)

ARN настроек доступа по IP.

maxConcurrentSessions -> (целое число)

Максимальное количество одновременных сеансов для портала.

networkSettingsArn -> (строка)

ARN сетевых настроек, связанных с веб-порталом.

portalArn -> (строка)

ARN веб-портала.

portalEndpoint -> (строка)

URL конечной точки веб-портала, к которому пользователи обращаются для запуска потоковых сеансов.

portalStatus -> (строка)

Статус веб-портала.

rendererType -> (строка)

Рендерер, используемый в потоковых сеансах.

trustStoreArn -> (строка)

ARN хранилища доверия, связанного с этим веб-порталом.

userAccessLoggingSettingsArn -> (строка)

ARN настроек регистрации доступа пользователей, связанных с веб-порталом.

userSettingsArn -> (строка)

ARN настроек пользователя, связанных с веб-порталом.

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

Spec-Zone.ru

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