WorkMail#
Client#
- class WorkMail.Client#
A low-level client representing Amazon WorkMail
WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.
The WorkMail API is designed for the following scenarios:
Listing and describing organizations
Managing users
Managing groups
Managing resources
All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.
client = session.create_client('workmail')
These are the available methods:
- associate_delegate_to_resource
- associate_member_to_group
- assume_impersonation_role
- can_paginate
- cancel_mailbox_export_job
- close
- create_alias
- create_availability_configuration
- create_group
- create_identity_center_application
- create_impersonation_role
- create_mobile_device_access_rule
- create_organization
- create_resource
- create_user
- delete_access_control_rule
- delete_alias
- delete_availability_configuration
- delete_email_monitoring_configuration
- delete_group
- delete_identity_center_application
- delete_identity_provider_configuration
- delete_impersonation_role
- delete_mailbox_permissions
- delete_mobile_device_access_override
- delete_mobile_device_access_rule
- delete_organization
- delete_personal_access_token
- delete_resource
- delete_retention_policy
- delete_user
- deregister_from_work_mail
- deregister_mail_domain
- describe_email_monitoring_configuration
- describe_entity
- describe_group
- describe_identity_provider_configuration
- describe_inbound_dmarc_settings
- describe_mailbox_export_job
- describe_organization
- describe_resource
- describe_user
- disassociate_delegate_from_resource
- disassociate_member_from_group
- get_access_control_effect
- get_default_retention_policy
- get_impersonation_role
- get_impersonation_role_effect
- get_mail_domain
- get_mailbox_details
- get_mobile_device_access_effect
- get_mobile_device_access_override
- get_paginator
- get_personal_access_token_metadata
- get_waiter
- list_access_control_rules
- list_aliases
- list_availability_configurations
- list_group_members
- list_groups
- list_groups_for_entity
- list_impersonation_roles
- list_mail_domains
- list_mailbox_export_jobs
- list_mailbox_permissions
- list_mobile_device_access_overrides
- list_mobile_device_access_rules
- list_organizations
- list_personal_access_tokens
- list_resource_delegates
- list_resources
- list_tags_for_resource
- list_users
- put_access_control_rule
- put_email_monitoring_configuration
- put_identity_provider_configuration
- put_inbound_dmarc_settings
- put_mailbox_permissions
- put_mobile_device_access_override
- put_retention_policy
- register_mail_domain
- register_to_work_mail
- reset_password
- start_mailbox_export_job
- tag_resource
- test_availability_configuration
- untag_resource
- update_availability_configuration
- update_default_mail_domain
- update_group
- update_impersonation_role
- update_mailbox_quota
- update_mobile_device_access_rule
- update_primary_email_address
- update_resource
- update_user
Client Exceptions#
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
- DirectoryInUseException
- DirectoryServiceAuthenticationFailedException
- DirectoryUnavailableException
- EmailAddressInUseException
- EntityAlreadyRegisteredException
- EntityNotFoundException
- EntityStateException
- InvalidConfigurationException
- InvalidCustomSesConfigurationException
- InvalidParameterException
- InvalidPasswordException
- LimitExceededException
- MailDomainInUseException
- MailDomainNotFoundException
- MailDomainStateException
- NameAvailabilityException
- OrganizationNotFoundException
- OrganizationStateException
- ReservedNameException
- ResourceNotFoundException
- TooManyTagsException
- UnsupportedOperationException
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are: