Skip to content

Type definitions#

Index > WorkMail > Type definitions

Auto-generated documentation for WorkMail type annotations stubs module mypy-boto3-workmail.

AccessControlRuleTypeDef#

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

AssociateDelegateToResourceRequestRequestTypeDef#

# AssociateDelegateToResourceRequestRequestTypeDef definition

class AssociateDelegateToResourceRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    ResourceId: str,
    EntityId: str,

AssociateMemberToGroupRequestRequestTypeDef#

# AssociateMemberToGroupRequestRequestTypeDef definition

class AssociateMemberToGroupRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    GroupId: str,
    MemberId: str,

AssumeImpersonationRoleRequestRequestTypeDef#

# AssumeImpersonationRoleRequestRequestTypeDef definition

class AssumeImpersonationRoleRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    ImpersonationRoleId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

LambdaAvailabilityProviderTypeDef#

# LambdaAvailabilityProviderTypeDef definition

class LambdaAvailabilityProviderTypeDef(TypedDict):
    LambdaArn: str,

RedactedEwsAvailabilityProviderTypeDef#

# RedactedEwsAvailabilityProviderTypeDef definition

class RedactedEwsAvailabilityProviderTypeDef(TypedDict):
    EwsEndpoint: NotRequired[str],
    EwsUsername: NotRequired[str],

BookingOptionsTypeDef#

# BookingOptionsTypeDef definition

class BookingOptionsTypeDef(TypedDict):
    AutoAcceptRequests: NotRequired[bool],
    AutoDeclineRecurringRequests: NotRequired[bool],
    AutoDeclineConflictingRequests: NotRequired[bool],

CancelMailboxExportJobRequestRequestTypeDef#

# CancelMailboxExportJobRequestRequestTypeDef definition

class CancelMailboxExportJobRequestRequestTypeDef(TypedDict):
    ClientToken: str,
    JobId: str,
    OrganizationId: str,

CreateAliasRequestRequestTypeDef#

# CreateAliasRequestRequestTypeDef definition

class CreateAliasRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    EntityId: str,
    Alias: str,

EwsAvailabilityProviderTypeDef#

# EwsAvailabilityProviderTypeDef definition

class EwsAvailabilityProviderTypeDef(TypedDict):
    EwsEndpoint: str,
    EwsUsername: str,
    EwsPassword: str,

CreateGroupRequestRequestTypeDef#

# CreateGroupRequestRequestTypeDef definition

class CreateGroupRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    Name: str,
    HiddenFromGlobalAddressList: NotRequired[bool],

ImpersonationRuleTypeDef#

# ImpersonationRuleTypeDef definition

class ImpersonationRuleTypeDef(TypedDict):
    ImpersonationRuleId: str,
    Effect: AccessEffectType,  # (1)
    Name: NotRequired[str],
    Description: NotRequired[str],
    TargetUsers: NotRequired[Sequence[str]],
    NotTargetUsers: NotRequired[Sequence[str]],
  1. See AccessEffectType

CreateMobileDeviceAccessRuleRequestRequestTypeDef#

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

DomainTypeDef#

# DomainTypeDef definition

class DomainTypeDef(TypedDict):
    DomainName: str,
    HostedZoneId: NotRequired[str],

CreateResourceRequestRequestTypeDef#

# CreateResourceRequestRequestTypeDef definition

class CreateResourceRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    Name: str,
    Type: ResourceTypeType,  # (1)
    Description: NotRequired[str],
    HiddenFromGlobalAddressList: NotRequired[bool],
  1. See ResourceTypeType

CreateUserRequestRequestTypeDef#

# CreateUserRequestRequestTypeDef definition

class CreateUserRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    Name: str,
    DisplayName: str,
    Password: NotRequired[str],
    Role: NotRequired[UserRoleType],  # (1)
    FirstName: NotRequired[str],
    LastName: NotRequired[str],
    HiddenFromGlobalAddressList: NotRequired[bool],
  1. See UserRoleType

