Spec-Zone.ru › AWS CLI v2

[ aws . appflow ]

обновить-профиль-коннектора

Описание

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

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

Синтаксис

  update-connector-profile
--connector-profile-name <value>
--connection-mode <value>
--connector-profile-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-profile-name (строка)

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

--connection-mode (строка)

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

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

  • Public
  • Private

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

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

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

bucketPrefix -> (строка)

Ключ объекта для целевого bucket в 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 через Data API. Для получения дополнительной информации и для политик, которые вы прикрепляете к этой роли, см. Разрешение Amazon AppFlow получать доступ к базам данных Amazon Redshift с помощью Data API.

isRedshiftServerless -> (булево)

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

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 stage, которое было создано при настройке Amazon S3 stage в учетной записи Snowflake. Оно записывается в формате: < База данных>< Схема>< Название стадии>.

bucketName -> (строка)

Имя Amazon S3 bucket, связанного с Snowflake.

bucketPrefix -> (строка)

Путь к bucket, который ссылается на Amazon S3 bucket, связанный с 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. Если ваш профиль использует учетные данные базовой аутентификации, SSO SAP может предотвратить подключение Amazon AppFlow к вашей учетной записи с вашим именем пользователя и паролем. В этом случае пропуск SSO позволяет Amazon AppFlow успешно подключиться. Однако, если ваш профиль использует учетные данные OAuth, этот параметр не влияет.

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

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

profileProperties -> (отображение)

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

key -> (строка)

value -> (строка)

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

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

tokenUrl -> (строка)

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

oAuth2GrantType -> (строка)

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

tokenUrlCustomProperties -> (отображение)

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

key -> (строка)

value -> (строка)

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

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

instanceUrl -> (строка)

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

isSandboxEnvironment -> (булево)

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

businessUnitId -> (строка)

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

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

Требуемые учетные данные, специфичные для каждого коннектора.

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

Требуемые учетные данные, специфичные для коннектора Amplitude.

apiKey -> (строка)

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

secretKey -> (строка)

Секретный ключ доступа (Secret Access Key) в составе учетных данных.

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

Требуемые учетные данные, специфичные для коннектора Datadog.

apiKey -> (строка)

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

applicationKey -> (строка)

Ключи приложений, в сочетании с вашим API-ключом, предоставляют полный доступ к программируемому API Datadog. Ключи приложений связаны с учетной записью пользователя, который их создал. Ключ приложения используется для регистрации всех запросов к API.

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

Требуемые учетные данные, специфичные для коннектора Dynatrace.

apiToken -> (строка)

API-токены, используемые API Dynatrace для аутентификации различных API-вызовов.

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

Требуемые учетные данные, специфичные для коннектора Google Analytics.

clientId -> (строка)

Идентификатор нужного клиента.

clientSecret -> (строка)

Секретный ключ клиента, используемый OAuth-клиентом для аутентификации на сервере авторизации.

accessToken -> (строка)

Учетные данные для доступа к защищенным ресурсам Google Analytics.

refreshToken -> (строка)

Учетные данные для получения новых токенов доступа. Требуется только для OAuth2-токенов доступа, не требуется для OAuth1-токенов доступа.

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

Требования OAuth для запроса токенов безопасности от конечной точки коннектора.

authCode -> (строка)

Код, предоставленный коннектором после аутентификации через подключенное приложение.

redirectUri -> (строка)

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

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

Требуемые учетные данные, специфичные для коннектора Amazon Honeycode.

accessToken -> (строка)

Учетные данные для доступа к защищенным ресурсам Amazon Honeycode.

refreshToken -> (строка)

Учетные данные для получения новых токенов доступа.

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

Используется для определенных коннекторов, поддерживающих OAuth, таких как Salesforce, Google Analytics, Marketo, Zendesk и Slack.

authCode -> (строка)

Код, предоставленный коннектором после аутентификации через подключенное приложение.

redirectUri -> (строка)

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

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

Требуемые учетные данные, специфичные для коннектора Infor Nexus.

accessKeyId -> (строка)

Ключ доступа (Access Key) в составе учетных данных.

userId -> (строка)

Идентификатор пользователя.

secretAccessKey -> (строка)

Секретный ключ, используемый для подписи запросов.

datakey -> (строка)

Ключи шифрования, используемые для шифрования данных.

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

Требуемые учетные данные, специфичные для коннектора Marketo.

clientId -> (строка)

Идентификатор нужного клиента.

clientSecret -> (строка)

Секретный ключ клиента, используемый OAuth-клиентом для аутентификации на сервере авторизации.

accessToken -> (строка)

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

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

Требования OAuth для запроса токенов безопасности от конечной точки коннектора.

