get-stream-group

Описание

Получает свойства ресурса группы потоков Amazon GameLift Streams. Укажите идентификатор группы потоков, которую нужно получить. При успешном выполнении операции возвращаются свойства запрошенной группы потоков.

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

Синтаксис

  get-stream-group
--identifier <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]

Параметры

--identifier (строка)

Уникальный идентификатор ресурса группы потоков для получения. Пример формата: sg-1AB2C3De4 .

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

Вывод

Arn -> (строка)

Идентификатор ресурса Amazon (ARN), присвоенный ресурсу группы потоков, и уникально идентифицирующий группу во всех регионах Amazon Web Services. Формат: arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID] .

AssociatedApplications -> (список)

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

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

(строка)

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

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

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

Прикладное программное обеспечение Amazon GameLift Streams по умолчанию, связанное с данной группой потоков.

Arn -> (строка)

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

Id -> (строка)

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

Description -> (строка)

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

Id -> (строка)

Уникальное значение идентификатора, присваиваемое ресурсу при его создании. Пример формата: sg-1AB2C3De4 .

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

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

LocationStates -> (список)

Этот параметр содержит список расположений, включая их названия, текущий статус и ёмкости.

Расположение может находиться в одном из следующих состояний:

ACTIVATING : Amazon GameLift Streams подготавливает расположение. Вы пока не можете транслировать из этого расположения, масштабировать ёмкость или удалять его.
ACTIVE : Расположение подготовлено с начальной ёмкостью. Теперь вы можете транслировать из него, масштабировать ёмкость или удалять его.
ERROR : Amazon GameLift Streams не удалось настроить это расположение. Поле StatusReason описывает ошибку. Вы можете удалить это расположение и повторить попытку его добавления.
REMOVING : Amazon GameLift Streams удаляет это расположение. Оно высвобождает всю выделенную ёмкость для этого расположения в этой группе потоков.

(структура)

Представляет расположение и соответствующую ёмкость и статус потока.

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

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

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

Ёмкость трансляции, выделенная и готовая обрабатывать запросы потока без задержки. Вы платите за эту ёмкость независимо от того, используется она или нет. Оптимально для наименьшего времени от запроса на трансляцию до начала сессии трансляции.

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

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

LocationName -> (строка)

Имя расположения. Например, us-east-1 . Полный список поддерживаемых Amazon GameLift Streams расположений см. в разделе «Регионы и квоты» в Руководстве разработчика Amazon GameLift Streams.

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

Ёмкость трансляции, которую Amazon GameLift Streams может выделить в ответ на запросы на трансляцию, а затем освободить после завершения сессии. Это обеспечивает контроль затрат в ущерб большему времени запуска (обычно менее 5 минут).

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

Это значение — общее количество вычислительных ресурсов, запрашиваемых для группы потоков. Оно включает ресурсы, которые Amazon GameLift Streams уже выделил или выделяет. Вы запрашиваете ёмкость для каждого расположения в группе потоков.

Status -> (строка)

Это значение — набор расположений, включая их названия, текущий статус и ёмкости.

Расположение может находиться в одном из следующих состояний:

ACTIVATING : Amazon GameLift Streams подготавливает расположение. Вы пока не можете транслировать из этого расположения, масштабировать ёмкость или удалять его.
ACTIVE : Расположение подготовлено с начальной ёмкостью. Теперь вы можете транслировать из него, масштабировать ёмкость или удалять его.
ERROR : Amazon GameLift Streams не удалось настроить это расположение. Поле StatusReason описывает ошибку. Вы можете удалить это расположение и повторить попытку его добавления.
REMOVING : Amazon GameLift Streams удаляет это расположение. Оно высвобождает всю выделенную ёмкость для этого расположения в этой группе потоков.

Status -> (строка)

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

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

StatusReason -> (строка)

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

internalError : Запрос не может быть обработано в данный момент из-за проблемы на сервере. Попробуйте повторить запрос позднее. Обратитесь в службу поддержки Amazon GameLift Streams для получения дополнительной помощи.
noAvailableInstances : В настоящее время в Amazon GameLift Streams недостаточно доступной ёмкости по запросу, чтобы выполнить ваш запрос. Подождите несколько минут и повторите запрос, так как ёмкость может часто изменяться. Вы также можете попробовать выполнить запрос с использованием другого класса потоков или в другом регионе.

StreamClass -> (строка)

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

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

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