[ aws . auditmanager ]
update-assessment
Описание
Редактирует оценку в Audit Manager.
См. также: Документацию API AWS
Синтаксис
update-assessment
--assessment-id <value>
[--assessment-name <value>]
[--assessment-description <value>]
--scope <value>
[--assessment-reports-destination <value>]
[--roles <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]
Параметры
--assessment-id (строка)
--assessment-name (строка)
--assessment-description (строка)
--scope (структура)
Область оценки.
awsAccounts -> (список)
Amazon Web Services счета, включенные в область оценки.
(структура)
Обёртка с деталями Amazon Web Services счета, такими как ID счета или адрес электронной почты.
id -> (строка)
emailAddress -> (строка)
name -> (строка)
awsServices -> (список)
Amazon Web Services сервисы, включенные в область оценки.
Предупреждение
Этот параметр API больше не поддерживается. Если вы используете этот параметр для указания одного или нескольких Amazon Web Services сервисов, Audit Manager игнорирует этот ввод. Вместо этого значение дляawsServices будет пустым.(структура)
Amazon Web Services сервис, такой как Amazon S3 или CloudTrail.
Для примера того, как найти имя Amazon Web Services сервиса и как определить его в области вашей оценки, смотрите следующее:
- Поиск имени Amazon Web Services сервиса для использования в области вашей оценки
- Определение имени Amazon Web Services сервиса в области вашей оценки
serviceName -> (строка)
Краткая форма:
awsAccounts=[{id=string,emailAddress=string,name=string},{id=string,emailAddress=string,name=string}],awsServices=[{serviceName=string},{serviceName=string}]
JSON синтаксис:
{
"awsAccounts": [
{
"id": "string",
"emailAddress": "string",
"name": "string"
}
...
],
"awsServices": [
{
"serviceName": "string"
}
...
]
}
--assessment-reports-destination (структура)
Место назначения отчета об оценке для оценки, которую нужно обновить.
destinationType -> (строка)
destination -> (строка)
Краткая форма:
destinationType=string,destination=string
JSON синтаксис:
{
"destinationType": "S3",
"destination": "string"
}
--roles (список)
Список ролей для оценки.
(структура)
Обёртка, содержащая информацию о роли Audit Manager текущего пользователя. Включает тип роли и IAM Amazon Resource Name (ARN).
roleType -> (строка)
Тип клиентского персонала.
Примечание
В CreateAssessment, roleType может быть только PROCESS_OWNER.
В UpdateSettings, roleType может быть только PROCESS_OWNER.
В BatchCreateDelegationByAssessment, roleType может быть только RESOURCE_OWNER.
roleArn -> (строка)
Краткая форма:
roleType=string,roleArn=string ...
JSON синтаксис:
[
{
"roleType": "PROCESS_OWNER"|"RESOURCE_OWNER",
"roleArn": "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
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла аутентификации.
--region (строка)
Регион для использования. Переопределяет настройки config/env.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- on
- off
- auto
--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 для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы параметров входных данных CLI.
Вывод
assessment -> (структура)
Объект ответа для API UpdateAssessment. Это имя обновлённой оценки.
arn -> (строка)
awsAccount -> (структура)
Учётная запись Amazon Web Services, связанная с оценкой.
id -> (строка)
emailAddress -> (строка)
name -> (строка)
metadata -> (структура)
Метаданные оценки.
name -> (строка)
id -> (строка)
description -> (строка)
complianceType -> (строка)
status -> (строка)
assessmentReportsDestination -> (структура)
Место назначения, в котором хранятся отчёты о доказательствах для оценки.
destinationType -> (строка)
destination -> (строка)
scope -> (структура)
Обёртка учётных записей и служб Amazon Web Services, включённых в сферу действия оценки.
awsAccounts -> (список)
Учётные записи Amazon Web Services, включённые в сферу действия оценки.
(структура)
Обёртка данных учётной записи Amazon Web Services, таких как идентификатор учётной записи или электронный адрес.
id -> (строка)
emailAddress -> (строка)
name -> (строка)
awsServices -> (список)
Службы Amazon Web Services, включённые в сферу действия оценки.
Предупреждение
Этот параметр API больше не поддерживается. Если вы используете этот параметр для указания одной или нескольких служб Amazon Web Services, Audit Manager игнорирует этот ввод. Вместо этого значение дляawsServices будет пустым.(структура)
Служба Amazon Web Services, например, Amazon S3 или CloudTrail.
Для примера того, как найти имя службы Amazon Web Services и как определить его в области вашей оценки, см. следующее:
- Поиск имени службы Amazon Web Services для использования в области вашей оценки
- Определение имени службы Amazon Web Services в области вашей оценки
serviceName -> (строка)
roles -> (список)
Роли, связанные с оценкой.
(структура)
Обёртка, содержащая информацию о роли Audit Manager текущего пользователя. Она включает тип роли и ARN роли IAM.
roleType -> (строка)
Тип клиентского профиля.
Примечание
В CreateAssessment , roleType может быть только PROCESS_OWNER .
В UpdateSettings , roleType может быть только PROCESS_OWNER .
В BatchCreateDelegationByAssessment , roleType может быть только RESOURCE_OWNER .
roleArn -> (строка)
delegations -> (список)
Делегирования, связанные с оценкой.
(структура)
Назначение набора правил делегату для проверки.
id -> (строка)
assessmentName -> (строка)
assessmentId -> (строка)
status -> (строка)
roleArn -> (строка)
roleType -> (строка)
Тип клиентского профиля.
Примечание
В CreateAssessment , roleType может быть только PROCESS_OWNER .
В UpdateSettings , roleType может быть только PROCESS_OWNER .
В BatchCreateDelegationByAssessment , roleType может быть только RESOURCE_OWNER .
creationTime -> (временная метка)
lastUpdated -> (временная метка)
controlSetId -> (строка)
comment -> (строка)
createdBy -> (строка)
creationTime -> (временная метка)
lastUpdated -> (временная метка)
framework -> (структура)
Фреймворк, на основе которого была создана оценка.
id -> (строка)
arn -> (строка)
metadata -> (структура)
Метаданные фреймворка, такие как имя, идентификатор или описание.
name -> (строка)
description -> (строка)
logo -> (строка)
complianceType -> (строка)
controlSets -> (список)
Наборы правил, связанные с фреймворком.
(структура)
Представляет набор правил в оценке Audit Manager.
id -> (строка)
description -> (строка)
status -> (строка)
roles -> (список)
Роли, связанные с набором правил.
(структура)
Обёртка, содержащая информацию о роли Audit Manager текущего пользователя. Она включает тип роли и ARN роли IAM.
roleType -> (строка)
Тип клиентского профиля.
Примечание
В CreateAssessment , roleType может быть только PROCESS_OWNER .
В UpdateSettings , roleType может быть только PROCESS_OWNER .
В BatchCreateDelegationByAssessment , roleType может быть только RESOURCE_OWNER .
roleArn -> (строка)
controls -> (список)
Список правил, содержащихся в наборе правил.
(структура)
Сущность правила, представляющая стандартное правило или пользовательское правило в оценке Audit Manager.
id -> (строка)
name -> (строка)
description -> (строка)
status -> (строка)
response -> (строка)
comments -> (список)
Список комментариев, прикреплённых к правилу.
(структура)
Комментарий, размещённый пользователем по поводу правила. Он включает имя автора, текст комментария и отметку времени.
authorName -> (строка)
commentBody -> (строка)
postedDate -> (временная метка)
evidenceSources -> (список)
Список источников данных для доказательств.
(строка)
evidenceCount -> (целое число)
assessmentReportEvidenceCount -> (целое число)
delegations -> (список)
Делегирования, связанные с набором правил.
(структура)
Назначение набора правил делегату для проверки.
id -> (строка)
assessmentName -> (строка)
assessmentId -> (строка)
status -> (строка)
roleArn -> (строка)
roleType -> (строка)
Тип клиентского профиля.
Примечание
В CreateAssessment , roleType может быть только PROCESS_OWNER .
В UpdateSettings , roleType может быть только PROCESS_OWNER .
В BatchCreateDelegationByAssessment , roleType может быть только RESOURCE_OWNER .
creationTime -> (временная метка)
lastUpdated -> (временная метка)
controlSetId -> (строка)
comment -> (строка)
createdBy -> (строка)
systemEvidenceCount -> (целое число)
manualEvidenceCount -> (целое число)
tags -> (карта)
Теги, связанные с оценкой.
key -> (строка)
value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.