Spec-Zone.ru › AWS CLI v2

[ aws . apigateway ]

get-authorizers

Описание

Описывает существующий ресурс Authorizers.

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

get-authorizers является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ с постраничной обработкой, аргумент --query должен извлечь данные из результатов следующих выражений запроса: items

Синтаксис

  get-authorizers
--rest-api-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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 (строка)

Строковый идентификатор связанного RestApi.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределяют значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, поскольку строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен, определяющий, с какой точки начать постраничную обработку. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS CLI.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для продолжения постраничной обработки предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

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

Для получения списка авторизаторов для REST API

Команда:

aws apigateway get-authorizers --rest-api-id 1234123412

Вывод:

{
    "items": [
        {
            "name": "MyAuthorizer",
            "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Authorizer_Function/invocations",
            "authorizerResultTtlInSeconds": 300,
            "identitySource": "method.request.header.Authorization",
            "type": "TOKEN",
            "id": "gfi4n3"
        }
    ]
}

Вывод

position -> (строка)

items -> (список)

Текущая страница элементов из этого набора.

(структура)

Представляет уровень авторизации для методов. Если включен для метода, API Gateway активирует авторизатор при вызове метода клиентом.

id -> (строка)

Идентификатор ресурса авторизатора.

name -> (строка)

Имя авторизатора.

type -> (строка)

Тип авторизатора. Допустимые значения — TOKEN для функции Lambda, использующей единственный токен авторизации, переданный в пользовательском заголовке, REQUEST для функции Lambda, использующей параметры запроса, и COGNITO_USER_POOLS для использования пула пользователей Amazon Cognito.

providerARNs -> (список)

Список Amazon Cognito ARN пулов пользователей для авторизатора COGNITO_USER_POOLS. Каждый элемент имеет такой формат: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. Для авторизаторов TOKEN или REQUEST это не определено.

(строка)

authType -> (строка)

Дополнительное поле, определенное пользователем, используется при импорте и экспорте OpenAPI без функционального влияния.

authorizerUri -> (строка)

Указывает URI (Uniform Resource Identifier) авторизатора. Для авторизаторов TOKEN или REQUEST это должен быть корректный 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 -> (строка)

Указывает необходимые учетные данные в виде роли IAM для вызова авторизатора API Gateway. Для указания роли IAM, которую API Gateway должен принять, используйте ARN роли. Для использования основанных на ресурсах разрешений для функции Lambda, укажите null.

identitySource -> (строка)

Источник идентификации, для которого запрашивается авторизация. Для авторизаторов TOKEN или COGNITO_USER_POOLS это обязательно и указывает выражение сопоставления заголовков запроса для пользовательского заголовка, содержащего токен авторизации, переданный клиентом. Например, если имя заголовка токена — Auth, выражение сопоставления заголовка — method.request.header.Auth. Для авторизатора REQUEST это обязательно при включенной кэшировании авторизации. Значение представляет собой строку с запятыми, разделенными одним или несколькими выражениями сопоставления указанных параметров запроса. Например, если определены заголовок Auth и параметр строки запроса Name в качестве источников идентификации, это значение будет method.request.header.Auth, method.request.querystring.Name. Эти параметры будут использованы для вывода ключа кэширования авторизации и для выполнения проверки параметров запроса, связанных с идентификацией, на этапе выполнения для авторизатора REQUEST, проверяя, что все параметры запроса, связанные с идентификацией, присутствуют, не равны null и не пусты. Только в этом случае авторизатор вызывает функцию Lambda авторизатора; в противном случае он возвращает ответ 401 Unauthorized без вызова функции Lambda. Допустимое значение — строка, содержащая запятыми, разделенные выражения сопоставления указанных параметров запроса. Когда кэширование авторизации отключено, это свойство необязательно.

identityValidationExpression -> (строка)

Выражение проверки для приходящего токена идентификации. Для авторизаторов TOKEN это регулярное выражение. Для авторизаторов COGNITO_USER_POOLS API Gateway будет сопоставлять поле aud входящего токена от клиента с указанным регулярным выражением. При совпадении он вызовет функцию Lambda авторизатора. В противном случае он вернёт ответ 401 Unauthorized без вызова функции Lambda. Выражение проверки не применяется к авторизатору REQUEST.

authorizerResultTtlInSeconds -> (целое число)

Срок хранения результатов кэширования авторизатора в секундах. Если он равен 0, кэширование авторизации отключено. Если он больше 0, API Gateway будет кэшировать ответы авторизатора. Если это поле не задано, значение по умолчанию составляет 300. Максимальное значение — 3600, или 1 час.

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

Spec-Zone.ru

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