[ aws . cognito-idp ]
обновить-сервер-ресурсов
Описание
Обновляет имя и области действия сервера ресурсов. Все остальные поля являются только для чтения. Дополнительную информацию о серверах ресурсов см. в разделе Управление доступом с помощью серверов ресурсов.
Предупреждение
Если вы не укажете значение для атрибута, оно будет установлено по умолчанию.Примечание
Amazon Cognito оценивает политики управления идентификацией и доступом (IAM) в запросах для этой операции API. Для этой операции вы должны использовать учетные данные IAM для авторизации запросов и предоставить себе соответствующее разрешение IAM в политике.
- Подписание запросов к API Amazon Web Services
- Использование API пулов пользователей Amazon Cognito и конечных точек пулов пользователей
См. также: Документация по API AWS
Синтаксис
update-resource-server
--user-pool-id <value>
--identifier <value>
--name <value>
[--scopes <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 . Более длинные строки идентификаторов областей действия увеличивают размер ваших токенов доступа.
--name (строка)
--scopes (список)
Массив обновленных имен и описаний пользовательских областей действия, которые вы хотите связать со своим сервером ресурсов.
(структура)
Одна пользовательская область действия, связанная с сервером ресурсов пула пользователей. Этот тип данных является членом ResourceServerScopeType . Дополнительную информацию см. в разделе Области действия, M2M и авторизация API с помощью серверов ресурсов.
ScopeName -> (строка)
resourceServerIdentifier/ScopeName . Например, если этот параметр равен exampleScope на сервере ресурсов с идентификатором exampleResourceServer , вы запрашиваете и получаете область действия exampleResourceServer/exampleScope .ScopeDescription -> (строка)
Сокращенный синтаксис:
ScopeName=string,ScopeDescription=string ...
Синтаксис JSON:
[
{
"ScopeName": "string",
"ScopeDescription": "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.
Обновление сервера ресурсов
В этом примере обновляется сервер ресурсов «Погода». Добавляется новая область действия.
Команда:
aws cognito-idp update-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com --name Weather --scopes ScopeName=NewScope,ScopeDescription="New scope description"
Вывод:
{
"ResourceServer": {
"UserPoolId": "us-west-2_aaaaaaaaa",
"Identifier": "weather.example.com",
"Name": "Happy",
"Scopes": [
{
"ScopeName": "NewScope",
"ScopeDescription": "New scope description"
}
]
}
}
Вывод
ResourceServer -> (структура)
Обновленные данные запрошенного сервера ресурсов.
UserPoolId -> (строка)
Identifier -> (строка)
Уникальный идентификатор сервера ресурсов для сервера ресурсов. Идентификатор может быть удобным для API именем, например, solar-system-data . Вы также можете установить API-URL, например, https://solar-system-data-api.example.com , в качестве идентификатора.
Amazon Cognito представляет области действия в токенах доступа в формате $resource-server-identifier/$scope . Более длинные строки идентификаторов областей действия увеличивают размер ваших токенов доступа.
Name -> (строка)
Scopes -> (список)
Список областей действия, определенных для сервера ресурсов.
(структура)
Одна пользовательская область действия, связанная с сервером ресурсов пула пользователей. Этот тип данных является членом ResourceServerScopeType . Дополнительную информацию см. в разделе Области действия, M2M и авторизация API с помощью серверов ресурсов.
ScopeName -> (строка)
resourceServerIdentifier/ScopeName . Например, если этот параметр равен exampleScope на сервере ресурсов с идентификатором exampleResourceServer , вы запрашиваете и получаете область действия exampleResourceServer/exampleScope .ScopeDescription -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.