POST

/update-connector-profile

http://appflow.{region}.amazonaws.com/update-connector-profile

Updates a given connector profile associated with your account.

Access Token Required: API Key

Body Params

clientTokenstring

The <code>clientToken</code> parameter is an idempotency token. It ensures that your <code>UpdateConnectorProfile</code> 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 <code>clientToken</code> parameter value. If you omit a <code>clientToken</code> 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 <code>clientToken</code>, Amazon AppFlow considers it a new call to <code>UpdateConnectorProfile</code>. The token is active for 8 hours.

connectionModestringrequired

Indicates the connection mode and if it is public or private.

connectorProfileNamestringrequired

The name of the connector profile and is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account.

connectorProfileConfigobjectrequired

Defines the connector-specific configuration and credentials for the connector profile.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://appflow.{region}.amazonaws.com/update-connector-profile' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}