Menu
AWS CodePipeline
API Reference (API Version 2015-07-09)

DeleteCustomActionType

Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.

Important

You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.

Request Syntax

{
   "category": "string",
   "provider": "string",
   "version": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

category

The category of the custom action that you want to delete, such as source or deploy.

Type: String

Valid Values: Source | Build | Deploy | Test | Invoke | Approval

Required: Yes

provider

The provider of the service used in the custom action, such as AWS CodeDeploy.

Type: String

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

Pattern: [0-9A-Za-z_-]+

Required: Yes

version

The version of the custom action to delete.

Type: String

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

Pattern: [0-9A-Za-z_-]+

Required: Yes

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

The validation was specified in an invalid format.

HTTP Status Code: 400

Example

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 68
X-Amz-Target: CodePipeline_20150709.DeleteCustomActionType
X-Amz-Date: 20151030T233944Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151030/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "category": "Build",
  "version": "1",
  "provider": "JenkinsProviderName"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 0

See Also

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