Spec-Zone.ru › AWS CLI v2

[ aws . appsync ]

get-function

Описание

Получить Function.

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

Синтаксис

  get-function
--api-id <value>
--function-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 (строка)

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

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

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

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

Вывод

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

Объект Function.

functionId -> (строка)

Уникальный идентификатор, представляющий объект Function.

functionArn -> (строка)

Amazon Resource Name (ARN) объекта Function.

name -> (строка)

Имя объекта Function.

description -> (строка)

Описание Function.

dataSourceName -> (строка)

Имя DataSource.

requestMappingTemplate -> (строка)

Шаблон отображения запроса Function. Функции поддерживают только версию шаблона отображения запроса 2018-05-29.

responseMappingTemplate -> (строка)

Шаблон отображения ответа Function.

functionVersion -> (строка)

Версия шаблона отображения запроса. В настоящее время поддерживается только версия шаблона 2018-05-29.

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

Описывает конфигурацию синхронизации для разрешителя.

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

conflictHandler -> (строка)

Стратегия разрешения конфликтов, которая должна быть выполнена в случае конфликта.

  • OPTIMISTIC_CONCURRENCY : Разрешение конфликтов путем отклонения мутаций, когда версии не соответствуют последней версии на сервере.
  • AUTOMERGE : Разрешение конфликтов с помощью стратегии разрешения конфликтов Automerge.
  • LAMBDA : Разрешение конфликтов с функцией Lambda, предоставленной в LambdaConflictHandlerConfig.

conflictDetection -> (строка)

Стратегия обнаружения конфликтов, используемая при вызове разрешителя.

  • VERSION : Обнаружение конфликтов на основе версий объектов для этого разрешителя.
  • NONE : Не обнаруживать конфликты при вызове этого разрешителя.

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

LambdaConflictHandlerConfig при настройке LAMBDA как обработчика конфликтов.

lambdaConflictHandlerArn -> (строка)

Amazon Resource Name (ARN) функции Lambda, используемой в качестве обработчика конфликтов.

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

Максимальный размер пакетной обработки для разрешителя.

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

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

name -> (строка)

Имя name среды выполнения для использования. В настоящее время единственное допустимое значение — APPSYNC_JS.

runtimeVersion -> (строка)

Версия version среды выполнения для использования. В настоящее время единственная допустимая версия — 1.0.0.

code -> (строка)

Код function, содержащий функции запроса и ответа. При использовании кода требуется runtime. Значение runtime должно быть APPSYNC_JS.

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

Spec-Zone.ru

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