AWS CodeStar Notifications
Welcome (API Version 2019-10-15)

DeleteTarget

Deletes a specified target for notifications.

Request Syntax

POST /deleteTarget HTTP/1.1 Content-type: application/json { "ForceUnsubscribeAll": boolean, "TargetAddress": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ForceUnsubscribeAll

A Boolean value that can be used to delete all associations with this SNS topic. The default value is FALSE. If set to TRUE, all associations between that target and every notification rule in your AWS account are deleted.

Type: Boolean

Required: No

TargetAddress

The Amazon Resource Name (ARN) of the SNS topic to delete.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 320.

Required: Yes

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.

ValidationException

One or more parameter values are not valid.

HTTP Status Code: 400

See Also

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