[ aws . quicksight ]
обновление-регистрации-ключа
Описание
Обновляет управляемый клиентом ключ в аккаунте Amazon QuickSight.
См. также: документацию AWS API
Синтаксис
update-key-registration
--aws-account-id <value>
--key-registration <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]
Параметры
--aws-account-id (строка)
--key-registration (список)
Список объектов RegisteredCustomerManagedKey, которые необходимо обновить в аккаунте Amazon QuickSight.
(структура)
Структура управляемого клиентом ключа, содержащая следующую информацию:
-
KeyArn- ARN ключа KMS, зарегистрированного в аккаунте Amazon QuickSight для использования в шифровании и дешифровании. -
DefaultKey- Указывает, установлен ли текущий ключ как ключевой для шифрования и дешифрования.
KeyArn -> (строка)
DefaultKey -> (логическое значение)
RegisteredCustomerManagedKey в качестве ключевого для шифрования и дешифрования.Сокращенный синтаксис:
KeyArn=string,DefaultKey=boolean ...
Синтаксис JSON:
[
{
"KeyArn": "string",
"DefaultKey": true|false
}
...
]
--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.
Вывод
FailedKeyRegistration -> (список)
Список всех записей управляемых клиентом ключей, которые не удалось обновить.
(структура)
Запись, появляющаяся, когда обновление KeyRegistration в Amazon QuickSight завершается ошибкой.
KeyArn -> (строка)
Message -> (строка)
FailedKeyRegistrationEntry.StatusCode -> (целое число)
FailedKeyRegistrationEntry.SenderFault -> (логическое значение)
FailedKeyRegistrationEntry ошибкой пользователя. Если значение этого свойства равно True, ошибка вызвана ошибкой пользователя. Если значение этого свойства равно False, ошибка произошла на бэкенде. Если ваша работа продолжает завершаться ошибкой с значением False SenderFault, обратитесь в службу поддержки Amazon Web Services.SuccessfulKeyRegistration -> (список)
Список всех записей управляемых клиентом ключей, которые были успешно обновлены.
(структура)
Успешная запись, которая появляется, когда задача KeyRegistration успешно применяется к аккаунту Amazon QuickSight.
KeyArn -> (строка)
SuccessfulKeyRegistrationEntry.StatusCode -> (целое число)
SuccessfulKeyRegistrationEntry.RequestId -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.