Spec-Zone.ru › AWS CLI v2

[ aws . appsync ]

list-graphql-apis

Описание

Перечисляет ваши GraphQL-API.

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

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

Синтаксис

  list-graphql-apis
[--api-type <value>]
[--owner <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]

Параметры

--api-type (строка)

Значение, указывающее, является ли GraphQL-API стандартным API (GRAPHQL) или объединённым API (MERGED).

Возможные значения:

  • GRAPHQL
  • MERGED

--owner (строка)

Владелец учётной записи GraphQL-API.

Возможные значения:

  • CURRENT_ACCOUNT
  • OTHER_ACCOUNTS

--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
  • таблица
  • 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.

Вывод

graphqlApis -> (список)

Объекты GraphqlApi.

(структура)

Описание GraphQL API.

name -> (строка)

Имя API.

apiId -> (строка)

Идентификатор API.

authenticationType -> (строка)

Тип аутентификации.

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

Настройка Amazon CloudWatch Logs.

fieldLogLevel -> (строка)

Уровень ведения журнала для полей. Возможные значения: NONE, ERROR или ALL.

  • NONE : Ведение журнала на уровне полей не производится.
  • ERROR : Ведутся журналы только для полей, содержащих ошибки:
    • Раздел с ошибками в ответе сервера.
    • Ошибки на уровне поля.
    • Сгенерированные функции запроса/ответа, которые были обработаны для полей с ошибками.
  • ALL : Ведутся журналы для всех полей в запросе:
    • Информация отслеживания на уровне поля.
    • Сгенерированные функции запроса/ответа, которые были обработаны для каждого поля.

cloudWatchLogsRoleArn -> (строка)

Служебная роль Amazon AppSync, которая используется для публикации в CloudWatch Logs в вашем аккаунте.

excludeVerboseContent -> (булево)

Установите в TRUE, чтобы исключить разделы, содержащие информацию, такую как заголовки, контекст и оцененные шаблоны отображения, независимо от уровня ведения журнала.

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

Настройка Amazon Cognito user pool.

userPoolId -> (строка)

Идентификатор user pool.

awsRegion -> (строка)

Регион Amazon Web Services, в котором был создан user pool.

defaultAction -> (строка)

Действие, которое вы хотите выполнить для своего GraphQL API, когда запрос, использующий аутентификацию Amazon Cognito user pool, не соответствует настройке Amazon Cognito user pool.

appIdClientRegex -> (строка)

Регулярное выражение для проверки идентификатора приложения Amazon Cognito user pool. Если это значение не задано, фильтрация не применяется.

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

Настройки OpenID Connect.

issuer -> (строка)

Издатель для конфигурации OIDC. Издатель, возвращаемый при обнаружении, должен точно соответствовать значению iss в токенах ID.

clientId -> (строка)

Идентификатор клиента доверенной стороны в поставщике идентификации OpenID. Этот идентификатор обычно получается при регистрации доверенной стороны в поставщике идентификации OpenID. Вы можете указать регулярное выражение, чтобы AppSync мог проверять сразу несколько идентификаторов клиентов.

iatTTL -> (целое)

Количество миллисекунд, в течение которых токен действителен после его выдачи пользователю.

authTTL -> (целое)

Количество миллисекунд, в течение которых токен действителен после аутентификации.

arn -> (строка)

Amazon Resource Name (ARN).

uris -> (карта)

URIs.

key -> (строка)

value -> (строка)

tags -> (карта)

Теги.

key -> (строка)

Ключ тега.

value -> (строка)

Значение тега.

additionalAuthenticationProviders -> (список)

Список дополнительных поставщиков аутентификации для API GraphqlApi.

(структура)

Описание дополнительного поставщика аутентификации.

authenticationType -> (строка)

Тип аутентификации: ключ API, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools или Lambda.

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

Настройка OIDC.

issuer -> (строка)

Издатель для конфигурации OIDC. Издатель, возвращаемый при обнаружении, должен точно соответствовать значению iss в токенах ID.

clientId -> (строка)

Идентификатор клиента доверенной стороны в поставщике идентификации OpenID. Этот идентификатор обычно получается при регистрации доверенной стороны в поставщике идентификации OpenID. Вы можете указать регулярное выражение, чтобы AppSync мог проверять сразу несколько идентификаторов клиентов.

iatTTL -> (целое)

Количество миллисекунд, в течение которых токен действителен после его выдачи пользователю.

authTTL -> (целое)

Количество миллисекунд, в течение которых токен действителен после аутентификации.

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

Настройка Amazon Cognito user pool.

userPoolId -> (строка)

Идентификатор user pool.

awsRegion -> (строка)

Регион Amazon Web Services, в котором был создан user pool.

appIdClientRegex -> (строка)

Регулярное выражение для проверки идентификатора приложения Amazon Cognito user pool. Если это значение не задано, фильтрация не применяется.

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

Настройка авторизации функции Lambda.

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

Количество секунд, в течение которых должен кешироваться ответ. По умолчанию 0 секунд (кеширование отключено). Если вы не зададите значение для authorizerResultTtlInSeconds, будет использоваться значение по умолчанию. Максимальное значение — один час (3600 секунд). Функция Lambda может переопределить это, вернув ключ ttlOverride в своём ответе.

authorizerUri -> (строка)

