Обновить пул пользователей

Описание

Обновляет конфигурацию пула пользователей. Чтобы избежать установки параметров по умолчанию Amazon Cognito, постройте этот API-запрос, передавая существующую конфигурацию вашего пула пользователей, изменённую для включения желаемых изменений.

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

Если вы не предоставите значение для атрибута, Amazon Cognito установит его по умолчанию.

Примечание

Данное действие может генерировать SMS-сообщение. Начиная с 1 июня 2021 года, операторы связи США требуют регистрации номера отправки перед отправкой SMS-сообщений на номера телефонов США. Если вы используете SMS-сообщения в Amazon Cognito, вы должны зарегистрировать номер телефона в Amazon Pinpoint. Amazon Cognito будет автоматически использовать зарегистрированный номер. В противном случае пользователи Amazon Cognito, которым необходимо получать SMS-сообщения, могут не иметь возможности зарегистрироваться, активировать свои учетные записи или войти в систему.

Если вы никогда не использовали SMS-сообщения с Amazon Cognito или любой другой службой Amazon Web Services, Amazon Simple Notification Service может поместить вашу учетную запись в песочницу SMS. В режиме песочницы вы можете отправлять сообщения только проверенным номерам телефонов. После тестирования приложения в среде песочницы вы можете перейти из песочницы в производство. Более подробную информацию см. в разделе «Настройки SMS-сообщений для пулов пользователей Amazon Cognito» в Руководстве разработчика Amazon Cognito.

Примечание

Amazon Cognito оценивает политики управления идентификацией и доступом (IAM) в запросах для этой API-операции. Для этой операции вы должны использовать учетные данные IAM для авторизации запросов и предоставить себе соответствующее разрешение IAM в политике.

Узнать больше

Подписание запросов к API Amazon Web Services
Использование API пулов пользователей Amazon Cognito и конечных точек пула пользователей

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

Синтаксис

  update-user-pool
--user-pool-id <value>
[--policies <value>]
[--deletion-protection <value>]
[--lambda-config <value>]
[--auto-verified-attributes <value>]
[--sms-verification-message <value>]
[--email-verification-message <value>]
[--email-verification-subject <value>]
[--verification-message-template <value>]
[--sms-authentication-message <value>]
[--user-attribute-update-settings <value>]
[--mfa-configuration <value>]
[--device-configuration <value>]
[--email-configuration <value>]
[--sms-configuration <value>]
[--user-pool-tags <value>]
[--admin-create-user-config <value>]
[--user-pool-add-ons <value>]
[--account-recovery-setting <value>]
[--pool-name <value>]
[--user-pool-tier <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]

Параметры

--user-pool-id (строка)

ID пула пользователей, который вы хотите обновить.

--policies (структура)

Политика пароля и политика входа в систему в пуле пользователей. Политика пароля устанавливает такие параметры, как требования к сложности пароля и истории паролей. Политика входа в систему устанавливает параметры, доступные приложениям в аутентификации на основе выбора.

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

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

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

Минимальная длина пароля в политике, которую вы установили. Это значение не может быть меньше 6.

RequireUppercase -> (булево)

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

RequireLowercase -> (булево)

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

RequireNumbers -> (булево)

Требование в политике пароля о том, что пользователи должны включать по крайней мере одну цифру в свой пароль.

RequireSymbols -> (булево)

Требование в политике пароля о том, что пользователи должны включать по крайней мере один символ в свой пароль.

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

Количество предыдущих паролей, которые вы хотите, чтобы Amazon Cognito ограничил для каждого пользователя. Пользователи не могут установить пароль, совпадающий с любым из n предыдущих паролей, где n - это значение PasswordHistorySize.

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

Количество дней, в течение которых временный пароль действителен в политике паролей. Если пользователь не войдет в систему за это время, администратор должен сбросить его пароль. По умолчанию 7. Если вы передадите значение 0, Amazon Cognito будет рассматривать его как значение null и устанавливать TemporaryPasswordValidityDays по умолчанию.

Примечание

При установке TemporaryPasswordValidityDays для пула пользователей вы больше не можете устанавливать значение для параметра UnusedAccountValidityDays в этом пуле.

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

Политика разрешенных типов аутентификации в пуле пользователей.

AllowedFirstAuthFactors -> (список)

Методы входа в систему, которые поддерживаются пулом пользователей в качестве первого фактора. Вы можете разрешить пользователям начинать аутентификацию с стандартного имени пользователя и пароля или с других одноразовых паролей и аппаратных факторов.

(строка)

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

