Skip to content

delete_custom_action_type async

delete_custom_action_type(
    category: ActionCategory,
    provider: ActionProvider,
    version: Version,
    *,
    config_overrides: Optional[AsyncCodePipelineClientConfig] = None,
) -> None

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

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.

Parameters:

  • category (ActionCategory) –

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

  • provider (ActionProvider) –

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

  • version (Version) –

    The version of the custom action to delete.

Raises:

Source code in docs_src/capo_codepipeline/_services/async_code_pipeline.py
async def delete_custom_action_type(
    self,
    category: "capo_codepipeline.types.action_category.ActionCategory",
    provider: "capo_codepipeline.types.action_provider.ActionProvider",
    version: "capo_codepipeline.types.version.Version",
    *,
    config_overrides: Optional[AsyncCodePipelineClientConfig] = None,
) -> None:
    """<p>Marks a custom action as deleted. <code>PollForJobs</code> for the custom action fails after the action is marked for deletion. Used for custom actions only.</p> <important> <p>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.</p> </important>

    Args:
        category: <p>The category of the custom action that you want to delete, such as source or deploy.</p>
        provider: <p>The provider of the service used in the custom action, such as CodeDeploy.</p>
        version: <p>The version of the custom action to delete.</p>

    Raises:
        capo_codepipeline.errors.concurrent_modification_exception.ConcurrentModificationException: <p>Unable to modify the tag due to a simultaneous update request.</p>
        capo_codepipeline.errors.validation_exception.ValidationException: <p>The validation was specified in an invalid format.</p>
        capo_codepipeline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codepipeline.types.delete_custom_action_type_input.DeleteCustomActionTypeInput]",
    ) -> AsyncOperationResponse[None]:
        import capo_codepipeline._operations.code_pipeline_20150709.delete_custom_action_type

        (
            output,
            http_response,
        ) = await capo_codepipeline._operations.code_pipeline_20150709.delete_custom_action_type.async_delete_custom_action_type(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteCustomActionType")
    )
    input_: capo_codepipeline.types.delete_custom_action_type_input.DeleteCustomActionTypeInput = {
        "category": category,
        "provider": provider,
        "version": version,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output