DeleteCustomActionType - CodePipeline
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DeleteCustomActionType

Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only.

Important

To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.

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

Type: String

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

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.

ConcurrentModificationException

Unable to modify the tag due to a simultaneous update request.

HTTP Status Code: 400

ValidationException

The validation was specified in an invalid format.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DeleteCustomActionType.

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 Amazon SDKs, see the following: