Type annotations for aiobotocore.WorkMail 2.1.0 service generated by mypy-boto3-builder 6.4.2
Project description
mypy-boto3-workmail
Type annotations for boto3.WorkMail 1.20.47 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.
Generated by mypy-boto3-builder 6.4.2.
More information can be found on boto3-stubs page and in types-aiobotocore-workmail docs
See how it helps to find and fix potential bugs:
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 types-aiobotocore
for WorkMail
service.
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[workmail]'
# Lite version does not provide session.create_client 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
Usage
VSCode
- Install Python extension
- Install Pylance extension
- Set
Pylance
as your Python Language Server - Install
types-aiobotocore[workmail]
in your environment:python -m pip install 'types-aiobotocore[workmail]'
Both type checking and auto-complete should work for WorkMail
service. No
explicit type annotations required, write your boto3
code as usual.
PyCharm
- Install
types-aiobotocore[workmail]
in your environment:python -m pip install 'types-aiobotocore[workmail]'
Both type checking and auto-complete should work for WorkMail
service. No
explicit type annotations required, write your aiobotocore
code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed
types-aiobotocore
submodules.
Other IDEs
Not tested, but as long as your IDE supports mypy
or pyright
, everything
should work.
mypy
- Install
mypy
:python -m pip install mypy
- Install
types-aiobotocore[workmail]
in your environment:python -m pip install 'types-aiobotocore[workmail]'
- Run
mypy
as usual
Type checking should work for WorkMail
service. No explicit type annotations
required, write your aiobotocore
code as usual.
pyright
- Install
pyright
:yarn global add pyright
- Install
types-aiobotocore[workmail]
in your environment:python -m pip install 'types-aiobotocore[workmail]'
- Optionally, you can install
boto3-stubs
totypings
folder.
Type checking should work for WorkMail
service. No explicit type annotations
required, write your aiobotocore
code as usual.
Explicit type annotations
Client annotations
WorkMailClient
provides annotations for session.create_client("workmail")
.
from aiobotocore.session import get_session
from types_aiobotocore_workmail import WorkMailClient
session = get_session()
async with session.create_client("workmail") as client:
client: WorkMailClient
# now client usage is checked by mypy and IDE should provide code auto-complete
Paginators annotations
types_aiobotocore_workmail.paginator
module contains type annotations for all
paginators.
from aiobotocore.session import get_session
from types_aiobotocore_workmail import WorkMailClient
from types_aiobotocore_workmail.paginator import (
ListAliasesPaginator,
ListGroupMembersPaginator,
ListGroupsPaginator,
ListMailboxPermissionsPaginator,
ListOrganizationsPaginator,
ListResourceDelegatesPaginator,
ListResourcesPaginator,
ListUsersPaginator,
)
session = get_session()
async with session.create_client("workmail") as client:
client: WorkMailClient
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_aliases_paginator: ListAliasesPaginator = client.get_paginator("list_aliases")
list_group_members_paginator: ListGroupMembersPaginator = client.get_paginator("list_group_members")
list_groups_paginator: ListGroupsPaginator = client.get_paginator("list_groups")
list_mailbox_permissions_paginator: ListMailboxPermissionsPaginator = client.get_paginator("list_mailbox_permissions")
list_organizations_paginator: ListOrganizationsPaginator = client.get_paginator("list_organizations")
list_resource_delegates_paginator: ListResourceDelegatesPaginator = client.get_paginator("list_resource_delegates")
list_resources_paginator: ListResourcesPaginator = client.get_paginator("list_resources")
list_users_paginator: ListUsersPaginator = client.get_paginator("list_users")
```
### Literals
`types_aiobotocore_workmail.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from types_aiobotocore_workmail.literals import (
AccessControlRuleEffectType,
DnsRecordVerificationStatusType,
EntityStateType,
FolderNameType,
ListAliasesPaginatorName,
ListGroupMembersPaginatorName,
ListGroupsPaginatorName,
ListMailboxPermissionsPaginatorName,
ListOrganizationsPaginatorName,
ListResourceDelegatesPaginatorName,
ListResourcesPaginatorName,
ListUsersPaginatorName,
MailboxExportJobStateType,
MemberTypeType,
MobileDeviceAccessRuleEffectType,
PermissionTypeType,
ResourceTypeType,
RetentionActionType,
UserRoleType,
ServiceName,
PaginatorName,
)
def check_value(value: AccessControlRuleEffectType) -> bool:
...
Typed dictionaries
types_aiobotocore_workmail.type_defs
module contains structures and shapes
assembled to typed dictionaries for additional type checking.
from types_aiobotocore_workmail.type_defs import (
AccessControlRuleTypeDef,
AssociateDelegateToResourceRequestRequestTypeDef,
AssociateMemberToGroupRequestRequestTypeDef,
BookingOptionsTypeDef,
CancelMailboxExportJobRequestRequestTypeDef,
CreateAliasRequestRequestTypeDef,
CreateGroupRequestRequestTypeDef,
CreateGroupResponseTypeDef,
CreateMobileDeviceAccessRuleRequestRequestTypeDef,
CreateMobileDeviceAccessRuleResponseTypeDef,
CreateOrganizationRequestRequestTypeDef,
CreateOrganizationResponseTypeDef,
CreateResourceRequestRequestTypeDef,
CreateResourceResponseTypeDef,
CreateUserRequestRequestTypeDef,
CreateUserResponseTypeDef,
DelegateTypeDef,
DeleteAccessControlRuleRequestRequestTypeDef,
DeleteAliasRequestRequestTypeDef,
DeleteGroupRequestRequestTypeDef,
DeleteMailboxPermissionsRequestRequestTypeDef,
DeleteMobileDeviceAccessOverrideRequestRequestTypeDef,
DeleteMobileDeviceAccessRuleRequestRequestTypeDef,
DeleteOrganizationRequestRequestTypeDef,
DeleteOrganizationResponseTypeDef,
DeleteResourceRequestRequestTypeDef,
DeleteRetentionPolicyRequestRequestTypeDef,
DeleteUserRequestRequestTypeDef,
DeregisterFromWorkMailRequestRequestTypeDef,
DeregisterMailDomainRequestRequestTypeDef,
DescribeGroupRequestRequestTypeDef,
DescribeGroupResponseTypeDef,
DescribeInboundDmarcSettingsRequestRequestTypeDef,
DescribeInboundDmarcSettingsResponseTypeDef,
DescribeMailboxExportJobRequestRequestTypeDef,
DescribeMailboxExportJobResponseTypeDef,
DescribeOrganizationRequestRequestTypeDef,
DescribeOrganizationResponseTypeDef,
DescribeResourceRequestRequestTypeDef,
DescribeResourceResponseTypeDef,
DescribeUserRequestRequestTypeDef,
DescribeUserResponseTypeDef,
DisassociateDelegateFromResourceRequestRequestTypeDef,
DisassociateMemberFromGroupRequestRequestTypeDef,
DnsRecordTypeDef,
DomainTypeDef,
FolderConfigurationTypeDef,
GetAccessControlEffectRequestRequestTypeDef,
GetAccessControlEffectResponseTypeDef,
GetDefaultRetentionPolicyRequestRequestTypeDef,
GetDefaultRetentionPolicyResponseTypeDef,
GetMailDomainRequestRequestTypeDef,
GetMailDomainResponseTypeDef,
GetMailboxDetailsRequestRequestTypeDef,
GetMailboxDetailsResponseTypeDef,
GetMobileDeviceAccessEffectRequestRequestTypeDef,
GetMobileDeviceAccessEffectResponseTypeDef,
GetMobileDeviceAccessOverrideRequestRequestTypeDef,
GetMobileDeviceAccessOverrideResponseTypeDef,
GroupTypeDef,
ListAccessControlRulesRequestRequestTypeDef,
ListAccessControlRulesResponseTypeDef,
ListAliasesRequestRequestTypeDef,
ListAliasesResponseTypeDef,
ListGroupMembersRequestRequestTypeDef,
ListGroupMembersResponseTypeDef,
ListGroupsRequestRequestTypeDef,
ListGroupsResponseTypeDef,
ListMailDomainsRequestRequestTypeDef,
ListMailDomainsResponseTypeDef,
ListMailboxExportJobsRequestRequestTypeDef,
ListMailboxExportJobsResponseTypeDef,
ListMailboxPermissionsRequestRequestTypeDef,
ListMailboxPermissionsResponseTypeDef,
ListMobileDeviceAccessOverridesRequestRequestTypeDef,
ListMobileDeviceAccessOverridesResponseTypeDef,
ListMobileDeviceAccessRulesRequestRequestTypeDef,
ListMobileDeviceAccessRulesResponseTypeDef,
ListOrganizationsRequestRequestTypeDef,
ListOrganizationsResponseTypeDef,
ListResourceDelegatesRequestRequestTypeDef,
ListResourceDelegatesResponseTypeDef,
ListResourcesRequestRequestTypeDef,
ListResourcesResponseTypeDef,
ListTagsForResourceRequestRequestTypeDef,
ListTagsForResourceResponseTypeDef,
ListUsersRequestRequestTypeDef,
ListUsersResponseTypeDef,
MailDomainSummaryTypeDef,
MailboxExportJobTypeDef,
MemberTypeDef,
MobileDeviceAccessMatchedRuleTypeDef,
MobileDeviceAccessOverrideTypeDef,
MobileDeviceAccessRuleTypeDef,
OrganizationSummaryTypeDef,
PaginatorConfigTypeDef,
PermissionTypeDef,
PutAccessControlRuleRequestRequestTypeDef,
PutInboundDmarcSettingsRequestRequestTypeDef,
PutMailboxPermissionsRequestRequestTypeDef,
PutMobileDeviceAccessOverrideRequestRequestTypeDef,
PutRetentionPolicyRequestRequestTypeDef,
RegisterMailDomainRequestRequestTypeDef,
RegisterToWorkMailRequestRequestTypeDef,
ResetPasswordRequestRequestTypeDef,
ResourceTypeDef,
ResponseMetadataTypeDef,
StartMailboxExportJobRequestRequestTypeDef,
StartMailboxExportJobResponseTypeDef,
TagResourceRequestRequestTypeDef,
TagTypeDef,
UntagResourceRequestRequestTypeDef,
UpdateDefaultMailDomainRequestRequestTypeDef,
UpdateMailboxQuotaRequestRequestTypeDef,
UpdateMobileDeviceAccessRuleRequestRequestTypeDef,
UpdatePrimaryEmailAddressRequestRequestTypeDef,
UpdateResourceRequestRequestTypeDef,
UserTypeDef,
)
def get_structure() -> AccessControlRuleTypeDef:
return {
...
}
Versioning
types-aiobotocore-workmail
version is the same as related boto3
version and
follows PEP 440 format.
Documentation
All type annotations can be found in types-aiobotocore-workmail docs
Support and contributing
This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for types-aiobotocore-workmail-2.1.0.post1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc997970c3b5736a648f89b1c51f0d9caf893ea4b4591d685adb6cdde45191da |
|
MD5 | da4ddba33145d5d473cedd2be5425f0a |
|
BLAKE2b-256 | ede156d607915fd85e2011f53a8a04bd1330721c4e25e63778c69c12d0c578be |
Hashes for types_aiobotocore_workmail-2.1.0.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1d571660da3acd568f34c996703e443379eee1cfa3a97a568e8362973f60aaf |
|
MD5 | 2969d60ffae1228a0437cad82c3f7d48 |
|
BLAKE2b-256 | e85ba2172851565148182ec59640baf9eab732b14099aa6552a2afc6c8fe8e1b |