Spec-Zone.ru › AWS CLI v2

[ aws . location ]

list-keys

Описание

Отображает ресурсы ключей API в вашей учетной записи Amazon Web Services.

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

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

Синтаксис

  list-keys
[--filter <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]

Параметры

--filter (структура)

Дополнительно фильтрует список, отображая только Active или Expired ключи API.

KeyStatus -> (строка)

Фильтрация по Active или Expired ключам API.

Сокращённый синтаксис:

KeyStatus=string

Синтаксис JSON:

{
  "KeyStatus": "Active"|"Expired"
}

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

Вывод

Entries -> (список)

Содержит ресурсы ключей API в вашей учетной записи Amazon Web Services. Подробности включают имя ключа API, разрешенные рефереры и отметку времени, когда ключ API истечёт.

(структура)

Ресурс ключа API, указанный в вашей учетной записи Amazon Web Services.

KeyName -> (строка)

Имя ресурса ключа API.

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

Отметка времени истечения срока действия ресурса ключа API в формате ISO 8601: YYYY-MM-DDThh:mm:ss.sssZ .

Description -> (строка)

Необязательное описание ресурса ключа API.

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

Ограничения API на разрешенные действия, ресурсы и рефереры для ресурса ключа API.

AllowActions -> (список)

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

Следующие являются допустимыми значениями для действий.

  • Действия карты
    • geo:GetMap* - Разрешает все действия, необходимые для отображения карты.
  • Действия места
    • geo:SearchPlaceIndexForText - Разрешает геокодирование.
    • geo:SearchPlaceIndexForPosition - Разрешает обратное геокодирование.
    • geo:SearchPlaceIndexForSuggestions - Разрешает формирование предложений из текста.
    • GetPlace - Разрешает поиск места по идентификатору места.
  • Действия маршрута
    • geo:CalculateRoute - Разрешает маршрутизацию от точки до точки.
    • geo:CalculateRouteMatrix - Разрешает вычисление матрицы маршрутов.

Примечание

Вы должны использовать эти строки точно. Например, чтобы предоставить доступ к отображению карты, единственное допустимое действие - geo:GetMap* в качестве входных данных для списка. ["geo:GetMap*"] допустимо, но ["geo:GetMapTile"] нет. Аналогично, вы не можете использовать ["geo:SearchPlaceIndexFor*"] - вы должны указать каждое действие места отдельно.

(строка)

AllowResources -> (список)

Список разрешенных ARNs ресурсов, на которых носитель ключа API может выполнять действия.

  • ARN должен быть правильным ARN для карты, места или маршрута. Вы можете включить подстановки в идентификаторе ресурса для сопоставления нескольких ресурсов одного типа.
  • Ресурсы должны находиться в той же partition, region и account-id, что и ключ, который создается.
  • Кроме подстановок, вы должны указать весь ARN, включая arn, partition, service, region, account-id и resource-id, разделённые двоеточиями (:).
  • Пробелы не допускаются, даже с подстановками. Например, arn:aws:geo:region:*account-id* :map/ExampleMap*.

Дополнительную информацию о формате ARN см. в разделе Имена ресурсов Amazon (ARN).

(строка)

AllowReferers -> (список)

Необязательный список разрешенных HTTP-рефереров, запросы которых должны исходить от. Запросы, использующие этот ключ API из других доменов, не будут разрешены.

Требования:

  • Содержат только буквенно-цифровые символы (A–Z, a–z, 0–9) или любые символы в этом списке $\-._+!*`(),;/?:@=&
  • Может содержать знак процента (%) в случае, если за ним следуют 2 шестнадцатеричных цифры (A-F, a-f, 0-9); это используется для целей кодирования URL.
  • Может содержать символы подстановок вопросительный знак (?) и звёздочка (*). Вопросительный знак (?) заменит любой одиночный символ (включая шестнадцатеричные цифры). Звездочка (*) заменит любые несколько символов (включая несколько шестнадцатеричных цифр).
  • Пробелы не допускаются. Например, https://example.com .

(строка)

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

Отметка времени создания ключа API в формате ISO 8601: YYYY-MM-DDThh:mm:ss.sssZ .

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

Отметка времени последнего обновления ключа API в формате ISO 8601: YYYY-MM-DDThh:mm:ss.sssZ .

NextToken -> (строка)

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

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

Spec-Zone.ru

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