Spec-Zone.ru › AWS CLI v2

[ aws . auditmanager ]

get-settings

Описание

Получает настройки для указанной учетной записи Amazon Web Services.

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

Синтаксис

  get-settings
--attribute <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]

Параметры

--attribute (строка)

Список значений перечисления атрибутов настроек.

Возможные значения:

  • ALL
  • IS_AWS_ORG_ENABLED
  • SNS_TOPIC
  • DEFAULT_ASSESSMENT_REPORTS_DESTINATION
  • DEFAULT_PROCESS_OWNERS
  • EVIDENCE_FINDER_ENABLEMENT
  • DEREGISTRATION_POLICY
  • DEFAULT_EXPORT_DESTINATION

--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 -> (структура)

Объект настроек, содержащий все поддерживаемые настройки Audit Manager.

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

Указывает, включена ли Organizations.

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