UpdateConnectorProfile
Updates a given connector profile associated with your account.
Request Syntax
POST /update-connector-profile HTTP/1.1
Content-type: application/json
{
"connectionMode": "string
",
"connectorProfileConfig": {
"connectorProfileCredentials": {
"Amplitude": {
"apiKey": "string
",
"secretKey": "string
"
},
"Datadog": {
"apiKey": "string
",
"applicationKey": "string
"
},
"Dynatrace": {
"apiToken": "string
"
},
"GoogleAnalytics": {
"accessToken": "string
",
"clientId": "string
",
"clientSecret": "string
",
"oAuthRequest": {
"authCode": "string
",
"redirectUri": "string
"
},
"refreshToken": "string
"
},
"Honeycode": {
"accessToken": "string
",
"oAuthRequest": {
"authCode": "string
",
"redirectUri": "string
"
},
"refreshToken": "string
"
},
"InforNexus": {
"accessKeyId": "string
",
"datakey": "string
",
"secretAccessKey": "string
",
"userId": "string
"
},
"Marketo": {
"accessToken": "string
",
"clientId": "string
",
"clientSecret": "string
",
"oAuthRequest": {
"authCode": "string
",
"redirectUri": "string
"
}
},
"Redshift": {
"password": "string
",
"username": "string
"
},
"Salesforce": {
"accessToken": "string
",
"clientCredentialsArn": "string
",
"oAuthRequest": {
"authCode": "string
",
"redirectUri": "string
"
},
"refreshToken": "string
"
},
"ServiceNow": {
"password": "string
",
"username": "string
"
},
"Singular": {
"apiKey": "string
"
},
"Slack": {
"accessToken": "string
",
"clientId": "string
",
"clientSecret": "string
",
"oAuthRequest": {
"authCode": "string
",
"redirectUri": "string
"
}
},
"Snowflake": {
"password": "string
",
"username": "string
"
},
"Trendmicro": {
"apiSecretKey": "string
"
},
"Veeva": {
"password": "string
",
"username": "string
"
},
"Zendesk": {
"accessToken": "string
",
"clientId": "string
",
"clientSecret": "string
",
"oAuthRequest": {
"authCode": "string
",
"redirectUri": "string
"
}
}
},
"connectorProfileProperties": {
"Amplitude": {
},
"Datadog": {
"instanceUrl": "string
"
},
"Dynatrace": {
"instanceUrl": "string
"
},
"GoogleAnalytics": {
},
"Honeycode": {
},
"InforNexus": {
"instanceUrl": "string
"
},
"Marketo": {
"instanceUrl": "string
"
},
"Redshift": {
"bucketName": "string
",
"bucketPrefix": "string
",
"databaseUrl": "string
",
"roleArn": "string
"
},
"Salesforce": {
"instanceUrl": "string
",
"isSandboxEnvironment": boolean
},
"ServiceNow": {
"instanceUrl": "string
"
},
"Singular": {
},
"Slack": {
"instanceUrl": "string
"
},
"Snowflake": {
"accountName": "string
",
"bucketName": "string
",
"bucketPrefix": "string
",
"privateLinkServiceName": "string
",
"region": "string
",
"stage": "string
",
"warehouse": "string
"
},
"Trendmicro": {
},
"Veeva": {
"instanceUrl": "string
"
},
"Zendesk": {
"instanceUrl": "string
"
}
}
},
"connectorProfileName": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- connectionMode
-
Indicates the connection mode and if it is public or private.
Type: String
Valid Values:
Public | Private
Required: Yes
- connectorProfileConfig
-
Defines the connector-specific profile configuration and credentials.
Type: ConnectorProfileConfig object
Required: Yes
- connectorProfileName
-
The name of the connector profile and is unique for each
ConnectorProfile
in the AWS Account.Type: String
Length Constraints: Maximum length of 256.
Pattern:
[\w/!@#+=.-]+
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"connectorProfileArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- connectorProfileArn
-
The Amazon Resource Name (ARN) of the connector profile.
Type: String
Length Constraints: Maximum length of 512.
Pattern:
arn:aws:kms:.*:[0-9]+:.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.
HTTP Status Code: 409
- ConnectorAuthenticationException
-
An error occurred when authenticating with the connector endpoint.
HTTP Status Code: 401
- InternalServerException
-
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource specified in the request (such as the source or destination connector profile) is not found.
HTTP Status Code: 404
- ValidationException
-
The request has invalid or missing parameters.
HTTP Status Code: 400
Examples
UpdateConnectorProfile example using Salesforce
This example shows a sample request and response for the UpdateConnectorProfile
API using Salesforce.
Sample Request
{
"connectorProfileName": "Connector_Profile_Name_value",
"kmsArn": null,
"connectorType": "Salesforce",
"connectionMode": "Public",
"connectorProfileConfig": {
"connectorProfileProperties": {
"salesforce": {
"instanceUrl": "Instance_url_value",
"isSandboxEnvironment": false
}
},
"connectorProfileCredentials": {
"salesforce": {
"accessToken": "<AccessToken>",
"refreshToken": "<RefreshToken>",
"oauthRequest": {
"authCode": null,
"redirectUri": null
}
}
}
}
}
Sample Response
{
"connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connector-profile/Connector_Profile_Name"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: