Spec-Zone.ru › AWS CLI v2

[ aws . cognito-identity ]

создание пула идентификаторов

Описание

Создает новый пул идентификаторов. Пул идентификаторов — это хранилище информации об идентификаторах пользователей, специфичное для вашей учетной записи Amazon Web Services. Ключи для SupportedLoginProviders следующие:

  • Facebook: graph.facebook.com
  • Google: accounts.google.com
  • Вход с Apple: appleid.apple.com
  • Amazon: www.amazon.com
  • Twitter: api.twitter.com
  • Digits: www.digits.com

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

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

Для вызова этой операции необходимо использовать учетные данные разработчика Amazon Web Services.

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

Синтаксис

  create-identity-pool
--identity-pool-name <value>
--allow-unauthenticated-identities | --no-allow-unauthenticated-identities
[--allow-classic-flow | --no-allow-classic-flow]
[--supported-login-providers <value>]
[--developer-provider-name <value>]
[--open-id-connect-provider-arns <value>]
[--cognito-identity-providers <value>]
[--saml-provider-arns <value>]
[--identity-pool-tags <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]

Параметры

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

Строка, которую вы предоставляете.

--allow-unauthenticated-identities | --no-allow-unauthenticated-identities (логическое значение)

ИСТИНА, если пул идентификаторов поддерживает аутентификацию без указания пользователя.

--allow-classic-flow | --no-allow-classic-flow (логическое значение)

Включает или отключает поток аутентификации Basic (Classic). Дополнительную информацию см. в разделе «Поток аутентификации пулов идентификаторов (федерированные идентификаторы)» в руководстве для разработчиков Amazon Cognito.

--supported-login-providers (массив)

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

ключ -> (строка)

значение -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--developer-provider-name (строка)

«Домен», с помощью которого Cognito будет ссылаться на ваших пользователей. Это имя используется в качестве заглушки для обеспечения взаимодействия вашего бэкенда и сервиса Cognito с разработчиком поставщика. Для DeveloperProviderName можно использовать буквы, а также точку (. ), подчеркивание (_ ) и дефис (- ).

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

--open-id-connect-provider-arns (список)

Имена ресурсов Amazon (ARN) поставщиков OpenID Connect.

(строка)

Синтаксис:

"string" "string" ...

--cognito-identity-providers (список)

Массив пулов пользователей Amazon Cognito и их идентификаторов клиентов.

(структура)

Поставщик, представляющий пул пользователей Amazon Cognito и его идентификатор клиента.

ИмяПоставщика -> (строка)

Имя поставщика для пула пользователей Amazon Cognito. Например, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789 .

ИдентификаторКлиента -> (строка)

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

ПроверкаТокенаНаСервере -> (логическое значение)

ИСТИНА, если проверка токена на стороне сервера включена для токена поставщика идентификаторов.

После установки значения ServerSideTokenCheck в ИСТИНА для пула идентификаторов, этот пул будет проверять с интегрированными пулами пользователей, чтобы убедиться, что пользователь не был глобально разлогинен или удален, прежде чем пул идентификаторов предоставит OIDC токен или учетные данные Amazon Web Services для пользователя.

Если пользователь разлогинен или удален, пул идентификаторов вернет ошибку 400 Не авторизован.

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

ProviderName=string,ClientId=string,ServerSideTokenCheck=boolean ...

Синтаксис JSON:

[
  {
    "ProviderName": "string",
    "ClientId": "string",
    "ServerSideTokenCheck": true|false
  }
  ...
]

--saml-provider-arns (список)

Массив имен ресурсов Amazon (ARN) поставщика SAML для вашего пула идентификаторов.

(строка)

Синтаксис:

"string" "string" ...

--identity-pool-tags (массив)

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

ключ -> (строка)

значение -> (строка)

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

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
  • текст
  • таблица
  • yaml
  • yaml-поток

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

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

Для создания пула идентификаторов с поставщиком пула идентификаторов Cognito

В этом примере создается пул идентификаторов с именем MyIdentityPool. Он имеет поставщика пула идентификаторов Cognito. Аутентификация без указания пользователя не допускается.

Команда:

aws cognito-identity create-identity-pool --identity-pool-name MyIdentityPool --no-allow-unauthenticated-identities --cognito-identity-providers ProviderName="cognito-idp.us-west-2.amazonaws.com/us-west-2_aaaaaaaaa",ClientId="3n4b5urk1ft4fl3mg5e62d9ado",ServerSideTokenCheck=false

Вывод:

{
  "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
  "IdentityPoolName": "MyIdentityPool",
  "AllowUnauthenticatedIdentities": false,
  "CognitoIdentityProviders": [
      {
          "ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111",
          "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado",
          "ServerSideTokenCheck": false
      }
  ]
}

Вывод

IdentityPoolId -> (строка)

Идентификатор пула идентификаторов в формате REGION:GUID.

IdentityPoolName -> (строка)

Строка, которую вы предоставляете.

AllowUnauthenticatedIdentities -> (булево)

ИСТИНА, если пул идентификаторов поддерживает аутентификацию без предоставления данных об авторизации.

AllowClassicFlow -> (булево)

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

SupportedLoginProviders -> (отображение)

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

ключ -> (строка)

значение -> (строка)

DeveloperProviderName -> (строка)

«Домен», по которому Cognito будет ссылаться на ваших пользователей.

OpenIdConnectProviderARNs -> (список)

ARN поставщиков OpenID Connect.

(строка)

CognitoIdentityProviders -> (список)

Список, представляющий пул пользователей Amazon Cognito и его идентификатор клиента.

(структура)

Поставщик, представляющий пул пользователей Amazon Cognito и его идентификатор клиента.

ProviderName -> (строка)

Имя поставщика для пула пользователей Amazon Cognito. Например, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

ClientId -> (строка)

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

ServerSideTokenCheck -> (булево)

ИСТИНА, если включена проверка токена на стороне сервера для токена поставщика идентификаторов.

После того, как вы установите ServerSideTokenCheck в значение ИСТИНА для пула идентификаторов, этот пул идентификаторов будет проверять в интегрированных пулах пользователей, чтобы убедиться, что пользователь не был глобально отключен или удален перед тем, как пул идентификаторов предоставит токен OIDC или учетные данные Amazon Web Services для пользователя.

Если пользователь отключен или удален, пул идентификаторов вернет ошибку 400 Неавторизован.

SamlProviderARNs -> (список)

Массив имен Amazon Resource Names (ARN) поставщика SAML для вашего пула идентификаторов.

(строка)

IdentityPoolTags -> (отображение)

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

ключ -> (строка)

значение -> (строка)

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

Spec-Zone.ru

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