@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)
AmazonWorkMail
Adds a member (user or group) to the resource's set of delegates.
associateDelegateToResource
in interface AmazonWorkMail
public AssociateMemberToGroupResult associateMemberToGroup(AssociateMemberToGroupRequest request)
AmazonWorkMail
Adds a member (user or group) to the group's set.
associateMemberToGroup
in interface AmazonWorkMail
public AssumeImpersonationRoleResult assumeImpersonationRole(AssumeImpersonationRoleRequest request)
AmazonWorkMail
Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.
assumeImpersonationRole
in interface AmazonWorkMail
public CancelMailboxExportJobResult cancelMailboxExportJob(CancelMailboxExportJobRequest request)
AmazonWorkMail
Cancels a mailbox export job.
If the mailbox export job is near completion, it might not be possible to cancel it.
cancelMailboxExportJob
in interface AmazonWorkMail
public CreateAliasResult createAlias(CreateAliasRequest request)
AmazonWorkMail
Adds an alias to the set of a given member (user or group) of WorkMail.
createAlias
in interface AmazonWorkMail
public CreateAvailabilityConfigurationResult createAvailabilityConfiguration(CreateAvailabilityConfigurationRequest request)
AmazonWorkMail
Creates an AvailabilityConfiguration
for the given WorkMail organization and domain.
createAvailabilityConfiguration
in interface AmazonWorkMail
public CreateGroupResult createGroup(CreateGroupRequest request)
AmazonWorkMail
Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.
createGroup
in interface AmazonWorkMail
public CreateImpersonationRoleResult createImpersonationRole(CreateImpersonationRoleRequest request)
AmazonWorkMail
Creates 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 AmazonWorkMail
public CreateMobileDeviceAccessRuleResult createMobileDeviceAccessRule(CreateMobileDeviceAccessRuleRequest request)
AmazonWorkMail
Creates a new mobile device access rule for the specified WorkMail organization.
createMobileDeviceAccessRule
in interface AmazonWorkMail
public CreateOrganizationResult createOrganization(CreateOrganizationRequest request)
AmazonWorkMail
Creates 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 AmazonWorkMail
public CreateResourceResult createResource(CreateResourceRequest request)
AmazonWorkMail
Creates a new WorkMail resource.
createResource
in interface AmazonWorkMail
public CreateUserResult createUser(CreateUserRequest request)
AmazonWorkMail
Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.
createUser
in interface AmazonWorkMail
public DeleteAccessControlRuleResult deleteAccessControlRule(DeleteAccessControlRuleRequest request)
AmazonWorkMail
Deletes 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 AmazonWorkMail
public DeleteAliasResult deleteAlias(DeleteAliasRequest request)
AmazonWorkMail
Remove one or more specified aliases from a set of aliases for a given user.
deleteAlias
in interface AmazonWorkMail
public DeleteAvailabilityConfigurationResult deleteAvailabilityConfiguration(DeleteAvailabilityConfigurationRequest request)
AmazonWorkMail
Deletes the AvailabilityConfiguration
for the given WorkMail organization and domain.
deleteAvailabilityConfiguration
in interface AmazonWorkMail
public DeleteEmailMonitoringConfigurationResult deleteEmailMonitoringConfiguration(DeleteEmailMonitoringConfigurationRequest request)
AmazonWorkMail
Deletes the email monitoring configuration for a specified organization.
deleteEmailMonitoringConfiguration
in interface AmazonWorkMail
public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
AmazonWorkMail
Deletes a group from WorkMail.
deleteGroup
in interface AmazonWorkMail
public DeleteImpersonationRoleResult deleteImpersonationRole(DeleteImpersonationRoleRequest request)
AmazonWorkMail
Deletes an impersonation role for the given WorkMail organization.
deleteImpersonationRole
in interface AmazonWorkMail
public DeleteMailboxPermissionsResult deleteMailboxPermissions(DeleteMailboxPermissionsRequest request)
AmazonWorkMail
Deletes permissions granted to a member (user or group).
deleteMailboxPermissions
in interface AmazonWorkMail
public DeleteMobileDeviceAccessOverrideResult deleteMobileDeviceAccessOverride(DeleteMobileDeviceAccessOverrideRequest request)
AmazonWorkMail
Deletes 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 AmazonWorkMail
public DeleteMobileDeviceAccessRuleResult deleteMobileDeviceAccessRule(DeleteMobileDeviceAccessRuleRequest request)
AmazonWorkMail
Deletes 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 AmazonWorkMail
public DeleteOrganizationResult deleteOrganization(DeleteOrganizationRequest request)
AmazonWorkMail
Deletes 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 AmazonWorkMail
public DeleteResourceResult deleteResource(DeleteResourceRequest request)
AmazonWorkMail
Deletes the specified resource.
deleteResource
in interface AmazonWorkMail
public DeleteRetentionPolicyResult deleteRetentionPolicy(DeleteRetentionPolicyRequest request)
AmazonWorkMail
Deletes the specified retention policy from the specified organization.
deleteRetentionPolicy
in interface AmazonWorkMail
public 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 AmazonWorkMail
public DeregisterFromWorkMailResult deregisterFromWorkMail(DeregisterFromWorkMailRequest request)
AmazonWorkMail
Mark 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 AmazonWorkMail
public DeregisterMailDomainResult deregisterMailDomain(DeregisterMailDomainRequest request)
AmazonWorkMail
Removes 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 AmazonWorkMail
public DescribeEmailMonitoringConfigurationResult describeEmailMonitoringConfiguration(DescribeEmailMonitoringConfigurationRequest request)
AmazonWorkMail
Describes the current email monitoring configuration for a specified organization.
describeEmailMonitoringConfiguration
in interface AmazonWorkMail
public DescribeEntityResult describeEntity(DescribeEntityRequest request)
AmazonWorkMail
Returns basic details about an entity in WorkMail.
describeEntity
in interface AmazonWorkMail
public DescribeGroupResult describeGroup(DescribeGroupRequest request)
AmazonWorkMail
Returns the data available for the group.
describeGroup
in interface AmazonWorkMail
public DescribeInboundDmarcSettingsResult describeInboundDmarcSettings(DescribeInboundDmarcSettingsRequest request)
AmazonWorkMail
Lists the settings in a DMARC policy for a specified organization.
describeInboundDmarcSettings
in interface AmazonWorkMail
public DescribeMailboxExportJobResult describeMailboxExportJob(DescribeMailboxExportJobRequest request)
AmazonWorkMail
Describes the current status of a mailbox export job.
describeMailboxExportJob
in interface AmazonWorkMail
public DescribeOrganizationResult describeOrganization(DescribeOrganizationRequest request)
AmazonWorkMail
Provides more information regarding a given organization based on its identifier.
describeOrganization
in interface AmazonWorkMail
public DescribeResourceResult describeResource(DescribeResourceRequest request)
AmazonWorkMail
Returns the data available for the resource.
describeResource
in interface AmazonWorkMail
public DescribeUserResult describeUser(DescribeUserRequest request)
AmazonWorkMail
Provides information regarding the user.
describeUser
in interface AmazonWorkMail
public DisassociateDelegateFromResourceResult disassociateDelegateFromResource(DisassociateDelegateFromResourceRequest request)
AmazonWorkMail
Removes a member from the resource's set of delegates.
disassociateDelegateFromResource
in interface AmazonWorkMail
public DisassociateMemberFromGroupResult disassociateMemberFromGroup(DisassociateMemberFromGroupRequest request)
AmazonWorkMail
Removes a member from a group.
disassociateMemberFromGroup
in interface AmazonWorkMail
public GetAccessControlEffectResult getAccessControlEffect(GetAccessControlEffectRequest request)
AmazonWorkMail
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. You must provide either the user ID or impersonation role ID. Impersonation role ID can only be used with Action EWS.
getAccessControlEffect
in interface AmazonWorkMail
public GetDefaultRetentionPolicyResult getDefaultRetentionPolicy(GetDefaultRetentionPolicyRequest request)
AmazonWorkMail
Gets the default retention policy details for the specified organization.
getDefaultRetentionPolicy
in interface AmazonWorkMail
public GetImpersonationRoleResult getImpersonationRole(GetImpersonationRoleRequest request)
AmazonWorkMail
Gets the impersonation role details for the given WorkMail organization.
getImpersonationRole
in interface AmazonWorkMail
public GetImpersonationRoleEffectResult getImpersonationRoleEffect(GetImpersonationRoleEffectRequest request)
AmazonWorkMail
Tests whether the given impersonation role can impersonate a target user.
getImpersonationRoleEffect
in interface AmazonWorkMail
public GetMailDomainResult getMailDomain(GetMailDomainRequest request)
AmazonWorkMail
Gets details for a mail domain, including domain records required to configure your domain with recommended security.
getMailDomain
in interface AmazonWorkMail
public GetMailboxDetailsResult getMailboxDetails(GetMailboxDetailsRequest request)
AmazonWorkMail
Requests a user's mailbox details for a specified organization and user.
getMailboxDetails
in interface AmazonWorkMail
public GetMobileDeviceAccessEffectResult getMobileDeviceAccessEffect(GetMobileDeviceAccessEffectRequest request)
AmazonWorkMail
Simulates 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 AmazonWorkMail
public GetMobileDeviceAccessOverrideResult getMobileDeviceAccessOverride(GetMobileDeviceAccessOverrideRequest request)
AmazonWorkMail
Gets the mobile device access override for the given WorkMail organization, user, and device.
getMobileDeviceAccessOverride
in interface AmazonWorkMail
public ListAccessControlRulesResult listAccessControlRules(ListAccessControlRulesRequest request)
AmazonWorkMail
Lists the access control rules for the specified organization.
listAccessControlRules
in interface AmazonWorkMail
public ListAliasesResult listAliases(ListAliasesRequest request)
AmazonWorkMail
Creates a paginated call to list the aliases associated with a given entity.
listAliases
in interface AmazonWorkMail
public ListAvailabilityConfigurationsResult listAvailabilityConfigurations(ListAvailabilityConfigurationsRequest request)
AmazonWorkMail
List all the AvailabilityConfiguration
's for the given WorkMail organization.
listAvailabilityConfigurations
in interface AmazonWorkMail
public ListGroupMembersResult listGroupMembers(ListGroupMembersRequest request)
AmazonWorkMail
Returns an overview of the members of a group. Users and groups can be members of a group.
listGroupMembers
in interface AmazonWorkMail
public ListGroupsResult listGroups(ListGroupsRequest request)
AmazonWorkMail
Returns summaries of the organization's groups.
listGroups
in interface AmazonWorkMail
public ListGroupsForEntityResult listGroupsForEntity(ListGroupsForEntityRequest request)
AmazonWorkMail
Returns all the groups to which an entity belongs.
listGroupsForEntity
in interface AmazonWorkMail
public ListImpersonationRolesResult listImpersonationRoles(ListImpersonationRolesRequest request)
AmazonWorkMail
Lists all the impersonation roles for the given WorkMail organization.
listImpersonationRoles
in interface AmazonWorkMail
public ListMailDomainsResult listMailDomains(ListMailDomainsRequest request)
AmazonWorkMail
Lists the mail domains in a given WorkMail organization.
listMailDomains
in interface AmazonWorkMail
public ListMailboxExportJobsResult listMailboxExportJobs(ListMailboxExportJobsRequest request)
AmazonWorkMail
Lists the mailbox export jobs started for the specified organization within the last seven days.
listMailboxExportJobs
in interface AmazonWorkMail
public ListMailboxPermissionsResult listMailboxPermissions(ListMailboxPermissionsRequest request)
AmazonWorkMail
Lists the mailbox permissions associated with a user, group, or resource mailbox.
listMailboxPermissions
in interface AmazonWorkMail
public ListMobileDeviceAccessOverridesResult listMobileDeviceAccessOverrides(ListMobileDeviceAccessOverridesRequest request)
AmazonWorkMail
Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
listMobileDeviceAccessOverrides
in interface AmazonWorkMail
public ListMobileDeviceAccessRulesResult listMobileDeviceAccessRules(ListMobileDeviceAccessRulesRequest request)
AmazonWorkMail
Lists the mobile device access rules for the specified WorkMail organization.
listMobileDeviceAccessRules
in interface AmazonWorkMail
public ListOrganizationsResult listOrganizations(ListOrganizationsRequest request)
AmazonWorkMail
Returns summaries of the customer's organizations.
listOrganizations
in interface AmazonWorkMail
public ListResourceDelegatesResult listResourceDelegates(ListResourceDelegatesRequest request)
AmazonWorkMail
Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.
listResourceDelegates
in interface AmazonWorkMail
public ListResourcesResult listResources(ListResourcesRequest request)
AmazonWorkMail
Returns summaries of the organization's resources.
listResources
in interface AmazonWorkMail
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonWorkMail
Lists the tags applied to an WorkMail organization resource.
listTagsForResource
in interface AmazonWorkMail
public ListUsersResult listUsers(ListUsersRequest request)
AmazonWorkMail
Returns summaries of the organization's users.
listUsers
in interface AmazonWorkMail
public PutAccessControlRuleResult putAccessControlRule(PutAccessControlRuleRequest request)
AmazonWorkMail
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, user IDs and impersonation IDs. Adding a new rule with the same name as an existing rule replaces the older rule.
putAccessControlRule
in interface AmazonWorkMail
public PutEmailMonitoringConfigurationResult putEmailMonitoringConfiguration(PutEmailMonitoringConfigurationRequest request)
AmazonWorkMail
Creates or updates the email monitoring configuration for a specified organization.
putEmailMonitoringConfiguration
in interface AmazonWorkMail
public PutInboundDmarcSettingsResult putInboundDmarcSettings(PutInboundDmarcSettingsRequest request)
AmazonWorkMail
Enables or disables a DMARC policy for a given organization.
putInboundDmarcSettings
in interface AmazonWorkMail
public PutMailboxPermissionsResult putMailboxPermissions(PutMailboxPermissionsRequest request)
AmazonWorkMail
Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
putMailboxPermissions
in interface AmazonWorkMail
public PutMobileDeviceAccessOverrideResult putMobileDeviceAccessOverride(PutMobileDeviceAccessOverrideRequest request)
AmazonWorkMail
Creates or updates a mobile device access override for the given WorkMail organization, user, and device.
putMobileDeviceAccessOverride
in interface AmazonWorkMail
public PutRetentionPolicyResult putRetentionPolicy(PutRetentionPolicyRequest request)
AmazonWorkMail
Puts a retention policy to the specified organization.
putRetentionPolicy
in interface AmazonWorkMail
public RegisterMailDomainResult registerMailDomain(RegisterMailDomainRequest request)
AmazonWorkMail
Registers 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 AmazonWorkMail
public RegisterToWorkMailResult registerToWorkMail(RegisterToWorkMailRequest request)
AmazonWorkMail
Registers 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 AmazonWorkMail
public ResetPasswordResult resetPassword(ResetPasswordRequest request)
AmazonWorkMail
Allows the administrator to reset the password for a user.
resetPassword
in interface AmazonWorkMail
public StartMailboxExportJobResult startMailboxExportJob(StartMailboxExportJobRequest request)
AmazonWorkMail
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. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.
startMailboxExportJob
in interface AmazonWorkMail
public TagResourceResult tagResource(TagResourceRequest request)
AmazonWorkMail
Applies the specified tags to the specified WorkMailorganization resource.
tagResource
in interface AmazonWorkMail
public 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 AmazonWorkMail
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonWorkMail
Untags the specified tags from the specified WorkMail organization resource.
untagResource
in interface AmazonWorkMail
public UpdateAvailabilityConfigurationResult updateAvailabilityConfiguration(UpdateAvailabilityConfigurationRequest request)
AmazonWorkMail
Updates an existing AvailabilityConfiguration
for the given WorkMail organization and domain.
updateAvailabilityConfiguration
in interface AmazonWorkMail
public UpdateDefaultMailDomainResult updateDefaultMailDomain(UpdateDefaultMailDomainRequest request)
AmazonWorkMail
Updates 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 AmazonWorkMail
public UpdateGroupResult updateGroup(UpdateGroupRequest request)
AmazonWorkMail
Updates attibutes in a group.
updateGroup
in interface AmazonWorkMail
public UpdateImpersonationRoleResult updateImpersonationRole(UpdateImpersonationRoleRequest request)
AmazonWorkMail
Updates an impersonation role for the given WorkMail organization.
updateImpersonationRole
in interface AmazonWorkMail
public UpdateMailboxQuotaResult updateMailboxQuota(UpdateMailboxQuotaRequest request)
AmazonWorkMail
Updates a user's current mailbox quota for a specified organization and user.
updateMailboxQuota
in interface AmazonWorkMail
public UpdateMobileDeviceAccessRuleResult updateMobileDeviceAccessRule(UpdateMobileDeviceAccessRuleRequest request)
AmazonWorkMail
Updates a mobile device access rule for the specified WorkMail organization.
updateMobileDeviceAccessRule
in interface AmazonWorkMail
public UpdatePrimaryEmailAddressResult updatePrimaryEmailAddress(UpdatePrimaryEmailAddressRequest request)
AmazonWorkMail
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.
updatePrimaryEmailAddress
in interface AmazonWorkMail
public 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 AmazonWorkMail
public 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 AmazonWorkMail
public void shutdown()
AmazonWorkMail
shutdown
in interface AmazonWorkMail
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonWorkMail
Response 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 AmazonWorkMail
request
- The originally executed request.