Skip to content

deregister_devices

deregister_devices(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    device_fleet_name: Optional[EntityName] = None,
    device_names: Optional[DeviceNames] = None,
) -> None

Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.

Parameters:

  • device_fleet_name (Optional[EntityName], default: None ) –

    The name of the fleet the devices belong to.

  • device_names (Optional[DeviceNames], default: None ) –

    The unique IDs of the devices.

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def deregister_devices(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    device_fleet_name: Optional[
        "capo_sagemaker.types.entity_name.EntityName"
    ] = None,
    device_names: Optional["capo_sagemaker.types.device_names.DeviceNames"] = None,
) -> None:
    """<p>Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.</p>

    Args:
        device_fleet_name: <p>The name of the fleet the devices belong to.</p>
        device_names: <p>The unique IDs of the devices.</p>

    Raises:
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.deregister_devices_request.DeregisterDevicesRequest]",
    ) -> OperationResponse[None]:
        import capo_sagemaker._operations.sage_maker.deregister_devices

        output, http_response = (
            capo_sagemaker._operations.sage_maker.deregister_devices.deregister_devices(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeregisterDevices")
    )
    input_: capo_sagemaker.types.deregister_devices_request.DeregisterDevicesRequest = {}
    if device_fleet_name is not None:
        input_["device_fleet_name"] = device_fleet_name
    if device_names is not None:
        input_["device_names"] = device_names

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