WorkMail module#
Index > WorkMail
Auto-generated documentation for WorkMail type annotations stubs module mypy-boto3-workmail.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and WorkMail
.
From PyPI with pip#
Install boto3-stubs
for WorkMail
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[workmail]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[workmail]'
# standalone installation
python -m pip install mypy-boto3-workmail
How to uninstall#
python -m pip uninstall -y mypy-boto3-workmail
Usage#
Code samples can be found in Examples.
WorkMailClient#
Type annotations and code completion for boto3.client("workmail")
as WorkMailClient
boto3 documentation
# WorkMailClient usage example
from boto3.session import Session
from mypy_boto3_workmail.client import WorkMailClient
def get_client() -> WorkMailClient:
return Session().client("workmail")
Paginators#
Type annotations and code completion for paginators
from boto3.client("workmail").get_paginator("...")
.
# ListAliasesPaginator usage example
from boto3.session import Session
from mypy_boto3_workmail.paginator import ListAliasesPaginator
def get_list_aliases_paginator() -> ListAliasesPaginator:
return Session().client("workmail").get_paginator("list_aliases"))
- ListAliasesPaginator
- ListAvailabilityConfigurationsPaginator
- ListGroupMembersPaginator
- ListGroupsPaginator
- ListMailboxPermissionsPaginator
- ListOrganizationsPaginator
- ListResourceDelegatesPaginator
- ListResourcesPaginator
- ListUsersPaginator
Literals#
Type annotations for literals used in methods and schemas.
# AccessControlRuleEffectType usage example
from mypy_boto3_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
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AccessControlRuleTypeDef usage example
from mypy_boto3_workmail.type_defs import AccessControlRuleTypeDef
def get_value() -> AccessControlRuleTypeDef:
return {
"Name": ...,
}
- AccessControlRuleTypeDef
- AssociateDelegateToResourceRequestRequestTypeDef
- AssociateMemberToGroupRequestRequestTypeDef
- AssumeImpersonationRoleRequestRequestTypeDef
- AssumeImpersonationRoleResponseTypeDef
- LambdaAvailabilityProviderTypeDef
- RedactedEwsAvailabilityProviderTypeDef
- BookingOptionsTypeDef
- CancelMailboxExportJobRequestRequestTypeDef
- CreateAliasRequestRequestTypeDef
- EwsAvailabilityProviderTypeDef
- CreateGroupRequestRequestTypeDef
- CreateGroupResponseTypeDef
- ImpersonationRuleTypeDef
- CreateImpersonationRoleResponseTypeDef
- CreateMobileDeviceAccessRuleRequestRequestTypeDef
- CreateMobileDeviceAccessRuleResponseTypeDef
- DomainTypeDef
- CreateOrganizationResponseTypeDef
- CreateResourceRequestRequestTypeDef
- CreateResourceResponseTypeDef
- CreateUserRequestRequestTypeDef
- CreateUserResponseTypeDef
- DelegateTypeDef
- DeleteAccessControlRuleRequestRequestTypeDef
- DeleteAliasRequestRequestTypeDef
- DeleteAvailabilityConfigurationRequestRequestTypeDef
- DeleteEmailMonitoringConfigurationRequestRequestTypeDef
- DeleteGroupRequestRequestTypeDef
- DeleteImpersonationRoleRequestRequestTypeDef
- DeleteMailboxPermissionsRequestRequestTypeDef
- DeleteMobileDeviceAccessOverrideRequestRequestTypeDef
- DeleteMobileDeviceAccessRuleRequestRequestTypeDef
- DeleteOrganizationRequestRequestTypeDef
- DeleteOrganizationResponseTypeDef
- DeleteResourceRequestRequestTypeDef
- DeleteRetentionPolicyRequestRequestTypeDef
- DeleteUserRequestRequestTypeDef
- DeregisterFromWorkMailRequestRequestTypeDef
- DeregisterMailDomainRequestRequestTypeDef
- DescribeEmailMonitoringConfigurationRequestRequestTypeDef
- DescribeEmailMonitoringConfigurationResponseTypeDef
- DescribeGroupRequestRequestTypeDef
- DescribeGroupResponseTypeDef
- DescribeInboundDmarcSettingsRequestRequestTypeDef
- DescribeInboundDmarcSettingsResponseTypeDef
- DescribeMailboxExportJobRequestRequestTypeDef
- DescribeMailboxExportJobResponseTypeDef
- DescribeOrganizationRequestRequestTypeDef
- DescribeOrganizationResponseTypeDef
- DescribeResourceRequestRequestTypeDef
- DescribeUserRequestRequestTypeDef
- DescribeUserResponseTypeDef
- DisassociateDelegateFromResourceRequestRequestTypeDef
- DisassociateMemberFromGroupRequestRequestTypeDef
- DnsRecordTypeDef
- FolderConfigurationTypeDef
- GetAccessControlEffectRequestRequestTypeDef
- GetAccessControlEffectResponseTypeDef
- GetDefaultRetentionPolicyRequestRequestTypeDef
- GetImpersonationRoleEffectRequestRequestTypeDef
- ImpersonationMatchedRuleTypeDef
- GetImpersonationRoleRequestRequestTypeDef
- GetMailDomainRequestRequestTypeDef
- GetMailboxDetailsRequestRequestTypeDef
- GetMailboxDetailsResponseTypeDef
- GetMobileDeviceAccessEffectRequestRequestTypeDef
- MobileDeviceAccessMatchedRuleTypeDef
- GetMobileDeviceAccessOverrideRequestRequestTypeDef
- GetMobileDeviceAccessOverrideResponseTypeDef
- GroupTypeDef
- ImpersonationRoleTypeDef
- ListAccessControlRulesRequestRequestTypeDef
- ListAliasesRequestListAliasesPaginateTypeDef
- ListAliasesRequestRequestTypeDef
- ListAliasesResponseTypeDef
- ListAvailabilityConfigurationsRequestListAvailabilityConfigurationsPaginateTypeDef
- ListAvailabilityConfigurationsRequestRequestTypeDef
- ListGroupMembersRequestListGroupMembersPaginateTypeDef
- ListGroupMembersRequestRequestTypeDef
- MemberTypeDef
- ListGroupsRequestListGroupsPaginateTypeDef
- ListGroupsRequestRequestTypeDef
- ListImpersonationRolesRequestRequestTypeDef
- ListMailDomainsRequestRequestTypeDef
- MailDomainSummaryTypeDef
- ListMailboxExportJobsRequestRequestTypeDef
- MailboxExportJobTypeDef
- ListMailboxPermissionsRequestListMailboxPermissionsPaginateTypeDef
- ListMailboxPermissionsRequestRequestTypeDef
- PermissionTypeDef
- ListMobileDeviceAccessOverridesRequestRequestTypeDef
- MobileDeviceAccessOverrideTypeDef
- ListMobileDeviceAccessRulesRequestRequestTypeDef
- MobileDeviceAccessRuleTypeDef
- ListOrganizationsRequestListOrganizationsPaginateTypeDef
- ListOrganizationsRequestRequestTypeDef
- OrganizationSummaryTypeDef
- ListResourceDelegatesRequestListResourceDelegatesPaginateTypeDef
- ListResourceDelegatesRequestRequestTypeDef
- ListResourcesRequestListResourcesPaginateTypeDef
- ListResourcesRequestRequestTypeDef
- ResourceTypeDef
- ListTagsForResourceRequestRequestTypeDef
- TagTypeDef
- ListUsersRequestListUsersPaginateTypeDef
- ListUsersRequestRequestTypeDef
- UserTypeDef
- PaginatorConfigTypeDef
- PutAccessControlRuleRequestRequestTypeDef
- PutEmailMonitoringConfigurationRequestRequestTypeDef
- PutInboundDmarcSettingsRequestRequestTypeDef
- PutMailboxPermissionsRequestRequestTypeDef
- PutMobileDeviceAccessOverrideRequestRequestTypeDef
- RegisterMailDomainRequestRequestTypeDef
- RegisterToWorkMailRequestRequestTypeDef
- ResetPasswordRequestRequestTypeDef
- ResponseMetadataTypeDef
- StartMailboxExportJobRequestRequestTypeDef
- StartMailboxExportJobResponseTypeDef
- TestAvailabilityConfigurationResponseTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateDefaultMailDomainRequestRequestTypeDef
- UpdateMailboxQuotaRequestRequestTypeDef
- UpdateMobileDeviceAccessRuleRequestRequestTypeDef
- UpdatePrimaryEmailAddressRequestRequestTypeDef
- ListAccessControlRulesResponseTypeDef
- AvailabilityConfigurationTypeDef
- DescribeResourceResponseTypeDef
- UpdateResourceRequestRequestTypeDef
- CreateAvailabilityConfigurationRequestRequestTypeDef
- TestAvailabilityConfigurationRequestRequestTypeDef
- UpdateAvailabilityConfigurationRequestRequestTypeDef
- CreateImpersonationRoleRequestRequestTypeDef
- GetImpersonationRoleResponseTypeDef
- UpdateImpersonationRoleRequestRequestTypeDef
- CreateOrganizationRequestRequestTypeDef
- ListResourceDelegatesResponseTypeDef
- GetMailDomainResponseTypeDef
- GetDefaultRetentionPolicyResponseTypeDef
- PutRetentionPolicyRequestRequestTypeDef
- GetImpersonationRoleEffectResponseTypeDef
- GetMobileDeviceAccessEffectResponseTypeDef
- ListGroupsResponseTypeDef
- ListImpersonationRolesResponseTypeDef
- ListGroupMembersResponseTypeDef
- ListMailDomainsResponseTypeDef
- ListMailboxExportJobsResponseTypeDef
- ListMailboxPermissionsResponseTypeDef
- ListMobileDeviceAccessOverridesResponseTypeDef
- ListMobileDeviceAccessRulesResponseTypeDef
- ListOrganizationsResponseTypeDef
- ListResourcesResponseTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- ListUsersResponseTypeDef
- ListAvailabilityConfigurationsResponseTypeDef