Spec-Zone.ru › AWS CLI v2

[ aws . appstream ]

describe-stacks

Описание

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

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

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

Синтаксис

  describe-stacks
[--names <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <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]

Параметры

--names (список)

Имена стеков для описания.

(строка)

Синтаксис:

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

--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
  • таблица
  • yaml
  • yaml-stream

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

Вывод

Стеки -> (список)

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

(структура)

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

Arn -> (строка)

ARN стека.

Name -> (строка)

Имя стека.

Description -> (строка)

Отображаемое описание.

DisplayName -> (строка)

Имя стека для отображения.

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

Время создания стека.

StorageConnectors -> (список)

Подключаемые накопители.

(структура)

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

ConnectorType -> (строка)

Тип подключения.

ResourceIdentifier -> (строка)

ARN подключения.

Domains -> (список)

Имена доменов для учетной записи.

(строка)

Домен GSuite для интеграции GDrive.

DomainsRequireAdminConsent -> (список)

Домены OneDrive for Business, где требуется согласие администратора, когда пользователи пытаются связать свою учетную запись OneDrive с AppStream 2.0. Атрибут может быть указан только при ConnectorType=ONE_DRIVE.

(строка)

Домен GSuite для интеграции GDrive.

RedirectURL -> (строка)

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

FeedbackURL -> (строка)

URL, на который пользователи перенаправляются после нажатия ссылки «Отправить отзыв». Если URL не указан, ссылка «Отправить отзыв» не отображается.

StackErrors -> (список)

Ошибки для стека.

(структура)

Описание ошибки стека.

ErrorCode -> (строка)

Код ошибки.

ErrorMessage -> (строка)

Сообщение об ошибке.

UserSettings -> (список)

Действия, которые включены или отключены для пользователей во время сеансов потоковой передачи. По умолчанию эти действия включены.

(структура)

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

Action -> (строка)

Действие, которое включено или выключено.

Permission -> (строка)

Указывает, включено или выключено действие.

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

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

Это может быть указано только для действий CLIPBOARD_COPY_FROM_LOCAL_DEVICE и CLIPBOARD_COPY_TO_LOCAL_DEVICE.

По умолчанию это 20 971 520 (20 МБ), если не указано, а разрешение — ENABLED. Это не может быть указано, когда разрешение — DISABLED.

Значение может быть от 1 до 20 971 520 (20 МБ).

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

Постоянные настройки приложения для пользователей стека.

Enabled -> (логическое значение)

Указывает, включены ли постоянные настройки приложения для пользователей во время их сеансов потоковой передачи.

SettingsGroup -> (строка)

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

S3BucketName -> (строка)

Ведро S3, в котором хранятся постоянные настройки приложения пользователей. Когда постоянные настройки приложения впервые включены для учетной записи в регионе AWS, создается ведро S3. Ведро уникально для учетной записи AWS и региона.

AccessEndpoints -> (список)

Список объектов виртуального частного облака (VPC) интерфейсного конечной точки. Пользователи стека могут подключаться к AppStream 2.0 только через указанные конечные точки.

(структура)

Описание интерфейсной конечной точки VPC (интерфейсной конечной точки), позволяющей создать частное соединение между указанным вами виртуальным частным облаком (VPC) и AppStream 2.0. Когда вы указываете интерфейсную конечную точку для стека, пользователи стека могут подключаться к AppStream 2.0 только через эту конечную точку. Когда вы указываете интерфейсную конечную точку для создателя изображений, администраторы могут подключаться к создателю изображений только через эту конечную точку.

EndpointType -> (строка)

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

VpceId -> (строка)

Идентификатор (ID) VPC, в котором используется интерфейсная конечная точка.

EmbedHostDomains -> (список)

Домены, в которых сеансы потоковой передачи AppStream 2.0 можно встраивать в iframe. Вы должны одобрить домены, в которых хотите размещать встроенные сеансы потоковой передачи AppStream 2.0.

(строка)

Указывает допустимый домен, который может встраивать AppStream. Примеры допустимых доменов: [“testorigin.tt–com”, “testingorigin.com.us”, “test.com.us”] Примеры недопустимых доменов: [“test,com”, “.com”, “h*llo.com”, “”]

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

Протокол потоковой передачи, который вы хотите, чтобы предпочитал ваш стек. Это может быть UDP или TCP. В настоящее время UDP поддерживается только в нативном клиенте Windows.

PreferredProtocol -> (строка)

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

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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