UnregisterConnector - AmazonAppFlow

UnregisterConnector

Unregisters the custom connector registered in your account that matches the connectorLabel provided in the request.

Request Syntax

POST /unregister-connector HTTP/1.1 Content-type: application/json { "connectorLabel": "string", "forceDelete": boolean }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

connectorLabel

The label of the connector. The label is unique for each ConnectorRegistration in your AWS account.

Type: String

Length Constraints: Maximum length of 256.

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

Required: Yes

forceDelete

Indicates whether Amazon AppFlow should unregister the connector, even if it is currently in use in one or more connector profiles. The default value is false.

Type: Boolean

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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

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

Examples

Unregister connectors

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

Sample Request

{ "connectorLabel": "MySampleCustomConnector", "forceDelete": true }
{ "message": "Conflict executing request: Connector: MySampleCustomConnector is associated with one or more connector profiles. If you still want to *delete* it, *then* make *delete* request *with* forceDelete flag *as* true. *Some* of the associated connector profiles are: [myTestProfile1, myTestProfile2]" }

See Also

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