Spec-Zone.ru › AWS CLI v2

[ aws . workmail ]

создать-роль-для-имитации

Описание

Создаёт роль для имитации пользователя в данной организации WorkMail.

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

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

Синтаксис

  create-impersonation-role
[--client-token <value>]
--organization-id <value>
--name <value>
--type <value>
[--description <value>]
--rules <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]

Параметры

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

Маркер идемпотентности для запроса клиента.

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

Организация WorkMail, в которой будет создана новая роль имитации.

--name (строка)

Имя новой роли для имитации пользователя.

--type (строка)

Тип роли для имитации. Доступные типы ролей для имитации — READ_ONLY или FULL_ACCESS .

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

  • FULL_ACCESS
  • READ_ONLY

--description (строка)

Описание новой роли для имитации пользователя.

--rules (список)

Список правил для роли для имитации пользователя.

(структура)

Правила для данной роли для имитации пользователя.

ImpersonationRuleId -> (строка)

Идентификатор правила.

Name -> (строка)

Имя правила.

Description -> (строка)

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

Effect -> (строка)

Эффект правила при совпадении со входом. Разрешённые значения эффекта — ALLOW или DENY .

TargetUsers -> (список)

Список идентификаторов пользователей, которые соответствуют правилу.

(строка)

NotTargetUsers -> (список)

Список идентификаторов пользователей, которые не соответствуют правилу.

(строка)

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

ImpersonationRuleId=string,Name=string,Description=string,Effect=string,TargetUsers=string,string,NotTargetUsers=string,string ...

Синтаксис JSON:

[
  {
    "ImpersonationRuleId": "string",
    "Name": "string",
    "Description": "string",
    "Effect": "ALLOW"|"DENY",
    "TargetUsers": ["string", ...],
    "NotTargetUsers": ["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
  • text
  • таблица
  • 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.

Вывод

ImpersonationRoleId -> (строка)

Новый идентификатор роли для имитации.

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

Spec-Zone.ru

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