[ aws . ivs-realtime ]
list-public-keys
Описание
Получает сводную информацию обо всех открытых ключах в вашей учетной записи в AWS-регионе, где обрабатывается запрос API.
См. также: Документация AWS API
list-public-keys является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: publicKeys
Синтаксис
list-public-keys
[--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 (boolean)
Включить отладку.
--endpoint-url (строка)
Переопределить URL команды заданным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.
--no-paginate (boolean)
Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команд.
- json
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определённый профиль из файла данных авторизации.
--region (строка)
Регион для использования. Переопределяет настройки из конфигурации/среды.
--version (строка)
Отобразить версию инструмента.
--color (строка)
Включить/отключить вывод цвета.
- включено
- выключено
- автоматически
--no-sign-request (boolean)
Не подписывать запросы. Данные авторизации не будут загружены, если этот аргумент указан.
--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 (boolean)
Отключить кли-пейджер для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запроса параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве «Начало работы» в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования, аналогичные unix-подобным. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.
Для перечисления доступных общедоступных ключей для подписи маркеров участников стадии
Следующий list-public-keys пример перечисляет все общедоступные ключи, доступные для подписи маркеров участников стадии в регионе AWS, где обрабатывается запрос API.
aws ivs-realtime list-public-keys
Вывод:
{
"publicKeys": [
{
"arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2",
"name": "",
"tags": {}
},
{
"arn": "arn:aws:ivs:us-west-2:123456789012:public-key/3bcdABCDefg4",
"name": "",
"tags": {}
}
]
}
Дополнительную информацию см. в разделе Распределение маркеров участников в руководстве пользователя Amazon IVS Real-Time Streaming.
Вывод
publicKeys -> (список)
Список соответствующих общедоступных ключей (только сводная информация).
(структура)
Сводная информация об общедоступном ключе.
arn -> (строка)
name -> (строка)
tags -> (карта)
Теги, прикрепленные к ресурсу. Массив карт, каждая из которых имеет вид string:string (key:value). Подробности, включая ограничения, которые применяются к тегам и «Ограничения на имена и требования к тегам», см. в разделе «Рекомендации и стратегии по маркировке ресурсов AWS» в Tagging AWS Resources and Tag Editor; Amazon IVS не накладывает никаких ограничений на теги, кроме тех, которые описаны там.
key -> (строка)
value -> (строка)
nextToken -> (строка)
maxResults, используйте nextToken в запросе, чтобы получить следующий набор.
© Copyright 2025, Amazon Web Services. Created using Sphinx.