AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

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

Note:

For PCL this operation is only available in asynchronous form. Please refer to DeleteCustomActionTypeAsync.

Namespace: Amazon.CodePipeline
Assembly: AWSSDK.CodePipeline.dll
Version: 3.x.y.z

Syntax

C#
public virtual DeleteCustomActionTypeResponse DeleteCustomActionType(
         DeleteCustomActionTypeRequest request
)
Parameters
request
Type: Amazon.CodePipeline.Model.DeleteCustomActionTypeRequest

Container for the necessary parameters to execute the DeleteCustomActionType service method.

Return Value
The response from the DeleteCustomActionType service method, as returned by CodePipeline.

Exceptions

ExceptionCondition
ValidationException The validation was specified in an invalid format.

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 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 Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also