aws_sdk_workmail/client/
describe_organization.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeOrganization`](crate::operation::describe_organization::builders::DescribeOrganizationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`organization_id(impl Into<String>)`](crate::operation::describe_organization::builders::DescribeOrganizationFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::describe_organization::builders::DescribeOrganizationFluentBuilder::set_organization_id):<br>required: **true**<br><p>The identifier for the organization to be described.</p><br>
    /// - On success, responds with [`DescribeOrganizationOutput`](crate::operation::describe_organization::DescribeOrganizationOutput) with field(s):
    ///   - [`organization_id(Option<String>)`](crate::operation::describe_organization::DescribeOrganizationOutput::organization_id): <p>The identifier of an organization.</p>
    ///   - [`alias(Option<String>)`](crate::operation::describe_organization::DescribeOrganizationOutput::alias): <p>The alias for an organization.</p>
    ///   - [`state(Option<String>)`](crate::operation::describe_organization::DescribeOrganizationOutput::state): <p>The state of an organization.</p>
    ///   - [`directory_id(Option<String>)`](crate::operation::describe_organization::DescribeOrganizationOutput::directory_id): <p>The identifier for the directory associated with an WorkMail organization.</p>
    ///   - [`directory_type(Option<String>)`](crate::operation::describe_organization::DescribeOrganizationOutput::directory_type): <p>The type of directory associated with the WorkMail organization.</p>
    ///   - [`default_mail_domain(Option<String>)`](crate::operation::describe_organization::DescribeOrganizationOutput::default_mail_domain): <p>The default mail domain associated with the organization.</p>
    ///   - [`completed_date(Option<DateTime>)`](crate::operation::describe_organization::DescribeOrganizationOutput::completed_date): <p>The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.</p>
    ///   - [`error_message(Option<String>)`](crate::operation::describe_organization::DescribeOrganizationOutput::error_message): <p>(Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.</p>
    ///   - [`arn(Option<String>)`](crate::operation::describe_organization::DescribeOrganizationOutput::arn): <p>The Amazon Resource Name (ARN) of the organization.</p>
    ///   - [`migration_admin(Option<String>)`](crate::operation::describe_organization::DescribeOrganizationOutput::migration_admin): <p>The user ID of the migration admin if migration is enabled for the organization.</p>
    ///   - [`interoperability_enabled(bool)`](crate::operation::describe_organization::DescribeOrganizationOutput::interoperability_enabled): <p>Indicates if interoperability is enabled for this organization.</p>
    /// - On failure, responds with [`SdkError<DescribeOrganizationError>`](crate::operation::describe_organization::DescribeOrganizationError)
    pub fn describe_organization(&self) -> crate::operation::describe_organization::builders::DescribeOrganizationFluentBuilder {
        crate::operation::describe_organization::builders::DescribeOrganizationFluentBuilder::new(self.handle.clone())
    }
}