Struct WorkmailClient 

pub struct WorkmailClient { /* private fields */ }

A client for the Amazon WorkMail API.

Implementations

impl WorkmailClient

pub fn new(region: Region) -> WorkmailClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>( request_dispatcher: D, credentials_provider: P, region: Region, ) -> WorkmailClient

where P: ProvideAwsCredentials + Send + Sync + 'static, D: DispatchSignedRequest + Send + Sync + 'static,

pub fn new_with_client(client: Client, region: Region) -> WorkmailClient

Trait Implementations

impl Clone for WorkmailClient

fn clone(&self) -> WorkmailClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Workmail for WorkmailClient

fn associate_delegate_to_resource<'life0, 'async_trait>( &'life0 self, input: AssociateDelegateToResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<AssociateDelegateToResourceResponse, RusotoError<AssociateDelegateToResourceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Adds a member (user or group) to the resource's set of delegates.

fn associate_member_to_group<'life0, 'async_trait>( &'life0 self, input: AssociateMemberToGroupRequest, ) -> Pin<Box<dyn Future<Output = Result<AssociateMemberToGroupResponse, RusotoError<AssociateMemberToGroupError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Adds a member (user or group) to the group's set.

fn create_alias<'life0, 'async_trait>( &'life0 self, input: CreateAliasRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateAliasResponse, RusotoError<CreateAliasError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Adds an alias to the set of a given member (user or group) of Amazon WorkMail.

fn create_group<'life0, 'async_trait>( &'life0 self, input: CreateGroupRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateGroupResponse, RusotoError<CreateGroupError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

fn create_resource<'life0, 'async_trait>( &'life0 self, input: CreateResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateResourceResponse, RusotoError<CreateResourceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a new Amazon WorkMail resource.

fn create_user<'life0, 'async_trait>( &'life0 self, input: CreateUserRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateUserResponse, RusotoError<CreateUserError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

fn delete_access_control_rule<'life0, 'async_trait>( &'life0 self, input: DeleteAccessControlRuleRequest, ) -> Pin<Box<dyn Future<Output = Result<DeleteAccessControlRuleResponse, RusotoError<DeleteAccessControlRuleError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes an access control rule for the specified WorkMail organization.

fn delete_alias<'life0, 'async_trait>( &'life0 self, input: DeleteAliasRequest, ) -> Pin<Box<dyn Future<Output = Result<DeleteAliasResponse, RusotoError<DeleteAliasError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove one or more specified aliases from a set of aliases for a given user.

fn delete_group<'life0, 'async_trait>( &'life0 self, input: DeleteGroupRequest, ) -> Pin<Box<dyn Future<Output = Result<DeleteGroupResponse, RusotoError<DeleteGroupError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes a group from Amazon WorkMail.

fn delete_mailbox_permissions<'life0, 'async_trait>( &'life0 self, input: DeleteMailboxPermissionsRequest, ) -> Pin<Box<dyn Future<Output = Result<DeleteMailboxPermissionsResponse, RusotoError<DeleteMailboxPermissionsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes permissions granted to a member (user or group).

fn delete_resource<'life0, 'async_trait>( &'life0 self, input: DeleteResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<DeleteResourceResponse, RusotoError<DeleteResourceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes the specified resource.

fn delete_retention_policy<'life0, 'async_trait>( &'life0 self, input: DeleteRetentionPolicyRequest, ) -> Pin<Box<dyn Future<Output = Result<DeleteRetentionPolicyResponse, RusotoError<DeleteRetentionPolicyError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes the specified retention policy from the specified organization.

fn delete_user<'life0, 'async_trait>( &'life0 self, input: DeleteUserRequest, ) -> Pin<Box<dyn Future<Output = Result<DeleteUserResponse, RusotoError<DeleteUserError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state.

Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.

fn deregister_from_work_mail<'life0, 'async_trait>( &'life0 self, input: DeregisterFromWorkMailRequest, ) -> Pin<Box<dyn Future<Output = Result<DeregisterFromWorkMailResponse, RusotoError<DeregisterFromWorkMailError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.

fn describe_group<'life0, 'async_trait>( &'life0 self, input: DescribeGroupRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeGroupResponse, RusotoError<DescribeGroupError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the data available for the group.

fn describe_organization<'life0, 'async_trait>( &'life0 self, input: DescribeOrganizationRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeOrganizationResponse, RusotoError<DescribeOrganizationError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Provides more information regarding a given organization based on its identifier.

fn describe_resource<'life0, 'async_trait>( &'life0 self, input: DescribeResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeResourceResponse, RusotoError<DescribeResourceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the data available for the resource.

fn describe_user<'life0, 'async_trait>( &'life0 self, input: DescribeUserRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeUserResponse, RusotoError<DescribeUserError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Provides information regarding the user.

fn disassociate_delegate_from_resource<'life0, 'async_trait>( &'life0 self, input: DisassociateDelegateFromResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<DisassociateDelegateFromResourceResponse, RusotoError<DisassociateDelegateFromResourceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Removes a member from the resource's set of delegates.

fn disassociate_member_from_group<'life0, 'async_trait>( &'life0 self, input: DisassociateMemberFromGroupRequest, ) -> Pin<Box<dyn Future<Output = Result<DisassociateMemberFromGroupResponse, RusotoError<DisassociateMemberFromGroupError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Removes a member from a group.

fn get_access_control_effect<'life0, 'async_trait>( &'life0 self, input: GetAccessControlEffectRequest, ) -> Pin<Box<dyn Future<Output = Result<GetAccessControlEffectResponse, RusotoError<GetAccessControlEffectError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, or user ID.

fn get_default_retention_policy<'life0, 'async_trait>( &'life0 self, input: GetDefaultRetentionPolicyRequest, ) -> Pin<Box<dyn Future<Output = Result<GetDefaultRetentionPolicyResponse, RusotoError<GetDefaultRetentionPolicyError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Gets the default retention policy details for the specified organization.

fn get_mailbox_details<'life0, 'async_trait>( &'life0 self, input: GetMailboxDetailsRequest, ) -> Pin<Box<dyn Future<Output = Result<GetMailboxDetailsResponse, RusotoError<GetMailboxDetailsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Requests a user's mailbox details for a specified organization and user.

fn list_access_control_rules<'life0, 'async_trait>( &'life0 self, input: ListAccessControlRulesRequest, ) -> Pin<Box<dyn Future<Output = Result<ListAccessControlRulesResponse, RusotoError<ListAccessControlRulesError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Lists the access control rules for the specified organization.

fn list_aliases<'life0, 'async_trait>( &'life0 self, input: ListAliasesRequest, ) -> Pin<Box<dyn Future<Output = Result<ListAliasesResponse, RusotoError<ListAliasesError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a paginated call to list the aliases associated with a given entity.

fn list_group_members<'life0, 'async_trait>( &'life0 self, input: ListGroupMembersRequest, ) -> Pin<Box<dyn Future<Output = Result<ListGroupMembersResponse, RusotoError<ListGroupMembersError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns an overview of the members of a group. Users and groups can be members of a group.

fn list_groups<'life0, 'async_trait>( &'life0 self, input: ListGroupsRequest, ) -> Pin<Box<dyn Future<Output = Result<ListGroupsResponse, RusotoError<ListGroupsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns summaries of the organization's groups.

fn list_mailbox_permissions<'life0, 'async_trait>( &'life0 self, input: ListMailboxPermissionsRequest, ) -> Pin<Box<dyn Future<Output = Result<ListMailboxPermissionsResponse, RusotoError<ListMailboxPermissionsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Lists the mailbox permissions associated with a user, group, or resource mailbox.

fn list_organizations<'life0, 'async_trait>( &'life0 self, input: ListOrganizationsRequest, ) -> Pin<Box<dyn Future<Output = Result<ListOrganizationsResponse, RusotoError<ListOrganizationsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns summaries of the customer's organizations.

fn list_resource_delegates<'life0, 'async_trait>( &'life0 self, input: ListResourceDelegatesRequest, ) -> Pin<Box<dyn Future<Output = Result<ListResourceDelegatesResponse, RusotoError<ListResourceDelegatesError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.

fn list_resources<'life0, 'async_trait>( &'life0 self, input: ListResourcesRequest, ) -> Pin<Box<dyn Future<Output = Result<ListResourcesResponse, RusotoError<ListResourcesError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns summaries of the organization's resources.

fn list_tags_for_resource<'life0, 'async_trait>( &'life0 self, input: ListTagsForResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<ListTagsForResourceResponse, RusotoError<ListTagsForResourceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Lists the tags applied to an Amazon WorkMail organization resource.

fn list_users<'life0, 'async_trait>( &'life0 self, input: ListUsersRequest, ) -> Pin<Box<dyn Future<Output = Result<ListUsersResponse, RusotoError<ListUsersError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns summaries of the organization's users.

fn put_access_control_rule<'life0, 'async_trait>( &'life0 self, input: PutAccessControlRuleRequest, ) -> Pin<Box<dyn Future<Output = Result<PutAccessControlRuleResponse, RusotoError<PutAccessControlRuleError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, and user IDs. Adding a new rule with the same name as an existing rule replaces the older rule.

fn put_mailbox_permissions<'life0, 'async_trait>( &'life0 self, input: PutMailboxPermissionsRequest, ) -> Pin<Box<dyn Future<Output = Result<PutMailboxPermissionsResponse, RusotoError<PutMailboxPermissionsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.

fn put_retention_policy<'life0, 'async_trait>( &'life0 self, input: PutRetentionPolicyRequest, ) -> Pin<Box<dyn Future<Output = Result<PutRetentionPolicyResponse, RusotoError<PutRetentionPolicyError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Puts a retention policy to the specified organization.

fn register_to_work_mail<'life0, 'async_trait>( &'life0 self, input: RegisterToWorkMailRequest, ) -> Pin<Box<dyn Future<Output = Result<RegisterToWorkMailResponse, RusotoError<RegisterToWorkMailError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.

Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

fn reset_password<'life0, 'async_trait>( &'life0 self, input: ResetPasswordRequest, ) -> Pin<Box<dyn Future<Output = Result<ResetPasswordResponse, RusotoError<ResetPasswordError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Allows the administrator to reset the password for a user.

fn tag_resource<'life0, 'async_trait>( &'life0 self, input: TagResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<TagResourceResponse, RusotoError<TagResourceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Applies the specified tags to the specified Amazon WorkMail organization resource.

fn untag_resource<'life0, 'async_trait>( &'life0 self, input: UntagResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<UntagResourceResponse, RusotoError<UntagResourceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Untags the specified tags from the specified Amazon WorkMail organization resource.

fn update_mailbox_quota<'life0, 'async_trait>( &'life0 self, input: UpdateMailboxQuotaRequest, ) -> Pin<Box<dyn Future<Output = Result<UpdateMailboxQuotaResponse, RusotoError<UpdateMailboxQuotaError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Updates a user's current mailbox quota for a specified organization and user.

fn update_primary_email_address<'life0, 'async_trait>( &'life0 self, input: UpdatePrimaryEmailAddressRequest, ) -> Pin<Box<dyn Future<Output = Result<UpdatePrimaryEmailAddressResponse, RusotoError<UpdatePrimaryEmailAddressError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.

fn update_resource<'life0, 'async_trait>( &'life0 self, input: UpdateResourceRequest, ) -> Pin<Box<dyn Future<Output = Result<UpdateResourceResponse, RusotoError<UpdateResourceError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.