aws_sdk_workmail/client/
describe_resource.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 [`DescribeResource`](crate::operation::describe_resource::builders::DescribeResourceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`organization_id(impl Into<String>)`](crate::operation::describe_resource::builders::DescribeResourceFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::describe_resource::builders::DescribeResourceFluentBuilder::set_organization_id):<br>required: **true**<br><p>The identifier associated with the organization for which the resource is described.</p><br>
7    ///   - [`resource_id(impl Into<String>)`](crate::operation::describe_resource::builders::DescribeResourceFluentBuilder::resource_id) / [`set_resource_id(Option<String>)`](crate::operation::describe_resource::builders::DescribeResourceFluentBuilder::set_resource_id):<br>required: **true**<br><p>The identifier of the resource to be described.</p> <p>The identifier can accept <i>ResourceId</i>, <i>Resourcename</i>, or <i>email</i>. The following identity formats are available:</p> <ul>  <li>   <p>Resource ID: r-0123456789a0123456789b0123456789</p></li>  <li>   <p>Email address: resource@domain.tld</p></li>  <li>   <p>Resource name: resource</p></li> </ul><br>
8    /// - On success, responds with [`DescribeResourceOutput`](crate::operation::describe_resource::DescribeResourceOutput) with field(s):
9    ///   - [`resource_id(Option<String>)`](crate::operation::describe_resource::DescribeResourceOutput::resource_id): <p>The identifier of the described resource.</p>
10    ///   - [`email(Option<String>)`](crate::operation::describe_resource::DescribeResourceOutput::email): <p>The email of the described resource.</p>
11    ///   - [`name(Option<String>)`](crate::operation::describe_resource::DescribeResourceOutput::name): <p>The name of the described resource.</p>
12    ///   - [`r#type(Option<ResourceType>)`](crate::operation::describe_resource::DescribeResourceOutput::type): <p>The type of the described resource.</p>
13    ///   - [`booking_options(Option<BookingOptions>)`](crate::operation::describe_resource::DescribeResourceOutput::booking_options): <p>The booking options for the described resource.</p>
14    ///   - [`state(Option<EntityState>)`](crate::operation::describe_resource::DescribeResourceOutput::state): <p>The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.</p>
15    ///   - [`enabled_date(Option<DateTime>)`](crate::operation::describe_resource::DescribeResourceOutput::enabled_date): <p>The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.</p>
16    ///   - [`disabled_date(Option<DateTime>)`](crate::operation::describe_resource::DescribeResourceOutput::disabled_date): <p>The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.</p>
17    ///   - [`description(Option<String>)`](crate::operation::describe_resource::DescribeResourceOutput::description): <p>Description of the resource.</p>
18    ///   - [`hidden_from_global_address_list(bool)`](crate::operation::describe_resource::DescribeResourceOutput::hidden_from_global_address_list): <p>If enabled, the resource is hidden from the global address list.</p>
19    /// - On failure, responds with [`SdkError<DescribeResourceError>`](crate::operation::describe_resource::DescribeResourceError)
20    pub fn describe_resource(&self) -> crate::operation::describe_resource::builders::DescribeResourceFluentBuilder {
21        crate::operation::describe_resource::builders::DescribeResourceFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_workmail/client/describe_resource.rs

aws_sdk_workmail/client/
describe_resource.rs
