Spec-Zone.ru › AWS CLI v2

[ aws . voice-id ]

обновить-домен

Описание

Обновляет указанный домен. Этот API имеет поведение clobber и очищает и заменяет все атрибуты. Если необязательное поле, такое как «Описание», не предоставлено, оно удаляется из домена.

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

Синтаксис

  update-domain
[--description <value>]
--domain-id <value>
--name <value>
--server-side-encryption-configuration <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]

Параметры

--description (строка)

Краткое описание этого домена.

--domain-id (строка)

Идентификатор домена, который требуется обновить.

--name (строка)

Имя домена.

--server-side-encryption-configuration (структура)

Настройка, содержащая идентификатор ключа KMS, которая будет использоваться Voice ID для шифрования данных на стороне сервера. Изменение связанного ключа KMS домена немедленно запускает асинхронный процесс удаления зависимости от старого ключа KMS таким образом, что к данным домена можно будет получить доступ только с помощью нового ключа KMS. Домен ServerSideEncryptionUpdateDetails содержит сведения об этом процессе.

KmsKeyId -> (строка)

Идентификатор ключа KMS, используемого для шифрования данных, хранящихся Voice ID. Voice ID не поддерживает асимметричные ключи, управляемые клиентом.

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

KmsKeyId=string

Синтаксис JSON:

{
  "KmsKeyId": "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.

Вывод

Домен -> (структура)

Подробности об обновленном домене

Arn -> (строка)

Amazon Resource Name (ARN) домена.

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

Отметка времени создания домена.

Описание -> (строка)

Описание домена.

DomainId -> (строка)

Идентификатор домена.

DomainStatus -> (строка)

Текущий статус домена.

Имя -> (строка)

Имя домена.

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

Настройка шифрования на стороне сервера, содержащая идентификатор ключа KMS, который Voice ID должен использовать для шифрования ваших данных.

KmsKeyId -> (строка)

Идентификатор ключа KMS, используемого для шифрования данных, хранящихся Voice ID. Voice ID не поддерживает асимметричные ключи, управляемые клиентом.

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

Подробности о последнем обновлении конфигурации шифрования на стороне сервера. При изменении конфигурации шифрования на стороне сервера зависимость от старого ключа KMS удаляется асинхронно. После завершения этого обновления данные домена можно будет получить доступ только с помощью нового ключа KMS.

Сообщение -> (строка)

Сообщение, объясняющее текущий статус обновления. При статусе обновления FAILED это сообщение объясняет причину сбоя.

OldKmsKeyId -> (строка)

Предыдущий ID ключа KMS, с которым домен был зашифрован до обновления ServerSideEncryptionConfiguration на новый ID ключа KMS.

UpdateStatus -> (строка)

Статус обновления шифрования на стороне сервера. Во время обновления, если возникнет проблема с текущим или старым ID ключа KMS домена, например, с недоступным или отключенным ключом, то статус будет FAILED. Чтобы решить эту проблему, необходимо сделать ключ доступным, а затем выполнить вызов UpdateDomain с существующей конфигурацией шифрования на стороне сервера, чтобы повторно попытать этот процесс обновления.

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

Отметка времени последнего обновления домена.

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

Подробности о списке наблюдения домена. Содержит идентификатор списка наблюдения по умолчанию домена.

DefaultWatchlistId -> (строка)

Идентификатор списка наблюдения по умолчанию.

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

Spec-Zone.ru

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