describe-user-pool

Описание

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

Примечание

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

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

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

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

Синтаксис

  describe-user-pool
--user-pool-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]

Параметры

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

Примеры

Примечание

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

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

Для описания пользовательского пула

В следующем примере описывается пользовательский пул с идентификатором пользовательского пула us-west-2_EXAMPLE.

aws cognito-idp describe-user-pool \
    --user-pool-id us-west-2_EXAMPLE

Вывод:

{
    "UserPool": {
        "Id": "us-west-2_EXAMPLE",
        "Name": "MyUserPool",
        "Policies": {
            "PasswordPolicy": {
                "MinimumLength": 8,
                "RequireUppercase": true,
                "RequireLowercase": true,
                "RequireNumbers": true,
                "RequireSymbols": true,
                "TemporaryPasswordValidityDays": 1
            }
        },
        "DeletionProtection": "ACTIVE",
        "LambdaConfig": {
            "PreSignUp": "arn:aws:lambda:us-west-2:123456789012:function:MyPreSignUpFunction",
            "CustomMessage": "arn:aws:lambda:us-west-2:123456789012:function:MyCustomMessageFunction",
            "PostConfirmation": "arn:aws:lambda:us-west-2:123456789012:function:MyPostConfirmationFunction",
            "PreAuthentication": "arn:aws:lambda:us-west-2:123456789012:function:MyPreAuthenticationFunction",
            "PostAuthentication": "arn:aws:lambda:us-west-2:123456789012:function:MyPostAuthenticationFunction",
            "DefineAuthChallenge": "arn:aws:lambda:us-west-2:123456789012:function:MyDefineAuthChallengeFunction",
            "CreateAuthChallenge": "arn:aws:lambda:us-west-2:123456789012:function:MyCreateAuthChallengeFunction",
            "VerifyAuthChallengeResponse": "arn:aws:lambda:us-west-2:123456789012:function:MyVerifyAuthChallengeFunction",
            "PreTokenGeneration": "arn:aws:lambda:us-west-2:123456789012:function:MyPreTokenGenerationFunction",
            "UserMigration": "arn:aws:lambda:us-west-2:123456789012:function:MyMigrateUserFunction",
            "PreTokenGenerationConfig": {
                "LambdaVersion": "V2_0",
                "LambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:MyPreTokenGenerationFunction"
            },
            "CustomSMSSender": {
                "LambdaVersion": "V1_0",
                "LambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:MyCustomSMSSenderFunction"
            },
            "CustomEmailSender": {
                "LambdaVersion": "V1_0",
                "LambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:MyCustomEmailSenderFunction"
            },
            "KMSKeyID": "arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
        },
        "LastModifiedDate": 1726784814.598,
        "CreationDate": 1602103465.273,
        "SchemaAttributes": [
            {
                "Name": "sub",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": false,
                "Required": true,
                "StringAttributeConstraints": {
                    "MinLength": "1",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "name",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "0",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "given_name",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "0",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "family_name",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "0",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "middle_name",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "0",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "nickname",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "0",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "preferred_username",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "0",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "profile",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "0",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "picture",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "0",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "website",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "0",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "email",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": true,
                "StringAttributeConstraints": {
                    "MinLength": "0",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "email_verified",
                "AttributeDataType": "Boolean",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false
            },
            {
                "Name": "gender",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "0",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "birthdate",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "10",
                    "MaxLength": "10"
                }
            },
            {
                "Name": "zoneinfo",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "0",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "locale",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "0",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "phone_number",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "0",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "phone_number_verified",
                "AttributeDataType": "Boolean",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false
            },
            {
                "Name": "address",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "0",
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "updated_at",
                "AttributeDataType": "Number",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "NumberAttributeConstraints": {
                    "MinValue": "0"
                }
            },
            {
                "Name": "identities",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {}
            },
            {
                "Name": "custom:111",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "1",
                    "MaxLength": "256"
                }
            },
            {
                "Name": "dev:custom:222",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": true,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MinLength": "1",
                    "MaxLength": "421"
                }
            },
            {
                "Name": "custom:accesstoken",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MaxLength": "2048"
                }
            },
            {
                "Name": "custom:idtoken",
                "AttributeDataType": "String",
                "DeveloperOnlyAttribute": false,
                "Mutable": true,
                "Required": false,
                "StringAttributeConstraints": {
                    "MaxLength": "2048"
                }
            }
        ],
        "AutoVerifiedAttributes": [
            "email"
        ],
        "SmsVerificationMessage": "Your verification code is {####}. ",
        "EmailVerificationMessage": "Your verification code is {####}. ",
        "EmailVerificationSubject": "Your verification code",
        "VerificationMessageTemplate": {
            "SmsMessage": "Your verification code is {####}. ",
            "EmailMessage": "Your verification code is {####}. ",
            "EmailSubject": "Your verification code",
            "EmailMessageByLink": "Please click the link below to verify your email address. <b>{##Verify Your Email##}</b>\n this is from us-west-2_ywDJHlIfU",
            "EmailSubjectByLink": "Your verification link",
            "DefaultEmailOption": "CONFIRM_WITH_LINK"
        },
        "SmsAuthenticationMessage": "Your verification code is {####}. ",
        "UserAttributeUpdateSettings": {
            "AttributesRequireVerificationBeforeUpdate": []
        },
        "MfaConfiguration": "OPTIONAL",
        "DeviceConfiguration": {
            "ChallengeRequiredOnNewDevice": true,
            "DeviceOnlyRememberedOnUserPrompt": false
        },
        "EstimatedNumberOfUsers": 166,
        "EmailConfiguration": {
            "SourceArn": "arn:aws:ses:us-west-2:123456789012:identity/admin@example.com",
            "EmailSendingAccount": "DEVELOPER"
        },
        "SmsConfiguration": {
            "SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/userpool-SMS-Role",
            "ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "SnsRegion": "us-west-2"
        },
        "UserPoolTags": {},
        "Domain": "myCustomDomain",
        "CustomDomain": "auth.example.com",
        "AdminCreateUserConfig": {
            "AllowAdminCreateUserOnly": false,
            "UnusedAccountValidityDays": 1,
            "InviteMessageTemplate": {
                "SMSMessage": "Your username is {username} and temporary password is {####}. ",
                "EmailMessage": "Your username is {username} and temporary password is {####}. ",
                "EmailSubject": "Your temporary password"
            }
        },
        "UserPoolAddOns": {
            "AdvancedSecurityMode": "ENFORCED",
            "AdvancedSecurityAdditionalFlows": {}
        },
        "Arn": "arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLE",
        "AccountRecoverySetting": {
            "RecoveryMechanisms": [
                {
                    "Priority": 1,
                    "Name": "verified_email"
                }
            ]
        }
    }
}

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