authCode -> (строка)

Код, предоставленный коннектором после аутентификации через подключенное приложение.

redirectUri -> (строка)

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

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

Требуемые учетные данные, специфичные для коннектора Amazon Redshift.

username -> (строка)

Имя пользователя.

password -> (строка)

Пароль, соответствующий имени пользователя.

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

Требуемые учетные данные, специфичные для коннектора Salesforce.

accessToken -> (строка)

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

refreshToken -> (строка)

Учетные данные для получения новых токенов доступа.

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

Требования OAuth для запроса токенов безопасности от конечной точки коннектора.

authCode -> (строка)

Код, предоставленный коннектором после аутентификации через подключенное приложение.

redirectUri -> (строка)

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

clientCredentialsArn -> (строка)

ARN хранилища секретов, содержащий идентификатор клиента и секрет клиента подключенного приложения.

oAuth2GrantType -> (строка)

Указывает тип OAuth 2.0 разрешения, используемый Amazon AppFlow при запросе токена доступа у Salesforce. Amazon AppFlow требует токен доступа каждый раз, когда пытается получить доступ к вашим записям Salesforce.

Вы можете указать одно из следующих значений:

AUTHORIZATION_CODE

Amazon AppFlow передает код авторизации при запросе токена доступа у Salesforce. Amazon AppFlow получает код авторизации от Salesforce после входа в вашу учетную запись Salesforce и предоставления Amazon AppFlow доступа к вашим записям.

JWT_BEARER

Amazon AppFlow передает JSON-токен (JWT) при запросе токена доступа у Salesforce. Вы предоставляете JWT Amazon AppFlow при определении подключения к вашей учетной записи Salesforce. При использовании этого типа разрешения вам не нужно входить в свою учетную запись Salesforce для предоставления Amazon AppFlow доступа к вашим записям.

Примечание

Значение CLIENT_CREDENTIALS не поддерживается для Salesforce.

jwtToken -> (строка)

JSON-токен (JWT), который предоставляет Amazon AppFlow доступ к вашим записям Salesforce.

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

Требуемые учетные данные, специфичные для коннектора ServiceNow.

username -> (строка)

Имя пользователя.

password -> (строка)

Пароль, соответствующий имени пользователя.

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

Требуемые OAuth 2.0 учетные данные для аутентификации пользователя.

clientId -> (строка)

Идентификатор нужного клиента.

clientSecret -> (строка)

Секретный ключ клиента, используемый OAuth-клиентом для аутентификации на сервере авторизации.

accessToken -> (строка)

Токен доступа для доступа к коннектору от вашего имени.

refreshToken -> (строка)

Токен обновления для обновления истекшего токена доступа.

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

Используется для определенных коннекторов, поддерживающих OAuth, таких как Salesforce, Google Analytics, Marketo, Zendesk и Slack.

authCode -> (строка)

Код, предоставленный коннектором после аутентификации через подключенное приложение.

redirectUri -> (строка)

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

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

Требуемые учетные данные, специфичные для коннектора Singular.

apiKey -> (строка)

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

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

Требуемые учетные данные, специфичные для коннектора Slack.

clientId -> (строка)

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

clientSecret -> (строка)

Секретный ключ клиента, используемый OAuth-клиентом для аутентификации на сервере авторизации.

accessToken -> (строка)

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

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

Требования OAuth для запроса токенов безопасности от конечной точки коннектора.

authCode -> (строка)

Код, предоставленный коннектором после аутентификации через подключенное приложение.

redirectUri -> (строка)

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

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

Требуемые учетные данные, специфичные для коннектора Snowflake.

username -> (строка)

Имя пользователя.

password -> (строка)

Пароль, соответствующий имени пользователя.

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

Требуемые учетные данные, специфичные для коннектора Trend Micro.

apiSecretKey -> (строка)

Секретный ключ доступа (Secret Access Key) в составе учетных данных.

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

Требуемые учетные данные, специфичные для коннектора Veeva.

username -> (строка)

Имя пользователя.

password -> (строка)

Пароль, соответствующий имени пользователя.

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

Требуемые учетные данные, специфичные для коннектора Zendesk.

clientId -> (строка)

Идентификатор нужного клиента.

clientSecret -> (строка)

Секретный ключ клиента, используемый OAuth-клиентом для аутентификации на сервере авторизации.

accessToken -> (строка)

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

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

Требования OAuth для запроса токенов безопасности от конечной точки коннектора.

authCode -> (строка)

Код, предоставленный коннектором после аутентификации через подключенное приложение.

redirectUri -> (строка)

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

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

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

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

