обновить-ключ
Описание
Обновляет указанные свойства ресурса API-ключа.
См. также: Документация AWS API
Синтаксис
update-key
--key-name <value>
[--description <value>]
[--expire-time <value>]
[--no-expiry | --no-no-expiry]
[--force-update | --no-force-update]
[--restrictions <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 (строка)
--description (строка)
--expire-time (метка времени)
YYYY-MM-DDThh:mm:ss.sssZ .--no-expiry | --no-no-expiry (булево)
true, чтобы установить для API-ключа отсутствие времени истечения.--force-update | --no-force-update (булево)
Флаг булевого типа, который необходимо включить для обновления ExpireTime или Restrictions данных.
Должен быть установлен в значение true, чтобы обновить ресурс API-ключа, который использовался в течение последних 7 дней.
False если обновление по силе не предпочтительноЗначение по умолчанию: False
--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 для карты, местоположения или маршрута 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 (ARNs).
(строка)
AllowReferers -> (список)
Необязательный список разрешённых HTTP-ссылок, из которых должны исходить запросы. Запросы, использующие этот API-ключ из других доменов, не будут разрешены.
Требования:
- Содержать только символы букв и цифр (A–Z, a–z, 0–9) или любые символы в этом списке
$\-._+!*`(),;/?:@=& - Может содержать символ процента (%) в случае, если за ним следуют 2 шестнадцатеричных цифры (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", ...]
}
--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 (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 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 -> (строка)
UpdateTime -> (метка времени)
YYYY-MM-DDThh:mm:ss.sssZ .
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|