Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

list-aliases

Описание

Получает все псевдонимы для этой учетной записи Amazon Web Services. Вы можете отфильтровать результат по имени псевдонима и/или типу стратегии маршрутизации. Используйте параметры постраничной обработки для получения результатов на последовательных страницах.

Примечание

Возвращаемые псевдонимы не упорядочены.

Связанные действия

Все API по задаче

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

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

Синтаксис

  list-aliases
[--routing-strategy-type <value>]
[--name <value>]
[--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]

Параметры

--routing-strategy-type (строка)

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

Возможные типы маршрутизации включают:

  • SIMPLE – Псевдоним указывает на один конкретный флот. Используйте этот тип при маршрутизации к активным флотам.
  • TERMINAL – Псевдоним не указывает на флот, а вместо этого может использоваться для отображения сообщения пользователю. Псевдоним типа терминала вызывает исключение TerminalRoutingStrategyException с сообщением RoutingStrategy.

Возможные значения:

  • SIMPLE
  • TERMINAL

--name (строка)

Описание, которое ассоциируется с псевдонимом. Имена псевдонимов не обязательно должны быть уникальными.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Использовать определенный регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • вкл
  • выкл
  • авто

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с набором сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время соединения сокета в секундах. Если значение установлено в 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.

Вывод

Псевдонимы -> (список)

Коллекция ресурсов псевдонимов, которые соответствуют параметрам запроса.

(структура)

Свойства, описывающие ресурс псевдонима.

Связанные действия

Все API по задаче

AliasId -> (строка)

Уникальный идентификатор псевдонима. Идентификаторы псевдонимов уникальны в пределах региона.

Name -> (строка)

Описание, которое ассоциируется с псевдонимом. Имена псевдонимов не обязательно должны быть уникальными.

AliasArn -> (строка)

Amazon Resource Name (ARN), назначенный ресурсу псевдонима Amazon GameLift и уникально его идентифицирующий. ARNs уникальны во всех регионах. Формат: arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . В ARN псевдонима GameLift идентификатор ресурса соответствует значению идентификатора псевдонима.

Description -> (строка)

Описание псевдонима, понятное человеку.

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

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

Type -> (строка)

Тип стратегии маршрутизации для псевдонима.

Возможные типы маршрутизации включают:

  • SIMPLE - Псевдоним указывает на один конкретный флот. Используйте этот тип при маршрутизации к активным флотам.
  • TERMINAL - Псевдоним не указывает на флот, а вместо этого может использоваться для отображения сообщения пользователю. Псевдоним типа терминала вызывает исключение TerminalRoutingStrategyException с встроенным сообщением.

FleetId -> (строка)

Уникальный идентификатор флота, на который указывает псевдоним. Это идентификатор флота, а не ARN флота.

Message -> (строка)

Текст сообщения, используемый со стратегией маршрутизации типа терминал.

CreationTime -> (временная метка)

Временная метка, указывающая время создания этого объекта данных. Формат — число, выраженное в секундах Unix как миллисекунды (например, "1469498468.057").

LastUpdatedTime -> (временная метка)

Время последнего изменения этого объекта данных. Формат — число, выраженное в секундах Unix как миллисекунды (например, "1469498468.057").

NextToken -> (строка)

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

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

Spec-Zone.ru

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