Регистрация

Описание

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

В ответ на этот запрос вы можете получить исключение LimitExceeded, если вы превысили квоту скорости для электронных писем или SMS-сообщений, а также если ваш пул пользователей автоматически проверяет электронные адреса или номера телефонов. Когда вы получаете это исключение в ответе, пользователь успешно создан и находится в состоянии UNCONFIRMED.

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

Синопсис

  sign-up
--client-id <value>
[--secret-hash <value>]
--username <value>
[--password <value>]
[--user-attributes <value>]
[--validation-data <value>]
[--analytics-metadata <value>]
[--user-context-data <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 (строка)

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

--username (строка)

--password (строка)

--user-attributes (список)

Краткая синтаксическая конструкция:

Name=string,Value=string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Value": "string"
  }
  ...
]

--validation-data (список)

Краткая синтаксическая конструкция:

Name=string,Value=string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Value": "string"
  }
  ...
]

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

Краткая синтаксическая конструкция:

AnalyticsEndpointId=string

Синтаксис JSON:

{
  "AnalyticsEndpointId": "string"
}

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

Краткая синтаксическая конструкция:

IpAddress=string,EncodedData=string

Синтаксис JSON:

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

--client-metadata (отображение)

Краткая синтаксическая конструкция:

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 (boolean)

Включить отладку логирования.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

• json
• text
• table
• yaml
• yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

Отображение версии этого инструмента.

--color (string)

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

• on
• off
• auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

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

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Для регистрации пользователя

В этом примере регистрируется пользователь jane@example.com.

Команда:

aws cognito-idp sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username jane@example.com --password PASSWORD --user-attributes Name="email",Value="jane@example.com" Name="name",Value="Jane"

Вывод:

{
  "UserConfirmed": false,
  "UserSub": "e04d60a6-45dc-441c-a40b-e25a787d4862"
}

Вывод

UserConfirmed -> (boolean)

CodeDeliveryDetails -> (structure)

UserSub -> (string)

Session -> (string)