[ aws . auditmanager ]
получение-каркаса-оценки
Описание
Получает информацию о заданном каркасе.
См. также: Документация API AWS
Синтаксис
get-assessment-framework
--framework-id <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 (строка)
--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 (строка)
Использовать определённый профиль из вашего файла credentials.
--region (строка)
Регион для использования. Переопределяет настройки config/env.
--version (строка)
Показать версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- включено
- выключено
- авто
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (строка)
Файл сертификатов CA для проверки сертификатов SSL. Переопределяет настройки config/env.
--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-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматический запрос параметров ввода CLI.
Вывод
framework -> (структура)
Фреймворк, возвращённый API GetAssessmentFramework.
arn -> (строка)
id -> (строка)
name -> (строка)
type -> (строка)
complianceType -> (строка)
description -> (строка)
logo -> (строка)
controlSources -> (строка)
controlSets -> (список)
Наборы правил, связанные с фреймворком.
(структура)
Набор правил в Audit Manager.
id -> (строка)
name -> (строка)
controls -> (список)
Список правил в рамках набора правил.
(структура)
Правило в Audit Manager.
arn -> (строка)
id -> (строка)
type -> (строка)
name -> (строка)
description -> (строка)
testingInformation -> (строка)
actionPlanTitle -> (строка)
actionPlanInstructions -> (строка)
controlSources -> (строка)
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
- Название управляемого правила: s3-bucket-acl-prohibited
- Для настраиваемых правил вы формируете
keywordValue, добавив префиксCustom_к имени правила. Этот префикс отличает настраиваемое правило от управляемого правила. Пример ключевого слова для настраиваемых правил:- Название настраиваемого правила: my-custom-config-rule
keywordValue:Custom_my-custom-config-rule
- Название настраиваемого правила: 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
- Название правила, связанного с услугой: CustomRuleForAccount-conformance-pack-szsm1uv0w
Предупреждение
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.