обновить-graphql-api
Описание
Обновляет объект GraphqlApi.
См. также: Документация API AWS
Синтаксис
update-graphql-api
--api-id <value>
--name <value>
[--log-config <value>]
--authentication-type <value>
[--user-pool-config <value>]
[--open-id-connect-config <value>]
[--additional-authentication-providers <value>]
[--xray-enabled | --no-xray-enabled]
[--lambda-authorizer-config <value>]
[--merged-api-execution-role-arn <value>]
[--owner-contact <value>]
[--introspection-config <value>]
[--query-depth-limit <value>]
[--resolver-count-limit <value>]
[--enhanced-metrics-config <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 (строка)
--name (строка)
GraphqlApi.--log-config (структура)
Настройка Amazon CloudWatch Logs для объекта GraphqlApi.
fieldLogLevel -> (строка)
Уровень ведения журнала полей. Возможные значения: NONE, ERROR или ALL.
- NONE : Информация о полях не регистрируется.
-
ERROR : Регистрируется только информация о полях, содержащих ошибки:
- Раздел с ошибками в ответе сервера.
- Ошибки уровня поля.
- Сгенерированные функции запроса/ответа, которые были решены для полей с ошибками.
-
ALL : Регистрируется информация обо всех полях в запросе:
- Данные трассировки полей.
- Сгенерированные функции запроса/ответа, которые были решены для каждого поля.
cloudWatchLogsRoleArn -> (строка)
excludeVerboseContent -> (булево)
Сокращенный синтаксис:
fieldLogLevel=string,cloudWatchLogsRoleArn=string,excludeVerboseContent=boolean
Синтаксис JSON:
{
"fieldLogLevel": "NONE"|"ERROR"|"ALL"|"INFO"|"DEBUG",
"cloudWatchLogsRoleArn": "string",
"excludeVerboseContent": true|false
}
--authentication-type (строка)
Новый тип аутентификации для объекта GraphqlApi.
Возможные значения:
API_KEYAWS_IAMAMAZON_COGNITO_USER_POOLSOPENID_CONNECTAWS_LAMBDA
--user-pool-config (структура)
Новая настройка пула пользователей Amazon Cognito для объекта ~GraphqlApi.
userPoolId -> (строка)
awsRegion -> (строка)
defaultAction -> (строка)
appIdClientRegex -> (строка)
Сокращенный синтаксис:
userPoolId=string,awsRegion=string,defaultAction=string,appIdClientRegex=string
Синтаксис JSON:
{
"userPoolId": "string",
"awsRegion": "string",
"defaultAction": "ALLOW"|"DENY",
"appIdClientRegex": "string"
}
--open-id-connect-config (структура)
Настройка OpenID Connect для объекта GraphqlApi.
issuer -> (строка)
iss в марке ID токена.clientId -> (строка)
iatTTL -> (целое число)
authTTL -> (целое число)
Сокращенный синтаксис:
issuer=string,clientId=string,iatTTL=long,authTTL=long
Синтаксис JSON:
{
"issuer": "string",
"clientId": "string",
"iatTTL": long,
"authTTL": long
}
--additional-authentication-providers (список)
Список дополнительных провайдеров аутентификации для API GraphqlApi.
(структура)
Описание дополнительного провайдера аутентификации.
authenticationType -> (строка)
openIDConnectConfig -> (структура)
Настройка OIDC.
issuer -> (строка)
iss в марке ID токена.clientId -> (строка)
iatTTL -> (целое число)
authTTL -> (целое число)
userPoolConfig -> (структура)
Настройка пула пользователей Amazon Cognito.
userPoolId -> (строка)
awsRegion -> (строка)
appIdClientRegex -> (строка)
lambdaAuthorizerConfig -> (структура)
Настройка авторизации функции Lambda.
authorizerResultTtlInSeconds -> (целое число)
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 -> (строка)
Сокращенный синтаксис:
authenticationType=string,openIDConnectConfig={issuer=string,clientId=string,iatTTL=long,authTTL=long},userPoolConfig={userPoolId=string,awsRegion=string,appIdClientRegex=string},lambdaAuthorizerConfig={authorizerResultTtlInSeconds=integer,authorizerUri=string,identityValidationExpression=string} ...
Синтаксис JSON:
[
{
"authenticationType": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|"AWS_LAMBDA",
"openIDConnectConfig": {
"issuer": "string",
"clientId": "string",
"iatTTL": long,
"authTTL": long
},
"userPoolConfig": {
"userPoolId": "string",
"awsRegion": "string",
"appIdClientRegex": "string"
},
"lambdaAuthorizerConfig": {
"authorizerResultTtlInSeconds": integer,
"authorizerUri": "string",
"identityValidationExpression": "string"
}
}
...
]
--xray-enabled | --no-xray-enabled (булево)
GraphqlApi.--lambda-authorizer-config (структура)
Настройка авторизации функции Lambda.
authorizerResultTtlInSeconds -> (целое число)
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 -> (строка)
Сокращенный синтаксис:
authorizerResultTtlInSeconds=integer,authorizerUri=string,identityValidationExpression=string
Синтаксис JSON:
{
"authorizerResultTtlInSeconds": integer,
"authorizerUri": "string",
"identityValidationExpression": "string"
}
--merged-api-execution-role-arn (строка)
AUTO_MERGE с изменениями исходного API в объединённом API автоматически.--owner-contact (строка)
Контактная информация владельца ресурса API.
Это поле принимает любой строковый ввод длиной от 0 до 256 символов.
--introspection-config (строка)
Устанавливает значение GraphQL API для включения (ENABLED ) или отключения (DISABLED ) интроспекции. Если значение не указано, настройка интроспекции будет установлена по умолчанию в ENABLED. Это поле вызовет ошибку, если операция попытается использовать функцию интроспекции, в то время как это поле отключено.
Для получения дополнительной информации об интроспекции см. Интроспекцию GraphQL.
Возможные значения:
ENABLEDDISABLED
--query-depth-limit (целое число)
Максимальная глубина запроса в одном запросе. Глубина — это количество вложенных уровней, разрешённых в теле запроса. Значение по умолчанию — 0 (или не указано), что означает отсутствие ограничения по глубине. Если вы устанавливаете ограничение, оно может быть от 1 до 75 вложенных уровней. Это поле вызовет ошибку ограничения, если операция выходит за пределы границ.
Обратите внимание, что поля всё ещё могут быть установлены как необязательные или обязательные. Если обязательное поле создаёт ошибку, ошибка будет передана вверх до первого необязательного поля, доступного для обработки.
--resolver-count-limit (целое число)
0 (или не указано), что устанавливает предел в 10000. Если задано ограничение, оно может составлять от 1 до 10000. Это поле вызовет ошибку ограничения, если операция выходит за пределы границ.--enhanced-metrics-config (структура)
Объект 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.
Краткая запись:
resolverLevelMetricsBehavior=string,dataSourceLevelMetricsBehavior=string,operationLevelMetricsConfig=string
Синтаксис JSON:
{
"resolverLevelMetricsBehavior": "FULL_REQUEST_RESOLVER_METRICS"|"PER_RESOLVER_METRICS",
"dataSourceLevelMetricsBehavior": "FULL_REQUEST_DATA_SOURCE_METRICS"|"PER_DATA_SOURCE_METRICS",
"operationLevelMetricsConfig": "ENABLED"|"DISABLED"
}
--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
- текст
- таблица
- 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-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическую запрос параметров ввода CLI.
Вывод
graphqlApi -> (структура)
Обновленный GraphqlApi объект.
name -> (строка)
apiId -> (строка)
authenticationType -> (строка)
logConfig -> (структура)
Настройка Amazon CloudWatch Logs.
fieldLogLevel -> (строка)
Уровень ведения журнала для полей. Допустимые значения: NONE, ERROR или ALL.
- NONE : Логирование полей не включено.
-
ERROR : Записываются только следующие сведения для полей с ошибками:
- Раздел с ошибками в ответе сервера.
- Ошибки на уровне поля.
- Сгенерированные функции запроса/ответа, разрешенные для полей с ошибками.
-
ALL : Для всех полей запроса регистрируются следующие сведения:
- Данные отслеживания на уровне поля.
- Сгенерированные функции запроса/ответа, разрешенные для каждого поля.
cloudWatchLogsRoleArn -> (строка)
excludeVerboseContent -> (логическое)
userPoolConfig -> (структура)
Настройка Amazon Cognito user pool.
userPoolId -> (строка)
awsRegion -> (строка)
defaultAction -> (строка)
appIdClientRegex -> (строка)
openIDConnectConfig -> (структура)
Настройка OpenID Connect.
issuer -> (строка)
iss в токене идентификатора.clientId -> (строка)
iatTTL -> (целое)
authTTL -> (целое)
arn -> (строка)
uris -> (массив)
URI.
key -> (строка)
value -> (строка)
tags -> (массив)
Теги.
key -> (строка)
value -> (строка)
additionalAuthenticationProviders -> (список)
Список дополнительных поставщиков аутентификации для API GraphqlApi.
(структура)
Описание дополнительного поставщика аутентификации.
authenticationType -> (строка)
openIDConnectConfig -> (структура)
Настройка OIDC.
issuer -> (строка)
iss в токене идентификатора.clientId -> (строка)
iatTTL -> (целое)
authTTL -> (целое)
userPoolConfig -> (структура)
Настройка Amazon Cognito user pool.
userPoolId -> (строка)
awsRegion -> (строка)
appIdClientRegex -> (строка)
lambdaAuthorizerConfig -> (структура)
Настройка аутентификации Lambda-функции.
authorizerResultTtlInSeconds -> (целое)
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 -> (строка)
xrayEnabled -> (логическое)
GraphqlApi.wafWebAclArn -> (строка)
GraphqlApi, если он существует.lambdaAuthorizerConfig -> (структура)
Настройка аутентификации Lambda-функции.
authorizerResultTtlInSeconds -> (целое)
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 -> (строка)
dns -> (массив)
DNS-записи API.
key -> (строка)
value -> (строка)
visibility -> (строка)
GLOBAL) или закрытый (PRIVATE). Если значение не задано, видимость будет установлена по умолчанию в GLOBAL. Это значение нельзя изменить после создания API.apiType -> (строка)
GRAPHQL) или объединённым API (MERGED).mergedApiExecutionRoleArn -> (строка)
AUTO_MERGE обновления конечной точки объединённого API с изменениями источника API автоматически.owner -> (строка)
ownerContact -> (строка)
Контактная информация владельца ресурса API.
Это поле принимает любой строковый ввод длиной от 0 до 256 символов.
introspectionConfig -> (строка)
Устанавливает значение видимости GraphQL API для включения (ENABLED) или отключения (DISABLED) интроспекции. Если значение не задано, настройка интроспекции будет установлена по умолчанию в ENABLED. Это поле вызовет ошибку, если операция попытается использовать функцию интроспекции, когда это поле отключено.
Дополнительную информацию об интроспекции см. в разделе Интроспекция GraphQL.
queryDepthLimit -> (целое)
Максимальная глубина запроса в одном запросе. Глубина — это количество вложенных уровней, разрешенных в теле запроса. Значение по умолчанию — 0 (или не указано), что означает отсутствие ограничения глубины. Если вы зададите ограничение, оно может находиться в диапазоне от 1 до 75 уровней вложенности. Если операция выйдет за пределы, это поле сгенерирует ошибку.
Обратите внимание, что поля всё ещё могут быть установлены как nullable или non-nullable. Если не nullable поле вызовет ошибку, ошибка будет переброшена на ближайшее nullable поле.
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.
© Copyright 2025, Amazon Web Services. Created using Sphinx.