Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

DescribeConnectorProfiles

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.

Request Syntax


POST /describe-connector-profiles HTTP/1.1
Content-type: application/json

{
   "connectorLabel": "string",
   "connectorProfileNames": [ "string" ],
   "connectorType": "string",
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

connectorLabel

The name of the connector. The name is unique for each ConnectorRegistration in your AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: No

connectorProfileNames

The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Maximum length of 256.

Pattern: [\w/!@#+=.-]+

Required: No

connectorType

The type of connector, such as Salesforce, Amplitude, and so on.

Type: String

Required: No

maxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The pagination token for the next page of data.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "connectorProfileDetails": [ 
      { 
         "connectionMode": "string",
         "connectorLabel": "string",
         "connectorProfileArn": "string",
         "connectorProfileName": "string",
         "connectorProfileProperties": { 
            "Amplitude": { 
            },
            "CustomConnector": { 
               "oAuth2Properties": { 
                  "oAuth2GrantType": "string",
                  "tokenUrl": "string",
                  "tokenUrlCustomProperties": { 
                     "string" : "string" 
                  }
               },
               "profileProperties": { 
                  "string" : "string" 
               }
            },
            "Datadog": { 
               "instanceUrl": "string"
            },
            "Dynatrace": { 
               "instanceUrl": "string"
            },
            "GoogleAnalytics": { 
            },
            "Honeycode": { 
            },
            "InforNexus": { 
               "instanceUrl": "string"
            },
            "Marketo": { 
               "instanceUrl": "string"
            },
            "Redshift": { 
               "bucketName": "string",
               "bucketPrefix": "string",
               "clusterIdentifier": "string",
               "dataApiRoleArn": "string",
               "databaseName": "string",
               "databaseUrl": "string",
               "isRedshiftServerless": boolean,
               "roleArn": "string",
               "workgroupName": "string"
            },
            "Salesforce": { 
               "instanceUrl": "string",
               "isSandboxEnvironment": boolean
            },
            "SAPOData": { 
               "applicationHostUrl": "string",
               "applicationServicePath": "string",
               "clientNumber": "string",
               "logonLanguage": "string",
               "oAuthProperties": { 
                  "authCodeUrl": "string",
                  "oAuthScopes": [ "string" ],
                  "tokenUrl": "string"
               },
               "portNumber": number,
               "privateLinkServiceName": "string"
            },
            "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"
            }
         },
         "connectorType": "string",
         "createdAt": number,
         "credentialsArn": "string",
         "lastUpdatedAt": number,
         "privateConnectionProvisioningState": { 
            "failureCause": "string",
            "failureMessage": "string",
            "status": "string"
         }
      }
   ],
   "nextToken": "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.

connectorProfileDetails

Returns information about the connector profiles associated with the flow.

Type: Array of ConnectorProfile objects

nextToken

The pagination token for the next page of data. If nextToken=null, this means that all records have been fetched.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

DescribeConnectorProfiles example

This example shows a sample request and response for the DescribeConnectorProfiles API.

Sample Request


{
  "connectorProfileNames": ["OldMarketoProfile","non-existing-name"],
  "connectorTypes": ["Marketo","Salesforce"]
}

Sample Response


{
  "connectorProfileDetails": [
    {
      "arn": "arn:aws:appflow:region:<AccountId>:connectorprofile/OldMarketoProfile",
      "configuration": {
        "api_version": "v1",
        "connection_mode": "Public",
        "credentials_arn": "arn:aws:secretsmanager:region:<AccountId>:secret:<secret>",
        "instanceUrl": "MarketoUrl"
      },
      "connectionMode": "Public",
      "connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/OldMarketoProfile",
      "connectorProfileName": "OldMarketoProfile",
      "connectorProfileProps": {
        "Amplitude": null,
        "Datadog": null,
        "Dynatrace": null,
        "GoogleAnalytics": null,
        "InforNexus": null,
        "Marketo": {
          "apiVersion": "v1",
          "instanceUrl": "MarketoUrl"
        },
        "Redshift": null,
        "Salesforce": null,
        "ServiceNow": null,
        "Singular": null,
        "Slack": null,
        "Snowflake": null,
        "Trendmicro": null,
        "Veeva": null,
        "Zendesk": null
      },
      "connectorType": "Marketo",
      "createdAt": "created_at_value",
      "credentialsArn": "arn:aws:secretsmanager:region:<AccountId>:secret:<secret>",
      "label": "OldMarketoProfile",
      "lastUpdated": "lastupdated_value",
      "lastUpdatedAt": "lastupdated_at_value"
    }
  ],
  "nextToken": null
}

DescribeConnectorProfiles example

This example shows a sample request and response for the DescribeConnectorProfiles API.

Sample Request


{
   "connectorProfileNames": ["OldMarketoProfile", "non-existing-name"],
   "connectorTypes": ["Marketo", "Salesforce", "CustomConnector"],
   "connectorLabel": "MyCustomConnectorLabel"
}

Sample Response


{
  "connectorProfileDetails": [
    {
      "arn": "arn:aws:appflow:region:<AccountId>:connectorprofile/OldMarketoProfile",
      "configuration":
      {
        "api_version": "v1",
        "connection_mode": "Public",
        "credentials_arn": "arn:aws:secretsmanager:region:<AccountId>:secret:<secret>",
        "instanceUrl": "MarketoUrl"
      },
      "connectionMode": "Public",
      "connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/OldMarketoProfile",
      "connectorProfileName": "OldMarketoProfile",
      "connectorProfileProps":
      {
        "Amplitude": null,
        "Datadog": null,
        "Dynatrace": null,
        "GoogleAnalytics": null,
        "InforNexus": null,
        "Marketo":
        {
          "apiVersion": "v1",
          "instanceUrl": "MarketoUrl"
        },
        "Redshift": null,
        "Salesforce": null,
        "ServiceNow": null,
        "Singular": null,
        "Slack": null,
        "Snowflake": null,
        "Trendmicro": null,
        "Veeva": null,
        "Zendesk": null
      },
      "connectorType": "Marketo",
      "createdAt": "2022-02-22T15:31:41.467000-08:00",
      "credentialsArn": "arn:aws:secretsmanager:region:<AccountId>:secret:<secret>",
      "label": "OldMarketoProfile",
      "lastUpdatedAt": "2022-02-22T15:31:41.467000-08:00"
    }
  ],
  "nextToken": null
}