Spec-Zone.ru › AWS CLI v2

[ aws . cognito-identity ]

обновить-пул-тождества

Описание

Обновляет конфигурацию пула тождеств.

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

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

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

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

Синтаксис

  update-identity-pool
--identity-pool-id <value>
--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-id (строка)

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

--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 будет ссылаться на ваших пользователей.

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

ARN-адреса поставщиков OpenID Connect.

(строка)

Синтаксис:

"string" "string" ...

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

Список, представляющий пул пользователей 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 Неавторизован.

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

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

Синтаксис JSON:

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

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

Массив Amazon Resource Names (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.

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

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

Команда:

aws cognito-identity update-identity-pool --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" --identity-pool-name "MyIdentityPool" --no-allow-unauthenticated-identities --cognito-identity-providers ProviderName="cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111",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 (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 Resource Names (ARN) поставщика SAML для вашего пула тождеств.

(строка)

IdentityPoolTags -> (массив)

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

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

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

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

Spec-Zone.ru

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