PasswordPolicy={MinimumLength=integer,RequireUppercase=boolean,RequireLowercase=boolean,RequireNumbers=boolean,RequireSymbols=boolean,PasswordHistorySize=integer,TemporaryPasswordValidityDays=integer},SignInPolicy={AllowedFirstAuthFactors=[string,string]}

Синтаксис JSON:

{
  "PasswordPolicy": {
    "MinimumLength": integer,
    "RequireUppercase": true|false,
    "RequireLowercase": true|false,
    "RequireNumbers": true|false,
    "RequireSymbols": true|false,
    "PasswordHistorySize": integer,
    "TemporaryPasswordValidityDays": integer
  },
  "SignInPolicy": {
    "AllowedFirstAuthFactors": ["PASSWORD"|"EMAIL_OTP"|"SMS_OTP"|"WEB_AUTHN", ...]
  }
}

--deletion-protection (строка)

При включённом состоянии, DeletionProtection предотвращает случайное удаление вашего пула пользователей. Перед тем, как вы сможете удалить защищённый от удаления пул пользователей, вы должны отключить эту функцию.

Когда вы пытаетесь удалить защищенный пул пользователей в запросе API DeleteUserPool, Amazon Cognito возвращает ошибку InvalidParameterException. Чтобы удалить защищённый пул пользователей, отправьте новый запрос DeleteUserPool после отключения защиты от удаления в запросе API UpdateUserPool.

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

ACTIVE
INACTIVE

--lambda-config (структура)

Коллекция триггеров Lambda для пула пользователей. Amazon Cognito вызывает триггеры на нескольких возможных этапах операций аутентификации. Триггеры могут изменять результат операций, которые их вызывали.

PreSignUp -> (строка)

Настройка триггера Lambda до регистрации пользователя в пуле пользователей. Этот триггер оценивает новых пользователей и может пропускать подтверждение, привязывать профиль федеративного пользователя или блокировать запросы на регистрацию.

CustomMessage -> (строка)

Триггер Lambda пользовательского сообщения. Этот триггер предоставляет возможность настроить все SMS- и электронные письма от вашего пула пользователей. Когда активен триггер пользовательского сообщения, ваш пул пользователей перенаправляет все сообщения в функцию Lambda, которая возвращает заголовок и тело сообщения, настроенные во время выполнения, для доставки вашему пользователю.

PostConfirmation -> (строка)

Настройка триггера Lambda после подтверждения в пуле пользователей. Этот триггер может выполнить дополнительные действия после того, как пользователь подтвердит свою учетную запись пользователя и свой адрес электронной почты или номер телефона.

PreAuthentication -> (строка)

Настройка триггера предварительной аутентификации в пуле пользователей. Этот триггер может оценивать и изменять события входа в систему пользователя.

PostAuthentication -> (строка)

Настройка триггера Lambda после аутентификации в пуле пользователей. Этот триггер может выполнить дополнительные действия после входа пользователя в систему.

DefineAuthChallenge -> (строка)

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

CreateAuthChallenge -> (строка)

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

VerifyAuthChallengeResponse -> (строка)

Настройка триггера Lambda для проверки ответа на проблему аутентификации, одного из трех триггеров в последовательности триггеров задач пользовательской аутентификации.

PreTokenGeneration -> (строка)

Настройка устаревшего триггера Lambda до генерации токена в пуле пользователей.

Установите этот параметр для совместимости со старыми версиями. Если вы также задаете ARN в PreTokenGenerationConfig, его значение должно быть идентично PreTokenGeneration. Для новых случаев триггеров до генерации токена, задайте LambdaArn из PreTokenGenerationConfig.

UserMigration -> (строка)

Настройка триггера Lambda для миграции пользователей в пуле пользователей. Этот триггер может создавать профили пользователей, когда пользователи входят в систему или пытаются сбросить свой пароль с помощью учетных данных, которые еще не существуют.

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

Подробная настройка триггера Lambda до генерации токена в пуле пользователей. Если вы также задаете ARN в PreTokenGeneration, его значение должно быть идентично PreTokenGenerationConfig.

LambdaVersion -> (строка)

Версия триггера пула пользователей запроса, который Amazon Cognito отправляет вашей функции Lambda. Версии с более высокими номерами добавляют поля, которые поддерживают новые функции.

LambdaArn -> (строка)

Amazon Resource Name (ARN) функции, которую вы хотите назначить своему триггеру Lambda.

Этот параметр и свойство PreTokenGeneration из LambdaConfig имеют одинаковое значение. Для новых случаев триггеров до генерации токена, задайте LambdaArn.

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

Настройка триггера Lambda пользовательского отправителя SMS. Этот триггер перенаправляет все SMS-уведомления из пула пользователей в функцию Lambda, которая передает сообщение с помощью настраиваемой логики.

