Skip to content

delete_ip_group

delete_ip_group(
    group_id: IpGroupId, *, config_overrides: Optional[WorkSpacesClientConfig] = None
) -> DeleteIpGroupResult

Deletes the specified IP access control group.

You cannot delete an IP access control group that is associated with a directory.

Parameters:

  • group_id (IpGroupId) –

    The identifier of the IP access control group.

Raises:

Source code in docs_src/capo_workspaces/_services/work_spaces.py
def delete_ip_group(
    self,
    group_id: "capo_workspaces.types.ip_group_id.IpGroupId",
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
) -> "capo_workspaces.types.delete_ip_group_result.DeleteIpGroupResult":
    """<p>Deletes the specified IP access control group.</p> <p>You cannot delete an IP access control group that is associated with a directory.</p>

    Args:
        group_id: <p>The identifier of the IP access control group.</p>

    Raises:
        capo_workspaces.errors.access_denied_exception.AccessDeniedException: <p>The user is not authorized to access a resource.</p>
        capo_workspaces.errors.invalid_parameter_values_exception.InvalidParameterValuesException: <p>One or more parameter values are not valid.</p>
        capo_workspaces.errors.resource_associated_exception.ResourceAssociatedException: <p>The resource is associated with a directory.</p>
        capo_workspaces.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces.types.delete_ip_group_request.DeleteIpGroupRequest]",
    ) -> OperationResponse[
        "capo_workspaces.types.delete_ip_group_result.DeleteIpGroupResult"
    ]:
        import capo_workspaces._operations.workspaces_service.delete_ip_group

        output, http_response = (
            capo_workspaces._operations.workspaces_service.delete_ip_group.delete_ip_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteIpGroup")
    )
    input_: capo_workspaces.types.delete_ip_group_request.DeleteIpGroupRequest = {
        "group_id": group_id
    }

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