Struct aws_sdk_workmail::Client

pub struct Client { /* private fields */ }

Client for Amazon WorkMail

Client for invoking operations on Amazon WorkMail. Each operation on Amazon WorkMail is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_workmail::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_workmail::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateDelegateToResource operation has a Client::associate_delegate_to_resource, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_delegate_to_resource()
    .organization_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_delegate_to_resource( &self ) -> AssociateDelegateToResourceFluentBuilder

Constructs a fluent builder for the AssociateDelegateToResource operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The organization under which the resource exists.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The resource for which members (users or groups) are associated.

    The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:

    • Resource ID: r-0123456789a0123456789b0123456789

    • Email address: resource@domain.tld

    • Resource name: resource

    
    
  • entity_id(impl Into<String>) / set_entity_id(Option<String>):
    required: true
    

    The member (user or group) to associate to the resource.

    The entity ID can accept UserId or GroupID, Username or Groupname, or email.

    • Entity: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: entity@domain.tld

    • Entity: entity

    
    
• On success, responds with AssociateDelegateToResourceOutput
• On failure, responds with SdkError<AssociateDelegateToResourceError>

impl Client

pub fn associate_member_to_group(&self) -> AssociateMemberToGroupFluentBuilder

Constructs a fluent builder for the AssociateMemberToGroup operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The organization under which the group exists.

    
    
  • group_id(impl Into<String>) / set_group_id(Option<String>):
    required: true
    

    The group to which the member (user or group) is associated.

    The identifier can accept GroupId, Groupname, or email. The following identity formats are available:

    • Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: group@domain.tld

    • Group name: group

    
    
  • member_id(impl Into<String>) / set_member_id(Option<String>):
    required: true
    

    The member (user or group) to associate to the group.

    The member ID can accept UserID or GroupId, Username or Groupname, or email.

    • Member: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: member@domain.tld

    • Member name: member

    
    
• On success, responds with AssociateMemberToGroupOutput
• On failure, responds with SdkError<AssociateMemberToGroupError>

impl Client

pub fn assume_impersonation_role(&self) -> AssumeImpersonationRoleFluentBuilder

Constructs a fluent builder for the AssumeImpersonationRole operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization under which the impersonation role will be assumed.

    
    
  • impersonation_role_id(impl Into<String>) / set_impersonation_role_id(Option<String>):
    required: true
    

    The impersonation role ID to assume.

    
    
• On success, responds with AssumeImpersonationRoleOutput with field(s):
  • token(Option<String>):

    The authentication token for the impersonation role.

  • expires_in(Option<i64>):

    The authentication token’s validity, in seconds.

• On failure, responds with SdkError<AssumeImpersonationRoleError>

impl Client

pub fn cancel_mailbox_export_job(&self) -> CancelMailboxExportJobFluentBuilder

Constructs a fluent builder for the CancelMailboxExportJob operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    The idempotency token for the client request.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The job ID.

    
    
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The organization ID.

    
    
• On success, responds with CancelMailboxExportJobOutput
• On failure, responds with SdkError<CancelMailboxExportJobError>

impl Client

pub fn create_alias(&self) -> CreateAliasFluentBuilder

Constructs a fluent builder for the CreateAlias operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The organization under which the member (user or group) exists.

    
    
  • entity_id(impl Into<String>) / set_entity_id(Option<String>):
    required: true
    

    The member (user or group) to which this alias is added.

    
    
  • alias(impl Into<String>) / set_alias(Option<String>):
    required: true
    

    The alias to add to the member set.

    
    
• On success, responds with CreateAliasOutput
• On failure, responds with SdkError<CreateAliasError>

impl Client

pub fn create_availability_configuration( &self ) -> CreateAvailabilityConfigurationFluentBuilder

Constructs a fluent builder for the CreateAvailabilityConfiguration operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    An idempotent token that ensures that an API request is executed only once.

    
    
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization for which the AvailabilityConfiguration will be created.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The domain to which the provider applies.

    
    
  • ews_provider(EwsAvailabilityProvider) / set_ews_provider(Option<EwsAvailabilityProvider>):
    required: false
    

    Exchange Web Services (EWS) availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.

    
    
  • lambda_provider(LambdaAvailabilityProvider) / set_lambda_provider(Option<LambdaAvailabilityProvider>):
    required: false
    

    Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider.

    
    
• On success, responds with CreateAvailabilityConfigurationOutput
• On failure, responds with SdkError<CreateAvailabilityConfigurationError>

impl Client

pub fn create_group(&self) -> CreateGroupFluentBuilder

Constructs a fluent builder for the CreateGroup operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The organization under which the group is to be created.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the group.

    
    
  • hidden_from_global_address_list(bool) / set_hidden_from_global_address_list(Option<bool>):
    required: false
    

    If this parameter is enabled, the group will be hidden from the address book.

    
    
• On success, responds with CreateGroupOutput with field(s):
  • group_id(Option<String>):

    The identifier of the group.

• On failure, responds with SdkError<CreateGroupError>

impl Client

pub fn create_impersonation_role(&self) -> CreateImpersonationRoleFluentBuilder

Constructs a fluent builder for the CreateImpersonationRole operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotency token for the client request.

    
    
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization to create the new impersonation role within.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the new impersonation role.

    
    
  • r#type(ImpersonationRoleType) / set_type(Option<ImpersonationRoleType>):
    required: true
    

    The impersonation role’s type. The available impersonation role types are READ_ONLY or FULL_ACCESS.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the new impersonation role.

    
    
  • rules(ImpersonationRule) / set_rules(Option<Vec::<ImpersonationRule>>):
    required: true
    

    The list of rules for the impersonation role.

    
    
• On success, responds with CreateImpersonationRoleOutput with field(s):
  • impersonation_role_id(Option<String>):

    The new impersonation role ID.

• On failure, responds with SdkError<CreateImpersonationRoleError>

impl Client

pub fn create_mobile_device_access_rule( &self ) -> CreateMobileDeviceAccessRuleFluentBuilder

Constructs a fluent builder for the CreateMobileDeviceAccessRule operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization under which the rule will be created.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotency token for the client request.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The rule name.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The rule description.

    
    
  • effect(MobileDeviceAccessRuleEffect) / set_effect(Option<MobileDeviceAccessRuleEffect>):
    required: true
    

    The effect of the rule when it matches. Allowed values are ALLOW or DENY.

    
    
  • device_types(impl Into<String>) / set_device_types(Option<Vec::<String>>):
    required: false
    

    Device types that the rule will match.

    
    
  • not_device_types(impl Into<String>) / set_not_device_types(Option<Vec::<String>>):
    required: false
    

    Device types that the rule will not match. All other device types will match.

    
    
  • device_models(impl Into<String>) / set_device_models(Option<Vec::<String>>):
    required: false
    

    Device models that the rule will match.

    
    
  • not_device_models(impl Into<String>) / set_not_device_models(Option<Vec::<String>>):
    required: false
    

    Device models that the rule will not match. All other device models will match.

    
    
  • device_operating_systems(impl Into<String>) / set_device_operating_systems(Option<Vec::<String>>):
    required: false
    

    Device operating systems that the rule will match.

    
    
  • not_device_operating_systems(impl Into<String>) / set_not_device_operating_systems(Option<Vec::<String>>):
    required: false
    

    Device operating systems that the rule will not match. All other device operating systems will match.

    
    
  • device_user_agents(impl Into<String>) / set_device_user_agents(Option<Vec::<String>>):
    required: false
    

    Device user agents that the rule will match.

    
    
  • not_device_user_agents(impl Into<String>) / set_not_device_user_agents(Option<Vec::<String>>):
    required: false
    

    Device user agents that the rule will not match. All other device user agents will match.

    
    
• On success, responds with CreateMobileDeviceAccessRuleOutput with field(s):
  • mobile_device_access_rule_id(Option<String>):

    The identifier for the newly created mobile device access rule.

• On failure, responds with SdkError<CreateMobileDeviceAccessRuleError>

impl Client

pub fn create_organization(&self) -> CreateOrganizationFluentBuilder

