Spec-Zone.ru › AWS CLI v2

[ aws . cognito-identity ]

describe-identity-pool

Описание

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

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

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

Синтаксис

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

Параметры

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

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

--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 (строка)

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

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

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

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

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

Примеры

Примечание

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

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

Для описания пула тождеств

В этом примере описывается пул тождеств.

Команда:

aws cognito-identity describe-identity-pool --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111"

Вывод:

{
  "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 (Classic). Дополнительную информацию см. в разделе Поток аутентификации пулов тождеств (федерированных тождеств) в руководстве разработчика 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 (ARN) поставщика SAML для вашего пула тождеств.

(строка)

IdentityPoolTags -> (карта)

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

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

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

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

Spec-Zone.ru

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