DelegateTypeDef#

# DelegateTypeDef definition

class DelegateTypeDef(TypedDict):
    Id: str,
    Type: MemberTypeType,  # (1)
  1. See MemberTypeType

DeleteAccessControlRuleRequestRequestTypeDef#

# DeleteAccessControlRuleRequestRequestTypeDef definition

class DeleteAccessControlRuleRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    Name: str,

DeleteAliasRequestRequestTypeDef#

# DeleteAliasRequestRequestTypeDef definition

class DeleteAliasRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    EntityId: str,
    Alias: str,

DeleteAvailabilityConfigurationRequestRequestTypeDef#

# DeleteAvailabilityConfigurationRequestRequestTypeDef definition

class DeleteAvailabilityConfigurationRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    DomainName: str,

DeleteEmailMonitoringConfigurationRequestRequestTypeDef#

# DeleteEmailMonitoringConfigurationRequestRequestTypeDef definition

class DeleteEmailMonitoringConfigurationRequestRequestTypeDef(TypedDict):
    OrganizationId: str,

DeleteGroupRequestRequestTypeDef#

# DeleteGroupRequestRequestTypeDef definition

class DeleteGroupRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    GroupId: str,

DeleteImpersonationRoleRequestRequestTypeDef#

# DeleteImpersonationRoleRequestRequestTypeDef definition

class DeleteImpersonationRoleRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    ImpersonationRoleId: str,

DeleteMailboxPermissionsRequestRequestTypeDef#

# DeleteMailboxPermissionsRequestRequestTypeDef definition

class DeleteMailboxPermissionsRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    EntityId: str,
    GranteeId: str,

DeleteMobileDeviceAccessOverrideRequestRequestTypeDef#

# DeleteMobileDeviceAccessOverrideRequestRequestTypeDef definition

class DeleteMobileDeviceAccessOverrideRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    UserId: str,
    DeviceId: str,

DeleteMobileDeviceAccessRuleRequestRequestTypeDef#

# DeleteMobileDeviceAccessRuleRequestRequestTypeDef definition

class DeleteMobileDeviceAccessRuleRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    MobileDeviceAccessRuleId: str,

DeleteOrganizationRequestRequestTypeDef#

# DeleteOrganizationRequestRequestTypeDef definition

class DeleteOrganizationRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    DeleteDirectory: bool,
    ClientToken: NotRequired[str],
    ForceDelete: NotRequired[bool],

DeleteResourceRequestRequestTypeDef#

# DeleteResourceRequestRequestTypeDef definition

class DeleteResourceRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    ResourceId: str,

DeleteRetentionPolicyRequestRequestTypeDef#

# DeleteRetentionPolicyRequestRequestTypeDef definition

class DeleteRetentionPolicyRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    Id: str,

DeleteUserRequestRequestTypeDef#

# DeleteUserRequestRequestTypeDef definition

class DeleteUserRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    UserId: str,

DeregisterFromWorkMailRequestRequestTypeDef#

# DeregisterFromWorkMailRequestRequestTypeDef definition

class DeregisterFromWorkMailRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    EntityId: str,

DeregisterMailDomainRequestRequestTypeDef#

# DeregisterMailDomainRequestRequestTypeDef definition

class DeregisterMailDomainRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    DomainName: str,

DescribeEmailMonitoringConfigurationRequestRequestTypeDef#

# DescribeEmailMonitoringConfigurationRequestRequestTypeDef definition

class DescribeEmailMonitoringConfigurationRequestRequestTypeDef(TypedDict):
    OrganizationId: str,

DescribeEntityRequestRequestTypeDef#

# DescribeEntityRequestRequestTypeDef definition

class DescribeEntityRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    Email: str,

DescribeGroupRequestRequestTypeDef#

# DescribeGroupRequestRequestTypeDef definition

class DescribeGroupRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    GroupId: str,

DescribeInboundDmarcSettingsRequestRequestTypeDef#