LambdaVersion -> (строка)

Вы должны использовать LambdaVersion из V1_0 с функцией пользовательского отправителя.

LambdaArn -> (строка)

Amazon Resource Name (ARN) функции, которую вы хотите назначить своему триггеру Lambda.

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

Настройка триггера Lambda пользовательского отправителя электронных писем. Этот триггер перенаправляет все электронные письма из пула пользователей в функцию Lambda, которая передает сообщение с помощью настраиваемой логики.

LambdaVersion -> (строка)

Вы должны использовать LambdaVersion из V1_0 с функцией пользовательского отправителя.

LambdaArn -> (строка)

Amazon Resource Name (ARN) функции, которую вы хотите назначить своему триггеру Lambda.

KMSKeyID -> (строка)

ARN ключа KMS. Amazon Cognito использует ключ для шифрования кодов и временных паролей, отправленных триггерам Lambda пользовательских отправителей.

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

PreSignUp=string,CustomMessage=string,PostConfirmation=string,PreAuthentication=string,PostAuthentication=string,DefineAuthChallenge=string,CreateAuthChallenge=string,VerifyAuthChallengeResponse=string,PreTokenGeneration=string,UserMigration=string,PreTokenGenerationConfig={LambdaVersion=string,LambdaArn=string},CustomSMSSender={LambdaVersion=string,LambdaArn=string},CustomEmailSender={LambdaVersion=string,LambdaArn=string},KMSKeyID=string

Синтаксис JSON:

{
  "PreSignUp": "string",
  "CustomMessage": "string",
  "PostConfirmation": "string",
  "PreAuthentication": "string",
  "PostAuthentication": "string",
  "DefineAuthChallenge": "string",
  "CreateAuthChallenge": "string",
  "VerifyAuthChallengeResponse": "string",
  "PreTokenGeneration": "string",
  "UserMigration": "string",
  "PreTokenGenerationConfig": {
    "LambdaVersion": "V1_0"|"V2_0"|"V3_0",
    "LambdaArn": "string"
  },
  "CustomSMSSender": {
    "LambdaVersion": "V1_0",
    "LambdaArn": "string"
  },
  "CustomEmailSender": {
    "LambdaVersion": "V1_0",
    "LambdaArn": "string"
  },
  "KMSKeyID": "string"
}

--auto-verified-attributes (список)

Атрибуты, которые вы хотите, чтобы ваш пул пользователей автоматически проверял. Возможные значения: email , phone_number . Для получения дополнительной информации см. Проверка контактной информации при регистрации.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  phone_number
  email

--sms-verification-message (строка)

Этот параметр больше не используется.

--email-verification-message (строка)

Этот параметр больше не используется.

--email-verification-subject (строка)

Этот параметр больше не используется.

--verification-message-template (структура)

Шаблон сообщения о подтверждении, которое ваш пользовательский пул отправляет пользователям, которые установили атрибут электронной почты или номера телефона.

Установите тип сообщения электронной почты, соответствующий вашему выбору DefaultEmailOption. Для CONFIRM_WITH_LINK укажите EmailMessageByLink и оставьте EmailMessage пустым. Для CONFIRM_WITH_CODE укажите EmailMessage и оставьте EmailMessageByLink пустым. При предоставлении обоих параметров с любым выбором Amazon Cognito возвращает ошибку.

SmsMessage -> (строка)

Шаблон для SMS-сообщений, которые Amazon Cognito отправляет вашим пользователям.

EmailMessage -> (строка)

Шаблон для сообщений электронной почты, которые Amazon Cognito отправляет вашим пользователям. Вы можете установить шаблон EmailMessage только в том случае, если значение EmailSendingAccount равно DEVELOPER. Когда EmailSendingAccount равно DEVELOPER, ваш пользовательский пул отправляет сообщения электронной почты с вашей собственной конфигурацией Amazon SES.

EmailSubject -> (строка)

Строка темы для шаблона сообщения электронной почты. Вы можете установить шаблон EmailSubject только в том случае, если значение EmailSendingAccount равно DEVELOPER. Когда EmailSendingAccount равно DEVELOPER, ваш пользовательский пул отправляет сообщения электронной почты с вашей собственной конфигурацией Amazon SES.

EmailMessageByLink -> (строка)

Шаблон сообщения электронной почты для отправки пользователю ссылки подтверждения. Вы можете установить шаблон EmailMessageByLink только в том случае, если значение EmailSendingAccount равно DEVELOPER. Когда EmailSendingAccount равно DEVELOPER, ваш пользовательский пул отправляет сообщения электронной почты с вашей собственной конфигурацией Amazon SES.

