Spec-Zone.ru › AWS CLI v2

[ aws . appsync ]

associate-source-graphql-api

Описание

Создаёт ассоциацию между объединённым API и источником API, используя идентификатор объединённого API.

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

Синтаксис

  associate-source-graphql-api
--merged-api-identifier <value>
--source-api-identifier <value>
[--description <value>]
[--source-api-association-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]

Параметры

--merged-api-identifier (строка)

Идентификатор объединённого API AppSync. Он генерируется службой AppSync. В большинстве случаев для объединённых API (особенно в вашем аккаунте) достаточно значения ID API или ARN объединённого API. Однако для объединённых API в других аккаунтах (случаи кросс-аккаунтного использования) строго требуется полный ARN ресурса объединённого API.

--source-api-identifier (строка)

Идентификатор источника API AppSync. Он генерируется службой AppSync. В большинстве случаев для источников API (особенно в вашем аккаунте) достаточно значения ID API или ARN источника API. Однако для источников API из других аккаунтов (случаи кросс-аккаунтного использования) строго требуется полный ARN ресурса источника API.

--description (строка)

Поле описания.

--source-api-association-config (структура)

Данные объекта SourceApiAssociationConfig.

mergeType -> (строка)

Свойство, указывающее, какой вариант слияния включён в ассоциацию с источником API.

Допустимые типы слияния: MANUAL_MERGE (по умолчанию) и AUTO_MERGE. Ручное слияние — это поведение по умолчанию и требует от пользователя вручную запускать любые изменения из источников API в объединённый API. Автоматическое слияние подписывает объединённый API на изменения, выполняемые в источниках API, так что любые изменения в источниках API также выполняются в объединённом API. Автоматическое слияние использует MergedApiExecutionRoleArn для выполнения операций слияния.

Сокращённый синтаксис:

mergeType=string

Синтаксис JSON:

{
  "mergeType": "MANUAL_MERGE"|"AUTO_MERGE"
}

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

Переопределить адрес по умолчанию команды заданным адресом.

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

Вывод

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

Данные объекта SourceApiAssociation.

associationId -> (строка)

Идентификатор, сгенерированный службой AppSync для ассоциации источника API.

associationArn -> (строка)

Amazon Resource Name (ARN) ассоциации источника API.

sourceApiId -> (строка)

ID источника API AppSync.

sourceApiArn -> (строка)

Amazon Resource Name (ARN) источника AppSync API.

mergedApiArn -> (строка)

Amazon Resource Name (ARN) объединённого API AppSync.

mergedApiId -> (строка)

ID объединённого API AppSync.

description -> (строка)

Поле описания.

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

Данные объекта SourceApiAssociationConfig.

mergeType -> (строка)

Свойство, указывающее, какой вариант слияния включён в ассоциацию с источником API.

Допустимые типы слияния: MANUAL_MERGE (по умолчанию) и AUTO_MERGE. Ручное слияние — это поведение по умолчанию и требует от пользователя вручную запускать любые изменения из источников API в объединённый API. Автоматическое слияние подписывает объединённый API на изменения, выполняемые в источниках API, так что любые изменения в источниках API также выполняются в объединённом API. Автоматическое слияние использует MergedApiExecutionRoleArn для выполнения операций слияния.

sourceApiAssociationStatus -> (строка)

Состояние ассоциации источника API.

sourceApiAssociationStatusDetail -> (строка)

Подробное сообщение, связанное с текущим состоянием ассоциации источника API.

lastSuccessfulMergeDate -> (метка времени)

Значение даты и времени последнего успешного слияния ассоциации источника API. Результат будет в формате UTC и вашем часовом поясе.

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

Spec-Zone.ru

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