Данные аутентификации SAPOData по схеме basic.

username -> (строка)

Имя пользователя для подключения к ресурсу.

password -> (строка)

Пароль для подключения к ресурсу.

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

Данные аутентификации SAPOData по схеме OAuth.

clientId -> (строка)

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

clientSecret -> (строка)

Секретный ключ клиента OAuth для аутентификации на сервере авторизации.

accessToken -> (строка)

Токен доступа для доступа к защищенным ресурсам SAPOData.

refreshToken -> (строка)

Токен обновления для продления истекшего токена доступа.

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

Требования OAuth для запроса токенов безопасности от конечной точки коннектора.

authCode -> (строка)

Код, предоставленный коннектором после аутентификации через подключенное приложение.

redirectUri -> (строка)

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

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

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

authenticationType -> (строка)

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

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

Данные для базовой аутентификации пользователя.

username -> (строка)

Имя пользователя для подключения к ресурсу.

password -> (строка)

Пароль для подключения к ресурсу.

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

Данные аутентификации OAuth 2.0 для пользователя.

clientId -> (строка)

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

clientSecret -> (строка)

Секретный ключ клиента OAuth для аутентификации на сервере авторизации.

accessToken -> (строка)

Токен доступа для подключения к коннектору от вашего имени.

refreshToken -> (строка)

Токен обновления для продления истекшего токена доступа.

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

Используется для некоторых коннекторов, поддерживающих OAuth, таких как Salesforce, Google Analytics, Marketo, Zendesk и Slack.

authCode -> (строка)

Код, предоставленный коннектором после аутентификации через подключенное приложение.

redirectUri -> (строка)

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

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

Ключи API для аутентификации пользователя.

apiKey -> (строка)

Ключ API для аутентификации.

apiSecretKey -> (строка)

Секретный ключ API для аутентификации.

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

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

customAuthenticationType -> (строка)

Тип пользовательской аутентификации, используемой коннектором.

credentialsMap -> (карта)

Карта, содержащая данные пользовательской аутентификации.

key -> (строка)

value -> (строка)

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

Данные профиля коннектора, необходимые при использовании Pardot Salesforce.

accessToken -> (строка)

Данные для доступа к защищенным ресурсам Pardot Salesforce.

refreshToken -> (строка)

Данные для получения новых токенов доступа.

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

Используется для некоторых коннекторов, поддерживающих OAuth, таких как Salesforce, Google Analytics, Marketo, Zendesk и Slack.

authCode -> (строка)

Код, предоставленный коннектором после аутентификации через подключенное приложение.

redirectUri -> (строка)

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

clientCredentialsArn -> (строка)

ARN секретного хранилища, содержащего идентификатор и секретный ключ клиента подключенного приложения.

Синтаксис JSON:

