[ aws . apigateway ]
get-authorizer
Описание
Описывает существующий ресурс Authorizer.
См. также: документацию AWS API
Синтаксис
get-authorizer
--rest-api-id <value>
--authorizer-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]
Параметры
--rest-api-id (строка)
--authorizer-id (строка)
--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
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для использования в фильтрации данных ответа.
--profile (строка)
Используйте определенный профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/окружения.
--version (строка)
Отображает версию этого инструмента.
--color (строка)
Включает/отключает цветной вывод.
- on
- off
- auto
--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.
Чтобы получить параметры Authorizer API Gateway для каждой API
Команда:
aws apigateway get-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3
Вывод:
{
"authorizerResultTtlInSeconds": 300,
"name": "MyAuthorizer",
"type": "TOKEN",
"identitySource": "method.request.header.Authorization",
"authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:authorizer_function/invocations",
"id": "gfi4n3"
}
Вывод
id -> (строка)
name -> (строка)
type -> (строка)
TOKEN для Lambda-функции, использующей единственный токен авторизации, отправленный в пользовательском заголовке, REQUEST для Lambda-функции, использующей параметры входного запроса, и COGNITO_USER_POOLS для использования Amazon Cognito user pool.providerARNs -> (список)
Список Amazon Cognito user pool ARN для COGNITO_USER_POOLS authorizer. Каждый элемент имеет следующий формат: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. Для TOKEN или REQUEST authorizer это не определено.
(строка)
authType -> (строка)
authorizerUri -> (строка)
TOKEN или REQUEST authorizers это должен быть хорошо сформированный URI Lambda-функции, например, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. В общем случае URI имеет такой вид arn:aws:apigateway:{region}:lambda:path/{service_api}, где {region} совпадает с областью, где размещена Lambda-функция, path указывает, что оставшаяся часть URI должна рассматриваться как путь к ресурсу, включая начальный /. Для Lambda-функций это обычно имеет вид /2015-03-31/functions/[FunctionARN]/invocations.authorizerCredentials -> (строка)
identitySource -> (строка)
TOKEN или COGNITO_USER_POOLS authorizer это обязательно и определяет выражение сопоставления заголовков запроса для пользовательского заголовка, содержащего токен авторизации, отправленный клиентом. Например, если имя заголовка токена — Auth, выражение сопоставления заголовка — method.request.header.Auth. Для REQUEST authorizer это обязательно при включенной кэшировании авторизации. Значение — это строка, разделенная запятыми, из одного или нескольких выражений сопоставления указанных параметров запроса. Например, если заголовок Auth, параметр строки запроса Name определены как источники идентификации, это значение будет method.request.header.Auth, method.request.querystring.Name. Эти параметры будут использоваться для вывода ключа кэширования авторизации и для выполнения проверки во время работы REQUEST authorizer путем проверки, что все параметры запроса, связанные с идентификацией, присутствуют, не равны null и не пусты. Только при этом authorizer вызывает Lambda-функцию authorizer, в противном случае он возвращает ответ 401 Unauthorized без вызова Lambda-функции. Допустимое значение — строка, разделенная запятыми, из выражений сопоставления указанных параметров запроса. Когда кэширование авторизации отключено, это свойство является необязательным.identityValidationExpression -> (строка)
TOKEN authorizers это регулярное выражение. Для COGNITO_USER_POOLS authorizers API Gateway будет сопоставлять поле aud входного токена от клиента со указанным регулярным выражением. При совпадении он вызывает Lambda-функцию authorizer. В противном случае он возвращает ответ 401 Unauthorized без вызова Lambda-функции. Выражение валидации не применяется к REQUEST authorizer.authorizerResultTtlInSeconds -> (целое число)
© Copyright 2025, Amazon Web Services. Created using Sphinx.