aws_sdk_iottwinmaker/client/
get_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 [`GetEntity`](crate::operation::get_entity::builders::GetEntityFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`workspace_id(impl Into<String>)`](crate::operation::get_entity::builders::GetEntityFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::get_entity::builders::GetEntityFluentBuilder::set_workspace_id):<br>required: **true**<br><p>The ID of the workspace.</p><br>
7    ///   - [`entity_id(impl Into<String>)`](crate::operation::get_entity::builders::GetEntityFluentBuilder::entity_id) / [`set_entity_id(Option<String>)`](crate::operation::get_entity::builders::GetEntityFluentBuilder::set_entity_id):<br>required: **true**<br><p>The ID of the entity.</p><br>
8    /// - On success, responds with [`GetEntityOutput`](crate::operation::get_entity::GetEntityOutput) with field(s):
9    ///   - [`entity_id(String)`](crate::operation::get_entity::GetEntityOutput::entity_id): <p>The ID of the entity.</p>
10    ///   - [`entity_name(String)`](crate::operation::get_entity::GetEntityOutput::entity_name): <p>The name of the entity.</p>
11    ///   - [`arn(String)`](crate::operation::get_entity::GetEntityOutput::arn): <p>The ARN of the entity.</p>
12    ///   - [`status(Option<Status>)`](crate::operation::get_entity::GetEntityOutput::status): <p>The current status of the entity.</p>
13    ///   - [`workspace_id(String)`](crate::operation::get_entity::GetEntityOutput::workspace_id): <p>The ID of the workspace.</p>
14    ///   - [`description(Option<String>)`](crate::operation::get_entity::GetEntityOutput::description): <p>The description of the entity.</p>
15    ///   - [`components(Option<HashMap::<String, ComponentResponse>>)`](crate::operation::get_entity::GetEntityOutput::components): <p>An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.</p>
16    ///   - [`parent_entity_id(String)`](crate::operation::get_entity::GetEntityOutput::parent_entity_id): <p>The ID of the parent entity for this entity.</p>
17    ///   - [`has_child_entities(bool)`](crate::operation::get_entity::GetEntityOutput::has_child_entities): <p>A Boolean value that specifies whether the entity has associated child entities.</p>
18    ///   - [`creation_date_time(DateTime)`](crate::operation::get_entity::GetEntityOutput::creation_date_time): <p>The date and time when the entity was created.</p>
19    ///   - [`update_date_time(DateTime)`](crate::operation::get_entity::GetEntityOutput::update_date_time): <p>The date and time when the entity was last updated.</p>
20    ///   - [`sync_source(Option<String>)`](crate::operation::get_entity::GetEntityOutput::sync_source): <p>The syncSource of the sync job, if this entity was created by a sync job.</p>
21    ///   - [`are_all_components_returned(Option<bool>)`](crate::operation::get_entity::GetEntityOutput::are_all_components_returned): <p>This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.</p>
22    /// - On failure, responds with [`SdkError<GetEntityError>`](crate::operation::get_entity::GetEntityError)
23    pub fn get_entity(&self) -> crate::operation::get_entity::builders::GetEntityFluentBuilder {
24        crate::operation::get_entity::builders::GetEntityFluentBuilder::new(self.handle.clone())
25    }
26}
aws_sdk_iottwinmaker/client/get_entity.rs

aws_sdk_iottwinmaker/client/
get_entity.rs
