Spec-Zone.ru › AWS CLI v2

[ aws . gameliftstreams ]

list-stream-groups

Описание

Возвращает список всех групп потоков Amazon GameLift Streams, связанных с используемой учетной записью Amazon Web Services. Данная операция возвращает группы потоков всех статусов, без определенного порядка. Вы можете использовать пагинацию для обработки результатов по мере необходимости.

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

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

Синтаксис

  list-stream-groups
[--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]

Параметры

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

Вывод

Элементы -> (список)

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

(структура)

Описывает ресурс группы потоков Amazon GameLift Streams для размещения потоков контента. Для получения дополнительных данных о группе потоков вызовите GetStreamGroup .

Arn -> (строка)

Идентификатор Amazon Resource Name (ARN) или ID, уникально идентифицирующий ресурс группы потоков. Пример формата: ARN-arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 или ID-sg-1AB2C3De4 .

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

Метка времени, указывающая время создания этого ресурса. Метки времени выражаются в формате ISO8601, например: 2022-12-27T22:29:40+00:00 (UTC).

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

Объект, идентифицирующий приложение Amazon GameLift Streams, с которым следует потоковая передача в этой группе потоков.

Arn -> (строка)

Amazon Resource Name (ARN), уникально идентифицирующий ресурс приложения. Пример формата: arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6 .

Id -> (строка)

Идентификатор, уникально идентифицирующий ресурс приложения. Например: a-9ZY8X7Wv6 .

Description -> (строка)

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

Id -> (строка)

Идентификатор Amazon Resource Name (ARN) или ID, уникально идентифицирующий ресурс группы потоков. Пример формата: ARN-arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 или ID-sg-1AB2C3De4 .

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

Метка времени, указывающая время последнего обновления этого ресурса. Метки времени выражаются в формате ISO8601, например: 2022-12-27T22:29:40+00:00 (UTC).

Status -> (строка)

Текущий статус ресурса группы потоков. Возможные статусы включают следующие:

  • ACTIVATING : Группа потоков развертывается и не готова к приему потоков.
  • ACTIVE : Группа потоков готова к приему потоков.
  • ACTIVE_WITH_ERRORS : Одна или несколько локаций в группе потоков находятся в состоянии ошибки. Проверьте детали отдельных локаций и удалите любые локации, которые находятся в состоянии ошибки.
  • ERROR : Во время развертывания группы потоков произошла ошибка. Дополнительную информацию см. в StatusReason.
  • DELETING : Amazon GameLift Streams находится в процессе удаления группы потоков.
  • UPDATING_LOCATIONS : Одна или несколько локаций в группе потоков находятся в процессе обновления (активации или удаления).

StreamClass -> (строка)

Целевое качество потока для группы потоков.

Класс потока может быть одним из следующих:

  • ``gen5n_win2022`` (NVIDIA, ультра) Поддерживает приложения с очень высокой сложностью 3D-сцены. Выполняет приложения на Microsoft Windows Server 2022 Base и поддерживает DirectX 12. Совместим с версиями Unreal Engine до 5.4, 32- и 64-разрядными приложениями и технологией античит. Использует графический процессор NVIDIA A10G Tensor.
    • Резолюция справки: 1080p
    • Частота кадров справки: 60 кадров/с
    • Характеристики рабочей нагрузки: 8 vCPU, 32 ГБ ОЗУ, 24 ГБ видеопамяти
    • Аренда: Поддерживает 1 одновременную сессию потока
  • ``gen5n_high`` (NVIDIA, высокое) Поддерживает приложения со средней и высокой сложностью 3D-сцены. Использует графический процессор NVIDIA A10G Tensor.
    • Резолюция справки: 1080p
    • Частота кадров справки: 60 кадров/с
    • Характеристики рабочей нагрузки: 4 vCPU, 16 ГБ ОЗУ, 12 ГБ видеопамяти
    • Аренда: Поддерживает до 2 одновременных сессий потока
  • ``gen5n_ultra`` (NVIDIA, ультра) Поддерживает приложения с очень высокой сложностью 3D-сцены. Использует выделенный графический процессор NVIDIA A10G Tensor.
    • Резолюция справки: 1080p
    • Частота кадров справки: 60 кадров/с
    • Характеристики рабочей нагрузки: 8 vCPU, 32 ГБ ОЗУ, 24 ГБ видеопамяти
    • Аренда: Поддерживает 1 одновременную сессию потока
  • ``gen4n_win2022`` (NVIDIA, ультра) Поддерживает приложения с очень высокой сложностью 3D-сцены. Выполняет приложения на Microsoft Windows Server 2022 Base и поддерживает DirectX 12. Совместим с версиями Unreal Engine до 5.4, 32- и 64-разрядными приложениями и технологией античит. Использует графический процессор NVIDIA T4 Tensor.
    • Резолюция справки: 1080p
    • Частота кадров справки: 60 кадров/с
    • Характеристики рабочей нагрузки: 8 vCPU, 32 ГБ ОЗУ, 16 ГБ видеопамяти
    • Аренда: Поддерживает 1 одновременную сессию потока
  • ``gen4n_high`` (NVIDIA, высокое) Поддерживает приложения со средней и высокой сложностью 3D-сцены. Использует графический процессор NVIDIA T4 Tensor.
    • Резолюция справки: 1080p
    • Частота кадров справки: 60 кадров/с
    • Характеристики рабочей нагрузки: 4 vCPU, 16 ГБ ОЗУ, 8 ГБ видеопамяти
    • Аренда: Поддерживает до 2 одновременных сессий потока
  • ``gen4n_ultra`` (NVIDIA, ультра) Поддерживает приложения с высокой сложностью 3D-сцены. Использует выделенный графический процессор NVIDIA T4 Tensor.
    • Резолюция справки: 1080p
    • Частота кадров справки: 60 кадров/с
    • Характеристики рабочей нагрузки: 8 vCPU, 32 ГБ ОЗУ, 16 ГБ видеопамяти
    • Аренда: Поддерживает 1 одновременную сессию потока

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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