EmailSubjectByLink -> (строка)

Строка темы для шаблона сообщения электронной почты для отправки пользователю ссылки подтверждения. Вы можете установить шаблон EmailSubjectByLink только в том случае, если значение EmailSendingAccount равно DEVELOPER. Когда EmailSendingAccount равно DEVELOPER, ваш пользовательский пул отправляет сообщения электронной почты с вашей собственной конфигурацией Amazon SES.

DefaultEmailOption -> (строка)

Настройка электронных писем подтверждения, содержащих нажимаемую ссылку или код подтверждения.

Для ссылки тело вашего шаблона должно содержать текст ссылки в формате {##Click here##}. «Нажмите здесь» в примере — это настраиваемая строка. Для кода тело вашего шаблона должно содержать заполнитель кода в формате {####}.

Сокращенная синтаксическая запись:

SmsMessage=string,EmailMessage=string,EmailSubject=string,EmailMessageByLink=string,EmailSubjectByLink=string,DefaultEmailOption=string

Синтаксис JSON:

{
  "SmsMessage": "string",
  "EmailMessage": "string",
  "EmailSubject": "string",
  "EmailMessageByLink": "string",
  "EmailSubjectByLink": "string",
  "DefaultEmailOption": "CONFIRM_WITH_LINK"|"CONFIRM_WITH_CODE"
}

--sms-authentication-message (строка)

Содержимое SMS-сообщения, которое ваш пользовательский пул отправляет пользователям при аутентификации по SMS.

--user-attribute-update-settings (структура)

Настройки обновлений атрибутов пользователей. Эти настройки включают свойство AttributesRequireVerificationBeforeUpdate, настройку пользовательского пула, которая сообщает Amazon Cognito, как обрабатывать изменения значения атрибутов адреса электронной почты и номера телефона ваших пользователей. Дополнительную информацию см. в разделе Подтверждение обновлений адресов электронной почты и номеров телефонов.

AttributesRequireVerificationBeforeUpdate -> (список)

Требует, чтобы ваш пользователь подтвердил свой адрес электронной почты, номер телефона или оба, прежде чем Amazon Cognito обновит значение этого атрибута. При обновлении атрибута пользователя, у которого активирован этот параметр, Amazon Cognito отправляет сообщение о подтверждении на новый номер телефона или адрес электронной почты. Amazon Cognito не изменяет значение атрибута до тех пор, пока ваш пользователь не ответит на сообщение о подтверждении и не подтвердит новое значение.

Когда AttributesRequireVerificationBeforeUpdate ложно, ваш пользовательский пул не требует, чтобы ваши пользователи подтверждали изменения атрибутов, прежде чем Amazon Cognito обновит их. В пользовательском пуле, где AttributesRequireVerificationBeforeUpdate ложно, операции API, которые изменяют значения атрибутов, могут сразу обновить атрибут пользователя email или phone_number.

(строка)

Сокращенная синтаксическая запись:

AttributesRequireVerificationBeforeUpdate=string,string

Синтаксис JSON:

{
  "AttributesRequireVerificationBeforeUpdate": ["phone_number"|"email", ...]
}

--mfa-configuration (строка)

Устанавливает многофакторную аутентификацию (MFA) в состояние включено, выключено или необязательно. Когда ON, все пользователи должны настроить MFA, прежде чем они смогут войти в систему. Когда OPTIONAL, ваше приложение должно определить на стороне клиента, хочет ли пользователь зарегистрировать устройство MFA. Для пользовательских пулов с адаптивной аутентификацией с защитой от угроз выберите OPTIONAL.

Когда MfaConfiguration равно OPTIONAL, управляемый вход не будет автоматически предлагать пользователям настроить MFA. Amazon Cognito генерирует запросы MFA в ответах API и при управляемом входе для пользователей, которые выбрали и настроились на предпочтительный фактор MFA.

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

OFF
ON
OPTIONAL

--device-configuration (структура)

Настройка запоминания устройства для пользовательского пула. Запоминание устройства или отслеживание устройства — это опция «Запомнить меня на этом устройстве» для пользовательских пулов, которые выполняют аутентификацию с помощью ключа устройства доверенного устройства на стороне сервера, а не с помощью кода MFA, предоставленного пользователем. Дополнительную информацию об аутентификации устройств см. в разделе Работа с устройствами пользователей в вашем пользовательском пуле. Значение null указывает, что вы деактивировали запоминание устройства в вашем пользовательском пуле.

Примечание

При предоставлении значения для любого поля DeviceConfiguration вы активируете функцию запоминания устройства Amazon Cognito. Дополнительную информацию см. в разделе Работа с устройствами.

ChallengeRequiredOnNewDevice -> (булево)

Если истинно, запомненное устройство может войти в систему с аутентификацией устройства вместо факторов SMS и временного одноразового пароля (TOTP) для многофакторной аутентификации (MFA).

Примечание

Независимо от того, истинно ли значение ChallengeRequiredOnNewDevice, пользователи, которые входят в систему с устройствами, которые не были подтверждены или запомнены, по-прежнему должны предоставить второй фактор в пользовательском пуле, требующем MFA.

DeviceOnlyRememberedOnUserPrompt -> (булево)

Если истинно, Amazon Cognito не запоминает устройство пользователя автоматически, когда ваше приложение отправляет запрос API ConfirmDevice. В вашем приложении создайте запрос для вашего пользователя, чтобы он выбрал, хочет ли он запомнить свое устройство. Верните выбор пользователя в запросе API UpdateDeviceStatus.

Если DeviceOnlyRememberedOnUserPrompt равно false, Amazon Cognito сразу же запоминает устройства, которые вы регистрируете в запросе API ConfirmDevice.

Сокращенная синтаксическая запись:

ChallengeRequiredOnNewDevice=boolean,DeviceOnlyRememberedOnUserPrompt=boolean

Синтаксис JSON:

{
  "ChallengeRequiredOnNewDevice": true|false,
  "DeviceOnlyRememberedOnUserPrompt": true|false
}

--email-configuration (структура)

Настройка электронной почты для вашего пользовательского пула. Тип настройки электронной почты устанавливает предпочитаемый метод отправки, регион Amazon Web Services и отправителя для электронных приглашений и сообщений о проверке из вашего пользовательского пула.

SourceArn -> (строка)

ARN проверенного адреса электронной почты или адреса из проверенного домена в Amazon SES. Вы можете задать SourceArn адрес из проверенного домена только с помощью запроса API. Вы можете задать проверенный адрес электронной почты, но не адрес в проверенном домене, в консоли Amazon Cognito. Amazon Cognito использует предоставленный вами адрес электронной почты следующим образом, в зависимости от значения параметра EmailSendingAccount:

Если вы укажете COGNITO_DEFAULT , Amazon Cognito использует этот адрес в качестве пользовательского адреса ОТПРАВЛЯЮЩИЙ при отправке электронных писем пользователям с помощью своего встроенного почтового аккаунта.
Если вы укажете DEVELOPER , Amazon Cognito отправляет электронные письма вашим пользователям, вызывая Amazon SES от вашего имени.

Значение параметра SourceArn должно указывать поддерживаемый регион Amazon Web Services для вашего пользовательского пула. Обычно регион в параметре SourceArn и регион пользовательского пула совпадают. Дополнительную информацию см. в руководстве разработчика Amazon Cognito, разделе «Регионы конфигурации электронной почты Amazon SES».

ReplyToEmailAddress -> (строка)

Адрес назначения, для ответа на полученное электронное письмо.

EmailSendingAccount -> (строка)

Указывает, использует ли Amazon Cognito свои встроенные функции для отправки электронных писем пользователям или использует вашу конфигурацию электронной почты Amazon Simple Email Service. Укажите одно из следующих значений:

COGNITO_DEFAULT

Когда Amazon Cognito отправляет электронные письма пользователям, он использует свои встроенные возможности отправки электронной почты. При использовании параметра по умолчанию Amazon Cognito позволяет отправлять ограниченное количество электронных писем ежедневно для вашего пользовательского пула. Для типичных производственных сред лимит отправки электронных писем по умолчанию меньше требуемого объема доставки. Для достижения большего объема доставки укажите DEVELOPER для использования вашей конфигурации электронной почты Amazon SES.

Чтобы узнать лимит доставки электронных писем для параметра по умолчанию, см. раздел «Пределы» в руководстве разработчика Amazon Cognito.

Адрес ОТПРАВЛЯЮЩИЙ по умолчанию - no-reply@verificationemail.com . Для настройки адреса ОТПРАВЛЯЮЩИЙ, укажите Amazon Resource Name (ARN) проверенного адреса электронной почты Amazon SES для параметра SourceArn.

DEVELOPER

Когда Amazon Cognito отправляет электронные письма пользователям, он использует вашу конфигурацию Amazon SES. Amazon Cognito вызывает Amazon SES от вашего имени для отправки электронных писем с вашего проверенного адреса электронной почты. При использовании этого параметра лимиты доставки электронных писем соответствуют лимитам, применённым к вашему проверенному адресу электронной почты Amazon SES в вашей учётной записи Amazon Web Services.

При использовании этого параметра укажите ARN проверенного адреса электронной почты Amazon SES для параметра SourceArn.

Для отправки электронных писем от имени Amazon Cognito, ему необходимы дополнительные разрешения для вызова Amazon SES от вашего имени. При обновлении пользовательского пула с этим параметром Amazon Cognito создаёт роли, связанные с сервисом, являющуюся типом роли в вашей учётной записи Amazon Web Services. Эта роль содержит разрешения, позволяющие вам получать доступ к Amazon SES и отправлять электронные письма с вашего адреса электронной почты. Дополнительную информацию о роли, связанной с сервисом, созданной Amazon Cognito, см. в руководстве разработчика Amazon Cognito, разделе «Использование ролей, связанных с сервисом для Amazon Cognito».

From -> (строка)

Адрес электронной почты отправителя или имя отправителя с адресом электронной почты. Например, testuser@example.com или Test User <testuser@example.com> . Этот адрес отображается перед телом письма.

ConfigurationSet -> (строка)

Набор правил конфигурации, которые могут быть применены к электронным письмам, отправленным с помощью Amazon Simple Email Service. Набор конфигурации применяется к электронному письму путём включения ссылки на набор конфигурации в заголовки письма. После применения ко всем электронным письмам применяются все правила в этом наборе конфигурации. Наборы конфигурации могут использоваться для применения следующих типов правил к электронным письмам:

Опубликование событий

Amazon Simple Email Service может отслеживать количество событий отправки, доставки, открытия, клика, возврата и жалобы для каждого отправленного электронного письма. Используйте публикацию событий для отправки информации об этих событиях в другие сервисы Amazon Web Services, такие как Amazon CloudWatch.

Управление пулом IP-адресов

При аренде выделенных IP-адресов с Amazon Simple Email Service, вы можете создавать группы IP-адресов, называемые выделенными пулами IP-адресов. Затем вы можете связать выделенные пулы IP-адресов с наборами конфигурации.

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

SourceArn=string,ReplyToEmailAddress=string,EmailSendingAccount=string,From=string,ConfigurationSet=string

Синтаксис JSON:

{
  "SourceArn": "string",
  "ReplyToEmailAddress": "string",
  "EmailSendingAccount": "COGNITO_DEFAULT"|"DEVELOPER",
  "From": "string",
  "ConfigurationSet": "string"
}

--sms-configuration (структура)

Настройка SMS с параметрами для вашего пользовательского пула Amazon Cognito для отправки SMS-сообщений с Amazon Simple Notification Service. Для отправки SMS-сообщений с Amazon SNS в нужном вам регионе Amazon Web Services, пользовательский пул Amazon Cognito использует роль Identity and Access Management (IAM) в вашей учётной записи Amazon Web Services. Дополнительную информацию см. в разделе «Настройки SMS-сообщений».

SnsCallerArn -> (строка)

Amazon Resource Name (ARN) вызывающего экземпляра Amazon SNS. Это ARN роли IAM в вашей учётной записи Amazon Web Services, которую Amazon Cognito будет использовать для отправки SMS-сообщений. SMS-сообщения подлежат лимиту расходов.

ExternalId -> (строка)

Внешний идентификатор обеспечивает дополнительную безопасность для вашей роли IAM. Вы можете использовать ExternalId с ролью IAM, которую вы используете с Amazon SNS для отправки SMS-сообщений для вашего пользовательского пула. Если вы предоставите ExternalId , ваш пользовательский пул Amazon Cognito включит его в запрос для принятия вашей роли IAM. Вы можете настроить политику доверия роли таким образом, чтобы потребовать от Amazon Cognito и любого принципала предоставление ExternalID . Если вы используете Amazon Cognito Management Console для создания роли для многофакторной аутентификации (MFA) по SMS, Amazon Cognito создаст роль с необходимыми разрешениями и политикой доверия, которая демонстрирует использование ExternalId .

Дополнительную информацию о ExternalId роли см. в статье «Как использовать внешний идентификатор при предоставлении доступа к вашим ресурсам Amazon Web Services третьей стороне».

SnsRegion -> (строка)

Регион Amazon Web Services для использования с интеграцией Amazon SNS. Вы можете выбрать тот же регион, что и ваш пользовательский пул, или поддерживаемый альтернативный регион Amazon SNS.

Ресурсы Amazon Cognito в регионе Amazon Web Services Азия-Тихий океан (Сеул) должны использовать вашу конфигурацию Amazon SNS в регионе Азия-Тихий океан (Токио). Дополнительную информацию см. в разделе «Настройки SMS-сообщений для пользовательских пулов Amazon Cognito».

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

SnsCallerArn=string,ExternalId=string,SnsRegion=string

Синтаксис JSON:

{
  "SnsCallerArn": "string",
  "ExternalId": "string",
  "SnsRegion": "string"
}

--user-pool-tags (карта)

Ключи и значения тегов, которые необходимо назначить пользовательскому пулу. Тег — это метка, которую вы можете использовать для категоризации и управления пользовательскими пулами различными способами, например, по назначению, владельцу, среде или другим критериям.

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--admin-create-user-config (структура)

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

AllowAdminCreateUserOnly -> (булево)

Настройка, позволяющая пользователям самостоятельно регистрироваться. Когда true , только администраторы могут создавать новые профили пользователей. Когда false , пользователи могут регистрироваться самостоятельно и создавать новый профиль пользователя с помощью операции SignUp.

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

Этот параметр больше не используется.

Срок действия пароля в днях для пользователей, созданных администратором. По истечении этого времени пользователь не сможет войти в систему с помощью своего временного пароля. Для сброса учетной записи после этого лимита времени необходимо снова вызвать AdminCreateUser, указав RESEND для параметра MessageAction.

Значение по умолчанию для этого параметра — 7.

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

Шаблон приветственного сообщения для новых пользователей. Этот шаблон должен содержать заполнитель временного пароля {####}, если вы создаёте пользователей с паролями. Если у ваших пользователей нет паролей, вы можете опустить этот заполнитель.

См. также раздел «Настройка сообщений о приглашении для пользователей».

SMSMessage -> (строка)

Шаблон сообщения для SMS-сообщений.

EmailMessage -> (строка)

Шаблон сообщения для электронных писем. EmailMessage разрешен только если EmailSendingAccount равен DEVELOPER.

EmailSubject -> (строка)

Заголовок сообщения для электронных писем. EmailSubject разрешен только если EmailSendingAccount равен DEVELOPER.

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

AllowAdminCreateUserOnly=boolean,UnusedAccountValidityDays=integer,InviteMessageTemplate={SMSMessage=string,EmailMessage=string,EmailSubject=string}

Синтаксис JSON:

{
  "AllowAdminCreateUserOnly": true|false,
  "UnusedAccountValidityDays": integer,
  "InviteMessageTemplate": {
    "SMSMessage": "string",
    "EmailMessage": "string",
    "EmailSubject": "string"
  }
}

--user-pool-add-ons (структура)

Содержит настройки для активации защиты от угроз, включая режим работы и дополнительные типы аутентификации. Для регистрации информации о безопасности пользователей, но без каких-либо действий, установите значение AUDIT. Для настройки автоматических ответов на потенциально нежелательный трафик в ваш пользовательский пул, установите значение ENFORCED.

Дополнительную информацию см. в разделе «Добавление расширенной безопасности в пользовательский пул». Для активации этой настройки ваш пользовательский пул должен быть на уровне Plus.

AdvancedSecurityMode -> (строка)

Режим работы защиты от угроз для стандартных типов аутентификации в вашем пользовательском пуле, включая аутентификацию по имени пользователя и паролю и аутентификацию с защищённым удалённым паролем (SRP).

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

Настройки защиты от угроз для дополнительных типов аутентификации в вашем пользовательском пуле, включая пользовательскую аутентификацию.

CustomAuthMode -> (строка)

Режим работы защиты от угроз в пользовательской аутентификации с триггерами Lambda пользовательских аутентификационных вызовов.

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

AdvancedSecurityMode=string,AdvancedSecurityAdditionalFlows={CustomAuthMode=string}

Синтаксис JSON:

{
  "AdvancedSecurityMode": "OFF"|"AUDIT"|"ENFORCED",
  "AdvancedSecurityAdditionalFlows": {
    "CustomAuthMode": "AUDIT"|"ENFORCED"
  }
}

--account-recovery-setting (структура)

Доступный проверенный метод, который пользователь может использовать для восстановления пароля при вызове ForgotPassword. Вы можете использовать эту настройку для определения предпочтительного метода, когда у пользователя доступно более одного метода. С этой настройкой SMS не подходит для механизма восстановления пароля, если у пользователя также активирована двухфакторная аутентификация (MFA) по SMS. При отсутствии этой настройки Amazon Cognito использует устаревёное поведение, определяя метод восстановления, где SMS предпочтительнее по электронной почте.

RecoveryMechanisms -> (список)

Список параметров и приоритетов доставки сообщений пользователю в операциях сброса пароля. Устанавливает или отображает пользовательские настройки приоритета сообщений по электронной почте или SMS, то есть, пользователи должны ли переходить на второй способ доставки, и должны ли пароли сбрасываться только администраторами.

(структура)

Вариант восстановления для пользователя. Данные типа AccountRecoverySettingType — это массив этого объекта. Каждый объект RecoveryOptionType имеет свойство priority, которое определяет, является ли это первичным или вторичным вариантом.

Например, если у verified_email приоритет 1, а у verified_phone_number приоритет 2, ваш пул пользователей отправляет сообщения о восстановлении учетной записи на подтверждённый адрес электронной почты, но переходит к сообщению SMS, если у пользователя подтверждён номер телефона. Вариант admin_only предотвращает самообслуживание восстановления учетной записи.

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

Ваши настройки приоритета использования указанного атрибута при восстановлении учетной записи. Наивысший приоритет — 1.

Name -> (строка)

Метод восстановления, для которого этот объект устанавливает вариант восстановления.

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

RecoveryMechanisms=[{Priority=integer,Name=string},{Priority=integer,Name=string}]

Синтаксис JSON:

{
  "RecoveryMechanisms": [
    {
      "Priority": integer,
      "Name": "verified_email"|"verified_phone_number"|"admin_only"
    }
    ...
  ]
}

--pool-name (строка)

Новое имя вашего пользовательского пула.

--user-pool-tier (строка)

План или уровень пользовательского пула. Этот параметр определяет возможность пользовательского пула использовать функции, такие как управляемый вход, настройка токенов доступа и защита от угроз. По умолчанию ESSENTIALS.

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

LITE
ESSENTIALS
PLUS

--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 (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Обновление пользовательского пула

Следующий update-user-pool пример изменяет пользовательский пул с примерным синтаксисом для каждого доступного параметра конфигурации. Для обновления пользовательского пула необходимо указать все ранее настроенные параметры, в противном случае они будут сброшены по умолчанию.

aws cognito-idp update-user-pool --user-pool-id us-west-2_EXAMPLE \
    --policies PasswordPolicy=\{MinimumLength=6,RequireUppercase=true,RequireLowercase=true,RequireNumbers=true,RequireSymbols=true,TemporaryPasswordValidityDays=7\} \
    --deletion-protection ACTIVE \
    --lambda-config PreSignUp="arn:aws:lambda:us-west-2:123456789012:function:cognito-test-presignup-function",PreTokenGeneration="arn:aws:lambda:us-west-2:123456789012:function:cognito-test-pretoken-function" \
    --auto-verified-attributes "phone_number" "email" \
    --verification-message-template \{\"SmsMessage\":\""Your code is {####}"\",\"EmailMessage\":\""Your code is {####}"\",\"EmailSubject\":\""Your verification code"\",\"EmailMessageByLink\":\""Click {##here##} to verify your email address."\",\"EmailSubjectByLink\":\""Your verification link"\",\"DefaultEmailOption\":\"CONFIRM_WITH_LINK\"\} \
    --sms-authentication-message "Your code is {####}" \
    --user-attribute-update-settings AttributesRequireVerificationBeforeUpdate="email","phone_number" \
    --mfa-configuration "OPTIONAL" \
    --device-configuration ChallengeRequiredOnNewDevice=true,DeviceOnlyRememberedOnUserPrompt=true \
    --email-configuration SourceArn="arn:aws:ses:us-west-2:123456789012:identity/admin@example.com",ReplyToEmailAddress="amdin+noreply@example.com",EmailSendingAccount=DEVELOPER,From="admin@amazon.com",ConfigurationSet="test-configuration-set" \
    --sms-configuration SnsCallerArn="arn:aws:iam::123456789012:role/service-role/SNS-SMS-Role",ExternalId="12345",SnsRegion="us-west-2" \
    --admin-create-user-config AllowAdminCreateUserOnly=false,InviteMessageTemplate=\{SMSMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailSubject=\""Welcome to MyMobileGame"\"\} \
    --user-pool-tags "Function"="MyMobileGame","Developers"="Berlin" \
    --admin-create-user-config AllowAdminCreateUserOnly=false,InviteMessageTemplate=\{SMSMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailSubject=\""Welcome to MyMobileGame"\"\} \
    --user-pool-add-ons AdvancedSecurityMode="AUDIT" \
    --account-recovery-setting RecoveryMechanisms=\[\{Priority=1,Name="verified_email"\},\{Priority=2,Name="verified_phone_number"\}\]

Эта команда не производит вывод.

Дополнительную информацию см. в разделе Обновление конфигурации пользовательского пула в Руководстве разработчика Amazon Cognito.

Вывод

Нет