Spec-Zone.ru › AWS CLI v2

[ aws . auditmanager ]

get-assessment

Описание

Получает информацию об указанной оценке.

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

Синтаксис

  get-assessment
--assessment-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]

Параметры

--assessment-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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

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

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

Обёртка, содержащая информацию о роли Управляющего аудитом текущего пользователя. Включает тип роли и IAM Amazon Resource Name (ARN).

roleType -> (строка)

Тип клиента.

Примечание

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

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

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

roleArn -> (строка)

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

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