Constructs a fluent builder for the CreateOrganization operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: false
    

    The AWS Directory Service directory ID.

    
    
  • alias(impl Into<String>) / set_alias(Option<String>):
    required: true
    

    The organization alias.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotency token associated with the request.

    
    
  • domains(Domain) / set_domains(Option<Vec::<Domain>>):
    required: false
    

    The email domains to associate with the organization.

    
    
  • kms_key_arn(impl Into<String>) / set_kms_key_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.

    
    
  • enable_interoperability(bool) / set_enable_interoperability(Option<bool>):
    required: false
    

    When true, allows organization interoperability between WorkMail and Microsoft Exchange. If true, you must include a AD Connector directory ID in the request.

    
    
• On success, responds with CreateOrganizationOutput with field(s):
  • organization_id(Option<String>):

    The organization ID.

• On failure, responds with SdkError<CreateOrganizationError>

impl Client

pub fn create_resource(&self) -> CreateResourceFluentBuilder

Constructs a fluent builder for the CreateResource operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier associated with the organization for which the resource is created.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the new resource.

    
    
  • r#type(ResourceType) / set_type(Option<ResourceType>):
    required: true
    

    The type of the new resource. The available types are equipment and room.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Resource description.

    
    
  • hidden_from_global_address_list(bool) / set_hidden_from_global_address_list(Option<bool>):
    required: false
    

    If this parameter is enabled, the resource will be hidden from the address book.

    
    
• On success, responds with CreateResourceOutput with field(s):
  • resource_id(Option<String>):

    The identifier of the new resource.

• On failure, responds with SdkError<CreateResourceError>

impl Client

pub fn create_user(&self) -> CreateUserFluentBuilder

Constructs a fluent builder for the CreateUser operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier of the organization for which the user is created.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    The display name for the new user.

    
    
  • password(impl Into<String>) / set_password(Option<String>):
    required: false
    

    The password for the new user.

    
    
  • role(UserRole) / set_role(Option<UserRole>):
    required: false
    

    The role of the new user.

    You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.

    
    
  • first_name(impl Into<String>) / set_first_name(Option<String>):
    required: false
    

    The first name of the new user.

    
    
  • last_name(impl Into<String>) / set_last_name(Option<String>):
    required: false
    

    The last name of the new user.

    
    
  • hidden_from_global_address_list(bool) / set_hidden_from_global_address_list(Option<bool>):
    required: false
    

    If this parameter is enabled, the user will be hidden from the address book.

    
    
• On success, responds with CreateUserOutput with field(s):
  • user_id(Option<String>):

    The identifier for the new user.

• On failure, responds with SdkError<CreateUserError>

impl Client

pub fn delete_access_control_rule(&self) -> DeleteAccessControlRuleFluentBuilder

Constructs a fluent builder for the DeleteAccessControlRule operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the access control rule.

    
    
• On success, responds with DeleteAccessControlRuleOutput
• On failure, responds with SdkError<DeleteAccessControlRuleError>

impl Client

pub fn delete_alias(&self) -> DeleteAliasFluentBuilder

Constructs a fluent builder for the DeleteAlias operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the user exists.

    
    
  • entity_id(impl Into<String>) / set_entity_id(Option<String>):
    required: true
    

    The identifier for the member (user or group) from which to have the aliases removed.

    
    
  • alias(impl Into<String>) / set_alias(Option<String>):
    required: true
    

    The aliases to be removed from the user’s set of aliases. Duplicate entries in the list are collapsed into single entries (the list is transformed into a set).

    
    
• On success, responds with DeleteAliasOutput
• On failure, responds with SdkError<DeleteAliasError>

impl Client

pub fn delete_availability_configuration( &self ) -> DeleteAvailabilityConfigurationFluentBuilder

Constructs a fluent builder for the DeleteAvailabilityConfiguration operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization for which the AvailabilityConfiguration will be deleted.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The domain for which the AvailabilityConfiguration will be deleted.

    
    
• On success, responds with DeleteAvailabilityConfigurationOutput
• On failure, responds with SdkError<DeleteAvailabilityConfigurationError>

impl Client

pub fn delete_email_monitoring_configuration( &self ) -> DeleteEmailMonitoringConfigurationFluentBuilder

Constructs a fluent builder for the DeleteEmailMonitoringConfiguration operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The ID of the organization from which the email monitoring configuration is deleted.

    
    
• On success, responds with DeleteEmailMonitoringConfigurationOutput
• On failure, responds with SdkError<DeleteEmailMonitoringConfigurationError>

impl Client

pub fn delete_group(&self) -> DeleteGroupFluentBuilder

Constructs a fluent builder for the DeleteGroup operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The organization that contains the group.

    
    
  • group_id(impl Into<String>) / set_group_id(Option<String>):
    required: true
    

    The identifier of the group to be deleted.

    The identifier can be the GroupId, or Groupname. The following identity formats are available:

    • Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Group name: group

    
    
• On success, responds with DeleteGroupOutput
• On failure, responds with SdkError<DeleteGroupError>

impl Client

pub fn delete_impersonation_role(&self) -> DeleteImpersonationRoleFluentBuilder

Constructs a fluent builder for the DeleteImpersonationRole operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization from which to delete the impersonation role.

    
    
  • impersonation_role_id(impl Into<String>) / set_impersonation_role_id(Option<String>):
    required: true
    

    The ID of the impersonation role to delete.

    
    
• On success, responds with DeleteImpersonationRoleOutput
• On failure, responds with SdkError<DeleteImpersonationRoleError>

impl Client

pub fn delete_mailbox_permissions( &self ) -> DeleteMailboxPermissionsFluentBuilder

Constructs a fluent builder for the DeleteMailboxPermissions operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier of the organization under which the member (user or group) exists.

    
    
  • entity_id(impl Into<String>) / set_entity_id(Option<String>):
    required: true
    

    The identifier of the entity that owns the mailbox.

    The identifier can be UserId or Group Id, Username or Groupname, or email.

    • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: entity@domain.tld

    • Entity name: entity

    
    
  • grantee_id(impl Into<String>) / set_grantee_id(Option<String>):
    required: true
    

    The identifier of the entity for which to delete granted permissions.

    The identifier can be UserId, ResourceID, or Group Id, Username or Groupname, or email.

    • Grantee ID: 12345678-1234-1234-1234-123456789012,r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: grantee@domain.tld

    • Grantee name: grantee

    
    
• On success, responds with DeleteMailboxPermissionsOutput
• On failure, responds with SdkError<DeleteMailboxPermissionsError>

impl Client

pub fn delete_mobile_device_access_override( &self ) -> DeleteMobileDeviceAccessOverrideFluentBuilder

Constructs a fluent builder for the DeleteMobileDeviceAccessOverride operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization for which the access override will be deleted.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The WorkMail user for which you want to delete the override. Accepts the following types of user identities:

    • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: user@domain.tld

    • User name: user

    
    
  • device_id(impl Into<String>) / set_device_id(Option<String>):
    required: true
    

    The mobile device for which you delete the override. DeviceId is case insensitive.

    
    
• On success, responds with DeleteMobileDeviceAccessOverrideOutput
• On failure, responds with SdkError<DeleteMobileDeviceAccessOverrideError>

impl Client

pub fn delete_mobile_device_access_rule( &self ) -> DeleteMobileDeviceAccessRuleFluentBuilder

Constructs a fluent builder for the DeleteMobileDeviceAccessRule operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization under which the rule will be deleted.

    
    
  • mobile_device_access_rule_id(impl Into<String>) / set_mobile_device_access_rule_id(Option<String>):
    required: true
    

    The identifier of the rule to be deleted.

    
    
• On success, responds with DeleteMobileDeviceAccessRuleOutput
• On failure, responds with SdkError<DeleteMobileDeviceAccessRuleError>

impl Client

pub fn delete_organization(&self) -> DeleteOrganizationFluentBuilder

Constructs a fluent builder for the DeleteOrganization operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotency token associated with the request.

    
    
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The organization ID.

    
    
  • delete_directory(bool) / set_delete_directory(Option<bool>):
    required: true
    

    If true, deletes the AWS Directory Service directory associated with the organization.

    
    
  • force_delete(bool) / set_force_delete(Option<bool>):
    required: false
    

    Deletes a WorkMail organization even if the organization has enabled users.

    
    
