Container for the parameters to the DeleteCustomActionType operation.
Marks a custom action as deleted.
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.
PollForJobs for the custom action fails after
the action is marked for deletion. Used for custom actions only.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CodePipeline.AmazonCodePipelineRequest
Amazon.CodePipeline.Model.DeleteCustomActionTypeRequest
Namespace: Amazon.CodePipeline.Model
Assembly: AWSSDK.CodePipeline.dll
Version: 3.x.y.z
Syntax
public class DeleteCustomActionTypeRequest : AmazonCodePipelineRequest IAmazonWebServiceRequest
The DeleteCustomActionTypeRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DeleteCustomActionTypeRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Category | Amazon.CodePipeline.ActionCategory |
Gets and sets the property Category. The category of the custom action that you want to delete, such as source or deploy. |
|
|
Provider | System.String |
Gets and sets the property Provider. The provider of the service used in the custom action, such as CodeDeploy. |
|
|
Version | System.String |
Gets and sets the property Version. The version of the custom action to delete. |
Examples
This example deletes a custom action in AWS CodePipeline by specifiying the action type, provider name, and version number of the action to be deleted. Only used for custom actions. Use the list-action-types command to view the correct values for category, version, and provider. After a custom action is deleted, PollForJobs for the custom action will fail. Warning: You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.
Delete a custom action
var client = new AmazonCodePipelineClient();
var response = client.DeleteCustomActionType(new DeleteCustomActionTypeRequest
{
Version = "1", // This is the current version number of the custom action.
Category = "Build", // This is the type of action that the custom action is, for example build or test.
Provider = "MyJenkinsProviderName" // This is the provider of the service used in the custom action. In this example, the custom action is for a Jenkins build, and the name of the provider is the one configured in the AWS CodePipeline Plugin for Jenkins
});
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5