Spec-Zone.ru › AWS CLI v2

[ aws . macie2 ]

обновить-конфигурацию-раскрытия

Описание

Обновляет состояние и параметры конфигурации для получения случаев обнаружения конфиденциальных данных, сообщённых в результатах.

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

Синтаксис

  update-reveal-configuration
--configuration <value>
[--retrieval-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]

Параметры

--configuration (структура)

Ключ KMS, используемый для шифрования конфиденциальных данных, и состояние конфигурации для учётной записи Amazon Macie.

kmsKeyId -> (строка)

Amazon Resource Name (ARN), идентификатор или псевдоним ключа KMS, используемого для шифрования извлекаемых конфиденциальных данных. Ключ должен быть существующим, управляемым клиентом симметричным ключом шифрования, включённым в той же области Amazon Web Services, что и учётная запись Amazon Macie.

Если это значение указывает псевдоним, оно должно включать следующий префикс: alias/. Если это значение указывает ключ, принадлежащий другой учётной записи Amazon Web Services, оно должно указывать ARN ключа или ARN псевдонима ключа.

status -> (строка)

Состояние конфигурации для учётной записи Amazon Macie. В ответе возможные значения: ENABLED, конфигурация в настоящее время включена для учётной записи; и DISABLED, конфигурация в настоящее время отключена для учётной записи. В запросе допустимые значения: ENABLED, включить конфигурацию для учётной записи; и DISABLED, отключить конфигурацию для учётной записи.

Предупреждение

Если вы отключите конфигурацию, вы также навсегда удалите текущие настройки, которые указывают, как получить доступ к соответствующим объектам S3. Если ваш текущий метод доступа — ASSUME_ROLE, Macie также удаляет внешний идентификатор и имя роли, в настоящее время указанные для конфигурации. Эти настройки невозможно восстановить после удаления.

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

kmsKeyId=string,status=string

Синтаксис JSON:

{
  "kmsKeyId": "string",
  "status": "ENABLED"|"DISABLED"
}

--retrieval-configuration (структура)

Метод доступа и настройки, используемые при извлечении конфиденциальных данных.

retrievalMode -> (строка)

Метод доступа, используемый при извлечении конфиденциальных данных из соответствующих объектов S3. Допустимые значения: ASSUME_ROLE, принять роль IAM, которая находится в соответствующей учётной записи Amazon Web Services и делегировать доступ Amazon Macie; и CALLER_CREDENTIALS, использовать учетные данные пользователя IAM, который запрашивает конфиденциальные данные. Если вы укажете ASSUME_ROLE, также укажите имя существующей роли IAM для принятия Macie (roleName).

Предупреждение

Если вы измените это значение с ASSUME_ROLE на CALLER_CREDENTIALS для существующей конфигурации, Macie навсегда удалит внешний идентификатор и имя роли, в настоящее время указанные для конфигурации. Эти настройки невозможно восстановить после удаления.

roleName -> (строка)

Имя роли IAM, которая находится в соответствующей учётной записи Amazon Web Services и Amazon Macie разрешено принять для извлечения конфиденциальных данных из соответствующих объектов S3 для учётной записи. Политики доверия и разрешений для роли должны соответствовать всем требованиям для принятия Macie роли.

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

retrievalMode=string,roleName=string

Синтаксис JSON:

{
  "retrievalMode": "CALLER_CREDENTIALS"|"ASSUME_ROLE",
  "roleName": "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.

Вывод

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

Ключ KMS, используемый для шифрования конфиденциальных данных, и состояние конфигурации для учётной записи Amazon Macie.

kmsKeyId -> (строка)

Amazon Resource Name (ARN), идентификатор или псевдоним ключа KMS, используемого для шифрования извлекаемых конфиденциальных данных. Ключ должен быть существующим, управляемым клиентом симметричным ключом шифрования, включённым в той же области Amazon Web Services, что и учётная запись Amazon Macie.

Если это значение указывает псевдоним, оно должно включать следующий префикс: alias/. Если это значение указывает ключ, принадлежащий другой учётной записи Amazon Web Services, оно должно указывать ARN ключа или ARN псевдонима ключа.

status -> (строка)

Состояние конфигурации для учётной записи Amazon Macie. В ответе возможные значения: ENABLED, конфигурация в настоящее время включена для учётной записи; и DISABLED, конфигурация в настоящее время отключена для учётной записи. В запросе допустимые значения: ENABLED, включить конфигурацию для учётной записи; и DISABLED, отключить конфигурацию для учётной записи.

Предупреждение

Если вы отключите конфигурацию, вы также навсегда удалите текущие настройки, которые указывают, как получить доступ к соответствующим объектам S3. Если ваш текущий метод доступа — ASSUME_ROLE, Macie также удаляет внешний идентификатор и имя роли, в настоящее время указанные для конфигурации. Эти настройки невозможно восстановить после удаления.

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

Метод доступа и настройки, используемые при извлечении конфиденциальных данных.

externalId -> (строка)

Внешний идентификатор для указания в политике доверия для принятия роли IAM при извлечении конфиденциальных данных из соответствующих объектов S3 (roleName). Это значение равно null, если значение для retrievalMode равно CALLER_CREDENTIALS.

Этот идентификатор — уникальная строка из букв и цифр, автоматически сгенерированная Amazon Macie после настройки на принятие роли IAM. Чтобы администратор Macie мог извлечь конфиденциальные данные из соответствующего объекта S3 для учётной записи участника, в политике доверия для роли в учётной записи участника должен быть предусмотрен условный оператор sts:ExternalId, требующий этот идентификатор.

retrievalMode -> (строка)

Метод доступа, используемый для извлечения конфиденциальных данных из соответствующих объектов S3. Допустимые значения: ASSUME_ROLE, принять роль IAM, находящуюся в соответствующей учётной записи Amazon Web Services, и делегировать доступ Amazon Macie (roleName); и CALLER_CREDENTIALS, использовать учетные данные пользователя IAM, который запрашивает конфиденциальные данные.

roleName -> (строка)

Имя роли IAM, которая находится в соответствующей учётной записи Amazon Web Services и Amazon Macie разрешено принять для извлечения конфиденциальных данных из соответствующих объектов S3 для учётной записи. Это значение равно null, если значение для retrievalMode равно CALLER_CREDENTIALS.

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

Spec-Zone.ru

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