AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing WorkMail Amazon WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or their native iOS and Android email applications. You can integrate Amazon WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.

The Amazon WorkMail API is designed for the following scenarios:

All Amazon WorkMail API actions are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkMail site, the IAM user gains full administrative visibility into the entire Amazon WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.WorkMail.AmazonWorkMailClient

Namespace: Amazon.WorkMail
Assembly: AWSSDK.WorkMail.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonWorkMailClient : AmazonServiceClient
         IAmazonService, IAmazonWorkMail, IDisposable

The AmazonWorkMailClient type exposes the following members

Constructors

NameDescription
Public Method AmazonWorkMailClient()

Constructs AmazonWorkMailClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonWorkMailClient(RegionEndpoint)

Constructs AmazonWorkMailClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonWorkMailClient(AmazonWorkMailConfig)

Constructs AmazonWorkMailClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonWorkMailClient(AWSCredentials)

Constructs AmazonWorkMailClient with AWS Credentials

Public Method AmazonWorkMailClient(AWSCredentials, RegionEndpoint)

Constructs AmazonWorkMailClient with AWS Credentials

Public Method AmazonWorkMailClient(AWSCredentials, AmazonWorkMailConfig)

Constructs AmazonWorkMailClient with AWS Credentials and an AmazonWorkMailClient Configuration object.

Public Method AmazonWorkMailClient(string, string)

Constructs AmazonWorkMailClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonWorkMailClient(string, string, RegionEndpoint)

Constructs AmazonWorkMailClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonWorkMailClient(string, string, AmazonWorkMailConfig)

Constructs AmazonWorkMailClient with AWS Access Key ID, AWS Secret Key and an AmazonWorkMailClient Configuration object.

Public Method AmazonWorkMailClient(string, string, string)

Constructs AmazonWorkMailClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonWorkMailClient(string, string, string, RegionEndpoint)

Constructs AmazonWorkMailClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonWorkMailClient(string, string, string, AmazonWorkMailConfig)

Constructs AmazonWorkMailClient with AWS Access Key ID, AWS Secret Key and an AmazonWorkMailClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateDelegateToResource(AssociateDelegateToResourceRequest)

Adds a member to the resource's set of delegates.

