@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.
|
AssumeImpersonationRoleResult |
assumeImpersonationRole(AssumeImpersonationRoleRequest request)
Assumes an impersonation role for the given WorkMail organization.
|
CancelMailboxExportJobResult |
cancelMailboxExportJob(CancelMailboxExportJobRequest request)
Cancels a mailbox export job.
|
CreateAliasResult |
createAlias(CreateAliasRequest request)
Adds an alias to the set of a given member (user or group) of WorkMail.
|
CreateAvailabilityConfigurationResult |
createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest request)
Creates an
AvailabilityConfiguration for the given WorkMail organization and domain. |
CreateGroupResult |
createGroup(CreateGroupRequest request)
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
|
CreateImpersonationRoleResult |
createImpersonationRole(CreateImpersonationRoleRequest request)
Creates an impersonation role for the given WorkMail organization.
|
CreateMobileDeviceAccessRuleResult |
createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest request)
Creates a new mobile device access rule for the specified WorkMail organization.
|
CreateOrganizationResult |
createOrganization(CreateOrganizationRequest request)
Creates a new WorkMail organization.
|
CreateResourceResult |
createResource(CreateResourceRequest request)
Creates a new WorkMail resource.
|
CreateUserResult |
createUser(CreateUserRequest request)
Creates a user who can be used in 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.
|
DeleteAvailabilityConfigurationResult |
deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest request)
Deletes the
AvailabilityConfiguration for the given WorkMail organization and domain. |
DeleteEmailMonitoringConfigurationResult |
deleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest request)
Deletes the email monitoring configuration for a specified organization.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest request)
Deletes a group from WorkMail.
|
DeleteImpersonationRoleResult |
deleteImpersonationRole(DeleteImpersonationRoleRequest request)
Deletes an impersonation role for the given WorkMail organization.
|
DeleteMailboxPermissionsResult |
deleteMailboxPermissions(DeleteMailboxPermissionsRequest request)
Deletes permissions granted to a member (user or group).
|
DeleteMobileDeviceAccessOverrideResult |
deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest request)
Deletes the mobile device access override for the given WorkMail organization, user, and device.
|
DeleteMobileDeviceAccessRuleResult |
deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest request)
Deletes a mobile device access rule for the specified WorkMail organization.
|
DeleteOrganizationResult |
deleteOrganization(DeleteOrganizationRequest request)
Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the
organization.
|
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 WorkMail and all subsequent systems.
|
DeregisterFromWorkMailResult |
deregisterFromWorkMail(DeregisterFromWorkMailRequest request)
Mark a user, group, or resource as no longer used in WorkMail.
|
DeregisterMailDomainResult |
deregisterMailDomain(DeregisterMailDomainRequest request)
Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail
use.
|
DescribeEmailMonitoringConfigurationResult |
describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest request)
Describes the current email monitoring configuration for a specified organization.
|
DescribeEntityResult |
describeEntity(DescribeEntityRequest request)
Returns basic details about an entity in WorkMail.
|
DescribeGroupResult |
describeGroup(DescribeGroupRequest request)
Returns the data available for the group.
|
DescribeInboundDmarcSettingsResult |
describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest request)
Lists the settings in a DMARC policy for a specified organization.
|
DescribeMailboxExportJobResult |
describeMailboxExportJob(DescribeMailboxExportJobRequest request)
Describes the current status of a mailbox export job.
|
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, and user ID or impersonation role 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.
|
GetImpersonationRoleResult |
getImpersonationRole(GetImpersonationRoleRequest request)
Gets the impersonation role details for the given WorkMail organization.
|
GetImpersonationRoleEffectResult |
getImpersonationRoleEffect(GetImpersonationRoleEffectRequest request)
Tests whether the given impersonation role can impersonate a target user.
|
GetMailboxDetailsResult |
getMailboxDetails(GetMailboxDetailsRequest request)
Requests a user's mailbox details for a specified organization and user.
|
GetMailDomainResult |
getMailDomain(GetMailDomainRequest request)
Gets details for a mail domain, including domain records required to configure your domain with recommended
security.
|
GetMobileDeviceAccessEffectResult |
getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest request)
Simulates the effect of the mobile device access rules for the given attributes of a sample access event.
|
GetMobileDeviceAccessOverrideResult |
getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest request)
Gets the mobile device access override for the given WorkMail organization, user, and device.
|
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.
|
ListAvailabilityConfigurationsResult |
listAvailabilityConfigurations(ListAvailabilityConfigurationsRequest request)
List all the
AvailabilityConfiguration's for the given WorkMail organization. |
ListGroupMembersResult |
listGroupMembers(ListGroupMembersRequest request)
Returns an overview of the members of a group.
|
ListGroupsResult |
listGroups(ListGroupsRequest request)
Returns summaries of the organization's groups.
|
ListGroupsForEntityResult |
listGroupsForEntity(ListGroupsForEntityRequest request)
Returns all the groups to which an entity belongs.
|
ListImpersonationRolesResult |
listImpersonationRoles(ListImpersonationRolesRequest request)
Lists all the impersonation roles for the given WorkMail organization.
|
ListMailboxExportJobsResult |
listMailboxExportJobs(ListMailboxExportJobsRequest request)
Lists the mailbox export jobs started for the specified organization within the last seven days.
|
ListMailboxPermissionsResult |
listMailboxPermissions(ListMailboxPermissionsRequest request)
Lists the mailbox permissions associated with a user, group, or resource mailbox.
|
ListMailDomainsResult |
listMailDomains(ListMailDomainsRequest request)
Lists the mail domains in a given WorkMail organization.
|
ListMobileDeviceAccessOverridesResult |
listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest request)
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
|
ListMobileDeviceAccessRulesResult |
listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest request)
Lists the mobile device access rules for the specified WorkMail organization.
|
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 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.
|
PutEmailMonitoringConfigurationResult |
putEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest request)
Creates or updates the email monitoring configuration for a specified organization.
|
PutInboundDmarcSettingsResult |
putInboundDmarcSettings(PutInboundDmarcSettingsRequest request)
Enables or disables a DMARC policy for a given organization.
|
PutMailboxPermissionsResult |
putMailboxPermissions(PutMailboxPermissionsRequest request)
Sets permissions for a user, group, or resource.
|
PutMobileDeviceAccessOverrideResult |
putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest request)
Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
|
PutRetentionPolicyResult |
putRetentionPolicy(PutRetentionPolicyRequest request)
Puts a retention policy to the specified organization.
|
RegisterMailDomainResult |
registerMailDomain(RegisterMailDomainRequest request)
Registers a new domain in WorkMail and SES, and configures it for use by WorkMail.
|
RegisterToWorkMailResult |
registerToWorkMail(RegisterToWorkMailRequest request)
Registers an existing and disabled user, group, or resource for 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.
|
StartMailboxExportJobResult |
startMailboxExportJob(StartMailboxExportJobRequest request)
Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to
the specified Amazon Simple Storage Service (Amazon S3) bucket.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Applies the specified tags to the specified WorkMailorganization resource.
|
TestAvailabilityConfigurationResult |
testAvailabilityConfiguration(TestAvailabilityConfigurationRequest request)
Performs a test on an availability provider to ensure that access is allowed.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Untags the specified tags from the specified WorkMail organization resource.
|
UpdateAvailabilityConfigurationResult |
updateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest request)
Updates an existing
AvailabilityConfiguration for the given WorkMail organization and domain. |
UpdateDefaultMailDomainResult |
updateDefaultMailDomain(UpdateDefaultMailDomainRequest request)
Updates the default mail domain for an organization.
|
UpdateGroupResult |
updateGroup(UpdateGroupRequest request)
Updates attibutes in a group.
|
UpdateImpersonationRoleResult |
updateImpersonationRole(UpdateImpersonationRoleRequest request)
Updates an impersonation role for the given WorkMail organization.
|
UpdateMailboxQuotaResult |
updateMailboxQuota(UpdateMailboxQuotaRequest request)
Updates a user's current mailbox quota for a specified organization and user.
|
UpdateMobileDeviceAccessRuleResult |
updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest request)
Updates a mobile device access rule for the specified WorkMail organization.
|
UpdatePrimaryEmailAddressResult |
updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest request)
Updates the primary email for a user, group, or resource.
|
UpdateResourceResult |
updateResource(UpdateResourceRequest request)
Updates data for the resource.
|
UpdateUserResult |
updateUser(UpdateUserRequest request)
Updates data for the user.
|
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 AssumeImpersonationRoleResult assumeImpersonationRole(AssumeImpersonationRoleRequest request)
AmazonWorkMailAssumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.
assumeImpersonationRole in interface AmazonWorkMailpublic CancelMailboxExportJobResult cancelMailboxExportJob(CancelMailboxExportJobRequest request)
AmazonWorkMailCancels a mailbox export job.
If the mailbox export job is near completion, it might not be possible to cancel it.
cancelMailboxExportJob in interface AmazonWorkMailpublic CreateAliasResult createAlias(CreateAliasRequest request)
AmazonWorkMailAdds an alias to the set of a given member (user or group) of WorkMail.
createAlias in interface AmazonWorkMailpublic CreateAvailabilityConfigurationResult createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest request)
AmazonWorkMail
Creates an AvailabilityConfiguration for the given WorkMail organization and domain.
createAvailabilityConfiguration in interface AmazonWorkMailpublic CreateGroupResult createGroup(CreateGroupRequest request)
AmazonWorkMailCreates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
createGroup in interface AmazonWorkMailpublic CreateImpersonationRoleResult createImpersonationRole(CreateImpersonationRoleRequest request)
AmazonWorkMailCreates an impersonation role for the given WorkMail organization.
Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries also complete successfully without performing any further actions.
createImpersonationRole in interface AmazonWorkMailpublic CreateMobileDeviceAccessRuleResult createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest request)
AmazonWorkMailCreates a new mobile device access rule for the specified WorkMail organization.
createMobileDeviceAccessRule in interface AmazonWorkMailpublic CreateOrganizationResult createOrganization(CreateOrganizationRequest request)
AmazonWorkMailCreates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new WorkMail directory for you. For more information, see Adding an organization in the WorkMail Administrator Guide.
You can associate multiple email domains with an organization, then choose your default email domain from the WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the WorkMail Administrator Guide.
Optionally, you can use a customer managed key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, WorkMail creates a default, AWS managed key for you.
createOrganization in interface AmazonWorkMailpublic CreateResourceResult createResource(CreateResourceRequest request)
AmazonWorkMailCreates a new WorkMail resource.
createResource in interface AmazonWorkMailpublic CreateUserResult createUser(CreateUserRequest request)
AmazonWorkMailCreates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
createUser in interface AmazonWorkMailpublic DeleteAccessControlRuleResult deleteAccessControlRule(DeleteAccessControlRuleRequest request)
AmazonWorkMailDeletes an access control rule for the specified WorkMail organization.
Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
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 DeleteAvailabilityConfigurationResult deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest request)
AmazonWorkMail
Deletes the AvailabilityConfiguration for the given WorkMail organization and domain.
deleteAvailabilityConfiguration in interface AmazonWorkMailpublic DeleteEmailMonitoringConfigurationResult deleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest request)
AmazonWorkMailDeletes the email monitoring configuration for a specified organization.
deleteEmailMonitoringConfiguration in interface AmazonWorkMailpublic DeleteGroupResult deleteGroup(DeleteGroupRequest request)
AmazonWorkMailDeletes a group from WorkMail.
deleteGroup in interface AmazonWorkMailpublic DeleteImpersonationRoleResult deleteImpersonationRole(DeleteImpersonationRoleRequest request)
AmazonWorkMailDeletes an impersonation role for the given WorkMail organization.
deleteImpersonationRole in interface AmazonWorkMailpublic DeleteMailboxPermissionsResult deleteMailboxPermissions(DeleteMailboxPermissionsRequest request)
AmazonWorkMailDeletes permissions granted to a member (user or group).
deleteMailboxPermissions in interface AmazonWorkMailpublic DeleteMobileDeviceAccessOverrideResult deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest request)
AmazonWorkMailDeletes the mobile device access override for the given WorkMail organization, user, and device.
Deleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
deleteMobileDeviceAccessOverride in interface AmazonWorkMailpublic DeleteMobileDeviceAccessRuleResult deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest request)
AmazonWorkMailDeletes a mobile device access rule for the specified WorkMail organization.
Deleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
deleteMobileDeviceAccessRule in interface AmazonWorkMailpublic DeleteOrganizationResult deleteOrganization(DeleteOrganizationRequest request)
AmazonWorkMailDeletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.
deleteOrganization 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 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 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 DeregisterMailDomainResult deregisterMailDomain(DeregisterMailDomainRequest request)
AmazonWorkMailRemoves a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.
deregisterMailDomain in interface AmazonWorkMailpublic DescribeEmailMonitoringConfigurationResult describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest request)
AmazonWorkMailDescribes the current email monitoring configuration for a specified organization.
describeEmailMonitoringConfiguration in interface AmazonWorkMailpublic DescribeEntityResult describeEntity(DescribeEntityRequest request)
AmazonWorkMailReturns basic details about an entity in WorkMail.
describeEntity in interface AmazonWorkMailpublic DescribeGroupResult describeGroup(DescribeGroupRequest request)
AmazonWorkMailReturns the data available for the group.
describeGroup in interface AmazonWorkMailpublic DescribeInboundDmarcSettingsResult describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest request)
AmazonWorkMailLists the settings in a DMARC policy for a specified organization.
describeInboundDmarcSettings in interface AmazonWorkMailpublic DescribeMailboxExportJobResult describeMailboxExportJob(DescribeMailboxExportJobRequest request)
AmazonWorkMailDescribes the current status of a mailbox export job.
describeMailboxExportJob 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, and user ID or impersonation role ID. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.
getAccessControlEffect in interface AmazonWorkMailpublic GetDefaultRetentionPolicyResult getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest request)
AmazonWorkMailGets the default retention policy details for the specified organization.
getDefaultRetentionPolicy in interface AmazonWorkMailpublic GetImpersonationRoleResult getImpersonationRole(GetImpersonationRoleRequest request)
AmazonWorkMailGets the impersonation role details for the given WorkMail organization.
getImpersonationRole in interface AmazonWorkMailpublic GetImpersonationRoleEffectResult getImpersonationRoleEffect(GetImpersonationRoleEffectRequest request)
AmazonWorkMailTests whether the given impersonation role can impersonate a target user.
getImpersonationRoleEffect in interface AmazonWorkMailpublic GetMailDomainResult getMailDomain(GetMailDomainRequest request)
AmazonWorkMailGets details for a mail domain, including domain records required to configure your domain with recommended security.
getMailDomain in interface AmazonWorkMailpublic GetMailboxDetailsResult getMailboxDetails(GetMailboxDetailsRequest request)
AmazonWorkMailRequests a user's mailbox details for a specified organization and user.
getMailboxDetails in interface AmazonWorkMailpublic GetMobileDeviceAccessEffectResult getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest request)
AmazonWorkMailSimulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current set of mobile device access rules for the WorkMail organization for a particular user's attributes.
getMobileDeviceAccessEffect in interface AmazonWorkMailpublic GetMobileDeviceAccessOverrideResult getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest request)
AmazonWorkMailGets the mobile device access override for the given WorkMail organization, user, and device.
getMobileDeviceAccessOverride 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 ListAvailabilityConfigurationsResult listAvailabilityConfigurations(ListAvailabilityConfigurationsRequest request)
AmazonWorkMail
List all the AvailabilityConfiguration's for the given WorkMail organization.
listAvailabilityConfigurations 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 ListGroupsForEntityResult listGroupsForEntity(ListGroupsForEntityRequest request)
AmazonWorkMailReturns all the groups to which an entity belongs.
listGroupsForEntity in interface AmazonWorkMailpublic ListImpersonationRolesResult listImpersonationRoles(ListImpersonationRolesRequest request)
AmazonWorkMailLists all the impersonation roles for the given WorkMail organization.
listImpersonationRoles in interface AmazonWorkMailpublic ListMailDomainsResult listMailDomains(ListMailDomainsRequest request)
AmazonWorkMailLists the mail domains in a given WorkMail organization.
listMailDomains in interface AmazonWorkMailpublic ListMailboxExportJobsResult listMailboxExportJobs(ListMailboxExportJobsRequest request)
AmazonWorkMailLists the mailbox export jobs started for the specified organization within the last seven days.
listMailboxExportJobs in interface AmazonWorkMailpublic ListMailboxPermissionsResult listMailboxPermissions(ListMailboxPermissionsRequest request)
AmazonWorkMailLists the mailbox permissions associated with a user, group, or resource mailbox.
listMailboxPermissions in interface AmazonWorkMailpublic ListMobileDeviceAccessOverridesResult listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest request)
AmazonWorkMailLists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
listMobileDeviceAccessOverrides in interface AmazonWorkMailpublic ListMobileDeviceAccessRulesResult listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest request)
AmazonWorkMailLists the mobile device access rules for the specified WorkMail organization.
listMobileDeviceAccessRules 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 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, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
putAccessControlRule in interface AmazonWorkMailpublic PutEmailMonitoringConfigurationResult putEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest request)
AmazonWorkMailCreates or updates the email monitoring configuration for a specified organization.
putEmailMonitoringConfiguration in interface AmazonWorkMailpublic PutInboundDmarcSettingsResult putInboundDmarcSettings(PutInboundDmarcSettingsRequest request)
AmazonWorkMailEnables or disables a DMARC policy for a given organization.
putInboundDmarcSettings 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 PutMobileDeviceAccessOverrideResult putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest request)
AmazonWorkMailCreates or updates a mobile device access override for the given WorkMail organization, user, and device.
putMobileDeviceAccessOverride in interface AmazonWorkMailpublic PutRetentionPolicyResult putRetentionPolicy(PutRetentionPolicyRequest request)
AmazonWorkMailPuts a retention policy to the specified organization.
putRetentionPolicy in interface AmazonWorkMailpublic RegisterMailDomainResult registerMailDomain(RegisterMailDomainRequest request)
AmazonWorkMailRegisters a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users' emails.
registerMailDomain in interface AmazonWorkMailpublic RegisterToWorkMailResult registerToWorkMail(RegisterToWorkMailRequest request)
AmazonWorkMailRegisters an existing and disabled user, group, or resource for 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 StartMailboxExportJobResult startMailboxExportJob(StartMailboxExportJobRequest request)
AmazonWorkMailStarts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.
startMailboxExportJob in interface AmazonWorkMailpublic TagResourceResult tagResource(TagResourceRequest request)
AmazonWorkMailApplies the specified tags to the specified WorkMailorganization resource.
tagResource in interface AmazonWorkMailpublic TestAvailabilityConfigurationResult testAvailabilityConfiguration(TestAvailabilityConfigurationRequest request)
AmazonWorkMail
Performs a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided
credentials can be used to successfully log in. For Lambda, it verifies that the Lambda function can be invoked
and that the resource access policy was configured to deny anonymous access. An anonymous invocation is one done
without providing either a SourceArn or SourceAccount header.
The request must contain either one provider definition (EwsProvider or LambdaProvider)
or the DomainName parameter. If the DomainName parameter is provided, the configuration
stored under the DomainName will be tested.
testAvailabilityConfiguration in interface AmazonWorkMailpublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonWorkMailUntags the specified tags from the specified WorkMail organization resource.
untagResource in interface AmazonWorkMailpublic UpdateAvailabilityConfigurationResult updateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest request)
AmazonWorkMail
Updates an existing AvailabilityConfiguration for the given WorkMail organization and domain.
updateAvailabilityConfiguration in interface AmazonWorkMailpublic UpdateDefaultMailDomainResult updateDefaultMailDomain(UpdateDefaultMailDomainRequest request)
AmazonWorkMailUpdates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.
updateDefaultMailDomain in interface AmazonWorkMailpublic UpdateGroupResult updateGroup(UpdateGroupRequest request)
AmazonWorkMailUpdates attibutes in a group.
updateGroup in interface AmazonWorkMailpublic UpdateImpersonationRoleResult updateImpersonationRole(UpdateImpersonationRoleRequest request)
AmazonWorkMailUpdates an impersonation role for the given WorkMail organization.
updateImpersonationRole in interface AmazonWorkMailpublic UpdateMailboxQuotaResult updateMailboxQuota(UpdateMailboxQuotaRequest request)
AmazonWorkMailUpdates a user's current mailbox quota for a specified organization and user.
updateMailboxQuota in interface AmazonWorkMailpublic UpdateMobileDeviceAccessRuleResult updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest request)
AmazonWorkMailUpdates a mobile device access rule for the specified WorkMail organization.
updateMobileDeviceAccessRule 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 UpdateUserResult updateUser(UpdateUserRequest request)
AmazonWorkMail
Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The
dataset in the request should be the one expected when performing another DescribeUser call.
updateUser 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.