aws_sdk_iottwinmaker/client/
create_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 [`CreateEntity`](crate::operation::create_entity::builders::CreateEntityFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`workspace_id(impl Into<String>)`](crate::operation::create_entity::builders::CreateEntityFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::create_entity::builders::CreateEntityFluentBuilder::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::create_entity::builders::CreateEntityFluentBuilder::entity_id) / [`set_entity_id(Option<String>)`](crate::operation::create_entity::builders::CreateEntityFluentBuilder::set_entity_id):<br>required: **false**<br><p>The ID of the entity.</p><br>
8    ///   - [`entity_name(impl Into<String>)`](crate::operation::create_entity::builders::CreateEntityFluentBuilder::entity_name) / [`set_entity_name(Option<String>)`](crate::operation::create_entity::builders::CreateEntityFluentBuilder::set_entity_name):<br>required: **true**<br><p>The name of the entity.</p><br>
9    ///   - [`description(impl Into<String>)`](crate::operation::create_entity::builders::CreateEntityFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_entity::builders::CreateEntityFluentBuilder::set_description):<br>required: **false**<br><p>The description of the entity.</p><br>
10    ///   - [`components(impl Into<String>, ComponentRequest)`](crate::operation::create_entity::builders::CreateEntityFluentBuilder::components) / [`set_components(Option<HashMap::<String, ComponentRequest>>)`](crate::operation::create_entity::builders::CreateEntityFluentBuilder::set_components):<br>required: **false**<br><p>An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.</p><br>
11    ///   - [`composite_components(impl Into<String>, CompositeComponentRequest)`](crate::operation::create_entity::builders::CreateEntityFluentBuilder::composite_components) / [`set_composite_components(Option<HashMap::<String, CompositeComponentRequest>>)`](crate::operation::create_entity::builders::CreateEntityFluentBuilder::set_composite_components):<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_id(impl Into<String>)`](crate::operation::create_entity::builders::CreateEntityFluentBuilder::parent_entity_id) / [`set_parent_entity_id(Option<String>)`](crate::operation::create_entity::builders::CreateEntityFluentBuilder::set_parent_entity_id):<br>required: **false**<br><p>The ID of the entity's parent entity.</p><br>
13    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_entity::builders::CreateEntityFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_entity::builders::CreateEntityFluentBuilder::set_tags):<br>required: **false**<br><p>Metadata that you can use to manage the entity.</p><br>
14    /// - On success, responds with [`CreateEntityOutput`](crate::operation::create_entity::CreateEntityOutput) with field(s):
15    ///   - [`entity_id(String)`](crate::operation::create_entity::CreateEntityOutput::entity_id): <p>The ID of the entity.</p>
16    ///   - [`arn(String)`](crate::operation::create_entity::CreateEntityOutput::arn): <p>The ARN of the entity.</p>
17    ///   - [`creation_date_time(DateTime)`](crate::operation::create_entity::CreateEntityOutput::creation_date_time): <p>The date and time when the entity was created.</p>
18    ///   - [`state(State)`](crate::operation::create_entity::CreateEntityOutput::state): <p>The current state of the entity.</p>
19    /// - On failure, responds with [`SdkError<CreateEntityError>`](crate::operation::create_entity::CreateEntityError)
20    pub fn create_entity(&self) -> crate::operation::create_entity::builders::CreateEntityFluentBuilder {
21        crate::operation::create_entity::builders::CreateEntityFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_iottwinmaker/client/create_entity.rs

aws_sdk_iottwinmaker/client/
create_entity.rs
