Spec-Zone.ru › AWS CLI v2

[ aws . appfabric ]

обновить-авторизацию-приложения

Описание

Обновляет авторизацию приложения в пакете приложения, что позволяет AppFabric подключаться к приложению.

Если авторизация приложения была в состоянии connected, обновление авторизации приложения вернёт её в состояние PendingConnect.

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

Синтаксис

  update-app-authorization
--app-bundle-identifier <value>
--app-authorization-identifier <value>
[--credential <value>]
[--tenant <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]

Параметры

--app-bundle-identifier (строка)

Amazon Resource Name (ARN) или Universal Unique Identifier (UUID) пакета приложения, который следует использовать для запроса.

--app-authorization-identifier (строка)

Amazon Resource Name (ARN) или Universal Unique Identifier (UUID) авторизации приложения, который следует использовать для запроса.

--credential (структура помеченного объединения)

Содержит учетные данные для приложения, такие как ключ API или идентификатор и секрет клиента OAuth2.

Укажите учетные данные, соответствующие типу авторизации авторизации приложения. Например, если тип авторизации авторизации приложения — OAuth2 (oauth2), то вы должны предоставить только учетные данные OAuth2.

Примечание

Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня: oauth2Credential, apiKeyCredential.

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

Содержит информацию об учетных данных клиента OAuth2.

clientId -> (строка)

Идентификатор клиента клиентского приложения.

clientSecret -> (строка)

Секрет клиента клиентского приложения.

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

Содержит информацию об учетных данных ключа API.

apiKey -> (строка)

Ключ API для приложения.

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

oauth2Credential={clientId=string,clientSecret=string},apiKeyCredential={apiKey=string}

Синтаксис JSON:

{
  "oauth2Credential": {
    "clientId": "string",
    "clientSecret": "string"
  },
  "apiKeyCredential": {
    "apiKey": "string"
  }
}

--tenant (структура)

Содержит информацию об арендаторе приложения, такую как отображаемое имя и идентификатор приложения.

tenantIdentifier -> (строка)

Идентификатор арендатора приложения.

tenantDisplayName -> (строка)

Отображаемое имя арендатора.

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

tenantIdentifier=string,tenantDisplayName=string

Синтаксис JSON:

{
  "tenantIdentifier": "string",
  "tenantDisplayName": "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-auto-prompt (логическое значение)

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

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

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

Вывод

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

Содержит информацию об авторизации приложения.

appAuthorizationArn -> (строка)

Amazon Resource Name (ARN) авторизации приложения.

appBundleArn -> (строка)

Amazon Resource Name (ARN) пакета приложения для авторизации приложения.

app -> (строка)

Имя приложения.

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

Содержит информацию об арендаторе приложения, такую как отображаемое имя и идентификатор приложения.

tenantIdentifier -> (строка)

Идентификатор арендатора приложения.

tenantDisplayName -> (строка)

Отображаемое имя арендатора.

authType -> (строка)

Тип авторизации.

status -> (строка)

Состояние авторизации приложения.

Возможные состояния:

  • PendingConnect : Начальное состояние авторизации приложения. Авторизация приложения создана, но еще не подключена.
  • Connected : Авторизация приложения подключена к приложению и готова к использованию.
  • ConnectionValidationFailed : Авторизация приложения получила исключение проверки при попытке подключения к приложению. Если авторизация приложения находится в этом состоянии, проверьте настроенные учетные данные и попробуйте подключить авторизацию приложения снова.
  • TokenAutoRotationFailed : AppFabric не удалось обновить токен доступа. Если авторизация приложения находится в этом состоянии, попробуйте снова подключить авторизацию приложения.

createdAt -> (метка времени)

Метка времени создания авторизации приложения.

updatedAt -> (метка времени)

Метка времени последнего обновления авторизации приложения.

persona -> (строка)

Роль пользователя авторизации приложения.

Это поле должно всегда быть admin .

authUrl -> (строка)

URL приложения для потока OAuth.

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

Spec-Zone.ru

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