Skip to content

Typed dictionaries

Index > WorkMail > 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],
  1. See AccessControlRuleEffectType

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,

LambdaAvailabilityProviderTypeDef

Usage Example
from mypy_boto3_workmail.type_defs import LambdaAvailabilityProviderTypeDef

def get_value() -> LambdaAvailabilityProviderTypeDef:
    return {
        "LambdaArn": ...,
    }
Definition
class LambdaAvailabilityProviderTypeDef(TypedDict):
    LambdaArn: str,

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": ...,
    }
Definition
class CreateGroupRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    Name: 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,

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]],
  1. See MobileDeviceAccessRuleEffectType

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)
  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": ...,
    }
Definition
class DelegateTypeDef(TypedDict):
    Id: str,
    Type: MemberTypeType,  # (1)
  1. 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": ...,
    }
Definition
class DeleteGroupRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    GroupId: 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": ...,
    }
Definition
class DeleteUserRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    UserId: str,

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": ...,
    }
Definition
class DescribeGroupRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    GroupId: str,

DescribeInboundDmarcSettingsRequestRequestTypeDef

Usage Example
from mypy_boto3_workmail.type_defs import DescribeInboundDmarcSettingsRequestRequestTypeDef

def get_value() -> DescribeInboundDmarcSettingsRequestRequestTypeDef:
    return {
        "OrganizationId": ...,
    }
Definition
class DescribeInboundDmarcSettingsRequestRequestTypeDef(TypedDict):
    OrganizationId: str,

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": ...,
    }
Definition
class DescribeOrganizationRequestRequestTypeDef(TypedDict):
    OrganizationId: str,

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": ...,
    }
Definition
class DescribeUserRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    UserId: str,

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],
  1. See FolderNameType
  2. See RetentionActionType

GetAccessControlEffectRequestRequestTypeDef

Usage Example
from mypy_boto3_workmail.type_defs import GetAccessControlEffectRequestRequestTypeDef

def get_value() -> GetAccessControlEffectRequestRequestTypeDef:
    return {
        "OrganizationId": ...,
        "IpAddress": ...,
        "Action": ...,
        "UserId": ...,
    }
Definition
class GetAccessControlEffectRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    IpAddress: str,
    Action: str,
    UserId: str,

GetDefaultRetentionPolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_workmail.type_defs import GetDefaultRetentionPolicyRequestRequestTypeDef

def get_value() -> GetDefaultRetentionPolicyRequestRequestTypeDef:
    return {
        "OrganizationId": ...,
    }
Definition
class GetDefaultRetentionPolicyRequestRequestTypeDef(TypedDict):
    OrganizationId: 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],
  1. See EntityStateType

ListAccessControlRulesRequestRequestTypeDef

Usage Example
from mypy_boto3_workmail.type_defs import ListAccessControlRulesRequestRequestTypeDef

def get_value() -> ListAccessControlRulesRequestRequestTypeDef:
    return {
        "OrganizationId": ...,
    }
Definition
class ListAccessControlRulesRequestRequestTypeDef(TypedDict):
    OrganizationId: str,

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],
  1. See MemberTypeType
  2. 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],

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],
  1. See MailboxExportJobStateType

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)
  1. See MemberTypeType
  2. 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],
  1. See MobileDeviceAccessRuleEffectType

ListMobileDeviceAccessRulesRequestRequestTypeDef

Usage Example
from mypy_boto3_workmail.type_defs import ListMobileDeviceAccessRulesRequestRequestTypeDef

def get_value() -> ListMobileDeviceAccessRulesRequestRequestTypeDef:
    return {
        "OrganizationId": ...,
    }
Definition
class ListMobileDeviceAccessRulesRequestRequestTypeDef(TypedDict):
    OrganizationId: str,

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],
  1. See MobileDeviceAccessRuleEffectType

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],
  1. See ResourceTypeType
  2. See EntityStateType

ListTagsForResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_workmail.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
    }
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

TagTypeDef

Usage Example
from mypy_boto3_workmail.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
Definition
class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

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],
  1. See EntityStateType
  2. 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]],
  1. See AccessControlRuleEffectType

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)
  1. See PermissionTypeType

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],
  1. See MobileDeviceAccessRuleEffectType

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]],
  1. See MobileDeviceAccessRuleEffectType

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,

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],
  1. See AvailabilityProviderTypeType
  2. See RedactedEwsAvailabilityProviderTypeDef
  3. See LambdaAvailabilityProviderTypeDef

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)
  1. See BookingOptionsTypeDef

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)
  1. See EwsAvailabilityProviderTypeDef
  2. See LambdaAvailabilityProviderTypeDef

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)
  1. See EwsAvailabilityProviderTypeDef
  2. See LambdaAvailabilityProviderTypeDef

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)
  1. See EwsAvailabilityProviderTypeDef
  2. See LambdaAvailabilityProviderTypeDef

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)
  1. See ResponseMetadataTypeDef

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)
  1. See ResponseMetadataTypeDef

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)
  1. See ResponseMetadataTypeDef

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)
  1. See ResponseMetadataTypeDef

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)
  1. See ResponseMetadataTypeDef

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)
  1. See ResponseMetadataTypeDef

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)
  1. See ResponseMetadataTypeDef

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)
  1. See EntityStateType
  2. See ResponseMetadataTypeDef

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)
  1. See ResponseMetadataTypeDef

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)
  1. See MailboxExportJobStateType
  2. See ResponseMetadataTypeDef

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)
  1. See ResponseMetadataTypeDef

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)
  1. See ResourceTypeType
  2. See BookingOptionsTypeDef
  3. See EntityStateType
  4. See ResponseMetadataTypeDef

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)
  1. See EntityStateType
  2. See UserRoleType
  3. 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)
  1. See AccessControlRuleEffectType
  2. See ResponseMetadataTypeDef

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)
  1. See ResponseMetadataTypeDef

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)
  1. See MobileDeviceAccessRuleEffectType
  2. See ResponseMetadataTypeDef

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)
  1. See AccessControlRuleTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See ResponseMetadataTypeDef

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)
  1. See ResponseMetadataTypeDef

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)
  1. See ResponseMetadataTypeDef

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],
  1. 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)
  1. See DelegateTypeDef
  2. See ResponseMetadataTypeDef

GetMailDomainResponseTypeDef

Usage Example
from mypy_boto3_workmail.type_defs import GetMailDomainResponseTypeDef

def get_value() -> GetMailDomainResponseTypeDef:
    return {
        "Records": ...,
        "IsTestDomain":