Spec-Zone.ru › AWS CLI v2

[ aws . workspaces-web ]

получить-портал

Описание

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

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

Синтаксис

  get-portal
--portal-arn <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]

Параметры

--portal-arn (строка)

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

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

Вывод

портал -> (структура)

Веб-портал.

additionalEncryptionContext -> (массив)

Дополнительный контекст шифрования портала.

ключ -> (строка)

значение -> (строка)

authenticationType -> (строка)

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

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

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

browserSettingsArn -> (строка)

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

browserType -> (строка)

Браузер, который пользователи видят при использовании сеанса потоковой передачи.

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

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

customerManagedKey -> (строка)

Используемый управляемый клиентом ключ для шифрования конфиденциальной информации на портале.

dataProtectionSettingsArn -> (строка)

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

displayName -> (строка)

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

instanceType -> (строка)

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

ipAccessSettingsArn -> (строка)

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

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

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

networkSettingsArn -> (строка)

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

portalArn -> (строка)

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

portalEndpoint -> (строка)

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

portalStatus -> (строка)

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

rendererType -> (строка)

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

statusReason -> (строка)

Сообщение, объясняющее причину текущего статуса веб-портала.

trustStoreArn -> (строка)

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

userAccessLoggingSettingsArn -> (строка)

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

userSettingsArn -> (строка)

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

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

Spec-Zone.ru

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