aws_sdk_iottwinmaker/client/
delete_entity.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DeleteEntity`](crate::operation::delete_entity::builders::DeleteEntityFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`workspace_id(impl Into<String>)`](crate::operation::delete_entity::builders::DeleteEntityFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::delete_entity::builders::DeleteEntityFluentBuilder::set_workspace_id):<br>required: **true**<br><p>The ID of the workspace that contains the entity to delete.</p><br>
7    ///   - [`entity_id(impl Into<String>)`](crate::operation::delete_entity::builders::DeleteEntityFluentBuilder::entity_id) / [`set_entity_id(Option<String>)`](crate::operation::delete_entity::builders::DeleteEntityFluentBuilder::set_entity_id):<br>required: **true**<br><p>The ID of the entity to delete.</p><br>
8    ///   - [`is_recursive(bool)`](crate::operation::delete_entity::builders::DeleteEntityFluentBuilder::is_recursive) / [`set_is_recursive(Option<bool>)`](crate::operation::delete_entity::builders::DeleteEntityFluentBuilder::set_is_recursive):<br>required: **false**<br><p>A Boolean value that specifies whether the operation deletes child entities.</p><br>
9    /// - On success, responds with [`DeleteEntityOutput`](crate::operation::delete_entity::DeleteEntityOutput) with field(s):
10    ///   - [`state(State)`](crate::operation::delete_entity::DeleteEntityOutput::state): <p>The current state of the deleted entity.</p>
11    /// - On failure, responds with [`SdkError<DeleteEntityError>`](crate::operation::delete_entity::DeleteEntityError)
12    pub fn delete_entity(&self) -> crate::operation::delete_entity::builders::DeleteEntityFluentBuilder {
13        crate::operation::delete_entity::builders::DeleteEntityFluentBuilder::new(self.handle.clone())
14    }
15}