• On success, responds with DeleteOrganizationOutput with field(s):
  • organization_id(Option<String>):

    The organization ID.

  • state(Option<String>):

    The state of the organization.

• On failure, responds with SdkError<DeleteOrganizationError>

impl Client

pub fn delete_resource(&self) -> DeleteResourceFluentBuilder

Constructs a fluent builder for the DeleteResource operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier associated with the organization from which the resource is deleted.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The identifier of the resource to be deleted.

    The identifier can accept ResourceId, or Resourcename. The following identity formats are available:

    • Resource ID: r-0123456789a0123456789b0123456789

    • Resource name: resource

    
    
• On success, responds with DeleteResourceOutput
• On failure, responds with SdkError<DeleteResourceError>

impl Client

pub fn delete_retention_policy(&self) -> DeleteRetentionPolicyFluentBuilder

Constructs a fluent builder for the DeleteRetentionPolicy operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The organization ID.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The retention policy ID.

    
    
• On success, responds with DeleteRetentionPolicyOutput
• On failure, responds with SdkError<DeleteRetentionPolicyError>

impl Client

pub fn delete_user(&self) -> DeleteUserFluentBuilder

Constructs a fluent builder for the DeleteUser operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The organization that contains the user to be deleted.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier of the user to be deleted.

    The identifier can be the UserId or Username. The following identity formats are available:

    • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • User name: user

    
    
• On success, responds with DeleteUserOutput
• On failure, responds with SdkError<DeleteUserError>

impl Client

pub fn deregister_from_work_mail(&self) -> DeregisterFromWorkMailFluentBuilder

Constructs a fluent builder for the DeregisterFromWorkMail operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the WorkMail entity exists.

    
    
  • entity_id(impl Into<String>) / set_entity_id(Option<String>):
    required: true
    

    The identifier for the member to be updated.

    The identifier can be UserId, ResourceId, or Group Id, Username, Resourcename, or Groupname, or email.

    • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: entity@domain.tld

    • Entity name: entity

    
    
• On success, responds with DeregisterFromWorkMailOutput
• On failure, responds with SdkError<DeregisterFromWorkMailError>

impl Client

pub fn deregister_mail_domain(&self) -> DeregisterMailDomainFluentBuilder

Constructs a fluent builder for the DeregisterMailDomain operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization for which the domain will be deregistered.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The domain to deregister in WorkMail and SES.

    
    
• On success, responds with DeregisterMailDomainOutput
• On failure, responds with SdkError<DeregisterMailDomainError>

impl Client

pub fn describe_email_monitoring_configuration( &self ) -> DescribeEmailMonitoringConfigurationFluentBuilder

Constructs a fluent builder for the DescribeEmailMonitoringConfiguration operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The ID of the organization for which the email monitoring configuration is described.

    
    
• On success, responds with DescribeEmailMonitoringConfigurationOutput with field(s):
  • role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.

  • log_group_arn(Option<String>):

    The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.

• On failure, responds with SdkError<DescribeEmailMonitoringConfigurationError>

impl Client

pub fn describe_entity(&self) -> DescribeEntityFluentBuilder

Constructs a fluent builder for the DescribeEntity operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the entity exists.

    
    
  • email(impl Into<String>) / set_email(Option<String>):
    required: true
    

    The email under which the entity exists.

    
    
• On success, responds with DescribeEntityOutput with field(s):
  • entity_id(Option<String>):

    The entity ID under which the entity exists.

  • name(Option<String>):

    Username, GroupName, or ResourceName based on entity type.

  • r#type(Option<EntityType>):

    Entity type.

• On failure, responds with SdkError<DescribeEntityError>

impl Client

pub fn describe_group(&self) -> DescribeGroupFluentBuilder

Constructs a fluent builder for the DescribeGroup operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the group exists.

    
    
  • group_id(impl Into<String>) / set_group_id(Option<String>):
    required: true
    

    The identifier for the group to be described.

    The identifier can accept GroupId, Groupname, or email. The following identity formats are available:

    • Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: group@domain.tld

    • Group name: group

    
    
• On success, responds with DescribeGroupOutput with field(s):
  • group_id(Option<String>):

    The identifier of the described group.

  • name(Option<String>):

    The name of the described group.

  • email(Option<String>):

    The email of the described group.

  • state(Option<EntityState>):

    The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

  • enabled_date(Option<DateTime>):

    The date and time when a user was registered to WorkMail, in UNIX epoch time format.

  • disabled_date(Option<DateTime>):

    The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.

  • hidden_from_global_address_list(bool):

    If the value is set to true, the group is hidden from the address book.

• On failure, responds with SdkError<DescribeGroupError>

impl Client

pub fn describe_inbound_dmarc_settings( &self ) -> DescribeInboundDmarcSettingsFluentBuilder

Constructs a fluent builder for the DescribeInboundDmarcSettings operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    Lists the ID of the given organization.

    
    
• On success, responds with DescribeInboundDmarcSettingsOutput with field(s):
  • enforced(bool):

    Lists the enforcement setting of the applied policy.

• On failure, responds with SdkError<DescribeInboundDmarcSettingsError>

impl Client

pub fn describe_mailbox_export_job( &self ) -> DescribeMailboxExportJobFluentBuilder

Constructs a fluent builder for the DescribeMailboxExportJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The mailbox export job ID.

    
    
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The organization ID.

    
    
• On success, responds with DescribeMailboxExportJobOutput with field(s):
  • entity_id(Option<String>):

    The identifier of the user or resource associated with the mailbox.

  • description(Option<String>):

    The mailbox export job description.

  • role_arn(Option<String>):

    The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket.

  • kms_key_arn(Option<String>):

    The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

  • s3_bucket_name(Option<String>):

    The name of the S3 bucket.

  • s3_prefix(Option<String>):

    The S3 bucket prefix.

  • s3_path(Option<String>):

    The path to the S3 bucket and file that the mailbox export job is exporting to.

  • estimated_progress(i32):

    The estimated progress of the mailbox export job, in percentage points.

  • state(Option<MailboxExportJobState>):

    The state of the mailbox export job.

  • error_info(Option<String>):

    Error information for failed mailbox export jobs.

  • start_time(Option<DateTime>):

    The mailbox export job start timestamp.

  • end_time(Option<DateTime>):

    The mailbox export job end timestamp.

• On failure, responds with SdkError<DescribeMailboxExportJobError>

impl Client

pub fn describe_organization(&self) -> DescribeOrganizationFluentBuilder

Constructs a fluent builder for the DescribeOrganization operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization to be described.

    
    
