Skip to content

delete_protection_group

delete_protection_group(
    protection_group_id: ProtectionGroupId,
    *,
    config_overrides: Optional[ShieldClientConfig] = None,
) -> DeleteProtectionGroupResponse

Removes the specified protection group.

Parameters:

  • protection_group_id (ProtectionGroupId) –

    The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Raises:

  • InternalErrorException –

    Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

  • OptimisticLockException –

    Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.

  • ResourceNotFoundException –

    Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_shield/_services/shield.py
def delete_protection_group(
    self,
    protection_group_id: "capo_shield.types.protection_group_id.ProtectionGroupId",
    *,
    config_overrides: Optional[ShieldClientConfig] = None,
) -> "capo_shield.types.delete_protection_group_response.DeleteProtectionGroupResponse":
    """<p>Removes the specified protection group.</p>

    Args:
        protection_group_id: <p>The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it. </p>

    Raises:
        capo_shield.errors.internal_error_exception.InternalErrorException: <p>Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.</p>
        capo_shield.errors.optimistic_lock_exception.OptimisticLockException: <p>Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.</p>
        capo_shield.errors.resource_not_found_exception.ResourceNotFoundException: <p>Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties. </p>
        capo_shield.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_shield.types.delete_protection_group_request.DeleteProtectionGroupRequest]",
    ) -> OperationResponse[
        "capo_shield.types.delete_protection_group_response.DeleteProtectionGroupResponse"
    ]:
        import capo_shield._operations.aws_shield_20160616.delete_protection_group

        output, http_response = (
            capo_shield._operations.aws_shield_20160616.delete_protection_group.delete_protection_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteProtectionGroup")
    )
    input_: capo_shield.types.delete_protection_group_request.DeleteProtectionGroupRequest = {
        "protection_group_id": protection_group_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output