aws_sdk_workmail/client/
describe_entity.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeEntity`](crate::operation::describe_entity::builders::DescribeEntityFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`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>
    ///   - [`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>
    /// - On success, responds with [`DescribeEntityOutput`](crate::operation::describe_entity::DescribeEntityOutput) with field(s):
    ///   - [`entity_id(Option<String>)`](crate::operation::describe_entity::DescribeEntityOutput::entity_id): <p>The entity ID under which the entity exists.</p>
    ///   - [`name(Option<String>)`](crate::operation::describe_entity::DescribeEntityOutput::name): <p>Username, GroupName, or ResourceName based on entity type.</p>
    ///   - [`r#type(Option<EntityType>)`](crate::operation::describe_entity::DescribeEntityOutput::type): <p>Entity type.</p>
    /// - On failure, responds with [`SdkError<DescribeEntityError>`](crate::operation::describe_entity::DescribeEntityError)
    pub fn describe_entity(&self) -> crate::operation::describe_entity::builders::DescribeEntityFluentBuilder {
        crate::operation::describe_entity::builders::DescribeEntityFluentBuilder::new(self.handle.clone())
    }
}