Public Method AssociateDelegateToResourceAsync(AssociateDelegateToResourceRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateDelegateToResource operation.

Public Method AssociateMemberToGroup(AssociateMemberToGroupRequest)

Adds a member to the group's set.

Public Method AssociateMemberToGroupAsync(AssociateMemberToGroupRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateMemberToGroup operation.

Public Method CreateAlias(CreateAliasRequest)

Adds an alias to the set of a given member of Amazon WorkMail.

Public Method CreateAliasAsync(CreateAliasRequest, CancellationToken)

Initiates the asynchronous execution of the CreateAlias operation.

Public Method CreateGroup(CreateGroupRequest)

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

Public Method CreateGroupAsync(CreateGroupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateGroup operation.

Public Method CreateResource(CreateResourceRequest)

Creates a new Amazon WorkMail resource. The available types are equipment and room.

Public Method CreateResourceAsync(CreateResourceRequest, CancellationToken)

Initiates the asynchronous execution of the CreateResource operation.

Public Method CreateUser(CreateUserRequest)

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

Public Method CreateUserAsync(CreateUserRequest, CancellationToken)

Initiates the asynchronous execution of the CreateUser operation.

Public Method DeleteAlias(DeleteAliasRequest)

Remove the alias from a set of aliases for a given user.

Public Method DeleteAliasAsync(DeleteAliasRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteAlias operation.

Public Method DeleteGroup(DeleteGroupRequest)

Deletes a group from Amazon WorkMail.

Public Method DeleteGroupAsync(DeleteGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteGroup operation.

Public Method DeleteMailboxPermissions(DeleteMailboxPermissionsRequest)

Deletes permissions granted to a user or group.

Public Method DeleteMailboxPermissionsAsync(DeleteMailboxPermissionsRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteMailboxPermissions operation.

Public Method DeleteResource(DeleteResourceRequest)

Deletes the specified resource.

Public Method DeleteResourceAsync(DeleteResourceRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteResource operation.

Public Method DeleteUser(DeleteUserRequest)

Deletes a user from Amazon WorkMail and all subsequent systems. The action can't be undone. The mailbox is kept as-is for a minimum of 30 days, without any means to restore it.

Public Method DeleteUserAsync(DeleteUserRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUser operation.

Public Method DeregisterFromWorkMail(DeregisterFromWorkMailRequest)

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

Public Method DeregisterFromWorkMailAsync(DeregisterFromWorkMailRequest, CancellationToken)

Initiates the asynchronous execution of the DeregisterFromWorkMail operation.

Public Method DescribeGroup(DescribeGroupRequest)

Returns the data available for the group.

Public Method DescribeGroupAsync(DescribeGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeGroup operation.

Public Method DescribeOrganization(DescribeOrganizationRequest)

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

Public Method DescribeOrganizationAsync(DescribeOrganizationRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeOrganization operation.

Public Method DescribeResource(DescribeResourceRequest)

Returns the data available for the resource.

Public Method DescribeResourceAsync(DescribeResourceRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeResource operation.

Public Method DescribeUser(DescribeUserRequest)

Provides information regarding the user.

Public Method DescribeUserAsync(DescribeUserRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeUser operation.

Public Method DisassociateDelegateFromResource(DisassociateDelegateFromResourceRequest)

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

Public Method DisassociateDelegateFromResourceAsync(DisassociateDelegateFromResourceRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateDelegateFromResource operation.

Public Method DisassociateMemberFromGroup(DisassociateMemberFromGroupRequest)

Removes a member from a group.

Public Method DisassociateMemberFromGroupAsync(DisassociateMemberFromGroupRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateMemberFromGroup operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ListAliases(ListAliasesRequest)

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

Public Method ListAliasesAsync(ListAliasesRequest, CancellationToken)

Initiates the asynchronous execution of the ListAliases operation.

Public Method ListGroupMembers(ListGroupMembersRequest)

Returns an overview of the members of a group.

Public Method ListGroupMembersAsync(ListGroupMembersRequest, CancellationToken)

Initiates the asynchronous execution of the ListGroupMembers operation.

Public Method ListGroups(ListGroupsRequest)

Returns summaries of the organization's groups.

Public Method ListGroupsAsync(ListGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the ListGroups operation.

Public Method ListMailboxPermissions(ListMailboxPermissionsRequest)

Lists the mailbox permissions associated with a mailbox.

Public Method ListMailboxPermissionsAsync(ListMailboxPermissionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListMailboxPermissions operation.

Public Method ListOrganizations(ListOrganizationsRequest)

Returns summaries of the customer's non-deleted organizations.

Public Method ListOrganizationsAsync(ListOrganizationsRequest, CancellationToken)

Initiates the asynchronous execution of the ListOrganizations operation.

Public Method ListResourceDelegates(ListResourceDelegatesRequest)

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

Public Method ListResourceDelegatesAsync(ListResourceDelegatesRequest, CancellationToken)

Initiates the asynchronous execution of the ListResourceDelegates operation.

Public Method ListResources(ListResourcesRequest)

Returns summaries of the organization's resources.

Public Method ListResourcesAsync(ListResourcesRequest, CancellationToken)

Initiates the asynchronous execution of the ListResources operation.

Public Method ListUsers(ListUsersRequest)

Returns summaries of the organization's users.

Public Method ListUsersAsync(ListUsersRequest, CancellationToken)

Initiates the asynchronous execution of the ListUsers operation.

Public Method PutMailboxPermissions(PutMailboxPermissionsRequest)

Sets permissions for a user or group. This replaces any pre-existing permissions set for the entity.

Public Method PutMailboxPermissionsAsync(PutMailboxPermissionsRequest, CancellationToken)

Initiates the asynchronous execution of the PutMailboxPermissions operation.

Public Method RegisterToWorkMail(RegisterToWorkMailRequest)

Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the entity is enabled and fails if the entity 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 or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

Public Method RegisterToWorkMailAsync(RegisterToWorkMailRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterToWorkMail operation.

Public Method ResetPassword(ResetPasswordRequest)

Allows the administrator to reset the password for a user.

Public Method ResetPasswordAsync(ResetPasswordRequest, CancellationToken)

Initiates the asynchronous execution of the ResetPassword operation.

Public Method UpdatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest)

Updates the primary email for an entity. 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.

Public Method UpdatePrimaryEmailAddressAsync(UpdatePrimaryEmailAddressRequest, CancellationToken)

Initiates the asynchronous execution of the UpdatePrimaryEmailAddress operation.

Public Method UpdateResource(UpdateResourceRequest)

Updates data for the resource. It must be preceded by a describe call in order to have the latest information. The dataset in the request should be the one expected when performing another describe call.

Public Method UpdateResourceAsync(UpdateResourceRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateResource operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms