list-apis
Описание
Отображает список API в вашей учетной записи AppSync.
ListApis возвращает только общие сведения об API. Для получения более подробной информации об API используйте GetApi .См. также: Документация по API AWS
list-apis — это постраничная операция. Для получения всех результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: apis
Синтаксис
list-apis
[--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]
Параметры
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, указанному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, значения этих аргументов переопределят значения, указанные в JSON. Невозможно передать произвольные двоичные значения, используя предоставленное значение JSON, так как строка будет взята буквально. Этот параметр не может быть указан вместе с --cli-input-yaml.
--starting-token (строка)
Токен, определяющий, с какой точки начать постраничный вывод. Это NextToken из ранее обрезанного ответа.
Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.
--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 для вывода.
--cli-auto-prompt (логическое значение)
Автоматическое запрошение параметров ввода командной строки.
--no-cli-auto-prompt (логическое значение)
Отключение автоматического запроса параметров ввода командной строки.
Вывод
apis -> (список)
Объекты Api.
(структура)
Описывает API AppSync. Вы можете использовать Api для API AppSync с вашим предпочтительным конфигурацией, например, API событий, который обеспечивает публикацию и подписку на сообщения в реальном времени через WebSockets.
apiId -> (строка)
Api.name -> (строка)
Api.ownerContact -> (строка)
Api.tags -> (карта)
Карта с ключами TagKey и значениями TagValue.
key -> (строка)
value -> (строка)
dns -> (карта)
Записи DNS для API. Это будет включать HTTP и конечную точку для реального времени.
key -> (строка)
value -> (строка)
apiArn -> (строка)
Api.created -> (временная метка)
Api.xrayEnabled -> (булево)
Api.wafWebAclArn -> (строка)
Api, если он существует.eventConfig -> (структура)
Конфигурация API событий. Это включает в себя настройки авторизации по умолчанию для подключения, публикации и подписки на API событий.
authProviders -> (список)
Список поставщиков авторизации.
(структура)
Описывает поставщика авторизации.
authType -> (строка)
cognitoConfig -> (структура)
Описывает конфигурацию пула пользователей Amazon Cognito.
userPoolId -> (строка)
awsRegion -> (строка)
appIdClientRegex -> (строка)
openIDConnectConfig -> (структура)
Описывает конфигурацию OpenID Connect (OIDC).
issuer -> (строка)
iss в токен ID.clientId -> (строка)
iatTTL -> (целое число)
authTTL -> (целое число)
lambdaAuthorizerConfig -> (структура)
LambdaAuthorizerConfig определяет, как авторизовать доступ к API AppSync при использовании режима авторизации AWS_LAMBDA. Обратите внимание, что API AppSync может иметь только один настроенный Lambda авторизатор за раз.
authorizerResultTtlInSeconds -> (целое число)
authorizerResultTtlInSeconds, используется значение по умолчанию. Максимальное значение — один час (3600 секунд). Функция Lambda может переопределить это, вернув ключ ttlOverride в ответ.authorizerUri -> (строка)
Имя ресурса Amazon (ARN) функции Lambda, которая должна быть вызвана для авторизации. Это может быть стандартный ARN Lambda, ARN версии (.../v3) или ARN псевдонима.
Примечание : этой функции Lambda необходимо назначить следующую политику на основе ресурсов. При настройке Lambda авторизаторов в консоли это делается за вас. Чтобы использовать интерфейс командной строки (CLI), выполните следующие действия:
aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction
identityValidationExpression -> (строка)
connectionAuthModes -> (список)
Список допустимых режимов авторизации для подключений к API событий.
(структура)
Описывает конфигурацию авторизации. Используйте AuthMode для указания конфигурации авторизации публикации и подписки для API событий.
authType -> (строка)
defaultPublishAuthModes -> (список)
Список допустимых режимов авторизации для публикации в API событий.
(структура)
Описывает конфигурацию авторизации. Используйте AuthMode для указания конфигурации авторизации публикации и подписки для API событий.
authType -> (строка)
defaultSubscribeAuthModes -> (список)
Список допустимых режимов авторизации для подписок на API событий.
(структура)
Описывает конфигурацию авторизации. Используйте AuthMode для указания конфигурации авторизации публикации и подписки для API событий.
authType -> (строка)
logConfig -> (структура)
Конфигурация CloudWatch Logs для API событий.
logLevel -> (строка)
cloudWatchLogsRoleArn -> (строка)
nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.