# DescribeInboundDmarcSettingsRequestRequestTypeDef definition

class DescribeInboundDmarcSettingsRequestRequestTypeDef(TypedDict):
    OrganizationId: str,

DescribeMailboxExportJobRequestRequestTypeDef#

# DescribeMailboxExportJobRequestRequestTypeDef definition

class DescribeMailboxExportJobRequestRequestTypeDef(TypedDict):
    JobId: str,
    OrganizationId: str,

DescribeOrganizationRequestRequestTypeDef#

# DescribeOrganizationRequestRequestTypeDef definition

class DescribeOrganizationRequestRequestTypeDef(TypedDict):
    OrganizationId: str,

DescribeResourceRequestRequestTypeDef#

# DescribeResourceRequestRequestTypeDef definition

class DescribeResourceRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    ResourceId: str,

DescribeUserRequestRequestTypeDef#

# DescribeUserRequestRequestTypeDef definition

class DescribeUserRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    UserId: str,

DisassociateDelegateFromResourceRequestRequestTypeDef#

# DisassociateDelegateFromResourceRequestRequestTypeDef definition

class DisassociateDelegateFromResourceRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    ResourceId: str,
    EntityId: str,

DisassociateMemberFromGroupRequestRequestTypeDef#

# DisassociateMemberFromGroupRequestRequestTypeDef definition

class DisassociateMemberFromGroupRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    GroupId: str,
    MemberId: str,

DnsRecordTypeDef#

# DnsRecordTypeDef definition

class DnsRecordTypeDef(TypedDict):
    Type: NotRequired[str],
    Hostname: NotRequired[str],
    Value: NotRequired[str],

FolderConfigurationTypeDef#

# FolderConfigurationTypeDef definition

class FolderConfigurationTypeDef(TypedDict):
    Name: FolderNameType,  # (1)
    Action: RetentionActionType,  # (2)
    Period: NotRequired[int],
  1. See FolderNameType
  2. See RetentionActionType

GetAccessControlEffectRequestRequestTypeDef#

# GetAccessControlEffectRequestRequestTypeDef definition

class GetAccessControlEffectRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    IpAddress: str,
    Action: str,
    UserId: NotRequired[str],
    ImpersonationRoleId: NotRequired[str],

GetDefaultRetentionPolicyRequestRequestTypeDef#

# GetDefaultRetentionPolicyRequestRequestTypeDef definition

class GetDefaultRetentionPolicyRequestRequestTypeDef(TypedDict):
    OrganizationId: str,

GetImpersonationRoleEffectRequestRequestTypeDef#

# GetImpersonationRoleEffectRequestRequestTypeDef definition

class GetImpersonationRoleEffectRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    ImpersonationRoleId: str,
    TargetUser: str,

ImpersonationMatchedRuleTypeDef#

# ImpersonationMatchedRuleTypeDef definition

class ImpersonationMatchedRuleTypeDef(TypedDict):
    ImpersonationRuleId: NotRequired[str],
    Name: NotRequired[str],

GetImpersonationRoleRequestRequestTypeDef#

# GetImpersonationRoleRequestRequestTypeDef definition

class GetImpersonationRoleRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    ImpersonationRoleId: str,

GetMailDomainRequestRequestTypeDef#

# GetMailDomainRequestRequestTypeDef definition

class GetMailDomainRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    DomainName: str,

GetMailboxDetailsRequestRequestTypeDef#

# GetMailboxDetailsRequestRequestTypeDef definition

class GetMailboxDetailsRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    UserId: str,

GetMobileDeviceAccessEffectRequestRequestTypeDef#

# GetMobileDeviceAccessEffectRequestRequestTypeDef definition

class GetMobileDeviceAccessEffectRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    DeviceType: NotRequired[str],
    DeviceModel: NotRequired[str],
    DeviceOperatingSystem: NotRequired[str],
    DeviceUserAgent: NotRequired[str],

