Spec-Zone.ru › AWS CLI v2

[ aws . auditmanager ]

обновление-каркаса-оценки

Описание

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

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

Синтаксис

  update-assessment-framework
--framework-id <value>
--name <value>
[--description <value>]
[--compliance-type <value>]
--control-sets <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]

Параметры

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

Уникальный идентификатор каркаса.

--name (строка)

Название обновляемого каркаса.

--description (строка)

Описание обновленного каркаса.

--compliance-type (строка)

Тип соответствия, поддерживаемый новым пользовательским каркасом, например, CIS или HIPAA.

--control-sets (список)

Наборы контролей, связанные с каркасом.

(структура)

Сущность controlSet, представляющая набор контролей в Audit Manager. Не содержит идентификатор набора контролей.

id -> (строка)

Уникальный идентификатор набора контролей.

name -> (строка)

Название набора контролей.

controls -> (список)

Список контролей, включенных в набор контролей.

(структура)

Атрибуты сущности контроля, уникально идентифицирующие существующий контроль для добавления в каркас в Audit Manager.

id -> (строка)

Уникальный идентификатор контроля.

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

id=string,name=string,controls=[{id=string},{id=string}] ...

Синтаксис JSON:

[
  {
    "id": "string",
    "name": "string",
    "controls": [
      {
        "id": "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) фреймворка.

id -> (строка)

Уникальный идентификатор фреймворка.

name -> (строка)

Название фреймворка.

type -> (строка)

Указывает, является ли фреймворк стандартным или настраиваемым.

complianceType -> (строка)

Тип соответствия, поддерживаемый фреймворком, например, CIS или HIPAA.

description -> (строка)

Описание фреймворка.

logo -> (строка)

Логотип, связанный с фреймворком.

controlSources -> (строка)

Источники данных контроля, откуда Audit Manager собирает доказательства.

controlSets -> (список)

Наборы контролей, связанные с фреймворком.

(структура)

Набор контролей в Audit Manager.

id -> (строка)

Идентификатор набора контролей в оценке. Это имя набора контролей в простом строчном формате.

name -> (строка)

Название набора контролей.

controls -> (список)

Список контролей в рамках набора контролей.

(структура)

Контроль в Audit Manager.

arn -> (строка)

Amazon Resource Name (ARN) контроля.

id -> (строка)

Уникальный идентификатор контроля.

type -> (строка)

Указывает, является ли контроль стандартным или настраиваемым.

name -> (строка)

Название контроля.

description -> (строка)

Описание контроля.

testingInformation -> (строка)

Шаги, которые необходимо выполнить, чтобы определить, был ли контроль выполнен.

actionPlanTitle -> (строка)

Название плана действий по устранению недостатков контроля.

actionPlanInstructions -> (строка)

Рекомендованные действия, которые следует выполнить, если контроль не выполнен.

controlSources -> (строка)

Типы источников данных, определяющие, откуда Audit Manager собирает доказательства для контроля.

controlMappingSources -> (список)

Источники сопоставления данных для контроля.

(структура)

Источник данных, определяющий, откуда Audit Manager собирает доказательства для контроля.

sourceId -> (строка)

Уникальный идентификатор источника.

sourceName -> (строка)

Название источника.

sourceDescription -> (строка)

Описание источника.

sourceSetUpOption -> (строка)

Параметр настройки источника данных. Этот параметр отражает, является ли метод сбора доказательств автоматическим или ручным. Если вы не укажете значение для sourceSetUpOption, Audit Manager автоматически выведет и заполнит правильное значение на основе sourceType, которое вы укажете.

sourceType -> (строка)

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

  • Источник может быть отдельным типом источника данных, например AWS_Cloudtrail, AWS_Config, AWS_Security_Hub, AWS_API_Call или MANUAL.
  • Источник также может быть управляемой группой источников данных, например, Core_Control или Common_Control.

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

Ключевое слово, связанное с источником данных контроля.

Для ручных доказательств это ключевое слово указывает, является ли ручное доказательство файлом или текстом.

Для автоматических доказательств это ключевое слово идентифицирует конкретное событие CloudTrail, правило Config, контроль Security Hub или имя API Amazon Web Services.

Дополнительную информацию о поддерживаемых ключевых словах, которые можно использовать при сопоставлении источника данных контроля, см. на следующих страницах руководства пользователя Audit Manager:

  • Поддерживаемые правила Config Audit Manager
  • Поддерживаемые контролы Security Hub Audit Manager
  • Поддерживаемые вызовы API Audit Manager
  • Поддерживаемые имена событий CloudTrail Audit Manager

keywordInputType -> (строка)

Метод ввода ключевого слова.

  • SELECT_FROM_LIST используется при сопоставлении источника данных для автоматических доказательств.
    • Когда keywordInputType равно SELECT_FROM_LIST, ключевое слово должно быть выбрано для сбора автоматических доказательств. Например, это ключевое слово может быть именем события CloudTrail, именем правила для Config, контролем Security Hub или именем вызова API Amazon Web Services.
  • UPLOAD_FILE и INPUT_TEXT используются только при сопоставлении источника данных для ручных доказательств.
    • Когда keywordInputType равно UPLOAD_FILE, файл должен быть загружен в качестве ручных доказательств.
    • Когда keywordInputType равно INPUT_TEXT, текст должен быть введён в качестве ручных доказательств.

keywordValue -> (строка)

Значение ключевого слова, используемого при сопоставлении источника данных контроля. Например, это может быть имя события CloudTrail, имя правила для Config, контроль Security Hub или имя вызова API Amazon Web Services.

Если вы сопоставляете источник данных с правилом в Config, то keywordValue, которое вы укажете, зависит от типа правила:

  • Для управляемых правил можно использовать идентификатор правила в качестве keywordValue. Идентификатор правила можно найти в списке управляемых правил Config. Для некоторых правил идентификатор отличается от имени правила. Например, у правила restricted-ssh следующий идентификатор правила: INCOMING_SSH_DISABLED. Убедитесь, что вы используете идентификатор правила, а не его имя. Пример ключевого слова для управляемых правил:
    • Название управляемого правила: s3-bucket-acl-prohibited keywordValue : S3_BUCKET_ACL_PROHIBITED
  • Для настраиваемых правил вы формируете keywordValue, добавляя префикс Custom_ к имени правила. Этот префикс отличает настраиваемое правило от управляемого. Пример ключевого слова для настраиваемых правил:
    • Имя настраиваемого правила: my-custom-config-rule keywordValue : Custom_my-custom-config-rule
  • Для правил, связанных с сервисом, вы формируете keywordValue, добавляя префикс Custom_ к имени правила. Кроме того, удалите суффикс ID, который появляется в конце имени правила. Примеры ключевых слов для правил, связанных с сервисом:
    • Имя правила, связанного с сервисом: CustomRuleForAccount-conformance-pack-szsm1uv0w keywordValue : Custom_CustomRuleForAccount-conformance-pack
    • Имя правила, связанного с сервисом: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba keywordValue : Custom_OrgConfigRule-s3-bucket-versioning-enabled

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

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

Учитывайте следующие требования, в зависимости от используемого типа источника данных.

  • Для Config:
    • Для управляемых правил, убедитесь, что keywordValue — это идентификатор правила в ALL_CAPS_WITH_UNDERSCORES. Например, CLOUDWATCH_LOG_GROUP_ENCRYPTED. Для точности, рекомендуем вам обратиться к списку поддерживаемых управляемых правил Config.
    • Для настраиваемых правил, убедитесь, что keywordValue имеет префикс Custom_, за которым следует имя настраиваемого правила. Сам формат имени настраиваемого правила может различаться. Для точности, рекомендуем вам посетить консоль Config для проверки имени вашего настраиваемого правила.
  • Для Security Hub: Формат для имён контролей Security Hub варьируется. Для точности, рекомендуем обратиться к списку поддерживаемых контролей Security Hub.
  • Для вызовов API Amazon Web Services: Убедитесь, что keywordValue написано как serviceprefix_ActionName. Например, iam_ListGroups. Для точности, рекомендуем обратиться к списку поддерживаемых вызовов API.
  • Для CloudTrail: Убедитесь, что keywordValue написано как serviceprefix_ActionName. Например, cloudtrail_StartLogging. Для точности, рекомендуем просмотреть префиксы служб Amazon Web Services и имена действий в Справочнике авторизации служб.

sourceFrequency -> (строка)

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

troubleshootingText -> (строка)

Инструкции по устранению неполадок контроля.

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

Время создания контроля.

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

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

createdBy -> (строка)

Пользователь или роль, создавшие контроль.

lastUpdatedBy -> (строка)

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

tags -> (карта)

Теги, связанные с контролем.

key -> (строка)

value -> (строка)

state -> (строка)

Состояние контроля. Состояние END_OF_SUPPORT применимо только к стандартным контролям. Это состояние указывает, что стандартный контроль по-прежнему может использоваться для сбора доказательств, но Audit Manager больше не обновляет или не поддерживает этот контроль.

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

Время создания фреймворка.

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

Время последнего обновления фреймворка.

createdBy -> (строка)

Пользователь или роль, создавшие фреймворк.

lastUpdatedBy -> (строка)

Пользователь или роль, которые последними обновили фреймворк.

tags -> (карта)

Теги, связанные с фреймворком.

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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