Typed dictionaries
Auto-generated documentation for WorkMail type annotations stubs module mypy-boto3-workmail.
AccessControlRuleTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import AccessControlRuleTypeDef
def get_value() -> AccessControlRuleTypeDef:
return {
"Name": ...,
}
Definition
class AccessControlRuleTypeDef(TypedDict):
Name: NotRequired[str],
Effect: NotRequired[AccessControlRuleEffectType], # (1)
Description: NotRequired[str],
IpRanges: NotRequired[List[str]],
NotIpRanges: NotRequired[List[str]],
Actions: NotRequired[List[str]],
NotActions: NotRequired[List[str]],
UserIds: NotRequired[List[str]],
NotUserIds: NotRequired[List[str]],
DateCreated: NotRequired[datetime],
DateModified: NotRequired[datetime],
ImpersonationRoleIds: NotRequired[List[str]],
NotImpersonationRoleIds: NotRequired[List[str]],
AssociateDelegateToResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import AssociateDelegateToResourceRequestRequestTypeDef
def get_value() -> AssociateDelegateToResourceRequestRequestTypeDef:
return {
"OrganizationId": ...,
"ResourceId": ...,
"EntityId": ...,
}
Definition
class AssociateDelegateToResourceRequestRequestTypeDef(TypedDict):
OrganizationId: str,
ResourceId: str,
EntityId: str,
AssociateMemberToGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import AssociateMemberToGroupRequestRequestTypeDef
def get_value() -> AssociateMemberToGroupRequestRequestTypeDef:
return {
"OrganizationId": ...,
"GroupId": ...,
"MemberId": ...,
}
Definition
class AssociateMemberToGroupRequestRequestTypeDef(TypedDict):
OrganizationId: str,
GroupId: str,
MemberId: str,
AssumeImpersonationRoleRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import AssumeImpersonationRoleRequestRequestTypeDef
def get_value() -> AssumeImpersonationRoleRequestRequestTypeDef:
return {
"OrganizationId": ...,
"ImpersonationRoleId": ...,
}
Definition
class AssumeImpersonationRoleRequestRequestTypeDef(TypedDict):
OrganizationId: str,
ImpersonationRoleId: str,
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
LambdaAvailabilityProviderTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import LambdaAvailabilityProviderTypeDef
def get_value() -> LambdaAvailabilityProviderTypeDef:
return {
"LambdaArn": ...,
}
RedactedEwsAvailabilityProviderTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import RedactedEwsAvailabilityProviderTypeDef
def get_value() -> RedactedEwsAvailabilityProviderTypeDef:
return {
"EwsEndpoint": ...,
}
Definition
class RedactedEwsAvailabilityProviderTypeDef(TypedDict):
EwsEndpoint: NotRequired[str],
EwsUsername: NotRequired[str],
BookingOptionsTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import BookingOptionsTypeDef
def get_value() -> BookingOptionsTypeDef:
return {
"AutoAcceptRequests": ...,
}
Definition
class BookingOptionsTypeDef(TypedDict):
AutoAcceptRequests: NotRequired[bool],
AutoDeclineRecurringRequests: NotRequired[bool],
AutoDeclineConflictingRequests: NotRequired[bool],
CancelMailboxExportJobRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import CancelMailboxExportJobRequestRequestTypeDef
def get_value() -> CancelMailboxExportJobRequestRequestTypeDef:
return {
"ClientToken": ...,
"JobId": ...,
"OrganizationId": ...,
}
Definition
class CancelMailboxExportJobRequestRequestTypeDef(TypedDict):
ClientToken: str,
JobId: str,
OrganizationId: str,
CreateAliasRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import CreateAliasRequestRequestTypeDef
def get_value() -> CreateAliasRequestRequestTypeDef:
return {
"OrganizationId": ...,
"EntityId": ...,
"Alias": ...,
}
Definition
class CreateAliasRequestRequestTypeDef(TypedDict):
OrganizationId: str,
EntityId: str,
Alias: str,
EwsAvailabilityProviderTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import EwsAvailabilityProviderTypeDef
def get_value() -> EwsAvailabilityProviderTypeDef:
return {
"EwsEndpoint": ...,
"EwsUsername": ...,
"EwsPassword": ...,
}
Definition
class EwsAvailabilityProviderTypeDef(TypedDict):
EwsEndpoint: str,
EwsUsername: str,
EwsPassword: str,
CreateGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import CreateGroupRequestRequestTypeDef
def get_value() -> CreateGroupRequestRequestTypeDef:
return {
"OrganizationId": ...,
"Name": ...,
}
ImpersonationRuleTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ImpersonationRuleTypeDef
def get_value() -> ImpersonationRuleTypeDef:
return {
"ImpersonationRuleId": ...,
"Effect": ...,
}
Definition
class ImpersonationRuleTypeDef(TypedDict):
ImpersonationRuleId: str,
Effect: AccessEffectType, # (1)
Name: NotRequired[str],
Description: NotRequired[str],
TargetUsers: NotRequired[Sequence[str]],
NotTargetUsers: NotRequired[Sequence[str]],
- See AccessEffectType
CreateMobileDeviceAccessRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import CreateMobileDeviceAccessRuleRequestRequestTypeDef
def get_value() -> CreateMobileDeviceAccessRuleRequestRequestTypeDef:
return {
"OrganizationId": ...,
"Name": ...,
"Effect": ...,
}
Definition
class CreateMobileDeviceAccessRuleRequestRequestTypeDef(TypedDict):
OrganizationId: str,
Name: str,
Effect: MobileDeviceAccessRuleEffectType, # (1)
ClientToken: NotRequired[str],
Description: NotRequired[str],
DeviceTypes: NotRequired[Sequence[str]],
NotDeviceTypes: NotRequired[Sequence[str]],
DeviceModels: NotRequired[Sequence[str]],
NotDeviceModels: NotRequired[Sequence[str]],
DeviceOperatingSystems: NotRequired[Sequence[str]],
NotDeviceOperatingSystems: NotRequired[Sequence[str]],
DeviceUserAgents: NotRequired[Sequence[str]],
NotDeviceUserAgents: NotRequired[Sequence[str]],
DomainTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DomainTypeDef
def get_value() -> DomainTypeDef:
return {
"DomainName": ...,
}
Definition
class DomainTypeDef(TypedDict):
DomainName: NotRequired[str],
HostedZoneId: NotRequired[str],
CreateResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import CreateResourceRequestRequestTypeDef
def get_value() -> CreateResourceRequestRequestTypeDef:
return {
"OrganizationId": ...,
"Name": ...,
"Type": ...,
}
Definition
class CreateResourceRequestRequestTypeDef(TypedDict):
OrganizationId: str,
Name: str,
Type: ResourceTypeType, # (1)
- See ResourceTypeType
CreateUserRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import CreateUserRequestRequestTypeDef
def get_value() -> CreateUserRequestRequestTypeDef:
return {
"OrganizationId": ...,
"Name": ...,
"DisplayName": ...,
"Password": ...,
}
Definition
class CreateUserRequestRequestTypeDef(TypedDict):
OrganizationId: str,
Name: str,
DisplayName: str,
Password: str,
DelegateTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DelegateTypeDef
def get_value() -> DelegateTypeDef:
return {
"Id": ...,
"Type": ...,
}
- See MemberTypeType
DeleteAccessControlRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeleteAccessControlRuleRequestRequestTypeDef
def get_value() -> DeleteAccessControlRuleRequestRequestTypeDef:
return {
"OrganizationId": ...,
"Name": ...,
}
Definition
class DeleteAccessControlRuleRequestRequestTypeDef(TypedDict):
OrganizationId: str,
Name: str,
DeleteAliasRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeleteAliasRequestRequestTypeDef
def get_value() -> DeleteAliasRequestRequestTypeDef:
return {
"OrganizationId": ...,
"EntityId": ...,
"Alias": ...,
}
Definition
class DeleteAliasRequestRequestTypeDef(TypedDict):
OrganizationId: str,
EntityId: str,
Alias: str,
DeleteAvailabilityConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeleteAvailabilityConfigurationRequestRequestTypeDef
def get_value() -> DeleteAvailabilityConfigurationRequestRequestTypeDef:
return {
"OrganizationId": ...,
"DomainName": ...,
}
Definition
class DeleteAvailabilityConfigurationRequestRequestTypeDef(TypedDict):
OrganizationId: str,
DomainName: str,
DeleteEmailMonitoringConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeleteEmailMonitoringConfigurationRequestRequestTypeDef
def get_value() -> DeleteEmailMonitoringConfigurationRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
Definition
class DeleteEmailMonitoringConfigurationRequestRequestTypeDef(TypedDict):
OrganizationId: str,
DeleteGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeleteGroupRequestRequestTypeDef
def get_value() -> DeleteGroupRequestRequestTypeDef:
return {
"OrganizationId": ...,
"GroupId": ...,
}
DeleteImpersonationRoleRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeleteImpersonationRoleRequestRequestTypeDef
def get_value() -> DeleteImpersonationRoleRequestRequestTypeDef:
return {
"OrganizationId": ...,
"ImpersonationRoleId": ...,
}
Definition
class DeleteImpersonationRoleRequestRequestTypeDef(TypedDict):
OrganizationId: str,
ImpersonationRoleId: str,
DeleteMailboxPermissionsRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeleteMailboxPermissionsRequestRequestTypeDef
def get_value() -> DeleteMailboxPermissionsRequestRequestTypeDef:
return {
"OrganizationId": ...,
"EntityId": ...,
"GranteeId": ...,
}
Definition
class DeleteMailboxPermissionsRequestRequestTypeDef(TypedDict):
OrganizationId: str,
EntityId: str,
GranteeId: str,
DeleteMobileDeviceAccessOverrideRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeleteMobileDeviceAccessOverrideRequestRequestTypeDef
def get_value() -> DeleteMobileDeviceAccessOverrideRequestRequestTypeDef:
return {
"OrganizationId": ...,
"UserId": ...,
"DeviceId": ...,
}
Definition
class DeleteMobileDeviceAccessOverrideRequestRequestTypeDef(TypedDict):
OrganizationId: str,
UserId: str,
DeviceId: str,
DeleteMobileDeviceAccessRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeleteMobileDeviceAccessRuleRequestRequestTypeDef
def get_value() -> DeleteMobileDeviceAccessRuleRequestRequestTypeDef:
return {
"OrganizationId": ...,
"MobileDeviceAccessRuleId": ...,
}
Definition
class DeleteMobileDeviceAccessRuleRequestRequestTypeDef(TypedDict):
OrganizationId: str,
MobileDeviceAccessRuleId: str,
DeleteOrganizationRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeleteOrganizationRequestRequestTypeDef
def get_value() -> DeleteOrganizationRequestRequestTypeDef:
return {
"OrganizationId": ...,
"DeleteDirectory": ...,
}
Definition
class DeleteOrganizationRequestRequestTypeDef(TypedDict):
OrganizationId: str,
DeleteDirectory: bool,
ClientToken: NotRequired[str],
DeleteResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeleteResourceRequestRequestTypeDef
def get_value() -> DeleteResourceRequestRequestTypeDef:
return {
"OrganizationId": ...,
"ResourceId": ...,
}
Definition
class DeleteResourceRequestRequestTypeDef(TypedDict):
OrganizationId: str,
ResourceId: str,
DeleteRetentionPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeleteRetentionPolicyRequestRequestTypeDef
def get_value() -> DeleteRetentionPolicyRequestRequestTypeDef:
return {
"OrganizationId": ...,
"Id": ...,
}
Definition
class DeleteRetentionPolicyRequestRequestTypeDef(TypedDict):
OrganizationId: str,
Id: str,
DeleteUserRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeleteUserRequestRequestTypeDef
def get_value() -> DeleteUserRequestRequestTypeDef:
return {
"OrganizationId": ...,
"UserId": ...,
}
DeregisterFromWorkMailRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeregisterFromWorkMailRequestRequestTypeDef
def get_value() -> DeregisterFromWorkMailRequestRequestTypeDef:
return {
"OrganizationId": ...,
"EntityId": ...,
}
Definition
class DeregisterFromWorkMailRequestRequestTypeDef(TypedDict):
OrganizationId: str,
EntityId: str,
DeregisterMailDomainRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeregisterMailDomainRequestRequestTypeDef
def get_value() -> DeregisterMailDomainRequestRequestTypeDef:
return {
"OrganizationId": ...,
"DomainName": ...,
}
Definition
class DeregisterMailDomainRequestRequestTypeDef(TypedDict):
OrganizationId: str,
DomainName: str,
DescribeEmailMonitoringConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DescribeEmailMonitoringConfigurationRequestRequestTypeDef
def get_value() -> DescribeEmailMonitoringConfigurationRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
Definition
class DescribeEmailMonitoringConfigurationRequestRequestTypeDef(TypedDict):
OrganizationId: str,
DescribeGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DescribeGroupRequestRequestTypeDef
def get_value() -> DescribeGroupRequestRequestTypeDef:
return {
"OrganizationId": ...,
"GroupId": ...,
}
DescribeInboundDmarcSettingsRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DescribeInboundDmarcSettingsRequestRequestTypeDef
def get_value() -> DescribeInboundDmarcSettingsRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
DescribeMailboxExportJobRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DescribeMailboxExportJobRequestRequestTypeDef
def get_value() -> DescribeMailboxExportJobRequestRequestTypeDef:
return {
"JobId": ...,
"OrganizationId": ...,
}
Definition
class DescribeMailboxExportJobRequestRequestTypeDef(TypedDict):
JobId: str,
OrganizationId: str,
DescribeOrganizationRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DescribeOrganizationRequestRequestTypeDef
def get_value() -> DescribeOrganizationRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
DescribeResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DescribeResourceRequestRequestTypeDef
def get_value() -> DescribeResourceRequestRequestTypeDef:
return {
"OrganizationId": ...,
"ResourceId": ...,
}
Definition
class DescribeResourceRequestRequestTypeDef(TypedDict):
OrganizationId: str,
ResourceId: str,
DescribeUserRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DescribeUserRequestRequestTypeDef
def get_value() -> DescribeUserRequestRequestTypeDef:
return {
"OrganizationId": ...,
"UserId": ...,
}
DisassociateDelegateFromResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DisassociateDelegateFromResourceRequestRequestTypeDef
def get_value() -> DisassociateDelegateFromResourceRequestRequestTypeDef:
return {
"OrganizationId": ...,
"ResourceId": ...,
"EntityId": ...,
}
Definition
class DisassociateDelegateFromResourceRequestRequestTypeDef(TypedDict):
OrganizationId: str,
ResourceId: str,
EntityId: str,
DisassociateMemberFromGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DisassociateMemberFromGroupRequestRequestTypeDef
def get_value() -> DisassociateMemberFromGroupRequestRequestTypeDef:
return {
"OrganizationId": ...,
"GroupId": ...,
"MemberId": ...,
}
Definition
class DisassociateMemberFromGroupRequestRequestTypeDef(TypedDict):
OrganizationId: str,
GroupId: str,
MemberId: str,
DnsRecordTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DnsRecordTypeDef
def get_value() -> DnsRecordTypeDef:
return {
"Type": ...,
}
Definition
class DnsRecordTypeDef(TypedDict):
Type: NotRequired[str],
Hostname: NotRequired[str],
Value: NotRequired[str],
FolderConfigurationTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import FolderConfigurationTypeDef
def get_value() -> FolderConfigurationTypeDef:
return {
"Name": ...,
"Action": ...,
}
Definition
class FolderConfigurationTypeDef(TypedDict):
Name: FolderNameType, # (1)
Action: RetentionActionType, # (2)
Period: NotRequired[int],
- See FolderNameType
- See RetentionActionType
GetAccessControlEffectRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetAccessControlEffectRequestRequestTypeDef
def get_value() -> GetAccessControlEffectRequestRequestTypeDef:
return {
"OrganizationId": ...,
"IpAddress": ...,
"Action": ...,
}
Definition
class GetAccessControlEffectRequestRequestTypeDef(TypedDict):
OrganizationId: str,
IpAddress: str,
Action: str,
UserId: NotRequired[str],
ImpersonationRoleId: NotRequired[str],
GetDefaultRetentionPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetDefaultRetentionPolicyRequestRequestTypeDef
def get_value() -> GetDefaultRetentionPolicyRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
GetImpersonationRoleEffectRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetImpersonationRoleEffectRequestRequestTypeDef
def get_value() -> GetImpersonationRoleEffectRequestRequestTypeDef:
return {
"OrganizationId": ...,
"ImpersonationRoleId": ...,
"TargetUser": ...,
}
Definition
class GetImpersonationRoleEffectRequestRequestTypeDef(TypedDict):
OrganizationId: str,
ImpersonationRoleId: str,
TargetUser: str,
ImpersonationMatchedRuleTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ImpersonationMatchedRuleTypeDef
def get_value() -> ImpersonationMatchedRuleTypeDef:
return {
"ImpersonationRuleId": ...,
}
Definition
class ImpersonationMatchedRuleTypeDef(TypedDict):
ImpersonationRuleId: NotRequired[str],
Name: NotRequired[str],
GetImpersonationRoleRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetImpersonationRoleRequestRequestTypeDef
def get_value() -> GetImpersonationRoleRequestRequestTypeDef:
return {
"OrganizationId": ...,
"ImpersonationRoleId": ...,
}
Definition
class GetImpersonationRoleRequestRequestTypeDef(TypedDict):
OrganizationId: str,
ImpersonationRoleId: str,
GetMailDomainRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetMailDomainRequestRequestTypeDef
def get_value() -> GetMailDomainRequestRequestTypeDef:
return {
"OrganizationId": ...,
"DomainName": ...,
}
Definition
class GetMailDomainRequestRequestTypeDef(TypedDict):
OrganizationId: str,
DomainName: str,
GetMailboxDetailsRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetMailboxDetailsRequestRequestTypeDef
def get_value() -> GetMailboxDetailsRequestRequestTypeDef:
return {
"OrganizationId": ...,
"UserId": ...,
}
Definition
class GetMailboxDetailsRequestRequestTypeDef(TypedDict):
OrganizationId: str,
UserId: str,
GetMobileDeviceAccessEffectRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetMobileDeviceAccessEffectRequestRequestTypeDef
def get_value() -> GetMobileDeviceAccessEffectRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
Definition
class GetMobileDeviceAccessEffectRequestRequestTypeDef(TypedDict):
OrganizationId: str,
DeviceType: NotRequired[str],
DeviceModel: NotRequired[str],
DeviceOperatingSystem: NotRequired[str],
DeviceUserAgent: NotRequired[str],
MobileDeviceAccessMatchedRuleTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import MobileDeviceAccessMatchedRuleTypeDef
def get_value() -> MobileDeviceAccessMatchedRuleTypeDef:
return {
"MobileDeviceAccessRuleId": ...,
}
Definition
class MobileDeviceAccessMatchedRuleTypeDef(TypedDict):
MobileDeviceAccessRuleId: NotRequired[str],
Name: NotRequired[str],
GetMobileDeviceAccessOverrideRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetMobileDeviceAccessOverrideRequestRequestTypeDef
def get_value() -> GetMobileDeviceAccessOverrideRequestRequestTypeDef:
return {
"OrganizationId": ...,
"UserId": ...,
"DeviceId": ...,
}
Definition
class GetMobileDeviceAccessOverrideRequestRequestTypeDef(TypedDict):
OrganizationId: str,
UserId: str,
DeviceId: str,
GroupTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GroupTypeDef
def get_value() -> GroupTypeDef:
return {
"Id": ...,
}
Definition
class GroupTypeDef(TypedDict):
Id: NotRequired[str],
Email: NotRequired[str],
Name: NotRequired[str],
State: NotRequired[EntityStateType], # (1)
EnabledDate: NotRequired[datetime],
DisabledDate: NotRequired[datetime],
- See EntityStateType
ImpersonationRoleTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ImpersonationRoleTypeDef
def get_value() -> ImpersonationRoleTypeDef:
return {
"ImpersonationRoleId": ...,
}
Definition
class ImpersonationRoleTypeDef(TypedDict):
ImpersonationRoleId: NotRequired[str],
Name: NotRequired[str],
Type: NotRequired[ImpersonationRoleTypeType], # (1)
DateCreated: NotRequired[datetime],
DateModified: NotRequired[datetime],
ListAccessControlRulesRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListAccessControlRulesRequestRequestTypeDef
def get_value() -> ListAccessControlRulesRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListAliasesRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListAliasesRequestRequestTypeDef
def get_value() -> ListAliasesRequestRequestTypeDef:
return {
"OrganizationId": ...,
"EntityId": ...,
}
Definition
class ListAliasesRequestRequestTypeDef(TypedDict):
OrganizationId: str,
EntityId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListAvailabilityConfigurationsRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListAvailabilityConfigurationsRequestRequestTypeDef
def get_value() -> ListAvailabilityConfigurationsRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
Definition
class ListAvailabilityConfigurationsRequestRequestTypeDef(TypedDict):
OrganizationId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListGroupMembersRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListGroupMembersRequestRequestTypeDef
def get_value() -> ListGroupMembersRequestRequestTypeDef:
return {
"OrganizationId": ...,
"GroupId": ...,
}
Definition
class ListGroupMembersRequestRequestTypeDef(TypedDict):
OrganizationId: str,
GroupId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
MemberTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import MemberTypeDef
def get_value() -> MemberTypeDef:
return {
"Id": ...,
}
Definition
class MemberTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
Type: NotRequired[MemberTypeType], # (1)
State: NotRequired[EntityStateType], # (2)
EnabledDate: NotRequired[datetime],
DisabledDate: NotRequired[datetime],
- See MemberTypeType
- See EntityStateType
ListGroupsRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListGroupsRequestRequestTypeDef
def get_value() -> ListGroupsRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
Definition
class ListGroupsRequestRequestTypeDef(TypedDict):
OrganizationId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListImpersonationRolesRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListImpersonationRolesRequestRequestTypeDef
def get_value() -> ListImpersonationRolesRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
Definition
class ListImpersonationRolesRequestRequestTypeDef(TypedDict):
OrganizationId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListMailDomainsRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListMailDomainsRequestRequestTypeDef
def get_value() -> ListMailDomainsRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
Definition
class ListMailDomainsRequestRequestTypeDef(TypedDict):
OrganizationId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
MailDomainSummaryTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import MailDomainSummaryTypeDef
def get_value() -> MailDomainSummaryTypeDef:
return {
"DomainName": ...,
}
Definition
class MailDomainSummaryTypeDef(TypedDict):
DomainName: NotRequired[str],
DefaultDomain: NotRequired[bool],
ListMailboxExportJobsRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListMailboxExportJobsRequestRequestTypeDef
def get_value() -> ListMailboxExportJobsRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
Definition
class ListMailboxExportJobsRequestRequestTypeDef(TypedDict):
OrganizationId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
MailboxExportJobTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import MailboxExportJobTypeDef
def get_value() -> MailboxExportJobTypeDef:
return {
"JobId": ...,
}
Definition
class MailboxExportJobTypeDef(TypedDict):
JobId: NotRequired[str],
EntityId: NotRequired[str],
Description: NotRequired[str],
S3BucketName: NotRequired[str],
S3Path: NotRequired[str],
EstimatedProgress: NotRequired[int],
State: NotRequired[MailboxExportJobStateType], # (1)
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
ListMailboxPermissionsRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListMailboxPermissionsRequestRequestTypeDef
def get_value() -> ListMailboxPermissionsRequestRequestTypeDef:
return {
"OrganizationId": ...,
"EntityId": ...,
}
Definition
class ListMailboxPermissionsRequestRequestTypeDef(TypedDict):
OrganizationId: str,
EntityId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
PermissionTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import PermissionTypeDef
def get_value() -> PermissionTypeDef:
return {
"GranteeId": ...,
"GranteeType": ...,
"PermissionValues": ...,
}
Definition
class PermissionTypeDef(TypedDict):
GranteeId: str,
GranteeType: MemberTypeType, # (1)
PermissionValues: List[PermissionTypeType], # (2)
- See MemberTypeType
- See PermissionTypeType
ListMobileDeviceAccessOverridesRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListMobileDeviceAccessOverridesRequestRequestTypeDef
def get_value() -> ListMobileDeviceAccessOverridesRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
Definition
class ListMobileDeviceAccessOverridesRequestRequestTypeDef(TypedDict):
OrganizationId: str,
UserId: NotRequired[str],
DeviceId: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
MobileDeviceAccessOverrideTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import MobileDeviceAccessOverrideTypeDef
def get_value() -> MobileDeviceAccessOverrideTypeDef:
return {
"UserId": ...,
}
Definition
class MobileDeviceAccessOverrideTypeDef(TypedDict):
UserId: NotRequired[str],
DeviceId: NotRequired[str],
Effect: NotRequired[MobileDeviceAccessRuleEffectType], # (1)
Description: NotRequired[str],
DateCreated: NotRequired[datetime],
DateModified: NotRequired[datetime],
ListMobileDeviceAccessRulesRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListMobileDeviceAccessRulesRequestRequestTypeDef
def get_value() -> ListMobileDeviceAccessRulesRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
MobileDeviceAccessRuleTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import MobileDeviceAccessRuleTypeDef
def get_value() -> MobileDeviceAccessRuleTypeDef:
return {
"MobileDeviceAccessRuleId": ...,
}
Definition
class MobileDeviceAccessRuleTypeDef(TypedDict):
MobileDeviceAccessRuleId: NotRequired[str],
Name: NotRequired[str],
Description: NotRequired[str],
Effect: NotRequired[MobileDeviceAccessRuleEffectType], # (1)
DeviceTypes: NotRequired[List[str]],
NotDeviceTypes: NotRequired[List[str]],
DeviceModels: NotRequired[List[str]],
NotDeviceModels: NotRequired[List[str]],
DeviceOperatingSystems: NotRequired[List[str]],
NotDeviceOperatingSystems: NotRequired[List[str]],
DeviceUserAgents: NotRequired[List[str]],
NotDeviceUserAgents: NotRequired[List[str]],
DateCreated: NotRequired[datetime],
DateModified: NotRequired[datetime],
ListOrganizationsRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListOrganizationsRequestRequestTypeDef
def get_value() -> ListOrganizationsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListOrganizationsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
OrganizationSummaryTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import OrganizationSummaryTypeDef
def get_value() -> OrganizationSummaryTypeDef:
return {
"OrganizationId": ...,
}
Definition
class OrganizationSummaryTypeDef(TypedDict):
OrganizationId: NotRequired[str],
Alias: NotRequired[str],
DefaultMailDomain: NotRequired[str],
ErrorMessage: NotRequired[str],
State: NotRequired[str],
ListResourceDelegatesRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListResourceDelegatesRequestRequestTypeDef
def get_value() -> ListResourceDelegatesRequestRequestTypeDef:
return {
"OrganizationId": ...,
"ResourceId": ...,
}
Definition
class ListResourceDelegatesRequestRequestTypeDef(TypedDict):
OrganizationId: str,
ResourceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListResourcesRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListResourcesRequestRequestTypeDef
def get_value() -> ListResourcesRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
Definition
class ListResourcesRequestRequestTypeDef(TypedDict):
OrganizationId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ResourceTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ResourceTypeDef
def get_value() -> ResourceTypeDef:
return {
"Id": ...,
}
Definition
class ResourceTypeDef(TypedDict):
Id: NotRequired[str],
Email: NotRequired[str],
Name: NotRequired[str],
Type: NotRequired[ResourceTypeType], # (1)
State: NotRequired[EntityStateType], # (2)
EnabledDate: NotRequired[datetime],
DisabledDate: NotRequired[datetime],
- See ResourceTypeType
- See EntityStateType
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
}
TagTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
ListUsersRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListUsersRequestRequestTypeDef
def get_value() -> ListUsersRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
Definition
class ListUsersRequestRequestTypeDef(TypedDict):
OrganizationId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
UserTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import UserTypeDef
def get_value() -> UserTypeDef:
return {
"Id": ...,
}
Definition
class UserTypeDef(TypedDict):
Id: NotRequired[str],
Email: NotRequired[str],
Name: NotRequired[str],
DisplayName: NotRequired[str],
State: NotRequired[EntityStateType], # (1)
UserRole: NotRequired[UserRoleType], # (2)
EnabledDate: NotRequired[datetime],
DisabledDate: NotRequired[datetime],
- See EntityStateType
- See UserRoleType
PutAccessControlRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import PutAccessControlRuleRequestRequestTypeDef
def get_value() -> PutAccessControlRuleRequestRequestTypeDef:
return {
"Name": ...,
"Effect": ...,
"Description": ...,
"OrganizationId": ...,
}
Definition
class PutAccessControlRuleRequestRequestTypeDef(TypedDict):
Name: str,
Effect: AccessControlRuleEffectType, # (1)
Description: str,
OrganizationId: str,
IpRanges: NotRequired[Sequence[str]],
NotIpRanges: NotRequired[Sequence[str]],
Actions: NotRequired[Sequence[str]],
NotActions: NotRequired[Sequence[str]],
UserIds: NotRequired[Sequence[str]],
NotUserIds: NotRequired[Sequence[str]],
ImpersonationRoleIds: NotRequired[Sequence[str]],
NotImpersonationRoleIds: NotRequired[Sequence[str]],
PutEmailMonitoringConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import PutEmailMonitoringConfigurationRequestRequestTypeDef
def get_value() -> PutEmailMonitoringConfigurationRequestRequestTypeDef:
return {
"OrganizationId": ...,
"RoleArn": ...,
"LogGroupArn": ...,
}
Definition
class PutEmailMonitoringConfigurationRequestRequestTypeDef(TypedDict):
OrganizationId: str,
RoleArn: str,
LogGroupArn: str,
PutInboundDmarcSettingsRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import PutInboundDmarcSettingsRequestRequestTypeDef
def get_value() -> PutInboundDmarcSettingsRequestRequestTypeDef:
return {
"OrganizationId": ...,
"Enforced": ...,
}
Definition
class PutInboundDmarcSettingsRequestRequestTypeDef(TypedDict):
OrganizationId: str,
Enforced: bool,
PutMailboxPermissionsRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import PutMailboxPermissionsRequestRequestTypeDef
def get_value() -> PutMailboxPermissionsRequestRequestTypeDef:
return {
"OrganizationId": ...,
"EntityId": ...,
"GranteeId": ...,
"PermissionValues": ...,
}
Definition
class PutMailboxPermissionsRequestRequestTypeDef(TypedDict):
OrganizationId: str,
EntityId: str,
GranteeId: str,
PermissionValues: Sequence[PermissionTypeType], # (1)
PutMobileDeviceAccessOverrideRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import PutMobileDeviceAccessOverrideRequestRequestTypeDef
def get_value() -> PutMobileDeviceAccessOverrideRequestRequestTypeDef:
return {
"OrganizationId": ...,
"UserId": ...,
"DeviceId": ...,
"Effect": ...,
}
Definition
class PutMobileDeviceAccessOverrideRequestRequestTypeDef(TypedDict):
OrganizationId: str,
UserId: str,
DeviceId: str,
Effect: MobileDeviceAccessRuleEffectType, # (1)
Description: NotRequired[str],
RegisterMailDomainRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import RegisterMailDomainRequestRequestTypeDef
def get_value() -> RegisterMailDomainRequestRequestTypeDef:
return {
"OrganizationId": ...,
"DomainName": ...,
}
Definition
class RegisterMailDomainRequestRequestTypeDef(TypedDict):
OrganizationId: str,
DomainName: str,
ClientToken: NotRequired[str],
RegisterToWorkMailRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import RegisterToWorkMailRequestRequestTypeDef
def get_value() -> RegisterToWorkMailRequestRequestTypeDef:
return {
"OrganizationId": ...,
"EntityId": ...,
"Email": ...,
}
Definition
class RegisterToWorkMailRequestRequestTypeDef(TypedDict):
OrganizationId: str,
EntityId: str,
Email: str,
ResetPasswordRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ResetPasswordRequestRequestTypeDef
def get_value() -> ResetPasswordRequestRequestTypeDef:
return {
"OrganizationId": ...,
"UserId": ...,
"Password": ...,
}
Definition
class ResetPasswordRequestRequestTypeDef(TypedDict):
OrganizationId: str,
UserId: str,
Password: str,
StartMailboxExportJobRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import StartMailboxExportJobRequestRequestTypeDef
def get_value() -> StartMailboxExportJobRequestRequestTypeDef:
return {
"ClientToken": ...,
"OrganizationId": ...,
"EntityId": ...,
"RoleArn": ...,
"KmsKeyArn": ...,
"S3BucketName": ...,
"S3Prefix": ...,
}
Definition
class StartMailboxExportJobRequestRequestTypeDef(TypedDict):
ClientToken: str,
OrganizationId: str,
EntityId: str,
RoleArn: str,
KmsKeyArn: str,
S3BucketName: str,
S3Prefix: str,
Description: NotRequired[str],
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"TagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateDefaultMailDomainRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import UpdateDefaultMailDomainRequestRequestTypeDef
def get_value() -> UpdateDefaultMailDomainRequestRequestTypeDef:
return {
"OrganizationId": ...,
"DomainName": ...,
}
Definition
class UpdateDefaultMailDomainRequestRequestTypeDef(TypedDict):
OrganizationId: str,
DomainName: str,
UpdateMailboxQuotaRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import UpdateMailboxQuotaRequestRequestTypeDef
def get_value() -> UpdateMailboxQuotaRequestRequestTypeDef:
return {
"OrganizationId": ...,
"UserId": ...,
"MailboxQuota": ...,
}
Definition
class UpdateMailboxQuotaRequestRequestTypeDef(TypedDict):
OrganizationId: str,
UserId: str,
MailboxQuota: int,
UpdateMobileDeviceAccessRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import UpdateMobileDeviceAccessRuleRequestRequestTypeDef
def get_value() -> UpdateMobileDeviceAccessRuleRequestRequestTypeDef:
return {
"OrganizationId": ...,
"MobileDeviceAccessRuleId": ...,
"Name": ...,
"Effect": ...,
}
Definition
class UpdateMobileDeviceAccessRuleRequestRequestTypeDef(TypedDict):
OrganizationId: str,
MobileDeviceAccessRuleId: str,
Name: str,
Effect: MobileDeviceAccessRuleEffectType, # (1)
Description: NotRequired[str],
DeviceTypes: NotRequired[Sequence[str]],
NotDeviceTypes: NotRequired[Sequence[str]],
DeviceModels: NotRequired[Sequence[str]],
NotDeviceModels: NotRequired[Sequence[str]],
DeviceOperatingSystems: NotRequired[Sequence[str]],
NotDeviceOperatingSystems: NotRequired[Sequence[str]],
DeviceUserAgents: NotRequired[Sequence[str]],
NotDeviceUserAgents: NotRequired[Sequence[str]],
UpdatePrimaryEmailAddressRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import UpdatePrimaryEmailAddressRequestRequestTypeDef
def get_value() -> UpdatePrimaryEmailAddressRequestRequestTypeDef:
return {
"OrganizationId": ...,
"EntityId": ...,
"Email": ...,
}
Definition
class UpdatePrimaryEmailAddressRequestRequestTypeDef(TypedDict):
OrganizationId: str,
EntityId: str,
Email: str,
AssumeImpersonationRoleResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import AssumeImpersonationRoleResponseTypeDef
def get_value() -> AssumeImpersonationRoleResponseTypeDef:
return {
"Token": ...,
"ExpiresIn": ...,
"ResponseMetadata": ...,
}
Definition
class AssumeImpersonationRoleResponseTypeDef(TypedDict):
Token: str,
ExpiresIn: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateGroupResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import CreateGroupResponseTypeDef
def get_value() -> CreateGroupResponseTypeDef:
return {
"GroupId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateGroupResponseTypeDef(TypedDict):
GroupId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateImpersonationRoleResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import CreateImpersonationRoleResponseTypeDef
def get_value() -> CreateImpersonationRoleResponseTypeDef:
return {
"ImpersonationRoleId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateImpersonationRoleResponseTypeDef(TypedDict):
ImpersonationRoleId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateMobileDeviceAccessRuleResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import CreateMobileDeviceAccessRuleResponseTypeDef
def get_value() -> CreateMobileDeviceAccessRuleResponseTypeDef:
return {
"MobileDeviceAccessRuleId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateMobileDeviceAccessRuleResponseTypeDef(TypedDict):
MobileDeviceAccessRuleId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateOrganizationResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import CreateOrganizationResponseTypeDef
def get_value() -> CreateOrganizationResponseTypeDef:
return {
"OrganizationId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateOrganizationResponseTypeDef(TypedDict):
OrganizationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateResourceResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import CreateResourceResponseTypeDef
def get_value() -> CreateResourceResponseTypeDef:
return {
"ResourceId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateResourceResponseTypeDef(TypedDict):
ResourceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateUserResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import CreateUserResponseTypeDef
def get_value() -> CreateUserResponseTypeDef:
return {
"UserId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateUserResponseTypeDef(TypedDict):
UserId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteOrganizationResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DeleteOrganizationResponseTypeDef
def get_value() -> DeleteOrganizationResponseTypeDef:
return {
"OrganizationId": ...,
"State": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteOrganizationResponseTypeDef(TypedDict):
OrganizationId: str,
State: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeEmailMonitoringConfigurationResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DescribeEmailMonitoringConfigurationResponseTypeDef
def get_value() -> DescribeEmailMonitoringConfigurationResponseTypeDef:
return {
"RoleArn": ...,
"LogGroupArn": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeEmailMonitoringConfigurationResponseTypeDef(TypedDict):
RoleArn: str,
LogGroupArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeGroupResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DescribeGroupResponseTypeDef
def get_value() -> DescribeGroupResponseTypeDef:
return {
"GroupId": ...,
"Name": ...,
"Email": ...,
"State": ...,
"EnabledDate": ...,
"DisabledDate": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeGroupResponseTypeDef(TypedDict):
GroupId: str,
Name: str,
Email: str,
State: EntityStateType, # (1)
EnabledDate: datetime,
DisabledDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeInboundDmarcSettingsResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DescribeInboundDmarcSettingsResponseTypeDef
def get_value() -> DescribeInboundDmarcSettingsResponseTypeDef:
return {
"Enforced": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeInboundDmarcSettingsResponseTypeDef(TypedDict):
Enforced: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeMailboxExportJobResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DescribeMailboxExportJobResponseTypeDef
def get_value() -> DescribeMailboxExportJobResponseTypeDef:
return {
"EntityId": ...,
"Description": ...,
"RoleArn": ...,
"KmsKeyArn": ...,
"S3BucketName": ...,
"S3Prefix": ...,
"S3Path": ...,
"EstimatedProgress": ...,
"State": ...,
"ErrorInfo": ...,
"StartTime": ...,
"EndTime": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeMailboxExportJobResponseTypeDef(TypedDict):
EntityId: str,
Description: str,
RoleArn: str,
KmsKeyArn: str,
S3BucketName: str,
S3Prefix: str,
S3Path: str,
EstimatedProgress: int,
State: MailboxExportJobStateType, # (1)
ErrorInfo: str,
StartTime: datetime,
EndTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeOrganizationResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DescribeOrganizationResponseTypeDef
def get_value() -> DescribeOrganizationResponseTypeDef:
return {
"OrganizationId": ...,
"Alias": ...,
"State": ...,
"DirectoryId": ...,
"DirectoryType": ...,
"DefaultMailDomain": ...,
"CompletedDate": ...,
"ErrorMessage": ...,
"ARN": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeOrganizationResponseTypeDef(TypedDict):
OrganizationId: str,
Alias: str,
State: str,
DirectoryId: str,
DirectoryType: str,
DefaultMailDomain: str,
CompletedDate: datetime,
ErrorMessage: str,
ARN: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeUserResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DescribeUserResponseTypeDef
def get_value() -> DescribeUserResponseTypeDef:
return {
"UserId": ...,
"Name": ...,
"Email": ...,
"DisplayName": ...,
"State": ...,
"UserRole": ...,
"EnabledDate": ...,
"DisabledDate": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeUserResponseTypeDef(TypedDict):
UserId: str,
Name: str,
Email: str,
DisplayName: str,
State: EntityStateType, # (1)
UserRole: UserRoleType, # (2)
EnabledDate: datetime,
DisabledDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See EntityStateType
- See UserRoleType
- See ResponseMetadataTypeDef
GetAccessControlEffectResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetAccessControlEffectResponseTypeDef
def get_value() -> GetAccessControlEffectResponseTypeDef:
return {
"Effect": ...,
"MatchedRules": ...,
"ResponseMetadata": ...,
}
Definition
class GetAccessControlEffectResponseTypeDef(TypedDict):
Effect: AccessControlRuleEffectType, # (1)
MatchedRules: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetMailboxDetailsResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetMailboxDetailsResponseTypeDef
def get_value() -> GetMailboxDetailsResponseTypeDef:
return {
"MailboxQuota": ...,
"MailboxSize": ...,
"ResponseMetadata": ...,
}
Definition
class GetMailboxDetailsResponseTypeDef(TypedDict):
MailboxQuota: int,
MailboxSize: float,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetMobileDeviceAccessOverrideResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetMobileDeviceAccessOverrideResponseTypeDef
def get_value() -> GetMobileDeviceAccessOverrideResponseTypeDef:
return {
"UserId": ...,
"DeviceId": ...,
"Effect": ...,
"Description": ...,
"DateCreated": ...,
"DateModified": ...,
"ResponseMetadata": ...,
}
Definition
class GetMobileDeviceAccessOverrideResponseTypeDef(TypedDict):
UserId: str,
DeviceId: str,
Effect: MobileDeviceAccessRuleEffectType, # (1)
Description: str,
DateCreated: datetime,
DateModified: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAccessControlRulesResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListAccessControlRulesResponseTypeDef
def get_value() -> ListAccessControlRulesResponseTypeDef:
return {
"Rules": ...,
"ResponseMetadata": ...,
}
Definition
class ListAccessControlRulesResponseTypeDef(TypedDict):
Rules: List[AccessControlRuleTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAliasesResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListAliasesResponseTypeDef
def get_value() -> ListAliasesResponseTypeDef:
return {
"Aliases": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListAliasesResponseTypeDef(TypedDict):
Aliases: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartMailboxExportJobResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import StartMailboxExportJobResponseTypeDef
def get_value() -> StartMailboxExportJobResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
Definition
class StartMailboxExportJobResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TestAvailabilityConfigurationResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import TestAvailabilityConfigurationResponseTypeDef
def get_value() -> TestAvailabilityConfigurationResponseTypeDef:
return {
"TestPassed": ...,
"FailureReason": ...,
"ResponseMetadata": ...,
}
Definition
class TestAvailabilityConfigurationResponseTypeDef(TypedDict):
TestPassed: bool,
FailureReason: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AvailabilityConfigurationTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import AvailabilityConfigurationTypeDef
def get_value() -> AvailabilityConfigurationTypeDef:
return {
"DomainName": ...,
}
Definition
class AvailabilityConfigurationTypeDef(TypedDict):
DomainName: NotRequired[str],
ProviderType: NotRequired[AvailabilityProviderTypeType], # (1)
EwsProvider: NotRequired[RedactedEwsAvailabilityProviderTypeDef], # (2)
LambdaProvider: NotRequired[LambdaAvailabilityProviderTypeDef], # (3)
DateCreated: NotRequired[datetime],
DateModified: NotRequired[datetime],
- See AvailabilityProviderTypeType
- See RedactedEwsAvailabilityProviderTypeDef
- See LambdaAvailabilityProviderTypeDef
DescribeResourceResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import DescribeResourceResponseTypeDef
def get_value() -> DescribeResourceResponseTypeDef:
return {
"ResourceId": ...,
"Email": ...,
"Name": ...,
"Type": ...,
"BookingOptions": ...,
"State": ...,
"EnabledDate": ...,
"DisabledDate": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeResourceResponseTypeDef(TypedDict):
ResourceId: str,
Email: str,
Name: str,
Type: ResourceTypeType, # (1)
BookingOptions: BookingOptionsTypeDef, # (2)
State: EntityStateType, # (3)
EnabledDate: datetime,
DisabledDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ResourceTypeType
- See BookingOptionsTypeDef
- See EntityStateType
- See ResponseMetadataTypeDef
UpdateResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import UpdateResourceRequestRequestTypeDef
def get_value() -> UpdateResourceRequestRequestTypeDef:
return {
"OrganizationId": ...,
"ResourceId": ...,
}
Definition
class UpdateResourceRequestRequestTypeDef(TypedDict):
OrganizationId: str,
ResourceId: str,
Name: NotRequired[str],
BookingOptions: NotRequired[BookingOptionsTypeDef], # (1)
CreateAvailabilityConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import CreateAvailabilityConfigurationRequestRequestTypeDef
def get_value() -> CreateAvailabilityConfigurationRequestRequestTypeDef:
return {
"OrganizationId": ...,
"DomainName": ...,
}
Definition
class CreateAvailabilityConfigurationRequestRequestTypeDef(TypedDict):
OrganizationId: str,
DomainName: str,
ClientToken: NotRequired[str],
EwsProvider: NotRequired[EwsAvailabilityProviderTypeDef], # (1)
LambdaProvider: NotRequired[LambdaAvailabilityProviderTypeDef], # (2)
TestAvailabilityConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import TestAvailabilityConfigurationRequestRequestTypeDef
def get_value() -> TestAvailabilityConfigurationRequestRequestTypeDef:
return {
"OrganizationId": ...,
}
Definition
class TestAvailabilityConfigurationRequestRequestTypeDef(TypedDict):
OrganizationId: str,
DomainName: NotRequired[str],
EwsProvider: NotRequired[EwsAvailabilityProviderTypeDef], # (1)
LambdaProvider: NotRequired[LambdaAvailabilityProviderTypeDef], # (2)
UpdateAvailabilityConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import UpdateAvailabilityConfigurationRequestRequestTypeDef
def get_value() -> UpdateAvailabilityConfigurationRequestRequestTypeDef:
return {
"OrganizationId": ...,
"DomainName": ...,
}
Definition
class UpdateAvailabilityConfigurationRequestRequestTypeDef(TypedDict):
OrganizationId: str,
DomainName: str,
EwsProvider: NotRequired[EwsAvailabilityProviderTypeDef], # (1)
LambdaProvider: NotRequired[LambdaAvailabilityProviderTypeDef], # (2)
CreateImpersonationRoleRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import CreateImpersonationRoleRequestRequestTypeDef
def get_value() -> CreateImpersonationRoleRequestRequestTypeDef:
return {
"OrganizationId": ...,
"Name": ...,
"Type": ...,
"Rules": ...,
}
Definition
class CreateImpersonationRoleRequestRequestTypeDef(TypedDict):
OrganizationId: str,
Name: str,
Type: ImpersonationRoleTypeType, # (1)
Rules: Sequence[ImpersonationRuleTypeDef], # (2)
ClientToken: NotRequired[str],
Description: NotRequired[str],
GetImpersonationRoleResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetImpersonationRoleResponseTypeDef
def get_value() -> GetImpersonationRoleResponseTypeDef:
return {
"ImpersonationRoleId": ...,
"Name": ...,
"Type": ...,
"Description": ...,
"Rules": ...,
"DateCreated": ...,
"DateModified": ...,
"ResponseMetadata": ...,
}
Definition
class GetImpersonationRoleResponseTypeDef(TypedDict):
ImpersonationRoleId: str,
Name: str,
Type: ImpersonationRoleTypeType, # (1)
Description: str,
Rules: List[ImpersonationRuleTypeDef], # (2)
DateCreated: datetime,
DateModified: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
UpdateImpersonationRoleRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import UpdateImpersonationRoleRequestRequestTypeDef
def get_value() -> UpdateImpersonationRoleRequestRequestTypeDef:
return {
"OrganizationId": ...,
"ImpersonationRoleId": ...,
"Name": ...,
"Type": ...,
"Rules": ...,
}
Definition
class UpdateImpersonationRoleRequestRequestTypeDef(TypedDict):
OrganizationId: str,
ImpersonationRoleId: str,
Name: str,
Type: ImpersonationRoleTypeType, # (1)
Rules: Sequence[ImpersonationRuleTypeDef], # (2)
Description: NotRequired[str],
CreateOrganizationRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import CreateOrganizationRequestRequestTypeDef
def get_value() -> CreateOrganizationRequestRequestTypeDef:
return {
"Alias": ...,
}
Definition
class CreateOrganizationRequestRequestTypeDef(TypedDict):
Alias: str,
DirectoryId: NotRequired[str],
ClientToken: NotRequired[str],
Domains: NotRequired[Sequence[DomainTypeDef]], # (1)
KmsKeyArn: NotRequired[str],
EnableInteroperability: NotRequired[bool],
- See DomainTypeDef
ListResourceDelegatesResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListResourceDelegatesResponseTypeDef
def get_value() -> ListResourceDelegatesResponseTypeDef:
return {
"Delegates": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListResourceDelegatesResponseTypeDef(TypedDict):
Delegates: List[DelegateTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetMailDomainResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetMailDomainResponseTypeDef
def get_value() -> GetMailDomainResponseTypeDef:
return {
"Records": ...,
"IsTestDomain": ...,
"IsDefault": ...,
"OwnershipVerificationStatus": ...,
"DkimVerificationStatus": ...,
"ResponseMetadata": ...,
}
Definition
class GetMailDomainResponseTypeDef(TypedDict):
Records: List[DnsRecordTypeDef], # (1)
IsTestDomain: bool,
IsDefault: bool,
OwnershipVerificationStatus: DnsRecordVerificationStatusType, # (2)
DkimVerificationStatus: DnsRecordVerificationStatusType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See DnsRecordTypeDef
- See DnsRecordVerificationStatusType
- See DnsRecordVerificationStatusType
- See ResponseMetadataTypeDef
GetDefaultRetentionPolicyResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetDefaultRetentionPolicyResponseTypeDef
def get_value() -> GetDefaultRetentionPolicyResponseTypeDef:
return {
"Id": ...,
"Name": ...,
"Description": ...,
"FolderConfigurations": ...,
"ResponseMetadata": ...,
}
Definition
class GetDefaultRetentionPolicyResponseTypeDef(TypedDict):
Id: str,
Name: str,
Description: str,
FolderConfigurations: List[FolderConfigurationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutRetentionPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import PutRetentionPolicyRequestRequestTypeDef
def get_value() -> PutRetentionPolicyRequestRequestTypeDef:
return {
"OrganizationId": ...,
"Name": ...,
"FolderConfigurations": ...,
}
Definition
class PutRetentionPolicyRequestRequestTypeDef(TypedDict):
OrganizationId: str,
Name: str,
FolderConfigurations: Sequence[FolderConfigurationTypeDef], # (1)
Id: NotRequired[str],
Description: NotRequired[str],
GetImpersonationRoleEffectResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetImpersonationRoleEffectResponseTypeDef
def get_value() -> GetImpersonationRoleEffectResponseTypeDef:
return {
"Type": ...,
"Effect": ...,
"MatchedRules": ...,
"ResponseMetadata": ...,
}
Definition
class GetImpersonationRoleEffectResponseTypeDef(TypedDict):
Type: ImpersonationRoleTypeType, # (1)
Effect: AccessEffectType, # (2)
MatchedRules: List[ImpersonationMatchedRuleTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ImpersonationRoleTypeType
- See AccessEffectType
- See ImpersonationMatchedRuleTypeDef
- See ResponseMetadataTypeDef
GetMobileDeviceAccessEffectResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import GetMobileDeviceAccessEffectResponseTypeDef
def get_value() -> GetMobileDeviceAccessEffectResponseTypeDef:
return {
"Effect": ...,
"MatchedRules": ...,
"ResponseMetadata": ...,
}
Definition
class GetMobileDeviceAccessEffectResponseTypeDef(TypedDict):
Effect: MobileDeviceAccessRuleEffectType, # (1)
MatchedRules: List[MobileDeviceAccessMatchedRuleTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See MobileDeviceAccessRuleEffectType
- See MobileDeviceAccessMatchedRuleTypeDef
- See ResponseMetadataTypeDef
ListGroupsResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListGroupsResponseTypeDef
def get_value() -> ListGroupsResponseTypeDef:
return {
"Groups": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListGroupsResponseTypeDef(TypedDict):
Groups: List[GroupTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See GroupTypeDef
- See ResponseMetadataTypeDef
ListImpersonationRolesResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListImpersonationRolesResponseTypeDef
def get_value() -> ListImpersonationRolesResponseTypeDef:
return {
"Roles": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListImpersonationRolesResponseTypeDef(TypedDict):
Roles: List[ImpersonationRoleTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAliasesRequestListAliasesPaginateTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListAliasesRequestListAliasesPaginateTypeDef
def get_value() -> ListAliasesRequestListAliasesPaginateTypeDef:
return {
"OrganizationId": ...,
"EntityId": ...,
}
Definition
class ListAliasesRequestListAliasesPaginateTypeDef(TypedDict):
OrganizationId: str,
EntityId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAvailabilityConfigurationsRequestListAvailabilityConfigurationsPaginateTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListAvailabilityConfigurationsRequestListAvailabilityConfigurationsPaginateTypeDef
def get_value() -> ListAvailabilityConfigurationsRequestListAvailabilityConfigurationsPaginateTypeDef:
return {
"OrganizationId": ...,
}
Definition
class ListAvailabilityConfigurationsRequestListAvailabilityConfigurationsPaginateTypeDef(TypedDict):
OrganizationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListGroupMembersRequestListGroupMembersPaginateTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListGroupMembersRequestListGroupMembersPaginateTypeDef
def get_value() -> ListGroupMembersRequestListGroupMembersPaginateTypeDef:
return {
"OrganizationId": ...,
"GroupId": ...,
}
Definition
class ListGroupMembersRequestListGroupMembersPaginateTypeDef(TypedDict):
OrganizationId: str,
GroupId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListGroupsRequestListGroupsPaginateTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListGroupsRequestListGroupsPaginateTypeDef
def get_value() -> ListGroupsRequestListGroupsPaginateTypeDef:
return {
"OrganizationId": ...,
}
Definition
class ListGroupsRequestListGroupsPaginateTypeDef(TypedDict):
OrganizationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListMailboxPermissionsRequestListMailboxPermissionsPaginateTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListMailboxPermissionsRequestListMailboxPermissionsPaginateTypeDef
def get_value() -> ListMailboxPermissionsRequestListMailboxPermissionsPaginateTypeDef:
return {
"OrganizationId": ...,
"EntityId": ...,
}
Definition
class ListMailboxPermissionsRequestListMailboxPermissionsPaginateTypeDef(TypedDict):
OrganizationId: str,
EntityId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListOrganizationsRequestListOrganizationsPaginateTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListOrganizationsRequestListOrganizationsPaginateTypeDef
def get_value() -> ListOrganizationsRequestListOrganizationsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListOrganizationsRequestListOrganizationsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListResourceDelegatesRequestListResourceDelegatesPaginateTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListResourceDelegatesRequestListResourceDelegatesPaginateTypeDef
def get_value() -> ListResourceDelegatesRequestListResourceDelegatesPaginateTypeDef:
return {
"OrganizationId": ...,
"ResourceId": ...,
}
Definition
class ListResourceDelegatesRequestListResourceDelegatesPaginateTypeDef(TypedDict):
OrganizationId: str,
ResourceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListResourcesRequestListResourcesPaginateTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListResourcesRequestListResourcesPaginateTypeDef
def get_value() -> ListResourcesRequestListResourcesPaginateTypeDef:
return {
"OrganizationId": ...,
}
Definition
class ListResourcesRequestListResourcesPaginateTypeDef(TypedDict):
OrganizationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListUsersRequestListUsersPaginateTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListUsersRequestListUsersPaginateTypeDef
def get_value() -> ListUsersRequestListUsersPaginateTypeDef:
return {
"OrganizationId": ...,
}
Definition
class ListUsersRequestListUsersPaginateTypeDef(TypedDict):
OrganizationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListGroupMembersResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListGroupMembersResponseTypeDef
def get_value() -> ListGroupMembersResponseTypeDef:
return {
"Members": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListGroupMembersResponseTypeDef(TypedDict):
Members: List[MemberTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See MemberTypeDef
- See ResponseMetadataTypeDef
ListMailDomainsResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListMailDomainsResponseTypeDef
def get_value() -> ListMailDomainsResponseTypeDef:
return {
"MailDomains": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListMailDomainsResponseTypeDef(TypedDict):
MailDomains: List[MailDomainSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListMailboxExportJobsResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListMailboxExportJobsResponseTypeDef
def get_value() -> ListMailboxExportJobsResponseTypeDef:
return {
"Jobs": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListMailboxExportJobsResponseTypeDef(TypedDict):
Jobs: List[MailboxExportJobTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListMailboxPermissionsResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListMailboxPermissionsResponseTypeDef
def get_value() -> ListMailboxPermissionsResponseTypeDef:
return {
"Permissions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListMailboxPermissionsResponseTypeDef(TypedDict):
Permissions: List[PermissionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListMobileDeviceAccessOverridesResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListMobileDeviceAccessOverridesResponseTypeDef
def get_value() -> ListMobileDeviceAccessOverridesResponseTypeDef:
return {
"Overrides": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListMobileDeviceAccessOverridesResponseTypeDef(TypedDict):
Overrides: List[MobileDeviceAccessOverrideTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListMobileDeviceAccessRulesResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListMobileDeviceAccessRulesResponseTypeDef
def get_value() -> ListMobileDeviceAccessRulesResponseTypeDef:
return {
"Rules": ...,
"ResponseMetadata": ...,
}
Definition
class ListMobileDeviceAccessRulesResponseTypeDef(TypedDict):
Rules: List[MobileDeviceAccessRuleTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListOrganizationsResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListOrganizationsResponseTypeDef
def get_value() -> ListOrganizationsResponseTypeDef:
return {
"OrganizationSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListOrganizationsResponseTypeDef(TypedDict):
OrganizationSummaries: List[OrganizationSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListResourcesResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListResourcesResponseTypeDef
def get_value() -> ListResourcesResponseTypeDef:
return {
"Resources": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListResourcesResponseTypeDef(TypedDict):
Resources: List[ResourceTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"Tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
ListUsersResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListUsersResponseTypeDef
def get_value() -> ListUsersResponseTypeDef:
return {
"Users": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListUsersResponseTypeDef(TypedDict):
Users: List[UserTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See UserTypeDef
- See ResponseMetadataTypeDef
ListAvailabilityConfigurationsResponseTypeDef
Usage Example
from mypy_boto3_workmail.type_defs import ListAvailabilityConfigurationsResponseTypeDef
def get_value() -> ListAvailabilityConfigurationsResponseTypeDef:
return {
"AvailabilityConfigurations": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}