{
  "connectorProfileProperties": {
    "Amplitude": {

    },
    "Datadog": {
      "instanceUrl": "string"
    },
    "Dynatrace": {
      "instanceUrl": "string"
    },
    "GoogleAnalytics": {

    },
    "Honeycode": {

    },
    "InforNexus": {
      "instanceUrl": "string"
    },
    "Marketo": {
      "instanceUrl": "string"
    },
    "Redshift": {
      "databaseUrl": "string",
      "bucketName": "string",
      "bucketPrefix": "string",
      "roleArn": "string",
      "dataApiRoleArn": "string",
      "isRedshiftServerless": true|false,
      "clusterIdentifier": "string",
      "workgroupName": "string",
      "databaseName": "string"
    },
    "Salesforce": {
      "instanceUrl": "string",
      "isSandboxEnvironment": true|false,
      "usePrivateLinkForMetadataAndAuthorization": true|false
    },
    "ServiceNow": {
      "instanceUrl": "string"
    },
    "Singular": {

    },
    "Slack": {
      "instanceUrl": "string"
    },
    "Snowflake": {
      "warehouse": "string",
      "stage": "string",
      "bucketName": "string",
      "bucketPrefix": "string",
      "privateLinkServiceName": "string",
      "accountName": "string",
      "region": "string"
    },
    "Trendmicro": {

    },
    "Veeva": {
      "instanceUrl": "string"
    },
    "Zendesk": {
      "instanceUrl": "string"
    },
    "SAPOData": {
      "applicationHostUrl": "string",
      "applicationServicePath": "string",
      "portNumber": integer,
      "clientNumber": "string",
      "logonLanguage": "string",
      "privateLinkServiceName": "string",
      "oAuthProperties": {
        "tokenUrl": "string",
        "authCodeUrl": "string",
        "oAuthScopes": ["string", ...]
      },
      "disableSSO": true|false
    },
    "CustomConnector": {
      "profileProperties": {"string": "string"
        ...},
      "oAuth2Properties": {
        "tokenUrl": "string",
        "oAuth2GrantType": "CLIENT_CREDENTIALS"|"AUTHORIZATION_CODE"|"JWT_BEARER",
        "tokenUrlCustomProperties": {"string": "string"
          ...}
      }
    },
    "Pardot": {
      "instanceUrl": "string",
      "isSandboxEnvironment": true|false,
      "businessUnitId": "string"
    }
  },
  "connectorProfileCredentials": {
    "Amplitude": {
      "apiKey": "string",
      "secretKey": "string"
    },
    "Datadog": {
      "apiKey": "string",
      "applicationKey": "string"
    },
    "Dynatrace": {
      "apiToken": "string"
    },
    "GoogleAnalytics": {
      "clientId": "string",
      "clientSecret": "string",
      "accessToken": "string",
      "refreshToken": "string",
      "oAuthRequest": {
        "authCode": "string",
        "redirectUri": "string"
      }
    },
    "Honeycode": {
      "accessToken": "string",
      "refreshToken": "string",
      "oAuthRequest": {
        "authCode": "string",
        "redirectUri": "string"
      }
    },
    "InforNexus": {
      "accessKeyId": "string",
      "userId": "string",
      "secretAccessKey": "string",
      "datakey": "string"
    },
    "Marketo": {
      "clientId": "string",
      "clientSecret": "string",
      "accessToken": "string",
      "oAuthRequest": {
        "authCode": "string",
        "redirectUri": "string"
      }
    },
    "Redshift": {
      "username": "string",
      "password": "string"
    },
    "Salesforce": {
      "accessToken": "string",
      "refreshToken": "string",
      "oAuthRequest": {
        "authCode": "string",
        "redirectUri": "string"
      },
      "clientCredentialsArn": "string",
      "oAuth2GrantType": "CLIENT_CREDENTIALS"|"AUTHORIZATION_CODE"|"JWT_BEARER",
      "jwtToken": "string"
    },
    "ServiceNow": {
      "username": "string",
      "password": "string",
      "oAuth2Credentials": {
        "clientId": "string",
        "clientSecret": "string",
        "accessToken": "string",
        "refreshToken": "string",
        "oAuthRequest": {
          "authCode": "string",
          "redirectUri": "string"
        }
      }
    },
    "Singular": {
      "apiKey": "string"
    },
    "Slack": {
      "clientId": "string",
      "clientSecret": "string",
      "accessToken": "string",
      "oAuthRequest": {
        "authCode": "string",
        "redirectUri": "string"
      }
    },
    "Snowflake": {
      "username": "string",
      "password": "string"
    },
    "Trendmicro": {
      "apiSecretKey": "string"
    },
    "Veeva": {
      "username": "string",
      "password": "string"
    },
    "Zendesk": {
      "clientId": "string",
      "clientSecret": "string",
      "accessToken": "string",
      "oAuthRequest": {
        "authCode": "string",
        "redirectUri": "string"
      }
    },
    "SAPOData": {
      "basicAuthCredentials": {
        "username": "string",
        "password": "string"
      },
      "oAuthCredentials": {
        "clientId": "string",
        "clientSecret": "string",
        "accessToken": "string",
        "refreshToken": "string",
        "oAuthRequest": {
          "authCode": "string",
          "redirectUri": "string"
        }
      }
    },
    "CustomConnector": {
      "authenticationType": "OAUTH2"|"APIKEY"|"BASIC"|"CUSTOM",
      "basic": {
        "username": "string",
        "password": "string"
      },
      "oauth2": {
        "clientId": "string",
        "clientSecret": "string",
        "accessToken": "string",
        "refreshToken": "string",
        "oAuthRequest": {
          "authCode": "string",
          "redirectUri": "string"
        }
      },
      "apiKey": {
        "apiKey": "string",
        "apiSecretKey": "string"
      },
      "custom": {
        "customAuthenticationType": "string",
        "credentialsMap": {"string": "string"
          ...}
      }
    },
    "Pardot": {
      "accessToken": "string",
      "refreshToken": "string",
      "oAuthRequest": {
        "authCode": "string",
        "redirectUri": "string"
      },
      "clientCredentialsArn": "string"
    }
  }
}

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

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

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

Если вы укажете параметры ввода, отличающиеся от первого запроса, произойдет ошибка. Если вы используете другое значение для clientToken, Amazon AppFlow рассматривает это как новый вызов к UpdateConnectorProfile. Токен активен в течение 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
  • 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.

Вывод

connectorProfileArn -> (строка)

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

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

Spec-Zone.ru

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