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.

Classes

NameDescription
Class AssociateDelegateToResourceRequest

Container for the parameters to the AssociateDelegateToResource operation. Adds a member to the resource's set of delegates.

Class AssociateDelegateToResourceResponse

This is the response object from the AssociateDelegateToResource operation.

Class AssociateMemberToGroupRequest

Container for the parameters to the AssociateMemberToGroup operation. Adds a member to the group's set.

Class AssociateMemberToGroupResponse

This is the response object from the AssociateMemberToGroup operation.

Class BookingOptions

At least one delegate must be associated to the resource to disable automatic replies from the resource.

Class CreateAliasRequest

Container for the parameters to the CreateAlias operation. Adds an alias to the set of a given member of Amazon WorkMail.

Class CreateAliasResponse

This is the response object from the CreateAlias operation.

Class CreateGroupRequest

Container for the parameters to the CreateGroup operation. Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

Class CreateGroupResponse

This is the response object from the CreateGroup operation.

Class CreateResourceRequest

Container for the parameters to the CreateResource operation. Creates a new Amazon WorkMail resource. The available types are equipment and room.

Class CreateResourceResponse

This is the response object from the CreateResource operation.

Class CreateUserRequest

Container for the parameters to the CreateUser operation. Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

Class CreateUserResponse

This is the response object from the CreateUser operation.

Class Delegate

The name of the attribute, which is one of the values defined in the UserAttribute enumeration.

Class DeleteAliasRequest

Container for the parameters to the DeleteAlias operation. Remove the alias from a set of aliases for a given user.

Class DeleteAliasResponse

This is the response object from the DeleteAlias operation.

Class DeleteGroupRequest

Container for the parameters to the DeleteGroup operation. Deletes a group from Amazon WorkMail.

Class DeleteGroupResponse

This is the response object from the DeleteGroup operation.

Class DeleteMailboxPermissionsRequest

Container for the parameters to the DeleteMailboxPermissions operation. Deletes permissions granted to a user or group.

Class DeleteMailboxPermissionsResponse

This is the response object from the DeleteMailboxPermissions operation.

Class DeleteResourceRequest

Container for the parameters to the DeleteResource operation. Deletes the specified resource.

Class DeleteResourceResponse

This is the response object from the DeleteResource operation.

Class DeleteUserRequest

Container for the parameters to the DeleteUser operation. 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.

Class DeleteUserResponse

This is the response object from the DeleteUser operation.

Class DeregisterFromWorkMailRequest

Container for the parameters to the DeregisterFromWorkMail operation. 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.

Class DeregisterFromWorkMailResponse

This is the response object from the DeregisterFromWorkMail operation.

Class DescribeGroupRequest

Container for the parameters to the DescribeGroup operation. Returns the data available for the group.

Class DescribeGroupResponse

This is the response object from the DescribeGroup operation.

Class DescribeOrganizationRequest

Container for the parameters to the DescribeOrganization operation. Provides more information regarding a given organization based on its identifier.

Class DescribeOrganizationResponse

This is the response object from the DescribeOrganization operation.

Class DescribeResourceRequest

Container for the parameters to the DescribeResource operation. Returns the data available for the resource.

Class DescribeResourceResponse

This is the response object from the DescribeResource operation.

Class DescribeUserRequest

Container for the parameters to the DescribeUser operation. Provides information regarding the user.

Class DescribeUserResponse

This is the response object from the DescribeUser operation.

Class DirectoryServiceAuthenticationFailedException

WorkMail exception

Class DirectoryUnavailableException

WorkMail exception

Class DisassociateDelegateFromResourceRequest

Container for the parameters to the DisassociateDelegateFromResource operation. Removes a member from the resource's set of delegates.

Class DisassociateDelegateFromResourceResponse

This is the response object from the DisassociateDelegateFromResource operation.

Class DisassociateMemberFromGroupRequest

Container for the parameters to the DisassociateMemberFromGroup operation. Removes a member from a group.

