Workmail Classes
AccessControlRuleTypeDef
Name
- Type: typing.Optional[str]
Effect
- Type: typing.Optional[typing.Literal['ALLOW', 'DENY']]
Description
- Type: typing.Optional[str]
IpRanges
- Type: typing.Optional[typing.List[str]]
NotIpRanges
- Type: typing.Optional[typing.List[str]]
Actions
- Type: typing.Optional[typing.List[str]]
NotActions
- Type: typing.Optional[typing.List[str]]
UserIds
- Type: typing.Optional[typing.List[str]]
NotUserIds
- Type: typing.Optional[typing.List[str]]
DateCreated
- Type: typing.Optional[datetime.datetime]
DateModified
- Type: typing.Optional[datetime.datetime]
ImpersonationRoleIds
- Type: typing.Optional[typing.List[str]]
NotImpersonationRoleIds
- Type: typing.Optional[typing.List[str]]
AssociateDelegateToResourceRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
ResourceId
- Type:
- Required: Yes
EntityId
- Type:
- Required: Yes
AssociateMemberToGroupRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
GroupId
- Type:
- Required: Yes
MemberId
- Type:
- Required: Yes
AssumeImpersonationRoleRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
ImpersonationRoleId
- Type:
- Required: Yes
AssumeImpersonationRoleResponseTypeDef
Token
- Type:
- Required: Yes
ExpiresIn
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
AvailabilityConfigurationTypeDef
DomainName
- Type: typing.Optional[str]
ProviderType
- Type: typing.Optional[typing.Literal['EWS', 'LAMBDA']]
EwsProvider
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.RedactedEwsAvailabilityProviderTypeDef]
LambdaProvider
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.LambdaAvailabilityProviderTypeDef]
DateCreated
- Type: typing.Optional[datetime.datetime]
DateModified
- Type: typing.Optional[datetime.datetime]
BaseValidatorModel
Oops! This Pydantic model is currently empty. Stay tuned!
BookingOptionsTypeDef
AutoAcceptRequests
- Type: typing.Optional[bool]
AutoDeclineRecurringRequests
- Type: typing.Optional[bool]
AutoDeclineConflictingRequests
- Type: typing.Optional[bool]
CancelMailboxExportJobRequestRequestTypeDef
ClientToken
- Type:
- Required: Yes
JobId
- Type:
- Required: Yes
OrganizationId
- Type:
- Required: Yes
CreateAliasRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
EntityId
- Type:
- Required: Yes
Alias
- Type:
- Required: Yes
CreateAvailabilityConfigurationRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
DomainName
- Type:
- Required: Yes
ClientToken
- Type: typing.Optional[str]
EwsProvider
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.EwsAvailabilityProviderTypeDef]
LambdaProvider
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.LambdaAvailabilityProviderTypeDef]
CreateGroupRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
HiddenFromGlobalAddressList
- Type: typing.Optional[bool]
CreateGroupResponseTypeDef
GroupId
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateImpersonationRoleRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
Type
- Type: typing.Literal['FULL_ACCESS', 'READ_ONLY']
- Required: Yes
Rules
- Type: typing.Sequence[aws_resource_validator.pydantic_models.workmail_classes.ImpersonationRuleTypeDef]
- Required: Yes
ClientToken
- Type: typing.Optional[str]
Description
- Type: typing.Optional[str]
CreateImpersonationRoleResponseTypeDef
ImpersonationRoleId
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateMobileDeviceAccessRuleRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
Effect
- Type: typing.Literal['ALLOW', 'DENY']
- Required: Yes
ClientToken
- Type: typing.Optional[str]
Description
- Type: typing.Optional[str]
DeviceTypes
- Type: typing.Optional[typing.Sequence[str]]
NotDeviceTypes
- Type: typing.Optional[typing.Sequence[str]]
DeviceModels
- Type: typing.Optional[typing.Sequence[str]]
NotDeviceModels
- Type: typing.Optional[typing.Sequence[str]]
DeviceOperatingSystems
- Type: typing.Optional[typing.Sequence[str]]
NotDeviceOperatingSystems
- Type: typing.Optional[typing.Sequence[str]]
DeviceUserAgents
- Type: typing.Optional[typing.Sequence[str]]
NotDeviceUserAgents
- Type: typing.Optional[typing.Sequence[str]]
CreateMobileDeviceAccessRuleResponseTypeDef
MobileDeviceAccessRuleId
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateOrganizationRequestRequestTypeDef
Alias
- Type:
- Required: Yes
DirectoryId
- Type: typing.Optional[str]
ClientToken
- Type: typing.Optional[str]
Domains
- Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.workmail_classes.DomainTypeDef]]
KmsKeyArn
- Type: typing.Optional[str]
EnableInteroperability
- Type: typing.Optional[bool]
CreateOrganizationResponseTypeDef
OrganizationId
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateResourceRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
Type
- Type: typing.Literal['EQUIPMENT', 'ROOM']
- Required: Yes
Description
- Type: typing.Optional[str]
HiddenFromGlobalAddressList
- Type: typing.Optional[bool]
CreateResourceResponseTypeDef
ResourceId
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateUserRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
DisplayName
- Type:
- Required: Yes
Password
- Type: typing.Optional[str]
Role
- Type: typing.Optional[typing.Literal['REMOTE_USER', 'RESOURCE', 'SYSTEM_USER', 'USER']]
FirstName
- Type: typing.Optional[str]
LastName
- Type: typing.Optional[str]
HiddenFromGlobalAddressList
- Type: typing.Optional[bool]
CreateUserResponseTypeDef
UserId
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DelegateTypeDef
Id
- Type:
- Required: Yes
Type
- Type: typing.Literal['GROUP', 'USER']
- Required: Yes
DeleteAccessControlRuleRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
DeleteAliasRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
EntityId
- Type:
- Required: Yes
Alias
- Type:
- Required: Yes
DeleteAvailabilityConfigurationRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
DomainName
- Type:
- Required: Yes
DeleteEmailMonitoringConfigurationRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
DeleteGroupRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
GroupId
- Type:
- Required: Yes
DeleteImpersonationRoleRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
ImpersonationRoleId
- Type:
- Required: Yes
DeleteMailboxPermissionsRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
EntityId
- Type:
- Required: Yes
GranteeId
- Type:
- Required: Yes
DeleteMobileDeviceAccessOverrideRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
UserId
- Type:
- Required: Yes
DeviceId
- Type:
- Required: Yes
DeleteMobileDeviceAccessRuleRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
MobileDeviceAccessRuleId
- Type:
- Required: Yes
DeleteOrganizationRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
DeleteDirectory
- Type:
- Required: Yes
ClientToken
- Type: typing.Optional[str]
ForceDelete
- Type: typing.Optional[bool]
DeleteOrganizationResponseTypeDef
OrganizationId
- Type:
- Required: Yes
State
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DeleteResourceRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
ResourceId
- Type:
- Required: Yes
DeleteRetentionPolicyRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
Id
- Type:
- Required: Yes
DeleteUserRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
UserId
- Type:
- Required: Yes
DeregisterFromWorkMailRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
EntityId
- Type:
- Required: Yes
DeregisterMailDomainRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
DomainName
- Type:
- Required: Yes
DescribeEmailMonitoringConfigurationRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
DescribeEmailMonitoringConfigurationResponseTypeDef
RoleArn
- Type:
- Required: Yes
LogGroupArn
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeEntityRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
- Type:
- Required: Yes
DescribeEntityResponseTypeDef
EntityId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
Type
- Type: typing.Literal['GROUP', 'RESOURCE', 'USER']
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeGroupRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
GroupId
- Type:
- Required: Yes
DescribeGroupResponseTypeDef
GroupId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
- Type:
- Required: Yes
State
- Type: typing.Literal['DELETED', 'DISABLED', 'ENABLED']
- Required: Yes
EnabledDate
- Type:
- Required: Yes
DisabledDate
- Type:
- Required: Yes
HiddenFromGlobalAddressList
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeInboundDmarcSettingsRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
DescribeInboundDmarcSettingsResponseTypeDef
Enforced
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeMailboxExportJobRequestRequestTypeDef
JobId
- Type:
- Required: Yes
OrganizationId
- Type:
- Required: Yes
DescribeMailboxExportJobResponseTypeDef
EntityId
- Type:
- Required: Yes
Description
- Type:
- Required: Yes
RoleArn
- Type:
- Required: Yes
KmsKeyArn
- Type:
- Required: Yes
S3BucketName
- Type:
- Required: Yes
S3Prefix
- Type:
- Required: Yes
S3Path
- Type:
- Required: Yes
EstimatedProgress
- Type:
- Required: Yes
State
- Type: typing.Literal['CANCELLED', 'COMPLETED', 'FAILED', 'RUNNING']
- Required: Yes
ErrorInfo
- Type:
- Required: Yes
StartTime
- Type:
- Required: Yes
EndTime
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeOrganizationRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
DescribeOrganizationResponseTypeDef
OrganizationId
- Type:
- Required: Yes
Alias
- Type:
- Required: Yes
State
- Type:
- Required: Yes
DirectoryId
- Type:
- Required: Yes
DirectoryType
- Type:
- Required: Yes
DefaultMailDomain
- Type:
- Required: Yes
CompletedDate
- Type:
- Required: Yes
ErrorMessage
- Type:
- Required: Yes
ARN
- Type:
- Required: Yes
MigrationAdmin
- Type:
- Required: Yes
InteroperabilityEnabled
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeResourceRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
ResourceId
- Type:
- Required: Yes
DescribeResourceResponseTypeDef
ResourceId
- Type:
- Required: Yes
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
Type
- Type: typing.Literal['EQUIPMENT', 'ROOM']
- Required: Yes
BookingOptions
- Type:
- Required: Yes
State
- Type: typing.Literal['DELETED', 'DISABLED', 'ENABLED']
- Required: Yes
EnabledDate
- Type:
- Required: Yes
DisabledDate
- Type:
- Required: Yes
Description
- Type:
- Required: Yes
HiddenFromGlobalAddressList
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeUserRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
UserId
- Type:
- Required: Yes
DescribeUserResponseTypeDef
UserId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
- Type:
- Required: Yes
DisplayName
- Type:
- Required: Yes
State
- Type: typing.Literal['DELETED', 'DISABLED', 'ENABLED']
- Required: Yes
UserRole
- Type: typing.Literal['REMOTE_USER', 'RESOURCE', 'SYSTEM_USER', 'USER']
- Required: Yes
EnabledDate
- Type:
- Required: Yes
DisabledDate
- Type:
- Required: Yes
MailboxProvisionedDate
- Type:
- Required: Yes
MailboxDeprovisionedDate
- Type:
- Required: Yes
FirstName
- Type:
- Required: Yes
LastName
- Type:
- Required: Yes
HiddenFromGlobalAddressList
- Type:
- Required: Yes
Initials
- Type:
- Required: Yes
Telephone
- Type:
- Required: Yes
Street
- Type:
- Required: Yes
JobTitle
- Type:
- Required: Yes
City
- Type:
- Required: Yes
Company
- Type:
- Required: Yes
ZipCode
- Type:
- Required: Yes
Department
- Type:
- Required: Yes
Country
- Type:
- Required: Yes
Office
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DisassociateDelegateFromResourceRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
ResourceId
- Type:
- Required: Yes
EntityId
- Type:
- Required: Yes
DisassociateMemberFromGroupRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
GroupId
- Type:
- Required: Yes
MemberId
- Type:
- Required: Yes
DnsRecordTypeDef
Type
- Type: typing.Optional[str]
Hostname
- Type: typing.Optional[str]
Value
- Type: typing.Optional[str]
DomainTypeDef
DomainName
- Type:
- Required: Yes
HostedZoneId
- Type: typing.Optional[str]
EwsAvailabilityProviderTypeDef
EwsEndpoint
- Type:
- Required: Yes
EwsUsername
- Type:
- Required: Yes
EwsPassword
- Type:
- Required: Yes
FolderConfigurationTypeDef
Name
- Type: typing.Literal['DELETED_ITEMS', 'DRAFTS', 'INBOX', 'JUNK_EMAIL', 'SENT_ITEMS']
- Required: Yes
Action
- Type: typing.Literal['DELETE', 'NONE', 'PERMANENTLY_DELETE']
- Required: Yes
Period
- Type: typing.Optional[int]
GetAccessControlEffectRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
IpAddress
- Type:
- Required: Yes
Action
- Type:
- Required: Yes
UserId
- Type: typing.Optional[str]
ImpersonationRoleId
- Type: typing.Optional[str]
GetAccessControlEffectResponseTypeDef
Effect
- Type: typing.Literal['ALLOW', 'DENY']
- Required: Yes
MatchedRules
- Type: typing.List[str]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetDefaultRetentionPolicyRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
GetDefaultRetentionPolicyResponseTypeDef
Id
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
Description
- Type:
- Required: Yes
FolderConfigurations
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.FolderConfigurationTypeDef]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetImpersonationRoleEffectRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
ImpersonationRoleId
- Type:
- Required: Yes
TargetUser
- Type:
- Required: Yes
GetImpersonationRoleEffectResponseTypeDef
Type
- Type: typing.Literal['FULL_ACCESS', 'READ_ONLY']
- Required: Yes
Effect
- Type: typing.Literal['ALLOW', 'DENY']
- Required: Yes
MatchedRules
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.ImpersonationMatchedRuleTypeDef]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetImpersonationRoleRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
ImpersonationRoleId
- Type:
- Required: Yes
GetImpersonationRoleResponseTypeDef
ImpersonationRoleId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
Type
- Type: typing.Literal['FULL_ACCESS', 'READ_ONLY']
- Required: Yes
Description
- Type:
- Required: Yes
Rules
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.ImpersonationRuleTypeDef]
- Required: Yes
DateCreated
- Type:
- Required: Yes
DateModified
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetMailDomainRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
DomainName
- Type:
- Required: Yes
GetMailDomainResponseTypeDef
Records
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.DnsRecordTypeDef]
- Required: Yes
IsTestDomain
- Type:
- Required: Yes
IsDefault
- Type:
- Required: Yes
OwnershipVerificationStatus
- Type: typing.Literal['FAILED', 'PENDING', 'VERIFIED']
- Required: Yes
DkimVerificationStatus
- Type: typing.Literal['FAILED', 'PENDING', 'VERIFIED']
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetMailboxDetailsRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
UserId
- Type:
- Required: Yes
GetMailboxDetailsResponseTypeDef
MailboxQuota
- Type:
- Required: Yes
MailboxSize
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetMobileDeviceAccessEffectRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
DeviceType
- Type: typing.Optional[str]
DeviceModel
- Type: typing.Optional[str]
DeviceOperatingSystem
- Type: typing.Optional[str]
DeviceUserAgent
- Type: typing.Optional[str]
GetMobileDeviceAccessEffectResponseTypeDef
Effect
- Type: typing.Literal['ALLOW', 'DENY']
- Required: Yes
MatchedRules
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.MobileDeviceAccessMatchedRuleTypeDef]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetMobileDeviceAccessOverrideRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
UserId
- Type:
- Required: Yes
DeviceId
- Type:
- Required: Yes
GetMobileDeviceAccessOverrideResponseTypeDef
UserId
- Type:
- Required: Yes
DeviceId
- Type:
- Required: Yes
Effect
- Type: typing.Literal['ALLOW', 'DENY']
- Required: Yes
Description
- Type:
- Required: Yes
DateCreated
- Type:
- Required: Yes
DateModified
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GroupIdentifierTypeDef
GroupId
- Type: typing.Optional[str]
GroupName
- Type: typing.Optional[str]
GroupTypeDef
Id
- Type: typing.Optional[str]
- Type: typing.Optional[str]
Name
- Type: typing.Optional[str]
State
- Type: typing.Optional[typing.Literal['DELETED', 'DISABLED', 'ENABLED']]
EnabledDate
- Type: typing.Optional[datetime.datetime]
DisabledDate
- Type: typing.Optional[datetime.datetime]
ImpersonationMatchedRuleTypeDef
ImpersonationRuleId
- Type: typing.Optional[str]
Name
- Type: typing.Optional[str]
ImpersonationRoleTypeDef
ImpersonationRoleId
- Type: typing.Optional[str]
Name
- Type: typing.Optional[str]
Type
- Type: typing.Optional[typing.Literal['FULL_ACCESS', 'READ_ONLY']]
DateCreated
- Type: typing.Optional[datetime.datetime]
DateModified
- Type: typing.Optional[datetime.datetime]
ImpersonationRuleTypeDef
ImpersonationRuleId
- Type:
- Required: Yes
Effect
- Type: typing.Literal['ALLOW', 'DENY']
- Required: Yes
Name
- Type: typing.Optional[str]
Description
- Type: typing.Optional[str]
TargetUsers
- Type: typing.Optional[typing.Sequence[str]]
NotTargetUsers
- Type: typing.Optional[typing.Sequence[str]]
LambdaAvailabilityProviderTypeDef
LambdaArn
- Type:
- Required: Yes
ListAccessControlRulesRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
ListAccessControlRulesResponseTypeDef
Rules
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.AccessControlRuleTypeDef]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListAliasesRequestListAliasesPaginateTypeDef
OrganizationId
- Type:
- Required: Yes
EntityId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.PaginatorConfigTypeDef]
ListAliasesRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
EntityId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListAliasesResponseTypeDef
Aliases
- Type: typing.List[str]
- Required: Yes
NextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListAvailabilityConfigurationsRequestListAvailabilityConfigurationsPaginateTypeDef
OrganizationId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.PaginatorConfigTypeDef]
ListAvailabilityConfigurationsRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
MaxResults
- Type: typing.Optional[int]
NextToken
- Type: typing.Optional[str]
ListAvailabilityConfigurationsResponseTypeDef
AvailabilityConfigurations
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.AvailabilityConfigurationTypeDef]
- Required: Yes
NextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListGroupMembersRequestListGroupMembersPaginateTypeDef
OrganizationId
- Type:
- Required: Yes
GroupId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.PaginatorConfigTypeDef]
ListGroupMembersRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
GroupId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListGroupMembersResponseTypeDef
Members
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.MemberTypeDef]
- Required: Yes
NextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListGroupsFiltersTypeDef
NamePrefix
- Type: typing.Optional[str]
PrimaryEmailPrefix
- Type: typing.Optional[str]
State
- Type: typing.Optional[typing.Literal['DELETED', 'DISABLED', 'ENABLED']]
ListGroupsForEntityFiltersTypeDef
GroupNamePrefix
- Type: typing.Optional[str]
ListGroupsForEntityRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
EntityId
- Type:
- Required: Yes
Filters
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.ListGroupsForEntityFiltersTypeDef]
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListGroupsForEntityResponseTypeDef
Groups
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.GroupIdentifierTypeDef]
- Required: Yes
NextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListGroupsRequestListGroupsPaginateTypeDef
OrganizationId
- Type:
- Required: Yes
Filters
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.ListGroupsFiltersTypeDef]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.PaginatorConfigTypeDef]
ListGroupsRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
Filters
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.ListGroupsFiltersTypeDef]
ListGroupsResponseTypeDef
Groups
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.GroupTypeDef]
- Required: Yes
NextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListImpersonationRolesRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListImpersonationRolesResponseTypeDef
Roles
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.ImpersonationRoleTypeDef]
- Required: Yes
NextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListMailDomainsRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
MaxResults
- Type: typing.Optional[int]
NextToken
- Type: typing.Optional[str]
ListMailDomainsResponseTypeDef
MailDomains
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.MailDomainSummaryTypeDef]
- Required: Yes
NextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListMailboxExportJobsRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListMailboxExportJobsResponseTypeDef
Jobs
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.MailboxExportJobTypeDef]
- Required: Yes
NextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListMailboxPermissionsRequestListMailboxPermissionsPaginateTypeDef
OrganizationId
- Type:
- Required: Yes
EntityId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.PaginatorConfigTypeDef]
ListMailboxPermissionsRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
EntityId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListMailboxPermissionsResponseTypeDef
Permissions
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.PermissionTypeDef]
- Required: Yes
NextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListMobileDeviceAccessOverridesRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
UserId
- Type: typing.Optional[str]
DeviceId
- Type: typing.Optional[str]
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListMobileDeviceAccessOverridesResponseTypeDef
Overrides
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.MobileDeviceAccessOverrideTypeDef]
- Required: Yes
NextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListMobileDeviceAccessRulesRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
ListMobileDeviceAccessRulesResponseTypeDef
Rules
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.MobileDeviceAccessRuleTypeDef]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListOrganizationsRequestListOrganizationsPaginateTypeDef
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.PaginatorConfigTypeDef]
ListOrganizationsRequestRequestTypeDef
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListOrganizationsResponseTypeDef
OrganizationSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.OrganizationSummaryTypeDef]
- Required: Yes
NextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListResourceDelegatesRequestListResourceDelegatesPaginateTypeDef
OrganizationId
- Type:
- Required: Yes
ResourceId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.PaginatorConfigTypeDef]
ListResourceDelegatesRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
ResourceId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListResourceDelegatesResponseTypeDef
Delegates
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.DelegateTypeDef]
- Required: Yes
NextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListResourcesFiltersTypeDef
NamePrefix
- Type: typing.Optional[str]
PrimaryEmailPrefix
- Type: typing.Optional[str]
State
- Type: typing.Optional[typing.Literal['DELETED', 'DISABLED', 'ENABLED']]
ListResourcesRequestListResourcesPaginateTypeDef
OrganizationId
- Type:
- Required: Yes
Filters
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.ListResourcesFiltersTypeDef]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.PaginatorConfigTypeDef]
ListResourcesRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
Filters
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.ListResourcesFiltersTypeDef]
ListResourcesResponseTypeDef
Resources
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.ResourceTypeDef]
- Required: Yes
NextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListTagsForResourceRequestRequestTypeDef
ResourceARN
- Type:
- Required: Yes
ListTagsForResourceResponseTypeDef
Tags
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.TagTypeDef]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListUsersFiltersTypeDef
UsernamePrefix
- Type: typing.Optional[str]
DisplayNamePrefix
- Type: typing.Optional[str]
PrimaryEmailPrefix
- Type: typing.Optional[str]
State
- Type: typing.Optional[typing.Literal['DELETED', 'DISABLED', 'ENABLED']]
ListUsersRequestListUsersPaginateTypeDef
OrganizationId
- Type:
- Required: Yes
Filters
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.ListUsersFiltersTypeDef]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.PaginatorConfigTypeDef]
ListUsersRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
Filters
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.ListUsersFiltersTypeDef]
ListUsersResponseTypeDef
Users
- Type: typing.List[aws_resource_validator.pydantic_models.workmail_classes.UserTypeDef]
- Required: Yes
NextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
MailDomainSummaryTypeDef
DomainName
- Type: typing.Optional[str]
DefaultDomain
- Type: typing.Optional[bool]
MailboxExportJobTypeDef
JobId
- Type: typing.Optional[str]
EntityId
- Type: typing.Optional[str]
Description
- Type: typing.Optional[str]
S3BucketName
- Type: typing.Optional[str]
S3Path
- Type: typing.Optional[str]
EstimatedProgress
- Type: typing.Optional[int]
State
- Type: typing.Optional[typing.Literal['CANCELLED', 'COMPLETED', 'FAILED', 'RUNNING']]
StartTime
- Type: typing.Optional[datetime.datetime]
EndTime
- Type: typing.Optional[datetime.datetime]
MemberTypeDef
Id
- Type: typing.Optional[str]
Name
- Type: typing.Optional[str]
Type
- Type: typing.Optional[typing.Literal['GROUP', 'USER']]
State
- Type: typing.Optional[typing.Literal['DELETED', 'DISABLED', 'ENABLED']]
EnabledDate
- Type: typing.Optional[datetime.datetime]
DisabledDate
- Type: typing.Optional[datetime.datetime]
MobileDeviceAccessMatchedRuleTypeDef
MobileDeviceAccessRuleId
- Type: typing.Optional[str]
Name
- Type: typing.Optional[str]
MobileDeviceAccessOverrideTypeDef
UserId
- Type: typing.Optional[str]
DeviceId
- Type: typing.Optional[str]
Effect
- Type: typing.Optional[typing.Literal['ALLOW', 'DENY']]
Description
- Type: typing.Optional[str]
DateCreated
- Type: typing.Optional[datetime.datetime]
DateModified
- Type: typing.Optional[datetime.datetime]
MobileDeviceAccessRuleTypeDef
MobileDeviceAccessRuleId
- Type: typing.Optional[str]
Name
- Type: typing.Optional[str]
Description
- Type: typing.Optional[str]
Effect
- Type: typing.Optional[typing.Literal['ALLOW', 'DENY']]
DeviceTypes
- Type: typing.Optional[typing.List[str]]
NotDeviceTypes
- Type: typing.Optional[typing.List[str]]
DeviceModels
- Type: typing.Optional[typing.List[str]]
NotDeviceModels
- Type: typing.Optional[typing.List[str]]
DeviceOperatingSystems
- Type: typing.Optional[typing.List[str]]
NotDeviceOperatingSystems
- Type: typing.Optional[typing.List[str]]
DeviceUserAgents
- Type: typing.Optional[typing.List[str]]
NotDeviceUserAgents
- Type: typing.Optional[typing.List[str]]
DateCreated
- Type: typing.Optional[datetime.datetime]
DateModified
- Type: typing.Optional[datetime.datetime]
OrganizationSummaryTypeDef
OrganizationId
- Type: typing.Optional[str]
Alias
- Type: typing.Optional[str]
DefaultMailDomain
- Type: typing.Optional[str]
ErrorMessage
- Type: typing.Optional[str]
State
- Type: typing.Optional[str]
PaginatorConfigTypeDef
MaxItems
- Type: typing.Optional[int]
PageSize
- Type: typing.Optional[int]
StartingToken
- Type: typing.Optional[str]
PermissionTypeDef
GranteeId
- Type:
- Required: Yes
GranteeType
- Type: typing.Literal['GROUP', 'USER']
- Required: Yes
PermissionValues
- Type: typing.List[typing.Literal['FULL_ACCESS', 'SEND_AS', 'SEND_ON_BEHALF']]
- Required: Yes
PutAccessControlRuleRequestRequestTypeDef
Name
- Type:
- Required: Yes
Effect
- Type: typing.Literal['ALLOW', 'DENY']
- Required: Yes
Description
- Type:
- Required: Yes
OrganizationId
- Type:
- Required: Yes
IpRanges
- Type: typing.Optional[typing.Sequence[str]]
NotIpRanges
- Type: typing.Optional[typing.Sequence[str]]
Actions
- Type: typing.Optional[typing.Sequence[str]]
NotActions
- Type: typing.Optional[typing.Sequence[str]]
UserIds
- Type: typing.Optional[typing.Sequence[str]]
NotUserIds
- Type: typing.Optional[typing.Sequence[str]]
ImpersonationRoleIds
- Type: typing.Optional[typing.Sequence[str]]
NotImpersonationRoleIds
- Type: typing.Optional[typing.Sequence[str]]
PutEmailMonitoringConfigurationRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
RoleArn
- Type:
- Required: Yes
LogGroupArn
- Type:
- Required: Yes
PutInboundDmarcSettingsRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
Enforced
- Type:
- Required: Yes
PutMailboxPermissionsRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
EntityId
- Type:
- Required: Yes
GranteeId
- Type:
- Required: Yes
PermissionValues
- Type: typing.Sequence[typing.Literal['FULL_ACCESS', 'SEND_AS', 'SEND_ON_BEHALF']]
- Required: Yes
PutMobileDeviceAccessOverrideRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
UserId
- Type:
- Required: Yes
DeviceId
- Type:
- Required: Yes
Effect
- Type: typing.Literal['ALLOW', 'DENY']
- Required: Yes
Description
- Type: typing.Optional[str]
PutRetentionPolicyRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
FolderConfigurations
- Type: typing.Sequence[aws_resource_validator.pydantic_models.workmail_classes.FolderConfigurationTypeDef]
- Required: Yes
Id
- Type: typing.Optional[str]
Description
- Type: typing.Optional[str]
RedactedEwsAvailabilityProviderTypeDef
EwsEndpoint
- Type: typing.Optional[str]
EwsUsername
- Type: typing.Optional[str]
RegisterMailDomainRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
DomainName
- Type:
- Required: Yes
ClientToken
- Type: typing.Optional[str]
RegisterToWorkMailRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
EntityId
- Type:
- Required: Yes
- Type:
- Required: Yes
ResetPasswordRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
UserId
- Type:
- Required: Yes
Password
- Type:
- Required: Yes
ResourceTypeDef
Id
- Type: typing.Optional[str]
- Type: typing.Optional[str]
Name
- Type: typing.Optional[str]
Type
- Type: typing.Optional[typing.Literal['EQUIPMENT', 'ROOM']]
State
- Type: typing.Optional[typing.Literal['DELETED', 'DISABLED', 'ENABLED']]
EnabledDate
- Type: typing.Optional[datetime.datetime]
DisabledDate
- Type: typing.Optional[datetime.datetime]
Description
- Type: typing.Optional[str]
ResponseMetadataTypeDef
RequestId
- Type:
- Required: Yes
HostId
- Type:
- Required: Yes
HTTPStatusCode
- Type:
- Required: Yes
HTTPHeaders
- Type: typing.Dict[str, str]
- Required: Yes
RetryAttempts
- Type:
- Required: Yes
StartMailboxExportJobRequestRequestTypeDef
ClientToken
- Type:
- Required: Yes
OrganizationId
- Type:
- Required: Yes
EntityId
- Type:
- Required: Yes
RoleArn
- Type:
- Required: Yes
KmsKeyArn
- Type:
- Required: Yes
S3BucketName
- Type:
- Required: Yes
S3Prefix
- Type:
- Required: Yes
Description
- Type: typing.Optional[str]
StartMailboxExportJobResponseTypeDef
JobId
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
TagResourceRequestRequestTypeDef
ResourceARN
- Type:
- Required: Yes
Tags
- Type: typing.Sequence[aws_resource_validator.pydantic_models.workmail_classes.TagTypeDef]
- Required: Yes
TagTypeDef
Key
- Type:
- Required: Yes
Value
- Type:
- Required: Yes
TestAvailabilityConfigurationRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
DomainName
- Type: typing.Optional[str]
EwsProvider
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.EwsAvailabilityProviderTypeDef]
LambdaProvider
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.LambdaAvailabilityProviderTypeDef]
TestAvailabilityConfigurationResponseTypeDef
TestPassed
- Type:
- Required: Yes
FailureReason
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UntagResourceRequestRequestTypeDef
ResourceARN
- Type:
- Required: Yes
TagKeys
- Type: typing.Sequence[str]
- Required: Yes
UpdateAvailabilityConfigurationRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
DomainName
- Type:
- Required: Yes
EwsProvider
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.EwsAvailabilityProviderTypeDef]
LambdaProvider
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.LambdaAvailabilityProviderTypeDef]
UpdateDefaultMailDomainRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
DomainName
- Type:
- Required: Yes
UpdateGroupRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
GroupId
- Type:
- Required: Yes
HiddenFromGlobalAddressList
- Type: typing.Optional[bool]
UpdateImpersonationRoleRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
ImpersonationRoleId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
Type
- Type: typing.Literal['FULL_ACCESS', 'READ_ONLY']
- Required: Yes
Rules
- Type: typing.Sequence[aws_resource_validator.pydantic_models.workmail_classes.ImpersonationRuleTypeDef]
- Required: Yes
Description
- Type: typing.Optional[str]
UpdateMailboxQuotaRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
UserId
- Type:
- Required: Yes
MailboxQuota
- Type:
- Required: Yes
UpdateMobileDeviceAccessRuleRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
MobileDeviceAccessRuleId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
Effect
- Type: typing.Literal['ALLOW', 'DENY']
- Required: Yes
Description
- Type: typing.Optional[str]
DeviceTypes
- Type: typing.Optional[typing.Sequence[str]]
NotDeviceTypes
- Type: typing.Optional[typing.Sequence[str]]
DeviceModels
- Type: typing.Optional[typing.Sequence[str]]
NotDeviceModels
- Type: typing.Optional[typing.Sequence[str]]
DeviceOperatingSystems
- Type: typing.Optional[typing.Sequence[str]]
NotDeviceOperatingSystems
- Type: typing.Optional[typing.Sequence[str]]
DeviceUserAgents
- Type: typing.Optional[typing.Sequence[str]]
NotDeviceUserAgents
- Type: typing.Optional[typing.Sequence[str]]
UpdatePrimaryEmailAddressRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
EntityId
- Type:
- Required: Yes
- Type:
- Required: Yes
UpdateResourceRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
ResourceId
- Type:
- Required: Yes
Name
- Type: typing.Optional[str]
BookingOptions
- Type: typing.Optional[aws_resource_validator.pydantic_models.workmail_classes.BookingOptionsTypeDef]
Description
- Type: typing.Optional[str]
Type
- Type: typing.Optional[typing.Literal['EQUIPMENT', 'ROOM']]
HiddenFromGlobalAddressList
- Type: typing.Optional[bool]
UpdateUserRequestRequestTypeDef
OrganizationId
- Type:
- Required: Yes
UserId
- Type:
- Required: Yes
Role
- Type: typing.Optional[typing.Literal['REMOTE_USER', 'RESOURCE', 'SYSTEM_USER', 'USER']]
DisplayName
- Type: typing.Optional[str]
FirstName
- Type: typing.Optional[str]
LastName
- Type: typing.Optional[str]
HiddenFromGlobalAddressList
- Type: typing.Optional[bool]
Initials
- Type: typing.Optional[str]
Telephone
- Type: typing.Optional[str]
Street
- Type: typing.Optional[str]
JobTitle
- Type: typing.Optional[str]
City
- Type: typing.Optional[str]
Company
- Type: typing.Optional[str]
ZipCode
- Type: typing.Optional[str]
Department
- Type: typing.Optional[str]
Country
- Type: typing.Optional[str]
Office
- Type: typing.Optional[str]
UserTypeDef
Id
- Type: typing.Optional[str]
- Type: typing.Optional[str]
Name
- Type: typing.Optional[str]
DisplayName
- Type: typing.Optional[str]
State
- Type: typing.Optional[typing.Literal['DELETED', 'DISABLED', 'ENABLED']]
UserRole
- Type: typing.Optional[typing.Literal['REMOTE_USER', 'RESOURCE', 'SYSTEM_USER', 'USER']]
EnabledDate
- Type: typing.Optional[datetime.datetime]
DisabledDate
- Type: typing.Optional[datetime.datetime]