Deletes the shadow for the specified thing.
Requires permission to access the DeleteThingShadow action.
For more information, see DeleteThingShadow in the IoT Developer Guide.
Parameters:
Raises:
Source code in docs_src/capo_iot_data_plane/_services/io_t_data_plane.py
| def delete_thing_shadow(
self,
thing_name: "capo_iot_data_plane.types.thing_name.ThingName",
*,
config_overrides: Optional[IoTDataPlaneClientConfig] = None,
shadow_name: Optional[
"capo_iot_data_plane.types.shadow_name.ShadowName"
] = None,
) -> "capo_iot_data_plane.types.delete_thing_shadow_response.DeleteThingShadowResponse":
"""<p>Deletes the shadow for the specified thing.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteThingShadow</a> action.</p> <p>For more information, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html">DeleteThingShadow</a> in the IoT Developer Guide.</p>
Args:
thing_name: <p>The name of the thing.</p>
shadow_name: <p>The name of the shadow.</p>
Raises:
capo_iot_data_plane.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
capo_iot_data_plane.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
capo_iot_data_plane.errors.method_not_allowed_exception.MethodNotAllowedException: <p>The specified combination of HTTP verb and URI is not supported.</p>
capo_iot_data_plane.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
capo_iot_data_plane.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
capo_iot_data_plane.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
capo_iot_data_plane.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
capo_iot_data_plane.errors.unsupported_document_encoding_exception.UnsupportedDocumentEncodingException: <p>The document encoding is not supported.</p>
capo_iot_data_plane.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_iot_data_plane.types.delete_thing_shadow_request.DeleteThingShadowRequest]",
) -> OperationResponse[
"capo_iot_data_plane.types.delete_thing_shadow_response.DeleteThingShadowResponse"
]:
import capo_iot_data_plane._operations.iot_moonraker_service.delete_thing_shadow
output, http_response = (
capo_iot_data_plane._operations.iot_moonraker_service.delete_thing_shadow.delete_thing_shadow(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteThingShadow")
)
input_: capo_iot_data_plane.types.delete_thing_shadow_request.DeleteThingShadowRequest = {
"thing_name": thing_name
}
if shadow_name is not None:
input_["shadow_name"] = shadow_name
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|