aws_sdk_workmail/client/describe_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 [`DescribeEntity`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`organization_id(impl Into<String>)`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::set_organization_id):<br>required: **true**<br><p>The identifier for the organization under which the entity exists.</p><br>
7 /// - [`email(impl Into<String>)`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::email) / [`set_email(Option<String>)`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::set_email):<br>required: **true**<br><p>The email under which the entity exists.</p><br>
8 /// - On success, responds with [`DescribeEntityOutput`](crate::operation::describe_entity::DescribeEntityOutput) with field(s):
9 /// - [`entity_id(Option<String>)`](crate::operation::describe_entity::DescribeEntityOutput::entity_id): <p>The entity ID under which the entity exists.</p>
10 /// - [`name(Option<String>)`](crate::operation::describe_entity::DescribeEntityOutput::name): <p>Username, GroupName, or ResourceName based on entity type.</p>
11 /// - [`r#type(Option<EntityType>)`](crate::operation::describe_entity::DescribeEntityOutput::type): <p>Entity type.</p>
12 /// - On failure, responds with [`SdkError<DescribeEntityError>`](crate::operation::describe_entity::DescribeEntityError)
13 pub fn describe_entity(&self) -> crate::operation::describe_entity::builders::DescribeEntityFluentBuilder {
14 crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::new(self.handle.clone())
15 }
16}