aws_sdk_iottwinmaker/client/
update_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 [`UpdateEntity`](crate::operation::update_entity::builders::UpdateEntityFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`workspace_id(impl Into<String>)`](crate::operation::update_entity::builders::UpdateEntityFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::update_entity::builders::UpdateEntityFluentBuilder::set_workspace_id):<br>required: **true**<br><p>The ID of the workspace that contains the entity.</p><br>
7    ///   - [`entity_id(impl Into<String>)`](crate::operation::update_entity::builders::UpdateEntityFluentBuilder::entity_id) / [`set_entity_id(Option<String>)`](crate::operation::update_entity::builders::UpdateEntityFluentBuilder::set_entity_id):<br>required: **true**<br><p>The ID of the entity.</p><br>
8    ///   - [`entity_name(impl Into<String>)`](crate::operation::update_entity::builders::UpdateEntityFluentBuilder::entity_name) / [`set_entity_name(Option<String>)`](crate::operation::update_entity::builders::UpdateEntityFluentBuilder::set_entity_name):<br>required: **false**<br><p>The name of the entity.</p><br>
9    ///   - [`description(impl Into<String>)`](crate::operation::update_entity::builders::UpdateEntityFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_entity::builders::UpdateEntityFluentBuilder::set_description):<br>required: **false**<br><p>The description of the entity.</p><br>
10    ///   - [`component_updates(impl Into<String>, ComponentUpdateRequest)`](crate::operation::update_entity::builders::UpdateEntityFluentBuilder::component_updates) / [`set_component_updates(Option<HashMap::<String, ComponentUpdateRequest>>)`](crate::operation::update_entity::builders::UpdateEntityFluentBuilder::set_component_updates):<br>required: **false**<br><p>An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.</p><br>
11    ///   - [`composite_component_updates(impl Into<String>, CompositeComponentUpdateRequest)`](crate::operation::update_entity::builders::UpdateEntityFluentBuilder::composite_component_updates) / [`set_composite_component_updates(Option<HashMap::<String, CompositeComponentUpdateRequest>>)`](crate::operation::update_entity::builders::UpdateEntityFluentBuilder::set_composite_component_updates):<br>required: **false**<br><p>This is an object that maps strings to <code>compositeComponent</code> updates in the request. Each key of the map represents the <code>componentPath</code> of the <code>compositeComponent</code>.</p><br>
12    ///   - [`parent_entity_update(ParentEntityUpdateRequest)`](crate::operation::update_entity::builders::UpdateEntityFluentBuilder::parent_entity_update) / [`set_parent_entity_update(Option<ParentEntityUpdateRequest>)`](crate::operation::update_entity::builders::UpdateEntityFluentBuilder::set_parent_entity_update):<br>required: **false**<br><p>An object that describes the update request for a parent entity.</p><br>
13    /// - On success, responds with [`UpdateEntityOutput`](crate::operation::update_entity::UpdateEntityOutput) with field(s):
14    ///   - [`update_date_time(DateTime)`](crate::operation::update_entity::UpdateEntityOutput::update_date_time): <p>The date and time when the entity was last updated.</p>
15    ///   - [`state(State)`](crate::operation::update_entity::UpdateEntityOutput::state): <p>The current state of the entity update.</p>
16    /// - On failure, responds with [`SdkError<UpdateEntityError>`](crate::operation::update_entity::UpdateEntityError)
17    pub fn update_entity(&self) -> crate::operation::update_entity::builders::UpdateEntityFluentBuilder {
18        crate::operation::update_entity::builders::UpdateEntityFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_iottwinmaker/client/update_entity.rs

aws_sdk_iottwinmaker/client/
update_entity.rs