MobileDeviceAccessMatchedRuleTypeDef#

# MobileDeviceAccessMatchedRuleTypeDef definition

class MobileDeviceAccessMatchedRuleTypeDef(TypedDict):
    MobileDeviceAccessRuleId: NotRequired[str],
    Name: NotRequired[str],

GetMobileDeviceAccessOverrideRequestRequestTypeDef#

# GetMobileDeviceAccessOverrideRequestRequestTypeDef definition

class GetMobileDeviceAccessOverrideRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    UserId: str,
    DeviceId: str,

GroupIdentifierTypeDef#

# GroupIdentifierTypeDef definition

class GroupIdentifierTypeDef(TypedDict):
    GroupId: NotRequired[str],
    GroupName: NotRequired[str],

GroupTypeDef#

# GroupTypeDef 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

ImpersonationRoleTypeDef#

# ImpersonationRoleTypeDef definition

class ImpersonationRoleTypeDef(TypedDict):
    ImpersonationRoleId: NotRequired[str],
    Name: NotRequired[str],
    Type: NotRequired[ImpersonationRoleTypeType],  # (1)
    DateCreated: NotRequired[datetime],
    DateModified: NotRequired[datetime],
  1. See ImpersonationRoleTypeType

ListAccessControlRulesRequestRequestTypeDef#

# ListAccessControlRulesRequestRequestTypeDef definition

class ListAccessControlRulesRequestRequestTypeDef(TypedDict):
    OrganizationId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListAliasesRequestRequestTypeDef#

# ListAliasesRequestRequestTypeDef definition

class ListAliasesRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    EntityId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListAvailabilityConfigurationsRequestRequestTypeDef#

# ListAvailabilityConfigurationsRequestRequestTypeDef definition

class ListAvailabilityConfigurationsRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListGroupMembersRequestRequestTypeDef#

# ListGroupMembersRequestRequestTypeDef definition

class ListGroupMembersRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    GroupId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

MemberTypeDef#

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

ListGroupsFiltersTypeDef#

# ListGroupsFiltersTypeDef definition

class ListGroupsFiltersTypeDef(TypedDict):
    NamePrefix: NotRequired[str],
    PrimaryEmailPrefix: NotRequired[str],
    State: NotRequired[EntityStateType],  # (1)
  1. See EntityStateType

ListGroupsForEntityFiltersTypeDef#

# ListGroupsForEntityFiltersTypeDef definition

class ListGroupsForEntityFiltersTypeDef(TypedDict):
    GroupNamePrefix: NotRequired[str],

ListImpersonationRolesRequestRequestTypeDef#

# ListImpersonationRolesRequestRequestTypeDef definition

class ListImpersonationRolesRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListMailDomainsRequestRequestTypeDef#

# ListMailDomainsRequestRequestTypeDef definition

class ListMailDomainsRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

MailDomainSummaryTypeDef#

# MailDomainSummaryTypeDef definition

class MailDomainSummaryTypeDef(TypedDict):
    DomainName: NotRequired[str],
    DefaultDomain: NotRequired[bool],

ListMailboxExportJobsRequestRequestTypeDef#

# ListMailboxExportJobsRequestRequestTypeDef definition

class ListMailboxExportJobsRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

MailboxExportJobTypeDef#

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

ListMailboxPermissionsRequestRequestTypeDef#

# ListMailboxPermissionsRequestRequestTypeDef definition

class ListMailboxPermissionsRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    EntityId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

PermissionTypeDef#

# PermissionTypeDef definition

class PermissionTypeDef(TypedDict):
    GranteeId: str,
    GranteeType: MemberTypeType,  # (1)
    PermissionValues: List[PermissionTypeType],  # (2)
  1. See MemberTypeType
  2. See PermissionTypeType

ListMobileDeviceAccessOverridesRequestRequestTypeDef#

# ListMobileDeviceAccessOverridesRequestRequestTypeDef definition

class ListMobileDeviceAccessOverridesRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    UserId: NotRequired[str],
    DeviceId: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

MobileDeviceAccessOverrideTypeDef#

# MobileDeviceAccessOverrideTypeDef 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#

# ListMobileDeviceAccessRulesRequestRequestTypeDef definition

class ListMobileDeviceAccessRulesRequestRequestTypeDef(TypedDict):
    OrganizationId: str,

MobileDeviceAccessRuleTypeDef#

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

ListOrganizationsRequestRequestTypeDef#

# ListOrganizationsRequestRequestTypeDef definition

class ListOrganizationsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

OrganizationSummaryTypeDef#

# OrganizationSummaryTypeDef definition

class OrganizationSummaryTypeDef(TypedDict):
    OrganizationId: NotRequired[str],
    Alias: NotRequired[str],
    DefaultMailDomain: NotRequired[str],
    ErrorMessage: NotRequired[str],
    State: NotRequired[str],

ListResourceDelegatesRequestRequestTypeDef#

# ListResourceDelegatesRequestRequestTypeDef definition

class ListResourceDelegatesRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    ResourceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListResourcesFiltersTypeDef#

# ListResourcesFiltersTypeDef definition

class ListResourcesFiltersTypeDef(TypedDict):
    NamePrefix: NotRequired[str],
    PrimaryEmailPrefix: NotRequired[str],
    State: NotRequired[EntityStateType],  # (1)
  1. See EntityStateType

ResourceTypeDef#

# 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],
    Description: NotRequired[str],
  1. See ResourceTypeType
  2. See EntityStateType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

ListUsersFiltersTypeDef#

# ListUsersFiltersTypeDef definition

class ListUsersFiltersTypeDef(TypedDict):
    UsernamePrefix: NotRequired[str],
    DisplayNamePrefix: NotRequired[str],
    PrimaryEmailPrefix: NotRequired[str],
    State: NotRequired[EntityStateType],  # (1)
  1. See EntityStateType

UserTypeDef#

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

PutAccessControlRuleRequestRequestTypeDef#

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

PutEmailMonitoringConfigurationRequestRequestTypeDef#

# PutEmailMonitoringConfigurationRequestRequestTypeDef definition

class PutEmailMonitoringConfigurationRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    RoleArn: str,
    LogGroupArn: str,

PutInboundDmarcSettingsRequestRequestTypeDef#

# PutInboundDmarcSettingsRequestRequestTypeDef definition

class PutInboundDmarcSettingsRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    Enforced: bool,

PutMailboxPermissionsRequestRequestTypeDef#

# PutMailboxPermissionsRequestRequestTypeDef definition

class PutMailboxPermissionsRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    EntityId: str,
    GranteeId: str,
    PermissionValues: Sequence[PermissionTypeType],  # (1)
  1. See PermissionTypeType

PutMobileDeviceAccessOverrideRequestRequestTypeDef#

# PutMobileDeviceAccessOverrideRequestRequestTypeDef definition

class PutMobileDeviceAccessOverrideRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    UserId: str,
    DeviceId: str,
    Effect: MobileDeviceAccessRuleEffectType,  # (1)
    Description: NotRequired[str],
  1. See MobileDeviceAccessRuleEffectType

RegisterMailDomainRequestRequestTypeDef#

# RegisterMailDomainRequestRequestTypeDef definition

class RegisterMailDomainRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    DomainName: str,
    ClientToken: NotRequired[str],

RegisterToWorkMailRequestRequestTypeDef#

# RegisterToWorkMailRequestRequestTypeDef definition

class RegisterToWorkMailRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    EntityId: str,
    Email: str,

ResetPasswordRequestRequestTypeDef#

# ResetPasswordRequestRequestTypeDef definition

class ResetPasswordRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    UserId: str,
    Password: str,

StartMailboxExportJobRequestRequestTypeDef#

# StartMailboxExportJobRequestRequestTypeDef definition

