@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonWorkMail extends Object implements AmazonWorkMail
AmazonWorkMail. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AssociateDelegateToResourceResult |
associateDelegateToResource(AssociateDelegateToResourceRequest request)
Adds a member (user or group) to the resource's set of delegates.
|
AssociateMemberToGroupResult |
associateMemberToGroup(AssociateMemberToGroupRequest request)
Adds a member (user or group) to the group's set.
|
CreateAliasResult |
createAlias(CreateAliasRequest request)
Adds an alias to the set of a given member (user or group) of Amazon WorkMail.
|
CreateGroupResult |
createGroup(CreateGroupRequest request)
Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
CreateResourceResult |
createResource(CreateResourceRequest request)
Creates a new Amazon WorkMail resource.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
|
DeleteAccessControlRuleResult |
deleteAccessControlRule(DeleteAccessControlRuleRequest request)
Deletes an access control rule for the specified WorkMail organization.
|
DeleteAliasResult |
deleteAlias(DeleteAliasRequest request)
Remove one or more specified aliases from a set of aliases for a given user.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest request)
Deletes a group from Amazon WorkMail.
|
DeleteMailboxPermissionsResult |
deleteMailboxPermissions(DeleteMailboxPermissionsRequest request)
Deletes permissions granted to a member (user or group).
|
DeleteResourceResult |
deleteResource(DeleteResourceRequest request)
Deletes the specified resource.
|
DeleteRetentionPolicyResult |
deleteRetentionPolicy(DeleteRetentionPolicyRequest request)
Deletes the specified retention policy from the specified organization.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes a user from Amazon WorkMail and all subsequent systems.
|
DeregisterFromWorkMailResult |
deregisterFromWorkMail(DeregisterFromWorkMailRequest request)
Mark a user, group, or resource as no longer used in Amazon WorkMail.
|
DescribeGroupResult |
describeGroup(DescribeGroupRequest request)
Returns the data available for the group.
|
DescribeOrganizationResult |
describeOrganization(DescribeOrganizationRequest request)
Provides more information regarding a given organization based on its identifier.
|
DescribeResourceResult |
describeResource(DescribeResourceRequest request)
Returns the data available for the resource.
|
DescribeUserResult |
describeUser(DescribeUserRequest request)
Provides information regarding the user.
|
DisassociateDelegateFromResourceResult |
disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest request)
Removes a member from the resource's set of delegates.
|
DisassociateMemberFromGroupResult |
disassociateMemberFromGroup(DisassociateMemberFromGroupRequest request)
Removes a member from a group.
|
GetAccessControlEffectResult |
getAccessControlEffect(GetAccessControlEffectRequest request)
Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access
protocol action, or user ID.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDefaultRetentionPolicyResult |
getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest request)
Gets the default retention policy details for the specified organization.
|
GetMailboxDetailsResult |
getMailboxDetails(GetMailboxDetailsRequest request)
Requests a user's mailbox details for a specified organization and user.
|
ListAccessControlRulesResult |
listAccessControlRules(ListAccessControlRulesRequest request)
Lists the access control rules for the specified organization.
|
ListAliasesResult |
listAliases(ListAliasesRequest request)
Creates a paginated call to list the aliases associated with a given entity.
|
ListGroupMembersResult |
listGroupMembers(ListGroupMembersRequest request)
Returns an overview of the members of a group.
|
ListGroupsResult |
listGroups(ListGroupsRequest request)
Returns summaries of the organization's groups.
|
ListMailboxPermissionsResult |
listMailboxPermissions(ListMailboxPermissionsRequest request)
Lists the mailbox permissions associated with a user, group, or resource mailbox.
|
ListOrganizationsResult |
listOrganizations(ListOrganizationsRequest request)
Returns summaries of the customer's organizations.
|
ListResourceDelegatesResult |
listResourceDelegates(ListResourceDelegatesRequest request)
Lists the delegates associated with a resource.
|
ListResourcesResult |
listResources(ListResourcesRequest request)
Returns summaries of the organization's resources.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags applied to an Amazon WorkMail organization resource.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Returns summaries of the organization's users.
|
PutAccessControlRuleResult |
putAccessControlRule(PutAccessControlRuleRequest request)
Adds a new access control rule for the specified organization.
|
PutMailboxPermissionsResult |
putMailboxPermissions(PutMailboxPermissionsRequest request)
Sets permissions for a user, group, or resource.
|
PutRetentionPolicyResult |
putRetentionPolicy(PutRetentionPolicyRequest request)
Puts a retention policy to the specified organization.
|
RegisterToWorkMailResult |
registerToWorkMail(RegisterToWorkMailRequest request)
Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and
calendaring capabilities.
|
ResetPasswordResult |
resetPassword(ResetPasswordRequest request)
Allows the administrator to reset the password for a user.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Applies the specified tags to the specified Amazon WorkMail organization resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Untags the specified tags from the specified Amazon WorkMail organization resource.
|
UpdateMailboxQuotaResult |
updateMailboxQuota(UpdateMailboxQuotaRequest request)
Updates a user's current mailbox quota for a specified organization and user.
|
UpdatePrimaryEmailAddressResult |
updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest request)
Updates the primary email for a user, group, or resource.
|
UpdateResourceResult |
updateResource(UpdateResourceRequest request)
Updates data for the resource.
|
public AssociateDelegateToResourceResult associateDelegateToResource(AssociateDelegateToResourceRequest request)
AmazonWorkMailAdds a member (user or group) to the resource's set of delegates.
associateDelegateToResource in interface AmazonWorkMailpublic AssociateMemberToGroupResult associateMemberToGroup(AssociateMemberToGroupRequest request)
AmazonWorkMailAdds a member (user or group) to the group's set.
associateMemberToGroup in interface AmazonWorkMailpublic CreateAliasResult createAlias(CreateAliasRequest request)
AmazonWorkMailAdds an alias to the set of a given member (user or group) of Amazon WorkMail.
createAlias in interface AmazonWorkMailpublic CreateGroupResult createGroup(CreateGroupRequest request)
AmazonWorkMailCreates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
createGroup in interface AmazonWorkMailpublic CreateResourceResult createResource(CreateResourceRequest request)
AmazonWorkMailCreates a new Amazon WorkMail resource.
createResource in interface AmazonWorkMailpublic CreateUserResult createUser(CreateUserRequest request)
AmazonWorkMailCreates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.
createUser in interface AmazonWorkMailpublic DeleteAccessControlRuleResult deleteAccessControlRule(DeleteAccessControlRuleRequest request)
AmazonWorkMailDeletes an access control rule for the specified WorkMail organization.
deleteAccessControlRule in interface AmazonWorkMailpublic DeleteAliasResult deleteAlias(DeleteAliasRequest request)
AmazonWorkMailRemove one or more specified aliases from a set of aliases for a given user.
deleteAlias in interface AmazonWorkMailpublic DeleteGroupResult deleteGroup(DeleteGroupRequest request)
AmazonWorkMailDeletes a group from Amazon WorkMail.
deleteGroup in interface AmazonWorkMailpublic DeleteMailboxPermissionsResult deleteMailboxPermissions(DeleteMailboxPermissionsRequest request)
AmazonWorkMailDeletes permissions granted to a member (user or group).
deleteMailboxPermissions in interface AmazonWorkMailpublic DeleteResourceResult deleteResource(DeleteResourceRequest request)
AmazonWorkMailDeletes the specified resource.
deleteResource in interface AmazonWorkMailpublic DeleteRetentionPolicyResult deleteRetentionPolicy(DeleteRetentionPolicyRequest request)
AmazonWorkMailDeletes the specified retention policy from the specified organization.
deleteRetentionPolicy in interface AmazonWorkMailpublic DeleteUserResult deleteUser(DeleteUserRequest request)
AmazonWorkMail
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.
deleteUser in interface AmazonWorkMailpublic DeregisterFromWorkMailResult deregisterFromWorkMail(DeregisterFromWorkMailRequest request)
AmazonWorkMailMark 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.
deregisterFromWorkMail in interface AmazonWorkMailpublic DescribeGroupResult describeGroup(DescribeGroupRequest request)
AmazonWorkMailReturns the data available for the group.
describeGroup in interface AmazonWorkMailpublic DescribeOrganizationResult describeOrganization(DescribeOrganizationRequest request)
AmazonWorkMailProvides more information regarding a given organization based on its identifier.
describeOrganization in interface AmazonWorkMailpublic DescribeResourceResult describeResource(DescribeResourceRequest request)
AmazonWorkMailReturns the data available for the resource.
describeResource in interface AmazonWorkMailpublic DescribeUserResult describeUser(DescribeUserRequest request)
AmazonWorkMailProvides information regarding the user.
describeUser in interface AmazonWorkMailpublic DisassociateDelegateFromResourceResult disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest request)
AmazonWorkMailRemoves a member from the resource's set of delegates.
disassociateDelegateFromResource in interface AmazonWorkMailpublic DisassociateMemberFromGroupResult disassociateMemberFromGroup(DisassociateMemberFromGroupRequest request)
AmazonWorkMailRemoves a member from a group.
disassociateMemberFromGroup in interface AmazonWorkMailpublic GetAccessControlEffectResult getAccessControlEffect(GetAccessControlEffectRequest request)
AmazonWorkMailGets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, or user ID.
getAccessControlEffect in interface AmazonWorkMailpublic GetDefaultRetentionPolicyResult getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest request)
AmazonWorkMailGets the default retention policy details for the specified organization.
getDefaultRetentionPolicy in interface AmazonWorkMailpublic GetMailboxDetailsResult getMailboxDetails(GetMailboxDetailsRequest request)
AmazonWorkMailRequests a user's mailbox details for a specified organization and user.
getMailboxDetails in interface AmazonWorkMailpublic ListAccessControlRulesResult listAccessControlRules(ListAccessControlRulesRequest request)
AmazonWorkMailLists the access control rules for the specified organization.
listAccessControlRules in interface AmazonWorkMailpublic ListAliasesResult listAliases(ListAliasesRequest request)
AmazonWorkMailCreates a paginated call to list the aliases associated with a given entity.
listAliases in interface AmazonWorkMailpublic ListGroupMembersResult listGroupMembers(ListGroupMembersRequest request)
AmazonWorkMailReturns an overview of the members of a group. Users and groups can be members of a group.
listGroupMembers in interface AmazonWorkMailpublic ListGroupsResult listGroups(ListGroupsRequest request)
AmazonWorkMailReturns summaries of the organization's groups.
listGroups in interface AmazonWorkMailpublic ListMailboxPermissionsResult listMailboxPermissions(ListMailboxPermissionsRequest request)
AmazonWorkMailLists the mailbox permissions associated with a user, group, or resource mailbox.
listMailboxPermissions in interface AmazonWorkMailpublic ListOrganizationsResult listOrganizations(ListOrganizationsRequest request)
AmazonWorkMailReturns summaries of the customer's organizations.
listOrganizations in interface AmazonWorkMailpublic ListResourceDelegatesResult listResourceDelegates(ListResourceDelegatesRequest request)
AmazonWorkMailLists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
listResourceDelegates in interface AmazonWorkMailpublic ListResourcesResult listResources(ListResourcesRequest request)
AmazonWorkMailReturns summaries of the organization's resources.
listResources in interface AmazonWorkMailpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonWorkMailLists the tags applied to an Amazon WorkMail organization resource.
listTagsForResource in interface AmazonWorkMailpublic ListUsersResult listUsers(ListUsersRequest request)
AmazonWorkMailReturns summaries of the organization's users.
listUsers in interface AmazonWorkMailpublic PutAccessControlRuleResult putAccessControlRule(PutAccessControlRuleRequest request)
AmazonWorkMailAdds 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.
putAccessControlRule in interface AmazonWorkMailpublic PutMailboxPermissionsResult putMailboxPermissions(PutMailboxPermissionsRequest request)
AmazonWorkMailSets permissions for a user, group, or resource. This replaces any pre-existing permissions.
putMailboxPermissions in interface AmazonWorkMailpublic PutRetentionPolicyResult putRetentionPolicy(PutRetentionPolicyRequest request)
AmazonWorkMailPuts a retention policy to the specified organization.
putRetentionPolicy in interface AmazonWorkMailpublic RegisterToWorkMailResult registerToWorkMail(RegisterToWorkMailRequest request)
AmazonWorkMailRegisters 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.
registerToWorkMail in interface AmazonWorkMailpublic ResetPasswordResult resetPassword(ResetPasswordRequest request)
AmazonWorkMailAllows the administrator to reset the password for a user.
resetPassword in interface AmazonWorkMailpublic TagResourceResult tagResource(TagResourceRequest request)
AmazonWorkMailApplies the specified tags to the specified Amazon WorkMail organization resource.
tagResource in interface AmazonWorkMailpublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonWorkMailUntags the specified tags from the specified Amazon WorkMail organization resource.
untagResource in interface AmazonWorkMailpublic UpdateMailboxQuotaResult updateMailboxQuota(UpdateMailboxQuotaRequest request)
AmazonWorkMailUpdates a user's current mailbox quota for a specified organization and user.
updateMailboxQuota in interface AmazonWorkMailpublic UpdatePrimaryEmailAddressResult updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest request)
AmazonWorkMailUpdates 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.
updatePrimaryEmailAddress in interface AmazonWorkMailpublic UpdateResourceResult updateResource(UpdateResourceRequest request)
AmazonWorkMail
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.
updateResource in interface AmazonWorkMailpublic void shutdown()
AmazonWorkMailshutdown in interface AmazonWorkMailpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonWorkMailResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonWorkMailrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.