Amazon Resource Name (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 -> (строка)

Регулярное выражение для проверки токенов перед вызовом функции Lambda.

xrayEnabled -> (булево)

Флаг, указывающий, следует ли использовать трассировку X-Ray для этого GraphqlApi.

wafWebAclArn -> (строка)

ARN списка управления доступом WAF (ACL), связанного с этим GraphqlApi, если он существует.

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

Настройка авторизации функции Lambda.

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

Количество секунд, в течение которых должен кешироваться ответ. По умолчанию 0 секунд (кеширование отключено). Если вы не зададите значение для authorizerResultTtlInSeconds, будет использоваться значение по умолчанию. Максимальное значение — один час (3600 секунд). Функция Lambda может переопределить это, вернув ключ ttlOverride в своём ответе.

authorizerUri -> (строка)

Amazon Resource Name (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 -> (строка)

Регулярное выражение для проверки токенов перед вызовом функции Lambda.

dns -> (карта)

DNS-записи для API.

key -> (строка)

value -> (строка)

visibility -> (строка)

Устанавливает значение GraphQL API на общедоступное (GLOBAL) или частное (PRIVATE). Если значение не задано, видимость будет установлена по умолчанию на GLOBAL. Это значение нельзя изменить после создания API.

apiType -> (строка)

Значение, указывающее, является ли GraphQL API стандартным (GRAPHQL) или объединённым (MERGED).

mergedApiExecutionRoleArn -> (строка)

ARN роли Identity and Access Management для объединённого API. Сервис AppSync использует эту роль от имени объединённого API для проверки доступа к исходным API во время выполнения и для запроса к AUTO_MERGE обновить конечную точку объединённого API с изменениями исходного API автоматически.

owner -> (строка)

Владелец аккаунта GraphQL API.

ownerContact -> (строка)

Контактная информация владельца ресурса API.

Это поле принимает любой строковый ввод длиной от 0 до 256 символов.

introspectionConfig -> (строка)

Устанавливает значение GraphQL API для включения (ENABLED) или выключения (DISABLED) интроспекции. Если значение не задано, настройка интроспекции будет установлена по умолчанию на ENABLED. Это поле будет генерировать ошибку, если операция пытается использовать функцию интроспекции, когда это поле отключено.

Дополнительную информацию об интроспекции можно найти в разделе Интроспекция GraphQL.

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

Максимальная глубина запроса в одном запросе. Глубина относится к количеству вложенных уровней, разрешенных в теле запроса. Значение по умолчанию — 0 (или не указано), что означает отсутствие ограничения по глубине. Если вы устанавливаете ограничение, оно может быть от 1 до 75 вложенных уровней. В случае превышения предела это поле выведет ошибку.

Обратите внимание, что поля по-прежнему могут быть установлены как обязательные или необязательные. Если поле с обязательным значением выдает ошибку, ошибка будет выброшена вверх к первому доступному необязательному полю.

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

Максимальное количество вызовов резолверов в одном запросе. Значение по умолчанию — 0 (или не указано), что установит ограничение на 10000. При указании значение предела может быть от 1 до 10000. Если превышено ограничение, это поле выведет ошибку.

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

Объект enhancedMetricsConfig.

resolverLevelMetricsBehavior -> (строка)

Управляет тем, как метрики решателей будут передаваться в CloudWatch. Метрики решателей включают:

  • Ошибки GraphQL: Количество произошедших ошибок GraphQL.
  • Запросы: Количество вызовов, произошедших во время запроса.
  • Задержка: Время выполнения вызова решателя.
  • Попадания в кэш: Количество попаданий в кэш во время запроса.
  • Промахи кэша: Количество промахов кэша во время запроса.

Эти метрики могут передаваться в CloudWatch на каждый решатель или для всех решателей в запросе. Метрики будут записываться по идентификатору API и имени решателя. resolverLevelMetricsBehavior принимает одно из этих значений за раз:

  • FULL_REQUEST_RESOLVER_METRICS : Записывает и отправляет данные метрик для всех решателей в запросе.
  • PER_RESOLVER_METRICS : Записывает и отправляет данные метрик для решателей, у которых значение metricsConfig установлено в значение ENABLED.

dataSourceLevelMetricsBehavior -> (строка)

Управляет тем, как метрики источника данных будут передаваться в CloudWatch. Метрики источника данных включают:

  • Запросы: Количество вызовов, произошедших во время запроса.
  • Задержка: Время выполнения вызова источника данных.
  • Ошибки: Количество ошибок, произошедших во время вызова источника данных.

Эти метрики могут передаваться в CloudWatch на каждый источник данных или для всех источников данных в запросе. Метрики будут записываться по идентификатору API и имени источника данных. dataSourceLevelMetricsBehavior принимает одно из этих значений за раз:

  • FULL_REQUEST_DATA_SOURCE_METRICS : Записывает и отправляет данные метрик для всех источников данных в запросе.
  • PER_DATA_SOURCE_METRICS : Записывает и отправляет данные метрик для источников данных, у которых значение metricsConfig установлено в значение ENABLED.

operationLevelMetricsConfig -> (строка)

Управляет тем, как метрики операций будут передаваться в CloudWatch. Метрики операций включают:

  • Запросы: Количество вызовов указанной GraphQL операции.
  • Ошибки GraphQL: Количество ошибок GraphQL, произошедших во время указанной GraphQL операции.

Метрики будут записываться по идентификатору API и имени операции. Вы можете установить значение в ENABLED или DISABLED.

nextToken -> (строка)

Идентификатор для передачи в следующий запрос этой операции, чтобы получить следующий набор элементов в списке.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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