Spec-Zone.ru › AWS CLI v2

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

Идентификатор Amazon Web Services счета.

emailAddress -> (строка)

Адрес электронной почты, связанный с Amazon Web Services счетом.

name -> (строка)

Название Amazon Web Services счета.

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

Название Amazon Web Services сервиса.

Краткая форма:

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

Тип назначения, такой как Amazon S3.

destination -> (строка)

Временной контейнер (bucket), где Audit Manager хранит отчеты об оценке.

Краткая форма:

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

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

Краткая форма:

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.

``` END_OF_DOCUMENT_MARKER

Вывод

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

Объект ответа для API UpdateAssessment. Это имя обновлённой оценки.

arn -> (строка)

Amazon Resource Name (ARN) оценки.

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

Учётная запись Amazon Web Services, связанная с оценкой.

id -> (строка)

Идентификатор учётной записи Amazon Web Services.

emailAddress -> (строка)

Электронный адрес, связанный с учётной записью Amazon Web Services.

name -> (строка)

Имя учётной записи Amazon Web Services.

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

Метаданные оценки.

name -> (строка)

Название оценки.

id -> (строка)

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

description -> (строка)

Описание оценки.

complianceType -> (строка)

Название стандарта соответствия, связанного с оценкой, например, PCI-DSS.

status -> (строка)

Общий статус оценки.

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

Место назначения, в котором хранятся отчёты о доказательствах для оценки.

destinationType -> (строка)

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

destination -> (строка)

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

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

Обёртка учётных записей и служб Amazon Web Services, включённых в сферу действия оценки.

awsAccounts -> (список)

Учётные записи Amazon Web Services, включённые в сферу действия оценки.

(структура)

Обёртка данных учётной записи Amazon Web Services, таких как идентификатор учётной записи или электронный адрес.

id -> (строка)

Идентификатор учётной записи Amazon Web Services.

emailAddress -> (строка)

Электронный адрес, связанный с учётной записью Amazon Web Services.

name -> (строка)

Имя учётной записи Amazon Web Services.

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

Имя службы Amazon Web Services.

roles -> (список)

Роли, связанные с оценкой.

(структура)

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

roleType -> (строка)

Тип клиентского профиля.

Примечание

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

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

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

roleArn -> (строка)

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

delegations -> (список)

Делегирования, связанные с оценкой.

(структура)

Назначение набора правил делегату для проверки.

id -> (строка)

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

assessmentName -> (строка)

Название оценки, связанной с делегированием.

assessmentId -> (строка)

Идентификатор оценки, связанной с делегированием.

status -> (строка)

Статус делегирования.

roleArn -> (строка)

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

roleType -> (строка)

Тип клиентского профиля.

Примечание

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

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

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

creationTime -> (временная метка)

Указывает, когда было создано делегирование.

lastUpdated -> (временная метка)

Указывает время последнего обновления делегирования.

controlSetId -> (строка)

Идентификатор набора правил, связанного с делегированием.

comment -> (строка)

Комментарий, связанный с делегированием.

createdBy -> (строка)

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

creationTime -> (временная метка)

Указывает, когда была создана оценка.

lastUpdated -> (временная метка)

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

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

Фреймворк, на основе которого была создана оценка.

id -> (строка)

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

arn -> (строка)

Amazon Resource Name (ARN) фреймворка.

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

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

name -> (строка)

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

description -> (строка)

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

logo -> (строка)

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

complianceType -> (строка)

Стандарт соответствия, связанный с фреймворком. Например, это может быть PCI DSS или HIPAA.

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

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

controls -> (список)

Список правил, содержащихся в наборе правил.

(структура)

Сущность правила, представляющая стандартное правило или пользовательское правило в оценке Audit Manager.

id -> (строка)

Идентификатор правила.

name -> (строка)

Имя правила.

description -> (строка)

Описание правила.

status -> (строка)

Статус правила.

response -> (строка)

Ответ правила.

comments -> (список)

Список комментариев, прикреплённых к правилу.

(структура)

Комментарий, размещённый пользователем по поводу правила. Он включает имя автора, текст комментария и отметку времени.

authorName -> (строка)

Имя пользователя, написавшего комментарий.

commentBody -> (строка)

Текст комментария к правилу.

postedDate -> (временная метка)

Время размещения комментария.

evidenceSources -> (список)

Список источников данных для доказательств.

(строка)

evidenceCount -> (целое число)

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

assessmentReportEvidenceCount -> (целое число)

Количество доказательств в отчёте об оценке.

delegations -> (список)

Делегирования, связанные с набором правил.

(структура)

Назначение набора правил делегату для проверки.

id -> (строка)

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

assessmentName -> (строка)

Название оценки, связанной с делегированием.

assessmentId -> (строка)

Идентификатор оценки, связанной с делегированием.

status -> (строка)

Статус делегирования.

roleArn -> (строка)

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

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.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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