Spec-Zone.ru › AWS CLI v2

[ aws . auditmanager ]

get-control

Описание

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

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

Синтаксис

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

Параметры

--control-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
  • текст
  • таблица
  • 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.

Вывод

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

Подробности управления, которые вернул API GetControl.

arn -> (строка)

Amazon Resource Name (ARN) управления.

id -> (строка)

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

type -> (строка)

Указывает, является ли управление стандартным или настраиваемым.

name -> (строка)

Название управления.

description -> (строка)

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

testingInformation -> (строка)

Шаги, которые следует выполнить, чтобы определить, выполнено ли управление.

actionPlanTitle -> (строка)

Заголовок плана действий для устранения несоответствий управления.

actionPlanInstructions -> (строка)

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

controlSources -> (строка)

Типы источников данных, определяющие, откуда Audit Manager собирает доказательства для управления.

controlMappingSources -> (список)

Источники сопоставления данных для управления.

(структура)

Источник данных, определяющий, откуда Audit Manager собирает доказательства для управления.

sourceId -> (строка)

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

sourceName -> (строка)

Название источника.

sourceDescription -> (строка)

Описание источника.

sourceSetUpOption -> (строка)

Параметр настройки источника данных. Этот параметр отражает, является ли метод сбора доказательств автоматическим или ручным. Если вы не укажете значение для sourceSetUpOption, Audit Manager автоматически выведет и заполнит правильное значение на основе sourceType, которое вы укажете.

sourceType -> (строка)

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

  • Источник может быть отдельным типом источника данных, например, AWS_Cloudtrail, AWS_Config, AWS_Security_Hub, AWS_API_Call или MANUAL.
  • Источник также может быть управляемой группой источников данных, например, Core_Control или Common_Control.

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

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

Для ручных доказательств это ключевое слово указывает, является ли ручное доказательство файлом или текстом.

Для автоматических доказательств это ключевое слово идентифицирует определенное событие CloudTrail, правило Config, управление Security Hub или имя API Amazon Web Services.

Дополнительные сведения о поддерживаемых ключевых словах, которые можно использовать при сопоставлении источника данных управления, см. на следующих страницах в руководстве пользователя Audit Manager:

  • Поддерживаемые правила Config в Audit Manager
  • Поддерживаемые управления Security Hub в Audit Manager
  • Поддерживаемые вызовы API в Audit Manager
  • Поддерживаемые имена событий CloudTrail в Audit Manager

keywordInputType -> (строка)

Метод ввода ключевого слова.

  • SELECT_FROM_LIST используется при сопоставлении источника данных для автоматических доказательств.
    • Когда keywordInputType равен SELECT_FROM_LIST, необходимо выбрать ключевое слово для сбора автоматических доказательств. Например, это может быть имя события CloudTrail, имя правила для Config, управление Security Hub или имя вызова API Amazon Web Services.
  • UPLOAD_FILE и INPUT_TEXT используются только при сопоставлении источника данных для ручных доказательств.
    • Когда keywordInputType равен UPLOAD_FILE, необходимо загрузить файл в качестве ручных доказательств.
    • Когда keywordInputType равен INPUT_TEXT, необходимо ввести текст в качестве ручных доказательств.

keywordValue -> (строка)

Значение ключевого слова, используемого при сопоставлении источника данных управления. Например, это может быть имя события CloudTrail, имя правила для Config, управление Security Hub или имя вызова API Amazon Web Services.

Если вы сопоставляете источник данных с правилом в Config, указанное вами keywordValue зависит от типа правила:

  • Для управляемых правил вы можете использовать идентификатор правила в качестве keywordValue. Идентификатор правила можно найти в списке управляемых правил Config. Для некоторых правил идентификатор правила отличается от имени правила. Например, правило с именем restricted-ssh имеет следующий идентификатор правила: INCOMING_SSH_DISABLED. Убедитесь, что используется идентификатор правила, а не имя правила. Пример ключевого слова для управляемых правил:
    • Имя управляемого правила: s3-bucket-acl-prohibited keywordValue : S3_BUCKET_ACL_PROHIBITED
  • Для настраиваемых правил вы формируете keywordValue, добавив префикс Custom_ к имени правила. Этот префикс отличает настраиваемое правило от управляемого правила. Пример ключевого слова для настраиваемых правил:
    • Имя настраиваемого правила: my-custom-config-rule keywordValue : Custom_my-custom-config-rule
  • Для правил, связанных с услугой, вы формируете keywordValue, добавив префикс Custom_ к имени правила. Кроме того, удалите суффикс ID, который появляется в конце имени правила. Примеры ключевых слов для правил, связанных с услугой:
    • Имя правила, связанного с услугой: CustomRuleForAccount-conformance-pack-szsm1uv0w keywordValue : Custom_CustomRuleForAccount-conformance-pack
    • Имя правила, связанного с услугой: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba keywordValue : Custom_OrgConfigRule-s3-bucket-versioning-enabled

Предупреждение

keywordValue чувствителен к регистру. Если вы введете значение неправильно, Audit Manager может не распознать сопоставление источника данных. В результате вы можете не успешно собрать доказательства из этого источника данных, как предполагалось.

Учитывайте следующие требования в зависимости от используемого типа источника данных.

  • Для Config:
    • Для управляемых правил убедитесь, что keywordValue является идентификатором правила в ALL_CAPS_WITH_UNDERSCORES. Например, CLOUDWATCH_LOG_GROUP_ENCRYPTED. Для точности рекомендуется обратиться к списку поддерживаемых управляемых правил Config.
    • Для настраиваемых правил убедитесь, что keywordValue имеет префикс Custom_, за которым следует имя настраиваемого правила. Формат самого имени настраиваемого правила может отличаться. Для точности рекомендуется посетить консоль Config, чтобы проверить имя своего настраиваемого правила.
  • Для Security Hub: формат изменяется для имен управления Security Hub. Для точности рекомендуется обратиться к списку поддерживаемых управлений Security Hub.
  • Для вызовов API Amazon Web Services: убедитесь, что keywordValue записано как serviceprefix_ActionName. Например, iam_ListGroups. Для точности рекомендуется обратиться к списку поддерживаемых вызовов API.
  • Для CloudTrail: убедитесь, что keywordValue записано как serviceprefix_ActionName. Например, cloudtrail_StartLogging. Для точности рекомендуется просмотреть префиксы служб и имена действий Amazon Web Services в справке по авторизации служб.

sourceFrequency -> (строка)

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

troubleshootingText -> (строка)

Инструкции по устранению неполадок управления.

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

Время создания управления.

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

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

createdBy -> (строка)

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

lastUpdatedBy -> (строка)

Пользователь или роль, которые последними обновили управление.

tags -> (карта)

Теги, связанные с управлением.

key -> (строка)

value -> (строка)

state -> (строка)

Состояние управления. Состояние END_OF_SUPPORT применимо только к стандартным управлениям. Это состояние указывает, что стандартное управление по-прежнему может использоваться для сбора доказательств, но Audit Manager больше не обновляет или не поддерживает данное управление.

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

Spec-Zone.ru

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