Skip to content

delete_site

delete_site(
    global_network_id: GlobalNetworkId,
    site_id: SiteId,
    *,
    config_overrides: Optional[NetworkManagerClientConfig] = None,
) -> DeleteSiteResponse

Deletes an existing site. The site cannot be associated with any device or link.

Parameters:

  • global_network_id (GlobalNetworkId) –

    The ID of the global network.

  • site_id (SiteId) –

    The ID of the site.

Raises:

Source code in docs_src/capo_networkmanager/_services/network_manager.py
def delete_site(
    self,
    global_network_id: "capo_networkmanager.types.global_network_id.GlobalNetworkId",
    site_id: "capo_networkmanager.types.site_id.SiteId",
    *,
    config_overrides: Optional[NetworkManagerClientConfig] = None,
) -> "capo_networkmanager.types.delete_site_response.DeleteSiteResponse":
    """<p>Deletes an existing site. The site cannot be associated with any device or link.</p>

    Args:
        global_network_id: <p>The ID of the global network.</p>
        site_id: <p>The ID of the site.</p>

    Raises:
        capo_networkmanager.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_networkmanager.errors.conflict_exception.ConflictException: <p>There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.</p>
        capo_networkmanager.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal error.</p>
        capo_networkmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found.</p>
        capo_networkmanager.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_networkmanager.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints.</p>
        capo_networkmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_networkmanager.types.delete_site_request.DeleteSiteRequest]",
    ) -> OperationResponse[
        "capo_networkmanager.types.delete_site_response.DeleteSiteResponse"
    ]:
        import capo_networkmanager._operations.network_manager.delete_site

        output, http_response = (
            capo_networkmanager._operations.network_manager.delete_site.delete_site(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_networkmanager.types.delete_site_response.DeleteSiteResponse",
    ) -> dict[str, Any]:
        import capo_networkmanager.types.delete_site_response

        return capo_networkmanager.types.delete_site_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DeleteSite", redact_output=_redact_output),
    )
    input_: capo_networkmanager.types.delete_site_request.DeleteSiteRequest = {
        "global_network_id": global_network_id,
        "site_id": site_id,
    }

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