Spec-Zone.ru › AWS CLI v2

[ aws . appflow ]

describe-connector-profiles

Описание

Возвращает список connector-profile деталей, соответствующих указанным именам connector-profile и connector-types. Оба входных списка являются необязательными и могут использоваться для фильтрации результата.

Если имена или connector-types не указаны, возвращает все профили соединителей в постраничном формате. Если соответствий нет, данная операция возвращает пустой список.

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

Синтаксис

  describe-connector-profiles
[--connector-profile-names <value>]
[--connector-type <value>]
[--connector-label <value>]
[--max-results <value>]
[--next-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-profile-names (список)

Имя профиля соединителя. Имя уникально для каждого ConnectorProfile в учетной записи Amazon Web Services.

(строка)

Синтаксис:

"string" "string" ...

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

Тип соединителя, например Salesforce, Amplitude и так далее.

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

  • Salesforce
  • Singular
  • Slack
  • Redshift
  • S3
  • Marketo
  • Googleanalytics
  • Zendesk
  • Servicenow
  • Datadog
  • Trendmicro
  • Snowflake
  • Dynatrace
  • Infornexus
  • Amplitude
  • Veeva
  • EventBridge
  • LookoutMetrics
  • Upsolver
  • Honeycode
  • CustomerProfiles
  • SAPOData
  • CustomConnector
  • Pardot

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

Имя соединителя. Имя уникально для каждого ConnectorRegistration в вашей учетной записи Amazon Web Services. Требуется только при запросе для типа соединителя CUSTOMCONNECTOR.

--max-results (целое число)

Указывает максимальное количество элементов, которые должны быть возвращены в наборе результатов. Значение по умолчанию для maxResults составляет 20 (для всех постраничных операций API).

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

Маркер постраничной навигации для следующей страницы данных.

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

connectorProfileDetails -> (список)

Возвращает информацию о профилях коннекторов, связанных с потоком.

(структура)

Описывает экземпляр коннектора. Он включает предоставленное имя, ARN учетных данных, режим подключения и т. д. Чтобы сохранить интуитивность и расширяемость API, поля, общие для всех типов профилей коннекторов, явно указаны на верхнем уровне. Остальные свойства, специфичные для коннектора, доступны через поле connectorProfileProperties.

connectorProfileArn -> (строка)

Amazon Resource Name (ARN) профиля коннектора.

connectorProfileName -> (строка)

Имя профиля коннектора. Имя уникально для каждого ConnectorProfile в учетной записи Amazon Web Services.

connectorType -> (строка)

Тип коннектора, например Salesforce, Amplitude и т. д.

connectorLabel -> (строка)

Метка создаваемого профиля коннектора.

connectionMode -> (строка)

Указывает режим подключения и является ли он общедоступным или частным.

credentialsArn -> (строка)

Amazon Resource Name (ARN) учетных данных профиля коннектора.

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

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

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

Свойства коннектора, специфичные для Amplitude.

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

Свойства коннектора, специфичные для Datadog.

instanceUrl -> (строка)

Расположение ресурса Datadog.

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

Свойства коннектора, специфичные для Dynatrace.

instanceUrl -> (строка)

Расположение ресурса Dynatrace.

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

Свойства коннектора, специфичные для Google Analytics.

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

Свойства коннектора, специфичные для Amazon Honeycode.

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

Свойства коннектора, специфичные для Infor Nexus.

instanceUrl -> (строка)

Расположение ресурса Infor Nexus.

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

Свойства коннектора, специфичные для Marketo.

instanceUrl -> (строка)

Расположение ресурса Marketo.

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

Свойства коннектора, специфичные для Amazon Redshift.

databaseUrl -> (строка)

JDBC URL кластера Amazon Redshift.

bucketName -> (строка)

Имя связанного Amazon S3-бакета.

bucketPrefix -> (строка)

Ключ объекта в конечном бакете Amazon S3, в котором Amazon AppFlow размещает файлы.

roleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, предоставляющей Amazon Redshift чтение без записи доступа к Amazon S3. Дополнительную информацию и политики, которые вы добавляете к этой роли, см. в разделе Разрешить Amazon Redshift доступ к вашим данным Amazon AppFlow в Amazon S3.

dataApiRoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, которая позволяет Amazon AppFlow получать доступ к базе данных Amazon Redshift через API данных. Дополнительную информацию и политики, которые вы добавляете к этой роли, см. в разделе Разрешить Amazon AppFlow доступ к базам данных Amazon Redshift с помощью API данных.

isRedshiftServerless -> (булево)

Указывает, определяет ли профиль коннектора подключение к серверу Amazon Redshift Serverless.

clusterIdentifier -> (строка)

Уникальный идентификатор, присвоенный кластеру Amazon Redshift.

workgroupName -> (строка)

Имя группы задач Amazon Redshift.

databaseName -> (строка)

Имя базы данных Amazon Redshift.

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

Свойства коннектора, специфичные для Salesforce.

instanceUrl -> (строка)

Расположение ресурса Salesforce.

isSandboxEnvironment -> (булево)

Указывает, относится ли профиль коннектора к среде песочницы или рабочей среде.

usePrivateLinkForMetadataAndAuthorization -> (булево)

Если режим подключения для профиля коннектора — частный, этот параметр устанавливает, использует ли Amazon AppFlow частную сеть для отправки метаданных и вызовов авторизации в Salesforce. Amazon AppFlow отправляет частные вызовы через Amazon Web Services PrivateLink. Эти вызовы проходят через инфраструктуру Amazon Web Services без экспонирования в общедоступном интернете.

Установите одно из следующих значений:

true

Amazon AppFlow отправляет все вызовы в Salesforce через частную сеть.

Эти частные вызовы:

  • Вызовы для получения метаданных о ваших записях Salesforce. Эти метаданные описывают ваши объекты Salesforce и их поля.

  • Вызовы для получения или обновления маркеров доступа, позволяющих Amazon AppFlow получать доступ к вашим записям Salesforce.

  • Вызовы для передачи ваших записей Salesforce в рамках выполнения потока.

    false

Значение по умолчанию. Amazon AppFlow отправляет некоторые вызовы в Salesforce по частной сети, а другие — по общедоступному интернету.

Общедоступные вызовы:

  • Вызовы для получения метаданных о ваших записях Salesforce.
  • Вызовы для получения или обновления маркеров доступа.

Частные вызовы:

  • Вызовы для передачи ваших записей Salesforce в рамках выполнения потока.

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

Свойства коннектора, специфичные для serviceNow.

instanceUrl -> (строка)

Расположение ресурса ServiceNow.

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

Свойства коннектора, специфичные для Singular.

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

Свойства коннектора, специфичные для Slack.

instanceUrl -> (строка)

Расположение ресурса Slack.

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

Свойства коннектора, специфичные для Snowflake.

warehouse -> (строка)

Имя хранилища Snowflake.

stage -> (строка)

Имя Amazon S3-этапа, который был создан при настройке Amazon S3-этапа в учетной записи Snowflake. Он записан в следующем формате: < База данных>< Схема>< Имя этапа>.

bucketName -> (строка)

Имя Amazon S3-бакета, связанного с Snowflake.

bucketPrefix -> (строка)

Путь к бакету, который относится к связанному Amazon S3-бакету Snowflake.

privateLinkServiceName -> (строка)

Имя сервиса Snowflake Private Link, используемого для частных передачь данных.

accountName -> (строка)

Имя учетной записи.

region -> (строка)

Регион Amazon Web Services учетной записи Snowflake.

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

Свойства коннектора, специфичные для Trend Micro.

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

Свойства коннектора, специфичные для Veeva.

instanceUrl -> (строка)

Расположение ресурса Veeva.

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

Свойства коннектора, специфичные для Zendesk.

instanceUrl -> (строка)

Расположение ресурса Zendesk.

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

Свойства профиля коннектора, специфичные для SAPOData.

applicationHostUrl -> (строка)

Расположение ресурса SAPOData.

applicationServicePath -> (строка)

Путь к службе каталога приложения.

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

Порт ресурса SAPOData.

clientNumber -> (строка)

Номер клиента, создающего подключение.

logonLanguage -> (строка)

Язык входа в систему ресурса SAPOData.

privateLinkServiceName -> (строка)

Имя службы SAPOData Private Link для использования при передаче частных данных.

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

Свойства SAPOData OAuth, требуемые для аутентификации типа OAuth.

tokenUrl -> (строка)

URL-адрес маркера, необходимый для получения маркеров доступа/обновления маркеров с использованием кода авторизации, а также для обновления истекших маркеров доступа с помощью маркера обновления.

authCodeUrl -> (строка)

URL-адрес кода авторизации, необходимый для перенаправления на страницу входа в SAP для получения кода авторизации для аутентификации типа OAuth.

oAuthScopes -> (список)

Охватываемые OAuth, необходимые для аутентификации типа OAuth.

(строка)

disableSSO -> (булево)

Если вы установите этот параметр в true, Amazon AppFlow проигнорирует параметры единого входа (SSO) в вашей учетной записи SAP при доступе к ресурсу SAP OData.

Вам нужна эта опция в зависимости от типа учетных данных, которые вы применили к профилю подключения SAP OData. Если ваш профиль использует учетные данные базовой аутентификации, SAP SSO может помешать Amazon AppFlow подключиться к вашей учетной записи с помощью вашего имени пользователя и пароля. В этом случае игнорирование SSO позволяет Amazon AppFlow успешно подключиться. Однако, если ваш профиль использует учетные данные OAuth, этот параметр не влияет.

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

Необходимые свойства для пользовательского коннектора.

profileProperties -> (карта)

Карта свойств, необходимых для создания профиля для пользовательского коннектора.

ключ -> (строка)

значение -> (строка)

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

Свойства OAuth 2.0, необходимые для аутентификации OAuth 2.0.

tokenUrl -> (строка)

URL-адрес маркера, необходимый для аутентификации OAuth 2.0.

oAuth2GrantType -> (строка)

Тип OAuth 2.0, используемый коннектором для аутентификации OAuth 2.0.

tokenUrlCustomProperties -> (карта)

Сопоставляет ваш URL-адрес маркера с картой свойств, которые вы определяете. Используйте этот параметр для предоставления дополнительных данных, необходимых коннектору для проверки подлинности вашего запроса.

ключ -> (строка)

значение -> (строка)

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

Свойства коннектора, специфичные для Salesforce Pardot.

instanceUrl -> (строка)

Расположение ресурса Salesforce Pardot.

isSandboxEnvironment -> (булево)

Указывает, относится ли профиль коннектора к среде песочницы или рабочей среде.

businessUnitId -> (строка)

Идентификатор бизнес-единицы экземпляра Salesforce Pardot.

createdAt -> (временная метка)

Указывает время создания профиля коннектора.

lastUpdatedAt -> (временная метка)

Указывает время последнего обновления профиля коннектора.

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

Указывает состояние подготовки частного подключения.

status -> (строка)

Указывает состояние подготовки частного подключения.

failureMessage -> (строка)

Указывает причину сбоя подготовки частного подключения.

failureCause -> (строка)

Указывает причину сбоя подготовки частного подключения.

nextToken -> (строка)

Токен постраничной навигации для следующей страницы данных. Если nextToken=null , это означает, что все записи были извлечены.

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

Spec-Zone.ru

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