Вывод

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

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

Id -> (строка)

Идентификатор пула пользователей.

Name -> (строка)

Имя пула пользователей.

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

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

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

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

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

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

RequireUppercase -> (булево)

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

RequireLowercase -> (булево)

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

RequireNumbers -> (булево)

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

RequireSymbols -> (булево)

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

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

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

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

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

Примечание

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

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

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

AllowedFirstAuthFactors -> (список)

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

(строка)

DeletionProtection -> (строка)

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

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

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

Коллекция триггеров 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 пользовательского отправителя.

Status -> (строка)

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

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

Дата и время изменения элемента. Amazon Cognito возвращает эту временную метку в формате временной метки UNIX. Ваш SDK может отобразить вывод в удобочитаемом формате, например, ISO 8601 или объекте Java Date.

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

Дата и время создания элемента. Amazon Cognito возвращает эту временную метку в формате временной метки UNIX. Ваш SDK может отобразить вывод в удобочитаемом формате, например, ISO 8601 или объекте Java Date.

SchemaAttributes -> (список)

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

Атрибуты только для разработчиков — устаревшая функция пользовательских пулов и являются только для чтения для всех клиентов приложений. Вы можете создавать и обновлять атрибуты только для разработчиков только с помощью операций API с проверкой подлинности IAM. Используйте разрешения на чтение/запись для клиента приложения вместо этого.

(структура)

Атрибуты только для разработчиков dev: — устаревшая функция пользовательских пулов и являются только для чтения для всех клиентов приложений. Вы можете создавать и обновлять атрибуты только для разработчиков только с помощью операций API с проверкой подлинности IAM. Используйте разрешения на чтение/запись для клиента приложения вместо этого.

Имя -> (строка)

Имя атрибута вашего пользовательского пула. При создании или обновлении пользовательского пула добавление атрибута схемы создаёт настраиваемый или атрибут только для разработчиков. При добавлении атрибута со значением Name равным MyAttribute, Amazon Cognito создаёт настраиваемый атрибут custom:MyAttribute. Когда DeveloperOnlyAttribute является true, Amazon Cognito создаёт атрибут как dev:MyAttribute. В операции описания пользовательского пула Amazon Cognito возвращает это значение как value для стандартных атрибутов, custom:value для настраиваемых атрибутов и dev:value для атрибутов только для разработчиков.

ТипДанныхАтрибута -> (строка)

