aws_sdk_workmail/client/get_mobile_device_access_override.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 [`GetMobileDeviceAccessOverride`](crate::operation::get_mobile_device_access_override::builders::GetMobileDeviceAccessOverrideFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`organization_id(impl Into<String>)`](crate::operation::get_mobile_device_access_override::builders::GetMobileDeviceAccessOverrideFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::get_mobile_device_access_override::builders::GetMobileDeviceAccessOverrideFluentBuilder::set_organization_id):<br>required: **true**<br><p>The WorkMail organization to which you want to apply the override.</p><br>
7 /// - [`user_id(impl Into<String>)`](crate::operation::get_mobile_device_access_override::builders::GetMobileDeviceAccessOverrideFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::get_mobile_device_access_override::builders::GetMobileDeviceAccessOverrideFluentBuilder::set_user_id):<br>required: **true**<br><p>Identifies the WorkMail user for the override. Accepts the following types of user identities:</p> <ul> <li> <p>User ID: <code>12345678-1234-1234-1234-123456789012</code> or <code>S-1-1-12-1234567890-123456789-123456789-1234</code></p></li> <li> <p>Email address: <code>user@domain.tld</code></p></li> <li> <p>User name: <code>user</code></p></li> </ul><br>
8 /// - [`device_id(impl Into<String>)`](crate::operation::get_mobile_device_access_override::builders::GetMobileDeviceAccessOverrideFluentBuilder::device_id) / [`set_device_id(Option<String>)`](crate::operation::get_mobile_device_access_override::builders::GetMobileDeviceAccessOverrideFluentBuilder::set_device_id):<br>required: **true**<br><p>The mobile device to which the override applies. <code>DeviceId</code> is case insensitive.</p><br>
9 /// - On success, responds with [`GetMobileDeviceAccessOverrideOutput`](crate::operation::get_mobile_device_access_override::GetMobileDeviceAccessOverrideOutput) with field(s):
10 /// - [`user_id(Option<String>)`](crate::operation::get_mobile_device_access_override::GetMobileDeviceAccessOverrideOutput::user_id): <p>The WorkMail user to which the access override applies.</p>
11 /// - [`device_id(Option<String>)`](crate::operation::get_mobile_device_access_override::GetMobileDeviceAccessOverrideOutput::device_id): <p>The device to which the access override applies.</p>
12 /// - [`effect(Option<MobileDeviceAccessRuleEffect>)`](crate::operation::get_mobile_device_access_override::GetMobileDeviceAccessOverrideOutput::effect): <p>The effect of the override, <code>ALLOW</code> or <code>DENY</code>.</p>
13 /// - [`description(Option<String>)`](crate::operation::get_mobile_device_access_override::GetMobileDeviceAccessOverrideOutput::description): <p>A description of the override.</p>
14 /// - [`date_created(Option<DateTime>)`](crate::operation::get_mobile_device_access_override::GetMobileDeviceAccessOverrideOutput::date_created): <p>The date the override was first created.</p>
15 /// - [`date_modified(Option<DateTime>)`](crate::operation::get_mobile_device_access_override::GetMobileDeviceAccessOverrideOutput::date_modified): <p>The date the description was last modified.</p>
16 /// - On failure, responds with [`SdkError<GetMobileDeviceAccessOverrideError>`](crate::operation::get_mobile_device_access_override::GetMobileDeviceAccessOverrideError)
17 pub fn get_mobile_device_access_override(
18 &self,
19 ) -> crate::operation::get_mobile_device_access_override::builders::GetMobileDeviceAccessOverrideFluentBuilder {
20 crate::operation::get_mobile_device_access_override::builders::GetMobileDeviceAccessOverrideFluentBuilder::new(self.handle.clone())
21 }
22}