Spec-Zone.ru › AWS CLI v2

[ aws . cognito-identity ]

получение-креденциалов-для-идентичности

Описание

Возвращает данные доступа для предоставленного идентификатора идентичности. Любые предоставленные данные входа будут проверены на соответствие поддерживаемым поставщикам входа. Если токен относится к cognito-identity.amazonaws.com, он будет передан в службу Security Token Service с соответствующей ролью для токена.

Это общедоступный API. Вам не требуются какие-либо данные доступа для вызова этого API.

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

Синтаксис

  get-credentials-for-identity
--identity-id <value>
[--logins <value>]
[--custom-role-arn <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-id (строка)

Уникальный идентификатор в формате REGION:GUID.

--logins (массив)

Набор необязательных пар имя-значение, которые сопоставляют имена поставщиков с токенами поставщиков. Пара имя-значение будет следовать синтаксису “имя_поставщика”: “идентификатор_пользователя_поставщика”.

Данные входа не должны указываться при попытке получить данные доступа для неавторизованной идентичности.

Параметр Logins необходим при использовании идентичностей, связанных с внешними поставщиками идентичности, такими как Facebook. Примеры Logins массивов см. в примерах кода в разделе «Внешние поставщики идентичности» в руководстве разработчика Amazon Cognito.

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

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

Сокращенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--custom-role-arn (строка)

Идентификатор ресурса Amazon (ARN) роли, которая должна быть принята, если в токене от поставщика идентичности получено несколько ролей. Например, для поставщика идентичности на основе SAML. Этот параметр необязателен для поставщиков идентичности, которые не поддерживают настройку ролей.

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

Вывод

IdentityId -> (строка)

Уникальный идентификатор в формате REGION:GUID.

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

Данные доступа для предоставленного идентификатора идентичности.

AccessKeyId -> (строка)

Часть Access Key данных доступа.

SecretKey -> (строка)

Часть Secret Access Key данных доступа

SessionToken -> (строка)

Часть Session Token данных доступа

Expiration -> (временная метка)

Дата истечения срока действия данных доступа.

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

Spec-Zone.ru

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