class StartMailboxExportJobRequestRequestTypeDef(TypedDict):
    ClientToken: str,
    OrganizationId: str,
    EntityId: str,
    RoleArn: str,
    KmsKeyArn: str,
    S3BucketName: str,
    S3Prefix: str,
    Description: NotRequired[str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

UpdateDefaultMailDomainRequestRequestTypeDef#

# UpdateDefaultMailDomainRequestRequestTypeDef definition

class UpdateDefaultMailDomainRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    DomainName: str,

UpdateGroupRequestRequestTypeDef#

# UpdateGroupRequestRequestTypeDef definition

class UpdateGroupRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    GroupId: str,
    HiddenFromGlobalAddressList: NotRequired[bool],

UpdateMailboxQuotaRequestRequestTypeDef#

# UpdateMailboxQuotaRequestRequestTypeDef definition

class UpdateMailboxQuotaRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    UserId: str,
    MailboxQuota: int,

UpdateMobileDeviceAccessRuleRequestRequestTypeDef#

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

UpdatePrimaryEmailAddressRequestRequestTypeDef#

# UpdatePrimaryEmailAddressRequestRequestTypeDef definition

class UpdatePrimaryEmailAddressRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    EntityId: str,
    Email: str,

UpdateUserRequestRequestTypeDef#

# UpdateUserRequestRequestTypeDef definition

class UpdateUserRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    UserId: str,
    Role: NotRequired[UserRoleType],  # (1)
    DisplayName: NotRequired[str],
    FirstName: NotRequired[str],
    LastName: NotRequired[str],
    HiddenFromGlobalAddressList: NotRequired[bool],
    Initials: NotRequired[str],
    Telephone: NotRequired[str],
    Street: NotRequired[str],
    JobTitle: NotRequired[str],
    City: NotRequired[str],
    Company: NotRequired[str],
    ZipCode: NotRequired[str],
    Department: NotRequired[str],
    Country: NotRequired[str],
    Office: NotRequired[str],
  1. See UserRoleType

AssumeImpersonationRoleResponseTypeDef#

# AssumeImpersonationRoleResponseTypeDef definition

class AssumeImpersonationRoleResponseTypeDef(TypedDict):
    Token: str,
    ExpiresIn: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateGroupResponseTypeDef#

# CreateGroupResponseTypeDef definition

class CreateGroupResponseTypeDef(TypedDict):
    GroupId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateImpersonationRoleResponseTypeDef#

# CreateImpersonationRoleResponseTypeDef definition

class CreateImpersonationRoleResponseTypeDef(TypedDict):
    ImpersonationRoleId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateMobileDeviceAccessRuleResponseTypeDef#

# CreateMobileDeviceAccessRuleResponseTypeDef definition

class CreateMobileDeviceAccessRuleResponseTypeDef(TypedDict):
    MobileDeviceAccessRuleId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateOrganizationResponseTypeDef#

# CreateOrganizationResponseTypeDef definition

class CreateOrganizationResponseTypeDef(TypedDict):
    OrganizationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateResourceResponseTypeDef#

# CreateResourceResponseTypeDef definition

class CreateResourceResponseTypeDef(TypedDict):
    ResourceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateUserResponseTypeDef#

# CreateUserResponseTypeDef definition

class CreateUserResponseTypeDef(TypedDict):
    UserId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteOrganizationResponseTypeDef#

# DeleteOrganizationResponseTypeDef definition

class DeleteOrganizationResponseTypeDef(TypedDict):
    OrganizationId: str,
    State: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeEmailMonitoringConfigurationResponseTypeDef#

# DescribeEmailMonitoringConfigurationResponseTypeDef definition

class DescribeEmailMonitoringConfigurationResponseTypeDef(TypedDict):
    RoleArn: str,
    LogGroupArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeEntityResponseTypeDef#

# DescribeEntityResponseTypeDef definition

class DescribeEntityResponseTypeDef(TypedDict):
    EntityId: str,
    Name: str,
    Type: EntityTypeType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EntityTypeType
  2. See ResponseMetadataTypeDef

DescribeGroupResponseTypeDef#

# DescribeGroupResponseTypeDef definition

class DescribeGroupResponseTypeDef(TypedDict):
    GroupId: str,
    Name: str,
    Email: str,
    State: EntityStateType,  # (1)
    EnabledDate: datetime,
    DisabledDate: datetime,
    HiddenFromGlobalAddressList: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EntityStateType
  2. See ResponseMetadataTypeDef

DescribeInboundDmarcSettingsResponseTypeDef#

# DescribeInboundDmarcSettingsResponseTypeDef definition

class DescribeInboundDmarcSettingsResponseTypeDef(TypedDict):
    Enforced: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeMailboxExportJobResponseTypeDef#

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

DescribeOrganizationResponseTypeDef#

# DescribeOrganizationResponseTypeDef definition

class DescribeOrganizationResponseTypeDef(TypedDict):
    OrganizationId: str,
    Alias: str,
    State: str,
    DirectoryId: str,
    DirectoryType: str,
    DefaultMailDomain: str,
    CompletedDate: datetime,
    ErrorMessage: str,
    ARN: str,
    MigrationAdmin: str,
    InteroperabilityEnabled: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeUserResponseTypeDef#

# DescribeUserResponseTypeDef definition

class DescribeUserResponseTypeDef(TypedDict):
    UserId: str,
    Name: str,
    Email: str,
    DisplayName: str,
    State: EntityStateType,  # (1)
    UserRole: UserRoleType,  # (2)
    EnabledDate: datetime,
    DisabledDate: datetime,
    MailboxProvisionedDate: datetime,
    MailboxDeprovisionedDate: datetime,
    FirstName: str,
    LastName: str,
    HiddenFromGlobalAddressList: bool,
    Initials: str,
    Telephone: str,
    Street: str,
    JobTitle: str,
    City: str,
    Company: str,
    ZipCode: str,
    Department: str,
    Country: str,
    Office: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See EntityStateType
  2. See UserRoleType
  3. See ResponseMetadataTypeDef

GetAccessControlEffectResponseTypeDef#

# GetAccessControlEffectResponseTypeDef definition

class GetAccessControlEffectResponseTypeDef(TypedDict):
    Effect: AccessControlRuleEffectType,  # (1)
    MatchedRules: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccessControlRuleEffectType
  2. See ResponseMetadataTypeDef

GetMailboxDetailsResponseTypeDef#

# GetMailboxDetailsResponseTypeDef definition

class GetMailboxDetailsResponseTypeDef(TypedDict):
    MailboxQuota: int,
    MailboxSize: float,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetMobileDeviceAccessOverrideResponseTypeDef#

# GetMobileDeviceAccessOverrideResponseTypeDef 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#

# ListAccessControlRulesResponseTypeDef definition

class ListAccessControlRulesResponseTypeDef(TypedDict):
    Rules: List[AccessControlRuleTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccessControlRuleTypeDef
  2. See ResponseMetadataTypeDef

ListAliasesResponseTypeDef#

# ListAliasesResponseTypeDef definition

class ListAliasesResponseTypeDef(TypedDict):
    Aliases: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartMailboxExportJobResponseTypeDef#

# StartMailboxExportJobResponseTypeDef definition

class StartMailboxExportJobResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TestAvailabilityConfigurationResponseTypeDef#

# TestAvailabilityConfigurationResponseTypeDef definition

class TestAvailabilityConfigurationResponseTypeDef(TypedDict):
    TestPassed: bool,
    FailureReason: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

AvailabilityConfigurationTypeDef#

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

DescribeResourceResponseTypeDef#

# DescribeResourceResponseTypeDef definition

class DescribeResourceResponseTypeDef(TypedDict):
    ResourceId: str,
    Email: str,
    Name: str,
    Type: ResourceTypeType,  # (1)
    BookingOptions: BookingOptionsTypeDef,  # (2)
    State: EntityStateType,  # (3)
    EnabledDate: datetime,
    DisabledDate: datetime,
    Description: str,
    HiddenFromGlobalAddressList: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ResourceTypeType
  2. See BookingOptionsTypeDef
  3. See EntityStateType
  4. See ResponseMetadataTypeDef

UpdateResourceRequestRequestTypeDef#

# UpdateResourceRequestRequestTypeDef definition

class UpdateResourceRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    ResourceId: str,
    Name: NotRequired[str],
    BookingOptions: NotRequired[BookingOptionsTypeDef],  # (1)
    Description: NotRequired[str],
    Type: NotRequired[ResourceTypeType],  # (2)
    HiddenFromGlobalAddressList: NotRequired[bool],
  1. See BookingOptionsTypeDef
  2. See ResourceTypeType

CreateAvailabilityConfigurationRequestRequestTypeDef#

# CreateAvailabilityConfigurationRequestRequestTypeDef 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#

# TestAvailabilityConfigurationRequestRequestTypeDef definition

class TestAvailabilityConfigurationRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    DomainName: NotRequired[str],
    EwsProvider: NotRequired[EwsAvailabilityProviderTypeDef],  # (1)
    LambdaProvider: NotRequired[LambdaAvailabilityProviderTypeDef],  # (2)
  1. See EwsAvailabilityProviderTypeDef
  2. See LambdaAvailabilityProviderTypeDef

UpdateAvailabilityConfigurationRequestRequestTypeDef#

# UpdateAvailabilityConfigurationRequestRequestTypeDef definition

class UpdateAvailabilityConfigurationRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    DomainName: str,
    EwsProvider: NotRequired[EwsAvailabilityProviderTypeDef],  # (1)
    LambdaProvider: NotRequired[LambdaAvailabilityProviderTypeDef],  # (2)
  1. See EwsAvailabilityProviderTypeDef
  2. See LambdaAvailabilityProviderTypeDef

CreateImpersonationRoleRequestRequestTypeDef#

# CreateImpersonationRoleRequestRequestTypeDef definition

class CreateImpersonationRoleRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    Name: str,
    Type: ImpersonationRoleTypeType,  # (1)
    Rules: Sequence[ImpersonationRuleTypeDef],  # (2)
    ClientToken: NotRequired[str],
    Description: NotRequired[str],
  1. See ImpersonationRoleTypeType
  2. See ImpersonationRuleTypeDef

GetImpersonationRoleResponseTypeDef#

# 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)
  1. See ImpersonationRoleTypeType
  2. See ImpersonationRuleTypeDef
  3. See ResponseMetadataTypeDef

UpdateImpersonationRoleRequestRequestTypeDef#

# UpdateImpersonationRoleRequestRequestTypeDef definition

class UpdateImpersonationRoleRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    ImpersonationRoleId: str,
    Name: str,
    Type: ImpersonationRoleTypeType,  # (1)
    Rules: Sequence[ImpersonationRuleTypeDef],  # (2)
    Description: NotRequired[str],
  1. See ImpersonationRoleTypeType
  2. See ImpersonationRuleTypeDef

CreateOrganizationRequestRequestTypeDef#

# CreateOrganizationRequestRequestTypeDef 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#

# ListResourceDelegatesResponseTypeDef definition

class ListResourceDelegatesResponseTypeDef(TypedDict):
    Delegates: List[DelegateTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DelegateTypeDef
  2. See ResponseMetadataTypeDef

GetMailDomainResponseTypeDef#

# GetMailDomainResponseTypeDef definition

class GetMailDomainResponseTypeDef(TypedDict):
    Records: List[DnsRecordTypeDef],  # (1)
    IsTestDomain: bool,
    IsDefault: bool,
    OwnershipVerificationStatus: DnsRecordVerificationStatusType,  # (2)
    DkimVerificationStatus: DnsRecordVerificationStatusType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See