Spec-Zone.ru › AWS CLI v2

[ aws . auditmanager ]

create-assessment

Описание

Создает оценку в Audit Manager.

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

Синтаксис

  create-assessment
--name <value>
[--description <value>]
--assessment-reports-destination <value>
--scope <value>
--roles <value>
--framework-id <value>
[--tags <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]

Параметры

--name (строка)

Имя создаваемой оценки.

--description (строка)

Необязательное описание создаваемой оценки.

--assessment-reports-destination (структура)

Место назначения отчета об оценке для создаваемой оценки.

destinationType -> (строка)

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

destination -> (строка)

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

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

destinationType=string,destination=string

Синтаксис JSON:

{
  "destinationType": "S3",
  "destination": "string"
}

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

Контейнер, содержащий учетные записи Amazon Web Services, включенные в область оценки.

Примечание

Больше не требуется указывать, какие сервисы Amazon Web Services включены в область при создании или обновлении оценки. Audit Manager определяет сервисы в области, анализируя контрольные точки вашей оценки и их источники данных, и сопоставляет эту информацию с соответствующими сервисами Amazon Web Services.

Если базовый источник данных вашей оценки изменится, мы автоматически обновим область сервисов, чтобы отразить правильные сервисы Amazon Web Services. Это гарантирует, что ваша оценка собирает точные и исчерпывающие данные обо всех соответствующих сервисах в вашей среде AWS.

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.

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

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"
    }
    ...
  ]
}

--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"
  }
  ...
]

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

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

--tags (карта)

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

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "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.

Вывод

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

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

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