delete_core_device ¶

delete_core_device(
    core_device_thing_name: CoreDeviceThingName,
    *,
    config_overrides: Optional[GreengrassV2ClientConfig] = None,
) -> None

Deletes a Greengrass core device, which is an IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the IoT thing. For more information about how to delete the IoT thing, see DeleteThing in the IoT API Reference.

Parameters:

core_device_thing_name (CoreDeviceThingName) –

The name of the core device. This is also the name of the IoT thing.

Raises:

AccessDeniedException –

You don't have permission to perform the action.
ConflictException –

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
InternalServerException –

IoT Greengrass can't process your request right now. Try again later.
ResourceNotFoundException –

The requested resource can't be found.
ThrottlingException –

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.
ValidationException –

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
UnknownServiceError –

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

Source code in docs_src/capo_greengrassv2/_services/greengrass_v2.py

def delete_core_device(
    self,
    core_device_thing_name: "capo_greengrassv2.types.core_device_thing_name.CoreDeviceThingName",
    *,
    config_overrides: Optional[GreengrassV2ClientConfig] = None,
) -> None:
    """<p>Deletes a Greengrass core device, which is an IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the IoT thing. For more information about how to delete the IoT thing, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteThing.html">DeleteThing</a> in the <i>IoT API Reference</i>.</p>

    Args:
        core_device_thing_name: <p>The name of the core device. This is also the name of the IoT thing.</p>

    Raises:
        capo_greengrassv2.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action.</p>
        capo_greengrassv2.errors.conflict_exception.ConflictException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
        capo_greengrassv2.errors.internal_server_exception.InternalServerException: <p>IoT Greengrass can't process your request right now. Try again later.</p>
        capo_greengrassv2.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_greengrassv2.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.</p>
        capo_greengrassv2.errors.validation_exception.ValidationException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
        capo_greengrassv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_greengrassv2.types.delete_core_device_request.DeleteCoreDeviceRequest]",
    ) -> OperationResponse[None]:
        import capo_greengrassv2._operations.greengrass_v2.delete_core_device

        output, http_response = (
            capo_greengrassv2._operations.greengrass_v2.delete_core_device.delete_core_device(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteCoreDevice")
    )
    input_: capo_greengrassv2.types.delete_core_device_request.DeleteCoreDeviceRequest = {
        "core_device_thing_name": core_device_thing_name
    }

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