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