describe-key

Описание

Извлекает подробную информацию о ресурсе API-ключа.

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

Синтаксис

  describe-key
--key-name <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]

Параметры

--key-name (строка)

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

--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
таблица
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 для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос параметров ввода CLI.

Вывод

Ключ -> (строка)

Значение/строка ключа API.

KeyArn -> (строка)

Amazon Resource Name (ARN) ресурса API-ключа. Используется, когда необходимо указать ресурс во всех службах Amazon Web Services.

Пример формата: arn:aws:geo:region:account-id:key/ExampleKey

KeyName -> (строка)

Имя ресурса 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 -> (список)

Список разрешенных ARN ресурсов, на которых носитель 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 Resource Names (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 .

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

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

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

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

Description -> (строка)

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

Tags -> (отображение)

Теги, связанные с ресурсом API-ключа.

ключ -> (строка)

значение -> (строка)