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-aioboto3
for WorkMail
service.
# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[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-aioboto3-lite[workmail]'
# standalone installation
python -m pip install types-aiobotocore-workmail
How to uninstall
Usage
Code samples can be found in Examples.
WorkMailClient
Type annotations and code completion for session.client("workmail")
as WorkMailClient
boto3 documentation
Usage example
from aioboto3.session import Session
from types_aiobotocore_workmail.client import WorkMailClient
session = Session()
async with session.client("workmail") as client:
client: WorkMailClient
Paginators
Type annotations and code completion for
paginators
from session.client("workmail").get_paginator("...")
.
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.
Usage example
from types_aiobotocore_workmail.literals import AccessControlRuleEffectType
def get_value() -> AccessControlRuleEffectType:
return "ALLOW"
- AccessControlRuleEffectType
- AvailabilityProviderTypeType
- DnsRecordVerificationStatusType
- EntityStateType
- FolderNameType
- 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.
Usage example
from types_aiobotocore_workmail.type_defs import AccessControlRuleTypeDef
def get_value() -> AccessControlRuleTypeDef:
return {
"Name": ...,
}
- AccessControlRuleTypeDef
- AssociateDelegateToResourceRequestRequestTypeDef
- AssociateMemberToGroupRequestRequestTypeDef
- LambdaAvailabilityProviderTypeDef
- RedactedEwsAvailabilityProviderTypeDef
- BookingOptionsTypeDef
- CancelMailboxExportJobRequestRequestTypeDef
- CreateAliasRequestRequestTypeDef
- EwsAvailabilityProviderTypeDef
- CreateGroupRequestRequestTypeDef
- ResponseMetadataTypeDef
- CreateMobileDeviceAccessRuleRequestRequestTypeDef
- DomainTypeDef
- CreateResourceRequestRequestTypeDef
- CreateUserRequestRequestTypeDef
- DelegateTypeDef
- DeleteAccessControlRuleRequestRequestTypeDef
- DeleteAliasRequestRequestTypeDef
- DeleteAvailabilityConfigurationRequestRequestTypeDef
- DeleteEmailMonitoringConfigurationRequestRequestTypeDef
- DeleteGroupRequestRequestTypeDef
- DeleteMailboxPermissionsRequestRequestTypeDef
- DeleteMobileDeviceAccessOverrideRequestRequestTypeDef
- DeleteMobileDeviceAccessRuleRequestRequestTypeDef
- DeleteOrganizationRequestRequestTypeDef
- DeleteResourceRequestRequestTypeDef
- DeleteRetentionPolicyRequestRequestTypeDef
- DeleteUserRequestRequestTypeDef
- DeregisterFromWorkMailRequestRequestTypeDef
- DeregisterMailDomainRequestRequestTypeDef
- DescribeEmailMonitoringConfigurationRequestRequestTypeDef
- DescribeGroupRequestRequestTypeDef
- DescribeInboundDmarcSettingsRequestRequestTypeDef
- DescribeMailboxExportJobRequestRequestTypeDef
- DescribeOrganizationRequestRequestTypeDef
- DescribeResourceRequestRequestTypeDef
- DescribeUserRequestRequestTypeDef
- DisassociateDelegateFromResourceRequestRequestTypeDef
- DisassociateMemberFromGroupRequestRequestTypeDef
- DnsRecordTypeDef
- FolderConfigurationTypeDef
- GetAccessControlEffectRequestRequestTypeDef
- GetDefaultRetentionPolicyRequestRequestTypeDef
- GetMailDomainRequestRequestTypeDef
- GetMailboxDetailsRequestRequestTypeDef
- GetMobileDeviceAccessEffectRequestRequestTypeDef
- MobileDeviceAccessMatchedRuleTypeDef
- GetMobileDeviceAccessOverrideRequestRequestTypeDef
- GroupTypeDef
- ListAccessControlRulesRequestRequestTypeDef
- PaginatorConfigTypeDef
- ListAliasesRequestRequestTypeDef
- ListAvailabilityConfigurationsRequestRequestTypeDef
- ListGroupMembersRequestRequestTypeDef
- MemberTypeDef
- ListGroupsRequestRequestTypeDef
- 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
- AvailabilityConfigurationTypeDef
- UpdateResourceRequestRequestTypeDef
- CreateAvailabilityConfigurationRequestRequestTypeDef
- TestAvailabilityConfigurationRequestRequestTypeDef
- UpdateAvailabilityConfigurationRequestRequestTypeDef
- CreateGroupResponseTypeDef
- CreateMobileDeviceAccessRuleResponseTypeDef
- CreateOrganizationResponseTypeDef
- CreateResourceResponseTypeDef
- CreateUserResponseTypeDef
- DeleteOrganizationResponseTypeDef
- DescribeEmailMonitoringConfigurationResponseTypeDef
- DescribeGroupResponseTypeDef
- DescribeInboundDmarcSettingsResponseTypeDef
- DescribeMailboxExportJobResponseTypeDef
- DescribeOrganizationResponseTypeDef
- DescribeResourceResponseTypeDef
- DescribeUserResponseTypeDef
- GetAccessControlEffectResponseTypeDef
- GetMailboxDetailsResponseTypeDef
- GetMobileDeviceAccessOverrideResponseTypeDef
- ListAccessControlRulesResponseTypeDef
- ListAliasesResponseTypeDef
- StartMailboxExportJobResponseTypeDef
- TestAvailabilityConfigurationResponseTypeDef
- CreateOrganizationRequestRequestTypeDef
- ListResourceDelegatesResponseTypeDef
- GetMailDomainResponseTypeDef
- GetDefaultRetentionPolicyResponseTypeDef
- PutRetentionPolicyRequestRequestTypeDef
- GetMobileDeviceAccessEffectResponseTypeDef
- ListGroupsResponseTypeDef
- ListAliasesRequestListAliasesPaginateTypeDef
- ListAvailabilityConfigurationsRequestListAvailabilityConfigurationsPaginateTypeDef
- ListGroupMembersRequestListGroupMembersPaginateTypeDef
- ListGroupsRequestListGroupsPaginateTypeDef
- ListMailboxPermissionsRequestListMailboxPermissionsPaginateTypeDef
- ListOrganizationsRequestListOrganizationsPaginateTypeDef
- ListResourceDelegatesRequestListResourceDelegatesPaginateTypeDef
- ListResourcesRequestListResourcesPaginateTypeDef
- ListUsersRequestListUsersPaginateTypeDef
- ListGroupMembersResponseTypeDef
- ListMailDomainsResponseTypeDef
- ListMailboxExportJobsResponseTypeDef
- ListMailboxPermissionsResponseTypeDef
- ListMobileDeviceAccessOverridesResponseTypeDef
- ListMobileDeviceAccessRulesResponseTypeDef
- ListOrganizationsResponseTypeDef
- ListResourcesResponseTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- ListUsersResponseTypeDef
- ListAvailabilityConfigurationsResponseTypeDef