Spec-Zone.ru › AWS CLI v2

[ aws . cognito-identity ]

получение ролей пула идентификаторов

Описание

Получает роли для пула идентификаторов.

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

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

Синтаксис

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

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

--no-verify-ssl (логическое)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (логическое)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

  • json
  • text
  • таблица
  • 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.

Для получения ролей пула идентификаторов

Этот пример получает роли пула идентификаторов.

Команда:

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

Вывод:

{
  "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111",
  "Roles": {
      "authenticated": "arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolAuth_Role",
      "unauthenticated": "arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolUnauth_Role"
  }
}

Вывод

IdentityPoolId -> (строка)

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

Roles -> (массив)

Массив ролей, связанных с этим пулом. В настоящее время поддерживаются только роли для авторизованных и неавторизованных пользователей.

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

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

RoleMappings -> (массив)

Как пользователи определенного поставщика удостоверений будут сопоставлены с ролями. Это карта из строк в объекты RoleMapping. Строка идентифицирует поставщика удостоверений, например, graph.facebook.com или cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id.

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

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

Сопоставление ролей.

Тип -> (строка)

Тип сопоставления ролей. Token будет использовать cognito:roles и cognito:preferred_role утверждения из токена поставщика удостоверений Cognito для сопоставления групп с ролями. Rules будет пытаться сопоставить утверждения из токена для сопоставления с ролью.

AmbiguousRoleResolution -> (строка)

Если вы укажете Token или Rules как тип сопоставления ролей, AmbiguousRoleResolution обязателен.

Указывает действие, которое будет выполнено, если ни одно из правил не соответствует значению утверждения для типа Rules или если утверждение cognito:preferred_role отсутствует и имеется несколько совпадений cognito:roles для типа Token.

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

Правила для сопоставления пользователей с ролями.

Если вы укажете Rules как тип сопоставления ролей, RulesConfiguration обязателен.

Rules -> (список)

Массив правил. Вы можете указать до 25 правил на поставщика удостоверений.

Правила обрабатываются в порядке. Первое соответствующее правило определяет роль.

(структура)

Правило, которое сопоставляет имя утверждения, значение утверждения и тип соответствия с ARN роли.

Утверждение -> (строка)

Имя утверждения, которое должно быть в токенах, например, "isAdmin" или "paid".

MatchType -> (строка)

Условие соответствия, которое определяет, насколько точно значение утверждения в токенах поставщика удостоверений должно соответствовать Value.

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

Короткая строка, которой должно соответствовать утверждение, например, "paid" или "да".

RoleARN -> (строка)

ARN роли.

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

Spec-Zone.ru

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