Spec-Zone.ru › AWS CLI v2

[ aws . appsync ]

get-graphql-api

Описание

Извлекает объект GraphqlApi.

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

Синтаксис

  get-graphql-api
--api-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]

Параметры

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

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

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

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

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

Объект GraphqlApi.

name -> (строка)

Имя API.

apiId -> (строка)

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

authenticationType -> (строка)

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

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

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

fieldLogLevel -> (строка)

Уровень ведения журнала полей. Значения могут быть NONE, ERROR или ALL.

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

cloudWatchLogsRoleArn -> (строка)

Роль службы, которую AppSync принимает для публикации в журналы CloudWatch в вашем аккаунте.

excludeVerboseContent -> (логическое значение)

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

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

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

userPoolId -> (строка)

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

awsRegion -> (строка)

Регион Amazon Web Services, в котором был создан пользовательский пул.

defaultAction -> (строка)

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

appIdClientRegex -> (строка)

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

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

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

issuer -> (строка)

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

clientId -> (строка)

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

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

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

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

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

arn -> (строка)

Amazon Resource Name (ARN).

uris -> (массив)

URI.

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 в токенах идентификации.

clientId -> (строка)

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

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

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

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

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

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

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

userPoolId -> (строка)

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

awsRegion -> (строка)

Регион Amazon Web Services, в котором был создан пользовательский пул.

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 вложенными уровнями. Это поле вызовет ошибку ограничения, если операция выходит за пределы границ.

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

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

Максимальное количество решателей, которые могут быть вызваны в одном запросе. По умолчанию значение 0 (или не указано), что установит предел в 10000. При указании, значение предела может быть между 1 и 10000. Это поле вызовет ошибку ограничения, если операция выходит за пределы границ.

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

Объект enhancedMetricsConfig.

resolverLevelMetricsBehavior -> (строка)

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

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

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

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

dataSourceLevelMetricsBehavior -> (строка)

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

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

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

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

operationLevelMetricsConfig -> (строка)

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

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

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

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

Spec-Zone.ru

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