2023/04/28 - Amazon Appflow - 5 updated api methods
Changes Adds Jwt Support for Salesforce Credentials.
{'connectorProfileConfig': {'connectorProfileCredentials': {'Salesforce': {'jwtToken': 'string',
'oAuth2GrantType': 'CLIENT_CREDENTIALS '
'| '
'AUTHORIZATION_CODE '
'| '
'JWT_BEARER'}},
'connectorProfileProperties': {'CustomConnector': {'oAuth2Properties': {'oAuth2GrantType': {'JWT_BEARER'}}}}}}
Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector profile that you create, you can provide the credentials and properties for only one connector.
See also: AWS API Documentation
Request Syntax
client.create_connector_profile(
connectorProfileName='string',
kmsArn='string',
connectorType='Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
connectorLabel='string',
connectionMode='Public'|'Private',
connectorProfileConfig={
'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': 123,
'clientNumber': 'string',
'logonLanguage': 'string',
'privateLinkServiceName': 'string',
'oAuthProperties': {
'tokenUrl': 'string',
'authCodeUrl': 'string',
'oAuthScopes': [
'string',
]
}
},
'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'
},
'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'
}
}
},
clientToken='string'
)
string
[REQUIRED]
The name of the connector profile. The name is unique for each ConnectorProfile in your Amazon Web Services account.
string
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
string
[REQUIRED]
The type of connector, such as Salesforce, Amplitude, and so on.
string
The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
string
[REQUIRED]
Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public internet.
dict
[REQUIRED]
Defines the connector-specific configuration and credentials.
connectorProfileProperties (dict) -- [REQUIRED]
The connector-specific properties of the profile configuration.
Amplitude (dict) --
The connector-specific properties required by Amplitude.
Datadog (dict) --
The connector-specific properties required by Datadog.
instanceUrl (string) -- [REQUIRED]
The location of the Datadog resource.
Dynatrace (dict) --
The connector-specific properties required by Dynatrace.
instanceUrl (string) -- [REQUIRED]
The location of the Dynatrace resource.
GoogleAnalytics (dict) --
The connector-specific properties required Google Analytics.
Honeycode (dict) --
The connector-specific properties required by Amazon Honeycode.
InforNexus (dict) --
The connector-specific properties required by Infor Nexus.
instanceUrl (string) -- [REQUIRED]
The location of the Infor Nexus resource.
Marketo (dict) --
The connector-specific properties required by Marketo.
instanceUrl (string) -- [REQUIRED]
The location of the Marketo resource.
Redshift (dict) --
The connector-specific properties required by Amazon Redshift.
databaseUrl (string) --
The JDBC URL of the Amazon Redshift cluster.
bucketName (string) -- [REQUIRED]
A name for the associated Amazon S3 bucket.
bucketPrefix (string) --
The object key for the destination bucket in which Amazon AppFlow places the files.
roleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3. For more information, and for the polices that you attach to this role, see Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3 .
dataApiRoleArn (string) --
The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API. For more information, and for the polices that you attach to this role, see Allow Amazon AppFlow to access Amazon Redshift databases with the Data API .
isRedshiftServerless (boolean) --
Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.
clusterIdentifier (string) --
The unique ID that's assigned to an Amazon Redshift cluster.
workgroupName (string) --
The name of an Amazon Redshift workgroup.
databaseName (string) --
The name of an Amazon Redshift database.
Salesforce (dict) --
The connector-specific properties required by Salesforce.
instanceUrl (string) --
The location of the Salesforce resource.
isSandboxEnvironment (boolean) --
Indicates whether the connector profile applies to a sandbox or production environment.
usePrivateLinkForMetadataAndAuthorization (boolean) --
If the connection mode for the connector profile is private, this parameter sets whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce. Amazon AppFlow sends private calls through Amazon Web Services PrivateLink. These calls travel through Amazon Web Services infrastructure without being exposed to the public internet.
Set either of the following values:
true
Amazon AppFlow sends all calls to Salesforce over the private network.
These private calls are:
Calls to get metadata about your Salesforce records. This metadata describes your Salesforce objects and their fields.
Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce records.
Calls to transfer your Salesforce records as part of a flow run.
false
The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls over the public internet.
The public calls are:
Calls to get metadata about your Salesforce records.
Calls to get or refresh access tokens.
The private calls are:
Calls to transfer your Salesforce records as part of a flow run.
ServiceNow (dict) --
The connector-specific properties required by serviceNow.
instanceUrl (string) -- [REQUIRED]
The location of the ServiceNow resource.
Singular (dict) --
The connector-specific properties required by Singular.
Slack (dict) --
The connector-specific properties required by Slack.
instanceUrl (string) -- [REQUIRED]
The location of the Slack resource.
Snowflake (dict) --
The connector-specific properties required by Snowflake.
warehouse (string) -- [REQUIRED]
The name of the Snowflake warehouse.
stage (string) -- [REQUIRED]
The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: < Database>< Schema><Stage Name>.
bucketName (string) -- [REQUIRED]
The name of the Amazon S3 bucket associated with Snowflake.
bucketPrefix (string) --
The bucket path that refers to the Amazon S3 bucket associated with Snowflake.
privateLinkServiceName (string) --
The Snowflake Private Link service name to be used for private data transfers.
accountName (string) --
The name of the account.
region (string) --
The Amazon Web Services Region of the Snowflake account.
Trendmicro (dict) --
The connector-specific properties required by Trend Micro.
Veeva (dict) --
The connector-specific properties required by Veeva.
instanceUrl (string) -- [REQUIRED]
The location of the Veeva resource.
Zendesk (dict) --
The connector-specific properties required by Zendesk.
instanceUrl (string) -- [REQUIRED]
The location of the Zendesk resource.
SAPOData (dict) --
The connector-specific profile properties required when using SAPOData.
applicationHostUrl (string) -- [REQUIRED]
The location of the SAPOData resource.
applicationServicePath (string) -- [REQUIRED]
The application path to catalog service.
portNumber (integer) -- [REQUIRED]
The port number of the SAPOData instance.
clientNumber (string) -- [REQUIRED]
The client number for the client creating the connection.
logonLanguage (string) --
The logon language of SAPOData instance.
privateLinkServiceName (string) --
The SAPOData Private Link service name to be used for private data transfers.
oAuthProperties (dict) --
The SAPOData OAuth properties required for OAuth type authentication.
tokenUrl (string) -- [REQUIRED]
The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token.
authCodeUrl (string) -- [REQUIRED]
The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication.
oAuthScopes (list) -- [REQUIRED]
The OAuth scopes required for OAuth type authentication.
(string) --
CustomConnector (dict) --
The properties required by the custom connector.
profileProperties (dict) --
A map of properties that are required to create a profile for the custom connector.
(string) --
(string) --
oAuth2Properties (dict) --
The OAuth 2.0 properties required for OAuth 2.0 authentication.
tokenUrl (string) -- [REQUIRED]
The token URL required for OAuth 2.0 authentication.
oAuth2GrantType (string) -- [REQUIRED]
The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.
tokenUrlCustomProperties (dict) --
Associates your token URL with a map of properties that you define. Use this parameter to provide any additional details that the connector requires to authenticate your request.
(string) --
(string) --
Pardot (dict) --
The connector-specific properties required by Salesforce Pardot.
instanceUrl (string) --
The location of the Salesforce Pardot resource.
isSandboxEnvironment (boolean) --
Indicates whether the connector profile applies to a sandbox or production environment.
businessUnitId (string) --
The business unit id of Salesforce Pardot instance.
connectorProfileCredentials (dict) --
The connector-specific credentials required by each connector.
Amplitude (dict) --
The connector-specific credentials required when using Amplitude.
apiKey (string) -- [REQUIRED]
A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
secretKey (string) -- [REQUIRED]
The Secret Access Key portion of the credentials.
Datadog (dict) --
The connector-specific credentials required when using Datadog.
apiKey (string) -- [REQUIRED]
A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
applicationKey (string) -- [REQUIRED]
Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API.
Dynatrace (dict) --
The connector-specific credentials required when using Dynatrace.
apiToken (string) -- [REQUIRED]
The API tokens used by Dynatrace API to authenticate various API calls.
GoogleAnalytics (dict) --
The connector-specific credentials required when using Google Analytics.
clientId (string) -- [REQUIRED]
The identifier for the desired client.
clientSecret (string) -- [REQUIRED]
The client secret used by the OAuth client to authenticate to the authorization server.
accessToken (string) --
The credentials used to access protected Google Analytics resources.
refreshToken (string) --
The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.
oAuthRequest (dict) --
The OAuth requirement needed to request security tokens from the connector endpoint.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
Honeycode (dict) --
The connector-specific credentials required when using Amazon Honeycode.
accessToken (string) --
The credentials used to access protected Amazon Honeycode resources.
refreshToken (string) --
The credentials used to acquire new access tokens.
oAuthRequest (dict) --
Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
InforNexus (dict) --
The connector-specific credentials required when using Infor Nexus.
accessKeyId (string) -- [REQUIRED]
The Access Key portion of the credentials.
userId (string) -- [REQUIRED]
The identifier for the user.
secretAccessKey (string) -- [REQUIRED]
The secret key used to sign requests.
datakey (string) -- [REQUIRED]
The encryption keys used to encrypt data.
Marketo (dict) --
The connector-specific credentials required when using Marketo.
clientId (string) -- [REQUIRED]
The identifier for the desired client.
clientSecret (string) -- [REQUIRED]
The client secret used by the OAuth client to authenticate to the authorization server.
accessToken (string) --
The credentials used to access protected Marketo resources.
oAuthRequest (dict) --
The OAuth requirement needed to request security tokens from the connector endpoint.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
Redshift (dict) --
The connector-specific credentials required when using Amazon Redshift.
username (string) --
The name of the user.
password (string) --
The password that corresponds to the user name.
Salesforce (dict) --
The connector-specific credentials required when using Salesforce.
accessToken (string) --
The credentials used to access protected Salesforce resources.
refreshToken (string) --
The credentials used to acquire new access tokens.
oAuthRequest (dict) --
The OAuth requirement needed to request security tokens from the connector endpoint.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
clientCredentialsArn (string) --
The secret manager ARN, which contains the client ID and client secret of the connected app.
oAuth2GrantType (string) --
Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
You can specify one of the following values:
AUTHORIZATION_CODE
Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.
CLIENT_CREDENTIALS
Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.
JWT_BEARER
Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.
jwtToken (string) --
A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.
ServiceNow (dict) --
The connector-specific credentials required when using ServiceNow.
username (string) -- [REQUIRED]
The name of the user.
password (string) -- [REQUIRED]
The password that corresponds to the user name.
Singular (dict) --
The connector-specific credentials required when using Singular.
apiKey (string) -- [REQUIRED]
A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
Slack (dict) --
The connector-specific credentials required when using Slack.
clientId (string) -- [REQUIRED]
The identifier for the client.
clientSecret (string) -- [REQUIRED]
The client secret used by the OAuth client to authenticate to the authorization server.
accessToken (string) --
The credentials used to access protected Slack resources.
oAuthRequest (dict) --
The OAuth requirement needed to request security tokens from the connector endpoint.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
Snowflake (dict) --
The connector-specific credentials required when using Snowflake.
username (string) -- [REQUIRED]
The name of the user.
password (string) -- [REQUIRED]
The password that corresponds to the user name.
Trendmicro (dict) --
The connector-specific credentials required when using Trend Micro.
apiSecretKey (string) -- [REQUIRED]
The Secret Access Key portion of the credentials.
Veeva (dict) --
The connector-specific credentials required when using Veeva.
username (string) -- [REQUIRED]
The name of the user.
password (string) -- [REQUIRED]
The password that corresponds to the user name.
Zendesk (dict) --
The connector-specific credentials required when using Zendesk.
clientId (string) -- [REQUIRED]
The identifier for the desired client.
clientSecret (string) -- [REQUIRED]
The client secret used by the OAuth client to authenticate to the authorization server.
accessToken (string) --
The credentials used to access protected Zendesk resources.
oAuthRequest (dict) --
The OAuth requirement needed to request security tokens from the connector endpoint.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
SAPOData (dict) --
The connector-specific profile credentials required when using SAPOData.
basicAuthCredentials (dict) --
The SAPOData basic authentication credentials.
username (string) -- [REQUIRED]
The username to use to connect to a resource.
password (string) -- [REQUIRED]
The password to use to connect to a resource.
oAuthCredentials (dict) --
The SAPOData OAuth type authentication credentials.
clientId (string) -- [REQUIRED]
The identifier for the desired client.
clientSecret (string) -- [REQUIRED]
The client secret used by the OAuth client to authenticate to the authorization server.
accessToken (string) --
The access token used to access protected SAPOData resources.
refreshToken (string) --
The refresh token used to refresh expired access token.
oAuthRequest (dict) --
The OAuth requirement needed to request security tokens from the connector endpoint.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
CustomConnector (dict) --
The connector-specific profile credentials that are required when using the custom connector.
authenticationType (string) -- [REQUIRED]
The authentication type that the custom connector uses for authenticating while creating a connector profile.
basic (dict) --
The basic credentials that are required for the authentication of the user.
username (string) -- [REQUIRED]
The username to use to connect to a resource.
password (string) -- [REQUIRED]
The password to use to connect to a resource.
oauth2 (dict) --
The OAuth 2.0 credentials required for the authentication of the user.
clientId (string) --
The identifier for the desired client.
clientSecret (string) --
The client secret used by the OAuth client to authenticate to the authorization server.
accessToken (string) --
The access token used to access the connector on your behalf.
refreshToken (string) --
The refresh token used to refresh an expired access token.
oAuthRequest (dict) --
Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
apiKey (dict) --
The API keys required for the authentication of the user.
apiKey (string) -- [REQUIRED]
The API key required for API key authentication.
apiSecretKey (string) --
The API secret key required for API key authentication.
custom (dict) --
If the connector uses the custom authentication mechanism, this holds the required credentials.
customAuthenticationType (string) -- [REQUIRED]
The custom authentication type that the connector uses.
credentialsMap (dict) --
A map that holds custom authentication credentials.
(string) --
(string) --
Pardot (dict) --
The connector-specific credentials required when using Salesforce Pardot.
accessToken (string) --
The credentials used to access protected Salesforce Pardot resources.
refreshToken (string) --
The credentials used to acquire new access tokens.
oAuthRequest (dict) --
Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
clientCredentialsArn (string) --
The secret manager ARN, which contains the client ID and client secret of the connected app.
string
The clientToken parameter is an idempotency token. It ensures that your CreateConnectorProfile request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.
If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.
If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken , Amazon AppFlow considers it a new call to CreateConnectorProfile . The token is active for 8 hours.
This field is autopopulated if not provided.
dict
Response Syntax
{
'connectorProfileArn': 'string'
}
Response Structure
(dict) --
connectorProfileArn (string) --
The Amazon Resource Name (ARN) of the connector profile.
{'connectorConfiguration': {'authenticationConfig': {'oAuth2Defaults': {'oauth2GrantTypesSupported': {'JWT_BEARER'}}},
'connectorMetadata': {'Salesforce': {'oauth2GrantTypesSupported': ['CLIENT_CREDENTIALS '
'| '
'AUTHORIZATION_CODE '
'| '
'JWT_BEARER']}}}}
Describes the given custom connector registered in your Amazon Web Services account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors.
See also: AWS API Documentation
Request Syntax
client.describe_connector(
connectorType='Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
connectorLabel='string'
)
string
[REQUIRED]
The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose CUSTOMCONNECTOR for Lambda based custom connectors.
string
The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
dict
Response Syntax
{
'connectorConfiguration': {
'canUseAsSource': True|False,
'canUseAsDestination': True|False,
'supportedDestinationConnectors': [
'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
],
'supportedSchedulingFrequencies': [
'BYMINUTE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'ONCE',
],
'isPrivateLinkEnabled': True|False,
'isPrivateLinkEndpointUrlRequired': True|False,
'supportedTriggerTypes': [
'Scheduled'|'Event'|'OnDemand',
],
'connectorMetadata': {
'Amplitude': {},
'Datadog': {},
'Dynatrace': {},
'GoogleAnalytics': {
'oAuthScopes': [
'string',
]
},
'InforNexus': {},
'Marketo': {},
'Redshift': {},
'S3': {},
'Salesforce': {
'oAuthScopes': [
'string',
],
'dataTransferApis': [
'AUTOMATIC'|'BULKV2'|'REST_SYNC',
],
'oauth2GrantTypesSupported': [
'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE'|'JWT_BEARER',
]
},
'ServiceNow': {},
'Singular': {},
'Slack': {
'oAuthScopes': [
'string',
]
},
'Snowflake': {
'supportedRegions': [
'string',
]
},
'Trendmicro': {},
'Veeva': {},
'Zendesk': {
'oAuthScopes': [
'string',
]
},
'EventBridge': {},
'Upsolver': {},
'CustomerProfiles': {},
'Honeycode': {
'oAuthScopes': [
'string',
]
},
'SAPOData': {},
'Pardot': {}
},
'connectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
'connectorLabel': 'string',
'connectorDescription': 'string',
'connectorOwner': 'string',
'connectorName': 'string',
'connectorVersion': 'string',
'connectorArn': 'string',
'connectorModes': [
'string',
],
'authenticationConfig': {
'isBasicAuthSupported': True|False,
'isApiKeyAuthSupported': True|False,
'isOAuth2Supported': True|False,
'isCustomAuthSupported': True|False,
'oAuth2Defaults': {
'oauthScopes': [
'string',
],
'tokenUrls': [
'string',
],
'authCodeUrls': [
'string',
],
'oauth2GrantTypesSupported': [
'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE'|'JWT_BEARER',
],
'oauth2CustomProperties': [
{
'key': 'string',
'isRequired': True|False,
'label': 'string',
'description': 'string',
'isSensitiveField': True|False,
'connectorSuppliedValues': [
'string',
],
'type': 'TOKEN_URL'|'AUTH_URL'
},
]
},
'customAuthConfigs': [
{
'customAuthenticationType': 'string',
'authParameters': [
{
'key': 'string',
'isRequired': True|False,
'label': 'string',
'description': 'string',
'isSensitiveField': True|False,
'connectorSuppliedValues': [
'string',
]
},
]
},
]
},
'connectorRuntimeSettings': [
{
'key': 'string',
'dataType': 'string',
'isRequired': True|False,
'label': 'string',
'description': 'string',
'scope': 'string',
'connectorSuppliedValueOptions': [
'string',
]
},
],
'supportedApiVersions': [
'string',
],
'supportedOperators': [
'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'CONTAINS'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
],
'supportedWriteOperations': [
'INSERT'|'UPSERT'|'UPDATE'|'DELETE',
],
'connectorProvisioningType': 'LAMBDA',
'connectorProvisioningConfig': {
'lambda': {
'lambdaArn': 'string'
}
},
'logoURL': 'string',
'registeredAt': datetime(2015, 1, 1),
'registeredBy': 'string'
}
}
Response Structure
(dict) --
connectorConfiguration (dict) --
Configuration info of all the connectors that the user requested.
canUseAsSource (boolean) --
Specifies whether the connector can be used as a source.
canUseAsDestination (boolean) --
Specifies whether the connector can be used as a destination.
supportedDestinationConnectors (list) --
Lists the connectors that are available for use as destinations.
(string) --
supportedSchedulingFrequencies (list) --
Specifies the supported flow frequency for that connector.
(string) --
isPrivateLinkEnabled (boolean) --
Specifies if PrivateLink is enabled for that connector.
isPrivateLinkEndpointUrlRequired (boolean) --
Specifies if a PrivateLink endpoint URL is required.
supportedTriggerTypes (list) --
Specifies the supported trigger types for the flow.
(string) --
connectorMetadata (dict) --
Specifies connector-specific metadata such as oAuthScopes , supportedRegions , privateLinkServiceUrl , and so on.
Amplitude (dict) --
The connector metadata specific to Amplitude.
Datadog (dict) --
The connector metadata specific to Datadog.
Dynatrace (dict) --
The connector metadata specific to Dynatrace.
GoogleAnalytics (dict) --
The connector metadata specific to Google Analytics.
oAuthScopes (list) --
The desired authorization scope for the Google Analytics account.
(string) --
InforNexus (dict) --
The connector metadata specific to Infor Nexus.
Marketo (dict) --
The connector metadata specific to Marketo.
Redshift (dict) --
The connector metadata specific to Amazon Redshift.
S3 (dict) --
The connector metadata specific to Amazon S3.
Salesforce (dict) --
The connector metadata specific to Salesforce.
oAuthScopes (list) --
The desired authorization scope for the Salesforce account.
(string) --
dataTransferApis (list) --
The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.
(string) --
oauth2GrantTypesSupported (list) --
The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
AUTHORIZATION_CODE
Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.
CLIENT_CREDENTIALS
Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.
JWT_BEARER
Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.
(string) --
ServiceNow (dict) --
The connector metadata specific to ServiceNow.
Singular (dict) --
The connector metadata specific to Singular.
Slack (dict) --
The connector metadata specific to Slack.
oAuthScopes (list) --
The desired authorization scope for the Slack account.
(string) --
Snowflake (dict) --
The connector metadata specific to Snowflake.
supportedRegions (list) --
Specifies the supported Amazon Web Services Regions when using Snowflake.
(string) --
Trendmicro (dict) --
The connector metadata specific to Trend Micro.
Veeva (dict) --
The connector metadata specific to Veeva.
Zendesk (dict) --
The connector metadata specific to Zendesk.
oAuthScopes (list) --
The desired authorization scope for the Zendesk account.
(string) --
EventBridge (dict) --
The connector metadata specific to Amazon EventBridge.
Upsolver (dict) --
The connector metadata specific to Upsolver.
CustomerProfiles (dict) --
The connector metadata specific to Amazon Connect Customer Profiles.
Honeycode (dict) --
The connector metadata specific to Amazon Honeycode.
oAuthScopes (list) --
The desired authorization scope for the Amazon Honeycode account.
(string) --
SAPOData (dict) --
The connector metadata specific to SAPOData.
Pardot (dict) --
The connector metadata specific to Salesforce Pardot.
connectorType (string) --
The connector type.
connectorLabel (string) --
The label used for registering the connector.
connectorDescription (string) --
A description about the connector.
connectorOwner (string) --
The owner who developed the connector.
connectorName (string) --
The connector name.
connectorVersion (string) --
The connector version.
connectorArn (string) --
The Amazon Resource Name (ARN) for the registered connector.
connectorModes (list) --
The connection modes that the connector supports.
(string) --
authenticationConfig (dict) --
The authentication config required for the connector.
isBasicAuthSupported (boolean) --
Indicates whether basic authentication is supported by the connector.
isApiKeyAuthSupported (boolean) --
Indicates whether API key authentication is supported by the connector
isOAuth2Supported (boolean) --
Indicates whether OAuth 2.0 authentication is supported by the connector.
isCustomAuthSupported (boolean) --
Indicates whether custom authentication is supported by the connector
oAuth2Defaults (dict) --
Contains the default values required for OAuth 2.0 authentication.
oauthScopes (list) --
OAuth 2.0 scopes that the connector supports.
(string) --
tokenUrls (list) --
Token URLs that can be used for OAuth 2.0 authentication.
(string) --
authCodeUrls (list) --
Auth code URLs that can be used for OAuth 2.0 authentication.
(string) --
oauth2GrantTypesSupported (list) --
OAuth 2.0 grant types supported by the connector.
(string) --
oauth2CustomProperties (list) --
List of custom parameters required for OAuth 2.0 authentication.
(dict) --
Custom parameter required for OAuth 2.0 authentication.
key (string) --
The key of the custom parameter required for OAuth 2.0 authentication.
isRequired (boolean) --
Indicates whether the custom parameter for OAuth 2.0 authentication is required.
label (string) --
The label of the custom parameter used for OAuth 2.0 authentication.
description (string) --
A description about the custom parameter used for OAuth 2.0 authentication.
isSensitiveField (boolean) --
Indicates whether this authentication custom parameter is a sensitive field.
connectorSuppliedValues (list) --
Contains default values for this authentication parameter that are supplied by the connector.
(string) --
type (string) --
Indicates whether custom parameter is used with TokenUrl or AuthUrl.
customAuthConfigs (list) --
Contains information required for custom authentication.
(dict) --
Configuration information required for custom authentication.
customAuthenticationType (string) --
The authentication type that the custom connector uses.
authParameters (list) --
Information about authentication parameters required for authentication.
(dict) --
Information about required authentication parameters.
key (string) --
The authentication key required to authenticate with the connector.
isRequired (boolean) --
Indicates whether this authentication parameter is required.
label (string) --
Label used for authentication parameter.
description (string) --
A description about the authentication parameter.
isSensitiveField (boolean) --
Indicates whether this authentication parameter is a sensitive field.
connectorSuppliedValues (list) --
Contains default values for this authentication parameter that are supplied by the connector.
(string) --
connectorRuntimeSettings (list) --
The required connector runtime settings.
(dict) --
Contains information about the connector runtime settings that are required for flow execution.
key (string) --
Contains value information about the connector runtime setting.
dataType (string) --
Data type of the connector runtime setting.
isRequired (boolean) --
Indicates whether this connector runtime setting is required.
label (string) --
A label used for connector runtime setting.
description (string) --
A description about the connector runtime setting.
scope (string) --
Indicates the scope of the connector runtime setting.
connectorSuppliedValueOptions (list) --
Contains default values for the connector runtime setting that are supplied by the connector.
(string) --
supportedApiVersions (list) --
A list of API versions that are supported by the connector.
(string) --
supportedOperators (list) --
A list of operators supported by the connector.
(string) --
supportedWriteOperations (list) --
A list of write operations supported by the connector.
(string) --
The possible write operations in the destination connector. When this value is not provided, this defaults to the INSERT operation.
connectorProvisioningType (string) --
The provisioning type used to register the connector.
connectorProvisioningConfig (dict) --
The configuration required for registering the connector.
lambda (dict) --
Contains information about the configuration of the lambda which is being registered as the connector.
lambdaArn (string) --
Lambda ARN of the connector being registered.
logoURL (string) --
Logo URL of the connector.
registeredAt (datetime) --
The date on which the connector was registered.
registeredBy (string) --
Information about who registered the connector.
{'connectorProfileDetails': {'connectorProfileProperties': {'CustomConnector': {'oAuth2Properties': {'oAuth2GrantType': {'JWT_BEARER'}}}}}}
Returns a list of connector-profile details matching the provided connector-profile names and connector-types . Both input lists are optional, and you can use them to filter the result.
If no names or connector-types are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.
See also: AWS API Documentation
Request Syntax
client.describe_connector_profiles(
connectorProfileNames=[
'string',
],
connectorType='Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
connectorLabel='string',
maxResults=123,
nextToken='string'
)
list
The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.
(string) --
string
The type of connector, such as Salesforce, Amplitude, and so on.
string
The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
integer
Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).
string
The pagination token for the next page of data.
dict
Response Syntax
{
'connectorProfileDetails': [
{
'connectorProfileArn': 'string',
'connectorProfileName': 'string',
'connectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
'connectorLabel': 'string',
'connectionMode': 'Public'|'Private',
'credentialsArn': 'string',
'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': 123,
'clientNumber': 'string',
'logonLanguage': 'string',
'privateLinkServiceName': 'string',
'oAuthProperties': {
'tokenUrl': 'string',
'authCodeUrl': 'string',
'oAuthScopes': [
'string',
]
}
},
'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'
}
},
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'privateConnectionProvisioningState': {
'status': 'FAILED'|'PENDING'|'CREATED',
'failureMessage': 'string',
'failureCause': 'CONNECTOR_AUTHENTICATION'|'CONNECTOR_SERVER'|'INTERNAL_SERVER'|'ACCESS_DENIED'|'VALIDATION'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
connectorProfileDetails (list) --
Returns information about the connector profiles associated with the flow.
(dict) --
Describes an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. To keep the API intuitive and extensible, the fields that are common to all types of connector profiles are explicitly specified at the top level. The rest of the connector-specific properties are available via the connectorProfileProperties field.
connectorProfileArn (string) --
The Amazon Resource Name (ARN) of the connector profile.
connectorProfileName (string) --
The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.
connectorType (string) --
The type of connector, such as Salesforce, Amplitude, and so on.
connectorLabel (string) --
The label for the connector profile being created.
connectionMode (string) --
Indicates the connection mode and if it is public or private.
credentialsArn (string) --
The Amazon Resource Name (ARN) of the connector profile credentials.
connectorProfileProperties (dict) --
The connector-specific properties of the profile configuration.
Amplitude (dict) --
The connector-specific properties required by Amplitude.
Datadog (dict) --
The connector-specific properties required by Datadog.
instanceUrl (string) --
The location of the Datadog resource.
Dynatrace (dict) --
The connector-specific properties required by Dynatrace.
instanceUrl (string) --
The location of the Dynatrace resource.
GoogleAnalytics (dict) --
The connector-specific properties required Google Analytics.
Honeycode (dict) --
The connector-specific properties required by Amazon Honeycode.
InforNexus (dict) --
The connector-specific properties required by Infor Nexus.
instanceUrl (string) --
The location of the Infor Nexus resource.
Marketo (dict) --
The connector-specific properties required by Marketo.
instanceUrl (string) --
The location of the Marketo resource.
Redshift (dict) --
The connector-specific properties required by Amazon Redshift.
databaseUrl (string) --
The JDBC URL of the Amazon Redshift cluster.
bucketName (string) --
A name for the associated Amazon S3 bucket.
bucketPrefix (string) --
The object key for the destination bucket in which Amazon AppFlow places the files.
roleArn (string) --
The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3. For more information, and for the polices that you attach to this role, see Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3 .
dataApiRoleArn (string) --
The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API. For more information, and for the polices that you attach to this role, see Allow Amazon AppFlow to access Amazon Redshift databases with the Data API .
isRedshiftServerless (boolean) --
Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.
clusterIdentifier (string) --
The unique ID that's assigned to an Amazon Redshift cluster.
workgroupName (string) --
The name of an Amazon Redshift workgroup.
databaseName (string) --
The name of an Amazon Redshift database.
Salesforce (dict) --
The connector-specific properties required by Salesforce.
instanceUrl (string) --
The location of the Salesforce resource.
isSandboxEnvironment (boolean) --
Indicates whether the connector profile applies to a sandbox or production environment.
usePrivateLinkForMetadataAndAuthorization (boolean) --
If the connection mode for the connector profile is private, this parameter sets whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce. Amazon AppFlow sends private calls through Amazon Web Services PrivateLink. These calls travel through Amazon Web Services infrastructure without being exposed to the public internet.
Set either of the following values:
true
Amazon AppFlow sends all calls to Salesforce over the private network.
These private calls are:
Calls to get metadata about your Salesforce records. This metadata describes your Salesforce objects and their fields.
Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce records.
Calls to transfer your Salesforce records as part of a flow run.
false
The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls over the public internet.
The public calls are:
Calls to get metadata about your Salesforce records.
Calls to get or refresh access tokens.
The private calls are:
Calls to transfer your Salesforce records as part of a flow run.
ServiceNow (dict) --
The connector-specific properties required by serviceNow.
instanceUrl (string) --
The location of the ServiceNow resource.
Singular (dict) --
The connector-specific properties required by Singular.
Slack (dict) --
The connector-specific properties required by Slack.
instanceUrl (string) --
The location of the Slack resource.
Snowflake (dict) --
The connector-specific properties required by Snowflake.
warehouse (string) --
The name of the Snowflake warehouse.
stage (string) --
The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: < Database>< Schema><Stage Name>.
bucketName (string) --
The name of the Amazon S3 bucket associated with Snowflake.
bucketPrefix (string) --
The bucket path that refers to the Amazon S3 bucket associated with Snowflake.
privateLinkServiceName (string) --
The Snowflake Private Link service name to be used for private data transfers.
accountName (string) --
The name of the account.
region (string) --
The Amazon Web Services Region of the Snowflake account.
Trendmicro (dict) --
The connector-specific properties required by Trend Micro.
Veeva (dict) --
The connector-specific properties required by Veeva.
instanceUrl (string) --
The location of the Veeva resource.
Zendesk (dict) --
The connector-specific properties required by Zendesk.
instanceUrl (string) --
The location of the Zendesk resource.
SAPOData (dict) --
The connector-specific profile properties required when using SAPOData.
applicationHostUrl (string) --
The location of the SAPOData resource.
applicationServicePath (string) --
The application path to catalog service.
portNumber (integer) --
The port number of the SAPOData instance.
clientNumber (string) --
The client number for the client creating the connection.
logonLanguage (string) --
The logon language of SAPOData instance.
privateLinkServiceName (string) --
The SAPOData Private Link service name to be used for private data transfers.
oAuthProperties (dict) --
The SAPOData OAuth properties required for OAuth type authentication.
tokenUrl (string) --
The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token.
authCodeUrl (string) --
The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication.
oAuthScopes (list) --
The OAuth scopes required for OAuth type authentication.
(string) --
CustomConnector (dict) --
The properties required by the custom connector.
profileProperties (dict) --
A map of properties that are required to create a profile for the custom connector.
(string) --
(string) --
oAuth2Properties (dict) --
The OAuth 2.0 properties required for OAuth 2.0 authentication.
tokenUrl (string) --
The token URL required for OAuth 2.0 authentication.
oAuth2GrantType (string) --
The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.
tokenUrlCustomProperties (dict) --
Associates your token URL with a map of properties that you define. Use this parameter to provide any additional details that the connector requires to authenticate your request.
(string) --
(string) --
Pardot (dict) --
The connector-specific properties required by Salesforce Pardot.
instanceUrl (string) --
The location of the Salesforce Pardot resource.
isSandboxEnvironment (boolean) --
Indicates whether the connector profile applies to a sandbox or production environment.
businessUnitId (string) --
The business unit id of Salesforce Pardot instance.
createdAt (datetime) --
Specifies when the connector profile was created.
lastUpdatedAt (datetime) --
Specifies when the connector profile was last updated.
privateConnectionProvisioningState (dict) --
Specifies the private connection provisioning state.
status (string) --
Specifies the private connection provisioning status.
failureMessage (string) --
Specifies the private connection provisioning failure reason.
failureCause (string) --
Specifies the private connection provisioning failure cause.
nextToken (string) --
The pagination token for the next page of data. If nextToken=null , this means that all records have been fetched.
{'connectorConfigurations': {'authenticationConfig': {'oAuth2Defaults': {'oauth2GrantTypesSupported': {'JWT_BEARER'}}},
'connectorMetadata': {'Salesforce': {'oauth2GrantTypesSupported': ['CLIENT_CREDENTIALS '
'| '
'AUTHORIZATION_CODE '
'| '
'JWT_BEARER']}}}}
Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page.
See also: AWS API Documentation
Request Syntax
client.describe_connectors(
connectorTypes=[
'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
],
maxResults=123,
nextToken='string'
)
list
The type of connector, such as Salesforce, Amplitude, and so on.
(string) --
integer
The maximum number of items that should be returned in the result set. The default is 20.
string
The pagination token for the next page of data.
dict
Response Syntax
{
'connectorConfigurations': {
'string': {
'canUseAsSource': True|False,
'canUseAsDestination': True|False,
'supportedDestinationConnectors': [
'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
],
'supportedSchedulingFrequencies': [
'BYMINUTE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'ONCE',
],
'isPrivateLinkEnabled': True|False,
'isPrivateLinkEndpointUrlRequired': True|False,
'supportedTriggerTypes': [
'Scheduled'|'Event'|'OnDemand',
],
'connectorMetadata': {
'Amplitude': {},
'Datadog': {},
'Dynatrace': {},
'GoogleAnalytics': {
'oAuthScopes': [
'string',
]
},
'InforNexus': {},
'Marketo': {},
'Redshift': {},
'S3': {},
'Salesforce': {
'oAuthScopes': [
'string',
],
'dataTransferApis': [
'AUTOMATIC'|'BULKV2'|'REST_SYNC',
],
'oauth2GrantTypesSupported': [
'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE'|'JWT_BEARER',
]
},
'ServiceNow': {},
'Singular': {},
'Slack': {
'oAuthScopes': [
'string',
]
},
'Snowflake': {
'supportedRegions': [
'string',
]
},
'Trendmicro': {},
'Veeva': {},
'Zendesk': {
'oAuthScopes': [
'string',
]
},
'EventBridge': {},
'Upsolver': {},
'CustomerProfiles': {},
'Honeycode': {
'oAuthScopes': [
'string',
]
},
'SAPOData': {},
'Pardot': {}
},
'connectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
'connectorLabel': 'string',
'connectorDescription': 'string',
'connectorOwner': 'string',
'connectorName': 'string',
'connectorVersion': 'string',
'connectorArn': 'string',
'connectorModes': [
'string',
],
'authenticationConfig': {
'isBasicAuthSupported': True|False,
'isApiKeyAuthSupported': True|False,
'isOAuth2Supported': True|False,
'isCustomAuthSupported': True|False,
'oAuth2Defaults': {
'oauthScopes': [
'string',
],
'tokenUrls': [
'string',
],
'authCodeUrls': [
'string',
],
'oauth2GrantTypesSupported': [
'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE'|'JWT_BEARER',
],
'oauth2CustomProperties': [
{
'key': 'string',
'isRequired': True|False,
'label': 'string',
'description': 'string',
'isSensitiveField': True|False,
'connectorSuppliedValues': [
'string',
],
'type': 'TOKEN_URL'|'AUTH_URL'
},
]
},
'customAuthConfigs': [
{
'customAuthenticationType': 'string',
'authParameters': [
{
'key': 'string',
'isRequired': True|False,
'label': 'string',
'description': 'string',
'isSensitiveField': True|False,
'connectorSuppliedValues': [
'string',
]
},
]
},
]
},
'connectorRuntimeSettings': [
{
'key': 'string',
'dataType': 'string',
'isRequired': True|False,
'label': 'string',
'description': 'string',
'scope': 'string',
'connectorSuppliedValueOptions': [
'string',
]
},
],
'supportedApiVersions': [
'string',
],
'supportedOperators': [
'PROJECTION'|'LESS_THAN'|'GREATER_THAN'|'CONTAINS'|'BETWEEN'|'LESS_THAN_OR_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'|'ADDITION'|'MULTIPLICATION'|'DIVISION'|'SUBTRACTION'|'MASK_ALL'|'MASK_FIRST_N'|'MASK_LAST_N'|'VALIDATE_NON_NULL'|'VALIDATE_NON_ZERO'|'VALIDATE_NON_NEGATIVE'|'VALIDATE_NUMERIC'|'NO_OP',
],
'supportedWriteOperations': [
'INSERT'|'UPSERT'|'UPDATE'|'DELETE',
],
'connectorProvisioningType': 'LAMBDA',
'connectorProvisioningConfig': {
'lambda': {
'lambdaArn': 'string'
}
},
'logoURL': 'string',
'registeredAt': datetime(2015, 1, 1),
'registeredBy': 'string'
}
},
'connectors': [
{
'connectorDescription': 'string',
'connectorName': 'string',
'connectorOwner': 'string',
'connectorVersion': 'string',
'applicationType': 'string',
'connectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
'connectorLabel': 'string',
'registeredAt': datetime(2015, 1, 1),
'registeredBy': 'string',
'connectorProvisioningType': 'LAMBDA',
'connectorModes': [
'string',
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
connectorConfigurations (dict) --
The configuration that is applied to the connectors used in the flow.
(string) --
(dict) --
The configuration settings related to a given connector.
canUseAsSource (boolean) --
Specifies whether the connector can be used as a source.
canUseAsDestination (boolean) --
Specifies whether the connector can be used as a destination.
supportedDestinationConnectors (list) --
Lists the connectors that are available for use as destinations.
(string) --
supportedSchedulingFrequencies (list) --
Specifies the supported flow frequency for that connector.
(string) --
isPrivateLinkEnabled (boolean) --
Specifies if PrivateLink is enabled for that connector.
isPrivateLinkEndpointUrlRequired (boolean) --
Specifies if a PrivateLink endpoint URL is required.
supportedTriggerTypes (list) --
Specifies the supported trigger types for the flow.
(string) --
connectorMetadata (dict) --
Specifies connector-specific metadata such as oAuthScopes , supportedRegions , privateLinkServiceUrl , and so on.
Amplitude (dict) --
The connector metadata specific to Amplitude.
Datadog (dict) --
The connector metadata specific to Datadog.
Dynatrace (dict) --
The connector metadata specific to Dynatrace.
GoogleAnalytics (dict) --
The connector metadata specific to Google Analytics.
oAuthScopes (list) --
The desired authorization scope for the Google Analytics account.
(string) --
InforNexus (dict) --
The connector metadata specific to Infor Nexus.
Marketo (dict) --
The connector metadata specific to Marketo.
Redshift (dict) --
The connector metadata specific to Amazon Redshift.
S3 (dict) --
The connector metadata specific to Amazon S3.
Salesforce (dict) --
The connector metadata specific to Salesforce.
oAuthScopes (list) --
The desired authorization scope for the Salesforce account.
(string) --
dataTransferApis (list) --
The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.
(string) --
oauth2GrantTypesSupported (list) --
The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
AUTHORIZATION_CODE
Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.
CLIENT_CREDENTIALS
Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.
JWT_BEARER
Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.
(string) --
ServiceNow (dict) --
The connector metadata specific to ServiceNow.
Singular (dict) --
The connector metadata specific to Singular.
Slack (dict) --
The connector metadata specific to Slack.
oAuthScopes (list) --
The desired authorization scope for the Slack account.
(string) --
Snowflake (dict) --
The connector metadata specific to Snowflake.
supportedRegions (list) --
Specifies the supported Amazon Web Services Regions when using Snowflake.
(string) --
Trendmicro (dict) --
The connector metadata specific to Trend Micro.
Veeva (dict) --
The connector metadata specific to Veeva.
Zendesk (dict) --
The connector metadata specific to Zendesk.
oAuthScopes (list) --
The desired authorization scope for the Zendesk account.
(string) --
EventBridge (dict) --
The connector metadata specific to Amazon EventBridge.
Upsolver (dict) --
The connector metadata specific to Upsolver.
CustomerProfiles (dict) --
The connector metadata specific to Amazon Connect Customer Profiles.
Honeycode (dict) --
The connector metadata specific to Amazon Honeycode.
oAuthScopes (list) --
The desired authorization scope for the Amazon Honeycode account.
(string) --
SAPOData (dict) --
The connector metadata specific to SAPOData.
Pardot (dict) --
The connector metadata specific to Salesforce Pardot.
connectorType (string) --
The connector type.
connectorLabel (string) --
The label used for registering the connector.
connectorDescription (string) --
A description about the connector.
connectorOwner (string) --
The owner who developed the connector.
connectorName (string) --
The connector name.
connectorVersion (string) --
The connector version.
connectorArn (string) --
The Amazon Resource Name (ARN) for the registered connector.
connectorModes (list) --
The connection modes that the connector supports.
(string) --
authenticationConfig (dict) --
The authentication config required for the connector.
isBasicAuthSupported (boolean) --
Indicates whether basic authentication is supported by the connector.
isApiKeyAuthSupported (boolean) --
Indicates whether API key authentication is supported by the connector
isOAuth2Supported (boolean) --
Indicates whether OAuth 2.0 authentication is supported by the connector.
isCustomAuthSupported (boolean) --
Indicates whether custom authentication is supported by the connector
oAuth2Defaults (dict) --
Contains the default values required for OAuth 2.0 authentication.
oauthScopes (list) --
OAuth 2.0 scopes that the connector supports.
(string) --
tokenUrls (list) --
Token URLs that can be used for OAuth 2.0 authentication.
(string) --
authCodeUrls (list) --
Auth code URLs that can be used for OAuth 2.0 authentication.
(string) --
oauth2GrantTypesSupported (list) --
OAuth 2.0 grant types supported by the connector.
(string) --
oauth2CustomProperties (list) --
List of custom parameters required for OAuth 2.0 authentication.
(dict) --
Custom parameter required for OAuth 2.0 authentication.
key (string) --
The key of the custom parameter required for OAuth 2.0 authentication.
isRequired (boolean) --
Indicates whether the custom parameter for OAuth 2.0 authentication is required.
label (string) --
The label of the custom parameter used for OAuth 2.0 authentication.
description (string) --
A description about the custom parameter used for OAuth 2.0 authentication.
isSensitiveField (boolean) --
Indicates whether this authentication custom parameter is a sensitive field.
connectorSuppliedValues (list) --
Contains default values for this authentication parameter that are supplied by the connector.
(string) --
type (string) --
Indicates whether custom parameter is used with TokenUrl or AuthUrl.
customAuthConfigs (list) --
Contains information required for custom authentication.
(dict) --
Configuration information required for custom authentication.
customAuthenticationType (string) --
The authentication type that the custom connector uses.
authParameters (list) --
Information about authentication parameters required for authentication.
(dict) --
Information about required authentication parameters.
key (string) --
The authentication key required to authenticate with the connector.
isRequired (boolean) --
Indicates whether this authentication parameter is required.
label (string) --
Label used for authentication parameter.
description (string) --
A description about the authentication parameter.
isSensitiveField (boolean) --
Indicates whether this authentication parameter is a sensitive field.
connectorSuppliedValues (list) --
Contains default values for this authentication parameter that are supplied by the connector.
(string) --
connectorRuntimeSettings (list) --
The required connector runtime settings.
(dict) --
Contains information about the connector runtime settings that are required for flow execution.
key (string) --
Contains value information about the connector runtime setting.
dataType (string) --
Data type of the connector runtime setting.
isRequired (boolean) --
Indicates whether this connector runtime setting is required.
label (string) --
A label used for connector runtime setting.
description (string) --
A description about the connector runtime setting.
scope (string) --
Indicates the scope of the connector runtime setting.
connectorSuppliedValueOptions (list) --
Contains default values for the connector runtime setting that are supplied by the connector.
(string) --
supportedApiVersions (list) --
A list of API versions that are supported by the connector.
(string) --
supportedOperators (list) --
A list of operators supported by the connector.
(string) --
supportedWriteOperations (list) --
A list of write operations supported by the connector.
(string) --
The possible write operations in the destination connector. When this value is not provided, this defaults to the INSERT operation.
connectorProvisioningType (string) --
The provisioning type used to register the connector.
connectorProvisioningConfig (dict) --
The configuration required for registering the connector.
lambda (dict) --
Contains information about the configuration of the lambda which is being registered as the connector.
lambdaArn (string) --
Lambda ARN of the connector being registered.
logoURL (string) --
Logo URL of the connector.
registeredAt (datetime) --
The date on which the connector was registered.
registeredBy (string) --
Information about who registered the connector.
connectors (list) --
Information about the connectors supported in Amazon AppFlow.
(dict) --
Information about the registered connector.
connectorDescription (string) --
A description about the registered connector.
connectorName (string) --
The name of the connector.
connectorOwner (string) --
The owner of the connector.
connectorVersion (string) --
The connector version.
applicationType (string) --
The application type of the connector.
connectorType (string) --
The connector type.
connectorLabel (string) --
A label used for the connector.
registeredAt (datetime) --
The time at which the connector was registered.
registeredBy (string) --
The user who registered the connector.
connectorProvisioningType (string) --
The provisioning type that the connector uses.
connectorModes (list) --
The connection mode that the connector supports.
(string) --
nextToken (string) --
The pagination token for the next page of data.
{'connectorProfileConfig': {'connectorProfileCredentials': {'Salesforce': {'jwtToken': 'string',
'oAuth2GrantType': 'CLIENT_CREDENTIALS '
'| '
'AUTHORIZATION_CODE '
'| '
'JWT_BEARER'}},
'connectorProfileProperties': {'CustomConnector': {'oAuth2Properties': {'oAuth2GrantType': {'JWT_BEARER'}}}}}}
Updates a given connector profile associated with your account.
See also: AWS API Documentation
Request Syntax
client.update_connector_profile(
connectorProfileName='string',
connectionMode='Public'|'Private',
connectorProfileConfig={
'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': 123,
'clientNumber': 'string',
'logonLanguage': 'string',
'privateLinkServiceName': 'string',
'oAuthProperties': {
'tokenUrl': 'string',
'authCodeUrl': 'string',
'oAuthScopes': [
'string',
]
}
},
'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'
},
'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'
}
}
},
clientToken='string'
)
string
[REQUIRED]
The name of the connector profile and is unique for each ConnectorProfile in the Amazon Web Services account.
string
[REQUIRED]
Indicates the connection mode and if it is public or private.
dict
[REQUIRED]
Defines the connector-specific profile configuration and credentials.
connectorProfileProperties (dict) -- [REQUIRED]
The connector-specific properties of the profile configuration.
Amplitude (dict) --
The connector-specific properties required by Amplitude.
Datadog (dict) --
The connector-specific properties required by Datadog.
instanceUrl (string) -- [REQUIRED]
The location of the Datadog resource.
Dynatrace (dict) --
The connector-specific properties required by Dynatrace.
instanceUrl (string) -- [REQUIRED]
The location of the Dynatrace resource.
GoogleAnalytics (dict) --
The connector-specific properties required Google Analytics.
Honeycode (dict) --
The connector-specific properties required by Amazon Honeycode.
InforNexus (dict) --
The connector-specific properties required by Infor Nexus.
instanceUrl (string) -- [REQUIRED]
The location of the Infor Nexus resource.
Marketo (dict) --
The connector-specific properties required by Marketo.
instanceUrl (string) -- [REQUIRED]
The location of the Marketo resource.
Redshift (dict) --
The connector-specific properties required by Amazon Redshift.
databaseUrl (string) --
The JDBC URL of the Amazon Redshift cluster.
bucketName (string) -- [REQUIRED]
A name for the associated Amazon S3 bucket.
bucketPrefix (string) --
The object key for the destination bucket in which Amazon AppFlow places the files.
roleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3. For more information, and for the polices that you attach to this role, see Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3 .
dataApiRoleArn (string) --
The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API. For more information, and for the polices that you attach to this role, see Allow Amazon AppFlow to access Amazon Redshift databases with the Data API .
isRedshiftServerless (boolean) --
Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.
clusterIdentifier (string) --
The unique ID that's assigned to an Amazon Redshift cluster.
workgroupName (string) --
The name of an Amazon Redshift workgroup.
databaseName (string) --
The name of an Amazon Redshift database.
Salesforce (dict) --
The connector-specific properties required by Salesforce.
instanceUrl (string) --
The location of the Salesforce resource.
isSandboxEnvironment (boolean) --
Indicates whether the connector profile applies to a sandbox or production environment.
usePrivateLinkForMetadataAndAuthorization (boolean) --
If the connection mode for the connector profile is private, this parameter sets whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce. Amazon AppFlow sends private calls through Amazon Web Services PrivateLink. These calls travel through Amazon Web Services infrastructure without being exposed to the public internet.
Set either of the following values:
true
Amazon AppFlow sends all calls to Salesforce over the private network.
These private calls are:
Calls to get metadata about your Salesforce records. This metadata describes your Salesforce objects and their fields.
Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce records.
Calls to transfer your Salesforce records as part of a flow run.
false
The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls over the public internet.
The public calls are:
Calls to get metadata about your Salesforce records.
Calls to get or refresh access tokens.
The private calls are:
Calls to transfer your Salesforce records as part of a flow run.
ServiceNow (dict) --
The connector-specific properties required by serviceNow.
instanceUrl (string) -- [REQUIRED]
The location of the ServiceNow resource.
Singular (dict) --
The connector-specific properties required by Singular.
Slack (dict) --
The connector-specific properties required by Slack.
instanceUrl (string) -- [REQUIRED]
The location of the Slack resource.
Snowflake (dict) --
The connector-specific properties required by Snowflake.
warehouse (string) -- [REQUIRED]
The name of the Snowflake warehouse.
stage (string) -- [REQUIRED]
The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: < Database>< Schema><Stage Name>.
bucketName (string) -- [REQUIRED]
The name of the Amazon S3 bucket associated with Snowflake.
bucketPrefix (string) --
The bucket path that refers to the Amazon S3 bucket associated with Snowflake.
privateLinkServiceName (string) --
The Snowflake Private Link service name to be used for private data transfers.
accountName (string) --
The name of the account.
region (string) --
The Amazon Web Services Region of the Snowflake account.
Trendmicro (dict) --
The connector-specific properties required by Trend Micro.
Veeva (dict) --
The connector-specific properties required by Veeva.
instanceUrl (string) -- [REQUIRED]
The location of the Veeva resource.
Zendesk (dict) --
The connector-specific properties required by Zendesk.
instanceUrl (string) -- [REQUIRED]
The location of the Zendesk resource.
SAPOData (dict) --
The connector-specific profile properties required when using SAPOData.
applicationHostUrl (string) -- [REQUIRED]
The location of the SAPOData resource.
applicationServicePath (string) -- [REQUIRED]
The application path to catalog service.
portNumber (integer) -- [REQUIRED]
The port number of the SAPOData instance.
clientNumber (string) -- [REQUIRED]
The client number for the client creating the connection.
logonLanguage (string) --
The logon language of SAPOData instance.
privateLinkServiceName (string) --
The SAPOData Private Link service name to be used for private data transfers.
oAuthProperties (dict) --
The SAPOData OAuth properties required for OAuth type authentication.
tokenUrl (string) -- [REQUIRED]
The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token.
authCodeUrl (string) -- [REQUIRED]
The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication.
oAuthScopes (list) -- [REQUIRED]
The OAuth scopes required for OAuth type authentication.
(string) --
CustomConnector (dict) --
The properties required by the custom connector.
profileProperties (dict) --
A map of properties that are required to create a profile for the custom connector.
(string) --
(string) --
oAuth2Properties (dict) --
The OAuth 2.0 properties required for OAuth 2.0 authentication.
tokenUrl (string) -- [REQUIRED]
The token URL required for OAuth 2.0 authentication.
oAuth2GrantType (string) -- [REQUIRED]
The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.
tokenUrlCustomProperties (dict) --
Associates your token URL with a map of properties that you define. Use this parameter to provide any additional details that the connector requires to authenticate your request.
(string) --
(string) --
Pardot (dict) --
The connector-specific properties required by Salesforce Pardot.
instanceUrl (string) --
The location of the Salesforce Pardot resource.
isSandboxEnvironment (boolean) --
Indicates whether the connector profile applies to a sandbox or production environment.
businessUnitId (string) --
The business unit id of Salesforce Pardot instance.
connectorProfileCredentials (dict) --
The connector-specific credentials required by each connector.
Amplitude (dict) --
The connector-specific credentials required when using Amplitude.
apiKey (string) -- [REQUIRED]
A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
secretKey (string) -- [REQUIRED]
The Secret Access Key portion of the credentials.
Datadog (dict) --
The connector-specific credentials required when using Datadog.
apiKey (string) -- [REQUIRED]
A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
applicationKey (string) -- [REQUIRED]
Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API.
Dynatrace (dict) --
The connector-specific credentials required when using Dynatrace.
apiToken (string) -- [REQUIRED]
The API tokens used by Dynatrace API to authenticate various API calls.
GoogleAnalytics (dict) --
The connector-specific credentials required when using Google Analytics.
clientId (string) -- [REQUIRED]
The identifier for the desired client.
clientSecret (string) -- [REQUIRED]
The client secret used by the OAuth client to authenticate to the authorization server.
accessToken (string) --
The credentials used to access protected Google Analytics resources.
refreshToken (string) --
The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.
oAuthRequest (dict) --
The OAuth requirement needed to request security tokens from the connector endpoint.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
Honeycode (dict) --
The connector-specific credentials required when using Amazon Honeycode.
accessToken (string) --
The credentials used to access protected Amazon Honeycode resources.
refreshToken (string) --
The credentials used to acquire new access tokens.
oAuthRequest (dict) --
Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
InforNexus (dict) --
The connector-specific credentials required when using Infor Nexus.
accessKeyId (string) -- [REQUIRED]
The Access Key portion of the credentials.
userId (string) -- [REQUIRED]
The identifier for the user.
secretAccessKey (string) -- [REQUIRED]
The secret key used to sign requests.
datakey (string) -- [REQUIRED]
The encryption keys used to encrypt data.
Marketo (dict) --
The connector-specific credentials required when using Marketo.
clientId (string) -- [REQUIRED]
The identifier for the desired client.
clientSecret (string) -- [REQUIRED]
The client secret used by the OAuth client to authenticate to the authorization server.
accessToken (string) --
The credentials used to access protected Marketo resources.
oAuthRequest (dict) --
The OAuth requirement needed to request security tokens from the connector endpoint.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
Redshift (dict) --
The connector-specific credentials required when using Amazon Redshift.
username (string) --
The name of the user.
password (string) --
The password that corresponds to the user name.
Salesforce (dict) --
The connector-specific credentials required when using Salesforce.
accessToken (string) --
The credentials used to access protected Salesforce resources.
refreshToken (string) --
The credentials used to acquire new access tokens.
oAuthRequest (dict) --
The OAuth requirement needed to request security tokens from the connector endpoint.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
clientCredentialsArn (string) --
The secret manager ARN, which contains the client ID and client secret of the connected app.
oAuth2GrantType (string) --
Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
You can specify one of the following values:
AUTHORIZATION_CODE
Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.
CLIENT_CREDENTIALS
Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.
JWT_BEARER
Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.
jwtToken (string) --
A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.
ServiceNow (dict) --
The connector-specific credentials required when using ServiceNow.
username (string) -- [REQUIRED]
The name of the user.
password (string) -- [REQUIRED]
The password that corresponds to the user name.
Singular (dict) --
The connector-specific credentials required when using Singular.
apiKey (string) -- [REQUIRED]
A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
Slack (dict) --
The connector-specific credentials required when using Slack.
clientId (string) -- [REQUIRED]
The identifier for the client.
clientSecret (string) -- [REQUIRED]
The client secret used by the OAuth client to authenticate to the authorization server.
accessToken (string) --
The credentials used to access protected Slack resources.
oAuthRequest (dict) --
The OAuth requirement needed to request security tokens from the connector endpoint.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
Snowflake (dict) --
The connector-specific credentials required when using Snowflake.
username (string) -- [REQUIRED]
The name of the user.
password (string) -- [REQUIRED]
The password that corresponds to the user name.
Trendmicro (dict) --
The connector-specific credentials required when using Trend Micro.
apiSecretKey (string) -- [REQUIRED]
The Secret Access Key portion of the credentials.
Veeva (dict) --
The connector-specific credentials required when using Veeva.
username (string) -- [REQUIRED]
The name of the user.
password (string) -- [REQUIRED]
The password that corresponds to the user name.
Zendesk (dict) --
The connector-specific credentials required when using Zendesk.
clientId (string) -- [REQUIRED]
The identifier for the desired client.
clientSecret (string) -- [REQUIRED]
The client secret used by the OAuth client to authenticate to the authorization server.
accessToken (string) --
The credentials used to access protected Zendesk resources.
oAuthRequest (dict) --
The OAuth requirement needed to request security tokens from the connector endpoint.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
SAPOData (dict) --
The connector-specific profile credentials required when using SAPOData.
basicAuthCredentials (dict) --
The SAPOData basic authentication credentials.
username (string) -- [REQUIRED]
The username to use to connect to a resource.
password (string) -- [REQUIRED]
The password to use to connect to a resource.
oAuthCredentials (dict) --
The SAPOData OAuth type authentication credentials.
clientId (string) -- [REQUIRED]
The identifier for the desired client.
clientSecret (string) -- [REQUIRED]
The client secret used by the OAuth client to authenticate to the authorization server.
accessToken (string) --
The access token used to access protected SAPOData resources.
refreshToken (string) --
The refresh token used to refresh expired access token.
oAuthRequest (dict) --
The OAuth requirement needed to request security tokens from the connector endpoint.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
CustomConnector (dict) --
The connector-specific profile credentials that are required when using the custom connector.
authenticationType (string) -- [REQUIRED]
The authentication type that the custom connector uses for authenticating while creating a connector profile.
basic (dict) --
The basic credentials that are required for the authentication of the user.
username (string) -- [REQUIRED]
The username to use to connect to a resource.
password (string) -- [REQUIRED]
The password to use to connect to a resource.
oauth2 (dict) --
The OAuth 2.0 credentials required for the authentication of the user.
clientId (string) --
The identifier for the desired client.
clientSecret (string) --
The client secret used by the OAuth client to authenticate to the authorization server.
accessToken (string) --
The access token used to access the connector on your behalf.
refreshToken (string) --
The refresh token used to refresh an expired access token.
oAuthRequest (dict) --
Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
apiKey (dict) --
The API keys required for the authentication of the user.
apiKey (string) -- [REQUIRED]
The API key required for API key authentication.
apiSecretKey (string) --
The API secret key required for API key authentication.
custom (dict) --
If the connector uses the custom authentication mechanism, this holds the required credentials.
customAuthenticationType (string) -- [REQUIRED]
The custom authentication type that the connector uses.
credentialsMap (dict) --
A map that holds custom authentication credentials.
(string) --
(string) --
Pardot (dict) --
The connector-specific credentials required when using Salesforce Pardot.
accessToken (string) --
The credentials used to access protected Salesforce Pardot resources.
refreshToken (string) --
The credentials used to acquire new access tokens.
oAuthRequest (dict) --
Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
authCode (string) --
The code provided by the connector when it has been authenticated via the connected app.
redirectUri (string) --
The URL to which the authentication server redirects the browser after authorization has been granted.
clientCredentialsArn (string) --
The secret manager ARN, which contains the client ID and client secret of the connected app.
string
The clientToken parameter is an idempotency token. It ensures that your UpdateConnectorProfile request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.
If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.
If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken , Amazon AppFlow considers it a new call to UpdateConnectorProfile . The token is active for 8 hours.
This field is autopopulated if not provided.
dict
Response Syntax
{
'connectorProfileArn': 'string'
}
Response Structure
(dict) --
connectorProfileArn (string) --
The Amazon Resource Name (ARN) of the connector profile.