Spec-Zone.ru › AWS CLI v2

[ aws . appflow ]

регистрация-соединителя

Описание

Регистрирует новый пользовательский соединитель в вашем аккаунте Amazon Web Services. Прежде чем вы сможете зарегистрировать соединитель, вы должны развернуть связанную функцию AWS lambda в вашем аккаунте.

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

Синтаксис

  register-connector
[--connector-label <value>]
[--description <value>]
[--connector-provisioning-type <value>]
[--connector-provisioning-config <value>]
[--client-token <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]

Параметры

--connector-label (строка)

Имя соединителя. Имя уникально для каждого ConnectorRegistration в вашем аккаунте Amazon Web Services.

--description (строка)

Описание регистрируемого соединителя.

--connector-provisioning-type (строка)

Тип подготовки соединителя. В настоящее время поддерживается только значение LAMBDA.

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

  • LAMBDA

--connector-provisioning-config (структура)

Тип подготовки соединителя. В настоящее время поддерживается только значение LAMBDA.

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

Содержит информацию о конфигурации lambda, регистрируемой как соединитель.

lambdaArn -> (строка)

Lambda ARN регистрируемого соединителя.

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

lambda={lambdaArn=string}

Синтаксис JSON:

{
  "lambda": {
    "lambdaArn": "string"
  }
}

--client-token (строка)

Параметр clientToken — это маркер идемпотентности. Он гарантирует, что ваш запрос RegisterConnector завершится только один раз. Вы выбираете значение для передачи. Например, если вы не получаете ответ от вашего запроса, вы можете безопасно повторить запрос со значением параметра clientToken.

Если вы опускаете значение clientToken, используемый Amazon Web Services SDK вставляет значение за вас. Таким образом, SDK может безопасно повторять запросы несколько раз после сетевой ошибки. Вы должны предоставить собственное значение для других случаев использования.

Если вы укажете входные параметры, отличающиеся от первого запроса, произойдет ошибка. Если вы используете другое значение для clientToken, Amazon AppFlow рассматривает это как новый вызов RegisterConnector. Токен активен в течение 8 часов.

--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 для вывода.

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

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

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

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

Вывод

connectorArn -> (строка)

ARN регистрируемого соединителя.

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

Spec-Zone.ru

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