Class DisassociateMemberFromGroupResponse

This is the response object from the DisassociateMemberFromGroup operation.

Class EmailAddressInUseException

WorkMail exception

Class EntityAlreadyRegisteredException

WorkMail exception

Class EntityNotFoundException

WorkMail exception

Class EntityStateException

WorkMail exception

Class Group

The representation of an Amazon WorkMail group.

Class InvalidConfigurationException

WorkMail exception

Class InvalidParameterException

WorkMail exception

Class InvalidPasswordException

WorkMail exception

Class ListAliasesRequest

Container for the parameters to the ListAliases operation. Creates a paginated call to list the aliases associated with a given entity.

Class ListAliasesResponse

This is the response object from the ListAliases operation.

Class ListGroupMembersRequest

Container for the parameters to the ListGroupMembers operation. Returns an overview of the members of a group.

Class ListGroupMembersResponse

This is the response object from the ListGroupMembers operation.

Class ListGroupsRequest

Container for the parameters to the ListGroups operation. Returns summaries of the organization's groups.

Class ListGroupsResponse

This is the response object from the ListGroups operation.

Class ListMailboxPermissionsRequest

Container for the parameters to the ListMailboxPermissions operation. Lists the mailbox permissions associated with a mailbox.

Class ListMailboxPermissionsResponse

This is the response object from the ListMailboxPermissions operation.

Class ListOrganizationsRequest

Container for the parameters to the ListOrganizations operation. Returns summaries of the customer's non-deleted organizations.

Class ListOrganizationsResponse

This is the response object from the ListOrganizations operation.

Class ListResourceDelegatesRequest

Container for the parameters to the ListResourceDelegates operation. Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.

Class ListResourceDelegatesResponse

This is the response object from the ListResourceDelegates operation.

Class ListResourcesRequest

Container for the parameters to the ListResources operation. Returns summaries of the organization's resources.

Class ListResourcesResponse

This is the response object from the ListResources operation.

Class ListUsersRequest

Container for the parameters to the ListUsers operation. Returns summaries of the organization's users.

Class ListUsersResponse

This is the response object from the ListUsers operation.

Class MailDomainNotFoundException

WorkMail exception

Class MailDomainStateException

WorkMail exception

Class Member

The representation of a group member (user or group).

Class NameAvailabilityException

WorkMail exception

Class OrganizationNotFoundException

WorkMail exception

Class OrganizationStateException

WorkMail exception

Class OrganizationSummary

The brief overview associated with an organization.

Class Permission

Permission granted to an entity (user, group) to access a certain aspect of another entity's mailbox.

Class PutMailboxPermissionsRequest

Container for the parameters to the PutMailboxPermissions operation. Sets permissions for a user or group. This replaces any pre-existing permissions set for the entity.

Class PutMailboxPermissionsResponse

This is the response object from the PutMailboxPermissions operation.

Class RegisterToWorkMailRequest

Container for the parameters to the RegisterToWorkMail operation. 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.

Class RegisterToWorkMailResponse

This is the response object from the RegisterToWorkMail operation.

Class ReservedNameException

WorkMail exception

Class ResetPasswordRequest

Container for the parameters to the ResetPassword operation. Allows the administrator to reset the password for a user.

Class ResetPasswordResponse

This is the response object from the ResetPassword operation.

Class Resource

The overview for a resource containing relevant data regarding it.

Class UnsupportedOperationException

WorkMail exception

Class UpdatePrimaryEmailAddressRequest

Container for the parameters to the UpdatePrimaryEmailAddress operation. 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.

Class UpdatePrimaryEmailAddressResponse

This is the response object from the UpdatePrimaryEmailAddress operation.

Class UpdateResourceRequest

Container for the parameters to the UpdateResource operation. 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.

Class UpdateResourceResponse

This is the response object from the UpdateResource operation.

Class User

The representation of an Amazon WorkMail user.