Data retrieval APIs for Amazon WorkMail
Amazon WorkMail provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| DescribeEmailMonitoringConfiguration | Retrieve the email monitoring configuration for an organization | Read |
| DescribeEntity | Read details of an entity | Read |
| DescribeGroup | Read the details for a group | List |
| DescribeIdentityProviderConfiguration | Read the identity provider configuration for the organization | Read |
| DescribeInboundDmarcSettings | Read the settings in a DMARC policy for a specified organization | Read |
| DescribeInboundMailFlowRule | Read the details of an inbound mail flow rule configured for an organization | Read |
| DescribeMailDomains | Show the details of all mail domains associated with the organization | List |
| DescribeMailboxExportJob | Retrieve details of a mailbox export job | Read |
| DescribeOrganization | Read details of an organization | List |
| DescribeOutboundMailFlowRule | Read the details of an outbound mail flow rule configured for an organization | Read |
| DescribeResource | Read the details for a resource | List |
| DescribeSmtpGateway | Read the details of an SMTP gateway registered to an organization | Read |
| DescribeUser | Read details for a user | List |
| GetAccessControlEffect | Get the effects of access control rules as they apply to a specified IPv4 address, access protocol action, or user ID | Read |
| GetDefaultRetentionPolicy | Retrieve the retention policy associated at an organizational level | Read |
| GetImpersonationRole | Retrieve an impersonation role for the given Amazon WorkMail organization | Read |
| GetImpersonationRoleEffect | Get the effect of the rules associated to an impersonation role for a specific user | Read |
| GetJournalingRules | Read the configured journaling and fallback email addresses for email journaling | Read |
| GetMailDomain | Retrieve details of a given mail domain in an organization | Read |
| GetMailDomainDetails | Get the details of the mail domain | Read |
| GetMailboxDetails | Read the details of the user's mailbox | Read |
| GetMobileDeviceAccessEffect | Simulate the effect of the mobile device access rules for the given attributes of a sample access event | Read |
| GetMobileDeviceAccessOverride | Retrieve a mobile device access override | Read |
| GetMobileDeviceDetails | Get the details of the mobile device | Read |
| GetMobileDevicesForUser | Get a list of the mobile devices associated with the user | Read |
| GetMobilePolicyDetails | Get the details of the mobile device policy associated with the organization | Read |
| GetPersonalAccessTokenMetadata | Read metadata for a personal access token | Read |
| ListAccessControlRules | List the access control rules | Read |
| ListAliases | List the aliases associated with a given entity | List |
| ListAvailabilityConfigurations | List all the AvailabilityConfiguration's for the given Amazon WorkMail organization | Read |
| ListGroupMembers | Read an overview of the members of a group. Users and groups can be members of a group | List |
| ListGroups | List summaries of the organization's groups | List |
| ListGroupsForEntity | List the groups to which an entity belongs | List |
| ListImpersonationRoles | List the impersonation roles for the given Amazon WorkMail organization | List |
| ListInboundMailFlowRules | List inbound mail flow rules configured for an organization | List |
| ListMailDomains | List the mail domains for a given organization | List |
| ListMailboxExportJobs | List mailbox export jobs | List |
| ListMailboxPermissions | List the mailbox permissions associated with a user, group, or resource mailbox | List |
| ListMobileDeviceAccessOverrides | List the mobile device access overrides | Read |
| ListMobileDeviceAccessRules | List the mobile device access rules | Read |
| ListOrganizations | List the non-deleted organizations | List |
| ListOutboundMailFlowRules | List outbound mail flow rules configured for an organization | List |
| ListPersonalAccessTokens | List metadata for personal access tokens | List |
| ListResourceDelegates | List the delegates associated with a resource | List |
| ListResources | List the organization's resources | List |
| ListSmtpGateways | List SMTP gateways registered to the organization | List |
| ListTagsForResource | List the tags applied to an Amazon WorkMail organization resource | List |
| ListUsers | List the organization's users | List |
| SearchMembers | Perform a prefix search to find a specific user in a mail group | Read |
| TestAvailabilityConfiguration | Performs a test on an availability provider to ensure that access is allowed | Read |
