Spec-Zone.ru › AWS CLI v2

[ aws . workmail ]

put-identity-provider-configuration

Описание

Включает интеграцию между IAM Identity Center (IdC) и WorkMail для проксирования запросов аутентификации для пользователей почтовых ящиков. Вы можете подключить свой каталог IdC или внешний каталог к WorkMail через IdC и управлять доступом к почтовым ящикам WorkMail в одном месте. Для повышения защиты можно включить многофакторную аутентификацию (MFA) и персональные токены доступа.

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

Синтаксис

  put-identity-provider-configuration
--organization-id <value>
--authentication-mode <value>
--identity-center-configuration <value>
--personal-access-token-configuration <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]

Параметры

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

Идентификатор организации WorkMail.

--authentication-mode (строка)

Режим аутентификации, используемый в WorkMail.

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

  • IDENTITY_PROVIDER_ONLY
  • IDENTITY_PROVIDER_AND_DIRECTORY

--identity-center-configuration (структура)

Подробности конфигурации IAM Identity Center.

InstanceArn -> (строка)

Amazon Resource Name (ARN) экземпляра IAM Identity Center. Должен находиться в той же учётной записи AWS и регионе, что и организация WorkMail.

ApplicationArn -> (строка)

Amazon Resource Name (ARN) приложения IAM Identity Center для WorkMail. Должен быть создан API WorkMail, см. CreateIdentityCenterApplication.

Краткая запись:

InstanceArn=string,ApplicationArn=string

Синтаксис JSON:

{
  "InstanceArn": "string",
  "ApplicationArn": "string"
}

--personal-access-token-configuration (структура)

Подробности конфигурации персональных токенов доступа.

Status -> (строка)

Статус разрешённого для организации персонального токена доступа.

  • Active - Пользователи почтовых ящиков могут войти в веб-приложение и выбрать Настройки, чтобы увидеть новую страницу Персональные токены доступа для создания и удаления персональных токенов доступа. Пользователи почтовых ящиков могут использовать персональные токены доступа для настройки подключения к почтовым ящикам с настольных или мобильных почтовых клиентов.
  • Inactive - Персональные токены доступа отключены для вашей организации. Пользователи почтовых ящиков не могут создавать, перечислять или удалять персональные токены доступа и не могут использовать их для подключения к своим почтовым ящикам с настольных или мобильных почтовых клиентов.

LifetimeInDays -> (целое число)

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

Краткая запись:

Status=string,LifetimeInDays=integer

Синтаксис JSON:

{
  "Status": "ACTIVE"|"INACTIVE",
  "LifetimeInDays": integer
}

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

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическую запрос параметров ввода CLI.

Вывод

Нет

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

Spec-Zone.ru

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