Spec-Zone.ru › AWS CLI v2

[ aws . cognito-idp ]

описание-сервера-ресурсов

Описание

Описывает сервер ресурсов. Дополнительную информацию о серверах ресурсов см. в разделе Управление доступом с помощью серверов ресурсов.

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

Синтаксис

  describe-resource-server
--user-pool-id <value>
--identifier <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]

Параметры

--user-pool-id (строка)

Идентификатор пула пользователей, который содержит сервер ресурсов.

--identifier (строка)

Уникальный идентификатор сервера ресурсов. Идентификатор может быть удобным для API именем, например, solar-system-data. Вы также можете установить API-URL, например, https://solar-system-data-api.example.com, в качестве идентификатора.

Amazon Cognito представляет области в токенах доступа в формате $resource-server-identifier/$scope. Более длинные строки идентификаторов областей увеличивают размер токенов доступа.

--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-auto-prompt (логическое значение)

Автоматически запросить параметры входных данных CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос параметров входных данных CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, все примеры имеют правила цитирования, аналогичные правилам unix-подобных систем. Эти примеры потребуется адаптировать к правилам цитирования вашей терминальной оболочки. См. раздел Использование кавычек со строками в руководстве пользователя AWS CLI.

Для описания сервера ресурсов

В этом примере описывается сервер ресурсов weather.example.com.

Команда:

aws cognito-idp describe-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com

Вывод:

{
  "ResourceServer": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "Identifier": "weather.example.com",
      "Name": "Weather",
      "Scopes": [
          {
              "ScopeName": "weather.update",
              "ScopeDescription": "Update weather forecast"
          },
          {
              "ScopeName": "weather.read",
              "ScopeDescription": "Read weather forecasts"
          },
          {
              "ScopeName": "weather.delete",
              "ScopeDescription": "Delete a weather forecast"
          }
      ]
  }
}

Вывод

СерверРесурсов -> (структура)

Подробные сведения о запрошенном сервере ресурсов.

IdПулаПользователей -> (строка)

Идентификатор пула пользователей, содержащий конфигурацию сервера ресурсов.

Идентификатор -> (строка)

Уникальный идентификатор сервера ресурсов. Идентификатор может быть удобным для API именем, например, solar-system-data. Вы также можете установить API-URL, например, https://solar-system-data-api.example.com, в качестве идентификатора.

Amazon Cognito представляет области в токенах доступа в формате $resource-server-identifier/$scope. Более длинные строки идентификаторов областей увеличивают размер токенов доступа.

Имя -> (строка)

Название сервера ресурсов.

Области -> (список)

Список областей, определенных для сервера ресурсов.

(структура)

Одна настраиваемая область, связанная с сервером ресурсов пула пользователей. Этот тип данных является членом ResourceServerScopeType. Дополнительную информацию см. в разделе Области, M2M и авторизация API с помощью серверов ресурсов.

ИмяОбласти -> (строка)

Название области. Amazon Cognito отображает настраиваемые области в формате resourceServerIdentifier/ScopeName. Например, если этот параметр равен exampleScope на сервере ресурсов с идентификатором exampleResourceServer, вы запрашиваете и получаете область exampleResourceServer/exampleScope.

ОписаниеОбласти -> (строка)

Описание настраиваемой области.

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

Spec-Zone.ru

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