Spec-Zone.ru › AWS CLI v2

[ aws . cognito-idp ]

resend-confirmation-code

Описание

Отправляет повторно код подтверждения для нового учетной записи пользователя, который зарегистрировался в вашем пуле пользователей. Amazon Cognito отправляет коды подтверждения пользователю в атрибуте AutoVerifiedAttributes вашего пула пользователей. Когда вы запрашиваете у новых пользователей код подтверждения, включите опцию «Отправить код повторно», которая генерирует вызов этой операции API.

Примечание

Amazon Cognito не проверяет политики управления идентификацией и доступом (IAM) в запросах для этой операции API. Для этой операции вы не можете использовать учетные данные IAM для авторизации запросов и не можете предоставлять разрешения IAM в политиках. Дополнительную информацию об моделях авторизации в 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. В *режиме песочницы* вы можете отправлять сообщения только на проверенные номера телефонов. После тестирования вашего приложения в среде песочницы вы можете выйти из песочницы и перейти в режим работы.

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

Синтаксис

  resend-confirmation-code
--client-id <value>
[--secret-hash <value>]
[--user-context-data <value>]
--username <value>
[--analytics-metadata <value>]
[--client-metadata <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

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

ID клиента приложения пула пользователей, где пользователь зарегистрировался.

--secret-hash (строка)

Код аутентификации сообщения с ключом-хэшем (HMAC), вычисленный с использованием секретного ключа клиента пула пользователей и имени пользователя плюс идентификатор клиента в сообщении. Дополнительную информацию о SecretHash см. в разделе Вычисление значений секретных хэшей.

--user-context-data (структура)

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

Дополнительную информацию см. в разделе Сбор данных для защиты от угроз в приложениях.

IpAddress -> (строка)

Исходный IP-адрес устройства вашего пользователя.

EncodedData -> (строка)

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

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

IpAddress=string,EncodedData=string

Синтаксис JSON:

{
  "IpAddress": "string",
  "EncodedData": "string"
}

--username (строка)

Имя пользователя, который вы хотите запросить или изменить. Значение этого параметра обычно является именем пользователя, но это может быть любой из его атрибутов псевдонима. Если username не является атрибутом псевдонима в вашем пуле пользователей, это значение должно быть sub локального пользователя или именем пользователя из стороннего IdP.

--analytics-metadata (структура)

Информация, которая поддерживает результаты аналитики с Amazon Pinpoint, включая идентификатор конечной точки пользователя. Идентификатор конечной точки является местом назначения push-уведомлений Amazon Pinpoint, например, идентификатор устройства, адрес электронной почты или номер телефона.

AnalyticsEndpointId -> (строка)

Идентификатор конечной точки. Информация, которую вы хотите передать Amazon Pinpoint о том, куда отправлять уведомления.

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

AnalyticsEndpointId=string

Синтаксис JSON:

{
  "AnalyticsEndpointId": "string"
}

--client-metadata (карта)

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

Вы создаете пользовательские рабочие процессы, назначив функции Lambda триггерам пула пользователей. При использовании действия API ResendConfirmationCode Amazon Cognito вызывает функцию, назначенную триггеру *пользовательского сообщения*. Когда Amazon Cognito вызывает эту функцию, она передает JSON-полезную нагрузку, которая принимается функцией как входные данные. Эта полезная нагрузка содержит атрибут clientMetadata, который предоставляет данные, которые вы назначили параметру ClientMetadata в вашем запросе ResendConfirmationCode. В коде вашей функции в Lambda вы можете обработать значение clientMetadata, чтобы улучшить свой рабочий процесс для ваших конкретных потребностей.

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

Примечание

При использовании параметра ClientMetadata обратите внимание, что Amazon Cognito не будет выполнять следующие действия:

  • Хранить значение ClientMetadata. Эти данные доступны только для триггеров Lambda, которые назначены пулу пользователей для поддержки пользовательских рабочих процессов. Если ваша конфигурация пула пользователей не включает триггеры, параметр ClientMetadata не имеет смысла.
  • Проверять значение ClientMetadata.
  • Шифровать значение ClientMetadata. Не отправляйте конфиденциальную информацию в этом параметре.

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения перепишут значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено без значения или значение input, выводит пример JSON-входных данных, которые можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, это выведет пример входных данных YAML, которые можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверит входные данные команд и вернет пример JSON-выходных данных для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

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

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Показать версию этого инструмента.

--color (строка)

Включить/выключить вывод цвета.

  • включить
  • выключить
  • автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию - 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию - 60 секунд.

--cli-binary-format (строка)

Стиль форматирования для двоичных блоков. Формат по умолчанию - base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается в двоичном блоке, fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла непосредственно независимо от параметра cli-binary-format. При использовании file:// содержимое файла необходимо отформатировать для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

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

Отключить вывода страниц CLI.

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

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

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

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

Примеры

Примечание

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

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

Для повторной отправки кода подтверждения

Следующий пример resend-confirmation-code отправляет код подтверждения пользователю jane.

aws cognito-idp resend-confirmation-code \
    --client-id 12a3b456c7de890f11g123hijk \
    --username jane

Вывод:

{
    "CodeDeliveryDetails": {
        "Destination": "j***@e***.com",
        "DeliveryMedium": "EMAIL",
        "AttributeName": "email"
    }
}

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

Вывод

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

Информация о телефонном номере или адресе электронной почты, на которые Amazon Cognito отправил код подтверждения.

Destination -> (строка)

Адрес электронной почты или телефонный номер назначения, на который Amazon Cognito отправил код.

DeliveryMedium -> (строка)

Метод, который Amazon Cognito использовал для отправки кода.

AttributeName -> (строка)

Имя атрибута, который Amazon Cognito проверяет с помощью кода.

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

Spec-Zone.ru

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