Spec-Zone.ru › AWS CLI v2

[ aws . accessanalyzer ]

start-policy-generation

Описание

Запускает запрос на генерацию политики.

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

Синтаксис

  start-policy-generation
--policy-generation-details <value>
[--cloud-trail-details <value>]
[--client-token <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]

Параметры

--policy-generation-details (структура)

Содержит ARN сущности IAM (пользователь или роль), для которой генерируется политика.

principalArn -> (строка)

ARN сущности IAM (пользователь или роль), для которой генерируется политика.

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

principalArn=string

Синтаксис JSON:

{
  "principalArn": "string"
}

--cloud-trail-details (структура)

Объект CloudTrailDetails, содержащий подробности о Trail, который необходимо проанализировать для генерации политик.

trails -> (список)

Объект Trail, содержащий настройки трейла.

(структура)

Содержит данные о CloudTrail трейле, анализируемом для генерации политики.

cloudTrailArn -> (строка)

Указывает ARN трейла. Формат ARN трейла — arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail .

regions -> (список)

Список областей для получения данных CloudTrail и анализа для генерации политики.

(строка)

allRegions -> (булево)

Возможные значения — true или false . Если установлено значение true , IAM Access Analyzer извлекает данные CloudTrail из всех областей для анализа и генерации политики.

accessRole -> (строка)

ARN роли сервиса, которую IAM Access Analyzer использует для доступа к вашему CloudTrail трейлу и информации о последнем доступе к сервису.

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

Начало временного интервала, в рамках которого IAM Access Analyzer проверяет ваши события CloudTrail. События с отметкой времени до этой даты не учитываются при генерации политики.

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

Конец временного интервала, в рамках которого IAM Access Analyzer проверяет ваши события CloudTrail. События с отметкой времени после этой даты не учитываются при генерации политики. Если этот параметр не указан, используется текущее время по умолчанию.

Синтаксис JSON:

{
  "trails": [
    {
      "cloudTrailArn": "string",
      "regions": ["string", ...],
      "allRegions": true|false
    }
    ...
  ],
  "accessRole": "string",
  "startTime": timestamp,
  "endTime": timestamp
}

--client-token (строка)

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

Если вы не указываете маркер клиента, он автоматически генерируется Amazon Web Services SDK.

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство «Начало работы» в Руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры нужно адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Запуск запроса на генерацию политики

Следующий start-policy-generation пример запускает запрос на генерацию политики в вашем аккаунте AWS.

aws accessanalyzer start-policy-generation \
    --policy-generation-details '{"principalArn":"arn:aws:iam::111122223333:role/Admin"}' \
    --cloud-trail-details file://myfile.json

Содержимое myfile.json:

{
    "accessRole": "arn:aws:iam::111122223333:role/service-role/AccessAnalyzerMonitorServiceRole",
    "startTime": "2024-02-13T00:30:00Z",
    "trails": [
        {
            "allRegions": true,
            "cloudTrailArn": "arn:aws:cloudtrail:us-west-2:111122223333:trail/my-trail"
        }
    ]
}

Вывод:

{
    "jobId": "c557dc4a-0338-4489-95dd-739014860ff9"
}

Дополнительную информацию см. в разделе Генерация политики IAM Access Analyzer в Руководстве пользователя AWS IAM.

Вывод

jobId -> (строка)

JobId, возвращаемый операцией StartPolicyGeneration. JobId можно использовать с GetGeneratedPolicy для получения сгенерированных политик или с CancelPolicyGeneration для отмены запроса на генерацию политики.

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

Spec-Zone.ru

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