Формат данных значений вашего атрибута. При выборе AttributeDataType Amazon Cognito проверяет ввод на соответствие типу данных. Значение настраиваемого атрибута в токенах ID пользователя всегда является строкой, например "custom:isMember" : "true" или "custom:YearsAsMember" : "12".

АтрибутТолькоДляРазработчиков -> (логическое)

Примечание

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

Указывает, является ли тип атрибута только для разработчиков. Этот атрибут может быть изменён только администратором. Пользователи не смогут изменить этот атрибут с помощью своего маркера доступа. Например, DeveloperOnlyAttribute может быть изменён с помощью AdminUpdateUserAttributes, но не может быть обновлён с помощью UpdateUserAttributes.

Изменяемый -> (логическое)

Указывает, можно ли изменить значение атрибута.

Любой атрибут пользовательского пула, значение которого вы отображаете из атрибута IdP, должен быть изменяемым, со значением параметра true. Amazon Cognito обновляет сопоставленные атрибуты, когда пользователи входят в ваше приложение через IdP. Если атрибут неизменяем, Amazon Cognito возвращает ошибку при попытке обновить атрибут. Дополнительную информацию см. в разделе Указание сопоставлений атрибутов поставщика идентификации для вашего пользовательского пула.

Обязательный -> (логическое)

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

ОграниченияЧисловогоАтрибута -> (структура)

Устанавливает ограничения для атрибута числового типа.

МинимальноеЗначение -> (строка)

Минимальное значение атрибута числового типа.

МаксимальноеЗначение -> (строка)

Максимальная длина значения числового атрибута. Должно быть числом, меньше или равным 2^1023, представленное строкой длиной не более 131072 символов.

ОграниченияСтроковогоАтрибута -> (структура)

Устанавливает ограничения для атрибута строкового типа.

МинимальнаяДлина -> (строка)

Минимальная длина значения строкового атрибута.

МаксимальнаяДлина -> (строка)

Максимальная длина значения строкового атрибута. Должно быть числом, меньше или равным 2^1023, представленное строкой длиной не более 131072 символов.

АвтоПроверенныеАтрибуты -> (список)

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

(строка)

АтрибутыПсевдонима -> (список)

Поддерживаемые атрибуты в качестве псевдонима для данного пользовательского пула. Псевдоним — это атрибут, который пользователи могут ввести в качестве альтернативного имени пользователя. Возможные значения: phone_number, email или preferred_username.

(строка)

АтрибутыИмениПользователя -> (список)

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

(строка)

СообщениеSMSДляПроверки -> (строка)

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

СообщениеПоEmailДляПроверки -> (строка)

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

ТемаПоEmailДляПроверки -> (строка)

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

ШаблонСообщенияДляПроверки -> (структура)

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

СообщениеSMS -> (строка)

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

СообщениеПоEmail -> (строка)

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

ТемаПоEmail -> (строка)

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

СообщениеПоEmailСсылка -> (строка)

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

ТемаПоEmailСсылка -> (строка)

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

ПочтовыйОпцияПоУмолчанию -> (строка)

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

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

СообщениеДляАвторизацииSMS -> (строка)

Содержимое сообщения об авторизации SMS.

НастройкиОбновленияАтрибутовПользователя -> (структура)

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

АтрибутыТребуютПроверкиПередОбновлением -> (список)

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

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

(строка)

НастройкаMFA -> (строка)

Может принимать одно из следующих значений:

OFF - Токены MFA не требуются и не могут быть указаны во время регистрации пользователя.
ON - Токены MFA требуются для всех регистраций пользователей. Вы можете указать только требование при первоначальном создании пользовательского пула.
OPTIONAL - Пользователи имеют возможность при регистрации создать токен MFA.

НастройкаУстройства -> (структура)

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

Примечание

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

ТребуетсяПроверкаНаНовомУстройстве -> (логическое)

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

Примечание

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

ЗапоминатьТолькоПриЗапросеПользователя -> (логическое)

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

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

ПриблизительноеКоличествоПользователей -> (целое)

Число, приблизительно оценивающее размер пользовательского пула.

НастройкаПоEmail -> (структура)

Настройка электронной почты для вашего пула пользователей. Тип настройки электронной почты задает предпочитаемый метод отправки, регион 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 email configuration regions.

ReplyToEmailAddress -> (строка)

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

EmailSendingAccount -> (строка)

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

COGNITO_DEFAULT

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

