DescribeConnector

Describes the given custom connector registered in your AWS account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors.

Request Syntax

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

{
   "connectorLabel": "string",
   "connectorType": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "connectorConfiguration": { 
      "authenticationConfig": { 
         "customAuthConfigs": [ 
            { 
               "authParameters": [ 
                  { 
                     "connectorSuppliedValues": [ "string" ],
                     "description": "string",
                     "isRequired": boolean,
                     "isSensitiveField": boolean,
                     "key": "string",
                     "label": "string"
                  }
               ],
               "customAuthenticationType": "string"
            }
         ],
         "isApiKeyAuthSupported": boolean,
         "isBasicAuthSupported": boolean,
         "isCustomAuthSupported": boolean,
         "isOAuth2Supported": boolean,
         "oAuth2Defaults": { 
            "authCodeUrls": [ "string" ],
            "oauth2CustomProperties": [ 
               { 
                  "connectorSuppliedValues": [ "string" ],
                  "description": "string",
                  "isRequired": boolean,
                  "isSensitiveField": boolean,
                  "key": "string",
                  "label": "string",
                  "type": "string"
               }
            ],
            "oauth2GrantTypesSupported": [ "string" ],
            "oauthScopes": [ "string" ],
            "tokenUrls": [ "string" ]
         }
      },
      "canUseAsDestination": boolean,
      "canUseAsSource": boolean,
      "connectorArn": "string",
      "connectorDescription": "string",
      "connectorLabel": "string",
      "connectorMetadata": { 
         "Amplitude": { 
         },
         "CustomerProfiles": { 
         },
         "Datadog": { 
         },
         "Dynatrace": { 
         },
         "EventBridge": { 
         },
         "GoogleAnalytics": { 
            "oAuthScopes": [ "string" ]
         },
         "Honeycode": { 
            "oAuthScopes": [ "string" ]
         },
         "InforNexus": { 
         },
         "Marketo": { 
         },
         "Pardot": { 
         },
         "Redshift": { 
         },
         "S3": { 
         },
         "Salesforce": { 
            "dataTransferApis": [ "string" ],
            "oauth2GrantTypesSupported": [ "string" ],
            "oAuthScopes": [ "string" ]
         },
         "SAPOData": { 
         },
         "ServiceNow": { 
         },
         "Singular": { 
         },
         "Slack": { 
            "oAuthScopes": [ "string" ]
         },
         "Snowflake": { 
            "supportedRegions": [ "string" ]
         },
         "Trendmicro": { 
         },
         "Upsolver": { 
         },
         "Veeva": { 
         },
         "Zendesk": { 
            "oAuthScopes": [ "string" ]
         }
      },
      "connectorModes": [ "string" ],
      "connectorName": "string",
      "connectorOwner": "string",
      "connectorProvisioningConfig": { 
         "lambda": { 
            "lambdaArn": "string"
         }
      },
      "connectorProvisioningType": "string",
      "connectorRuntimeSettings": [ 
         { 
            "connectorSuppliedValueOptions": [ "string" ],
            "dataType": "string",
            "description": "string",
            "isRequired": boolean,
            "key": "string",
            "label": "string",
            "scope": "string"
         }
      ],
      "connectorType": "string",
      "connectorVersion": "string",
      "isPrivateLinkEnabled": boolean,
      "isPrivateLinkEndpointUrlRequired": boolean,
      "logoURL": "string",
      "registeredAt": number,
      "registeredBy": "string",
      "supportedApiVersions": [ "string" ],
      "supportedDataTransferApis": [ 
         { 
            "Name": "string",
            "Type": "string"
         }
      ],
      "supportedDataTransferTypes": [ "string" ],
      "supportedDestinationConnectors": [ "string" ],
      "supportedOperators": [ "string" ],
      "supportedSchedulingFrequencies": [ "string" ],
      "supportedTriggerTypes": [ "string" ],
      "supportedWriteOperations": [ "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.

Errors

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

Examples

Describing the given connector

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

Sample Request

{
  "connectorType": "connectorType",
  "connectorLabel": "connectorLabel"
}

Sample Response

{
  "connectorConfiguration":
  {
    "authenticationConfig": null,
    "canUseAsDestination": true,
    "canUseAsSource": true,
    "connectorArn": null,
    "connectorDescription": "Salesforce",
    "connectorLabel": null,
    "connectorMetadata":
    {
      "Amplitude": null,
      "AppIntegrations": null,
      "CustomerProfiles": null,
      "Datadog": null,
      "Dynatrace": null,
      "EventBridge": null,
      "GoogleAnalytics": null,
      "Honeycode": null,
      "InforNexus": null,
      "Locke": null,
      "Marketo": null,
      "Pardot": null,
      "Redshift": null,
      "S3": null,
      "SAPOData": null,
      "Salesforce":
      {
        "oAuthScopes":
        [
          "api",
          "refresh_token",
          "id"
        ]
      },
      "ServiceNow": null,
      "Singular": null,
      "Slack": null,
      "Snowflake": null,
      "Trendmicro": null,
      "Upsolver": null,
      "Veeva": null,
      "Zendesk": null
    },
    "connectorModes": null,
    "connectorName": null,
    "connectorOwner": null,
    "connectorProvisioningConfig": null,
    "connectorProvisioningType": null,
    "connectorRuntimeSettings": null,
    "connectorType": "SALESFORCE",
    "connectorVersion": null,
    "isPrivateLinkEnabled": true,
    "isPrivateLinkEndpointUrlRequired": false,
    "logoURL": "insert-logo-here",
    "registeredAt": null,
    "registeredBy": null,
    "supportedApiVersions": null,
    "supportedDestinationConnectors":
    [
      "S3",
      "Snowflake",
      "Redshift",
      "Salesforce",
      "EventBridge",
      "LookoutMetrics",
      "Locke",
      "Honeycode",
      "Upsolver",
      "CustomerProfiles",
      "Zendesk",
      "Marketo",
      "CustomConnector"
    ],
    "supportedOperators": null,
    "supportedSchedulingFrequencies":
    [
      "BYMINUTE",
      "HOURLY",
      "DAILY",
      "WEEKLY",
      "MONTHLY",
      "ONCE"
    ],
    "supportedTriggerTypes":
    [
      "Scheduled",
      "OnDemand",
      "Event"
    ],
    "supportedWriteOperations": null
  }
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: