Skip to content

delete_device async

delete_device(
    global_network_id: GlobalNetworkId,
    device_id: DeviceId,
    *,
    config_overrides: Optional[AsyncNetworkManagerClientConfig] = None,
) -> DeleteDeviceResponse

Deletes an existing device. You must first disassociate the device from any links and customer gateways.

Parameters:

  • global_network_id (GlobalNetworkId) –

    The ID of the global network.

  • device_id (DeviceId) –

    The ID of the device.

Raises:

Source code in docs_src/capo_networkmanager/_services/async_network_manager.py
async def delete_device(
    self,
    global_network_id: "capo_networkmanager.types.global_network_id.GlobalNetworkId",
    device_id: "capo_networkmanager.types.device_id.DeviceId",
    *,
    config_overrides: Optional[AsyncNetworkManagerClientConfig] = None,
) -> "capo_networkmanager.types.delete_device_response.DeleteDeviceResponse":
    """<p>Deletes an existing device. You must first disassociate the device from any links and customer gateways.</p>

    Args:
        global_network_id: <p>The ID of the global network.</p>
        device_id: <p>The ID of the device.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_networkmanager.types.delete_device_request.DeleteDeviceRequest]",
    ) -> AsyncOperationResponse[
        "capo_networkmanager.types.delete_device_response.DeleteDeviceResponse"
    ]:
        import capo_networkmanager._operations.network_manager.delete_device

        (
            output,
            http_response,
        ) = await capo_networkmanager._operations.network_manager.delete_device.async_delete_device(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

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

        return capo_networkmanager.types.delete_device_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DeleteDevice", redact_output=_redact_output),
    )
    input_: capo_networkmanager.types.delete_device_request.DeleteDeviceRequest = {
        "global_network_id": global_network_id,
        "device_id": device_id,
    }

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