Spec-Zone.ru › AWS CLI v2

[ aws . auditmanager ]

update-settings

Описание

Обновляет настройки Audit Manager для текущей учетной записи.

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

Синтаксис

  update-settings
[--sns-topic <value>]
[--default-assessment-reports-destination <value>]
[--default-process-owners <value>]
[--kms-key <value>]
[--evidence-finder-enabled | --no-evidence-finder-enabled]
[--deregistration-policy <value>]
[--default-export-destination <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]

Параметры

--sns-topic (строка)

Тема Amazon Simple Notification Service (Amazon SNS), в которую Audit Manager отправляет уведомления.

--default-assessment-reports-destination (структура)

Базовый ведро S3 для хранения отчетов об оценках.

destinationType -> (строка)

Тип назначения, например Amazon S3.

destination -> (строка)

Ведро назначения, в котором Audit Manager хранит отчеты об оценках.

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

destinationType=string,destination=string

Синтаксис JSON:

{
  "destinationType": "S3",
  "destination": "string"
}

--default-process-owners (список)

Список основных владельцев аудита.

(структура)

Контейнер, содержащий информацию о роли Audit Manager текущего пользователя. Включает тип роли и IAM Amazon Resource Name (ARN).

roleType -> (строка)

Тип пользовательского архетипа.

Примечание

В CreateAssessment, roleType может быть только PROCESS_OWNER.

В UpdateSettings, roleType может быть только PROCESS_OWNER.

В BatchCreateDelegationByAssessment, roleType может быть только RESOURCE_OWNER.

roleArn -> (строка)

Amazon Resource Name (ARN) IAM роли.

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

roleType=string,roleArn=string ...

Синтаксис JSON:

[
  {
    "roleType": "PROCESS_OWNER"|"RESOURCE_OWNER",
    "roleArn": "string"
  }
  ...
]

--kms-key (строка)

Подробности ключа KMS.

--evidence-finder-enabled | --no-evidence-finder-enabled (булево)

Указывает, включена ли функция поиска доказательств. Измените этот атрибут для включения или отключения поиска доказательств.

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

При отключении поиска доказательств с помощью этого атрибута Audit Manager удаляет хранилище данных событий, используемое для поиска данных доказательств. В результате вы не сможете снова включить поиск доказательств и использовать эту функцию. Единственный вариант — отменить регистрацию и повторно зарегистрировать Audit Manager.

--deregistration-policy (структура)

Политика дерегистрации для данных вашего Audit Manager. Вы можете использовать этот атрибут для определения обработки ваших данных при дерегистрации Audit Manager.

deleteResources -> (строка)

Указывает, какие данные Audit Manager будут удалены при дерегистрации Audit Manager.

  • Если вы установите значение ALL, все ваши данные будут удалены в течение семи дней после дерегистрации.
  • Если вы установите значение DEFAULT, ни данные не будут удалены во время дерегистрации. Однако имейте в виду, что политика хранения данных Audit Manager по-прежнему применяется. В результате любые данные доказательств будут удалены через два года после их создания. Другие ваши ресурсы Audit Manager будут существовать неограниченно.

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

deleteResources=string

Синтаксис JSON:

{
  "deleteResources": "ALL"|"DEFAULT"
}

--default-export-destination (структура)

Базовое ведро S3 для хранения экспортов поиска доказательств.

destinationType -> (строка)

Тип назначения, например Amazon S3.

destination -> (строка)

Ведро назначения, в котором Audit Manager хранит экспортированные файлы.

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

destinationType=string,destination=string

Синтаксис JSON:

{
  "destinationType": "S3",
  "destination": "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.

Вывод

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

Текущий список настроек.

isAwsOrgEnabled -> (логическое значение)

Указывает, включены ли Организации.

snsTopic -> (строка)

Указанная тема Amazon Simple Notification Service (Amazon SNS).

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

Корзина по умолчанию S3 для хранения отчетов об оценках.

destinationType -> (строка)

Тип назначения, например, Amazon S3.

destination -> (строка)

Корзина назначения, в которой Audit Manager хранит отчеты об оценках.

defaultProcessOwners -> (список)

Указанные владельцы аудита по умолчанию.

(структура)

Обёртка, содержащая информацию о роли Audit Manager текущего пользователя. Включает тип роли и IAM Amazon Resource Name (ARN).

roleType -> (строка)

Тип пользователя.

Примечание

В CreateAssessment, roleType может быть только PROCESS_OWNER.

В UpdateSettings, roleType может быть только PROCESS_OWNER.

В BatchCreateDelegationByAssessment, roleType может быть только RESOURCE_OWNER.

roleArn -> (строка)

Amazon Resource Name (ARN) IAM роли.

kmsKey -> (строка)

Подробности ключа KMS.

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

Текущий статус поиска доказательств и сведения о хранилище данных событий.

eventDataStoreArn -> (строка)

Amazon Resource Name (ARN) хранилища данных событий CloudTrail Lake, используемого поиском доказательств. Хранилище данных — это озеро данных доказательств, по которому поиск доказательств выполняет запросы.

enablementStatus -> (строка)

Текущий статус функции поиска доказательств и связанного хранилища данных событий.

  • ENABLE_IN_PROGRESS означает, что вы запросили включение поиска доказательств. В настоящее время создается хранилище данных событий для поддержки запросов поиска доказательств.
  • ENABLED означает, что хранилище данных событий было успешно создано и поиск доказательств включён. Рекомендуется подождать 7 дней, пока хранилище данных событий не будет заполнено данными о доказательствах за последние два года. Вы можете использовать поиск доказательств в то же время, но не все данные могут быть доступны до завершения заполнения.
  • DISABLE_IN_PROGRESS означает, что вы запросили отключение поиска доказательств, и ваш запрос ожидает удаления хранилища данных событий.
  • DISABLED означает, что вы окончательно отключили поиск доказательств, и хранилище данных событий было удалено. После этого поиск доказательств нельзя включить заново.

backfillStatus -> (строка)

Текущий статус процесса заполнения данных о доказательствах.

Заполнение начинается после включения поиска доказательств. Во время этой задачи Audit Manager заполняет хранилище данных событиями о доказательствах за последние два года, чтобы ваши данные о доказательствах можно было запросить.

  • NOT_STARTED означает, что заполнение ещё не началось.
  • IN_PROGRESS означает, что заполнение выполняется. Это может занять до 7 дней, в зависимости от объёма данных о доказательствах.
  • COMPLETED означает, что заполнение завершено. Все ваши прошлые данные о доказательствах теперь доступны для запроса.

error -> (строка)

Представляет любые ошибки, возникшие при включении или отключении поиска доказательств.

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

Политика дерегистрации для ваших данных Audit Manager. Вы можете использовать этот атрибут, чтобы определить, как будут обрабатываться ваши данные при дерегистрации Audit Manager.

deleteResources -> (строка)

Указывает, какие данные Audit Manager будут удалены при дерегистрации Audit Manager.

  • Если вы установите значение в ALL, все ваши данные будут удалены в течение семи дней после дерегистрации.
  • Если вы установите значение в DEFAULT, ваши данные не будут удалены во время дерегистрации. Однако учтите, что политика хранения данных Audit Manager всё равно применяется. В результате любые данные доказательств будут удалены через два года после их создания. Ваши другие ресурсы Audit Manager будут существовать неопределённо долго.

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

Корзина назначения S3 по умолчанию для хранения экспортов поиска доказательств.

destinationType -> (строка)

Тип назначения, например, Amazon S3.

destination -> (строка)

Корзина назначения, в которой Audit Manager хранит экспортированные файлы.

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

Spec-Zone.ru

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