create-key
Описание
Создаёт ресурс API-ключа в вашем аккаунте Amazon Web Services, который позволяет предоставлять действия для ресурсов Amazon Location носителю API-ключа.
Примечание
Для получения дополнительной информации см. Использование API-ключей.См. также: Документация API AWS
Синтаксис
create-key
--key-name <value>
--restrictions <value>
[--description <value>]
[--expire-time <value>]
[--no-expiry | --no-no-expiry]
[--tags <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-ключа.
Требования:
- Содержит только символы латинского алфавита (A–Z, a–z), цифры (0–9), дефисы (-), точки (.) и символы нижнего подчеркивания (_).
- Должно быть уникальным именем API-ключа.
- Пробелы запрещены. Например,
ExampleAPIKey.
--restrictions (структура)
Ограничения API-ключа для ресурса API-ключа.
AllowActions -> (список)
Список разрешённых действий, которые ресурс API-ключа предоставляет разрешения для выполнения. Для каждого типа ресурса необходимо указать хотя бы одно действие. Например, если у вас есть ресурс местоположения, необходимо указать по крайней мере одно действие для местоположений.
Следующие значения являются допустимыми для действий.
-
Действия с картами
-
geo:GetMap*- Разрешает все действия, необходимые для отображения карты.
-
-
Действия с местоположениями
-
geo:SearchPlaceIndexForText- Разрешает геокодирование. -
geo:SearchPlaceIndexForPosition- Разрешает обратное геокодирование. -
geo:SearchPlaceIndexForSuggestions- Разрешает формирование предложений по тексту. -
GetPlace- Разрешает поиск местоположения по ID местоположения.
-
-
Действия с маршрутами
-
geo:CalculateRoute- Разрешает маршрутизацию между точками. -
geo:CalculateRouteMatrix- Разрешает вычисление матрицы маршрутов.
-
Примечание
Необходимо использовать эти строки точно. Например, чтобы предоставить доступ к отображению карты, единственным допустимым действием являетсяgeo:GetMap* в качестве входного значения списка. ["geo:GetMap*"] допустимо, но ["geo:GetMapTile"] нет. Аналогично, нельзя использовать ["geo:SearchPlaceIndexFor*"] — необходимо указать каждое из действий Place отдельно.(строка)
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 (ARN).
(строка)
AllowReferers -> (список)
Необязательный список разрешённых HTTP-ссылок, от которых должны происходить запросы. Запросы, использующие этот API-ключ с других доменов, не будут разрешены.
Требования:
- Содержат только символы латинского алфавита (A–Z, a–z), цифры (0–9) или любые символы из этого списка
$\-._+!*`(),;/?:@=& - Может содержать процент (%) при наличии двух последующих шестнадцатеричных цифр (A-F, a-f, 0-9); это используется для целей кодирования URL.
- Может содержать подстановочные знаки вопросительный знак (?) и звёздочка (*). Вопросительный знак (?) будет заменять любой одиночный символ (включая шестнадцатеричные цифры). Звёздочка (*) будет заменять любые множественные символы (включая множественные шестнадцатеричные цифры).
- Пробелы запрещены. Например,
https://example.com.
(строка)
Сокращенный синтаксис:
AllowActions=string,string,AllowResources=string,string,AllowReferers=string,string
Синтаксис JSON:
{
"AllowActions": ["string", ...],
"AllowResources": ["string", ...],
"AllowReferers": ["string", ...]
}
--description (строка)
--expire-time (метка времени)
YYYY-MM-DDThh:mm:ss.sssZ. Один из NoExpiry или ExpireTime должен быть задан.--no-expiry | --no-no-expiry (логическое значение)
true, чтобы установить отсутствие времени истечения срока действия для API-ключа. Один из NoExpiry или ExpireTime должен быть задан.--tags (карта)
Применяет один или несколько тегов к ресурсу карты. Тег — это пара ключ-значение, которая помогает управлять, идентифицировать, искать и фильтровать ваши ресурсы, маркируя их.
Формат: "key" : "value"
Ограничения:
- Максимум 50 тегов на ресурс
- Каждый тег ресурса должен быть уникальным со значением максимум одного значения.
- Максимальная длина ключа: 128 символов Юникода в UTF-8
- Максимальная длина значения: 256 символов Юникода в UTF-8
- Можно использовать символы латинского алфавита (A–Z, a–z), цифры (0–9) и следующие символы: + - = . _ : / @.
- Нельзя использовать «aws:» в качестве префикса для ключа.
ключ -> (строка)
значение -> (строка)
Сокращенный синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--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.
Вывод
Ключ -> (строка)
KeyArn -> (строка)
Amazon Resource Name (ARN) для ресурса API-ключа. Используется, когда необходимо указать ресурс во всех Amazon Web Services.
- Пример формата:
arn:aws:geo:region:account-id:key/ExampleKey
KeyName -> (строка)
CreateTime -> (метка времени)
YYYY-MM-DDThh:mm:ss.sssZ.
© Copyright 2025, Amazon Web Services. Created using Sphinx.