Чтобы узнать о лимите доставки писем для параметра по умолчанию, см. раздел Limits в руководстве разработчика 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 создает роль связанную с сервисом (service-linked role), это тип роли в вашей учетной записи Amazon Web Services. Эта роль содержит разрешения, которые позволяют вам получать доступ к Amazon SES и отправлять электронные письма с вашего адреса электронной почты. Дополнительную информацию о роли связанной с сервисом, которую создает Amazon Cognito, см. в руководстве разработчика Amazon Cognito в разделе Using Service-Linked Roles for 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-адресов с наборами конфигурации.

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

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

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 для создания роли для многофакторной аутентификации (MFA) по SMS, Amazon Cognito создает роль с необходимыми разрешениями и политикой доверия, демонстрирующей использование ExternalId.

Дополнительную информацию о ExternalId роли см. в документе How to use an external ID when granting access to your Amazon Web Services resources to a third party.

SnsRegion -> (строка)

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

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

UserPoolTags -> (карта)

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

key -> (строка)

value -> (строка)

SmsConfigurationFailure -> (строка)

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

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

InvalidSmsRoleAccessPolicyException

Роль Identity and Access Management, которую Amazon Cognito использует для отправки SMS-сообщений, не настроена должным образом. Дополнительную информацию см. в разделе SmsConfigurationType.

SNSSandbox

Учетная запись Amazon Web Services находится в песочнице SNS SMS, и сообщения будут достигать только проверенных конечных пользователей. Этот параметр не будет заполнен SNSSandbox, если пользователь, создающий пул пользователей, не имеет разрешений SNS. Чтобы узнать, как вывести свою учетную запись Amazon Web Services из песочницы, см. Moving out of the SMS sandbox.

EmailConfigurationFailure -> (строка)

Устарело. Проверьте коды ошибок из запросов API с помощью EventSource:cognito-idp.amazonaws.com в CloudTrail, чтобы получить информацию о проблемах с конфигурацией электронной почты пула пользователей.

Domain -> (строка)

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

CustomDomain -> (строка)

Пользовательский домен, который вы предоставляете Amazon Cognito. Этот параметр применяется только если вы используете пользовательский домен для размещения страниц регистрации и входа в вашу программу. Пример пользовательского домена может быть auth.example.com.

Дополнительную информацию о добавлении пользовательского домена в ваш пул пользователей см. в разделе Using Your Own Domain for the Hosted UI.

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

Конфигурация для AdminCreateUser запросов.

AllowAdminCreateUserOnly -> (булево)

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

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

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

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

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

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

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

См. также Customizing User Invitation Messages.

SMSMessage -> (строка)

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

EmailMessage -> (строка)

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

EmailSubject -> (строка)

Тема электронных писем. EmailSubject разрешен только если EmailSendingAccount равен DEVELOPER.

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

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

Дополнительную информацию см. в разделе Adding advanced security to a user pool. Чтобы активировать эту настройку, ваш пул пользователей должен быть на тарифе Plus.

AdvancedSecurityMode -> (строка)

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

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

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

CustomAuthMode -> (строка)

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

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

Чувствительность к регистру имени пользователя для выбранного варианта входа. Когда чувствительность к регистру установлена в False (регистронезависимая), пользователи могут войти в систему с любой комбинацией заглавных и строчных букв. Например, username , USERNAME , или UserName , или для электронной почты, email@example.com или EMaiL@eXamplE.Com . Для большинства случаев рекомендуется установить чувствительность к регистру в значение False (регистронезависимая). Когда имена пользователей и адреса электронной почты нечувствительны к регистру, Amazon Cognito рассматривает любые вариации регистра как одного и того же пользователя и предотвращает присвоение варианта регистра к одному и тому же атрибуту для разного пользователя.

CaseSensitive -> (boolean)

Определяет, будет ли применяться чувствительность к регистру имени пользователя для всех пользователей в пуле пользователей через API Amazon Cognito. Для большинства случаев рекомендуется установить чувствительность к регистру в значение False (регистронезависимая). Когда имена пользователей и адреса электронной почты нечувствительны к регистру, пользователи могут войти как один и тот же пользователь, когда они вводят разный регистр своего имени пользователя.

Допустимые значения:

true

Включает чувствительность к регистру для всех вводимых имён пользователей. Когда этот параметр установлен в значение true , пользователи должны войти в систему с использованием точного регистра своего имени пользователя, например, «UserName». Это значение по умолчанию.

false

Включает нечувствительность к регистру для всех вводимых имён пользователей. Например, когда этот параметр установлен в значение false , пользователи могут войти с помощью username , USERNAME или UserName . Этот параметр также делает как preferred_username , так и email псевдоним нечувствительными к регистру, в дополнение к атрибуту username.

Arn -> (string)

Идентификатор ресурса Amazon (ARN) пула пользователей.

AccountRecoverySetting -> (structure)

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

RecoveryMechanisms -> (list)

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

(structure)

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

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

Priority -> (integer)

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

Name -> (string)

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

UserPoolTier -> (string)

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