Spec-Zone.ru › AWS CLI v2

[ aws . cognito-sync ]

get-identity-pool-configuration

Описание

Получает параметры конфигурации пула тождеств.

Этот API может вызываться только с учетными данными разработчика. Вы не можете вызвать этот API с временными учетными данными пользователя, предоставленными Cognito Identity.

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

Синтаксис

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

Пространственно-именной GUID (например, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE), созданный Amazon Cognito. Это идентификатор пула, для которого нужно вернуть конфигурацию.

--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-адрес.

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

Вывод

IdentityPoolId -> (строка)

Пространственно-именной GUID (например, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE), созданный Amazon Cognito.

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

Параметры, применяемые к этому пулу тождеств для синхронизации push.

ApplicationArns -> (список)

Список SNS-идентификаторов приложений платформы, которые могут использоваться клиентами.

(строка)

RoleArn -> (строка)

Роль, настроенная для разрешения Cognito вызывать SNS от имени разработчика.

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

Параметры, применяемые к этому пулу тождеств для Amazon Cognito streams.

StreamName -> (строка)

Имя Cognito stream для получения обновлений. Этот stream должен быть в учетной записи разработчика и в том же регионе, что и пул тождеств.

RoleArn -> (строка)

ARN роли, которую Amazon Cognito может принять для публикации в stream. Эта роль должна предоставлять доступ Amazon Cognito (cognito-sync) для вызова PutRecord в вашем Cognito stream.

StreamingStatus -> (строка)

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

ENABLED - Включено потоковое обновление пула тождеств.

DISABLED - Потоковое обновление пула тождеств отключено. Массовая публикация также завершится неудачно, если StreamingStatus имеет значение DISABLED.

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

Spec-Zone.ru

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