обновить-профиль-коннектора
Описание
Обновляет заданный профиль коннектора, связанный с вашей учетной записью.
См. также: Документацию 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 (строка)
Указывает режим подключения и является ли он общедоступным или частным.
Возможные значения:
PublicPrivate
--connector-profile-config (структура)
Определяет конфигурацию и учетные данные профиля, специфичные для коннектора.
connectorProfileProperties -> (структура)
Свойства профиля конфигурации, специфичные для коннектора.
Amplitude -> (структура)
Datadog -> (структура)
Свойства, специфичные для коннектора, необходимые для Datadog.
instanceUrl -> (строка)
Dynatrace -> (структура)
Свойства, специфичные для коннектора, необходимые для Dynatrace.
instanceUrl -> (строка)
GoogleAnalytics -> (структура)
Honeycode -> (структура)
InforNexus -> (структура)
Свойства, специфичные для коннектора, необходимые для Infor Nexus.
instanceUrl -> (строка)
Marketo -> (структура)
Свойства, специфичные для коннектора, необходимые для Marketo.
instanceUrl -> (строка)
Redshift -> (структура)
Свойства, специфичные для коннектора, необходимые для Amazon Redshift.
databaseUrl -> (строка)
bucketName -> (строка)
bucketPrefix -> (строка)
roleArn -> (строка)
dataApiRoleArn -> (строка)
isRedshiftServerless -> (булево)
clusterIdentifier -> (строка)
workgroupName -> (строка)
databaseName -> (строка)
Salesforce -> (структура)
Свойства, специфичные для коннектора, необходимые для Salesforce.
instanceUrl -> (строка)
isSandboxEnvironment -> (булево)
usePrivateLinkForMetadataAndAuthorization -> (булево)
Если режим подключения для профиля коннектора частный, этот параметр устанавливает, использует ли Amazon AppFlow частную сеть для отправки запросов метаданных и авторизации в Salesforce. Amazon AppFlow отправляет частные вызовы через Amazon Web Services PrivateLink. Эти вызовы проходят через инфраструктуру Amazon Web Services без доступа к открытому интернету.
Установите любое из следующих значений:
Amazon AppFlow отправляет все вызовы в Salesforce через частную сеть.
Эти частные вызовы:
-
Вызовы для получения метаданных о ваших записях Salesforce. Эти метаданные описывают ваши объекты Salesforce и их поля.
-
Вызовы для получения или обновления маркеров доступа, которые позволяют Amazon AppFlow получать доступ к вашим записям Salesforce.
-
Вызовы для передачи ваших записей Salesforce в рамках выполнения потока.
false
Значение по умолчанию. Amazon AppFlow отправляет некоторые вызовы в Salesforce по частной сети, а другие — через открытый интернет.
Открытые вызовы:
- Вызовы для получения метаданных о ваших записях Salesforce.
- Вызовы для получения или обновления маркеров доступа.
Частные вызовы:
- Вызовы для передачи ваших записей Salesforce в рамках выполнения потока.
ServiceNow -> (структура)
Свойства, специфичные для коннектора, необходимые для serviceNow.
instanceUrl -> (строка)
Singular -> (структура)
Slack -> (структура)
Свойства, специфичные для коннектора, необходимые для Slack.
instanceUrl -> (строка)
Snowflake -> (структура)
Свойства, специфичные для коннектора, необходимые для Snowflake.
warehouse -> (строка)
stage -> (строка)
bucketName -> (строка)
bucketPrefix -> (строка)
privateLinkServiceName -> (строка)
accountName -> (строка)
region -> (строка)
Trendmicro -> (структура)
Veeva -> (структура)
Свойства, специфичные для коннектора, необходимые для Veeva.
instanceUrl -> (строка)
Zendesk -> (структура)
Свойства, специфичные для коннектора, необходимые для Zendesk.
instanceUrl -> (строка)
SAPOData -> (структура)
Свойства профиля коннектора, специфичные для SAPOData.
applicationHostUrl -> (строка)
applicationServicePath -> (строка)
portNumber -> (целое число)
clientNumber -> (строка)
logonLanguage -> (строка)
privateLinkServiceName -> (строка)
oAuthProperties -> (структура)
Свойства SAPOData OAuth, необходимые для аутентификации типа OAuth.
tokenUrl -> (строка)
authCodeUrl -> (строка)
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 -> (строка)
oAuth2GrantType -> (строка)
tokenUrlCustomProperties -> (отображение)
Связывает ваш URL токена со словарем свойств, которые вы определяете. Используйте этот параметр, чтобы предоставить любые дополнительные сведения, необходимые коннектору для аутентификации вашего запроса.
key -> (строка)
value -> (строка)
Pardot -> (структура)
Свойства, специфичные для коннектора, необходимые для Salesforce Pardot.
instanceUrl -> (строка)
isSandboxEnvironment -> (булево)
businessUnitId -> (строка)
connectorProfileCredentials -> (структура)
Требуемые учетные данные, специфичные для каждого коннектора.
Amplitude -> (структура)
Требуемые учетные данные, специфичные для коннектора Amplitude.
apiKey -> (строка)
secretKey -> (строка)
Datadog -> (структура)
Требуемые учетные данные, специфичные для коннектора Datadog.
apiKey -> (строка)
applicationKey -> (строка)
Dynatrace -> (структура)
Требуемые учетные данные, специфичные для коннектора Dynatrace.
apiToken -> (строка)
GoogleAnalytics -> (структура)
Требуемые учетные данные, специфичные для коннектора Google Analytics.
clientId -> (строка)
clientSecret -> (строка)
accessToken -> (строка)
refreshToken -> (строка)
oAuthRequest -> (структура)
Требования OAuth для запроса токенов безопасности от конечной точки коннектора.
authCode -> (строка)
redirectUri -> (строка)
Honeycode -> (структура)
Требуемые учетные данные, специфичные для коннектора Amazon Honeycode.
accessToken -> (строка)
refreshToken -> (строка)
oAuthRequest -> (структура)
Используется для определенных коннекторов, поддерживающих OAuth, таких как Salesforce, Google Analytics, Marketo, Zendesk и Slack.
authCode -> (строка)
redirectUri -> (строка)
InforNexus -> (структура)
Требуемые учетные данные, специфичные для коннектора Infor Nexus.
accessKeyId -> (строка)
userId -> (строка)
secretAccessKey -> (строка)
datakey -> (строка)
Marketo -> (структура)
Требуемые учетные данные, специфичные для коннектора Marketo.
clientId -> (строка)
clientSecret -> (строка)
accessToken -> (строка)
oAuthRequest -> (структура)
Требования OAuth для запроса токенов безопасности от конечной точки коннектора.
authCode -> (строка)
redirectUri -> (строка)
Redshift -> (структура)
Требуемые учетные данные, специфичные для коннектора Amazon Redshift.
username -> (строка)
password -> (строка)
Salesforce -> (структура)
Требуемые учетные данные, специфичные для коннектора Salesforce.
accessToken -> (строка)
refreshToken -> (строка)
oAuthRequest -> (структура)
Требования OAuth для запроса токенов безопасности от конечной точки коннектора.
authCode -> (строка)
redirectUri -> (строка)
clientCredentialsArn -> (строка)
oAuth2GrantType -> (строка)
Указывает тип OAuth 2.0 разрешения, используемый Amazon AppFlow при запросе токена доступа у Salesforce. Amazon AppFlow требует токен доступа каждый раз, когда пытается получить доступ к вашим записям Salesforce.
Вы можете указать одно из следующих значений:
Amazon AppFlow передает код авторизации при запросе токена доступа у Salesforce. Amazon AppFlow получает код авторизации от Salesforce после входа в вашу учетную запись Salesforce и предоставления Amazon AppFlow доступа к вашим записям.
Amazon AppFlow передает JSON-токен (JWT) при запросе токена доступа у Salesforce. Вы предоставляете JWT Amazon AppFlow при определении подключения к вашей учетной записи Salesforce. При использовании этого типа разрешения вам не нужно входить в свою учетную запись Salesforce для предоставления Amazon AppFlow доступа к вашим записям.
Примечание
Значение CLIENT_CREDENTIALS не поддерживается для Salesforce.jwtToken -> (строка)
ServiceNow -> (структура)
Требуемые учетные данные, специфичные для коннектора ServiceNow.
username -> (строка)
password -> (строка)
oAuth2Credentials -> (структура)
Требуемые OAuth 2.0 учетные данные для аутентификации пользователя.
clientId -> (строка)
clientSecret -> (строка)
accessToken -> (строка)
refreshToken -> (строка)
oAuthRequest -> (структура)
Используется для определенных коннекторов, поддерживающих OAuth, таких как Salesforce, Google Analytics, Marketo, Zendesk и Slack.
authCode -> (строка)
redirectUri -> (строка)
Singular -> (структура)
Требуемые учетные данные, специфичные для коннектора Singular.
apiKey -> (строка)
Slack -> (структура)
Требуемые учетные данные, специфичные для коннектора Slack.
clientId -> (строка)
clientSecret -> (строка)
accessToken -> (строка)
oAuthRequest -> (структура)
Требования OAuth для запроса токенов безопасности от конечной точки коннектора.
authCode -> (строка)
redirectUri -> (строка)
Snowflake -> (структура)
Требуемые учетные данные, специфичные для коннектора Snowflake.
username -> (строка)
password -> (строка)
Trendmicro -> (структура)
Требуемые учетные данные, специфичные для коннектора Trend Micro.
apiSecretKey -> (строка)
Veeva -> (структура)
Требуемые учетные данные, специфичные для коннектора Veeva.
username -> (строка)
password -> (строка)
Zendesk -> (структура)
Требуемые учетные данные, специфичные для коннектора Zendesk.
clientId -> (строка)
clientSecret -> (строка)
accessToken -> (строка)
oAuthRequest -> (структура)
Требования OAuth для запроса токенов безопасности от конечной точки коннектора.
authCode -> (строка)
redirectUri -> (строка)
SAPOData -> (структура)
Данные профиля коннектора, необходимые при использовании SAPOData.
basicAuthCredentials -> (структура)
Данные аутентификации SAPOData по схеме basic.
username -> (строка)
password -> (строка)
oAuthCredentials -> (структура)
Данные аутентификации SAPOData по схеме OAuth.
clientId -> (строка)
clientSecret -> (строка)
accessToken -> (строка)
refreshToken -> (строка)
oAuthRequest -> (структура)
Требования OAuth для запроса токенов безопасности от конечной точки коннектора.
authCode -> (строка)
redirectUri -> (строка)
CustomConnector -> (структура)
Данные профиля коннектора, необходимые при использовании пользовательского коннектора.
authenticationType -> (строка)
basic -> (структура)
Данные для базовой аутентификации пользователя.
username -> (строка)
password -> (строка)
oauth2 -> (структура)
Данные аутентификации OAuth 2.0 для пользователя.
clientId -> (строка)
clientSecret -> (строка)
accessToken -> (строка)
refreshToken -> (строка)
oAuthRequest -> (структура)
Используется для некоторых коннекторов, поддерживающих OAuth, таких как Salesforce, Google Analytics, Marketo, Zendesk и Slack.
authCode -> (строка)
redirectUri -> (строка)
apiKey -> (структура)
Ключи API для аутентификации пользователя.
apiKey -> (строка)
apiSecretKey -> (строка)
custom -> (структура)
Если коннектор использует пользовательский механизм аутентификации, здесь содержатся необходимые данные.
customAuthenticationType -> (строка)
credentialsMap -> (карта)
Карта, содержащая данные пользовательской аутентификации.
key -> (строка)
value -> (строка)
Pardot -> (структура)
Данные профиля коннектора, необходимые при использовании Pardot Salesforce.
accessToken -> (строка)
refreshToken -> (строка)
oAuthRequest -> (структура)
Используется для некоторых коннекторов, поддерживающих OAuth, таких как Salesforce, Google Analytics, Marketo, Zendesk и Slack.
authCode -> (строка)
redirectUri -> (строка)
clientCredentialsArn -> (строка)
Синтаксис 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 -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.