• On success, responds with DescribeOrganizationOutput with field(s):
  • organization_id(Option<String>):

    The identifier of an organization.

  • alias(Option<String>):

    The alias for an organization.

  • state(Option<String>):

    The state of an organization.

  • directory_id(Option<String>):

    The identifier for the directory associated with an WorkMail organization.

  • directory_type(Option<String>):

    The type of directory associated with the WorkMail organization.

  • default_mail_domain(Option<String>):

    The default mail domain associated with the organization.

  • completed_date(Option<DateTime>):

    The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.

  • error_message(Option<String>):

    (Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the organization.

  • migration_admin(Option<String>):

    The user ID of the migration admin if migration is enabled for the organization.

  • interoperability_enabled(bool):

    Indicates if interoperability is enabled for this organization.

• On failure, responds with SdkError<DescribeOrganizationError>

impl Client

pub fn describe_resource(&self) -> DescribeResourceFluentBuilder

Constructs a fluent builder for the DescribeResource operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier associated with the organization for which the resource is described.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The identifier of the resource to be described.

    The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:

    • Resource ID: r-0123456789a0123456789b0123456789

    • Email address: resource@domain.tld

    • Resource name: resource

    
    
• On success, responds with DescribeResourceOutput with field(s):
  • resource_id(Option<String>):

    The identifier of the described resource.

  • email(Option<String>):

    The email of the described resource.

  • name(Option<String>):

    The name of the described resource.

  • r#type(Option<ResourceType>):

    The type of the described resource.

  • booking_options(Option<BookingOptions>):

    The booking options for the described resource.

  • state(Option<EntityState>):

    The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.

  • enabled_date(Option<DateTime>):

    The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.

  • disabled_date(Option<DateTime>):

    The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.

  • description(Option<String>):

    Description of the resource.

  • hidden_from_global_address_list(bool):

    If enabled, the resource is hidden from the global address list.

• On failure, responds with SdkError<DescribeResourceError>

impl Client

pub fn describe_user(&self) -> DescribeUserFluentBuilder

Constructs a fluent builder for the DescribeUser operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the user exists.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier for the user to be described.

    The identifier can be the UserId, Username, or email. The following identity formats are available:

    • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: user@domain.tld

    • User name: user

    
    
• On success, responds with DescribeUserOutput with field(s):
  • user_id(Option<String>):

    The identifier for the described user.

  • name(Option<String>):

    The name for the user.

  • email(Option<String>):

    The email of the user.

  • display_name(Option<String>):

    The display name of the user.

  • state(Option<EntityState>):

    The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

  • user_role(Option<UserRole>):

    In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.

  • enabled_date(Option<DateTime>):

    The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.

  • disabled_date(Option<DateTime>):

    The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.

  • mailbox_provisioned_date(Option<DateTime>):

    The date when the mailbox was created for the user.

  • mailbox_deprovisioned_date(Option<DateTime>):

    The date when the mailbox was removed for the user.

  • first_name(Option<String>):

    First name of the user.

  • last_name(Option<String>):

    Last name of the user.

  • hidden_from_global_address_list(bool):

    If enabled, the user is hidden from the global address list.

  • initials(Option<String>):

    Initials of the user.

  • telephone(Option<String>):

    User’s contact number.

  • street(Option<String>):

    Street where the user is located.

  • job_title(Option<String>):

    Job title of the user.

  • city(Option<String>):

    City where the user is located.

  • company(Option<String>):

    Company of the user.

  • zip_code(Option<String>):

    Zip code of the user.

  • department(Option<String>):

    Department of the user.

  • country(Option<String>):

    Country where the user is located.

  • office(Option<String>):

    Office where the user is located.

• On failure, responds with SdkError<DescribeUserError>

impl Client

pub fn disassociate_delegate_from_resource( &self ) -> DisassociateDelegateFromResourceFluentBuilder

Constructs a fluent builder for the DisassociateDelegateFromResource operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the resource exists.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The identifier of the resource from which delegates’ set members are removed.

    The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:

    • Resource ID: r-0123456789a0123456789b0123456789

    • Email address: resource@domain.tld

    • Resource name: resource

    
    
  • entity_id(impl Into<String>) / set_entity_id(Option<String>):
    required: true
    

    The identifier for the member (user, group) to be removed from the resource’s delegates.

    The entity ID can accept UserId or GroupID, Username or Groupname, or email.

    • Entity: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: entity@domain.tld

    • Entity: entity

    
    
• On success, responds with DisassociateDelegateFromResourceOutput
• On failure, responds with SdkError<DisassociateDelegateFromResourceError>

impl Client

pub fn disassociate_member_from_group( &self ) -> DisassociateMemberFromGroupFluentBuilder

Constructs a fluent builder for the DisassociateMemberFromGroup operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the group exists.

    
    
  • group_id(impl Into<String>) / set_group_id(Option<String>):
    required: true
    

    The identifier for the group from which members are removed.

    The identifier can accept GroupId, Groupname, or email. The following identity formats are available:

    • Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: group@domain.tld

    • Group name: group

    
    
  • member_id(impl Into<String>) / set_member_id(Option<String>):
    required: true
    

    The identifier for the member to be removed from the group.

    The member ID can accept UserID or GroupId, Username or Groupname, or email.

    • Member ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: member@domain.tld

    • Member name: member

    
    
• On success, responds with DisassociateMemberFromGroupOutput
• On failure, responds with SdkError<DisassociateMemberFromGroupError>

impl Client

pub fn get_access_control_effect(&self) -> GetAccessControlEffectFluentBuilder

Constructs a fluent builder for the GetAccessControlEffect operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization.

    
    
  • ip_address(impl Into<String>) / set_ip_address(Option<String>):
    required: true
    

    The IPv4 address.

    
    
  • action(impl Into<String>) / set_action(Option<String>):
    required: true
    

    The access protocol action. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: false
    

    The user ID.

    
    
  • impersonation_role_id(impl Into<String>) / set_impersonation_role_id(Option<String>):
    required: false
    

    The impersonation role ID.

    
    
• On success, responds with GetAccessControlEffectOutput with field(s):
  • effect(Option<AccessControlRuleEffect>):

    The rule effect.

  • matched_rules(Option<Vec::<String>>):

    The rules that match the given parameters, resulting in an effect.

• On failure, responds with SdkError<GetAccessControlEffectError>

impl Client

pub fn get_default_retention_policy( &self ) -> GetDefaultRetentionPolicyFluentBuilder

Constructs a fluent builder for the GetDefaultRetentionPolicy operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The organization ID.

    
    
• On success, responds with GetDefaultRetentionPolicyOutput with field(s):
  • id(Option<String>):

    The retention policy ID.

  • name(Option<String>):

    The retention policy name.

  • description(Option<String>):

    The retention policy description.

  • folder_configurations(Option<Vec::<FolderConfiguration>>):

    The retention policy folder configurations.

• On failure, responds with SdkError<GetDefaultRetentionPolicyError>

impl Client

pub fn get_impersonation_role(&self) -> GetImpersonationRoleFluentBuilder

Constructs a fluent builder for the GetImpersonationRole operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization from which to retrieve the impersonation role.

    
    
  • impersonation_role_id(impl Into<String>) / set_impersonation_role_id(Option<String>):
    required: true
    

    The impersonation role ID to retrieve.

    
    
• On success, responds with GetImpersonationRoleOutput with field(s):
  • impersonation_role_id(Option<String>):

    The impersonation role ID.

  • name(Option<String>):

    The impersonation role name.

  • r#type(Option<ImpersonationRoleType>):

    The impersonation role type.

  • description(Option<String>):

    The impersonation role description.

  • rules(Option<Vec::<ImpersonationRule>>):

    The list of rules for the given impersonation role.

  • date_created(Option<DateTime>):

    The date when the impersonation role was created.

  • date_modified(Option<DateTime>):

    The date when the impersonation role was last modified.

• On failure, responds with SdkError<GetImpersonationRoleError>

impl Client

pub fn get_impersonation_role_effect( &self ) -> GetImpersonationRoleEffectFluentBuilder

Constructs a fluent builder for the GetImpersonationRoleEffect operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization where the impersonation role is defined.

    
    
  • impersonation_role_id(impl Into<String>) / set_impersonation_role_id(Option<String>):
    required: true
    

    The impersonation role ID to test.

    
    
  • target_user(impl Into<String>) / set_target_user(Option<String>):
    required: true
    

    The WorkMail organization user chosen to test the impersonation role. The following identity formats are available:

    • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: user@domain.tld

    • User name: user

    
    
• On success, responds with GetImpersonationRoleEffectOutput with field(s):
  • r#type(Option<ImpersonationRoleType>):

    The impersonation role type.

  • effect(Option<AccessEffect>):

    Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.

  • matched_rules(Option<Vec::<ImpersonationMatchedRule>>):

    A list of the rules that match the input and produce the configured effect.

• On failure, responds with SdkError<GetImpersonationRoleEffectError>

impl Client

pub fn get_mail_domain(&self) -> GetMailDomainFluentBuilder

Constructs a fluent builder for the GetMailDomain operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization for which the domain is retrieved.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The domain from which you want to retrieve details.

    
    
• On success, responds with GetMailDomainOutput with field(s):
  • records(Option<Vec::<DnsRecord>>):

    A list of the DNS records that WorkMail recommends adding in your DNS provider for the best user experience. The records configure your domain with DMARC, SPF, DKIM, and direct incoming email traffic to SES. See admin guide for more details.

  • is_test_domain(bool):

    Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.

  • is_default(bool):

    Specifies whether the domain is the default domain for your organization.

  • ownership_verification_status(Option<DnsRecordVerificationStatus>):

    Indicates the status of the domain ownership verification.

  • dkim_verification_status(Option<DnsRecordVerificationStatus>):

    Indicates the status of a DKIM verification.

• On failure, responds with SdkError<GetMailDomainError>

impl Client

pub fn get_mailbox_details(&self) -> GetMailboxDetailsFluentBuilder

Constructs a fluent builder for the GetMailboxDetails operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization that contains the user whose mailbox details are being requested.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier for the user whose mailbox details are being requested.

    The identifier can be the UserId, Username, or email. The following identity formats are available:

    • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: user@domain.tld

    • User name: user

    
    
• On success, responds with GetMailboxDetailsOutput with field(s):
  • mailbox_quota(Option<i32>):

    The maximum allowed mailbox size, in MB, for the specified user.

  • mailbox_size(f64):

    The current mailbox size, in MB, for the specified user.

• On failure, responds with SdkError<GetMailboxDetailsError>

impl Client

pub fn get_mobile_device_access_effect( &self ) -> GetMobileDeviceAccessEffectFluentBuilder

Constructs a fluent builder for the GetMobileDeviceAccessEffect operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization to simulate the access effect for.

    
    
  • device_type(impl Into<String>) / set_device_type(Option<String>):
    required: false
    

    Device type the simulated user will report.

    
    
  • device_model(impl Into<String>) / set_device_model(Option<String>):
    required: false
    

    Device model the simulated user will report.

    
    
  • device_operating_system(impl Into<String>) / set_device_operating_system(Option<String>):
    required: false
    

    Device operating system the simulated user will report.

    
    
  • device_user_agent(impl Into<String>) / set_device_user_agent(Option<String>):
    required: false
    

    Device user agent the simulated user will report.

    
    
• On success, responds with GetMobileDeviceAccessEffectOutput with field(s):
  • effect(Option<MobileDeviceAccessRuleEffect>):

    The effect of the simulated access, ALLOW or DENY, after evaluating mobile device access rules in the WorkMail organization for the simulated user parameters.

  • matched_rules(Option<Vec::<MobileDeviceAccessMatchedRule>>):

    A list of the rules which matched the simulated user input and produced the effect.

• On failure, responds with SdkError<GetMobileDeviceAccessEffectError>

impl Client

pub fn get_mobile_device_access_override( &self ) -> GetMobileDeviceAccessOverrideFluentBuilder

Constructs a fluent builder for the GetMobileDeviceAccessOverride operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization to which you want to apply the override.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    Identifies the WorkMail user for the override. Accepts the following types of user identities:

    • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: user@domain.tld

    • User name: user

    
    
  • device_id(impl Into<String>) / set_device_id(Option<String>):
    required: true
    

    The mobile device to which the override applies. DeviceId is case insensitive.

    
    
• On success, responds with GetMobileDeviceAccessOverrideOutput with field(s):
  • user_id(Option<String>):

    The WorkMail user to which the access override applies.

  • device_id(Option<String>):

    The device to which the access override applies.

  • effect(Option<MobileDeviceAccessRuleEffect>):

    The effect of the override, ALLOW or DENY.

  • description(Option<String>):

    A description of the override.

  • date_created(Option<DateTime>):

    The date the override was first created.

  • date_modified(Option<DateTime>):

    The date the description was last modified.

• On failure, responds with SdkError<GetMobileDeviceAccessOverrideError>

impl Client

pub fn list_access_control_rules(&self) -> ListAccessControlRulesFluentBuilder

Constructs a fluent builder for the ListAccessControlRules operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization.

    
    
• On success, responds with ListAccessControlRulesOutput with field(s):
  • rules(Option<Vec::<AccessControlRule>>):

    The access control rules.

• On failure, responds with SdkError<ListAccessControlRulesError>

impl Client

pub fn list_aliases(&self) -> ListAliasesFluentBuilder

Constructs a fluent builder for the ListAliases operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the entity exists.

    
    
  • entity_id(impl Into<String>) / set_entity_id(Option<String>):
    required: true
    

    The identifier for the entity for which to list the aliases.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListAliasesOutput with field(s):
  • aliases(Option<Vec::<String>>):

    The entity’s paginated aliases.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.

• On failure, responds with SdkError<ListAliasesError>

impl Client

pub fn list_availability_configurations( &self ) -> ListAvailabilityConfigurationsFluentBuilder

Constructs a fluent builder for the ListAvailabilityConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization for which the AvailabilityConfiguration’s will be listed.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next page of results. The first call does not require a token.

    
    
• On success, responds with ListAvailabilityConfigurationsOutput with field(s):
  • availability_configurations(Option<Vec::<AvailabilityConfiguration>>):

    The list of AvailabilityConfiguration’s that exist for the specified WorkMail organization.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. The value is null when there are no further results to return.

• On failure, responds with SdkError<ListAvailabilityConfigurationsError>

impl Client

pub fn list_group_members(&self) -> ListGroupMembersFluentBuilder

Constructs a fluent builder for the ListGroupMembers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the group exists.

    
    
  • group_id(impl Into<String>) / set_group_id(Option<String>):
    required: true
    

    The identifier for the group to which the members (users or groups) are associated.

    The identifier can accept GroupId, Groupname, or email. The following identity formats are available:

    • Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: group@domain.tld

    • Group name: group

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListGroupMembersOutput with field(s):
  • members(Option<Vec::<Member>>):

    The members associated to the group.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

• On failure, responds with SdkError<ListGroupMembersError>

impl Client

pub fn list_groups(&self) -> ListGroupsFluentBuilder

Constructs a fluent builder for the ListGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the groups exist.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • filters(ListGroupsFilters) / set_filters(Option<ListGroupsFilters>):
    required: false
    

    Limit the search results based on the filter criteria. Only one filter per request is supported.

    
    
• On success, responds with ListGroupsOutput with field(s):
  • groups(Option<Vec::<Group>>):

    The overview of groups for an organization.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.

• On failure, responds with SdkError<ListGroupsError>

impl Client

pub fn list_groups_for_entity(&self) -> ListGroupsForEntityFluentBuilder

Constructs a fluent builder for the ListGroupsForEntity operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the entity exists.

    
    
  • entity_id(impl Into<String>) / set_entity_id(Option<String>):
    required: true
    

    The identifier for the entity.

    The entity ID can accept UserId or GroupID, Username or Groupname, or email.

    • Entity ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: entity@domain.tld

    • Entity name: entity

    
    
  • filters(ListGroupsForEntityFilters) / set_filters(Option<ListGroupsForEntityFilters>):
    required: false
    

    Limit the search results based on the filter criteria.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListGroupsForEntityOutput with field(s):
  • groups(Option<Vec::<GroupIdentifier>>):

    The overview of groups in an organization.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListGroupsForEntityError>

impl Client

pub fn list_impersonation_roles(&self) -> ListImpersonationRolesFluentBuilder

Constructs a fluent builder for the ListImpersonationRoles operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization to which the listed impersonation roles belong.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token used to retrieve the next page of results. The first call doesn’t require a token.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results returned in a single call.

    
    
• On success, responds with ListImpersonationRolesOutput with field(s):
  • roles(Option<Vec::<ImpersonationRole>>):

    The list of impersonation roles under the given WorkMail organization.

  • next_token(Option<String>):

    The token to retrieve the next page of results. The value is null when there are no results to return.

• On failure, responds with SdkError<ListImpersonationRolesError>

impl Client

pub fn list_mail_domains(&self) -> ListMailDomainsFluentBuilder

Constructs a fluent builder for the ListMailDomains operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization for which to list domains.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next page of results. The first call does not require a token.

    
    
• On success, responds with ListMailDomainsOutput with field(s):
  • mail_domains(Option<Vec::<MailDomainSummary>>):

    The list of mail domain summaries, specifying domains that exist in the specified WorkMail organization, along with the information about whether the domain is or isn’t the default.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. The value becomes null when there are no more results to return.

• On failure, responds with SdkError<ListMailDomainsError>

impl Client

pub fn list_mailbox_export_jobs(&self) -> ListMailboxExportJobsFluentBuilder

Constructs a fluent builder for the ListMailboxExportJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The organization ID.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListMailboxExportJobsOutput with field(s):
  • jobs(Option<Vec::<MailboxExportJob>>):

    The mailbox export job details.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results.

• On failure, responds with SdkError<ListMailboxExportJobsError>

impl Client

pub fn list_mailbox_permissions(&self) -> ListMailboxPermissionsFluentBuilder

Constructs a fluent builder for the ListMailboxPermissions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier of the organization under which the user, group, or resource exists.

    
    
  • entity_id(impl Into<String>) / set_entity_id(Option<String>):
    required: true
    

    The identifier of the user, or resource for which to list mailbox permissions.

    The entity ID can accept UserId or ResourceId, Username or Resourcename, or email.

    • Entity ID: 12345678-1234-1234-1234-123456789012, or r-0123456789a0123456789b0123456789

    • Email address: entity@domain.tld

    • Entity name: entity

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListMailboxPermissionsOutput with field(s):
  • permissions(Option<Vec::<Permission>>):

    One page of the user, group, or resource mailbox permissions.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.

• On failure, responds with SdkError<ListMailboxPermissionsError>

impl Client

pub fn list_mobile_device_access_overrides( &self ) -> ListMobileDeviceAccessOverridesFluentBuilder

Constructs a fluent builder for the ListMobileDeviceAccessOverrides operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization under which to list mobile device access overrides.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: false
    

    The WorkMail user under which you list the mobile device access overrides. Accepts the following types of user identities:

    • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: user@domain.tld

    • User name: user

    
    
  • device_id(impl Into<String>) / set_device_id(Option<String>):
    required: false
    

    The mobile device to which the access override applies.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next page of results. The first call does not require a token.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListMobileDeviceAccessOverridesOutput with field(s):
  • overrides(Option<Vec::<MobileDeviceAccessOverride>>):

    The list of mobile device access overrides that exist for the specified WorkMail organization and user.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.

• On failure, responds with SdkError<ListMobileDeviceAccessOverridesError>

impl Client

pub fn list_mobile_device_access_rules( &self ) -> ListMobileDeviceAccessRulesFluentBuilder

Constructs a fluent builder for the ListMobileDeviceAccessRules operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization for which to list the rules.

    
    
• On success, responds with ListMobileDeviceAccessRulesOutput with field(s):
  • rules(Option<Vec::<MobileDeviceAccessRule>>):

    The list of mobile device access rules that exist under the specified WorkMail organization.

• On failure, responds with SdkError<ListMobileDeviceAccessRulesError>

impl Client

pub fn list_organizations(&self) -> ListOrganizationsFluentBuilder

Constructs a fluent builder for the ListOrganizations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListOrganizationsOutput with field(s):
  • organization_summaries(Option<Vec::<OrganizationSummary>>):

    The overview of owned organizations presented as a list of organization summaries.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.

• On failure, responds with SdkError<ListOrganizationsError>

impl Client

pub fn list_resource_delegates(&self) -> ListResourceDelegatesFluentBuilder

Constructs a fluent builder for the ListResourceDelegates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization that contains the resource for which delegates are listed.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The identifier for the resource whose delegates are listed.

    The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:

    • Resource ID: r-0123456789a0123456789b0123456789

    • Email address: resource@domain.tld

    • Resource name: resource

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token used to paginate through the delegates associated with a resource.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of maximum results in a page.

    
    
• On success, responds with ListResourceDelegatesOutput with field(s):
  • delegates(Option<Vec::<Delegate>>):

    One page of the resource’s delegates.

  • next_token(Option<String>):

    The token used to paginate through the delegates associated with a resource. While results are still available, it has an associated value. When the last page is reached, the token is empty.

• On failure, responds with SdkError<ListResourceDelegatesError>

impl Client

pub fn list_resources(&self) -> ListResourcesFluentBuilder

Constructs a fluent builder for the ListResources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the resources exist.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • filters(ListResourcesFilters) / set_filters(Option<ListResourcesFilters>):
    required: false
    

    Limit the resource search results based on the filter criteria. You can only use one filter per request.

    
    
• On success, responds with ListResourcesOutput with field(s):
  • resources(Option<Vec::<Resource>>):

    One page of the organization’s resource representation.

  • next_token(Option<String>):

    The token used to paginate through all the organization’s resources. While results are still available, it has an associated value. When the last page is reached, the token is empty.

• On failure, responds with SdkError<ListResourcesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The resource ARN.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    A list of tag key-value pairs.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_users(&self) -> ListUsersFluentBuilder

Constructs a fluent builder for the ListUsers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the users exist.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in a single call.

    
    
  • filters(ListUsersFilters) / set_filters(Option<ListUsersFilters>):
    required: false
    

    Limit the user search results based on the filter criteria. You can only use one filter per request.

    
    
• On success, responds with ListUsersOutput with field(s):
  • users(Option<Vec::<User>>):

    The overview of users for an organization.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListUsersError>

impl Client

pub fn put_access_control_rule(&self) -> PutAccessControlRuleFluentBuilder

Constructs a fluent builder for the PutAccessControlRule operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The rule name.

    
    
  • effect(AccessControlRuleEffect) / set_effect(Option<AccessControlRuleEffect>):
    required: true
    

    The rule effect.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    The rule description.

    
    
  • ip_ranges(impl Into<String>) / set_ip_ranges(Option<Vec::<String>>):
    required: false
    

    IPv4 CIDR ranges to include in the rule.

    
    
  • not_ip_ranges(impl Into<String>) / set_not_ip_ranges(Option<Vec::<String>>):
    required: false
    

    IPv4 CIDR ranges to exclude from the rule.

    
    
  • actions(impl Into<String>) / set_actions(Option<Vec::<String>>):
    required: false
    

    Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

    
    
  • not_actions(impl Into<String>) / set_not_actions(Option<Vec::<String>>):
    required: false
    

    Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.

    
    
  • user_ids(impl Into<String>) / set_user_ids(Option<Vec::<String>>):
    required: false
    

    User IDs to include in the rule.

    
    
  • not_user_ids(impl Into<String>) / set_not_user_ids(Option<Vec::<String>>):
    required: false
    

    User IDs to exclude from the rule.

    
    
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier of the organization.

    
    
  • impersonation_role_ids(impl Into<String>) / set_impersonation_role_ids(Option<Vec::<String>>):
    required: false
    

    Impersonation role IDs to include in the rule.

    
    
  • not_impersonation_role_ids(impl Into<String>) / set_not_impersonation_role_ids(Option<Vec::<String>>):
    required: false
    

    Impersonation role IDs to exclude from the rule.

    
    
• On success, responds with PutAccessControlRuleOutput
• On failure, responds with SdkError<PutAccessControlRuleError>

impl Client

pub fn put_email_monitoring_configuration( &self ) -> PutEmailMonitoringConfigurationFluentBuilder

Constructs a fluent builder for the PutEmailMonitoringConfiguration operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The ID of the organization for which the email monitoring configuration is set.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.

    
    
  • log_group_arn(impl Into<String>) / set_log_group_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.

    
    
• On success, responds with PutEmailMonitoringConfigurationOutput
• On failure, responds with SdkError<PutEmailMonitoringConfigurationError>

impl Client

pub fn put_inbound_dmarc_settings(&self) -> PutInboundDmarcSettingsFluentBuilder

Constructs a fluent builder for the PutInboundDmarcSettings operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The ID of the organization that you are applying the DMARC policy to.

    
    
  • enforced(bool) / set_enforced(Option<bool>):
    required: true
    

    Enforces or suspends a policy after it’s applied.

    
    
• On success, responds with PutInboundDmarcSettingsOutput
• On failure, responds with SdkError<PutInboundDmarcSettingsError>

impl Client

pub fn put_mailbox_permissions(&self) -> PutMailboxPermissionsFluentBuilder

Constructs a fluent builder for the PutMailboxPermissions operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier of the organization under which the user, group, or resource exists.

    
    
  • entity_id(impl Into<String>) / set_entity_id(Option<String>):
    required: true
    

    The identifier of the user or resource for which to update mailbox permissions.

    The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

    • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: entity@domain.tld

    • Entity name: entity

    
    
  • grantee_id(impl Into<String>) / set_grantee_id(Option<String>):
    required: true
    

    The identifier of the user, group, or resource to which to grant the permissions.

    The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

    • Grantee ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: grantee@domain.tld

    • Grantee name: grantee

    
    
  • permission_values(PermissionType) / set_permission_values(Option<Vec::<PermissionType>>):
    required: true
    

    The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

    
    
• On success, responds with PutMailboxPermissionsOutput
• On failure, responds with SdkError<PutMailboxPermissionsError>

impl Client

pub fn put_mobile_device_access_override( &self ) -> PutMobileDeviceAccessOverrideFluentBuilder

Constructs a fluent builder for the PutMobileDeviceAccessOverride operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    Identifies the WorkMail organization for which you create the override.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The WorkMail user for which you create the override. Accepts the following types of user identities:

    • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: user@domain.tld

    • User name: user

    
    
  • device_id(impl Into<String>) / set_device_id(Option<String>):
    required: true
    

    The mobile device for which you create the override. DeviceId is case insensitive.

    
    
  • effect(MobileDeviceAccessRuleEffect) / set_effect(Option<MobileDeviceAccessRuleEffect>):
    required: true
    

    The effect of the override, ALLOW or DENY.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the override.

    
    
• On success, responds with PutMobileDeviceAccessOverrideOutput
• On failure, responds with SdkError<PutMobileDeviceAccessOverrideError>

impl Client

pub fn put_retention_policy(&self) -> PutRetentionPolicyFluentBuilder

Constructs a fluent builder for the PutRetentionPolicy operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The organization ID.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: false
    

    The retention policy ID.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The retention policy name.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The retention policy description.

    
    
  • folder_configurations(FolderConfiguration) / set_folder_configurations(Option<Vec::<FolderConfiguration>>):
    required: true
    

    The retention policy folder configurations.

    
    
• On success, responds with PutRetentionPolicyOutput
• On failure, responds with SdkError<PutRetentionPolicyError>

impl Client

pub fn register_mail_domain(&self) -> RegisterMailDomainFluentBuilder

Constructs a fluent builder for the RegisterMailDomain operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Idempotency token used when retrying requests.

    
    
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization under which you’re creating the domain.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The name of the mail domain to create in WorkMail and SES.

    
    
• On success, responds with RegisterMailDomainOutput
• On failure, responds with SdkError<RegisterMailDomainError>

impl Client

pub fn register_to_work_mail(&self) -> RegisterToWorkMailFluentBuilder

Constructs a fluent builder for the RegisterToWorkMail operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the user, group, or resource exists.

    
    
  • entity_id(impl Into<String>) / set_entity_id(Option<String>):
    required: true
    

    The identifier for the user, group, or resource to be updated.

    The identifier can accept UserId, ResourceId, or GroupId, or Username, Resourcename, or Groupname. The following identity formats are available:

    • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

    • Entity name: entity

    
    
  • email(impl Into<String>) / set_email(Option<String>):
    required: true
    

    The email for the user, group, or resource to be updated.

    
    
• On success, responds with RegisterToWorkMailOutput
• On failure, responds with SdkError<RegisterToWorkMailError>

impl Client

pub fn reset_password(&self) -> ResetPasswordFluentBuilder

Constructs a fluent builder for the ResetPassword operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier of the organization that contains the user for which the password is reset.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier of the user for whom the password is reset.

    
    
  • password(impl Into<String>) / set_password(Option<String>):
    required: true
    

    The new password for the user.

    
    
• On success, responds with ResetPasswordOutput
• On failure, responds with SdkError<ResetPasswordError>

impl Client

pub fn start_mailbox_export_job(&self) -> StartMailboxExportJobFluentBuilder

Constructs a fluent builder for the StartMailboxExportJob operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    The idempotency token for the client request.

    
    
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier associated with the organization.

    
    
  • entity_id(impl Into<String>) / set_entity_id(Option<String>):
    required: true
    

    The identifier of the user or resource associated with the mailbox.

    The identifier can accept UserId or ResourceId, Username or Resourcename, or email. The following identity formats are available:

    • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789 , or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: entity@domain.tld

    • Entity name: entity

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The mailbox export job description.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.

    
    
  • kms_key_arn(impl Into<String>) / set_kms_key_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

    
    
  • s3_bucket_name(impl Into<String>) / set_s3_bucket_name(Option<String>):
    required: true
    

    The name of the S3 bucket.

    
    
  • s3_prefix(impl Into<String>) / set_s3_prefix(Option<String>):
    required: true
    

    The S3 bucket prefix.

    
    
• On success, responds with StartMailboxExportJobOutput with field(s):
  • job_id(Option<String>):

    The job ID.

• On failure, responds with SdkError<StartMailboxExportJobError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The resource ARN.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The tag key-value pairs.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn test_availability_configuration( &self ) -> TestAvailabilityConfigurationFluentBuilder

Constructs a fluent builder for the TestAvailabilityConfiguration operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization where the availability provider will be tested.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: false
    

    The domain to which the provider applies. If this field is provided, a stored availability provider associated to this domain name will be tested.

    
    
  • ews_provider(EwsAvailabilityProvider) / set_ews_provider(Option<EwsAvailabilityProvider>):
    required: false
    

    Describes an EWS based availability provider. This is only used as input to the service.

    
    
  • lambda_provider(LambdaAvailabilityProvider) / set_lambda_provider(Option<LambdaAvailabilityProvider>):
    required: false
    

    Describes a Lambda based availability provider.

    
    
• On success, responds with TestAvailabilityConfigurationOutput with field(s):
  • test_passed(bool):

    Boolean indicating whether the test passed or failed.

  • failure_reason(Option<String>):

    String containing the reason for a failed test if TestPassed is false.

• On failure, responds with SdkError<TestAvailabilityConfigurationError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The resource ARN.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag keys.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_availability_configuration( &self ) -> UpdateAvailabilityConfigurationFluentBuilder

Constructs a fluent builder for the UpdateAvailabilityConfiguration operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization for which the AvailabilityConfiguration will be updated.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The domain to which the provider applies the availability configuration.

    
    
  • ews_provider(EwsAvailabilityProvider) / set_ews_provider(Option<EwsAvailabilityProvider>):
    required: false
    

    The EWS availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider. The previously stored provider will be overridden by the one provided.

    
    
  • lambda_provider(LambdaAvailabilityProvider) / set_lambda_provider(Option<LambdaAvailabilityProvider>):
    required: false
    

    The Lambda availability provider definition. The request must contain exactly one provider definition, either EwsProvider or LambdaProvider. The previously stored provider will be overridden by the one provided.

    
    
• On success, responds with UpdateAvailabilityConfigurationOutput
• On failure, responds with SdkError<UpdateAvailabilityConfigurationError>

impl Client

pub fn update_default_mail_domain(&self) -> UpdateDefaultMailDomainFluentBuilder

Constructs a fluent builder for the UpdateDefaultMailDomain operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization for which to list domains.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The domain name that will become the default domain.

    
    
• On success, responds with UpdateDefaultMailDomainOutput
• On failure, responds with SdkError<UpdateDefaultMailDomainError>

impl Client

pub fn update_group(&self) -> UpdateGroupFluentBuilder

Constructs a fluent builder for the UpdateGroup operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the group exists.

    
    
  • group_id(impl Into<String>) / set_group_id(Option<String>):
    required: true
    

    The identifier for the group to be updated.

    The identifier can accept GroupId, Groupname, or email. The following identity formats are available:

    • Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: group@domain.tld

    • Group name: group

    
    
  • hidden_from_global_address_list(bool) / set_hidden_from_global_address_list(Option<bool>):
    required: false
    

    If enabled, the group is hidden from the global address list.

    
    
• On success, responds with UpdateGroupOutput
• On failure, responds with SdkError<UpdateGroupError>

impl Client

pub fn update_impersonation_role(&self) -> UpdateImpersonationRoleFluentBuilder

Constructs a fluent builder for the UpdateImpersonationRole operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization that contains the impersonation role to update.

    
    
  • impersonation_role_id(impl Into<String>) / set_impersonation_role_id(Option<String>):
    required: true
    

    The ID of the impersonation role to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The updated impersonation role name.

    
    
  • r#type(ImpersonationRoleType) / set_type(Option<ImpersonationRoleType>):
    required: true
    

    The updated impersonation role type.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated impersonation role description.

    
    
  • rules(ImpersonationRule) / set_rules(Option<Vec::<ImpersonationRule>>):
    required: true
    

    The updated list of rules.

    
    
• On success, responds with UpdateImpersonationRoleOutput
• On failure, responds with SdkError<UpdateImpersonationRoleError>

impl Client

pub fn update_mailbox_quota(&self) -> UpdateMailboxQuotaFluentBuilder

Constructs a fluent builder for the UpdateMailboxQuota operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization that contains the user for whom to update the mailbox quota.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifer for the user for whom to update the mailbox quota.

    The identifier can be the UserId, Username, or email. The following identity formats are available:

    • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: user@domain.tld

    • User name: user

    
    
  • mailbox_quota(i32) / set_mailbox_quota(Option<i32>):
    required: true
    

    The updated mailbox quota, in MB, for the specified user.

    
    
• On success, responds with UpdateMailboxQuotaOutput
• On failure, responds with SdkError<UpdateMailboxQuotaError>

impl Client

pub fn update_mobile_device_access_rule( &self ) -> UpdateMobileDeviceAccessRuleFluentBuilder

Constructs a fluent builder for the UpdateMobileDeviceAccessRule operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The WorkMail organization under which the rule will be updated.

    
    
  • mobile_device_access_rule_id(impl Into<String>) / set_mobile_device_access_rule_id(Option<String>):
    required: true
    

    The identifier of the rule to be updated.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The updated rule name.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated rule description.

    
    
  • effect(MobileDeviceAccessRuleEffect) / set_effect(Option<MobileDeviceAccessRuleEffect>):
    required: true
    

    The effect of the rule when it matches. Allowed values are ALLOW or DENY.

    
    
  • device_types(impl Into<String>) / set_device_types(Option<Vec::<String>>):
    required: false
    

    Device types that the updated rule will match.

    
    
  • not_device_types(impl Into<String>) / set_not_device_types(Option<Vec::<String>>):
    required: false
    

    Device types that the updated rule will not match. All other device types will match.

    
    
  • device_models(impl Into<String>) / set_device_models(Option<Vec::<String>>):
    required: false
    

    Device models that the updated rule will match.

    
    
  • not_device_models(impl Into<String>) / set_not_device_models(Option<Vec::<String>>):
    required: false
    

    Device models that the updated rule will not match. All other device models will match.

    
    
  • device_operating_systems(impl Into<String>) / set_device_operating_systems(Option<Vec::<String>>):
    required: false
    

    Device operating systems that the updated rule will match.

    
    
  • not_device_operating_systems(impl Into<String>) / set_not_device_operating_systems(Option<Vec::<String>>):
    required: false
    

    Device operating systems that the updated rule will not match. All other device operating systems will match.

    
    
  • device_user_agents(impl Into<String>) / set_device_user_agents(Option<Vec::<String>>):
    required: false
    

    User agents that the updated rule will match.

    
    
  • not_device_user_agents(impl Into<String>) / set_not_device_user_agents(Option<Vec::<String>>):
    required: false
    

    User agents that the updated rule will not match. All other user agents will match.

    
    
• On success, responds with UpdateMobileDeviceAccessRuleOutput
• On failure, responds with SdkError<UpdateMobileDeviceAccessRuleError>

impl Client

pub fn update_primary_email_address( &self ) -> UpdatePrimaryEmailAddressFluentBuilder

Constructs a fluent builder for the UpdatePrimaryEmailAddress operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The organization that contains the user, group, or resource to update.

    
    
  • entity_id(impl Into<String>) / set_entity_id(Option<String>):
    required: true
    

    The user, group, or resource to update.

    The identifier can accept UseriD, ResourceId, or GroupId, Username, Resourcename, or Groupname, or email. The following identity formats are available:

    • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: entity@domain.tld

    • Entity name: entity

    
    
  • email(impl Into<String>) / set_email(Option<String>):
    required: true
    

    The value of the email to be updated as primary.

    
    
• On success, responds with UpdatePrimaryEmailAddressOutput
• On failure, responds with SdkError<UpdatePrimaryEmailAddressError>

impl Client

pub fn update_resource(&self) -> UpdateResourceFluentBuilder

Constructs a fluent builder for the UpdateResource operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier associated with the organization for which the resource is updated.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The identifier of the resource to be updated.

    The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:

    • Resource ID: r-0123456789a0123456789b0123456789

    • Email address: resource@domain.tld

    • Resource name: resource

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the resource to be updated.

    
    
  • booking_options(BookingOptions) / set_booking_options(Option<BookingOptions>):
    required: false
    

    The resource’s booking options to be updated.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Updates the resource description.

    
    
  • r#type(ResourceType) / set_type(Option<ResourceType>):
    required: false
    

    Updates the resource type.

    
    
  • hidden_from_global_address_list(bool) / set_hidden_from_global_address_list(Option<bool>):
    required: false
    

    If enabled, the resource is hidden from the global address list.

    
    
• On success, responds with UpdateResourceOutput
• On failure, responds with SdkError<UpdateResourceError>

impl Client

pub fn update_user(&self) -> UpdateUserFluentBuilder

Constructs a fluent builder for the UpdateUser operation.

• The fluent builder is configurable:
  • organization_id(impl Into<String>) / set_organization_id(Option<String>):
    required: true
    

    The identifier for the organization under which the user exists.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The identifier for the user to be updated.

    The identifier can be the UserId, Username, or email. The following identity formats are available:

    • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: user@domain.tld

    • User name: user

    
    
  • role(UserRole) / set_role(Option<UserRole>):
    required: false
    

    Updates the user role.

    You cannot pass SYSTEM_USER or RESOURCE.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    Updates the display name of the user.

    
    
  • first_name(impl Into<String>) / set_first_name(Option<String>):
    required: false
    

    Updates the user’s first name.

    
    
  • last_name(impl Into<String>) / set_last_name(Option<String>):
    required: false
    

    Updates the user’s last name.

    
    
  • hidden_from_global_address_list(bool) / set_hidden_from_global_address_list(Option<bool>):
    required: false
    

    If enabled, the user is hidden from the global address list.

    
    
  • initials(impl Into<String>) / set_initials(Option<String>):
    required: false
    

    Updates the user’s initials.

    
    
  • telephone(impl Into<String>) / set_telephone(Option<String>):
    required: false
    

    Updates the user’s contact details.

    
    
  • street(impl Into<String>) / set_street(Option<String>):
    required: false
    

    Updates the user’s street address.

    
    
  • job_title(impl Into<String>) / set_job_title(Option<String>):
    required: false
    

    Updates the user’s job title.

    
    
  • city(impl Into<String>) / set_city(Option<String>):
    required: false
    

    Updates the user’s city.

    
    
  • company(impl Into<String>) / set_company(Option<String>):
    required: false
    

    Updates the user’s company.

    
    
  • zip_code(impl Into<String>) / set_zip_code(Option<String>):
    required: false
    

    Updates the user’s zipcode.

    
    
  • department(impl Into<String>) / set_department(Option<String>):
    required: false
    

    Updates the user’s department.

    
    
  • country(impl Into<String>) / set_country(Option<String>):
    required: false
    

    Updates the user’s country.

    
    
  • office(impl Into<String>) / set_office(Option<String>):
    required: false
    

    Updates the user’s office.

    
    
• On success, responds with UpdateUserOutput
• On failure, responds with SdkError<UpdateUserError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.