WorkMail module#
Index > WorkMail
Auto-generated documentation for WorkMail type annotations stubs module types-aiobotocore-workmail.
How to install#
From PyPI with pip#
Install types-aiobotocore
for WorkMail
service.
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[workmail]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[workmail]'
# standalone installation
python -m pip install types-aiobotocore-workmail
How to uninstall#
python -m pip uninstall -y types-aiobotocore-workmail
Usage#
Code samples can be found in Examples.
WorkMailClient#
Type annotations and code completion for session.create_client("workmail")
as WorkMailClient
boto3 documentation
# WorkMailClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_workmail.client import WorkMailClient
session = get_session()
async with session.create_client("workmail") as client:
client: WorkMailClient
Paginators#
Type annotations and code completion for
paginators
from session.create_client("workmail").get_paginator("...")
.
# ListAliasesPaginator usage example
from types_aiobotocore_workmail.paginator import ListAliasesPaginator
def get_list_aliases_paginator() -> ListAliasesPaginator:
return client.get_paginator("list_aliases"))
- ListAliasesPaginator
- ListAvailabilityConfigurationsPaginator
- ListGroupMembersPaginator
- ListGroupsPaginator
- ListMailboxPermissionsPaginator
- ListOrganizationsPaginator
- ListResourceDelegatesPaginator
- ListResourcesPaginator
- ListUsersPaginator
Literals#
Type annotations for literals used in methods and schema.
# AccessControlRuleEffectType usage example
from types_aiobotocore_workmail.literals import AccessControlRuleEffectType
def get_value() -> AccessControlRuleEffectType:
return "ALLOW"
- AccessControlRuleEffectType
- AccessEffectType
- AvailabilityProviderTypeType
- DnsRecordVerificationStatusType
- EntityStateType
- FolderNameType
- ImpersonationRoleTypeType
- ListAliasesPaginatorName
- ListAvailabilityConfigurationsPaginatorName
- ListGroupMembersPaginatorName
- ListGroupsPaginatorName
- ListMailboxPermissionsPaginatorName
- ListOrganizationsPaginatorName
- ListResourceDelegatesPaginatorName
- ListResourcesPaginatorName
- ListUsersPaginatorName
- MailboxExportJobStateType
- MemberTypeType
- MobileDeviceAccessRuleEffectType
- PermissionTypeType
- ResourceTypeType
- RetentionActionType
- UserRoleType
- WorkMailServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AccessControlRuleTypeDef
- AssociateDelegateToResourceRequestRequestTypeDef
- AssociateMemberToGroupRequestRequestTypeDef
- AssumeImpersonationRoleRequestRequestTypeDef
- ResponseMetadataTypeDef
- LambdaAvailabilityProviderTypeDef
- RedactedEwsAvailabilityProviderTypeDef
- BookingOptionsTypeDef
- CancelMailboxExportJobRequestRequestTypeDef
- CreateAliasRequestRequestTypeDef
- EwsAvailabilityProviderTypeDef
- CreateGroupRequestRequestTypeDef
- ImpersonationRuleTypeDef
- CreateMobileDeviceAccessRuleRequestRequestTypeDef
- DomainTypeDef
- CreateResourceRequestRequestTypeDef
- CreateUserRequestRequestTypeDef
- DelegateTypeDef
- DeleteAccessControlRuleRequestRequestTypeDef
- DeleteAliasRequestRequestTypeDef
- DeleteAvailabilityConfigurationRequestRequestTypeDef
- DeleteEmailMonitoringConfigurationRequestRequestTypeDef
- DeleteGroupRequestRequestTypeDef
- DeleteImpersonationRoleRequestRequestTypeDef
- DeleteMailboxPermissionsRequestRequestTypeDef
- DeleteMobileDeviceAccessOverrideRequestRequestTypeDef
- DeleteMobileDeviceAccessRuleRequestRequestTypeDef
- DeleteOrganizationRequestRequestTypeDef
- DeleteResourceRequestRequestTypeDef
- DeleteRetentionPolicyRequestRequestTypeDef
- DeleteUserRequestRequestTypeDef
- DeregisterFromWorkMailRequestRequestTypeDef
- DeregisterMailDomainRequestRequestTypeDef
- DescribeEmailMonitoringConfigurationRequestRequestTypeDef
- DescribeGroupRequestRequestTypeDef
- DescribeInboundDmarcSettingsRequestRequestTypeDef
- DescribeMailboxExportJobRequestRequestTypeDef
- DescribeOrganizationRequestRequestTypeDef
- DescribeResourceRequestRequestTypeDef
- DescribeUserRequestRequestTypeDef
- DisassociateDelegateFromResourceRequestRequestTypeDef
- DisassociateMemberFromGroupRequestRequestTypeDef
- DnsRecordTypeDef
- FolderConfigurationTypeDef
- GetAccessControlEffectRequestRequestTypeDef
- GetDefaultRetentionPolicyRequestRequestTypeDef
- GetImpersonationRoleEffectRequestRequestTypeDef
- ImpersonationMatchedRuleTypeDef
- GetImpersonationRoleRequestRequestTypeDef
- GetMailDomainRequestRequestTypeDef
- GetMailboxDetailsRequestRequestTypeDef
- GetMobileDeviceAccessEffectRequestRequestTypeDef
- MobileDeviceAccessMatchedRuleTypeDef
- GetMobileDeviceAccessOverrideRequestRequestTypeDef
- GroupTypeDef
- ImpersonationRoleTypeDef
- ListAccessControlRulesRequestRequestTypeDef
- PaginatorConfigTypeDef
- ListAliasesRequestRequestTypeDef
- ListAvailabilityConfigurationsRequestRequestTypeDef
- ListGroupMembersRequestRequestTypeDef
- MemberTypeDef
- ListGroupsRequestRequestTypeDef
- ListImpersonationRolesRequestRequestTypeDef
- ListMailDomainsRequestRequestTypeDef
- MailDomainSummaryTypeDef
- ListMailboxExportJobsRequestRequestTypeDef
- MailboxExportJobTypeDef
- ListMailboxPermissionsRequestRequestTypeDef
- PermissionTypeDef
- ListMobileDeviceAccessOverridesRequestRequestTypeDef
- MobileDeviceAccessOverrideTypeDef
- ListMobileDeviceAccessRulesRequestRequestTypeDef
- MobileDeviceAccessRuleTypeDef
- ListOrganizationsRequestRequestTypeDef
- OrganizationSummaryTypeDef
- ListResourceDelegatesRequestRequestTypeDef
- ListResourcesRequestRequestTypeDef
- ResourceTypeDef
- ListTagsForResourceRequestRequestTypeDef
- TagTypeDef
- ListUsersRequestRequestTypeDef
- UserTypeDef
- PutAccessControlRuleRequestRequestTypeDef
- PutEmailMonitoringConfigurationRequestRequestTypeDef
- PutInboundDmarcSettingsRequestRequestTypeDef
- PutMailboxPermissionsRequestRequestTypeDef
- PutMobileDeviceAccessOverrideRequestRequestTypeDef
- RegisterMailDomainRequestRequestTypeDef
- RegisterToWorkMailRequestRequestTypeDef
- ResetPasswordRequestRequestTypeDef
- StartMailboxExportJobRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateDefaultMailDomainRequestRequestTypeDef
- UpdateMailboxQuotaRequestRequestTypeDef
- UpdateMobileDeviceAccessRuleRequestRequestTypeDef
- UpdatePrimaryEmailAddressRequestRequestTypeDef
- AssumeImpersonationRoleResponseTypeDef
- CreateGroupResponseTypeDef
- CreateImpersonationRoleResponseTypeDef
- CreateMobileDeviceAccessRuleResponseTypeDef
- CreateOrganizationResponseTypeDef
- CreateResourceResponseTypeDef
- CreateUserResponseTypeDef
- DeleteOrganizationResponseTypeDef
- DescribeEmailMonitoringConfigurationResponseTypeDef
- DescribeGroupResponseTypeDef
- DescribeInboundDmarcSettingsResponseTypeDef
- DescribeMailboxExportJobResponseTypeDef
- DescribeOrganizationResponseTypeDef
- DescribeUserResponseTypeDef
- GetAccessControlEffectResponseTypeDef
- GetMailboxDetailsResponseTypeDef
- GetMobileDeviceAccessOverrideResponseTypeDef
- ListAccessControlRulesResponseTypeDef
- ListAliasesResponseTypeDef
- StartMailboxExportJobResponseTypeDef
- TestAvailabilityConfigurationResponseTypeDef
- AvailabilityConfigurationTypeDef
- DescribeResourceResponseTypeDef
- UpdateResourceRequestRequestTypeDef
- CreateAvailabilityConfigurationRequestRequestTypeDef
- TestAvailabilityConfigurationRequestRequestTypeDef
- UpdateAvailabilityConfigurationRequestRequestTypeDef
- CreateImpersonationRoleRequestRequestTypeDef
- GetImpersonationRoleResponseTypeDef
- UpdateImpersonationRoleRequestRequestTypeDef
- CreateOrganizationRequestRequestTypeDef
- ListResourceDelegatesResponseTypeDef
- GetMailDomainResponseTypeDef
- GetDefaultRetentionPolicyResponseTypeDef
- PutRetentionPolicyRequestRequestTypeDef
- GetImpersonationRoleEffectResponseTypeDef
- GetMobileDeviceAccessEffectResponseTypeDef
- ListGroupsResponseTypeDef
- ListImpersonationRolesResponseTypeDef
- ListAliasesRequestListAliasesPaginateTypeDef
- ListAvailabilityConfigurationsRequestListAvailabilityConfigurationsPaginateTypeDef
- ListGroupMembersRequestListGroupMembersPaginateTypeDef
- ListGroupsRequestListGroupsPaginateTypeDef
- ListMailboxPermissionsRequestListMailboxPermissionsPaginateTypeDef
- ListOrganizationsRequestListOrganizationsPaginateTypeDef
- ListResourceDelegatesRequestListResourceDelegatesPaginateTypeDef
- ListResourcesRequestListResourcesPaginateTypeDef
- ListUsersRequestListUsersPaginateTypeDef
- ListGroupMembersResponseTypeDef
- ListMailDomainsResponseTypeDef
- ListMailboxExportJobsResponseTypeDef
- ListMailboxPermissionsResponseTypeDef
- ListMobileDeviceAccessOverridesResponseTypeDef
- ListMobileDeviceAccessRulesResponseTypeDef
- ListOrganizationsResponseTypeDef
- ListResourcesResponseTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- ListUsersResponseTypeDef
- ListAvailabilityConfigurationsResponseTypeDef