Spec-Zone.ru › AWS CLI v2

[ aws . auditmanager ]

обновить-статус-оценки

Описание

Обновляет статус оценки в Audit Manager.

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

Синтаксис

  update-assessment-status
--assessment-id <value>
--status <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 (строка)

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

--status (строка)

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

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

  • ACTIVE
  • INACTIVE

--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.

Вывод

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

Имя обновлённой оценки, возвращённой API UpdateAssessmentStatus.

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 текущего пользователя. Она включает тип роли и IAM Amazon Resource Name (ARN).

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 текущего пользователя. Она включает тип роли и IAM Amazon Resource Name (ARN).

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