Spec-Zone.ru › AWS CLI v2

[ aws . cognito-sync ]

настройка-пула-точек-доступа

Описание

Устанавливает необходимую конфигурацию для синхронизации push.

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

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

Синтаксис

  set-identity-pool-configuration
--identity-pool-id <value>
[--push-sync <value>]
[--cognito-streams <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. Это идентификатор пула для изменения.

--push-sync (структура)

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

ApplicationArns -> (список)

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

(строка)

RoleArn -> (строка)

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

Краткая запись:

ApplicationArns=string,string,RoleArn=string

Синтаксис JSON:

{
  "ApplicationArns": ["string", ...],
  "RoleArn": "string"
}

--cognito-streams (структура) Параметры для применения к этому пулу точек доступа для потоков Amazon Cognito.StreamName -> (строка)

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

RoleArn -> (строка)

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

StreamingStatus -> (строка)

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

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

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

Краткая запись:

StreamName=string,RoleArn=string,StreamingStatus=string

Синтаксис JSON:

{
  "StreamName": "string",
  "RoleArn": "string",
  "StreamingStatus": "ENABLED"|"DISABLED"
}

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

Вывод

IdentityPoolId -> (строка)

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

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

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

ApplicationArns -> (список)

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

(строка)

RoleArn -> (строка)

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

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

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

StreamName -> (строка)

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

RoleArn -> (строка)

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

StreamingStatus -> (строка)

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

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

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

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

Spec-Zone.ru

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