Spec-Zone.ru › AWS CLI v2

[ aws . wafv2 ]

list-api-keys

Описание

Получает список API-ключей, которые вы определили для указанного уровня доступа.

API-ключи необходимы для интеграции API CAPTCHA в ваши приложения на JavaScript. API позволяет настроить размещение и характеристики CAPTCHA для ваших конечных пользователей. Дополнительную информацию об интеграции CAPTCHA с JavaScript см. в разделе Интеграция приложения WAF в руководстве разработчика WAF.

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

Синтаксис

  list-api-keys
--scope <value>
[--next-marker <value>]
[--limit <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]

Параметры

--scope (строка)

Указывает, относится ли данный ресурс к глобальному типу ресурсов, такому как распределение Amazon CloudFront. Для приложения Amplify используйте CLOUDFRONT.

Для работы с CloudFront также необходимо указать регион США Восточный (Северная Вирджиния) следующим образом:

  • CLI — Укажите регион при использовании уровня доступа CloudFront: --scope=CLOUDFRONT --region=us-east-1.
  • API и SDK — Для всех вызовов используйте конечную точку региона us-east-1.

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

  • CLOUDFRONT
  • REGIONAL

--next-marker (строка)

При запросе списка объектов с параметром Limit, если количество доступных для получения объектов превышает лимит, WAF возвращает значение NextMarker в ответе. Для получения следующей группы объектов передайте маркер из предыдущего вызова в следующий запрос.

--limit (целое число)

Максимальное количество объектов, которое вы хотите, чтобы WAF вернул для данного запроса. Если доступно больше объектов, в ответе WAF предоставляет значение NextMarker, которое можно использовать в последующем вызове для получения следующей группы объектов.

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

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

Вывод

NextMarker -> (строка)

При запросе списка объектов с параметром Limit, если количество доступных для получения объектов превышает лимит, WAF возвращает значение NextMarker в ответе. Для получения следующей группы объектов передайте маркер из предыдущего вызова в следующий запрос.

APIKeySummaries -> (список)

Массив сводок ключей. Если вы указали Limit в запросе, это может быть не весь список.

(структура)

Информация об одном API-ключе.

API-ключи необходимы для интеграции API CAPTCHA в ваши приложения на JavaScript. API позволяет настроить размещение и характеристики CAPTCHA для ваших конечных пользователей. Дополнительную информацию об интеграции CAPTCHA с JavaScript см. в разделе Интеграция приложения WAF в руководстве разработчика WAF.

TokenDomains -> (список)

Доменные имена токенов, определенные в этом API-ключе.

(строка)

APIKey -> (строка)

Сгенерированный и зашифрованный API-ключ. Вы можете скопировать его для использования в интеграции CAPTCHA с JavaScript.

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

Дата и время создания ключа.

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

Внутреннее значение, используемое WAF для управления ключом.

ApplicationIntegrationURL -> (строка)

URL интеграции приложения CAPTCHA для использования в вашей реализации на JavaScript.

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

Spec-Zone.ru

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