Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Amazonka.WorkMail
Contents
- Service Configuration
- Errors
- DirectoryInUseException
- DirectoryServiceAuthenticationFailedException
- DirectoryUnavailableException
- EmailAddressInUseException
- EntityAlreadyRegisteredException
- EntityNotFoundException
- EntityStateException
- InvalidConfigurationException
- InvalidCustomSesConfigurationException
- InvalidParameterException
- InvalidPasswordException
- LimitExceededException
- MailDomainInUseException
- MailDomainNotFoundException
- MailDomainStateException
- NameAvailabilityException
- OrganizationNotFoundException
- OrganizationStateException
- ReservedNameException
- ResourceNotFoundException
- TooManyTagsException
- UnsupportedOperationException
- Waiters
- Operations
- AssociateDelegateToResource
- AssociateMemberToGroup
- AssumeImpersonationRole
- CancelMailboxExportJob
- CreateAlias
- CreateAvailabilityConfiguration
- CreateGroup
- CreateImpersonationRole
- CreateMobileDeviceAccessRule
- CreateOrganization
- CreateResource
- CreateUser
- DeleteAccessControlRule
- DeleteAlias
- DeleteAvailabilityConfiguration
- DeleteEmailMonitoringConfiguration
- DeleteGroup
- DeleteImpersonationRole
- DeleteMailboxPermissions
- DeleteMobileDeviceAccessOverride
- DeleteMobileDeviceAccessRule
- DeleteOrganization
- DeleteResource
- DeleteRetentionPolicy
- DeleteUser
- DeregisterFromWorkMail
- DeregisterMailDomain
- DescribeEmailMonitoringConfiguration
- DescribeGroup
- DescribeInboundDmarcSettings
- DescribeMailboxExportJob
- DescribeOrganization
- DescribeResource
- DescribeUser
- DisassociateDelegateFromResource
- DisassociateMemberFromGroup
- GetAccessControlEffect
- GetDefaultRetentionPolicy
- GetImpersonationRole
- GetImpersonationRoleEffect
- GetMailDomain
- GetMailboxDetails
- GetMobileDeviceAccessEffect
- GetMobileDeviceAccessOverride
- ListAccessControlRules
- ListAliases (Paginated)
- ListAvailabilityConfigurations (Paginated)
- ListGroupMembers (Paginated)
- ListGroups (Paginated)
- ListImpersonationRoles
- ListMailDomains
- ListMailboxExportJobs
- ListMailboxPermissions (Paginated)
- ListMobileDeviceAccessOverrides
- ListMobileDeviceAccessRules
- ListOrganizations (Paginated)
- ListResourceDelegates (Paginated)
- ListResources (Paginated)
- ListTagsForResource
- ListUsers (Paginated)
- PutAccessControlRule
- PutEmailMonitoringConfiguration
- PutInboundDmarcSettings
- PutMailboxPermissions
- PutMobileDeviceAccessOverride
- PutRetentionPolicy
- RegisterMailDomain
- RegisterToWorkMail
- ResetPassword
- StartMailboxExportJob
- TagResource
- TestAvailabilityConfiguration
- UntagResource
- UpdateAvailabilityConfiguration
- UpdateDefaultMailDomain
- UpdateImpersonationRole
- UpdateMailboxQuota
- UpdateMobileDeviceAccessRule
- UpdatePrimaryEmailAddress
- UpdateResource
- Types
- AccessControlRuleEffect
- AccessEffect
- AvailabilityProviderType
- DnsRecordVerificationStatus
- EntityState
- FolderName
- ImpersonationRoleType
- MailboxExportJobState
- MemberType
- MobileDeviceAccessRuleEffect
- PermissionType
- ResourceType
- RetentionAction
- UserRole
- AccessControlRule
- AvailabilityConfiguration
- BookingOptions
- Delegate
- DnsRecord
- Domain
- EwsAvailabilityProvider
- FolderConfiguration
- Group
- ImpersonationMatchedRule
- ImpersonationRole
- ImpersonationRule
- LambdaAvailabilityProvider
- MailDomainSummary
- MailboxExportJob
- Member
- MobileDeviceAccessMatchedRule
- MobileDeviceAccessOverride
- MobileDeviceAccessRule
- OrganizationSummary
- Permission
- RedactedEwsAvailabilityProvider
- Resource
- Tag
- User
Description
Derived from API version 2017-10-01
of the AWS service descriptions, licensed under Apache 2.0.
WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.
The WorkMail API is designed for the following scenarios:
- Listing and describing organizations
- Managing users
- Managing groups
- Managing resources
All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.
Synopsis
- defaultService :: Service
- _DirectoryInUseException :: AsError a => Fold a ServiceError
- _DirectoryServiceAuthenticationFailedException :: AsError a => Fold a ServiceError
- _DirectoryUnavailableException :: AsError a => Fold a ServiceError
- _EmailAddressInUseException :: AsError a => Fold a ServiceError
- _EntityAlreadyRegisteredException :: AsError a => Fold a ServiceError
- _EntityNotFoundException :: AsError a => Fold a ServiceError
- _EntityStateException :: AsError a => Fold a ServiceError
- _InvalidConfigurationException :: AsError a => Fold a ServiceError
- _InvalidCustomSesConfigurationException :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _InvalidPasswordException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _MailDomainInUseException :: AsError a => Fold a ServiceError
- _MailDomainNotFoundException :: AsError a => Fold a ServiceError
- _MailDomainStateException :: AsError a => Fold a ServiceError
- _NameAvailabilityException :: AsError a => Fold a ServiceError
- _OrganizationNotFoundException :: AsError a => Fold a ServiceError
- _OrganizationStateException :: AsError a => Fold a ServiceError
- _ReservedNameException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- _UnsupportedOperationException :: AsError a => Fold a ServiceError
- data AssociateDelegateToResource = AssociateDelegateToResource' Text Text Text
- newAssociateDelegateToResource :: Text -> Text -> Text -> AssociateDelegateToResource
- data AssociateDelegateToResourceResponse = AssociateDelegateToResourceResponse' Int
- newAssociateDelegateToResourceResponse :: Int -> AssociateDelegateToResourceResponse
- data AssociateMemberToGroup = AssociateMemberToGroup' Text Text Text
- newAssociateMemberToGroup :: Text -> Text -> Text -> AssociateMemberToGroup
- data AssociateMemberToGroupResponse = AssociateMemberToGroupResponse' Int
- newAssociateMemberToGroupResponse :: Int -> AssociateMemberToGroupResponse
- data AssumeImpersonationRole = AssumeImpersonationRole' Text Text
- newAssumeImpersonationRole :: Text -> Text -> AssumeImpersonationRole
- data AssumeImpersonationRoleResponse = AssumeImpersonationRoleResponse' (Maybe Integer) (Maybe Text) Int
- newAssumeImpersonationRoleResponse :: Int -> AssumeImpersonationRoleResponse
- data CancelMailboxExportJob = CancelMailboxExportJob' Text Text Text
- newCancelMailboxExportJob :: Text -> Text -> Text -> CancelMailboxExportJob
- data CancelMailboxExportJobResponse = CancelMailboxExportJobResponse' Int
- newCancelMailboxExportJobResponse :: Int -> CancelMailboxExportJobResponse
- data CreateAlias = CreateAlias' Text Text Text
- newCreateAlias :: Text -> Text -> Text -> CreateAlias
- data CreateAliasResponse = CreateAliasResponse' Int
- newCreateAliasResponse :: Int -> CreateAliasResponse
- data CreateAvailabilityConfiguration = CreateAvailabilityConfiguration' (Maybe Text) (Maybe EwsAvailabilityProvider) (Maybe LambdaAvailabilityProvider) Text Text
- newCreateAvailabilityConfiguration :: Text -> Text -> CreateAvailabilityConfiguration
- data CreateAvailabilityConfigurationResponse = CreateAvailabilityConfigurationResponse' Int
- newCreateAvailabilityConfigurationResponse :: Int -> CreateAvailabilityConfigurationResponse
- data CreateGroup = CreateGroup' Text Text
- newCreateGroup :: Text -> Text -> CreateGroup
- data CreateGroupResponse = CreateGroupResponse' (Maybe Text) Int
- newCreateGroupResponse :: Int -> CreateGroupResponse
- data CreateImpersonationRole = CreateImpersonationRole' (Maybe Text) (Maybe Text) Text Text ImpersonationRoleType [ImpersonationRule]
- newCreateImpersonationRole :: Text -> Text -> ImpersonationRoleType -> CreateImpersonationRole
- data CreateImpersonationRoleResponse = CreateImpersonationRoleResponse' (Maybe Text) Int
- newCreateImpersonationRoleResponse :: Int -> CreateImpersonationRoleResponse
- data CreateMobileDeviceAccessRule = CreateMobileDeviceAccessRule' (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) Text Text MobileDeviceAccessRuleEffect
- newCreateMobileDeviceAccessRule :: Text -> Text -> MobileDeviceAccessRuleEffect -> CreateMobileDeviceAccessRule
- data CreateMobileDeviceAccessRuleResponse = CreateMobileDeviceAccessRuleResponse' (Maybe Text) Int
- newCreateMobileDeviceAccessRuleResponse :: Int -> CreateMobileDeviceAccessRuleResponse
- data CreateOrganization = CreateOrganization' (Maybe Text) (Maybe Text) (Maybe [Domain]) (Maybe Bool) (Maybe Text) Text
- newCreateOrganization :: Text -> CreateOrganization
- data CreateOrganizationResponse = CreateOrganizationResponse' (Maybe Text) Int
- newCreateOrganizationResponse :: Int -> CreateOrganizationResponse
- data CreateResource = CreateResource' Text Text ResourceType
- newCreateResource :: Text -> Text -> ResourceType -> CreateResource
- data CreateResourceResponse = CreateResourceResponse' (Maybe Text) Int
- newCreateResourceResponse :: Int -> CreateResourceResponse
- data CreateUser = CreateUser' Text Text Text (Sensitive Text)
- newCreateUser :: Text -> Text -> Text -> Text -> CreateUser
- data CreateUserResponse = CreateUserResponse' (Maybe Text) Int
- newCreateUserResponse :: Int -> CreateUserResponse
- data DeleteAccessControlRule = DeleteAccessControlRule' Text Text
- newDeleteAccessControlRule :: Text -> Text -> DeleteAccessControlRule
- data DeleteAccessControlRuleResponse = DeleteAccessControlRuleResponse' Int
- newDeleteAccessControlRuleResponse :: Int -> DeleteAccessControlRuleResponse
- data DeleteAlias = DeleteAlias' Text Text Text
- newDeleteAlias :: Text -> Text -> Text -> DeleteAlias
- data DeleteAliasResponse = DeleteAliasResponse' Int
- newDeleteAliasResponse :: Int -> DeleteAliasResponse
- data DeleteAvailabilityConfiguration = DeleteAvailabilityConfiguration' Text Text
- newDeleteAvailabilityConfiguration :: Text -> Text -> DeleteAvailabilityConfiguration
- data DeleteAvailabilityConfigurationResponse = DeleteAvailabilityConfigurationResponse' Int
- newDeleteAvailabilityConfigurationResponse :: Int -> DeleteAvailabilityConfigurationResponse
- data DeleteEmailMonitoringConfiguration = DeleteEmailMonitoringConfiguration' Text
- newDeleteEmailMonitoringConfiguration :: Text -> DeleteEmailMonitoringConfiguration
- data DeleteEmailMonitoringConfigurationResponse = DeleteEmailMonitoringConfigurationResponse' Int
- newDeleteEmailMonitoringConfigurationResponse :: Int -> DeleteEmailMonitoringConfigurationResponse
- data DeleteGroup = DeleteGroup' Text Text
- newDeleteGroup :: Text -> Text -> DeleteGroup
- data DeleteGroupResponse = DeleteGroupResponse' Int
- newDeleteGroupResponse :: Int -> DeleteGroupResponse
- data DeleteImpersonationRole = DeleteImpersonationRole' Text Text
- newDeleteImpersonationRole :: Text -> Text -> DeleteImpersonationRole
- data DeleteImpersonationRoleResponse = DeleteImpersonationRoleResponse' Int
- newDeleteImpersonationRoleResponse :: Int -> DeleteImpersonationRoleResponse
- data DeleteMailboxPermissions = DeleteMailboxPermissions' Text Text Text
- newDeleteMailboxPermissions :: Text -> Text -> Text -> DeleteMailboxPermissions
- data DeleteMailboxPermissionsResponse = DeleteMailboxPermissionsResponse' Int
- newDeleteMailboxPermissionsResponse :: Int -> DeleteMailboxPermissionsResponse
- data DeleteMobileDeviceAccessOverride = DeleteMobileDeviceAccessOverride' Text Text Text
- newDeleteMobileDeviceAccessOverride :: Text -> Text -> Text -> DeleteMobileDeviceAccessOverride
- data DeleteMobileDeviceAccessOverrideResponse = DeleteMobileDeviceAccessOverrideResponse' Int
- newDeleteMobileDeviceAccessOverrideResponse :: Int -> DeleteMobileDeviceAccessOverrideResponse
- data DeleteMobileDeviceAccessRule = DeleteMobileDeviceAccessRule' Text Text
- newDeleteMobileDeviceAccessRule :: Text -> Text -> DeleteMobileDeviceAccessRule
- data DeleteMobileDeviceAccessRuleResponse = DeleteMobileDeviceAccessRuleResponse' Int
- newDeleteMobileDeviceAccessRuleResponse :: Int -> DeleteMobileDeviceAccessRuleResponse
- data DeleteOrganization = DeleteOrganization' (Maybe Text) Text Bool
- newDeleteOrganization :: Text -> Bool -> DeleteOrganization
- data DeleteOrganizationResponse = DeleteOrganizationResponse' (Maybe Text) (Maybe Text) Int
- newDeleteOrganizationResponse :: Int -> DeleteOrganizationResponse
- data DeleteResource = DeleteResource' Text Text
- newDeleteResource :: Text -> Text -> DeleteResource
- data DeleteResourceResponse = DeleteResourceResponse' Int
- newDeleteResourceResponse :: Int -> DeleteResourceResponse
- data DeleteRetentionPolicy = DeleteRetentionPolicy' Text Text
- newDeleteRetentionPolicy :: Text -> Text -> DeleteRetentionPolicy
- data DeleteRetentionPolicyResponse = DeleteRetentionPolicyResponse' Int
- newDeleteRetentionPolicyResponse :: Int -> DeleteRetentionPolicyResponse
- data DeleteUser = DeleteUser' Text Text
- newDeleteUser :: Text -> Text -> DeleteUser
- data DeleteUserResponse = DeleteUserResponse' Int
- newDeleteUserResponse :: Int -> DeleteUserResponse
- data DeregisterFromWorkMail = DeregisterFromWorkMail' Text Text
- newDeregisterFromWorkMail :: Text -> Text -> DeregisterFromWorkMail
- data DeregisterFromWorkMailResponse = DeregisterFromWorkMailResponse' Int
- newDeregisterFromWorkMailResponse :: Int -> DeregisterFromWorkMailResponse
- data DeregisterMailDomain = DeregisterMailDomain' Text Text
- newDeregisterMailDomain :: Text -> Text -> DeregisterMailDomain
- data DeregisterMailDomainResponse = DeregisterMailDomainResponse' Int
- newDeregisterMailDomainResponse :: Int -> DeregisterMailDomainResponse
- data DescribeEmailMonitoringConfiguration = DescribeEmailMonitoringConfiguration' Text
- newDescribeEmailMonitoringConfiguration :: Text -> DescribeEmailMonitoringConfiguration
- data DescribeEmailMonitoringConfigurationResponse = DescribeEmailMonitoringConfigurationResponse' (Maybe Text) (Maybe Text) Int
- newDescribeEmailMonitoringConfigurationResponse :: Int -> DescribeEmailMonitoringConfigurationResponse
- data DescribeGroup = DescribeGroup' Text Text
- newDescribeGroup :: Text -> Text -> DescribeGroup
- data DescribeGroupResponse = DescribeGroupResponse' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe EntityState) Int
- newDescribeGroupResponse :: Int -> DescribeGroupResponse
- data DescribeInboundDmarcSettings = DescribeInboundDmarcSettings' Text
- newDescribeInboundDmarcSettings :: Text -> DescribeInboundDmarcSettings
- data DescribeInboundDmarcSettingsResponse = DescribeInboundDmarcSettingsResponse' (Maybe Bool) Int
- newDescribeInboundDmarcSettingsResponse :: Int -> DescribeInboundDmarcSettingsResponse
- data DescribeMailboxExportJob = DescribeMailboxExportJob' Text Text
- newDescribeMailboxExportJob :: Text -> Text -> DescribeMailboxExportJob
- data DescribeMailboxExportJobResponse = DescribeMailboxExportJobResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe MailboxExportJobState) Int
- newDescribeMailboxExportJobResponse :: Int -> DescribeMailboxExportJobResponse
- data DescribeOrganization = DescribeOrganization' Text
- newDescribeOrganization :: Text -> DescribeOrganization
- data DescribeOrganizationResponse = DescribeOrganizationResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDescribeOrganizationResponse :: Int -> DescribeOrganizationResponse
- data DescribeResource = DescribeResource' Text Text
- newDescribeResource :: Text -> Text -> DescribeResource
- data DescribeResourceResponse = DescribeResourceResponse' (Maybe BookingOptions) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe EntityState) (Maybe ResourceType) Int
- newDescribeResourceResponse :: Int -> DescribeResourceResponse
- data DescribeUser = DescribeUser' Text Text
- newDescribeUser :: Text -> Text -> DescribeUser
- data DescribeUserResponse = DescribeUserResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe EntityState) (Maybe Text) (Maybe UserRole) Int
- newDescribeUserResponse :: Int -> DescribeUserResponse
- data DisassociateDelegateFromResource = DisassociateDelegateFromResource' Text Text Text
- newDisassociateDelegateFromResource :: Text -> Text -> Text -> DisassociateDelegateFromResource
- data DisassociateDelegateFromResourceResponse = DisassociateDelegateFromResourceResponse' Int
- newDisassociateDelegateFromResourceResponse :: Int -> DisassociateDelegateFromResourceResponse
- data DisassociateMemberFromGroup = DisassociateMemberFromGroup' Text Text Text
- newDisassociateMemberFromGroup :: Text -> Text -> Text -> DisassociateMemberFromGroup
- data DisassociateMemberFromGroupResponse = DisassociateMemberFromGroupResponse' Int
- newDisassociateMemberFromGroupResponse :: Int -> DisassociateMemberFromGroupResponse
- data GetAccessControlEffect = GetAccessControlEffect' (Maybe Text) (Maybe Text) Text Text Text
- newGetAccessControlEffect :: Text -> Text -> Text -> GetAccessControlEffect
- data GetAccessControlEffectResponse = GetAccessControlEffectResponse' (Maybe AccessControlRuleEffect) (Maybe [Text]) Int
- newGetAccessControlEffectResponse :: Int -> GetAccessControlEffectResponse
- data GetDefaultRetentionPolicy = GetDefaultRetentionPolicy' Text
- newGetDefaultRetentionPolicy :: Text -> GetDefaultRetentionPolicy
- data GetDefaultRetentionPolicyResponse = GetDefaultRetentionPolicyResponse' (Maybe Text) (Maybe [FolderConfiguration]) (Maybe Text) (Maybe Text) Int
- newGetDefaultRetentionPolicyResponse :: Int -> GetDefaultRetentionPolicyResponse
- data GetImpersonationRole = GetImpersonationRole' Text Text
- newGetImpersonationRole :: Text -> Text -> GetImpersonationRole
- data GetImpersonationRoleResponse = GetImpersonationRoleResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ImpersonationRule]) (Maybe ImpersonationRoleType) Int
- newGetImpersonationRoleResponse :: Int -> GetImpersonationRoleResponse
- data GetImpersonationRoleEffect = GetImpersonationRoleEffect' Text Text Text
- newGetImpersonationRoleEffect :: Text -> Text -> Text -> GetImpersonationRoleEffect
- data GetImpersonationRoleEffectResponse = GetImpersonationRoleEffectResponse' (Maybe AccessEffect) (Maybe [ImpersonationMatchedRule]) (Maybe ImpersonationRoleType) Int
- newGetImpersonationRoleEffectResponse :: Int -> GetImpersonationRoleEffectResponse
- data GetMailDomain = GetMailDomain' Text Text
- newGetMailDomain :: Text -> Text -> GetMailDomain
- data GetMailDomainResponse = GetMailDomainResponse' (Maybe DnsRecordVerificationStatus) (Maybe Bool) (Maybe Bool) (Maybe DnsRecordVerificationStatus) (Maybe [DnsRecord]) Int
- newGetMailDomainResponse :: Int -> GetMailDomainResponse
- data GetMailboxDetails = GetMailboxDetails' Text Text
- newGetMailboxDetails :: Text -> Text -> GetMailboxDetails
- data GetMailboxDetailsResponse = GetMailboxDetailsResponse' (Maybe Natural) (Maybe Double) Int
- newGetMailboxDetailsResponse :: Int -> GetMailboxDetailsResponse
- data GetMobileDeviceAccessEffect = GetMobileDeviceAccessEffect' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newGetMobileDeviceAccessEffect :: Text -> GetMobileDeviceAccessEffect
- data GetMobileDeviceAccessEffectResponse = GetMobileDeviceAccessEffectResponse' (Maybe MobileDeviceAccessRuleEffect) (Maybe [MobileDeviceAccessMatchedRule]) Int
- newGetMobileDeviceAccessEffectResponse :: Int -> GetMobileDeviceAccessEffectResponse
- data GetMobileDeviceAccessOverride = GetMobileDeviceAccessOverride' Text Text Text
- newGetMobileDeviceAccessOverride :: Text -> Text -> Text -> GetMobileDeviceAccessOverride
- data GetMobileDeviceAccessOverrideResponse = GetMobileDeviceAccessOverrideResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe MobileDeviceAccessRuleEffect) (Maybe Text) Int
- newGetMobileDeviceAccessOverrideResponse :: Int -> GetMobileDeviceAccessOverrideResponse
- data ListAccessControlRules = ListAccessControlRules' Text
- newListAccessControlRules :: Text -> ListAccessControlRules
- data ListAccessControlRulesResponse = ListAccessControlRulesResponse' (Maybe [AccessControlRule]) Int
- newListAccessControlRulesResponse :: Int -> ListAccessControlRulesResponse
- data ListAliases = ListAliases' (Maybe Natural) (Maybe Text) Text Text
- newListAliases :: Text -> Text -> ListAliases
- data ListAliasesResponse = ListAliasesResponse' (Maybe [Text]) (Maybe Text) Int
- newListAliasesResponse :: Int -> ListAliasesResponse
- data ListAvailabilityConfigurations = ListAvailabilityConfigurations' (Maybe Natural) (Maybe Text) Text
- newListAvailabilityConfigurations :: Text -> ListAvailabilityConfigurations
- data ListAvailabilityConfigurationsResponse = ListAvailabilityConfigurationsResponse' (Maybe [AvailabilityConfiguration]) (Maybe Text) Int
- newListAvailabilityConfigurationsResponse :: Int -> ListAvailabilityConfigurationsResponse
- data ListGroupMembers = ListGroupMembers' (Maybe Natural) (Maybe Text) Text Text
- newListGroupMembers :: Text -> Text -> ListGroupMembers
- data ListGroupMembersResponse = ListGroupMembersResponse' (Maybe [Member]) (Maybe Text) Int
- newListGroupMembersResponse :: Int -> ListGroupMembersResponse
- data ListGroups = ListGroups' (Maybe Natural) (Maybe Text) Text
- newListGroups :: Text -> ListGroups
- data ListGroupsResponse = ListGroupsResponse' (Maybe [Group]) (Maybe Text) Int
- newListGroupsResponse :: Int -> ListGroupsResponse
- data ListImpersonationRoles = ListImpersonationRoles' (Maybe Natural) (Maybe Text) Text
- newListImpersonationRoles :: Text -> ListImpersonationRoles
- data ListImpersonationRolesResponse = ListImpersonationRolesResponse' (Maybe Text) (Maybe [ImpersonationRole]) Int
- newListImpersonationRolesResponse :: Int -> ListImpersonationRolesResponse
- data ListMailDomains = ListMailDomains' (Maybe Natural) (Maybe Text) Text
- newListMailDomains :: Text -> ListMailDomains
- data ListMailDomainsResponse = ListMailDomainsResponse' (Maybe [MailDomainSummary]) (Maybe Text) Int
- newListMailDomainsResponse :: Int -> ListMailDomainsResponse
- data ListMailboxExportJobs = ListMailboxExportJobs' (Maybe Natural) (Maybe Text) Text
- newListMailboxExportJobs :: Text -> ListMailboxExportJobs
- data ListMailboxExportJobsResponse = ListMailboxExportJobsResponse' (Maybe [MailboxExportJob]) (Maybe Text) Int
- newListMailboxExportJobsResponse :: Int -> ListMailboxExportJobsResponse
- data ListMailboxPermissions = ListMailboxPermissions' (Maybe Natural) (Maybe Text) Text Text
- newListMailboxPermissions :: Text -> Text -> ListMailboxPermissions
- data ListMailboxPermissionsResponse = ListMailboxPermissionsResponse' (Maybe Text) (Maybe [Permission]) Int
- newListMailboxPermissionsResponse :: Int -> ListMailboxPermissionsResponse
- data ListMobileDeviceAccessOverrides = ListMobileDeviceAccessOverrides' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) Text
- newListMobileDeviceAccessOverrides :: Text -> ListMobileDeviceAccessOverrides
- data ListMobileDeviceAccessOverridesResponse = ListMobileDeviceAccessOverridesResponse' (Maybe Text) (Maybe [MobileDeviceAccessOverride]) Int
- newListMobileDeviceAccessOverridesResponse :: Int -> ListMobileDeviceAccessOverridesResponse
- data ListMobileDeviceAccessRules = ListMobileDeviceAccessRules' Text
- newListMobileDeviceAccessRules :: Text -> ListMobileDeviceAccessRules
- data ListMobileDeviceAccessRulesResponse = ListMobileDeviceAccessRulesResponse' (Maybe [MobileDeviceAccessRule]) Int
- newListMobileDeviceAccessRulesResponse :: Int -> ListMobileDeviceAccessRulesResponse
- data ListOrganizations = ListOrganizations' (Maybe Natural) (Maybe Text)
- newListOrganizations :: ListOrganizations
- data ListOrganizationsResponse = ListOrganizationsResponse' (Maybe Text) (Maybe [OrganizationSummary]) Int
- newListOrganizationsResponse :: Int -> ListOrganizationsResponse
- data ListResourceDelegates = ListResourceDelegates' (Maybe Natural) (Maybe Text) Text Text
- newListResourceDelegates :: Text -> Text -> ListResourceDelegates
- data ListResourceDelegatesResponse = ListResourceDelegatesResponse' (Maybe [Delegate]) (Maybe Text) Int
- newListResourceDelegatesResponse :: Int -> ListResourceDelegatesResponse
- data ListResources = ListResources' (Maybe Natural) (Maybe Text) Text
- newListResources :: Text -> ListResources
- data ListResourcesResponse = ListResourcesResponse' (Maybe Text) (Maybe [Resource]) Int
- newListResourcesResponse :: Int -> ListResourcesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListUsers = ListUsers' (Maybe Natural) (Maybe Text) Text
- newListUsers :: Text -> ListUsers
- data ListUsersResponse = ListUsersResponse' (Maybe Text) (Maybe [User]) Int
- newListUsersResponse :: Int -> ListUsersResponse
- data PutAccessControlRule = PutAccessControlRule' (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) Text AccessControlRuleEffect Text Text
- newPutAccessControlRule :: Text -> AccessControlRuleEffect -> Text -> Text -> PutAccessControlRule
- data PutAccessControlRuleResponse = PutAccessControlRuleResponse' Int
- newPutAccessControlRuleResponse :: Int -> PutAccessControlRuleResponse
- data PutEmailMonitoringConfiguration = PutEmailMonitoringConfiguration' Text Text Text
- newPutEmailMonitoringConfiguration :: Text -> Text -> Text -> PutEmailMonitoringConfiguration
- data PutEmailMonitoringConfigurationResponse = PutEmailMonitoringConfigurationResponse' Int
- newPutEmailMonitoringConfigurationResponse :: Int -> PutEmailMonitoringConfigurationResponse
- data PutInboundDmarcSettings = PutInboundDmarcSettings' Text Bool
- newPutInboundDmarcSettings :: Text -> Bool -> PutInboundDmarcSettings
- data PutInboundDmarcSettingsResponse = PutInboundDmarcSettingsResponse' Int
- newPutInboundDmarcSettingsResponse :: Int -> PutInboundDmarcSettingsResponse
- data PutMailboxPermissions = PutMailboxPermissions' Text Text Text [PermissionType]
- newPutMailboxPermissions :: Text -> Text -> Text -> PutMailboxPermissions
- data PutMailboxPermissionsResponse = PutMailboxPermissionsResponse' Int
- newPutMailboxPermissionsResponse :: Int -> PutMailboxPermissionsResponse
- data PutMobileDeviceAccessOverride = PutMobileDeviceAccessOverride' (Maybe Text) Text Text Text MobileDeviceAccessRuleEffect
- newPutMobileDeviceAccessOverride :: Text -> Text -> Text -> MobileDeviceAccessRuleEffect -> PutMobileDeviceAccessOverride
- data PutMobileDeviceAccessOverrideResponse = PutMobileDeviceAccessOverrideResponse' Int
- newPutMobileDeviceAccessOverrideResponse :: Int -> PutMobileDeviceAccessOverrideResponse
- data PutRetentionPolicy = PutRetentionPolicy' (Maybe (Sensitive Text)) (Maybe Text) Text Text [FolderConfiguration]
- newPutRetentionPolicy :: Text -> Text -> PutRetentionPolicy
- data PutRetentionPolicyResponse = PutRetentionPolicyResponse' Int
- newPutRetentionPolicyResponse :: Int -> PutRetentionPolicyResponse
- data RegisterMailDomain = RegisterMailDomain' (Maybe Text) Text Text
- newRegisterMailDomain :: Text -> Text -> RegisterMailDomain
- data RegisterMailDomainResponse = RegisterMailDomainResponse' Int
- newRegisterMailDomainResponse :: Int -> RegisterMailDomainResponse
- data RegisterToWorkMail = RegisterToWorkMail' Text Text Text
- newRegisterToWorkMail :: Text -> Text -> Text -> RegisterToWorkMail
- data RegisterToWorkMailResponse = RegisterToWorkMailResponse' Int
- newRegisterToWorkMailResponse :: Int -> RegisterToWorkMailResponse
- data ResetPassword = ResetPassword' Text Text (Sensitive Text)
- newResetPassword :: Text -> Text -> Text -> ResetPassword
- data ResetPasswordResponse = ResetPasswordResponse' Int
- newResetPasswordResponse :: Int -> ResetPasswordResponse
- data StartMailboxExportJob = StartMailboxExportJob' (Maybe Text) Text Text Text Text Text Text Text
- newStartMailboxExportJob :: Text -> Text -> Text -> Text -> Text -> Text -> Text -> StartMailboxExportJob
- data StartMailboxExportJobResponse = StartMailboxExportJobResponse' (Maybe Text) Int
- newStartMailboxExportJobResponse :: Int -> StartMailboxExportJobResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data TestAvailabilityConfiguration = TestAvailabilityConfiguration' (Maybe Text) (Maybe EwsAvailabilityProvider) (Maybe LambdaAvailabilityProvider) Text
- newTestAvailabilityConfiguration :: Text -> TestAvailabilityConfiguration
- data TestAvailabilityConfigurationResponse = TestAvailabilityConfigurationResponse' (Maybe Text) (Maybe Bool) Int
- newTestAvailabilityConfigurationResponse :: Int -> TestAvailabilityConfigurationResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateAvailabilityConfiguration = UpdateAvailabilityConfiguration' (Maybe EwsAvailabilityProvider) (Maybe LambdaAvailabilityProvider) Text Text
- newUpdateAvailabilityConfiguration :: Text -> Text -> UpdateAvailabilityConfiguration
- data UpdateAvailabilityConfigurationResponse = UpdateAvailabilityConfigurationResponse' Int
- newUpdateAvailabilityConfigurationResponse :: Int -> UpdateAvailabilityConfigurationResponse
- data UpdateDefaultMailDomain = UpdateDefaultMailDomain' Text Text
- newUpdateDefaultMailDomain :: Text -> Text -> UpdateDefaultMailDomain
- data UpdateDefaultMailDomainResponse = UpdateDefaultMailDomainResponse' Int
- newUpdateDefaultMailDomainResponse :: Int -> UpdateDefaultMailDomainResponse
- data UpdateImpersonationRole = UpdateImpersonationRole' (Maybe Text) Text Text Text ImpersonationRoleType [ImpersonationRule]
- newUpdateImpersonationRole :: Text -> Text -> Text -> ImpersonationRoleType -> UpdateImpersonationRole
- data UpdateImpersonationRoleResponse = UpdateImpersonationRoleResponse' Int
- newUpdateImpersonationRoleResponse :: Int -> UpdateImpersonationRoleResponse
- data UpdateMailboxQuota = UpdateMailboxQuota' Text Text Natural
- newUpdateMailboxQuota :: Text -> Text -> Natural -> UpdateMailboxQuota
- data UpdateMailboxQuotaResponse = UpdateMailboxQuotaResponse' Int
- newUpdateMailboxQuotaResponse :: Int -> UpdateMailboxQuotaResponse
- data UpdateMobileDeviceAccessRule = UpdateMobileDeviceAccessRule' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) Text Text Text MobileDeviceAccessRuleEffect
- newUpdateMobileDeviceAccessRule :: Text -> Text -> Text -> MobileDeviceAccessRuleEffect -> UpdateMobileDeviceAccessRule
- data UpdateMobileDeviceAccessRuleResponse = UpdateMobileDeviceAccessRuleResponse' Int
- newUpdateMobileDeviceAccessRuleResponse :: Int -> UpdateMobileDeviceAccessRuleResponse
- data UpdatePrimaryEmailAddress = UpdatePrimaryEmailAddress' Text Text Text
- newUpdatePrimaryEmailAddress :: Text -> Text -> Text -> UpdatePrimaryEmailAddress
- data UpdatePrimaryEmailAddressResponse = UpdatePrimaryEmailAddressResponse' Int
- newUpdatePrimaryEmailAddressResponse :: Int -> UpdatePrimaryEmailAddressResponse
- data UpdateResource = UpdateResource' (Maybe BookingOptions) (Maybe Text) Text Text
- newUpdateResource :: Text -> Text -> UpdateResource
- data UpdateResourceResponse = UpdateResourceResponse' Int
- newUpdateResourceResponse :: Int -> UpdateResourceResponse
- newtype AccessControlRuleEffect where
- newtype AccessEffect where
- AccessEffect' { }
- pattern AccessEffect_ALLOW :: AccessEffect
- pattern AccessEffect_DENY :: AccessEffect
- newtype AvailabilityProviderType where
- newtype DnsRecordVerificationStatus where
- newtype EntityState where
- EntityState' { }
- pattern EntityState_DELETED :: EntityState
- pattern EntityState_DISABLED :: EntityState
- pattern EntityState_ENABLED :: EntityState
- newtype FolderName where
- FolderName' { }
- pattern FolderName_DELETED_ITEMS :: FolderName
- pattern FolderName_DRAFTS :: FolderName
- pattern FolderName_INBOX :: FolderName
- pattern FolderName_JUNK_EMAIL :: FolderName
- pattern FolderName_SENT_ITEMS :: FolderName
- newtype ImpersonationRoleType where
- newtype MailboxExportJobState where
- newtype MemberType where
- MemberType' { }
- pattern MemberType_GROUP :: MemberType
- pattern MemberType_USER :: MemberType
- newtype MobileDeviceAccessRuleEffect where
- newtype PermissionType where
- PermissionType' { }
- pattern PermissionType_FULL_ACCESS :: PermissionType
- pattern PermissionType_SEND_AS :: PermissionType
- pattern PermissionType_SEND_ON_BEHALF :: PermissionType
- newtype ResourceType where
- ResourceType' { }
- pattern ResourceType_EQUIPMENT :: ResourceType
- pattern ResourceType_ROOM :: ResourceType
- newtype RetentionAction where
- RetentionAction' { }
- pattern RetentionAction_DELETE :: RetentionAction
- pattern RetentionAction_NONE :: RetentionAction
- pattern RetentionAction_PERMANENTLY_DELETE :: RetentionAction
- newtype UserRole where
- UserRole' {
- fromUserRole :: Text
- pattern UserRole_RESOURCE :: UserRole
- pattern UserRole_SYSTEM_USER :: UserRole
- pattern UserRole_USER :: UserRole
- UserRole' {
- data AccessControlRule = AccessControlRule' (Maybe [Text]) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe AccessControlRuleEffect) (Maybe [Text]) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text])
- newAccessControlRule :: AccessControlRule
- data AvailabilityConfiguration = AvailabilityConfiguration' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe RedactedEwsAvailabilityProvider) (Maybe LambdaAvailabilityProvider) (Maybe AvailabilityProviderType)
- newAvailabilityConfiguration :: AvailabilityConfiguration
- data BookingOptions = BookingOptions' (Maybe Bool) (Maybe Bool) (Maybe Bool)
- newBookingOptions :: BookingOptions
- data Delegate = Delegate' Text MemberType
- newDelegate :: Text -> MemberType -> Delegate
- data DnsRecord = DnsRecord' (Maybe Text) (Maybe Text) (Maybe Text)
- newDnsRecord :: DnsRecord
- data Domain = Domain' (Maybe Text) (Maybe Text)
- newDomain :: Domain
- data EwsAvailabilityProvider = EwsAvailabilityProvider' Text Text (Sensitive Text)
- newEwsAvailabilityProvider :: Text -> Text -> Text -> EwsAvailabilityProvider
- data FolderConfiguration = FolderConfiguration' (Maybe Natural) FolderName RetentionAction
- newFolderConfiguration :: FolderName -> RetentionAction -> FolderConfiguration
- data Group = Group' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe EntityState)
- newGroup :: Group
- data ImpersonationMatchedRule = ImpersonationMatchedRule' (Maybe Text) (Maybe Text)
- newImpersonationMatchedRule :: ImpersonationMatchedRule
- data ImpersonationRole = ImpersonationRole' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ImpersonationRoleType)
- newImpersonationRole :: ImpersonationRole
- data ImpersonationRule = ImpersonationRule' (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) Text AccessEffect
- newImpersonationRule :: Text -> AccessEffect -> ImpersonationRule
- data LambdaAvailabilityProvider = LambdaAvailabilityProvider' Text
- newLambdaAvailabilityProvider :: Text -> LambdaAvailabilityProvider
- data MailDomainSummary = MailDomainSummary' (Maybe Bool) (Maybe Text)
- newMailDomainSummary :: MailDomainSummary
- data MailboxExportJob = MailboxExportJob' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe MailboxExportJobState)
- newMailboxExportJob :: MailboxExportJob
- data Member = Member' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe EntityState) (Maybe MemberType)
- newMember :: Member
- data MobileDeviceAccessMatchedRule = MobileDeviceAccessMatchedRule' (Maybe Text) (Maybe Text)
- newMobileDeviceAccessMatchedRule :: MobileDeviceAccessMatchedRule
- data MobileDeviceAccessOverride = MobileDeviceAccessOverride' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe MobileDeviceAccessRuleEffect) (Maybe Text)
- newMobileDeviceAccessOverride :: MobileDeviceAccessOverride
- data MobileDeviceAccessRule = MobileDeviceAccessRule' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe MobileDeviceAccessRuleEffect) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text))
- newMobileDeviceAccessRule :: MobileDeviceAccessRule
- data OrganizationSummary = OrganizationSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newOrganizationSummary :: OrganizationSummary
- data Permission = Permission' Text MemberType [PermissionType]
- newPermission :: Text -> MemberType -> Permission
- data RedactedEwsAvailabilityProvider = RedactedEwsAvailabilityProvider' (Maybe Text) (Maybe Text)
- newRedactedEwsAvailabilityProvider :: RedactedEwsAvailabilityProvider
- data Resource = Resource' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe EntityState) (Maybe ResourceType)
- newResource :: Resource
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data User = User' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe EntityState) (Maybe UserRole)
- newUser :: User
Service Configuration
defaultService :: Service Source #
API version 2017-10-01
of the Amazon WorkMail SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by WorkMail
.
DirectoryInUseException
_DirectoryInUseException :: AsError a => Fold a ServiceError Source #
The directory is already in use by another WorkMail organization in the same account and Region.
DirectoryServiceAuthenticationFailedException
_DirectoryServiceAuthenticationFailedException :: AsError a => Fold a ServiceError Source #
The directory service doesn't recognize the credentials supplied by WorkMail.
DirectoryUnavailableException
_DirectoryUnavailableException :: AsError a => Fold a ServiceError Source #
The directory is unavailable. It might be located in another Region or deleted.
EmailAddressInUseException
_EmailAddressInUseException :: AsError a => Fold a ServiceError Source #
The email address that you're trying to assign is already created for a different user, group, or resource.
EntityAlreadyRegisteredException
_EntityAlreadyRegisteredException :: AsError a => Fold a ServiceError Source #
The user, group, or resource that you're trying to register is already registered.
EntityNotFoundException
_EntityNotFoundException :: AsError a => Fold a ServiceError Source #
The identifier supplied for the user, group, or resource does not exist in your organization.
EntityStateException
_EntityStateException :: AsError a => Fold a ServiceError Source #
You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
InvalidConfigurationException
_InvalidConfigurationException :: AsError a => Fold a ServiceError Source #
The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests or have at least one delegate associated that can do so on its behalf.
InvalidCustomSesConfigurationException
_InvalidCustomSesConfigurationException :: AsError a => Fold a ServiceError Source #
You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule.
InvalidParameterException
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
One or more of the input parameters don't match the service's restrictions.
InvalidPasswordException
_InvalidPasswordException :: AsError a => Fold a ServiceError Source #
The supplied password doesn't match the minimum security constraints, such as length or use of special characters.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The request exceeds the limit of the resource.
MailDomainInUseException
_MailDomainInUseException :: AsError a => Fold a ServiceError Source #
The domain you're trying to change is in use by another user or organization in your account. See the error message for details.
MailDomainNotFoundException
_MailDomainNotFoundException :: AsError a => Fold a ServiceError Source #
The domain specified is not found in your organization.
MailDomainStateException
_MailDomainStateException :: AsError a => Fold a ServiceError Source #
After a domain has been added to the organization, it must be verified. The domain is not yet verified.
NameAvailabilityException
_NameAvailabilityException :: AsError a => Fold a ServiceError Source #
The user, group, or resource name isn't unique in WorkMail.
OrganizationNotFoundException
_OrganizationNotFoundException :: AsError a => Fold a ServiceError Source #
An operation received a valid organization identifier that either doesn't belong or exist in the system.
OrganizationStateException
_OrganizationStateException :: AsError a => Fold a ServiceError Source #
The organization must have a valid state to perform certain operations on the organization or its members.
ReservedNameException
_ReservedNameException :: AsError a => Fold a ServiceError Source #
This user, group, or resource name is not allowed in WorkMail.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource cannot be found.
TooManyTagsException
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
The resource can have up to 50 user-applied tags.
UnsupportedOperationException
_UnsupportedOperationException :: AsError a => Fold a ServiceError Source #
You can't perform a write operation against a read-only directory.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateDelegateToResource
data AssociateDelegateToResource Source #
See: newAssociateDelegateToResource
smart constructor.
Constructors
AssociateDelegateToResource' Text Text Text |
Instances
newAssociateDelegateToResource Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> AssociateDelegateToResource |
Create a value of AssociateDelegateToResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateDelegateToResource
, associateDelegateToResource_organizationId
- The organization under which the resource exists.
$sel:resourceId:AssociateDelegateToResource'
, associateDelegateToResource_resourceId
- The resource for which members (users or groups) are associated.
AssociateDelegateToResource
, associateDelegateToResource_entityId
- The member (user or group) to associate to the resource.
data AssociateDelegateToResourceResponse Source #
See: newAssociateDelegateToResourceResponse
smart constructor.
Constructors
AssociateDelegateToResourceResponse' Int |
Instances
newAssociateDelegateToResourceResponse Source #
Arguments
:: Int | |
-> AssociateDelegateToResourceResponse |
Create a value of AssociateDelegateToResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AssociateDelegateToResourceResponse'
, associateDelegateToResourceResponse_httpStatus
- The response's http status code.
AssociateMemberToGroup
data AssociateMemberToGroup Source #
See: newAssociateMemberToGroup
smart constructor.
Constructors
AssociateMemberToGroup' Text Text Text |
Instances
newAssociateMemberToGroup Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> AssociateMemberToGroup |
Create a value of AssociateMemberToGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateMemberToGroup
, associateMemberToGroup_organizationId
- The organization under which the group exists.
$sel:groupId:AssociateMemberToGroup'
, associateMemberToGroup_groupId
- The group to which the member (user or group) is associated.
$sel:memberId:AssociateMemberToGroup'
, associateMemberToGroup_memberId
- The member (user or group) to associate to the group.
data AssociateMemberToGroupResponse Source #
See: newAssociateMemberToGroupResponse
smart constructor.
Constructors
AssociateMemberToGroupResponse' Int |
Instances
newAssociateMemberToGroupResponse Source #
Create a value of AssociateMemberToGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AssociateMemberToGroupResponse'
, associateMemberToGroupResponse_httpStatus
- The response's http status code.
AssumeImpersonationRole
data AssumeImpersonationRole Source #
See: newAssumeImpersonationRole
smart constructor.
Constructors
AssumeImpersonationRole' Text Text |
Instances
newAssumeImpersonationRole Source #
Create a value of AssumeImpersonationRole
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssumeImpersonationRole
, assumeImpersonationRole_organizationId
- The WorkMail organization under which the impersonation role will be
assumed.
AssumeImpersonationRole
, assumeImpersonationRole_impersonationRoleId
- The impersonation role ID to assume.
data AssumeImpersonationRoleResponse Source #
See: newAssumeImpersonationRoleResponse
smart constructor.
Instances
newAssumeImpersonationRoleResponse Source #
Create a value of AssumeImpersonationRoleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expiresIn:AssumeImpersonationRoleResponse'
, assumeImpersonationRoleResponse_expiresIn
- The authentication token's validity, in seconds.
$sel:token:AssumeImpersonationRoleResponse'
, assumeImpersonationRoleResponse_token
- The authentication token for the impersonation role.
$sel:httpStatus:AssumeImpersonationRoleResponse'
, assumeImpersonationRoleResponse_httpStatus
- The response's http status code.
CancelMailboxExportJob
data CancelMailboxExportJob Source #
See: newCancelMailboxExportJob
smart constructor.
Constructors
CancelMailboxExportJob' Text Text Text |
Instances
newCancelMailboxExportJob Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> CancelMailboxExportJob |
Create a value of CancelMailboxExportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CancelMailboxExportJob'
, cancelMailboxExportJob_clientToken
- The idempotency token for the client request.
CancelMailboxExportJob
, cancelMailboxExportJob_jobId
- The job ID.
CancelMailboxExportJob
, cancelMailboxExportJob_organizationId
- The organization ID.
data CancelMailboxExportJobResponse Source #
See: newCancelMailboxExportJobResponse
smart constructor.
Constructors
CancelMailboxExportJobResponse' Int |
Instances
newCancelMailboxExportJobResponse Source #
Create a value of CancelMailboxExportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CancelMailboxExportJobResponse'
, cancelMailboxExportJobResponse_httpStatus
- The response's http status code.
CreateAlias
data CreateAlias Source #
See: newCreateAlias
smart constructor.
Constructors
CreateAlias' Text Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> CreateAlias |
Create a value of CreateAlias
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateAlias
, createAlias_organizationId
- The organization under which the member (user or group) exists.
CreateAlias
, createAlias_entityId
- The member (user or group) to which this alias is added.
CreateAlias
, createAlias_alias
- The alias to add to the member set.
data CreateAliasResponse Source #
See: newCreateAliasResponse
smart constructor.
Constructors
CreateAliasResponse' Int |
Instances
newCreateAliasResponse Source #
Arguments
:: Int | |
-> CreateAliasResponse |
Create a value of CreateAliasResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateAliasResponse'
, createAliasResponse_httpStatus
- The response's http status code.
CreateAvailabilityConfiguration
data CreateAvailabilityConfiguration Source #
See: newCreateAvailabilityConfiguration
smart constructor.
Constructors
CreateAvailabilityConfiguration' (Maybe Text) (Maybe EwsAvailabilityProvider) (Maybe LambdaAvailabilityProvider) Text Text |
Instances
newCreateAvailabilityConfiguration Source #
Arguments
:: Text | |
-> Text | |
-> CreateAvailabilityConfiguration |
Create a value of CreateAvailabilityConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateAvailabilityConfiguration'
, createAvailabilityConfiguration_clientToken
- An idempotent token that ensures that an API request is executed only
once.
CreateAvailabilityConfiguration
, createAvailabilityConfiguration_ewsProvider
- Exchange Web Services (EWS) availability provider definition. The
request must contain exactly one provider definition, either
EwsProvider
or LambdaProvider
.
CreateAvailabilityConfiguration
, createAvailabilityConfiguration_lambdaProvider
- Lambda availability provider definition. The request must contain
exactly one provider definition, either EwsProvider
or
LambdaProvider
.
CreateAvailabilityConfiguration
, createAvailabilityConfiguration_organizationId
- The WorkMail organization for which the AvailabilityConfiguration
will
be created.
CreateAvailabilityConfiguration
, createAvailabilityConfiguration_domainName
- The domain to which the provider applies.
data CreateAvailabilityConfigurationResponse Source #
See: newCreateAvailabilityConfigurationResponse
smart constructor.
Constructors
CreateAvailabilityConfigurationResponse' Int |
Instances
newCreateAvailabilityConfigurationResponse Source #
Arguments
:: Int | |
-> CreateAvailabilityConfigurationResponse |
Create a value of CreateAvailabilityConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateAvailabilityConfigurationResponse'
, createAvailabilityConfigurationResponse_httpStatus
- The response's http status code.
CreateGroup
data CreateGroup Source #
See: newCreateGroup
smart constructor.
Constructors
CreateGroup' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> CreateGroup |
Create a value of CreateGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateGroup
, createGroup_organizationId
- The organization under which the group is to be created.
CreateGroup
, createGroup_name
- The name of the group.
data CreateGroupResponse Source #
See: newCreateGroupResponse
smart constructor.
Constructors
CreateGroupResponse' (Maybe Text) Int |
Instances
newCreateGroupResponse Source #
Arguments
:: Int | |
-> CreateGroupResponse |
Create a value of CreateGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupId:CreateGroupResponse'
, createGroupResponse_groupId
- The identifier of the group.
$sel:httpStatus:CreateGroupResponse'
, createGroupResponse_httpStatus
- The response's http status code.
CreateImpersonationRole
data CreateImpersonationRole Source #
See: newCreateImpersonationRole
smart constructor.
Constructors
CreateImpersonationRole' (Maybe Text) (Maybe Text) Text Text ImpersonationRoleType [ImpersonationRule] |
Instances
newCreateImpersonationRole Source #
Arguments
:: Text | |
-> Text | |
-> ImpersonationRoleType | |
-> CreateImpersonationRole |
Create a value of CreateImpersonationRole
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateImpersonationRole'
, createImpersonationRole_clientToken
- The idempotency token for the client request.
CreateImpersonationRole
, createImpersonationRole_description
- The description of the new impersonation role.
CreateImpersonationRole
, createImpersonationRole_organizationId
- The WorkMail organization to create the new impersonation role within.
CreateImpersonationRole
, createImpersonationRole_name
- The name of the new impersonation role.
CreateImpersonationRole
, createImpersonationRole_type
- The impersonation role's type. The available impersonation role types
are READ_ONLY
or FULL_ACCESS
.
$sel:rules:CreateImpersonationRole'
, createImpersonationRole_rules
- The list of rules for the impersonation role.
data CreateImpersonationRoleResponse Source #
See: newCreateImpersonationRoleResponse
smart constructor.
Constructors
CreateImpersonationRoleResponse' (Maybe Text) Int |
Instances
newCreateImpersonationRoleResponse Source #
Create a value of CreateImpersonationRoleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateImpersonationRoleResponse
, createImpersonationRoleResponse_impersonationRoleId
- The new impersonation role ID.
$sel:httpStatus:CreateImpersonationRoleResponse'
, createImpersonationRoleResponse_httpStatus
- The response's http status code.
CreateMobileDeviceAccessRule
data CreateMobileDeviceAccessRule Source #
See: newCreateMobileDeviceAccessRule
smart constructor.
Constructors
CreateMobileDeviceAccessRule' (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) Text Text MobileDeviceAccessRuleEffect |
Instances
newCreateMobileDeviceAccessRule Source #
Arguments
:: Text | |
-> Text | |
-> MobileDeviceAccessRuleEffect | |
-> CreateMobileDeviceAccessRule |
Create a value of CreateMobileDeviceAccessRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateMobileDeviceAccessRule'
, createMobileDeviceAccessRule_clientToken
- The idempotency token for the client request.
CreateMobileDeviceAccessRule
, createMobileDeviceAccessRule_description
- The rule description.
CreateMobileDeviceAccessRule
, createMobileDeviceAccessRule_deviceModels
- Device models that the rule will match.
CreateMobileDeviceAccessRule
, createMobileDeviceAccessRule_deviceOperatingSystems
- Device operating systems that the rule will match.
CreateMobileDeviceAccessRule
, createMobileDeviceAccessRule_deviceTypes
- Device types that the rule will match.
CreateMobileDeviceAccessRule
, createMobileDeviceAccessRule_deviceUserAgents
- Device user agents that the rule will match.
CreateMobileDeviceAccessRule
, createMobileDeviceAccessRule_notDeviceModels
- Device models that the rule will not match. All other device models
will match.
CreateMobileDeviceAccessRule
, createMobileDeviceAccessRule_notDeviceOperatingSystems
- Device operating systems that the rule will not match. All other
device operating systems will match.
CreateMobileDeviceAccessRule
, createMobileDeviceAccessRule_notDeviceTypes
- Device types that the rule will not match. All other device types
will match.
CreateMobileDeviceAccessRule
, createMobileDeviceAccessRule_notDeviceUserAgents
- Device user agents that the rule will not match. All other device
user agents will match.
CreateMobileDeviceAccessRule
, createMobileDeviceAccessRule_organizationId
- The WorkMail organization under which the rule will be created.
CreateMobileDeviceAccessRule
, createMobileDeviceAccessRule_name
- The rule name.
CreateMobileDeviceAccessRule
, createMobileDeviceAccessRule_effect
- The effect of the rule when it matches. Allowed values are ALLOW
or
DENY
.
data CreateMobileDeviceAccessRuleResponse Source #
See: newCreateMobileDeviceAccessRuleResponse
smart constructor.
Constructors
CreateMobileDeviceAccessRuleResponse' (Maybe Text) Int |
Instances
newCreateMobileDeviceAccessRuleResponse Source #
Arguments
:: Int | |
-> CreateMobileDeviceAccessRuleResponse |
Create a value of CreateMobileDeviceAccessRuleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateMobileDeviceAccessRuleResponse
, createMobileDeviceAccessRuleResponse_mobileDeviceAccessRuleId
- The identifier for the newly created mobile device access rule.
$sel:httpStatus:CreateMobileDeviceAccessRuleResponse'
, createMobileDeviceAccessRuleResponse_httpStatus
- The response's http status code.
CreateOrganization
data CreateOrganization Source #
See: newCreateOrganization
smart constructor.
Constructors
CreateOrganization' (Maybe Text) (Maybe Text) (Maybe [Domain]) (Maybe Bool) (Maybe Text) Text |
Instances
newCreateOrganization Source #
Arguments
:: Text | |
-> CreateOrganization |
Create a value of CreateOrganization
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateOrganization'
, createOrganization_clientToken
- The idempotency token associated with the request.
$sel:directoryId:CreateOrganization'
, createOrganization_directoryId
- The AWS Directory Service directory ID.
$sel:domains:CreateOrganization'
, createOrganization_domains
- The email domains to associate with the organization.
$sel:enableInteroperability:CreateOrganization'
, createOrganization_enableInteroperability
- When true
, allows organization interoperability between WorkMail and
Microsoft Exchange. If true
, you must include a AD Connector directory
ID in the request.
$sel:kmsKeyArn:CreateOrganization'
, createOrganization_kmsKeyArn
- The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.
CreateOrganization
, createOrganization_alias
- The organization alias.
data CreateOrganizationResponse Source #
See: newCreateOrganizationResponse
smart constructor.
Constructors
CreateOrganizationResponse' (Maybe Text) Int |
Instances
newCreateOrganizationResponse Source #
Create a value of CreateOrganizationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateOrganizationResponse
, createOrganizationResponse_organizationId
- The organization ID.
$sel:httpStatus:CreateOrganizationResponse'
, createOrganizationResponse_httpStatus
- The response's http status code.
CreateResource
data CreateResource Source #
See: newCreateResource
smart constructor.
Constructors
CreateResource' Text Text ResourceType |
Instances
Arguments
:: Text | |
-> Text | |
-> ResourceType | |
-> CreateResource |
Create a value of CreateResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateResource
, createResource_organizationId
- The identifier associated with the organization for which the resource
is created.
CreateResource
, createResource_name
- The name of the new resource.
CreateResource
, createResource_type
- The type of the new resource. The available types are equipment
and
room
.
data CreateResourceResponse Source #
See: newCreateResourceResponse
smart constructor.
Constructors
CreateResourceResponse' (Maybe Text) Int |
Instances
newCreateResourceResponse Source #
Create a value of CreateResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceId:CreateResourceResponse'
, createResourceResponse_resourceId
- The identifier of the new resource.
$sel:httpStatus:CreateResourceResponse'
, createResourceResponse_httpStatus
- The response's http status code.
CreateUser
data CreateUser Source #
See: newCreateUser
smart constructor.
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> CreateUser |
Create a value of CreateUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateUser
, createUser_organizationId
- The identifier of the organization for which the user is created.
CreateUser
, createUser_name
- The name for the new user. WorkMail directory user names have a maximum
length of 64. All others have a maximum length of 20.
CreateUser
, createUser_displayName
- The display name for the new user.
$sel:password:CreateUser'
, createUser_password
- The password for the new user.
data CreateUserResponse Source #
See: newCreateUserResponse
smart constructor.
Constructors
CreateUserResponse' (Maybe Text) Int |
Instances
newCreateUserResponse Source #
Arguments
:: Int | |
-> CreateUserResponse |
Create a value of CreateUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateUserResponse
, createUserResponse_userId
- The identifier for the new user.
$sel:httpStatus:CreateUserResponse'
, createUserResponse_httpStatus
- The response's http status code.
DeleteAccessControlRule
data DeleteAccessControlRule Source #
See: newDeleteAccessControlRule
smart constructor.
Constructors
DeleteAccessControlRule' Text Text |
Instances
newDeleteAccessControlRule Source #
Create a value of DeleteAccessControlRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteAccessControlRule
, deleteAccessControlRule_organizationId
- The identifier for the organization.
DeleteAccessControlRule
, deleteAccessControlRule_name
- The name of the access control rule.
data DeleteAccessControlRuleResponse Source #
See: newDeleteAccessControlRuleResponse
smart constructor.
Constructors
DeleteAccessControlRuleResponse' Int |
Instances
newDeleteAccessControlRuleResponse Source #
Create a value of DeleteAccessControlRuleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteAccessControlRuleResponse'
, deleteAccessControlRuleResponse_httpStatus
- The response's http status code.
DeleteAlias
data DeleteAlias Source #
See: newDeleteAlias
smart constructor.
Constructors
DeleteAlias' Text Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> DeleteAlias |
Create a value of DeleteAlias
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteAlias
, deleteAlias_organizationId
- The identifier for the organization under which the user exists.
DeleteAlias
, deleteAlias_entityId
- The identifier for the member (user or group) from which to have the
aliases removed.
DeleteAlias
, deleteAlias_alias
- The aliases to be removed from the user's set of aliases. Duplicate
entries in the list are collapsed into single entries (the list is
transformed into a set).
data DeleteAliasResponse Source #
See: newDeleteAliasResponse
smart constructor.
Constructors
DeleteAliasResponse' Int |
Instances
newDeleteAliasResponse Source #
Arguments
:: Int | |
-> DeleteAliasResponse |
Create a value of DeleteAliasResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteAliasResponse'
, deleteAliasResponse_httpStatus
- The response's http status code.
DeleteAvailabilityConfiguration
data DeleteAvailabilityConfiguration Source #
See: newDeleteAvailabilityConfiguration
smart constructor.
Constructors
DeleteAvailabilityConfiguration' Text Text |
Instances
newDeleteAvailabilityConfiguration Source #
Arguments
:: Text | |
-> Text | |
-> DeleteAvailabilityConfiguration |
Create a value of DeleteAvailabilityConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteAvailabilityConfiguration
, deleteAvailabilityConfiguration_organizationId
- The WorkMail organization for which the AvailabilityConfiguration
will
be deleted.
DeleteAvailabilityConfiguration
, deleteAvailabilityConfiguration_domainName
- The domain for which the AvailabilityConfiguration
will be deleted.
data DeleteAvailabilityConfigurationResponse Source #
See: newDeleteAvailabilityConfigurationResponse
smart constructor.
Constructors
DeleteAvailabilityConfigurationResponse' Int |
Instances
newDeleteAvailabilityConfigurationResponse Source #
Arguments
:: Int | |
-> DeleteAvailabilityConfigurationResponse |
Create a value of DeleteAvailabilityConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteAvailabilityConfigurationResponse'
, deleteAvailabilityConfigurationResponse_httpStatus
- The response's http status code.
DeleteEmailMonitoringConfiguration
data DeleteEmailMonitoringConfiguration Source #
See: newDeleteEmailMonitoringConfiguration
smart constructor.
Constructors
DeleteEmailMonitoringConfiguration' Text |
Instances
newDeleteEmailMonitoringConfiguration Source #
Create a value of DeleteEmailMonitoringConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteEmailMonitoringConfiguration
, deleteEmailMonitoringConfiguration_organizationId
- The ID of the organization from which the email monitoring configuration
is deleted.
data DeleteEmailMonitoringConfigurationResponse Source #
See: newDeleteEmailMonitoringConfigurationResponse
smart constructor.
Constructors
DeleteEmailMonitoringConfigurationResponse' Int |
Instances
newDeleteEmailMonitoringConfigurationResponse Source #
Arguments
:: Int | |
-> DeleteEmailMonitoringConfigurationResponse |
Create a value of DeleteEmailMonitoringConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteEmailMonitoringConfigurationResponse'
, deleteEmailMonitoringConfigurationResponse_httpStatus
- The response's http status code.
DeleteGroup
data DeleteGroup Source #
See: newDeleteGroup
smart constructor.
Constructors
DeleteGroup' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> DeleteGroup |
Create a value of DeleteGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteGroup
, deleteGroup_organizationId
- The organization that contains the group.
$sel:groupId:DeleteGroup'
, deleteGroup_groupId
- The identifier of the group to be deleted.
data DeleteGroupResponse Source #
See: newDeleteGroupResponse
smart constructor.
Constructors
DeleteGroupResponse' Int |
Instances
newDeleteGroupResponse Source #
Arguments
:: Int | |
-> DeleteGroupResponse |
Create a value of DeleteGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteGroupResponse'
, deleteGroupResponse_httpStatus
- The response's http status code.
DeleteImpersonationRole
data DeleteImpersonationRole Source #
See: newDeleteImpersonationRole
smart constructor.
Constructors
DeleteImpersonationRole' Text Text |
Instances
newDeleteImpersonationRole Source #
Create a value of DeleteImpersonationRole
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteImpersonationRole
, deleteImpersonationRole_organizationId
- The WorkMail organization from which to delete the impersonation role.
DeleteImpersonationRole
, deleteImpersonationRole_impersonationRoleId
- The ID of the impersonation role to delete.
data DeleteImpersonationRoleResponse Source #
See: newDeleteImpersonationRoleResponse
smart constructor.
Constructors
DeleteImpersonationRoleResponse' Int |
Instances
newDeleteImpersonationRoleResponse Source #
Create a value of DeleteImpersonationRoleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteImpersonationRoleResponse'
, deleteImpersonationRoleResponse_httpStatus
- The response's http status code.
DeleteMailboxPermissions
data DeleteMailboxPermissions Source #
See: newDeleteMailboxPermissions
smart constructor.
Constructors
DeleteMailboxPermissions' Text Text Text |
Instances
newDeleteMailboxPermissions Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> DeleteMailboxPermissions |
Create a value of DeleteMailboxPermissions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteMailboxPermissions
, deleteMailboxPermissions_organizationId
- The identifier of the organization under which the member (user or
group) exists.
DeleteMailboxPermissions
, deleteMailboxPermissions_entityId
- The identifier of the member (user or group) that owns the mailbox.
DeleteMailboxPermissions
, deleteMailboxPermissions_granteeId
- The identifier of the member (user or group) for which to delete granted
permissions.
data DeleteMailboxPermissionsResponse Source #
See: newDeleteMailboxPermissionsResponse
smart constructor.
Constructors
DeleteMailboxPermissionsResponse' Int |
Instances
newDeleteMailboxPermissionsResponse Source #
Create a value of DeleteMailboxPermissionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteMailboxPermissionsResponse'
, deleteMailboxPermissionsResponse_httpStatus
- The response's http status code.
DeleteMobileDeviceAccessOverride
data DeleteMobileDeviceAccessOverride Source #
See: newDeleteMobileDeviceAccessOverride
smart constructor.
Constructors
DeleteMobileDeviceAccessOverride' Text Text Text |
Instances
newDeleteMobileDeviceAccessOverride Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> DeleteMobileDeviceAccessOverride |
Create a value of DeleteMobileDeviceAccessOverride
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteMobileDeviceAccessOverride
, deleteMobileDeviceAccessOverride_organizationId
- The WorkMail organization for which the access override will be deleted.
DeleteMobileDeviceAccessOverride
, deleteMobileDeviceAccessOverride_userId
- The WorkMail user for which you want to delete the override. Accepts the
following types of user identities:
- User ID:
12345678-1234-1234-1234-123456789012
orS-1-1-12-1234567890-123456789-123456789-1234
- Email address:
user@domain.tld
- User name:
user
DeleteMobileDeviceAccessOverride
, deleteMobileDeviceAccessOverride_deviceId
- The mobile device for which you delete the override. DeviceId
is case
insensitive.
data DeleteMobileDeviceAccessOverrideResponse Source #
See: newDeleteMobileDeviceAccessOverrideResponse
smart constructor.
Constructors
DeleteMobileDeviceAccessOverrideResponse' Int |
Instances
newDeleteMobileDeviceAccessOverrideResponse Source #
Arguments
:: Int | |
-> DeleteMobileDeviceAccessOverrideResponse |
Create a value of DeleteMobileDeviceAccessOverrideResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteMobileDeviceAccessOverrideResponse'
, deleteMobileDeviceAccessOverrideResponse_httpStatus
- The response's http status code.
DeleteMobileDeviceAccessRule
data DeleteMobileDeviceAccessRule Source #
See: newDeleteMobileDeviceAccessRule
smart constructor.
Constructors
DeleteMobileDeviceAccessRule' Text Text |
Instances
newDeleteMobileDeviceAccessRule Source #
Arguments
:: Text | |
-> Text | |
-> DeleteMobileDeviceAccessRule |
Create a value of DeleteMobileDeviceAccessRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteMobileDeviceAccessRule
, deleteMobileDeviceAccessRule_organizationId
- The WorkMail organization under which the rule will be deleted.
DeleteMobileDeviceAccessRule
, deleteMobileDeviceAccessRule_mobileDeviceAccessRuleId
- The identifier of the rule to be deleted.
data DeleteMobileDeviceAccessRuleResponse Source #
See: newDeleteMobileDeviceAccessRuleResponse
smart constructor.
Constructors
DeleteMobileDeviceAccessRuleResponse' Int |
Instances
newDeleteMobileDeviceAccessRuleResponse Source #
Arguments
:: Int | |
-> DeleteMobileDeviceAccessRuleResponse |
Create a value of DeleteMobileDeviceAccessRuleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteMobileDeviceAccessRuleResponse'
, deleteMobileDeviceAccessRuleResponse_httpStatus
- The response's http status code.
DeleteOrganization
data DeleteOrganization Source #
See: newDeleteOrganization
smart constructor.
Constructors
DeleteOrganization' (Maybe Text) Text Bool |
Instances
newDeleteOrganization Source #
Arguments
:: Text | |
-> Bool | |
-> DeleteOrganization |
Create a value of DeleteOrganization
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeleteOrganization'
, deleteOrganization_clientToken
- The idempotency token associated with the request.
DeleteOrganization
, deleteOrganization_organizationId
- The organization ID.
$sel:deleteDirectory:DeleteOrganization'
, deleteOrganization_deleteDirectory
- If true, deletes the AWS Directory Service directory associated with the
organization.
data DeleteOrganizationResponse Source #
See: newDeleteOrganizationResponse
smart constructor.
Instances
newDeleteOrganizationResponse Source #
Create a value of DeleteOrganizationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteOrganization
, deleteOrganizationResponse_organizationId
- The organization ID.
DeleteOrganizationResponse
, deleteOrganizationResponse_state
- The state of the organization.
$sel:httpStatus:DeleteOrganizationResponse'
, deleteOrganizationResponse_httpStatus
- The response's http status code.
DeleteResource
data DeleteResource Source #
See: newDeleteResource
smart constructor.
Constructors
DeleteResource' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> DeleteResource |
Create a value of DeleteResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteResource
, deleteResource_organizationId
- The identifier associated with the organization from which the resource
is deleted.
$sel:resourceId:DeleteResource'
, deleteResource_resourceId
- The identifier of the resource to be deleted.
data DeleteResourceResponse Source #
See: newDeleteResourceResponse
smart constructor.
Constructors
DeleteResourceResponse' Int |
Instances
newDeleteResourceResponse Source #
Create a value of DeleteResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteResourceResponse'
, deleteResourceResponse_httpStatus
- The response's http status code.
DeleteRetentionPolicy
data DeleteRetentionPolicy Source #
See: newDeleteRetentionPolicy
smart constructor.
Constructors
DeleteRetentionPolicy' Text Text |
Instances
newDeleteRetentionPolicy Source #
Arguments
:: Text | |
-> Text | |
-> DeleteRetentionPolicy |
Create a value of DeleteRetentionPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteRetentionPolicy
, deleteRetentionPolicy_organizationId
- The organization ID.
DeleteRetentionPolicy
, deleteRetentionPolicy_id
- The retention policy ID.
data DeleteRetentionPolicyResponse Source #
See: newDeleteRetentionPolicyResponse
smart constructor.
Constructors
DeleteRetentionPolicyResponse' Int |
Instances
newDeleteRetentionPolicyResponse Source #
Create a value of DeleteRetentionPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteRetentionPolicyResponse'
, deleteRetentionPolicyResponse_httpStatus
- The response's http status code.
DeleteUser
data DeleteUser Source #
See: newDeleteUser
smart constructor.
Constructors
DeleteUser' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> DeleteUser |
Create a value of DeleteUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteUser
, deleteUser_organizationId
- The organization that contains the user to be deleted.
DeleteUser
, deleteUser_userId
- The identifier of the user to be deleted.
data DeleteUserResponse Source #
See: newDeleteUserResponse
smart constructor.
Constructors
DeleteUserResponse' Int |
Instances
newDeleteUserResponse Source #
Arguments
:: Int | |
-> DeleteUserResponse |
Create a value of DeleteUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteUserResponse'
, deleteUserResponse_httpStatus
- The response's http status code.
DeregisterFromWorkMail
data DeregisterFromWorkMail Source #
See: newDeregisterFromWorkMail
smart constructor.
Constructors
DeregisterFromWorkMail' Text Text |
Instances
newDeregisterFromWorkMail Source #
Create a value of DeregisterFromWorkMail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeregisterFromWorkMail
, deregisterFromWorkMail_organizationId
- The identifier for the organization under which the WorkMail entity
exists.
DeregisterFromWorkMail
, deregisterFromWorkMail_entityId
- The identifier for the member (user or group) to be updated.
data DeregisterFromWorkMailResponse Source #
See: newDeregisterFromWorkMailResponse
smart constructor.
Constructors
DeregisterFromWorkMailResponse' Int |
Instances
newDeregisterFromWorkMailResponse Source #
Create a value of DeregisterFromWorkMailResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeregisterFromWorkMailResponse'
, deregisterFromWorkMailResponse_httpStatus
- The response's http status code.
DeregisterMailDomain
data DeregisterMailDomain Source #
See: newDeregisterMailDomain
smart constructor.
Constructors
DeregisterMailDomain' Text Text |
Instances
newDeregisterMailDomain Source #
Arguments
:: Text | |
-> Text | |
-> DeregisterMailDomain |
Create a value of DeregisterMailDomain
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeregisterMailDomain
, deregisterMailDomain_organizationId
- The WorkMail organization for which the domain will be deregistered.
DeregisterMailDomain
, deregisterMailDomain_domainName
- The domain to deregister in WorkMail and SES.
data DeregisterMailDomainResponse Source #
See: newDeregisterMailDomainResponse
smart constructor.
Constructors
DeregisterMailDomainResponse' Int |
Instances
newDeregisterMailDomainResponse Source #
Create a value of DeregisterMailDomainResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeregisterMailDomainResponse'
, deregisterMailDomainResponse_httpStatus
- The response's http status code.
DescribeEmailMonitoringConfiguration
data DescribeEmailMonitoringConfiguration Source #
See: newDescribeEmailMonitoringConfiguration
smart constructor.
Constructors
DescribeEmailMonitoringConfiguration' Text |
Instances
newDescribeEmailMonitoringConfiguration Source #
Create a value of DescribeEmailMonitoringConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeEmailMonitoringConfiguration
, describeEmailMonitoringConfiguration_organizationId
- The ID of the organization for which the email monitoring configuration
is described.
data DescribeEmailMonitoringConfigurationResponse Source #
See: newDescribeEmailMonitoringConfigurationResponse
smart constructor.
Instances
newDescribeEmailMonitoringConfigurationResponse Source #
Arguments
:: Int |
|
-> DescribeEmailMonitoringConfigurationResponse |
Create a value of DescribeEmailMonitoringConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logGroupArn:DescribeEmailMonitoringConfigurationResponse'
, describeEmailMonitoringConfigurationResponse_logGroupArn
- The Amazon Resource Name (ARN) of the CloudWatch Log group associated
with the email monitoring configuration.
$sel:roleArn:DescribeEmailMonitoringConfigurationResponse'
, describeEmailMonitoringConfigurationResponse_roleArn
- The Amazon Resource Name (ARN) of the IAM Role associated with the email
monitoring configuration.
$sel:httpStatus:DescribeEmailMonitoringConfigurationResponse'
, describeEmailMonitoringConfigurationResponse_httpStatus
- The response's http status code.
DescribeGroup
data DescribeGroup Source #
See: newDescribeGroup
smart constructor.
Constructors
DescribeGroup' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> DescribeGroup |
Create a value of DescribeGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeGroup
, describeGroup_organizationId
- The identifier for the organization under which the group exists.
DescribeGroup
, describeGroup_groupId
- The identifier for the group to be described.
data DescribeGroupResponse Source #
See: newDescribeGroupResponse
smart constructor.
Constructors
DescribeGroupResponse' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe EntityState) Int |
Instances
newDescribeGroupResponse Source #
Create a value of DescribeGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeGroupResponse
, describeGroupResponse_disabledDate
- The date and time when a user was deregistered from WorkMail, in UNIX
epoch time format.
DescribeGroupResponse
, describeGroupResponse_email
- The email of the described group.
DescribeGroupResponse
, describeGroupResponse_enabledDate
- The date and time when a user was registered to WorkMail, in UNIX epoch
time format.
DescribeGroup
, describeGroupResponse_groupId
- The identifier of the described group.
DescribeGroupResponse
, describeGroupResponse_name
- The name of the described group.
DescribeGroupResponse
, describeGroupResponse_state
- The state of the user: enabled (registered to WorkMail) or disabled
(deregistered or never registered to WorkMail).
$sel:httpStatus:DescribeGroupResponse'
, describeGroupResponse_httpStatus
- The response's http status code.
DescribeInboundDmarcSettings
data DescribeInboundDmarcSettings Source #
See: newDescribeInboundDmarcSettings
smart constructor.
Constructors
DescribeInboundDmarcSettings' Text |
Instances
newDescribeInboundDmarcSettings Source #
Arguments
:: Text | |
-> DescribeInboundDmarcSettings |
Create a value of DescribeInboundDmarcSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeInboundDmarcSettings
, describeInboundDmarcSettings_organizationId
- Lists the ID of the given organization.
data DescribeInboundDmarcSettingsResponse Source #
See: newDescribeInboundDmarcSettingsResponse
smart constructor.
Constructors
DescribeInboundDmarcSettingsResponse' (Maybe Bool) Int |
Instances
newDescribeInboundDmarcSettingsResponse Source #
Arguments
:: Int | |
-> DescribeInboundDmarcSettingsResponse |
Create a value of DescribeInboundDmarcSettingsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enforced:DescribeInboundDmarcSettingsResponse'
, describeInboundDmarcSettingsResponse_enforced
- Lists the enforcement setting of the applied policy.
$sel:httpStatus:DescribeInboundDmarcSettingsResponse'
, describeInboundDmarcSettingsResponse_httpStatus
- The response's http status code.
DescribeMailboxExportJob
data DescribeMailboxExportJob Source #
See: newDescribeMailboxExportJob
smart constructor.
Constructors
DescribeMailboxExportJob' Text Text |
Instances
newDescribeMailboxExportJob Source #
Create a value of DescribeMailboxExportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeMailboxExportJob
, describeMailboxExportJob_jobId
- The mailbox export job ID.
DescribeMailboxExportJob
, describeMailboxExportJob_organizationId
- The organization ID.
data DescribeMailboxExportJobResponse Source #
See: newDescribeMailboxExportJobResponse
smart constructor.
Constructors
DescribeMailboxExportJobResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe MailboxExportJobState) Int |
Instances
newDescribeMailboxExportJobResponse Source #
Create a value of DescribeMailboxExportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeMailboxExportJobResponse
, describeMailboxExportJobResponse_description
- The mailbox export job description.
DescribeMailboxExportJobResponse
, describeMailboxExportJobResponse_endTime
- The mailbox export job end timestamp.
DescribeMailboxExportJobResponse
, describeMailboxExportJobResponse_entityId
- The identifier of the user or resource associated with the mailbox.
$sel:errorInfo:DescribeMailboxExportJobResponse'
, describeMailboxExportJobResponse_errorInfo
- Error information for failed mailbox export jobs.
DescribeMailboxExportJobResponse
, describeMailboxExportJobResponse_estimatedProgress
- The estimated progress of the mailbox export job, in percentage points.
$sel:kmsKeyArn:DescribeMailboxExportJobResponse'
, describeMailboxExportJobResponse_kmsKeyArn
- The Amazon Resource Name (ARN) of the symmetric AWS Key Management
Service (AWS KMS) key that encrypts the exported mailbox content.
$sel:roleArn:DescribeMailboxExportJobResponse'
, describeMailboxExportJobResponse_roleArn
- The ARN of the AWS Identity and Access Management (IAM) role that grants
write permission to the Amazon Simple Storage Service (Amazon S3)
bucket.
DescribeMailboxExportJobResponse
, describeMailboxExportJobResponse_s3BucketName
- The name of the S3 bucket.
DescribeMailboxExportJobResponse
, describeMailboxExportJobResponse_s3Path
- The path to the S3 bucket and file that the mailbox export job is
exporting to.
$sel:s3Prefix:DescribeMailboxExportJobResponse'
, describeMailboxExportJobResponse_s3Prefix
- The S3 bucket prefix.
DescribeMailboxExportJobResponse
, describeMailboxExportJobResponse_startTime
- The mailbox export job start timestamp.
DescribeMailboxExportJobResponse
, describeMailboxExportJobResponse_state
- The state of the mailbox export job.
$sel:httpStatus:DescribeMailboxExportJobResponse'
, describeMailboxExportJobResponse_httpStatus
- The response's http status code.
DescribeOrganization
data DescribeOrganization Source #
See: newDescribeOrganization
smart constructor.
Constructors
DescribeOrganization' Text |
Instances
newDescribeOrganization Source #
Arguments
:: Text | |
-> DescribeOrganization |
Create a value of DescribeOrganization
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeOrganization
, describeOrganization_organizationId
- The identifier for the organization to be described.
data DescribeOrganizationResponse Source #
See: newDescribeOrganizationResponse
smart constructor.
Constructors
DescribeOrganizationResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeOrganizationResponse Source #
Create a value of DescribeOrganizationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:DescribeOrganizationResponse'
, describeOrganizationResponse_arn
- The Amazon Resource Name (ARN) of the organization.
DescribeOrganizationResponse
, describeOrganizationResponse_alias
- The alias for an organization.
$sel:completedDate:DescribeOrganizationResponse'
, describeOrganizationResponse_completedDate
- The date at which the organization became usable in the WorkMail
context, in UNIX epoch time format.
DescribeOrganizationResponse
, describeOrganizationResponse_defaultMailDomain
- The default mail domain associated with the organization.
$sel:directoryId:DescribeOrganizationResponse'
, describeOrganizationResponse_directoryId
- The identifier for the directory associated with an WorkMail
organization.
$sel:directoryType:DescribeOrganizationResponse'
, describeOrganizationResponse_directoryType
- The type of directory associated with the WorkMail organization.
DescribeOrganizationResponse
, describeOrganizationResponse_errorMessage
- (Optional) The error message indicating if unexpected behavior was
encountered with regards to the organization.
DescribeOrganization
, describeOrganizationResponse_organizationId
- The identifier of an organization.
DescribeOrganizationResponse
, describeOrganizationResponse_state
- The state of an organization.
$sel:httpStatus:DescribeOrganizationResponse'
, describeOrganizationResponse_httpStatus
- The response's http status code.
DescribeResource
data DescribeResource Source #
See: newDescribeResource
smart constructor.
Constructors
DescribeResource' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> DescribeResource |
Create a value of DescribeResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeResource
, describeResource_organizationId
- The identifier associated with the organization for which the resource
is described.
DescribeResource
, describeResource_resourceId
- The identifier of the resource to be described.
data DescribeResourceResponse Source #
See: newDescribeResourceResponse
smart constructor.
Constructors
DescribeResourceResponse' (Maybe BookingOptions) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe EntityState) (Maybe ResourceType) Int |
Instances
newDescribeResourceResponse Source #
Create a value of DescribeResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bookingOptions:DescribeResourceResponse'
, describeResourceResponse_bookingOptions
- The booking options for the described resource.
DescribeResourceResponse
, describeResourceResponse_disabledDate
- The date and time when a resource was disabled from WorkMail, in UNIX
epoch time format.
DescribeResourceResponse
, describeResourceResponse_email
- The email of the described resource.
DescribeResourceResponse
, describeResourceResponse_enabledDate
- The date and time when a resource was enabled for WorkMail, in UNIX
epoch time format.
DescribeResourceResponse
, describeResourceResponse_name
- The name of the described resource.
DescribeResource
, describeResourceResponse_resourceId
- The identifier of the described resource.
DescribeResourceResponse
, describeResourceResponse_state
- The state of the resource: enabled (registered to WorkMail), disabled
(deregistered or never registered to WorkMail), or deleted.
DescribeResourceResponse
, describeResourceResponse_type
- The type of the described resource.
$sel:httpStatus:DescribeResourceResponse'
, describeResourceResponse_httpStatus
- The response's http status code.
DescribeUser
data DescribeUser Source #
See: newDescribeUser
smart constructor.
Constructors
DescribeUser' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> DescribeUser |
Create a value of DescribeUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeUser
, describeUser_organizationId
- The identifier for the organization under which the user exists.
DescribeUser
, describeUser_userId
- The identifier for the user to be described.
data DescribeUserResponse Source #
See: newDescribeUserResponse
smart constructor.
Constructors
DescribeUserResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe EntityState) (Maybe Text) (Maybe UserRole) Int |
Instances
newDescribeUserResponse Source #
Arguments
:: Int | |
-> DescribeUserResponse |
Create a value of DescribeUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeUserResponse
, describeUserResponse_disabledDate
- The date and time at which the user was disabled for WorkMail usage, in
UNIX epoch time format.
DescribeUserResponse
, describeUserResponse_displayName
- The display name of the user.
DescribeUserResponse
, describeUserResponse_email
- The email of the user.
DescribeUserResponse
, describeUserResponse_enabledDate
- The date and time at which the user was enabled for WorkMailusage, in
UNIX epoch time format.
DescribeUserResponse
, describeUserResponse_name
- The name for the user.
DescribeUserResponse
, describeUserResponse_state
- The state of a user: enabled (registered to WorkMail) or disabled
(deregistered or never registered to WorkMail).
DescribeUser
, describeUserResponse_userId
- The identifier for the described user.
DescribeUserResponse
, describeUserResponse_userRole
- In certain cases, other entities are modeled as users. If
interoperability is enabled, resources are imported into WorkMail as
users. Because different WorkMail organizations rely on different
directory types, administrators can distinguish between an unregistered
user (account is disabled and has a user role) and the directory
administrators. The values are USER, RESOURCE, and SYSTEM_USER.
$sel:httpStatus:DescribeUserResponse'
, describeUserResponse_httpStatus
- The response's http status code.
DisassociateDelegateFromResource
data DisassociateDelegateFromResource Source #
See: newDisassociateDelegateFromResource
smart constructor.
Constructors
DisassociateDelegateFromResource' Text Text Text |
Instances
newDisassociateDelegateFromResource Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> DisassociateDelegateFromResource |
Create a value of DisassociateDelegateFromResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateDelegateFromResource
, disassociateDelegateFromResource_organizationId
- The identifier for the organization under which the resource exists.
$sel:resourceId:DisassociateDelegateFromResource'
, disassociateDelegateFromResource_resourceId
- The identifier of the resource from which delegates' set members are
removed.
DisassociateDelegateFromResource
, disassociateDelegateFromResource_entityId
- The identifier for the member (user, group) to be removed from the
resource's delegates.
data DisassociateDelegateFromResourceResponse Source #
See: newDisassociateDelegateFromResourceResponse
smart constructor.
Constructors
DisassociateDelegateFromResourceResponse' Int |
Instances
newDisassociateDelegateFromResourceResponse Source #
Arguments
:: Int | |
-> DisassociateDelegateFromResourceResponse |
Create a value of DisassociateDelegateFromResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisassociateDelegateFromResourceResponse'
, disassociateDelegateFromResourceResponse_httpStatus
- The response's http status code.
DisassociateMemberFromGroup
data DisassociateMemberFromGroup Source #
See: newDisassociateMemberFromGroup
smart constructor.
Constructors
DisassociateMemberFromGroup' Text Text Text |
Instances
newDisassociateMemberFromGroup Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> DisassociateMemberFromGroup |
Create a value of DisassociateMemberFromGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateMemberFromGroup
, disassociateMemberFromGroup_organizationId
- The identifier for the organization under which the group exists.
$sel:groupId:DisassociateMemberFromGroup'
, disassociateMemberFromGroup_groupId
- The identifier for the group from which members are removed.
$sel:memberId:DisassociateMemberFromGroup'
, disassociateMemberFromGroup_memberId
- The identifier for the member to be removed to the group.
data DisassociateMemberFromGroupResponse Source #
See: newDisassociateMemberFromGroupResponse
smart constructor.
Constructors
DisassociateMemberFromGroupResponse' Int |
Instances
newDisassociateMemberFromGroupResponse Source #
Arguments
:: Int | |
-> DisassociateMemberFromGroupResponse |
Create a value of DisassociateMemberFromGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisassociateMemberFromGroupResponse'
, disassociateMemberFromGroupResponse_httpStatus
- The response's http status code.
GetAccessControlEffect
data GetAccessControlEffect Source #
See: newGetAccessControlEffect
smart constructor.
Instances
newGetAccessControlEffect Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> GetAccessControlEffect |
Create a value of GetAccessControlEffect
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetAccessControlEffect
, getAccessControlEffect_impersonationRoleId
- The impersonation role ID.
GetAccessControlEffect
, getAccessControlEffect_userId
- The user ID.
GetAccessControlEffect
, getAccessControlEffect_organizationId
- The identifier for the organization.
$sel:ipAddress:GetAccessControlEffect'
, getAccessControlEffect_ipAddress
- The IPv4 address.
GetAccessControlEffect
, getAccessControlEffect_action
- The access protocol action. Valid values include ActiveSync
,
AutoDiscover
, EWS
, IMAP
, SMTP
, WindowsOutlook
, and WebMail
.
data GetAccessControlEffectResponse Source #
See: newGetAccessControlEffectResponse
smart constructor.
Constructors
GetAccessControlEffectResponse' (Maybe AccessControlRuleEffect) (Maybe [Text]) Int |
Instances
newGetAccessControlEffectResponse Source #
Create a value of GetAccessControlEffectResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetAccessControlEffectResponse
, getAccessControlEffectResponse_effect
- The rule effect.
$sel:matchedRules:GetAccessControlEffectResponse'
, getAccessControlEffectResponse_matchedRules
- The rules that match the given parameters, resulting in an effect.
$sel:httpStatus:GetAccessControlEffectResponse'
, getAccessControlEffectResponse_httpStatus
- The response's http status code.
GetDefaultRetentionPolicy
data GetDefaultRetentionPolicy Source #
See: newGetDefaultRetentionPolicy
smart constructor.
Constructors
GetDefaultRetentionPolicy' Text |
Instances
newGetDefaultRetentionPolicy Source #
Arguments
:: Text | |
-> GetDefaultRetentionPolicy |
Create a value of GetDefaultRetentionPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDefaultRetentionPolicy
, getDefaultRetentionPolicy_organizationId
- The organization ID.
data GetDefaultRetentionPolicyResponse Source #
See: newGetDefaultRetentionPolicyResponse
smart constructor.
Constructors
GetDefaultRetentionPolicyResponse' (Maybe Text) (Maybe [FolderConfiguration]) (Maybe Text) (Maybe Text) Int |
Instances
newGetDefaultRetentionPolicyResponse Source #
Arguments
:: Int | |
-> GetDefaultRetentionPolicyResponse |
Create a value of GetDefaultRetentionPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDefaultRetentionPolicyResponse
, getDefaultRetentionPolicyResponse_description
- The retention policy description.
$sel:folderConfigurations:GetDefaultRetentionPolicyResponse'
, getDefaultRetentionPolicyResponse_folderConfigurations
- The retention policy folder configurations.
GetDefaultRetentionPolicyResponse
, getDefaultRetentionPolicyResponse_id
- The retention policy ID.
GetDefaultRetentionPolicyResponse
, getDefaultRetentionPolicyResponse_name
- The retention policy name.
$sel:httpStatus:GetDefaultRetentionPolicyResponse'
, getDefaultRetentionPolicyResponse_httpStatus
- The response's http status code.
GetImpersonationRole
data GetImpersonationRole Source #
See: newGetImpersonationRole
smart constructor.
Constructors
GetImpersonationRole' Text Text |
Instances
newGetImpersonationRole Source #
Arguments
:: Text | |
-> Text | |
-> GetImpersonationRole |
Create a value of GetImpersonationRole
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetImpersonationRole
, getImpersonationRole_organizationId
- The WorkMail organization from which to retrieve the impersonation role.
GetImpersonationRole
, getImpersonationRole_impersonationRoleId
- The impersonation role ID to retrieve.
data GetImpersonationRoleResponse Source #
See: newGetImpersonationRoleResponse
smart constructor.
Constructors
GetImpersonationRoleResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ImpersonationRule]) (Maybe ImpersonationRoleType) Int |
Instances
newGetImpersonationRoleResponse Source #
Create a value of GetImpersonationRoleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetImpersonationRoleResponse
, getImpersonationRoleResponse_dateCreated
- The date when the impersonation role was created.
GetImpersonationRoleResponse
, getImpersonationRoleResponse_dateModified
- The date when the impersonation role was last modified.
GetImpersonationRoleResponse
, getImpersonationRoleResponse_description
- The impersonation role description.
GetImpersonationRole
, getImpersonationRoleResponse_impersonationRoleId
- The impersonation role ID.
GetImpersonationRoleResponse
, getImpersonationRoleResponse_name
- The impersonation role name.
$sel:rules:GetImpersonationRoleResponse'
, getImpersonationRoleResponse_rules
- The list of rules for the given impersonation role.
GetImpersonationRoleResponse
, getImpersonationRoleResponse_type
- The impersonation role type.
$sel:httpStatus:GetImpersonationRoleResponse'
, getImpersonationRoleResponse_httpStatus
- The response's http status code.
GetImpersonationRoleEffect
data GetImpersonationRoleEffect Source #
See: newGetImpersonationRoleEffect
smart constructor.
Constructors
GetImpersonationRoleEffect' Text Text Text |
Instances
newGetImpersonationRoleEffect Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> GetImpersonationRoleEffect |
Create a value of GetImpersonationRoleEffect
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetImpersonationRoleEffect
, getImpersonationRoleEffect_organizationId
- The WorkMail organization where the impersonation role is defined.
GetImpersonationRoleEffect
, getImpersonationRoleEffect_impersonationRoleId
- The impersonation role ID to test.
$sel:targetUser:GetImpersonationRoleEffect'
, getImpersonationRoleEffect_targetUser
- The WorkMail organization user chosen to test the impersonation role.
The following identity formats are available:
- User ID:
12345678-1234-1234-1234-123456789012
orS-1-1-12-1234567890-123456789-123456789-1234
- Email address:
user@domain.tld
- User name:
user
data GetImpersonationRoleEffectResponse Source #
See: newGetImpersonationRoleEffectResponse
smart constructor.
Constructors
GetImpersonationRoleEffectResponse' (Maybe AccessEffect) (Maybe [ImpersonationMatchedRule]) (Maybe ImpersonationRoleType) Int |
Instances
newGetImpersonationRoleEffectResponse Source #
Arguments
:: Int | |
-> GetImpersonationRoleEffectResponse |
Create a value of GetImpersonationRoleEffectResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetImpersonationRoleEffectResponse
, getImpersonationRoleEffectResponse_effect
- Effect of the impersonation role on the target user based on its rules.
Available effects are ALLOW
or DENY
.
$sel:matchedRules:GetImpersonationRoleEffectResponse'
, getImpersonationRoleEffectResponse_matchedRules
- A list of the rules that match the input and produce the configured
effect.
GetImpersonationRoleEffectResponse
, getImpersonationRoleEffectResponse_type
- The impersonation role type.
$sel:httpStatus:GetImpersonationRoleEffectResponse'
, getImpersonationRoleEffectResponse_httpStatus
- The response's http status code.
GetMailDomain
data GetMailDomain Source #
See: newGetMailDomain
smart constructor.
Constructors
GetMailDomain' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> GetMailDomain |
Create a value of GetMailDomain
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetMailDomain
, getMailDomain_organizationId
- The WorkMail organization for which the domain is retrieved.
GetMailDomain
, getMailDomain_domainName
- The domain from which you want to retrieve details.
data GetMailDomainResponse Source #
See: newGetMailDomainResponse
smart constructor.
Constructors
GetMailDomainResponse' (Maybe DnsRecordVerificationStatus) (Maybe Bool) (Maybe Bool) (Maybe DnsRecordVerificationStatus) (Maybe [DnsRecord]) Int |
Instances
newGetMailDomainResponse Source #
Create a value of GetMailDomainResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dkimVerificationStatus:GetMailDomainResponse'
, getMailDomainResponse_dkimVerificationStatus
- Indicates the status of a DKIM verification.
$sel:isDefault:GetMailDomainResponse'
, getMailDomainResponse_isDefault
- Specifies whether the domain is the default domain for your
organization.
$sel:isTestDomain:GetMailDomainResponse'
, getMailDomainResponse_isTestDomain
- Specifies whether the domain is a test domain provided by WorkMail, or a
custom domain.
$sel:ownershipVerificationStatus:GetMailDomainResponse'
, getMailDomainResponse_ownershipVerificationStatus
- Indicates the status of the domain ownership verification.
$sel:records:GetMailDomainResponse'
, getMailDomainResponse_records
- A list of the DNS records that WorkMail recommends adding in your DNS
provider for the best user experience. The records configure your domain
with DMARC, SPF, DKIM, and direct incoming email traffic to SES. See
admin guide for more details.
$sel:httpStatus:GetMailDomainResponse'
, getMailDomainResponse_httpStatus
- The response's http status code.
GetMailboxDetails
data GetMailboxDetails Source #
See: newGetMailboxDetails
smart constructor.
Constructors
GetMailboxDetails' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> GetMailboxDetails |
Create a value of GetMailboxDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetMailboxDetails
, getMailboxDetails_organizationId
- The identifier for the organization that contains the user whose mailbox
details are being requested.
GetMailboxDetails
, getMailboxDetails_userId
- The identifier for the user whose mailbox details are being requested.
data GetMailboxDetailsResponse Source #
See: newGetMailboxDetailsResponse
smart constructor.
Instances
newGetMailboxDetailsResponse Source #
Create a value of GetMailboxDetailsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mailboxQuota:GetMailboxDetailsResponse'
, getMailboxDetailsResponse_mailboxQuota
- The maximum allowed mailbox size, in MB, for the specified user.
$sel:mailboxSize:GetMailboxDetailsResponse'
, getMailboxDetailsResponse_mailboxSize
- The current mailbox size, in MB, for the specified user.
$sel:httpStatus:GetMailboxDetailsResponse'
, getMailboxDetailsResponse_httpStatus
- The response's http status code.
GetMobileDeviceAccessEffect
data GetMobileDeviceAccessEffect Source #
See: newGetMobileDeviceAccessEffect
smart constructor.
Instances
newGetMobileDeviceAccessEffect Source #
Arguments
:: Text | |
-> GetMobileDeviceAccessEffect |
Create a value of GetMobileDeviceAccessEffect
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceModel:GetMobileDeviceAccessEffect'
, getMobileDeviceAccessEffect_deviceModel
- Device model the simulated user will report.
$sel:deviceOperatingSystem:GetMobileDeviceAccessEffect'
, getMobileDeviceAccessEffect_deviceOperatingSystem
- Device operating system the simulated user will report.
$sel:deviceType:GetMobileDeviceAccessEffect'
, getMobileDeviceAccessEffect_deviceType
- Device type the simulated user will report.
$sel:deviceUserAgent:GetMobileDeviceAccessEffect'
, getMobileDeviceAccessEffect_deviceUserAgent
- Device user agent the simulated user will report.
GetMobileDeviceAccessEffect
, getMobileDeviceAccessEffect_organizationId
- The WorkMail organization to simulate the access effect for.
data GetMobileDeviceAccessEffectResponse Source #
See: newGetMobileDeviceAccessEffectResponse
smart constructor.
Constructors
GetMobileDeviceAccessEffectResponse' (Maybe MobileDeviceAccessRuleEffect) (Maybe [MobileDeviceAccessMatchedRule]) Int |
Instances
newGetMobileDeviceAccessEffectResponse Source #
Arguments
:: Int | |
-> GetMobileDeviceAccessEffectResponse |
Create a value of GetMobileDeviceAccessEffectResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetMobileDeviceAccessEffectResponse
, getMobileDeviceAccessEffectResponse_effect
- The effect of the simulated access, ALLOW
or DENY
, after evaluating
mobile device access rules in the WorkMail organization for the
simulated user parameters.
$sel:matchedRules:GetMobileDeviceAccessEffectResponse'
, getMobileDeviceAccessEffectResponse_matchedRules
- A list of the rules which matched the simulated user input and produced
the effect.
$sel:httpStatus:GetMobileDeviceAccessEffectResponse'
, getMobileDeviceAccessEffectResponse_httpStatus
- The response's http status code.
GetMobileDeviceAccessOverride
data GetMobileDeviceAccessOverride Source #
See: newGetMobileDeviceAccessOverride
smart constructor.
Constructors
GetMobileDeviceAccessOverride' Text Text Text |
Instances
newGetMobileDeviceAccessOverride Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> GetMobileDeviceAccessOverride |
Create a value of GetMobileDeviceAccessOverride
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetMobileDeviceAccessOverride
, getMobileDeviceAccessOverride_organizationId
- The WorkMail organization to which you want to apply the override.
GetMobileDeviceAccessOverride
, getMobileDeviceAccessOverride_userId
- Identifies the WorkMail user for the override. Accepts the following
types of user identities:
- User ID:
12345678-1234-1234-1234-123456789012
orS-1-1-12-1234567890-123456789-123456789-1234
- Email address:
user@domain.tld
- User name:
user
GetMobileDeviceAccessOverride
, getMobileDeviceAccessOverride_deviceId
- The mobile device to which the override applies. DeviceId
is case
insensitive.
data GetMobileDeviceAccessOverrideResponse Source #
See: newGetMobileDeviceAccessOverrideResponse
smart constructor.
Constructors
GetMobileDeviceAccessOverrideResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe MobileDeviceAccessRuleEffect) (Maybe Text) Int |
Instances
newGetMobileDeviceAccessOverrideResponse Source #
Arguments
:: Int | |
-> GetMobileDeviceAccessOverrideResponse |
Create a value of GetMobileDeviceAccessOverrideResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetMobileDeviceAccessOverrideResponse
, getMobileDeviceAccessOverrideResponse_dateCreated
- The date the override was first created.
GetMobileDeviceAccessOverrideResponse
, getMobileDeviceAccessOverrideResponse_dateModified
- The date the description was last modified.
GetMobileDeviceAccessOverrideResponse
, getMobileDeviceAccessOverrideResponse_description
- A description of the override.
GetMobileDeviceAccessOverride
, getMobileDeviceAccessOverrideResponse_deviceId
- The device to which the access override applies.
GetMobileDeviceAccessOverrideResponse
, getMobileDeviceAccessOverrideResponse_effect
- The effect of the override, ALLOW
or DENY
.
GetMobileDeviceAccessOverride
, getMobileDeviceAccessOverrideResponse_userId
- The WorkMail user to which the access override applies.
$sel:httpStatus:GetMobileDeviceAccessOverrideResponse'
, getMobileDeviceAccessOverrideResponse_httpStatus
- The response's http status code.
ListAccessControlRules
data ListAccessControlRules Source #
See: newListAccessControlRules
smart constructor.
Constructors
ListAccessControlRules' Text |
Instances
newListAccessControlRules Source #
Arguments
:: Text | |
-> ListAccessControlRules |
Create a value of ListAccessControlRules
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListAccessControlRules
, listAccessControlRules_organizationId
- The identifier for the organization.
data ListAccessControlRulesResponse Source #
See: newListAccessControlRulesResponse
smart constructor.
Constructors
ListAccessControlRulesResponse' (Maybe [AccessControlRule]) Int |
Instances
newListAccessControlRulesResponse Source #
Create a value of ListAccessControlRulesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rules:ListAccessControlRulesResponse'
, listAccessControlRulesResponse_rules
- The access control rules.
$sel:httpStatus:ListAccessControlRulesResponse'
, listAccessControlRulesResponse_httpStatus
- The response's http status code.
ListAliases (Paginated)
data ListAliases Source #
See: newListAliases
smart constructor.
Instances
Arguments
:: Text | |
-> Text | |
-> ListAliases |
Create a value of ListAliases
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListAliases'
, listAliases_maxResults
- The maximum number of results to return in a single call.
ListAliases
, listAliases_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
ListAliases
, listAliases_organizationId
- The identifier for the organization under which the entity exists.
ListAliases
, listAliases_entityId
- The identifier for the entity for which to list the aliases.
data ListAliasesResponse Source #
See: newListAliasesResponse
smart constructor.
Instances
newListAliasesResponse Source #
Arguments
:: Int | |
-> ListAliasesResponse |
Create a value of ListAliasesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aliases:ListAliasesResponse'
, listAliasesResponse_aliases
- The entity's paginated aliases.
ListAliases
, listAliasesResponse_nextToken
- The token to use to retrieve the next page of results. The value is
"null" when there are no more results to return.
$sel:httpStatus:ListAliasesResponse'
, listAliasesResponse_httpStatus
- The response's http status code.
ListAvailabilityConfigurations (Paginated)
data ListAvailabilityConfigurations Source #
See: newListAvailabilityConfigurations
smart constructor.
Instances
newListAvailabilityConfigurations Source #
Create a value of ListAvailabilityConfigurations
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListAvailabilityConfigurations'
, listAvailabilityConfigurations_maxResults
- The maximum number of results to return in a single call.
ListAvailabilityConfigurations
, listAvailabilityConfigurations_nextToken
- The token to use to retrieve the next page of results. The first call
does not require a token.
ListAvailabilityConfigurations
, listAvailabilityConfigurations_organizationId
- The WorkMail organization for which the AvailabilityConfiguration
's
will be listed.
data ListAvailabilityConfigurationsResponse Source #
See: newListAvailabilityConfigurationsResponse
smart constructor.
Constructors
ListAvailabilityConfigurationsResponse' (Maybe [AvailabilityConfiguration]) (Maybe Text) Int |
Instances
newListAvailabilityConfigurationsResponse Source #
Arguments
:: Int | |
-> ListAvailabilityConfigurationsResponse |
Create a value of ListAvailabilityConfigurationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:availabilityConfigurations:ListAvailabilityConfigurationsResponse'
, listAvailabilityConfigurationsResponse_availabilityConfigurations
- The list of AvailabilityConfiguration
's that exist for the specified
WorkMail organization.
ListAvailabilityConfigurations
, listAvailabilityConfigurationsResponse_nextToken
- The token to use to retrieve the next page of results. The value is
null
when there are no further results to return.
$sel:httpStatus:ListAvailabilityConfigurationsResponse'
, listAvailabilityConfigurationsResponse_httpStatus
- The response's http status code.
ListGroupMembers (Paginated)
data ListGroupMembers Source #
See: newListGroupMembers
smart constructor.
Instances
Arguments
:: Text | |
-> Text | |
-> ListGroupMembers |
Create a value of ListGroupMembers
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListGroupMembers'
, listGroupMembers_maxResults
- The maximum number of results to return in a single call.
ListGroupMembers
, listGroupMembers_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
ListGroupMembers
, listGroupMembers_organizationId
- The identifier for the organization under which the group exists.
$sel:groupId:ListGroupMembers'
, listGroupMembers_groupId
- The identifier for the group to which the members (users or groups) are
associated.
data ListGroupMembersResponse Source #
See: newListGroupMembersResponse
smart constructor.
Instances
newListGroupMembersResponse Source #
Create a value of ListGroupMembersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:members:ListGroupMembersResponse'
, listGroupMembersResponse_members
- The members associated to the group.
ListGroupMembers
, listGroupMembersResponse_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
$sel:httpStatus:ListGroupMembersResponse'
, listGroupMembersResponse_httpStatus
- The response's http status code.
ListGroups (Paginated)
data ListGroups Source #
See: newListGroups
smart constructor.
Instances
Arguments
:: Text | |
-> ListGroups |
Create a value of ListGroups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListGroups'
, listGroups_maxResults
- The maximum number of results to return in a single call.
ListGroups
, listGroups_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
ListGroups
, listGroups_organizationId
- The identifier for the organization under which the groups exist.
data ListGroupsResponse Source #
See: newListGroupsResponse
smart constructor.
Instances
newListGroupsResponse Source #
Arguments
:: Int | |
-> ListGroupsResponse |
Create a value of ListGroupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groups:ListGroupsResponse'
, listGroupsResponse_groups
- The overview of groups for an organization.
ListGroups
, listGroupsResponse_nextToken
- The token to use to retrieve the next page of results. The value is
"null" when there are no more results to return.
$sel:httpStatus:ListGroupsResponse'
, listGroupsResponse_httpStatus
- The response's http status code.
ListImpersonationRoles
data ListImpersonationRoles Source #
See: newListImpersonationRoles
smart constructor.
Instances
newListImpersonationRoles Source #
Arguments
:: Text | |
-> ListImpersonationRoles |
Create a value of ListImpersonationRoles
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListImpersonationRoles'
, listImpersonationRoles_maxResults
- The maximum number of results returned in a single call.
ListImpersonationRoles
, listImpersonationRoles_nextToken
- The token used to retrieve the next page of results. The first call
doesn't require a token.
ListImpersonationRoles
, listImpersonationRoles_organizationId
- The WorkMail organization to which the listed impersonation roles
belong.
data ListImpersonationRolesResponse Source #
See: newListImpersonationRolesResponse
smart constructor.
Constructors
ListImpersonationRolesResponse' (Maybe Text) (Maybe [ImpersonationRole]) Int |
Instances
newListImpersonationRolesResponse Source #
Create a value of ListImpersonationRolesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListImpersonationRoles
, listImpersonationRolesResponse_nextToken
- The token to retrieve the next page of results. The value is null
when
there are no results to return.
$sel:roles:ListImpersonationRolesResponse'
, listImpersonationRolesResponse_roles
- The list of impersonation roles under the given WorkMail organization.
$sel:httpStatus:ListImpersonationRolesResponse'
, listImpersonationRolesResponse_httpStatus
- The response's http status code.
ListMailDomains
data ListMailDomains Source #
See: newListMailDomains
smart constructor.
Instances
Arguments
:: Text | |
-> ListMailDomains |
Create a value of ListMailDomains
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListMailDomains'
, listMailDomains_maxResults
- The maximum number of results to return in a single call.
ListMailDomains
, listMailDomains_nextToken
- The token to use to retrieve the next page of results. The first call
does not require a token.
ListMailDomains
, listMailDomains_organizationId
- The WorkMail organization for which to list domains.
data ListMailDomainsResponse Source #
See: newListMailDomainsResponse
smart constructor.
Constructors
ListMailDomainsResponse' (Maybe [MailDomainSummary]) (Maybe Text) Int |
Instances
newListMailDomainsResponse Source #
Create a value of ListMailDomainsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mailDomains:ListMailDomainsResponse'
, listMailDomainsResponse_mailDomains
- The list of mail domain summaries, specifying domains that exist in the
specified WorkMail organization, along with the information about
whether the domain is or isn't the default.
ListMailDomains
, listMailDomainsResponse_nextToken
- The token to use to retrieve the next page of results. The value becomes
null
when there are no more results to return.
$sel:httpStatus:ListMailDomainsResponse'
, listMailDomainsResponse_httpStatus
- The response's http status code.
ListMailboxExportJobs
data ListMailboxExportJobs Source #
See: newListMailboxExportJobs
smart constructor.
Instances
newListMailboxExportJobs Source #
Arguments
:: Text | |
-> ListMailboxExportJobs |
Create a value of ListMailboxExportJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListMailboxExportJobs'
, listMailboxExportJobs_maxResults
- The maximum number of results to return in a single call.
ListMailboxExportJobs
, listMailboxExportJobs_nextToken
- The token to use to retrieve the next page of results.
ListMailboxExportJobs
, listMailboxExportJobs_organizationId
- The organization ID.
data ListMailboxExportJobsResponse Source #
See: newListMailboxExportJobsResponse
smart constructor.
Constructors
ListMailboxExportJobsResponse' (Maybe [MailboxExportJob]) (Maybe Text) Int |
Instances
newListMailboxExportJobsResponse Source #
Create a value of ListMailboxExportJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobs:ListMailboxExportJobsResponse'
, listMailboxExportJobsResponse_jobs
- The mailbox export job details.
ListMailboxExportJobs
, listMailboxExportJobsResponse_nextToken
- The token to use to retrieve the next page of results.
$sel:httpStatus:ListMailboxExportJobsResponse'
, listMailboxExportJobsResponse_httpStatus
- The response's http status code.
ListMailboxPermissions (Paginated)
data ListMailboxPermissions Source #
See: newListMailboxPermissions
smart constructor.
Instances
newListMailboxPermissions Source #
Create a value of ListMailboxPermissions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListMailboxPermissions'
, listMailboxPermissions_maxResults
- The maximum number of results to return in a single call.
ListMailboxPermissions
, listMailboxPermissions_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
ListMailboxPermissions
, listMailboxPermissions_organizationId
- The identifier of the organization under which the user, group, or
resource exists.
ListMailboxPermissions
, listMailboxPermissions_entityId
- The identifier of the user, group, or resource for which to list mailbox
permissions.
data ListMailboxPermissionsResponse Source #
See: newListMailboxPermissionsResponse
smart constructor.
Constructors
ListMailboxPermissionsResponse' (Maybe Text) (Maybe [Permission]) Int |
Instances
newListMailboxPermissionsResponse Source #
Create a value of ListMailboxPermissionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListMailboxPermissions
, listMailboxPermissionsResponse_nextToken
- The token to use to retrieve the next page of results. The value is
"null" when there are no more results to return.
$sel:permissions:ListMailboxPermissionsResponse'
, listMailboxPermissionsResponse_permissions
- One page of the user, group, or resource mailbox permissions.
$sel:httpStatus:ListMailboxPermissionsResponse'
, listMailboxPermissionsResponse_httpStatus
- The response's http status code.
ListMobileDeviceAccessOverrides
data ListMobileDeviceAccessOverrides Source #
See: newListMobileDeviceAccessOverrides
smart constructor.
Constructors
ListMobileDeviceAccessOverrides' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) Text |
Instances
newListMobileDeviceAccessOverrides Source #
Create a value of ListMobileDeviceAccessOverrides
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListMobileDeviceAccessOverrides
, listMobileDeviceAccessOverrides_deviceId
- The mobile device to which the access override applies.
$sel:maxResults:ListMobileDeviceAccessOverrides'
, listMobileDeviceAccessOverrides_maxResults
- The maximum number of results to return in a single call.
ListMobileDeviceAccessOverrides
, listMobileDeviceAccessOverrides_nextToken
- The token to use to retrieve the next page of results. The first call
does not require a token.
ListMobileDeviceAccessOverrides
, listMobileDeviceAccessOverrides_userId
- The WorkMail user under which you list the mobile device access
overrides. Accepts the following types of user identities:
- User ID:
12345678-1234-1234-1234-123456789012
orS-1-1-12-1234567890-123456789-123456789-1234
- Email address:
user@domain.tld
- User name:
user
ListMobileDeviceAccessOverrides
, listMobileDeviceAccessOverrides_organizationId
- The WorkMail organization under which to list mobile device access
overrides.
data ListMobileDeviceAccessOverridesResponse Source #
See: newListMobileDeviceAccessOverridesResponse
smart constructor.
Constructors
ListMobileDeviceAccessOverridesResponse' (Maybe Text) (Maybe [MobileDeviceAccessOverride]) Int |
Instances
newListMobileDeviceAccessOverridesResponse Source #
Arguments
:: Int | |
-> ListMobileDeviceAccessOverridesResponse |
Create a value of ListMobileDeviceAccessOverridesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListMobileDeviceAccessOverrides
, listMobileDeviceAccessOverridesResponse_nextToken
- The token to use to retrieve the next page of results. The value is
“null” when there are no more results to return.
$sel:overrides:ListMobileDeviceAccessOverridesResponse'
, listMobileDeviceAccessOverridesResponse_overrides
- The list of mobile device access overrides that exist for the specified
WorkMail organization and user.
$sel:httpStatus:ListMobileDeviceAccessOverridesResponse'
, listMobileDeviceAccessOverridesResponse_httpStatus
- The response's http status code.
ListMobileDeviceAccessRules
data ListMobileDeviceAccessRules Source #
See: newListMobileDeviceAccessRules
smart constructor.
Constructors
ListMobileDeviceAccessRules' Text |
Instances
newListMobileDeviceAccessRules Source #
Arguments
:: Text | |
-> ListMobileDeviceAccessRules |
Create a value of ListMobileDeviceAccessRules
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListMobileDeviceAccessRules
, listMobileDeviceAccessRules_organizationId
- The WorkMail organization for which to list the rules.
data ListMobileDeviceAccessRulesResponse Source #
See: newListMobileDeviceAccessRulesResponse
smart constructor.
Constructors
ListMobileDeviceAccessRulesResponse' (Maybe [MobileDeviceAccessRule]) Int |
Instances
newListMobileDeviceAccessRulesResponse Source #
Arguments
:: Int | |
-> ListMobileDeviceAccessRulesResponse |
Create a value of ListMobileDeviceAccessRulesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rules:ListMobileDeviceAccessRulesResponse'
, listMobileDeviceAccessRulesResponse_rules
- The list of mobile device access rules that exist under the specified
WorkMail organization.
$sel:httpStatus:ListMobileDeviceAccessRulesResponse'
, listMobileDeviceAccessRulesResponse_httpStatus
- The response's http status code.
ListOrganizations (Paginated)
data ListOrganizations Source #
See: newListOrganizations
smart constructor.
Constructors
ListOrganizations' (Maybe Natural) (Maybe Text) |
Instances
newListOrganizations :: ListOrganizations Source #
Create a value of ListOrganizations
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListOrganizations'
, listOrganizations_maxResults
- The maximum number of results to return in a single call.
ListOrganizations
, listOrganizations_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
data ListOrganizationsResponse Source #
See: newListOrganizationsResponse
smart constructor.
Constructors
ListOrganizationsResponse' (Maybe Text) (Maybe [OrganizationSummary]) Int |
Instances
newListOrganizationsResponse Source #
Create a value of ListOrganizationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListOrganizations
, listOrganizationsResponse_nextToken
- The token to use to retrieve the next page of results. The value is
"null" when there are no more results to return.
$sel:organizationSummaries:ListOrganizationsResponse'
, listOrganizationsResponse_organizationSummaries
- The overview of owned organizations presented as a list of organization
summaries.
$sel:httpStatus:ListOrganizationsResponse'
, listOrganizationsResponse_httpStatus
- The response's http status code.
ListResourceDelegates (Paginated)
data ListResourceDelegates Source #
See: newListResourceDelegates
smart constructor.
Instances
newListResourceDelegates Source #
Arguments
:: Text | |
-> Text | |
-> ListResourceDelegates |
Create a value of ListResourceDelegates
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListResourceDelegates'
, listResourceDelegates_maxResults
- The number of maximum results in a page.
ListResourceDelegates
, listResourceDelegates_nextToken
- The token used to paginate through the delegates associated with a
resource.
ListResourceDelegates
, listResourceDelegates_organizationId
- The identifier for the organization that contains the resource for which
delegates are listed.
$sel:resourceId:ListResourceDelegates'
, listResourceDelegates_resourceId
- The identifier for the resource whose delegates are listed.
data ListResourceDelegatesResponse Source #
See: newListResourceDelegatesResponse
smart constructor.
Instances
newListResourceDelegatesResponse Source #
Create a value of ListResourceDelegatesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:delegates:ListResourceDelegatesResponse'
, listResourceDelegatesResponse_delegates
- One page of the resource's delegates.
ListResourceDelegates
, listResourceDelegatesResponse_nextToken
- The token used to paginate through the delegates associated with a
resource. While results are still available, it has an associated value.
When the last page is reached, the token is empty.
$sel:httpStatus:ListResourceDelegatesResponse'
, listResourceDelegatesResponse_httpStatus
- The response's http status code.
ListResources (Paginated)
data ListResources Source #
See: newListResources
smart constructor.
Instances
Arguments
:: Text | |
-> ListResources |
Create a value of ListResources
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListResources'
, listResources_maxResults
- The maximum number of results to return in a single call.
ListResources
, listResources_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
ListResources
, listResources_organizationId
- The identifier for the organization under which the resources exist.
data ListResourcesResponse Source #
See: newListResourcesResponse
smart constructor.
Instances
newListResourcesResponse Source #
Create a value of ListResourcesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListResources
, listResourcesResponse_nextToken
- The token used to paginate through all the organization's resources.
While results are still available, it has an associated value. When the
last page is reached, the token is empty.
$sel:resources:ListResourcesResponse'
, listResourcesResponse_resources
- One page of the organization's resource representation.
$sel:httpStatus:ListResourcesResponse'
, listResourcesResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Constructors
ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
:: Text | |
-> ListTagsForResource |
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:ListTagsForResource'
, listTagsForResource_resourceARN
- The resource ARN.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Constructors
ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- A list of tag key-value pairs.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListUsers (Paginated)
See: newListUsers
smart constructor.
Instances
Create a value of ListUsers
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListUsers'
, listUsers_maxResults
- The maximum number of results to return in a single call.
ListUsers
, listUsers_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
ListUsers
, listUsers_organizationId
- The identifier for the organization under which the users exist.
data ListUsersResponse Source #
See: newListUsersResponse
smart constructor.
Instances
Arguments
:: Int | |
-> ListUsersResponse |
Create a value of ListUsersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListUsers
, listUsersResponse_nextToken
- The token to use to retrieve the next page of results. This value is
`null` when there are no more results to return.
$sel:users:ListUsersResponse'
, listUsersResponse_users
- The overview of users for an organization.
$sel:httpStatus:ListUsersResponse'
, listUsersResponse_httpStatus
- The response's http status code.
PutAccessControlRule
data PutAccessControlRule Source #
See: newPutAccessControlRule
smart constructor.
Constructors
PutAccessControlRule' (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) Text AccessControlRuleEffect Text Text |
Instances
newPutAccessControlRule Source #
Arguments
:: Text | |
-> AccessControlRuleEffect | |
-> Text | |
-> Text | |
-> PutAccessControlRule |
Create a value of PutAccessControlRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutAccessControlRule
, putAccessControlRule_actions
- Access protocol actions to include in the rule. Valid values include
ActiveSync
, AutoDiscover
, EWS
, IMAP
, SMTP
, WindowsOutlook
,
and WebMail
.
PutAccessControlRule
, putAccessControlRule_impersonationRoleIds
- Impersonation role IDs to include in the rule.
PutAccessControlRule
, putAccessControlRule_ipRanges
- IPv4 CIDR ranges to include in the rule.
PutAccessControlRule
, putAccessControlRule_notActions
- Access protocol actions to exclude from the rule. Valid values include
ActiveSync
, AutoDiscover
, EWS
, IMAP
, SMTP
, WindowsOutlook
,
and WebMail
.
PutAccessControlRule
, putAccessControlRule_notImpersonationRoleIds
- Impersonation role IDs to exclude from the rule.
PutAccessControlRule
, putAccessControlRule_notIpRanges
- IPv4 CIDR ranges to exclude from the rule.
PutAccessControlRule
, putAccessControlRule_notUserIds
- User IDs to exclude from the rule.
PutAccessControlRule
, putAccessControlRule_userIds
- User IDs to include in the rule.
PutAccessControlRule
, putAccessControlRule_name
- The rule name.
PutAccessControlRule
, putAccessControlRule_effect
- The rule effect.
PutAccessControlRule
, putAccessControlRule_description
- The rule description.
PutAccessControlRule
, putAccessControlRule_organizationId
- The identifier of the organization.
data PutAccessControlRuleResponse Source #
See: newPutAccessControlRuleResponse
smart constructor.
Constructors
PutAccessControlRuleResponse' Int |
Instances
newPutAccessControlRuleResponse Source #
Create a value of PutAccessControlRuleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutAccessControlRuleResponse'
, putAccessControlRuleResponse_httpStatus
- The response's http status code.
PutEmailMonitoringConfiguration
data PutEmailMonitoringConfiguration Source #
See: newPutEmailMonitoringConfiguration
smart constructor.
Constructors
PutEmailMonitoringConfiguration' Text Text Text |
Instances
newPutEmailMonitoringConfiguration Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> PutEmailMonitoringConfiguration |
Create a value of PutEmailMonitoringConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutEmailMonitoringConfiguration
, putEmailMonitoringConfiguration_organizationId
- The ID of the organization for which the email monitoring configuration
is set.
$sel:roleArn:PutEmailMonitoringConfiguration'
, putEmailMonitoringConfiguration_roleArn
- The Amazon Resource Name (ARN) of the IAM Role associated with the email
monitoring configuration.
$sel:logGroupArn:PutEmailMonitoringConfiguration'
, putEmailMonitoringConfiguration_logGroupArn
- The Amazon Resource Name (ARN) of the CloudWatch Log group associated
with the email monitoring configuration.
data PutEmailMonitoringConfigurationResponse Source #
See: newPutEmailMonitoringConfigurationResponse
smart constructor.
Constructors
PutEmailMonitoringConfigurationResponse' Int |
Instances
newPutEmailMonitoringConfigurationResponse Source #
Arguments
:: Int | |
-> PutEmailMonitoringConfigurationResponse |
Create a value of PutEmailMonitoringConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutEmailMonitoringConfigurationResponse'
, putEmailMonitoringConfigurationResponse_httpStatus
- The response's http status code.
PutInboundDmarcSettings
data PutInboundDmarcSettings Source #
See: newPutInboundDmarcSettings
smart constructor.
Constructors
PutInboundDmarcSettings' Text Bool |
Instances
newPutInboundDmarcSettings Source #
Arguments
:: Text | |
-> Bool | |
-> PutInboundDmarcSettings |
Create a value of PutInboundDmarcSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutInboundDmarcSettings
, putInboundDmarcSettings_organizationId
- The ID of the organization that you are applying the DMARC policy to.
$sel:enforced:PutInboundDmarcSettings'
, putInboundDmarcSettings_enforced
- Enforces or suspends a policy after it's applied.
data PutInboundDmarcSettingsResponse Source #
See: newPutInboundDmarcSettingsResponse
smart constructor.
Constructors
PutInboundDmarcSettingsResponse' Int |
Instances
newPutInboundDmarcSettingsResponse Source #
Create a value of PutInboundDmarcSettingsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutInboundDmarcSettingsResponse'
, putInboundDmarcSettingsResponse_httpStatus
- The response's http status code.
PutMailboxPermissions
data PutMailboxPermissions Source #
See: newPutMailboxPermissions
smart constructor.
Constructors
PutMailboxPermissions' Text Text Text [PermissionType] |
Instances
newPutMailboxPermissions Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> PutMailboxPermissions |
Create a value of PutMailboxPermissions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutMailboxPermissions
, putMailboxPermissions_organizationId
- The identifier of the organization under which the user, group, or
resource exists.
PutMailboxPermissions
, putMailboxPermissions_entityId
- The identifier of the user, group, or resource for which to update
mailbox permissions.
PutMailboxPermissions
, putMailboxPermissions_granteeId
- The identifier of the user, group, or resource to which to grant the
permissions.
PutMailboxPermissions
, putMailboxPermissions_permissionValues
- The permissions granted to the grantee. SEND_AS allows the grantee to
send email as the owner of the mailbox (the grantee is not mentioned on
these emails). SEND_ON_BEHALF allows the grantee to send email on behalf
of the owner of the mailbox (the grantee is not mentioned as the
physical sender of these emails). FULL_ACCESS allows the grantee full
access to the mailbox, irrespective of other folder-level permissions
set on the mailbox.
data PutMailboxPermissionsResponse Source #
See: newPutMailboxPermissionsResponse
smart constructor.
Constructors
PutMailboxPermissionsResponse' Int |
Instances
newPutMailboxPermissionsResponse Source #
Create a value of PutMailboxPermissionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutMailboxPermissionsResponse'
, putMailboxPermissionsResponse_httpStatus
- The response's http status code.
PutMobileDeviceAccessOverride
data PutMobileDeviceAccessOverride Source #
See: newPutMobileDeviceAccessOverride
smart constructor.
Constructors
PutMobileDeviceAccessOverride' (Maybe Text) Text Text Text MobileDeviceAccessRuleEffect |
Instances
newPutMobileDeviceAccessOverride Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> MobileDeviceAccessRuleEffect | |
-> PutMobileDeviceAccessOverride |
Create a value of PutMobileDeviceAccessOverride
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutMobileDeviceAccessOverride
, putMobileDeviceAccessOverride_description
- A description of the override.
PutMobileDeviceAccessOverride
, putMobileDeviceAccessOverride_organizationId
- Identifies the WorkMail organization for which you create the override.
PutMobileDeviceAccessOverride
, putMobileDeviceAccessOverride_userId
- The WorkMail user for which you create the override. Accepts the
following types of user identities:
- User ID:
12345678-1234-1234-1234-123456789012
orS-1-1-12-1234567890-123456789-123456789-1234
- Email address:
user@domain.tld
- User name:
user
PutMobileDeviceAccessOverride
, putMobileDeviceAccessOverride_deviceId
- The mobile device for which you create the override. DeviceId
is case
insensitive.
PutMobileDeviceAccessOverride
, putMobileDeviceAccessOverride_effect
- The effect of the override, ALLOW
or DENY
.
data PutMobileDeviceAccessOverrideResponse Source #
See: newPutMobileDeviceAccessOverrideResponse
smart constructor.
Constructors
PutMobileDeviceAccessOverrideResponse' Int |
Instances
newPutMobileDeviceAccessOverrideResponse Source #
Arguments
:: Int | |
-> PutMobileDeviceAccessOverrideResponse |
Create a value of PutMobileDeviceAccessOverrideResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutMobileDeviceAccessOverrideResponse'
, putMobileDeviceAccessOverrideResponse_httpStatus
- The response's http status code.
PutRetentionPolicy
data PutRetentionPolicy Source #
See: newPutRetentionPolicy
smart constructor.
Constructors
PutRetentionPolicy' (Maybe (Sensitive Text)) (Maybe Text) Text Text [FolderConfiguration] |
Instances
newPutRetentionPolicy Source #
Arguments
:: Text | |
-> Text | |
-> PutRetentionPolicy |
Create a value of PutRetentionPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutRetentionPolicy
, putRetentionPolicy_description
- The retention policy description.
PutRetentionPolicy
, putRetentionPolicy_id
- The retention policy ID.
PutRetentionPolicy
, putRetentionPolicy_organizationId
- The organization ID.
PutRetentionPolicy
, putRetentionPolicy_name
- The retention policy name.
$sel:folderConfigurations:PutRetentionPolicy'
, putRetentionPolicy_folderConfigurations
- The retention policy folder configurations.
data PutRetentionPolicyResponse Source #
See: newPutRetentionPolicyResponse
smart constructor.
Constructors
PutRetentionPolicyResponse' Int |
Instances
newPutRetentionPolicyResponse Source #
Create a value of PutRetentionPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutRetentionPolicyResponse'
, putRetentionPolicyResponse_httpStatus
- The response's http status code.
RegisterMailDomain
data RegisterMailDomain Source #
See: newRegisterMailDomain
smart constructor.
Constructors
RegisterMailDomain' (Maybe Text) Text Text |
Instances
newRegisterMailDomain Source #
Arguments
:: Text | |
-> Text | |
-> RegisterMailDomain |
Create a value of RegisterMailDomain
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:RegisterMailDomain'
, registerMailDomain_clientToken
- Idempotency token used when retrying requests.
RegisterMailDomain
, registerMailDomain_organizationId
- The WorkMail organization under which you're creating the domain.
RegisterMailDomain
, registerMailDomain_domainName
- The name of the mail domain to create in WorkMail and SES.
data RegisterMailDomainResponse Source #
See: newRegisterMailDomainResponse
smart constructor.
Constructors
RegisterMailDomainResponse' Int |
Instances
newRegisterMailDomainResponse Source #
Create a value of RegisterMailDomainResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:RegisterMailDomainResponse'
, registerMailDomainResponse_httpStatus
- The response's http status code.
RegisterToWorkMail
data RegisterToWorkMail Source #
See: newRegisterToWorkMail
smart constructor.
Constructors
RegisterToWorkMail' Text Text Text |
Instances
newRegisterToWorkMail Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> RegisterToWorkMail |
Create a value of RegisterToWorkMail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RegisterToWorkMail
, registerToWorkMail_organizationId
- The identifier for the organization under which the user, group, or
resource exists.
RegisterToWorkMail
, registerToWorkMail_entityId
- The identifier for the user, group, or resource to be updated.
RegisterToWorkMail
, registerToWorkMail_email
- The email for the user, group, or resource to be updated.
data RegisterToWorkMailResponse Source #
See: newRegisterToWorkMailResponse
smart constructor.
Constructors
RegisterToWorkMailResponse' Int |
Instances
newRegisterToWorkMailResponse Source #
Create a value of RegisterToWorkMailResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:RegisterToWorkMailResponse'
, registerToWorkMailResponse_httpStatus
- The response's http status code.
ResetPassword
data ResetPassword Source #
See: newResetPassword
smart constructor.
Constructors
ResetPassword' Text Text (Sensitive Text) |
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> ResetPassword |
Create a value of ResetPassword
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ResetPassword
, resetPassword_organizationId
- The identifier of the organization that contains the user for which the
password is reset.
ResetPassword
, resetPassword_userId
- The identifier of the user for whom the password is reset.
$sel:password:ResetPassword'
, resetPassword_password
- The new password for the user.
data ResetPasswordResponse Source #
See: newResetPasswordResponse
smart constructor.
Constructors
ResetPasswordResponse' Int |
Instances
newResetPasswordResponse Source #
Create a value of ResetPasswordResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ResetPasswordResponse'
, resetPasswordResponse_httpStatus
- The response's http status code.
StartMailboxExportJob
data StartMailboxExportJob Source #
See: newStartMailboxExportJob
smart constructor.
Instances
newStartMailboxExportJob Source #
Create a value of StartMailboxExportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartMailboxExportJob
, startMailboxExportJob_description
- The mailbox export job description.
$sel:clientToken:StartMailboxExportJob'
, startMailboxExportJob_clientToken
- The idempotency token for the client request.
StartMailboxExportJob
, startMailboxExportJob_organizationId
- The identifier associated with the organization.
StartMailboxExportJob
, startMailboxExportJob_entityId
- The identifier of the user or resource associated with the mailbox.
$sel:roleArn:StartMailboxExportJob'
, startMailboxExportJob_roleArn
- The ARN of the AWS Identity and Access Management (IAM) role that grants
write permission to the S3 bucket.
$sel:kmsKeyArn:StartMailboxExportJob'
, startMailboxExportJob_kmsKeyArn
- The Amazon Resource Name (ARN) of the symmetric AWS Key Management
Service (AWS KMS) key that encrypts the exported mailbox content.
StartMailboxExportJob
, startMailboxExportJob_s3BucketName
- The name of the S3 bucket.
$sel:s3Prefix:StartMailboxExportJob'
, startMailboxExportJob_s3Prefix
- The S3 bucket prefix.
data StartMailboxExportJobResponse Source #
See: newStartMailboxExportJobResponse
smart constructor.
Constructors
StartMailboxExportJobResponse' (Maybe Text) Int |
Instances
newStartMailboxExportJobResponse Source #
Create a value of StartMailboxExportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartMailboxExportJobResponse
, startMailboxExportJobResponse_jobId
- The job ID.
$sel:httpStatus:StartMailboxExportJobResponse'
, startMailboxExportJobResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Constructors
TagResource' Text [Tag] |
Instances
Arguments
:: Text | |
-> TagResource |
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:TagResource'
, tagResource_resourceARN
- The resource ARN.
$sel:tags:TagResource'
, tagResource_tags
- The tag key-value pairs.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Constructors
TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
:: Int | |
-> TagResourceResponse |
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
TestAvailabilityConfiguration
data TestAvailabilityConfiguration Source #
See: newTestAvailabilityConfiguration
smart constructor.
Constructors
TestAvailabilityConfiguration' (Maybe Text) (Maybe EwsAvailabilityProvider) (Maybe LambdaAvailabilityProvider) Text |
Instances
newTestAvailabilityConfiguration Source #
Create a value of TestAvailabilityConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TestAvailabilityConfiguration
, testAvailabilityConfiguration_domainName
- The domain to which the provider applies. If this field is provided, a
stored availability provider associated to this domain name will be
tested.
TestAvailabilityConfiguration
, testAvailabilityConfiguration_ewsProvider
- Undocumented member.
TestAvailabilityConfiguration
, testAvailabilityConfiguration_lambdaProvider
- Undocumented member.
TestAvailabilityConfiguration
, testAvailabilityConfiguration_organizationId
- The WorkMail organization where the availability provider will be
tested.
data TestAvailabilityConfigurationResponse Source #
See: newTestAvailabilityConfigurationResponse
smart constructor.
Instances
newTestAvailabilityConfigurationResponse Source #
Arguments
:: Int | |
-> TestAvailabilityConfigurationResponse |
Create a value of TestAvailabilityConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:TestAvailabilityConfigurationResponse'
, testAvailabilityConfigurationResponse_failureReason
- String containing the reason for a failed test if TestPassed
is false.
$sel:testPassed:TestAvailabilityConfigurationResponse'
, testAvailabilityConfigurationResponse_testPassed
- Boolean indicating whether the test passed or failed.
$sel:httpStatus:TestAvailabilityConfigurationResponse'
, testAvailabilityConfigurationResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Constructors
UntagResource' Text [Text] |
Instances
Arguments
:: Text | |
-> UntagResource |
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:UntagResource'
, untagResource_resourceARN
- The resource ARN.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The tag keys.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Constructors
UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateAvailabilityConfiguration
data UpdateAvailabilityConfiguration Source #
See: newUpdateAvailabilityConfiguration
smart constructor.
Constructors
UpdateAvailabilityConfiguration' (Maybe EwsAvailabilityProvider) (Maybe LambdaAvailabilityProvider) Text Text |
Instances
newUpdateAvailabilityConfiguration Source #
Arguments
:: Text | |
-> Text | |
-> UpdateAvailabilityConfiguration |
Create a value of UpdateAvailabilityConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateAvailabilityConfiguration
, updateAvailabilityConfiguration_ewsProvider
- The EWS availability provider definition. The request must contain
exactly one provider definition, either EwsProvider
or
LambdaProvider
. The previously stored provider will be overridden by
the one provided.
UpdateAvailabilityConfiguration
, updateAvailabilityConfiguration_lambdaProvider
- The Lambda availability provider definition. The request must contain
exactly one provider definition, either EwsProvider
or
LambdaProvider
. The previously stored provider will be overridden by
the one provided.
UpdateAvailabilityConfiguration
, updateAvailabilityConfiguration_organizationId
- The WorkMail organization for which the AvailabilityConfiguration
will
be updated.
UpdateAvailabilityConfiguration
, updateAvailabilityConfiguration_domainName
- The domain to which the provider applies the availability configuration.
data UpdateAvailabilityConfigurationResponse Source #
See: newUpdateAvailabilityConfigurationResponse
smart constructor.
Constructors
UpdateAvailabilityConfigurationResponse' Int |
Instances
newUpdateAvailabilityConfigurationResponse Source #
Arguments
:: Int | |
-> UpdateAvailabilityConfigurationResponse |
Create a value of UpdateAvailabilityConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateAvailabilityConfigurationResponse'
, updateAvailabilityConfigurationResponse_httpStatus
- The response's http status code.
UpdateDefaultMailDomain
data UpdateDefaultMailDomain Source #
See: newUpdateDefaultMailDomain
smart constructor.
Constructors
UpdateDefaultMailDomain' Text Text |
Instances
newUpdateDefaultMailDomain Source #
Create a value of UpdateDefaultMailDomain
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDefaultMailDomain
, updateDefaultMailDomain_organizationId
- The WorkMail organization for which to list domains.
UpdateDefaultMailDomain
, updateDefaultMailDomain_domainName
- The domain name that will become the default domain.
data UpdateDefaultMailDomainResponse Source #
See: newUpdateDefaultMailDomainResponse
smart constructor.
Constructors
UpdateDefaultMailDomainResponse' Int |
Instances
newUpdateDefaultMailDomainResponse Source #
Create a value of UpdateDefaultMailDomainResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateDefaultMailDomainResponse'
, updateDefaultMailDomainResponse_httpStatus
- The response's http status code.
UpdateImpersonationRole
data UpdateImpersonationRole Source #
See: newUpdateImpersonationRole
smart constructor.
Constructors
UpdateImpersonationRole' (Maybe Text) Text Text Text ImpersonationRoleType [ImpersonationRule] |
Instances
newUpdateImpersonationRole Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> ImpersonationRoleType | |
-> UpdateImpersonationRole |
Create a value of UpdateImpersonationRole
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateImpersonationRole
, updateImpersonationRole_description
- The updated impersonation role description.
UpdateImpersonationRole
, updateImpersonationRole_organizationId
- The WorkMail organization that contains the impersonation role to
update.
UpdateImpersonationRole
, updateImpersonationRole_impersonationRoleId
- The ID of the impersonation role to update.
UpdateImpersonationRole
, updateImpersonationRole_name
- The updated impersonation role name.
UpdateImpersonationRole
, updateImpersonationRole_type
- The updated impersonation role type.
$sel:rules:UpdateImpersonationRole'
, updateImpersonationRole_rules
- The updated list of rules.
data UpdateImpersonationRoleResponse Source #
See: newUpdateImpersonationRoleResponse
smart constructor.
Constructors
UpdateImpersonationRoleResponse' Int |
Instances
newUpdateImpersonationRoleResponse Source #
Create a value of UpdateImpersonationRoleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateImpersonationRoleResponse'
, updateImpersonationRoleResponse_httpStatus
- The response's http status code.
UpdateMailboxQuota
data UpdateMailboxQuota Source #
See: newUpdateMailboxQuota
smart constructor.
Constructors
UpdateMailboxQuota' Text Text Natural |
Instances
newUpdateMailboxQuota Source #
Arguments
:: Text | |
-> Text | |
-> Natural | |
-> UpdateMailboxQuota |
Create a value of UpdateMailboxQuota
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateMailboxQuota
, updateMailboxQuota_organizationId
- The identifier for the organization that contains the user for whom to
update the mailbox quota.
UpdateMailboxQuota
, updateMailboxQuota_userId
- The identifer for the user for whom to update the mailbox quota.
$sel:mailboxQuota:UpdateMailboxQuota'
, updateMailboxQuota_mailboxQuota
- The updated mailbox quota, in MB, for the specified user.
data UpdateMailboxQuotaResponse Source #
See: newUpdateMailboxQuotaResponse
smart constructor.
Constructors
UpdateMailboxQuotaResponse' Int |
Instances
newUpdateMailboxQuotaResponse Source #
Create a value of UpdateMailboxQuotaResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateMailboxQuotaResponse'
, updateMailboxQuotaResponse_httpStatus
- The response's http status code.
UpdateMobileDeviceAccessRule
data UpdateMobileDeviceAccessRule Source #
See: newUpdateMobileDeviceAccessRule
smart constructor.
Constructors
UpdateMobileDeviceAccessRule' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) Text Text Text MobileDeviceAccessRuleEffect |
Instances
newUpdateMobileDeviceAccessRule Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> MobileDeviceAccessRuleEffect | |
-> UpdateMobileDeviceAccessRule |
Create a value of UpdateMobileDeviceAccessRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateMobileDeviceAccessRule
, updateMobileDeviceAccessRule_description
- The updated rule description.
UpdateMobileDeviceAccessRule
, updateMobileDeviceAccessRule_deviceModels
- Device models that the updated rule will match.
UpdateMobileDeviceAccessRule
, updateMobileDeviceAccessRule_deviceOperatingSystems
- Device operating systems that the updated rule will match.
UpdateMobileDeviceAccessRule
, updateMobileDeviceAccessRule_deviceTypes
- Device types that the updated rule will match.
UpdateMobileDeviceAccessRule
, updateMobileDeviceAccessRule_deviceUserAgents
- User agents that the updated rule will match.
UpdateMobileDeviceAccessRule
, updateMobileDeviceAccessRule_notDeviceModels
- Device models that the updated rule will not match. All other device
models will match.
UpdateMobileDeviceAccessRule
, updateMobileDeviceAccessRule_notDeviceOperatingSystems
- Device operating systems that the updated rule will not match. All
other device operating systems will match.
UpdateMobileDeviceAccessRule
, updateMobileDeviceAccessRule_notDeviceTypes
- Device types that the updated rule will not match. All other device
types will match.
UpdateMobileDeviceAccessRule
, updateMobileDeviceAccessRule_notDeviceUserAgents
- User agents that the updated rule will not match. All other user
agents will match.
UpdateMobileDeviceAccessRule
, updateMobileDeviceAccessRule_organizationId
- The WorkMail organization under which the rule will be updated.
UpdateMobileDeviceAccessRule
, updateMobileDeviceAccessRule_mobileDeviceAccessRuleId
- The identifier of the rule to be updated.
UpdateMobileDeviceAccessRule
, updateMobileDeviceAccessRule_name
- The updated rule name.
UpdateMobileDeviceAccessRule
, updateMobileDeviceAccessRule_effect
- The effect of the rule when it matches. Allowed values are ALLOW
or
DENY
.
data UpdateMobileDeviceAccessRuleResponse Source #
See: newUpdateMobileDeviceAccessRuleResponse
smart constructor.
Constructors
UpdateMobileDeviceAccessRuleResponse' Int |
Instances
newUpdateMobileDeviceAccessRuleResponse Source #
Arguments
:: Int | |
-> UpdateMobileDeviceAccessRuleResponse |
Create a value of UpdateMobileDeviceAccessRuleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateMobileDeviceAccessRuleResponse'
, updateMobileDeviceAccessRuleResponse_httpStatus
- The response's http status code.
UpdatePrimaryEmailAddress
data UpdatePrimaryEmailAddress Source #
See: newUpdatePrimaryEmailAddress
smart constructor.
Constructors
UpdatePrimaryEmailAddress' Text Text Text |
Instances
newUpdatePrimaryEmailAddress Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> UpdatePrimaryEmailAddress |
Create a value of UpdatePrimaryEmailAddress
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdatePrimaryEmailAddress
, updatePrimaryEmailAddress_organizationId
- The organization that contains the user, group, or resource to update.
UpdatePrimaryEmailAddress
, updatePrimaryEmailAddress_entityId
- The user, group, or resource to update.
UpdatePrimaryEmailAddress
, updatePrimaryEmailAddress_email
- The value of the email to be updated as primary.
data UpdatePrimaryEmailAddressResponse Source #
See: newUpdatePrimaryEmailAddressResponse
smart constructor.
Constructors
UpdatePrimaryEmailAddressResponse' Int |
Instances
newUpdatePrimaryEmailAddressResponse Source #
Arguments
:: Int | |
-> UpdatePrimaryEmailAddressResponse |
Create a value of UpdatePrimaryEmailAddressResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdatePrimaryEmailAddressResponse'
, updatePrimaryEmailAddressResponse_httpStatus
- The response's http status code.
UpdateResource
data UpdateResource Source #
See: newUpdateResource
smart constructor.
Constructors
UpdateResource' (Maybe BookingOptions) (Maybe Text) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> UpdateResource |
Create a value of UpdateResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bookingOptions:UpdateResource'
, updateResource_bookingOptions
- The resource's booking options to be updated.
UpdateResource
, updateResource_name
- The name of the resource to be updated.
UpdateResource
, updateResource_organizationId
- The identifier associated with the organization for which the resource
is updated.
$sel:resourceId:UpdateResource'
, updateResource_resourceId
- The identifier of the resource to be updated.
data UpdateResourceResponse Source #
See: newUpdateResourceResponse
smart constructor.
Constructors
UpdateResourceResponse' Int |
Instances
newUpdateResourceResponse Source #
Create a value of UpdateResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateResourceResponse'
, updateResourceResponse_httpStatus
- The response's http status code.
Types
AccessControlRuleEffect
newtype AccessControlRuleEffect Source #
Constructors
AccessControlRuleEffect' | |
Fields |
Bundled Patterns
pattern AccessControlRuleEffect_ALLOW :: AccessControlRuleEffect | |
pattern AccessControlRuleEffect_DENY :: AccessControlRuleEffect |
Instances
AccessEffect
newtype AccessEffect Source #
Constructors
AccessEffect' | |
Fields |
Bundled Patterns
pattern AccessEffect_ALLOW :: AccessEffect | |
pattern AccessEffect_DENY :: AccessEffect |
Instances
AvailabilityProviderType
newtype AvailabilityProviderType Source #
Constructors
AvailabilityProviderType' | |
Fields |
Bundled Patterns
pattern AvailabilityProviderType_EWS :: AvailabilityProviderType | |
pattern AvailabilityProviderType_LAMBDA :: AvailabilityProviderType |
Instances
DnsRecordVerificationStatus
newtype DnsRecordVerificationStatus Source #
Constructors
DnsRecordVerificationStatus' | |
Fields |
Bundled Patterns
Instances
EntityState
newtype EntityState Source #
Constructors
EntityState' | |
Fields |
Bundled Patterns
pattern EntityState_DELETED :: EntityState | |
pattern EntityState_DISABLED :: EntityState | |
pattern EntityState_ENABLED :: EntityState |
Instances
FolderName
newtype FolderName Source #
Constructors
FolderName' | |
Fields |
Bundled Patterns
pattern FolderName_DELETED_ITEMS :: FolderName | |
pattern FolderName_DRAFTS :: FolderName | |
pattern FolderName_INBOX :: FolderName | |
pattern FolderName_JUNK_EMAIL :: FolderName | |
pattern FolderName_SENT_ITEMS :: FolderName |
Instances
ImpersonationRoleType
newtype ImpersonationRoleType Source #
Constructors
ImpersonationRoleType' | |
Fields |
Bundled Patterns
pattern ImpersonationRoleType_FULL_ACCESS :: ImpersonationRoleType | |
pattern ImpersonationRoleType_READ_ONLY :: ImpersonationRoleType |
Instances
MailboxExportJobState
newtype MailboxExportJobState Source #
Constructors
MailboxExportJobState' | |
Fields |
Bundled Patterns
pattern MailboxExportJobState_CANCELLED :: MailboxExportJobState | |
pattern MailboxExportJobState_COMPLETED :: MailboxExportJobState | |
pattern MailboxExportJobState_FAILED :: MailboxExportJobState | |
pattern MailboxExportJobState_RUNNING :: MailboxExportJobState |
Instances
MemberType
newtype MemberType Source #
Constructors
MemberType' | |
Fields |
Bundled Patterns
pattern MemberType_GROUP :: MemberType | |
pattern MemberType_USER :: MemberType |
Instances
MobileDeviceAccessRuleEffect
newtype MobileDeviceAccessRuleEffect Source #
Constructors
MobileDeviceAccessRuleEffect' | |
Fields |
Bundled Patterns
pattern MobileDeviceAccessRuleEffect_ALLOW :: MobileDeviceAccessRuleEffect | |
pattern MobileDeviceAccessRuleEffect_DENY :: MobileDeviceAccessRuleEffect |
Instances
PermissionType
newtype PermissionType Source #
Constructors
PermissionType' | |
Fields |
Bundled Patterns
pattern PermissionType_FULL_ACCESS :: PermissionType | |
pattern PermissionType_SEND_AS :: PermissionType | |
pattern PermissionType_SEND_ON_BEHALF :: PermissionType |
Instances
ResourceType
newtype ResourceType Source #
Constructors
ResourceType' | |
Fields |
Bundled Patterns
pattern ResourceType_EQUIPMENT :: ResourceType | |
pattern ResourceType_ROOM :: ResourceType |
Instances
RetentionAction
newtype RetentionAction Source #
Constructors
RetentionAction' | |
Fields |
Bundled Patterns
pattern RetentionAction_DELETE :: RetentionAction | |
pattern RetentionAction_NONE :: RetentionAction | |
pattern RetentionAction_PERMANENTLY_DELETE :: RetentionAction |
Instances
UserRole
Constructors
UserRole' | |
Fields
|
Bundled Patterns
pattern UserRole_RESOURCE :: UserRole | |
pattern UserRole_SYSTEM_USER :: UserRole | |
pattern UserRole_USER :: UserRole |
Instances
AccessControlRule
data AccessControlRule Source #
A rule that controls access to an WorkMail organization.
See: newAccessControlRule
smart constructor.
Constructors
AccessControlRule' (Maybe [Text]) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe AccessControlRuleEffect) (Maybe [Text]) (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) |
Instances
newAccessControlRule :: AccessControlRule Source #
Create a value of AccessControlRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actions:AccessControlRule'
, accessControlRule_actions
- Access protocol actions to include in the rule. Valid values include
ActiveSync
, AutoDiscover
, EWS
, IMAP
, SMTP
, WindowsOutlook
,
and WebMail
.
$sel:dateCreated:AccessControlRule'
, accessControlRule_dateCreated
- The date that the rule was created.
$sel:dateModified:AccessControlRule'
, accessControlRule_dateModified
- The date that the rule was modified.
$sel:description:AccessControlRule'
, accessControlRule_description
- The rule description.
$sel:effect:AccessControlRule'
, accessControlRule_effect
- The rule effect.
$sel:impersonationRoleIds:AccessControlRule'
, accessControlRule_impersonationRoleIds
- Impersonation role IDs to include in the rule.
$sel:ipRanges:AccessControlRule'
, accessControlRule_ipRanges
- IPv4 CIDR ranges to include in the rule.
$sel:name:AccessControlRule'
, accessControlRule_name
- The rule name.
$sel:notActions:AccessControlRule'
, accessControlRule_notActions
- Access protocol actions to exclude from the rule. Valid values include
ActiveSync
, AutoDiscover
, EWS
, IMAP
, SMTP
, WindowsOutlook
,
and WebMail
.
$sel:notImpersonationRoleIds:AccessControlRule'
, accessControlRule_notImpersonationRoleIds
- Impersonation role IDs to exclude from the rule.
$sel:notIpRanges:AccessControlRule'
, accessControlRule_notIpRanges
- IPv4 CIDR ranges to exclude from the rule.
$sel:notUserIds:AccessControlRule'
, accessControlRule_notUserIds
- User IDs to exclude from the rule.
$sel:userIds:AccessControlRule'
, accessControlRule_userIds
- User IDs to include in the rule.
AvailabilityConfiguration
data AvailabilityConfiguration Source #
List all the AvailabilityConfiguration
's for the given WorkMail
organization.
See: newAvailabilityConfiguration
smart constructor.
Constructors
AvailabilityConfiguration' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe RedactedEwsAvailabilityProvider) (Maybe LambdaAvailabilityProvider) (Maybe AvailabilityProviderType) |
Instances
newAvailabilityConfiguration :: AvailabilityConfiguration Source #
Create a value of AvailabilityConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dateCreated:AvailabilityConfiguration'
, availabilityConfiguration_dateCreated
- The date and time at which the availability configuration was created.
$sel:dateModified:AvailabilityConfiguration'
, availabilityConfiguration_dateModified
- The date and time at which the availability configuration was last
modified.
$sel:domainName:AvailabilityConfiguration'
, availabilityConfiguration_domainName
- Displays the domain to which the provider applies.
$sel:ewsProvider:AvailabilityConfiguration'
, availabilityConfiguration_ewsProvider
- If ProviderType
is EWS
, then this field contains
RedactedEwsAvailabilityProvider
. Otherwise, it is not required.
$sel:lambdaProvider:AvailabilityConfiguration'
, availabilityConfiguration_lambdaProvider
- If ProviderType is LAMBDA
then this field contains
LambdaAvailabilityProvider
. Otherwise, it is not required.
$sel:providerType:AvailabilityConfiguration'
, availabilityConfiguration_providerType
- Displays the provider type that applies to this domain.
BookingOptions
data BookingOptions Source #
At least one delegate must be associated to the resource to disable automatic replies from the resource.
See: newBookingOptions
smart constructor.
Instances
newBookingOptions :: BookingOptions Source #
Create a value of BookingOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoAcceptRequests:BookingOptions'
, bookingOptions_autoAcceptRequests
- The resource's ability to automatically reply to requests. If disabled,
delegates must be associated to the resource.
$sel:autoDeclineConflictingRequests:BookingOptions'
, bookingOptions_autoDeclineConflictingRequests
- The resource's ability to automatically decline any conflicting
requests.
$sel:autoDeclineRecurringRequests:BookingOptions'
, bookingOptions_autoDeclineRecurringRequests
- The resource's ability to automatically decline any recurring requests.
Delegate
The name of the attribute, which is one of the values defined in the UserAttribute enumeration.
See: newDelegate
smart constructor.
Constructors
Delegate' Text MemberType |
Instances
FromJSON Delegate Source # | |
Generic Delegate Source # | |
Read Delegate Source # | |
Show Delegate Source # | |
NFData Delegate Source # | |
Defined in Amazonka.WorkMail.Types.Delegate | |
Eq Delegate Source # | |
Hashable Delegate Source # | |
Defined in Amazonka.WorkMail.Types.Delegate | |
type Rep Delegate Source # | |
Defined in Amazonka.WorkMail.Types.Delegate type Rep Delegate = D1 ('MetaData "Delegate" "Amazonka.WorkMail.Types.Delegate" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "Delegate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MemberType))) |
Arguments
:: Text | |
-> MemberType | |
-> Delegate |
Create a value of Delegate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:Delegate'
, delegate_id
- The identifier for the user or group associated as the resource's
delegate.
$sel:type':Delegate'
, delegate_type
- The type of the delegate: user or group.
DnsRecord
A DNS record uploaded to your DNS provider.
See: newDnsRecord
smart constructor.
Instances
FromJSON DnsRecord Source # | |
Generic DnsRecord Source # | |
Read DnsRecord Source # | |
Show DnsRecord Source # | |
NFData DnsRecord Source # | |
Defined in Amazonka.WorkMail.Types.DnsRecord | |
Eq DnsRecord Source # | |
Hashable DnsRecord Source # | |
Defined in Amazonka.WorkMail.Types.DnsRecord | |
type Rep DnsRecord Source # | |
Defined in Amazonka.WorkMail.Types.DnsRecord type Rep DnsRecord = D1 ('MetaData "DnsRecord" "Amazonka.WorkMail.Types.DnsRecord" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "DnsRecord'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
newDnsRecord :: DnsRecord Source #
Create a value of DnsRecord
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hostname:DnsRecord'
, dnsRecord_hostname
- The DNS hostname.- For example, domain.example.com
.
$sel:type':DnsRecord'
, dnsRecord_type
- The RFC 1035 record type. Possible values: CNAME
, A
, MX
.
$sel:value:DnsRecord'
, dnsRecord_value
- The value returned by the DNS for a query to that hostname and record
type.
Domain
The domain to associate with an WorkMail organization.
When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see Adding a domain in the WorkMail Administrator Guide.
See: newDomain
smart constructor.
Instances
ToJSON Domain Source # | |
Defined in Amazonka.WorkMail.Types.Domain | |
Generic Domain Source # | |
Read Domain Source # | |
Show Domain Source # | |
NFData Domain Source # | |
Defined in Amazonka.WorkMail.Types.Domain | |
Eq Domain Source # | |
Hashable Domain Source # | |
Defined in Amazonka.WorkMail.Types.Domain | |
type Rep Domain Source # | |
Defined in Amazonka.WorkMail.Types.Domain type Rep Domain = D1 ('MetaData "Domain" "Amazonka.WorkMail.Types.Domain" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "Domain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
Create a value of Domain
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:Domain'
, domain_domainName
- The fully qualified domain name.
$sel:hostedZoneId:Domain'
, domain_hostedZoneId
- The hosted zone ID for a domain hosted in Route 53. Required when
configuring a domain hosted in Route 53.
EwsAvailabilityProvider
data EwsAvailabilityProvider Source #
Describes an EWS based availability provider. This is only used as input to the service.
See: newEwsAvailabilityProvider
smart constructor.
Constructors
EwsAvailabilityProvider' Text Text (Sensitive Text) |
Instances
newEwsAvailabilityProvider Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> EwsAvailabilityProvider |
Create a value of EwsAvailabilityProvider
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ewsEndpoint:EwsAvailabilityProvider'
, ewsAvailabilityProvider_ewsEndpoint
- The endpoint of the remote EWS server.
$sel:ewsUsername:EwsAvailabilityProvider'
, ewsAvailabilityProvider_ewsUsername
- The username used to authenticate the remote EWS server.
$sel:ewsPassword:EwsAvailabilityProvider'
, ewsAvailabilityProvider_ewsPassword
- The password used to authenticate the remote EWS server.
FolderConfiguration
data FolderConfiguration Source #
The configuration applied to an organization's folders by its retention policy.
See: newFolderConfiguration
smart constructor.
Constructors
FolderConfiguration' (Maybe Natural) FolderName RetentionAction |
Instances
newFolderConfiguration Source #
Arguments
:: FolderName | |
-> RetentionAction | |
-> FolderConfiguration |
Create a value of FolderConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:period:FolderConfiguration'
, folderConfiguration_period
- The number of days for which the folder-configuration action applies.
$sel:name:FolderConfiguration'
, folderConfiguration_name
- The folder name.
$sel:action:FolderConfiguration'
, folderConfiguration_action
- The action to take on the folder contents at the end of the folder
configuration period.
Group
The representation of an WorkMail group.
See: newGroup
smart constructor.
Constructors
Group' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe EntityState) |
Instances
Create a value of Group
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:disabledDate:Group'
, group_disabledDate
- The date indicating when the group was disabled from WorkMail use.
$sel:email:Group'
, group_email
- The email of the group.
$sel:enabledDate:Group'
, group_enabledDate
- The date indicating when the group was enabled for WorkMail use.
$sel:id:Group'
, group_id
- The identifier of the group.
$sel:name:Group'
, group_name
- The name of the group.
$sel:state:Group'
, group_state
- The state of the group, which can be ENABLED, DISABLED, or DELETED.
ImpersonationMatchedRule
data ImpersonationMatchedRule Source #
The impersonation rule that matched the input.
See: newImpersonationMatchedRule
smart constructor.
Constructors
ImpersonationMatchedRule' (Maybe Text) (Maybe Text) |
Instances
newImpersonationMatchedRule :: ImpersonationMatchedRule Source #
Create a value of ImpersonationMatchedRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:impersonationRuleId:ImpersonationMatchedRule'
, impersonationMatchedRule_impersonationRuleId
- The ID of the rule that matched the input
$sel:name:ImpersonationMatchedRule'
, impersonationMatchedRule_name
- The name of the rule that matched the input.
ImpersonationRole
data ImpersonationRole Source #
An impersonation role for the given WorkMail organization.
See: newImpersonationRole
smart constructor.
Constructors
ImpersonationRole' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ImpersonationRoleType) |
Instances
newImpersonationRole :: ImpersonationRole Source #
Create a value of ImpersonationRole
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dateCreated:ImpersonationRole'
, impersonationRole_dateCreated
- The date when the impersonation role was created.
$sel:dateModified:ImpersonationRole'
, impersonationRole_dateModified
- The date when the impersonation role was last modified.
$sel:impersonationRoleId:ImpersonationRole'
, impersonationRole_impersonationRoleId
- The identifier of the impersonation role.
$sel:name:ImpersonationRole'
, impersonationRole_name
- The impersonation role name.
$sel:type':ImpersonationRole'
, impersonationRole_type
- The impersonation role type.
ImpersonationRule
data ImpersonationRule Source #
The rules for the given impersonation role.
See: newImpersonationRule
smart constructor.
Constructors
ImpersonationRule' (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) Text AccessEffect |
Instances
Arguments
:: Text | |
-> AccessEffect | |
-> ImpersonationRule |
Create a value of ImpersonationRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:ImpersonationRule'
, impersonationRule_description
- The rule description.
$sel:name:ImpersonationRule'
, impersonationRule_name
- The rule name.
$sel:notTargetUsers:ImpersonationRule'
, impersonationRule_notTargetUsers
- A list of user IDs that don't match the rule.
$sel:targetUsers:ImpersonationRule'
, impersonationRule_targetUsers
- A list of user IDs that match the rule.
$sel:impersonationRuleId:ImpersonationRule'
, impersonationRule_impersonationRuleId
- The identifier of the rule.
$sel:effect:ImpersonationRule'
, impersonationRule_effect
- The effect of the rule when it matches the input. Allowed effect values
are ALLOW
or DENY
.
LambdaAvailabilityProvider
data LambdaAvailabilityProvider Source #
Describes a Lambda based availability provider.
See: newLambdaAvailabilityProvider
smart constructor.
Constructors
LambdaAvailabilityProvider' Text |
Instances
newLambdaAvailabilityProvider Source #
Create a value of LambdaAvailabilityProvider
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lambdaArn:LambdaAvailabilityProvider'
, lambdaAvailabilityProvider_lambdaArn
- The Amazon Resource Name (ARN) of the Lambda that acts as the
availability provider.
MailDomainSummary
data MailDomainSummary Source #
The data for a given domain.
See: newMailDomainSummary
smart constructor.
Constructors
MailDomainSummary' (Maybe Bool) (Maybe Text) |
Instances
newMailDomainSummary :: MailDomainSummary Source #
Create a value of MailDomainSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultDomain:MailDomainSummary'
, mailDomainSummary_defaultDomain
- Whether the domain is default or not.
$sel:domainName:MailDomainSummary'
, mailDomainSummary_domainName
- The domain name.
MailboxExportJob
data MailboxExportJob Source #
The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.
See: newMailboxExportJob
smart constructor.
Constructors
MailboxExportJob' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe MailboxExportJobState) |
Instances
newMailboxExportJob :: MailboxExportJob Source #
Create a value of MailboxExportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:MailboxExportJob'
, mailboxExportJob_description
- The mailbox export job description.
$sel:endTime:MailboxExportJob'
, mailboxExportJob_endTime
- The mailbox export job end timestamp.
$sel:entityId:MailboxExportJob'
, mailboxExportJob_entityId
- The identifier of the user or resource associated with the mailbox.
$sel:estimatedProgress:MailboxExportJob'
, mailboxExportJob_estimatedProgress
- The estimated progress of the mailbox export job, in percentage points.
$sel:jobId:MailboxExportJob'
, mailboxExportJob_jobId
- The identifier of the mailbox export job.
$sel:s3BucketName:MailboxExportJob'
, mailboxExportJob_s3BucketName
- The name of the S3 bucket.
$sel:s3Path:MailboxExportJob'
, mailboxExportJob_s3Path
- The path to the S3 bucket and file that the mailbox export job exports
to.
$sel:startTime:MailboxExportJob'
, mailboxExportJob_startTime
- The mailbox export job start timestamp.
$sel:state:MailboxExportJob'
, mailboxExportJob_state
- The state of the mailbox export job.
Member
The representation of a user or group.
See: newMember
smart constructor.
Constructors
Member' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe EntityState) (Maybe MemberType) |
Instances
Create a value of Member
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:disabledDate:Member'
, member_disabledDate
- The date indicating when the member was disabled from WorkMail use.
$sel:enabledDate:Member'
, member_enabledDate
- The date indicating when the member was enabled for WorkMail use.
$sel:id:Member'
, member_id
- The identifier of the member.
$sel:name:Member'
, member_name
- The name of the member.
$sel:state:Member'
, member_state
- The state of the member, which can be ENABLED, DISABLED, or DELETED.
$sel:type':Member'
, member_type
- A member can be a user or group.
MobileDeviceAccessMatchedRule
data MobileDeviceAccessMatchedRule Source #
The rule that a simulated user matches.
See: newMobileDeviceAccessMatchedRule
smart constructor.
Constructors
MobileDeviceAccessMatchedRule' (Maybe Text) (Maybe Text) |
Instances
newMobileDeviceAccessMatchedRule :: MobileDeviceAccessMatchedRule Source #
Create a value of MobileDeviceAccessMatchedRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mobileDeviceAccessRuleId:MobileDeviceAccessMatchedRule'
, mobileDeviceAccessMatchedRule_mobileDeviceAccessRuleId
- Identifier of the rule that a simulated user matches.
$sel:name:MobileDeviceAccessMatchedRule'
, mobileDeviceAccessMatchedRule_name
- Name of a rule that a simulated user matches.
MobileDeviceAccessOverride
data MobileDeviceAccessOverride Source #
The override object.
See: newMobileDeviceAccessOverride
smart constructor.
Constructors
MobileDeviceAccessOverride' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe MobileDeviceAccessRuleEffect) (Maybe Text) |
Instances
newMobileDeviceAccessOverride :: MobileDeviceAccessOverride Source #
Create a value of MobileDeviceAccessOverride
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dateCreated:MobileDeviceAccessOverride'
, mobileDeviceAccessOverride_dateCreated
- The date the override was first created.
$sel:dateModified:MobileDeviceAccessOverride'
, mobileDeviceAccessOverride_dateModified
- The date the override was last modified.
$sel:description:MobileDeviceAccessOverride'
, mobileDeviceAccessOverride_description
- A description of the override.
$sel:deviceId:MobileDeviceAccessOverride'
, mobileDeviceAccessOverride_deviceId
- The device to which the override applies.
$sel:effect:MobileDeviceAccessOverride'
, mobileDeviceAccessOverride_effect
- The effect of the override, ALLOW
or DENY
.
$sel:userId:MobileDeviceAccessOverride'
, mobileDeviceAccessOverride_userId
- The WorkMail user to which the access override applies.
MobileDeviceAccessRule
data MobileDeviceAccessRule Source #
A rule that controls access to mobile devices for an WorkMail group.
See: newMobileDeviceAccessRule
smart constructor.
Constructors
MobileDeviceAccessRule' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe MobileDeviceAccessRuleEffect) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) |
Instances
newMobileDeviceAccessRule :: MobileDeviceAccessRule Source #
Create a value of MobileDeviceAccessRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dateCreated:MobileDeviceAccessRule'
, mobileDeviceAccessRule_dateCreated
- The date and time at which an access rule was created.
$sel:dateModified:MobileDeviceAccessRule'
, mobileDeviceAccessRule_dateModified
- The date and time at which an access rule was modified.
$sel:description:MobileDeviceAccessRule'
, mobileDeviceAccessRule_description
- The description of a mobile access rule.
$sel:deviceModels:MobileDeviceAccessRule'
, mobileDeviceAccessRule_deviceModels
- Device models that a rule will match.
$sel:deviceOperatingSystems:MobileDeviceAccessRule'
, mobileDeviceAccessRule_deviceOperatingSystems
- Device operating systems that a rule will match.
$sel:deviceTypes:MobileDeviceAccessRule'
, mobileDeviceAccessRule_deviceTypes
- Device types that a rule will match.
$sel:deviceUserAgents:MobileDeviceAccessRule'
, mobileDeviceAccessRule_deviceUserAgents
- Device user agents that a rule will match.
$sel:effect:MobileDeviceAccessRule'
, mobileDeviceAccessRule_effect
- The effect of the rule when it matches. Allowed values are ALLOW
or
DENY
.
$sel:mobileDeviceAccessRuleId:MobileDeviceAccessRule'
, mobileDeviceAccessRule_mobileDeviceAccessRuleId
- The ID assigned to a mobile access rule.
$sel:name:MobileDeviceAccessRule'
, mobileDeviceAccessRule_name
- The name of a mobile access rule.
$sel:notDeviceModels:MobileDeviceAccessRule'
, mobileDeviceAccessRule_notDeviceModels
- Device models that a rule will not match. All other device models
will match.
$sel:notDeviceOperatingSystems:MobileDeviceAccessRule'
, mobileDeviceAccessRule_notDeviceOperatingSystems
- Device operating systems that a rule will not match. All other
device types will match.
$sel:notDeviceTypes:MobileDeviceAccessRule'
, mobileDeviceAccessRule_notDeviceTypes
- Device types that a rule will not match. All other device types will
match.
$sel:notDeviceUserAgents:MobileDeviceAccessRule'
, mobileDeviceAccessRule_notDeviceUserAgents
- Device user agents that a rule will not match. All other device user
agents will match.
OrganizationSummary
data OrganizationSummary Source #
The representation of an organization.
See: newOrganizationSummary
smart constructor.
Instances
newOrganizationSummary :: OrganizationSummary Source #
Create a value of OrganizationSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alias:OrganizationSummary'
, organizationSummary_alias
- The alias associated with the organization.
$sel:defaultMailDomain:OrganizationSummary'
, organizationSummary_defaultMailDomain
- The default email domain associated with the organization.
$sel:errorMessage:OrganizationSummary'
, organizationSummary_errorMessage
- The error message associated with the organization. It is only present
if unexpected behavior has occurred with regards to the organization. It
provides insight or solutions regarding unexpected behavior.
$sel:organizationId:OrganizationSummary'
, organizationSummary_organizationId
- The identifier associated with the organization.
$sel:state:OrganizationSummary'
, organizationSummary_state
- The state associated with the organization.
Permission
data Permission Source #
Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.
See: newPermission
smart constructor.
Constructors
Permission' Text MemberType [PermissionType] |
Instances
Create a value of Permission
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:granteeId:Permission'
, permission_granteeId
- The identifier of the user, group, or resource to which the permissions
are granted.
$sel:granteeType:Permission'
, permission_granteeType
- The type of user, group, or resource referred to in GranteeId.
$sel:permissionValues:Permission'
, permission_permissionValues
- The permissions granted to the grantee. SEND_AS allows the grantee to
send email as the owner of the mailbox (the grantee is not mentioned on
these emails). SEND_ON_BEHALF allows the grantee to send email on behalf
of the owner of the mailbox (the grantee is not mentioned as the
physical sender of these emails). FULL_ACCESS allows the grantee full
access to the mailbox, irrespective of other folder-level permissions
set on the mailbox.
RedactedEwsAvailabilityProvider
data RedactedEwsAvailabilityProvider Source #
Describes an EWS based availability provider when returned from the service. It does not contain the password of the endpoint.
See: newRedactedEwsAvailabilityProvider
smart constructor.
Constructors
RedactedEwsAvailabilityProvider' (Maybe Text) (Maybe Text) |
Instances
newRedactedEwsAvailabilityProvider :: RedactedEwsAvailabilityProvider Source #
Create a value of RedactedEwsAvailabilityProvider
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ewsEndpoint:RedactedEwsAvailabilityProvider'
, redactedEwsAvailabilityProvider_ewsEndpoint
- The endpoint of the remote EWS server.
$sel:ewsUsername:RedactedEwsAvailabilityProvider'
, redactedEwsAvailabilityProvider_ewsUsername
- The username used to authenticate the remote EWS server.
Resource
The representation of a resource.
See: newResource
smart constructor.
Constructors
Resource' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe EntityState) (Maybe ResourceType) |
Instances
newResource :: Resource Source #
Create a value of Resource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:disabledDate:Resource'
, resource_disabledDate
- The date indicating when the resource was disabled from WorkMail use.
$sel:email:Resource'
, resource_email
- The email of the resource.
$sel:enabledDate:Resource'
, resource_enabledDate
- The date indicating when the resource was enabled for WorkMail use.
$sel:id:Resource'
, resource_id
- The identifier of the resource.
$sel:name:Resource'
, resource_name
- The name of the resource.
$sel:state:Resource'
, resource_state
- The state of the resource, which can be ENABLED, DISABLED, or DELETED.
$sel:type':Resource'
, resource_type
- The type of the resource: equipment or room.
Tag
Describes a tag applied to a resource.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.WorkMail.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.WorkMail.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.WorkMail.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.WorkMail.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.WorkMail.Types.Tag" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag'
, tag_key
- The key of the tag.
$sel:value:Tag'
, tag_value
- The value of the tag.
User
The representation of an WorkMail user.
See: newUser
smart constructor.
Constructors
User' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe EntityState) (Maybe UserRole) |
Instances
Create a value of User
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:disabledDate:User'
, user_disabledDate
- The date indicating when the user was disabled from WorkMail use.
$sel:displayName:User'
, user_displayName
- The display name of the user.
$sel:email:User'
, user_email
- The email of the user.
$sel:enabledDate:User'
, user_enabledDate
- The date indicating when the user was enabled for WorkMail use.
$sel:id:User'
, user_id
- The identifier of the user.
$sel:name:User'
, user_name
- The name of the user.
$sel:state:User'
, user_state
- The state of the user, which can be ENABLED, DISABLED, or DELETED.
$sel:userRole:User'
, user_userRole
- The role of the user.