Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- DirectoryUnavailableException
- InvalidParameterException
- UnsupportedOperationException
- DirectoryServiceAuthenticationFailedException
- OrganizationStateException
- EntityStateException
- InvalidConfigurationException
- TooManyTagsException
- MailDomainStateException
- ReservedNameException
- OrganizationNotFoundException
- EntityNotFoundException
- EntityAlreadyRegisteredException
- DirectoryInUseException
- MailDomainInUseException
- MailDomainNotFoundException
- InvalidCustomSesConfigurationException
- ResourceNotFoundException
- EmailAddressInUseException
- NameAvailabilityException
- LimitExceededException
- InvalidPasswordException
- Waiters
- Operations
- DescribeInboundDmarcSettings
- GetMailDomain
- UpdatePrimaryEmailAddress
- DescribeResource
- CreateOrganization
- CreateAlias
- DeleteOrganization
- ResetPassword
- DescribeGroup
- DescribeMailboxExportJob
- ListTagsForResource
- RegisterToWorkMail
- ListAliases (Paginated)
- PutMailboxPermissions
- GetMobileDeviceAccessEffect
- DeleteMailboxPermissions
- ListUsers (Paginated)
- PutInboundDmarcSettings
- GetMailboxDetails
- AssociateMemberToGroup
- DeleteResource
- UpdateResource
- DisassociateMemberFromGroup
- ListResources (Paginated)
- DeregisterFromWorkMail
- ListMailboxExportJobs
- CreateMobileDeviceAccessRule
- ListMailboxPermissions (Paginated)
- GetMobileDeviceAccessOverride
- ListGroupMembers (Paginated)
- DisassociateDelegateFromResource
- DeleteAccessControlRule
- ListResourceDelegates (Paginated)
- ListAccessControlRules
- DescribeUser
- PutAccessControlRule
- StartMailboxExportJob
- DeleteAlias
- ListOrganizations (Paginated)
- AssociateDelegateToResource
- GetAccessControlEffect
- DeleteRetentionPolicy
- CreateUser
- PutRetentionPolicy
- ListMailDomains
- DeleteUser
- TagResource
- RegisterMailDomain
- UpdateDefaultMailDomain
- UpdateMobileDeviceAccessRule
- DeleteMobileDeviceAccessRule
- CreateGroup
- UpdateMailboxQuota
- UntagResource
- ListMobileDeviceAccessRules
- DeleteGroup
- ListGroups (Paginated)
- DescribeOrganization
- CreateResource
- GetDefaultRetentionPolicy
- DeregisterMailDomain
- CancelMailboxExportJob
- ListMobileDeviceAccessOverrides
- DeleteMobileDeviceAccessOverride
- PutMobileDeviceAccessOverride
- Types
- AccessControlRuleEffect
- DnsRecordVerificationStatus
- EntityState
- FolderName
- MailboxExportJobState
- MemberType
- MobileDeviceAccessRuleEffect
- PermissionType
- ResourceType
- RetentionAction
- UserRole
- AccessControlRule
- BookingOptions
- Delegate
- DnsRecord
- Domain
- FolderConfiguration
- Group
- MailDomainSummary
- MailboxExportJob
- Member
- MobileDeviceAccessMatchedRule
- MobileDeviceAccessOverride
- MobileDeviceAccessRule
- OrganizationSummary
- Permission
- Resource
- Tag
- User
Derived from API version 2017-10-01
of the AWS service descriptions, licensed under Apache 2.0.
Amazon 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
- _DirectoryUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _DirectoryServiceAuthenticationFailedException :: AsError a => Getting (First ServiceError) a ServiceError
- _OrganizationStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _EntityStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError
- _MailDomainStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _ReservedNameException :: AsError a => Getting (First ServiceError) a ServiceError
- _OrganizationNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _EntityNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _EntityAlreadyRegisteredException :: AsError a => Getting (First ServiceError) a ServiceError
- _DirectoryInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _MailDomainInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _MailDomainNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidCustomSesConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _EmailAddressInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _NameAvailabilityException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidPasswordException :: AsError a => Getting (First ServiceError) a ServiceError
- data DescribeInboundDmarcSettings = DescribeInboundDmarcSettings' Text
- newDescribeInboundDmarcSettings :: Text -> DescribeInboundDmarcSettings
- data DescribeInboundDmarcSettingsResponse = DescribeInboundDmarcSettingsResponse' (Maybe Bool) Int
- newDescribeInboundDmarcSettingsResponse :: Int -> DescribeInboundDmarcSettingsResponse
- data GetMailDomain = GetMailDomain' Text Text
- newGetMailDomain :: Text -> Text -> GetMailDomain
- data GetMailDomainResponse = GetMailDomainResponse' (Maybe Bool) (Maybe [DnsRecord]) (Maybe DnsRecordVerificationStatus) (Maybe DnsRecordVerificationStatus) (Maybe Bool) Int
- newGetMailDomainResponse :: Int -> GetMailDomainResponse
- data UpdatePrimaryEmailAddress = UpdatePrimaryEmailAddress' Text Text Text
- newUpdatePrimaryEmailAddress :: Text -> Text -> Text -> UpdatePrimaryEmailAddress
- data UpdatePrimaryEmailAddressResponse = UpdatePrimaryEmailAddressResponse' Int
- newUpdatePrimaryEmailAddressResponse :: Int -> UpdatePrimaryEmailAddressResponse
- data DescribeResource = DescribeResource' Text Text
- newDescribeResource :: Text -> Text -> DescribeResource
- data DescribeResourceResponse = DescribeResourceResponse' (Maybe Text) (Maybe EntityState) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ResourceType) (Maybe POSIX) (Maybe BookingOptions) Int
- newDescribeResourceResponse :: Int -> DescribeResourceResponse
- data CreateOrganization = CreateOrganization' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Domain]) Text
- newCreateOrganization :: Text -> CreateOrganization
- data CreateOrganizationResponse = CreateOrganizationResponse' (Maybe Text) Int
- newCreateOrganizationResponse :: Int -> CreateOrganizationResponse
- data CreateAlias = CreateAlias' Text Text Text
- newCreateAlias :: Text -> Text -> Text -> CreateAlias
- data CreateAliasResponse = CreateAliasResponse' Int
- newCreateAliasResponse :: Int -> CreateAliasResponse
- data DeleteOrganization = DeleteOrganization' (Maybe Text) Text Bool
- newDeleteOrganization :: Text -> Bool -> DeleteOrganization
- data DeleteOrganizationResponse = DeleteOrganizationResponse' (Maybe Text) (Maybe Text) Int
- newDeleteOrganizationResponse :: Int -> DeleteOrganizationResponse
- data ResetPassword = ResetPassword' Text Text (Sensitive Text)
- newResetPassword :: Text -> Text -> Text -> ResetPassword
- data ResetPasswordResponse = ResetPasswordResponse' Int
- newResetPasswordResponse :: Int -> ResetPasswordResponse
- data DescribeGroup = DescribeGroup' Text Text
- newDescribeGroup :: Text -> Text -> DescribeGroup
- data DescribeGroupResponse = DescribeGroupResponse' (Maybe Text) (Maybe EntityState) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) Int
- newDescribeGroupResponse :: Int -> DescribeGroupResponse
- data DescribeMailboxExportJob = DescribeMailboxExportJob' Text Text
- newDescribeMailboxExportJob :: Text -> Text -> DescribeMailboxExportJob
- data DescribeMailboxExportJobResponse = DescribeMailboxExportJobResponse' (Maybe MailboxExportJobState) (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDescribeMailboxExportJobResponse :: Int -> DescribeMailboxExportJobResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data RegisterToWorkMail = RegisterToWorkMail' Text Text Text
- newRegisterToWorkMail :: Text -> Text -> Text -> RegisterToWorkMail
- data RegisterToWorkMailResponse = RegisterToWorkMailResponse' Int
- newRegisterToWorkMailResponse :: Int -> RegisterToWorkMailResponse
- data ListAliases = ListAliases' (Maybe Text) (Maybe Natural) Text Text
- newListAliases :: Text -> Text -> ListAliases
- data ListAliasesResponse = ListAliasesResponse' (Maybe [Text]) (Maybe Text) Int
- newListAliasesResponse :: Int -> ListAliasesResponse
- data PutMailboxPermissions = PutMailboxPermissions' Text Text Text [PermissionType]
- newPutMailboxPermissions :: Text -> Text -> Text -> PutMailboxPermissions
- data PutMailboxPermissionsResponse = PutMailboxPermissionsResponse' Int
- newPutMailboxPermissionsResponse :: Int -> PutMailboxPermissionsResponse
- 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 DeleteMailboxPermissions = DeleteMailboxPermissions' Text Text Text
- newDeleteMailboxPermissions :: Text -> Text -> Text -> DeleteMailboxPermissions
- data DeleteMailboxPermissionsResponse = DeleteMailboxPermissionsResponse' Int
- newDeleteMailboxPermissionsResponse :: Int -> DeleteMailboxPermissionsResponse
- data ListUsers = ListUsers' (Maybe Text) (Maybe Natural) Text
- newListUsers :: Text -> ListUsers
- data ListUsersResponse = ListUsersResponse' (Maybe [User]) (Maybe Text) Int
- newListUsersResponse :: Int -> ListUsersResponse
- data PutInboundDmarcSettings = PutInboundDmarcSettings' Text Bool
- newPutInboundDmarcSettings :: Text -> Bool -> PutInboundDmarcSettings
- data PutInboundDmarcSettingsResponse = PutInboundDmarcSettingsResponse' Int
- newPutInboundDmarcSettingsResponse :: Int -> PutInboundDmarcSettingsResponse
- data GetMailboxDetails = GetMailboxDetails' Text Text
- newGetMailboxDetails :: Text -> Text -> GetMailboxDetails
- data GetMailboxDetailsResponse = GetMailboxDetailsResponse' (Maybe Natural) (Maybe Double) Int
- newGetMailboxDetailsResponse :: Int -> GetMailboxDetailsResponse
- data AssociateMemberToGroup = AssociateMemberToGroup' Text Text Text
- newAssociateMemberToGroup :: Text -> Text -> Text -> AssociateMemberToGroup
- data AssociateMemberToGroupResponse = AssociateMemberToGroupResponse' Int
- newAssociateMemberToGroupResponse :: Int -> AssociateMemberToGroupResponse
- data DeleteResource = DeleteResource' Text Text
- newDeleteResource :: Text -> Text -> DeleteResource
- data DeleteResourceResponse = DeleteResourceResponse' Int
- newDeleteResourceResponse :: Int -> DeleteResourceResponse
- data UpdateResource = UpdateResource' (Maybe Text) (Maybe BookingOptions) Text Text
- newUpdateResource :: Text -> Text -> UpdateResource
- data UpdateResourceResponse = UpdateResourceResponse' Int
- newUpdateResourceResponse :: Int -> UpdateResourceResponse
- data DisassociateMemberFromGroup = DisassociateMemberFromGroup' Text Text Text
- newDisassociateMemberFromGroup :: Text -> Text -> Text -> DisassociateMemberFromGroup
- data DisassociateMemberFromGroupResponse = DisassociateMemberFromGroupResponse' Int
- newDisassociateMemberFromGroupResponse :: Int -> DisassociateMemberFromGroupResponse
- data ListResources = ListResources' (Maybe Text) (Maybe Natural) Text
- newListResources :: Text -> ListResources
- data ListResourcesResponse = ListResourcesResponse' (Maybe [Resource]) (Maybe Text) Int
- newListResourcesResponse :: Int -> ListResourcesResponse
- data DeregisterFromWorkMail = DeregisterFromWorkMail' Text Text
- newDeregisterFromWorkMail :: Text -> Text -> DeregisterFromWorkMail
- data DeregisterFromWorkMailResponse = DeregisterFromWorkMailResponse' Int
- newDeregisterFromWorkMailResponse :: Int -> DeregisterFromWorkMailResponse
- data ListMailboxExportJobs = ListMailboxExportJobs' (Maybe Text) (Maybe Natural) Text
- newListMailboxExportJobs :: Text -> ListMailboxExportJobs
- data ListMailboxExportJobsResponse = ListMailboxExportJobsResponse' (Maybe Text) (Maybe [MailboxExportJob]) Int
- newListMailboxExportJobsResponse :: Int -> ListMailboxExportJobsResponse
- data CreateMobileDeviceAccessRule = CreateMobileDeviceAccessRule' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe 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 ListMailboxPermissions = ListMailboxPermissions' (Maybe Text) (Maybe Natural) Text Text
- newListMailboxPermissions :: Text -> Text -> ListMailboxPermissions
- data ListMailboxPermissionsResponse = ListMailboxPermissionsResponse' (Maybe Text) (Maybe [Permission]) Int
- newListMailboxPermissionsResponse :: Int -> ListMailboxPermissionsResponse
- data GetMobileDeviceAccessOverride = GetMobileDeviceAccessOverride' Text Text Text
- newGetMobileDeviceAccessOverride :: Text -> Text -> Text -> GetMobileDeviceAccessOverride
- data GetMobileDeviceAccessOverrideResponse = GetMobileDeviceAccessOverrideResponse' (Maybe MobileDeviceAccessRuleEffect) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) Int
- newGetMobileDeviceAccessOverrideResponse :: Int -> GetMobileDeviceAccessOverrideResponse
- data ListGroupMembers = ListGroupMembers' (Maybe Text) (Maybe Natural) Text Text
- newListGroupMembers :: Text -> Text -> ListGroupMembers
- data ListGroupMembersResponse = ListGroupMembersResponse' (Maybe [Member]) (Maybe Text) Int
- newListGroupMembersResponse :: Int -> ListGroupMembersResponse
- data DisassociateDelegateFromResource = DisassociateDelegateFromResource' Text Text Text
- newDisassociateDelegateFromResource :: Text -> Text -> Text -> DisassociateDelegateFromResource
- data DisassociateDelegateFromResourceResponse = DisassociateDelegateFromResourceResponse' Int
- newDisassociateDelegateFromResourceResponse :: Int -> DisassociateDelegateFromResourceResponse
- data DeleteAccessControlRule = DeleteAccessControlRule' Text Text
- newDeleteAccessControlRule :: Text -> Text -> DeleteAccessControlRule
- data DeleteAccessControlRuleResponse = DeleteAccessControlRuleResponse' Int
- newDeleteAccessControlRuleResponse :: Int -> DeleteAccessControlRuleResponse
- data ListResourceDelegates = ListResourceDelegates' (Maybe Text) (Maybe Natural) Text Text
- newListResourceDelegates :: Text -> Text -> ListResourceDelegates
- data ListResourceDelegatesResponse = ListResourceDelegatesResponse' (Maybe [Delegate]) (Maybe Text) Int
- newListResourceDelegatesResponse :: Int -> ListResourceDelegatesResponse
- data ListAccessControlRules = ListAccessControlRules' Text
- newListAccessControlRules :: Text -> ListAccessControlRules
- data ListAccessControlRulesResponse = ListAccessControlRulesResponse' (Maybe [AccessControlRule]) Int
- newListAccessControlRulesResponse :: Int -> ListAccessControlRulesResponse
- data DescribeUser = DescribeUser' Text Text
- newDescribeUser :: Text -> Text -> DescribeUser
- data DescribeUserResponse = DescribeUserResponse' (Maybe Text) (Maybe EntityState) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe UserRole) (Maybe POSIX) Int
- newDescribeUserResponse :: Int -> DescribeUserResponse
- data PutAccessControlRule = PutAccessControlRule' (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 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 DeleteAlias = DeleteAlias' Text Text Text
- newDeleteAlias :: Text -> Text -> Text -> DeleteAlias
- data DeleteAliasResponse = DeleteAliasResponse' Int
- newDeleteAliasResponse :: Int -> DeleteAliasResponse
- data ListOrganizations = ListOrganizations' (Maybe Text) (Maybe Natural)
- newListOrganizations :: ListOrganizations
- data ListOrganizationsResponse = ListOrganizationsResponse' (Maybe Text) (Maybe [OrganizationSummary]) Int
- newListOrganizationsResponse :: Int -> ListOrganizationsResponse
- data AssociateDelegateToResource = AssociateDelegateToResource' Text Text Text
- newAssociateDelegateToResource :: Text -> Text -> Text -> AssociateDelegateToResource
- data AssociateDelegateToResourceResponse = AssociateDelegateToResourceResponse' Int
- newAssociateDelegateToResourceResponse :: Int -> AssociateDelegateToResourceResponse
- data GetAccessControlEffect = GetAccessControlEffect' Text Text Text Text
- newGetAccessControlEffect :: Text -> Text -> Text -> Text -> GetAccessControlEffect
- data GetAccessControlEffectResponse = GetAccessControlEffectResponse' (Maybe AccessControlRuleEffect) (Maybe [Text]) Int
- newGetAccessControlEffectResponse :: Int -> GetAccessControlEffectResponse
- data DeleteRetentionPolicy = DeleteRetentionPolicy' Text Text
- newDeleteRetentionPolicy :: Text -> Text -> DeleteRetentionPolicy
- data DeleteRetentionPolicyResponse = DeleteRetentionPolicyResponse' Int
- newDeleteRetentionPolicyResponse :: Int -> DeleteRetentionPolicyResponse
- data CreateUser = CreateUser' Text Text Text (Sensitive Text)
- newCreateUser :: Text -> Text -> Text -> Text -> CreateUser
- data CreateUserResponse = CreateUserResponse' (Maybe Text) Int
- newCreateUserResponse :: Int -> CreateUserResponse
- data PutRetentionPolicy = PutRetentionPolicy' (Maybe Text) (Maybe (Sensitive Text)) Text Text [FolderConfiguration]
- newPutRetentionPolicy :: Text -> Text -> PutRetentionPolicy
- data PutRetentionPolicyResponse = PutRetentionPolicyResponse' Int
- newPutRetentionPolicyResponse :: Int -> PutRetentionPolicyResponse
- data ListMailDomains = ListMailDomains' (Maybe Text) (Maybe Natural) Text
- newListMailDomains :: Text -> ListMailDomains
- data ListMailDomainsResponse = ListMailDomainsResponse' (Maybe Text) (Maybe [MailDomainSummary]) Int
- newListMailDomainsResponse :: Int -> ListMailDomainsResponse
- data DeleteUser = DeleteUser' Text Text
- newDeleteUser :: Text -> Text -> DeleteUser
- data DeleteUserResponse = DeleteUserResponse' Int
- newDeleteUserResponse :: Int -> DeleteUserResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data RegisterMailDomain = RegisterMailDomain' (Maybe Text) Text Text
- newRegisterMailDomain :: Text -> Text -> RegisterMailDomain
- data RegisterMailDomainResponse = RegisterMailDomainResponse' Int
- newRegisterMailDomainResponse :: Int -> RegisterMailDomainResponse
- data UpdateDefaultMailDomain = UpdateDefaultMailDomain' Text Text
- newUpdateDefaultMailDomain :: Text -> Text -> UpdateDefaultMailDomain
- data UpdateDefaultMailDomainResponse = UpdateDefaultMailDomainResponse' Int
- newUpdateDefaultMailDomainResponse :: Int -> UpdateDefaultMailDomainResponse
- data UpdateMobileDeviceAccessRule = UpdateMobileDeviceAccessRule' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe 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 DeleteMobileDeviceAccessRule = DeleteMobileDeviceAccessRule' Text Text
- newDeleteMobileDeviceAccessRule :: Text -> Text -> DeleteMobileDeviceAccessRule
- data DeleteMobileDeviceAccessRuleResponse = DeleteMobileDeviceAccessRuleResponse' Int
- newDeleteMobileDeviceAccessRuleResponse :: Int -> DeleteMobileDeviceAccessRuleResponse
- data CreateGroup = CreateGroup' Text Text
- newCreateGroup :: Text -> Text -> CreateGroup
- data CreateGroupResponse = CreateGroupResponse' (Maybe Text) Int
- newCreateGroupResponse :: Int -> CreateGroupResponse
- data UpdateMailboxQuota = UpdateMailboxQuota' Text Text Natural
- newUpdateMailboxQuota :: Text -> Text -> Natural -> UpdateMailboxQuota
- data UpdateMailboxQuotaResponse = UpdateMailboxQuotaResponse' Int
- newUpdateMailboxQuotaResponse :: Int -> UpdateMailboxQuotaResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data ListMobileDeviceAccessRules = ListMobileDeviceAccessRules' Text
- newListMobileDeviceAccessRules :: Text -> ListMobileDeviceAccessRules
- data ListMobileDeviceAccessRulesResponse = ListMobileDeviceAccessRulesResponse' (Maybe [MobileDeviceAccessRule]) Int
- newListMobileDeviceAccessRulesResponse :: Int -> ListMobileDeviceAccessRulesResponse
- data DeleteGroup = DeleteGroup' Text Text
- newDeleteGroup :: Text -> Text -> DeleteGroup
- data DeleteGroupResponse = DeleteGroupResponse' Int
- newDeleteGroupResponse :: Int -> DeleteGroupResponse
- data ListGroups = ListGroups' (Maybe Text) (Maybe Natural) Text
- newListGroups :: Text -> ListGroups
- data ListGroupsResponse = ListGroupsResponse' (Maybe [Group]) (Maybe Text) Int
- newListGroupsResponse :: Int -> ListGroupsResponse
- data DescribeOrganization = DescribeOrganization' Text
- newDescribeOrganization :: Text -> DescribeOrganization
- data DescribeOrganizationResponse = DescribeOrganizationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDescribeOrganizationResponse :: Int -> DescribeOrganizationResponse
- data CreateResource = CreateResource' Text Text ResourceType
- newCreateResource :: Text -> Text -> ResourceType -> CreateResource
- data CreateResourceResponse = CreateResourceResponse' (Maybe Text) Int
- newCreateResourceResponse :: Int -> CreateResourceResponse
- data GetDefaultRetentionPolicy = GetDefaultRetentionPolicy' Text
- newGetDefaultRetentionPolicy :: Text -> GetDefaultRetentionPolicy
- data GetDefaultRetentionPolicyResponse = GetDefaultRetentionPolicyResponse' (Maybe Text) (Maybe Text) (Maybe [FolderConfiguration]) (Maybe Text) Int
- newGetDefaultRetentionPolicyResponse :: Int -> GetDefaultRetentionPolicyResponse
- data DeregisterMailDomain = DeregisterMailDomain' Text Text
- newDeregisterMailDomain :: Text -> Text -> DeregisterMailDomain
- data DeregisterMailDomainResponse = DeregisterMailDomainResponse' Int
- newDeregisterMailDomainResponse :: Int -> DeregisterMailDomainResponse
- data CancelMailboxExportJob = CancelMailboxExportJob' Text Text Text
- newCancelMailboxExportJob :: Text -> Text -> Text -> CancelMailboxExportJob
- data CancelMailboxExportJobResponse = CancelMailboxExportJobResponse' Int
- newCancelMailboxExportJobResponse :: Int -> CancelMailboxExportJobResponse
- data ListMobileDeviceAccessOverrides = ListMobileDeviceAccessOverrides' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) Text
- newListMobileDeviceAccessOverrides :: Text -> ListMobileDeviceAccessOverrides
- data ListMobileDeviceAccessOverridesResponse = ListMobileDeviceAccessOverridesResponse' (Maybe [MobileDeviceAccessOverride]) (Maybe Text) Int
- newListMobileDeviceAccessOverridesResponse :: Int -> ListMobileDeviceAccessOverridesResponse
- data DeleteMobileDeviceAccessOverride = DeleteMobileDeviceAccessOverride' Text Text Text
- newDeleteMobileDeviceAccessOverride :: Text -> Text -> Text -> DeleteMobileDeviceAccessOverride
- data DeleteMobileDeviceAccessOverrideResponse = DeleteMobileDeviceAccessOverrideResponse' Int
- newDeleteMobileDeviceAccessOverrideResponse :: Int -> DeleteMobileDeviceAccessOverrideResponse
- data PutMobileDeviceAccessOverride = PutMobileDeviceAccessOverride' (Maybe Text) Text Text Text MobileDeviceAccessRuleEffect
- newPutMobileDeviceAccessOverride :: Text -> Text -> Text -> MobileDeviceAccessRuleEffect -> PutMobileDeviceAccessOverride
- data PutMobileDeviceAccessOverrideResponse = PutMobileDeviceAccessOverrideResponse' Int
- newPutMobileDeviceAccessOverrideResponse :: Int -> PutMobileDeviceAccessOverrideResponse
- newtype AccessControlRuleEffect 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 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 AccessControlRuleEffect) (Maybe [Text]) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe POSIX) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe Text)
- newAccessControlRule :: AccessControlRule
- 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 FolderConfiguration = FolderConfiguration' (Maybe Natural) FolderName RetentionAction
- newFolderConfiguration :: FolderName -> RetentionAction -> FolderConfiguration
- data Group = Group' (Maybe Text) (Maybe EntityState) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newGroup :: Group
- data MailDomainSummary = MailDomainSummary' (Maybe Bool) (Maybe Text)
- newMailDomainSummary :: MailDomainSummary
- data MailboxExportJob = MailboxExportJob' (Maybe MailboxExportJobState) (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newMailboxExportJob :: MailboxExportJob
- data Member = Member' (Maybe EntityState) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe MemberType) (Maybe POSIX)
- newMember :: Member
- data MobileDeviceAccessMatchedRule = MobileDeviceAccessMatchedRule' (Maybe Text) (Maybe Text)
- newMobileDeviceAccessMatchedRule :: MobileDeviceAccessMatchedRule
- data MobileDeviceAccessOverride = MobileDeviceAccessOverride' (Maybe MobileDeviceAccessRuleEffect) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newMobileDeviceAccessOverride :: MobileDeviceAccessOverride
- data MobileDeviceAccessRule = MobileDeviceAccessRule' (Maybe MobileDeviceAccessRuleEffect) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe 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 Resource = Resource' (Maybe Text) (Maybe EntityState) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ResourceType) (Maybe POSIX)
- newResource :: Resource
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data User = User' (Maybe Text) (Maybe EntityState) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserRole) (Maybe POSIX)
- 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
.
DirectoryUnavailableException
_DirectoryUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The directory is unavailable. It might be located in another Region or deleted.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more of the input parameters don't match the service's restrictions.
UnsupportedOperationException
_UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't perform a write operation against a read-only directory.
DirectoryServiceAuthenticationFailedException
_DirectoryServiceAuthenticationFailedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The directory service doesn't recognize the credentials supplied by WorkMail.
OrganizationStateException
_OrganizationStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The organization must have a valid state to perform certain operations on the organization or its members.
EntityStateException
_EntityStateException :: AsError a => Getting (First ServiceError) 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 => Getting (First ServiceError) 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.
TooManyTagsException
_TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource can have up to 50 user-applied tags.
MailDomainStateException
_MailDomainStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
After a domain has been added to the organization, it must be verified. The domain is not yet verified.
ReservedNameException
_ReservedNameException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This user, group, or resource name is not allowed in Amazon WorkMail.
OrganizationNotFoundException
_OrganizationNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An operation received a valid organization identifier that either doesn't belong or exist in the system.
EntityNotFoundException
_EntityNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The identifier supplied for the user, group, or resource does not exist in your organization.
EntityAlreadyRegisteredException
_EntityAlreadyRegisteredException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user, group, or resource that you're trying to register is already registered.
DirectoryInUseException
_DirectoryInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The directory is already in use by another WorkMail organization in the same account and Region.
MailDomainInUseException
_MailDomainInUseException :: AsError a => Getting (First ServiceError) 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 => Getting (First ServiceError) a ServiceError Source #
The domain specified is not found in your organization.
InvalidCustomSesConfigurationException
_InvalidCustomSesConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You SES configuration has customizations that Amazon WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource cannot be found.
EmailAddressInUseException
_EmailAddressInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The email address that you're trying to assign is already created for a different user, group, or resource.
NameAvailabilityException
_NameAvailabilityException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user, group, or resource name isn't unique in Amazon WorkMail.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request exceeds the limit of the resource.
InvalidPasswordException
_InvalidPasswordException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The supplied password doesn't match the minimum security constraints, such as length or use of special characters.
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.
DescribeInboundDmarcSettings
data DescribeInboundDmarcSettings Source #
See: newDescribeInboundDmarcSettings
smart constructor.
Instances
newDescribeInboundDmarcSettings Source #
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:
$sel:organizationId:DescribeInboundDmarcSettings'
, describeInboundDmarcSettings_organizationId
- Lists the ID of the given organization.
data DescribeInboundDmarcSettingsResponse Source #
See: newDescribeInboundDmarcSettingsResponse
smart constructor.
Instances
newDescribeInboundDmarcSettingsResponse Source #
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.
GetMailDomain
data GetMailDomain Source #
See: newGetMailDomain
smart constructor.
Instances
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:
$sel:organizationId:GetMailDomain'
, getMailDomain_organizationId
- The Amazon WorkMail organization for which the domain is retrieved.
$sel:domainName:GetMailDomain'
, getMailDomain_domainName
- The domain from which you want to retrieve details.
data GetMailDomainResponse Source #
See: newGetMailDomainResponse
smart constructor.
GetMailDomainResponse' (Maybe Bool) (Maybe [DnsRecord]) (Maybe DnsRecordVerificationStatus) (Maybe DnsRecordVerificationStatus) (Maybe Bool) 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:isTestDomain:GetMailDomainResponse'
, getMailDomainResponse_isTestDomain
- Specifies whether the domain is a test domain provided by WorkMail, or a
custom domain.
$sel:records:GetMailDomainResponse'
, getMailDomainResponse_records
- A list of the DNS records that Amazon 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:ownershipVerificationStatus:GetMailDomainResponse'
, getMailDomainResponse_ownershipVerificationStatus
- Indicates the status of the domain ownership verification.
$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:httpStatus:GetMailDomainResponse'
, getMailDomainResponse_httpStatus
- The response's http status code.
UpdatePrimaryEmailAddress
data UpdatePrimaryEmailAddress Source #
See: newUpdatePrimaryEmailAddress
smart constructor.
Instances
newUpdatePrimaryEmailAddress Source #
:: 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:
$sel:organizationId:UpdatePrimaryEmailAddress'
, updatePrimaryEmailAddress_organizationId
- The organization that contains the user, group, or resource to update.
$sel:entityId:UpdatePrimaryEmailAddress'
, updatePrimaryEmailAddress_entityId
- The user, group, or resource to update.
$sel:email:UpdatePrimaryEmailAddress'
, updatePrimaryEmailAddress_email
- The value of the email to be updated as primary.
data UpdatePrimaryEmailAddressResponse Source #
See: newUpdatePrimaryEmailAddressResponse
smart constructor.
Instances
Eq UpdatePrimaryEmailAddressResponse Source # | |
Read UpdatePrimaryEmailAddressResponse Source # | |
Show UpdatePrimaryEmailAddressResponse Source # | |
Generic UpdatePrimaryEmailAddressResponse Source # | |
NFData UpdatePrimaryEmailAddressResponse Source # | |
Defined in Amazonka.WorkMail.UpdatePrimaryEmailAddress rnf :: UpdatePrimaryEmailAddressResponse -> () # | |
type Rep UpdatePrimaryEmailAddressResponse Source # | |
Defined in Amazonka.WorkMail.UpdatePrimaryEmailAddress type Rep UpdatePrimaryEmailAddressResponse = D1 ('MetaData "UpdatePrimaryEmailAddressResponse" "Amazonka.WorkMail.UpdatePrimaryEmailAddress" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "UpdatePrimaryEmailAddressResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdatePrimaryEmailAddressResponse Source #
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.
DescribeResource
data DescribeResource Source #
See: newDescribeResource
smart constructor.
Instances
:: 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:
$sel:organizationId:DescribeResource'
, describeResource_organizationId
- The identifier associated with the organization for which the resource
is described.
$sel:resourceId:DescribeResource'
, describeResource_resourceId
- The identifier of the resource to be described.
data DescribeResourceResponse Source #
See: newDescribeResourceResponse
smart constructor.
DescribeResourceResponse' (Maybe Text) (Maybe EntityState) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ResourceType) (Maybe POSIX) (Maybe BookingOptions) 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:email:DescribeResourceResponse'
, describeResourceResponse_email
- The email of the described resource.
$sel:state:DescribeResourceResponse'
, describeResourceResponse_state
- The state of the resource: enabled (registered to Amazon WorkMail),
disabled (deregistered or never registered to WorkMail), or deleted.
$sel:resourceId:DescribeResource'
, describeResourceResponse_resourceId
- The identifier of the described resource.
$sel:disabledDate:DescribeResourceResponse'
, describeResourceResponse_disabledDate
- The date and time when a resource was disabled from WorkMail, in UNIX
epoch time format.
$sel:name:DescribeResourceResponse'
, describeResourceResponse_name
- The name of the described resource.
$sel:type':DescribeResourceResponse'
, describeResourceResponse_type
- The type of the described resource.
$sel:enabledDate:DescribeResourceResponse'
, describeResourceResponse_enabledDate
- The date and time when a resource was enabled for WorkMail, in UNIX
epoch time format.
$sel:bookingOptions:DescribeResourceResponse'
, describeResourceResponse_bookingOptions
- The booking options for the described resource.
$sel:httpStatus:DescribeResourceResponse'
, describeResourceResponse_httpStatus
- The response's http status code.
CreateOrganization
data CreateOrganization Source #
See: newCreateOrganization
smart constructor.
Instances
newCreateOrganization Source #
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:directoryId:CreateOrganization'
, createOrganization_directoryId
- The AWS Directory Service directory ID.
$sel:enableInteroperability:CreateOrganization'
, createOrganization_enableInteroperability
- When true
, allows organization interoperability between Amazon
WorkMail and Microsoft Exchange. Can only be set to true
if an AD
Connector directory ID is included in the request.
$sel:kmsKeyArn:CreateOrganization'
, createOrganization_kmsKeyArn
- The Amazon Resource Name (ARN) of a customer managed master key from AWS
KMS.
$sel:clientToken:CreateOrganization'
, createOrganization_clientToken
- The idempotency token associated with the request.
$sel:domains:CreateOrganization'
, createOrganization_domains
- The email domains to associate with the organization.
$sel:alias:CreateOrganization'
, createOrganization_alias
- The organization alias.
data CreateOrganizationResponse Source #
See: newCreateOrganizationResponse
smart constructor.
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:
$sel:organizationId:CreateOrganizationResponse'
, createOrganizationResponse_organizationId
- The organization ID.
$sel:httpStatus:CreateOrganizationResponse'
, createOrganizationResponse_httpStatus
- The response's http status code.
CreateAlias
data CreateAlias Source #
See: newCreateAlias
smart constructor.
Instances
:: 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:
$sel:organizationId:CreateAlias'
, createAlias_organizationId
- The organization under which the member (user or group) exists.
$sel:entityId:CreateAlias'
, createAlias_entityId
- The member (user or group) to which this alias is added.
$sel:alias:CreateAlias'
, createAlias_alias
- The alias to add to the member set.
data CreateAliasResponse Source #
See: newCreateAliasResponse
smart constructor.
Instances
newCreateAliasResponse Source #
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.
DeleteOrganization
data DeleteOrganization Source #
See: newDeleteOrganization
smart constructor.
Instances
newDeleteOrganization Source #
:: 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.
$sel:organizationId: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:
$sel:state:DeleteOrganizationResponse'
, deleteOrganizationResponse_state
- The state of the organization.
$sel:organizationId:DeleteOrganization'
, deleteOrganizationResponse_organizationId
- The organization ID.
$sel:httpStatus:DeleteOrganizationResponse'
, deleteOrganizationResponse_httpStatus
- The response's http status code.
ResetPassword
data ResetPassword Source #
See: newResetPassword
smart constructor.
Instances
:: 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:
$sel:organizationId:ResetPassword'
, resetPassword_organizationId
- The identifier of the organization that contains the user for which the
password is reset.
$sel:userId: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.
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.
DescribeGroup
data DescribeGroup Source #
See: newDescribeGroup
smart constructor.
Instances
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:
$sel:organizationId:DescribeGroup'
, describeGroup_organizationId
- The identifier for the organization under which the group exists.
$sel:groupId:DescribeGroup'
, describeGroup_groupId
- The identifier for the group to be described.
data DescribeGroupResponse Source #
See: newDescribeGroupResponse
smart constructor.
DescribeGroupResponse' (Maybe Text) (Maybe EntityState) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) 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:
$sel:email:DescribeGroupResponse'
, describeGroupResponse_email
- The email of the described group.
$sel:state:DescribeGroupResponse'
, describeGroupResponse_state
- The state of the user: enabled (registered to Amazon WorkMail) or
disabled (deregistered or never registered to WorkMail).
$sel:disabledDate:DescribeGroupResponse'
, describeGroupResponse_disabledDate
- The date and time when a user was deregistered from WorkMail, in UNIX
epoch time format.
$sel:name:DescribeGroupResponse'
, describeGroupResponse_name
- The name of the described group.
$sel:groupId:DescribeGroup'
, describeGroupResponse_groupId
- The identifier of the described group.
$sel:enabledDate:DescribeGroupResponse'
, describeGroupResponse_enabledDate
- The date and time when a user was registered to WorkMail, in UNIX epoch
time format.
$sel:httpStatus:DescribeGroupResponse'
, describeGroupResponse_httpStatus
- The response's http status code.
DescribeMailboxExportJob
data DescribeMailboxExportJob Source #
See: newDescribeMailboxExportJob
smart constructor.
Instances
newDescribeMailboxExportJob Source #
:: Text | |
-> Text | |
-> DescribeMailboxExportJob |
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:
$sel:jobId:DescribeMailboxExportJob'
, describeMailboxExportJob_jobId
- The mailbox export job ID.
$sel:organizationId:DescribeMailboxExportJob'
, describeMailboxExportJob_organizationId
- The organization ID.
data DescribeMailboxExportJobResponse Source #
See: newDescribeMailboxExportJobResponse
smart constructor.
DescribeMailboxExportJobResponse' (Maybe MailboxExportJobState) (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) 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:
$sel:state:DescribeMailboxExportJobResponse'
, describeMailboxExportJobResponse_state
- The state of the mailbox export job.
$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:startTime:DescribeMailboxExportJobResponse'
, describeMailboxExportJobResponse_startTime
- The mailbox export job start timestamp.
$sel:estimatedProgress:DescribeMailboxExportJobResponse'
, describeMailboxExportJobResponse_estimatedProgress
- The estimated progress of the mailbox export job, in percentage points.
$sel:endTime:DescribeMailboxExportJobResponse'
, describeMailboxExportJobResponse_endTime
- The mailbox export job end timestamp.
$sel:s3Path: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.
$sel:entityId:DescribeMailboxExportJobResponse'
, describeMailboxExportJobResponse_entityId
- The identifier of the user or resource associated with the mailbox.
$sel:description:DescribeMailboxExportJobResponse'
, describeMailboxExportJobResponse_description
- The mailbox export job description.
$sel:errorInfo:DescribeMailboxExportJobResponse'
, describeMailboxExportJobResponse_errorInfo
- Error information for failed mailbox export jobs.
$sel:s3BucketName:DescribeMailboxExportJobResponse'
, describeMailboxExportJobResponse_s3BucketName
- The name of the S3 bucket.
$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.
$sel:httpStatus:DescribeMailboxExportJobResponse'
, describeMailboxExportJobResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
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.
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.
RegisterToWorkMail
data RegisterToWorkMail Source #
See: newRegisterToWorkMail
smart constructor.
Instances
newRegisterToWorkMail Source #
:: 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:
$sel:organizationId:RegisterToWorkMail'
, registerToWorkMail_organizationId
- The identifier for the organization under which the user, group, or
resource exists.
$sel:entityId:RegisterToWorkMail'
, registerToWorkMail_entityId
- The identifier for the user, group, or resource to be updated.
$sel:email:RegisterToWorkMail'
, registerToWorkMail_email
- The email for the user, group, or resource to be updated.
data RegisterToWorkMailResponse Source #
See: newRegisterToWorkMailResponse
smart constructor.
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.
ListAliases (Paginated)
data ListAliases Source #
See: newListAliases
smart constructor.
Instances
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:nextToken:ListAliases'
, listAliases_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
$sel:maxResults:ListAliases'
, listAliases_maxResults
- The maximum number of results to return in a single call.
$sel:organizationId:ListAliases'
, listAliases_organizationId
- The identifier for the organization under which the entity exists.
$sel:entityId:ListAliases'
, listAliases_entityId
- The identifier for the entity for which to list the aliases.
data ListAliasesResponse Source #
See: newListAliasesResponse
smart constructor.
Instances
newListAliasesResponse Source #
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.
$sel:nextToken: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.
PutMailboxPermissions
data PutMailboxPermissions Source #
See: newPutMailboxPermissions
smart constructor.
Instances
newPutMailboxPermissions Source #
:: 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:
$sel:organizationId:PutMailboxPermissions'
, putMailboxPermissions_organizationId
- The identifier of the organization under which the user, group, or
resource exists.
$sel:entityId:PutMailboxPermissions'
, putMailboxPermissions_entityId
- The identifier of the user, group, or resource for which to update
mailbox permissions.
$sel:granteeId:PutMailboxPermissions'
, putMailboxPermissions_granteeId
- The identifier of the user, group, or resource to which to grant the
permissions.
$sel:permissionValues: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.
Instances
Eq PutMailboxPermissionsResponse Source # | |
Read PutMailboxPermissionsResponse Source # | |
Show PutMailboxPermissionsResponse Source # | |
Defined in Amazonka.WorkMail.PutMailboxPermissions showsPrec :: Int -> PutMailboxPermissionsResponse -> ShowS # show :: PutMailboxPermissionsResponse -> String # showList :: [PutMailboxPermissionsResponse] -> ShowS # | |
Generic PutMailboxPermissionsResponse Source # | |
NFData PutMailboxPermissionsResponse Source # | |
Defined in Amazonka.WorkMail.PutMailboxPermissions rnf :: PutMailboxPermissionsResponse -> () # | |
type Rep PutMailboxPermissionsResponse Source # | |
Defined in Amazonka.WorkMail.PutMailboxPermissions type Rep PutMailboxPermissionsResponse = D1 ('MetaData "PutMailboxPermissionsResponse" "Amazonka.WorkMail.PutMailboxPermissions" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "PutMailboxPermissionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
GetMobileDeviceAccessEffect
data GetMobileDeviceAccessEffect Source #
See: newGetMobileDeviceAccessEffect
smart constructor.
Instances
newGetMobileDeviceAccessEffect Source #
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:deviceOperatingSystem:GetMobileDeviceAccessEffect'
, getMobileDeviceAccessEffect_deviceOperatingSystem
- Device operating system the simulated user will report.
$sel:deviceModel:GetMobileDeviceAccessEffect'
, getMobileDeviceAccessEffect_deviceModel
- Device model 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.
$sel:organizationId:GetMobileDeviceAccessEffect'
, getMobileDeviceAccessEffect_organizationId
- The Amazon WorkMail organization to simulate the access effect for.
data GetMobileDeviceAccessEffectResponse Source #
See: newGetMobileDeviceAccessEffectResponse
smart constructor.
GetMobileDeviceAccessEffectResponse' (Maybe MobileDeviceAccessRuleEffect) (Maybe [MobileDeviceAccessMatchedRule]) Int |
Instances
newGetMobileDeviceAccessEffectResponse Source #
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:
$sel:effect:GetMobileDeviceAccessEffectResponse'
, getMobileDeviceAccessEffectResponse_effect
- The effect of the simulated access, ALLOW
or DENY
, after evaluating
mobile device access rules in the Amazon 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.
DeleteMailboxPermissions
data DeleteMailboxPermissions Source #
See: newDeleteMailboxPermissions
smart constructor.
Instances
newDeleteMailboxPermissions Source #
:: 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:
$sel:organizationId:DeleteMailboxPermissions'
, deleteMailboxPermissions_organizationId
- The identifier of the organization under which the member (user or
group) exists.
$sel:entityId:DeleteMailboxPermissions'
, deleteMailboxPermissions_entityId
- The identifier of the member (user or group) that owns the mailbox.
$sel:granteeId:DeleteMailboxPermissions'
, deleteMailboxPermissions_granteeId
- The identifier of the member (user or group) for which to delete granted
permissions.
data DeleteMailboxPermissionsResponse Source #
See: newDeleteMailboxPermissionsResponse
smart constructor.
Instances
Eq DeleteMailboxPermissionsResponse Source # | |
Read DeleteMailboxPermissionsResponse Source # | |
Show DeleteMailboxPermissionsResponse Source # | |
Generic DeleteMailboxPermissionsResponse Source # | |
NFData DeleteMailboxPermissionsResponse Source # | |
Defined in Amazonka.WorkMail.DeleteMailboxPermissions rnf :: DeleteMailboxPermissionsResponse -> () # | |
type Rep DeleteMailboxPermissionsResponse Source # | |
Defined in Amazonka.WorkMail.DeleteMailboxPermissions type Rep DeleteMailboxPermissionsResponse = D1 ('MetaData "DeleteMailboxPermissionsResponse" "Amazonka.WorkMail.DeleteMailboxPermissions" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DeleteMailboxPermissionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
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:nextToken:ListUsers'
, listUsers_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
$sel:maxResults:ListUsers'
, listUsers_maxResults
- The maximum number of results to return in a single call.
$sel:organizationId:ListUsers'
, listUsers_organizationId
- The identifier for the organization under which the users exist.
data ListUsersResponse Source #
See: newListUsersResponse
smart constructor.
Instances
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:
$sel:users:ListUsersResponse'
, listUsersResponse_users
- The overview of users for an organization.
$sel:nextToken: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:httpStatus:ListUsersResponse'
, listUsersResponse_httpStatus
- The response's http status code.
PutInboundDmarcSettings
data PutInboundDmarcSettings Source #
See: newPutInboundDmarcSettings
smart constructor.
Instances
newPutInboundDmarcSettings Source #
:: 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:
$sel:organizationId: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.
Instances
Eq PutInboundDmarcSettingsResponse Source # | |
Read PutInboundDmarcSettingsResponse Source # | |
Show PutInboundDmarcSettingsResponse Source # | |
Defined in Amazonka.WorkMail.PutInboundDmarcSettings | |
Generic PutInboundDmarcSettingsResponse Source # | |
NFData PutInboundDmarcSettingsResponse Source # | |
Defined in Amazonka.WorkMail.PutInboundDmarcSettings rnf :: PutInboundDmarcSettingsResponse -> () # | |
type Rep PutInboundDmarcSettingsResponse Source # | |
Defined in Amazonka.WorkMail.PutInboundDmarcSettings type Rep PutInboundDmarcSettingsResponse = D1 ('MetaData "PutInboundDmarcSettingsResponse" "Amazonka.WorkMail.PutInboundDmarcSettings" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "PutInboundDmarcSettingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
GetMailboxDetails
data GetMailboxDetails Source #
See: newGetMailboxDetails
smart constructor.
Instances
:: 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:
$sel:organizationId:GetMailboxDetails'
, getMailboxDetails_organizationId
- The identifier for the organization that contains the user whose mailbox
details are being requested.
$sel:userId: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.
AssociateMemberToGroup
data AssociateMemberToGroup Source #
See: newAssociateMemberToGroup
smart constructor.
Instances
newAssociateMemberToGroup Source #
:: 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:
$sel:organizationId: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.
Instances
Eq AssociateMemberToGroupResponse Source # | |
Read AssociateMemberToGroupResponse Source # | |
Show AssociateMemberToGroupResponse Source # | |
Defined in Amazonka.WorkMail.AssociateMemberToGroup | |
Generic AssociateMemberToGroupResponse Source # | |
NFData AssociateMemberToGroupResponse Source # | |
Defined in Amazonka.WorkMail.AssociateMemberToGroup rnf :: AssociateMemberToGroupResponse -> () # | |
type Rep AssociateMemberToGroupResponse Source # | |
Defined in Amazonka.WorkMail.AssociateMemberToGroup type Rep AssociateMemberToGroupResponse = D1 ('MetaData "AssociateMemberToGroupResponse" "Amazonka.WorkMail.AssociateMemberToGroup" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "AssociateMemberToGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
DeleteResource
data DeleteResource Source #
See: newDeleteResource
smart constructor.
Instances
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:
$sel:organizationId: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.
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.
UpdateResource
data UpdateResource Source #
See: newUpdateResource
smart constructor.
Instances
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:name:UpdateResource'
, updateResource_name
- The name of the resource to be updated.
$sel:bookingOptions:UpdateResource'
, updateResource_bookingOptions
- The resource's booking options to be updated.
$sel:organizationId: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.
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.
DisassociateMemberFromGroup
data DisassociateMemberFromGroup Source #
See: newDisassociateMemberFromGroup
smart constructor.
Instances
newDisassociateMemberFromGroup Source #
:: 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:
$sel:organizationId: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.
Instances
Eq DisassociateMemberFromGroupResponse Source # | |
Read DisassociateMemberFromGroupResponse Source # | |
Show DisassociateMemberFromGroupResponse Source # | |
Generic DisassociateMemberFromGroupResponse Source # | |
NFData DisassociateMemberFromGroupResponse Source # | |
Defined in Amazonka.WorkMail.DisassociateMemberFromGroup rnf :: DisassociateMemberFromGroupResponse -> () # | |
type Rep DisassociateMemberFromGroupResponse Source # | |
Defined in Amazonka.WorkMail.DisassociateMemberFromGroup type Rep DisassociateMemberFromGroupResponse = D1 ('MetaData "DisassociateMemberFromGroupResponse" "Amazonka.WorkMail.DisassociateMemberFromGroup" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DisassociateMemberFromGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDisassociateMemberFromGroupResponse Source #
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.
ListResources (Paginated)
data ListResources Source #
See: newListResources
smart constructor.
Instances
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:nextToken:ListResources'
, listResources_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
$sel:maxResults:ListResources'
, listResources_maxResults
- The maximum number of results to return in a single call.
$sel:organizationId: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:
$sel:resources:ListResourcesResponse'
, listResourcesResponse_resources
- One page of the organization's resource representation.
$sel:nextToken: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:httpStatus:ListResourcesResponse'
, listResourcesResponse_httpStatus
- The response's http status code.
DeregisterFromWorkMail
data DeregisterFromWorkMail Source #
See: newDeregisterFromWorkMail
smart constructor.
Instances
newDeregisterFromWorkMail Source #
:: Text | |
-> Text | |
-> DeregisterFromWorkMail |
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:
$sel:organizationId:DeregisterFromWorkMail'
, deregisterFromWorkMail_organizationId
- The identifier for the organization under which the Amazon WorkMail
entity exists.
$sel:entityId:DeregisterFromWorkMail'
, deregisterFromWorkMail_entityId
- The identifier for the member (user or group) to be updated.
data DeregisterFromWorkMailResponse Source #
See: newDeregisterFromWorkMailResponse
smart constructor.
Instances
Eq DeregisterFromWorkMailResponse Source # | |
Read DeregisterFromWorkMailResponse Source # | |
Show DeregisterFromWorkMailResponse Source # | |
Defined in Amazonka.WorkMail.DeregisterFromWorkMail | |
Generic DeregisterFromWorkMailResponse Source # | |
NFData DeregisterFromWorkMailResponse Source # | |
Defined in Amazonka.WorkMail.DeregisterFromWorkMail rnf :: DeregisterFromWorkMailResponse -> () # | |
type Rep DeregisterFromWorkMailResponse Source # | |
Defined in Amazonka.WorkMail.DeregisterFromWorkMail type Rep DeregisterFromWorkMailResponse = D1 ('MetaData "DeregisterFromWorkMailResponse" "Amazonka.WorkMail.DeregisterFromWorkMail" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DeregisterFromWorkMailResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
ListMailboxExportJobs
data ListMailboxExportJobs Source #
See: newListMailboxExportJobs
smart constructor.
Instances
newListMailboxExportJobs Source #
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:nextToken:ListMailboxExportJobs'
, listMailboxExportJobs_nextToken
- The token to use to retrieve the next page of results.
$sel:maxResults:ListMailboxExportJobs'
, listMailboxExportJobs_maxResults
- The maximum number of results to return in a single call.
$sel:organizationId:ListMailboxExportJobs'
, listMailboxExportJobs_organizationId
- The organization ID.
data ListMailboxExportJobsResponse Source #
See: newListMailboxExportJobsResponse
smart constructor.
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:nextToken:ListMailboxExportJobs'
, listMailboxExportJobsResponse_nextToken
- The token to use to retrieve the next page of results.
$sel:jobs:ListMailboxExportJobsResponse'
, listMailboxExportJobsResponse_jobs
- The mailbox export job details.
$sel:httpStatus:ListMailboxExportJobsResponse'
, listMailboxExportJobsResponse_httpStatus
- The response's http status code.
CreateMobileDeviceAccessRule
data CreateMobileDeviceAccessRule Source #
See: newCreateMobileDeviceAccessRule
smart constructor.
CreateMobileDeviceAccessRule' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) Text Text MobileDeviceAccessRuleEffect |
Instances
newCreateMobileDeviceAccessRule Source #
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.
$sel:deviceUserAgents:CreateMobileDeviceAccessRule'
, createMobileDeviceAccessRule_deviceUserAgents
- Device user agents that the rule will match.
$sel:deviceTypes:CreateMobileDeviceAccessRule'
, createMobileDeviceAccessRule_deviceTypes
- Device types that the rule will match.
$sel:notDeviceTypes:CreateMobileDeviceAccessRule'
, createMobileDeviceAccessRule_notDeviceTypes
- Device types that the rule will not match. All other device types
will match.
$sel:notDeviceOperatingSystems:CreateMobileDeviceAccessRule'
, createMobileDeviceAccessRule_notDeviceOperatingSystems
- Device operating systems that the rule will not match. All other
device operating systems will match.
$sel:deviceModels:CreateMobileDeviceAccessRule'
, createMobileDeviceAccessRule_deviceModels
- Device models that the rule will match.
$sel:deviceOperatingSystems:CreateMobileDeviceAccessRule'
, createMobileDeviceAccessRule_deviceOperatingSystems
- Device operating systems that the rule will match.
$sel:description:CreateMobileDeviceAccessRule'
, createMobileDeviceAccessRule_description
- The rule description.
$sel:notDeviceUserAgents:CreateMobileDeviceAccessRule'
, createMobileDeviceAccessRule_notDeviceUserAgents
- Device user agents that the rule will not match. All other device
user agents will match.
$sel:notDeviceModels:CreateMobileDeviceAccessRule'
, createMobileDeviceAccessRule_notDeviceModels
- Device models that the rule will not match. All other device models
will match.
$sel:organizationId:CreateMobileDeviceAccessRule'
, createMobileDeviceAccessRule_organizationId
- The Amazon WorkMail organization under which the rule will be created.
$sel:name:CreateMobileDeviceAccessRule'
, createMobileDeviceAccessRule_name
- The rule name.
$sel:effect:CreateMobileDeviceAccessRule'
, createMobileDeviceAccessRule_effect
- The effect of the rule when it matches. Allowed values are ALLOW
or
DENY
.
data CreateMobileDeviceAccessRuleResponse Source #
See: newCreateMobileDeviceAccessRuleResponse
smart constructor.
Instances
newCreateMobileDeviceAccessRuleResponse Source #
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:
$sel:mobileDeviceAccessRuleId:CreateMobileDeviceAccessRuleResponse'
, createMobileDeviceAccessRuleResponse_mobileDeviceAccessRuleId
- The identifier for the newly created mobile device access rule.
$sel:httpStatus:CreateMobileDeviceAccessRuleResponse'
, createMobileDeviceAccessRuleResponse_httpStatus
- The response's http status code.
ListMailboxPermissions (Paginated)
data ListMailboxPermissions Source #
See: newListMailboxPermissions
smart constructor.
Instances
newListMailboxPermissions Source #
:: Text | |
-> Text | |
-> ListMailboxPermissions |
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:nextToken:ListMailboxPermissions'
, listMailboxPermissions_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
$sel:maxResults:ListMailboxPermissions'
, listMailboxPermissions_maxResults
- The maximum number of results to return in a single call.
$sel:organizationId:ListMailboxPermissions'
, listMailboxPermissions_organizationId
- The identifier of the organization under which the user, group, or
resource exists.
$sel:entityId:ListMailboxPermissions'
, listMailboxPermissions_entityId
- The identifier of the user, group, or resource for which to list mailbox
permissions.
data ListMailboxPermissionsResponse Source #
See: newListMailboxPermissionsResponse
smart constructor.
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:
$sel:nextToken: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.
GetMobileDeviceAccessOverride
data GetMobileDeviceAccessOverride Source #
See: newGetMobileDeviceAccessOverride
smart constructor.
Instances
newGetMobileDeviceAccessOverride Source #
:: 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:
$sel:organizationId:GetMobileDeviceAccessOverride'
, getMobileDeviceAccessOverride_organizationId
- The Amazon WorkMail organization to which you want to apply the
override.
$sel:userId: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
$sel:deviceId:GetMobileDeviceAccessOverride'
, getMobileDeviceAccessOverride_deviceId
- The mobile device to which the override applies. DeviceId
is case
insensitive.
data GetMobileDeviceAccessOverrideResponse Source #
See: newGetMobileDeviceAccessOverrideResponse
smart constructor.
GetMobileDeviceAccessOverrideResponse' (Maybe MobileDeviceAccessRuleEffect) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) Int |
Instances
newGetMobileDeviceAccessOverrideResponse Source #
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:
$sel:effect:GetMobileDeviceAccessOverrideResponse'
, getMobileDeviceAccessOverrideResponse_effect
- The effect of the override, ALLOW
or DENY
.
$sel:userId:GetMobileDeviceAccessOverride'
, getMobileDeviceAccessOverrideResponse_userId
- The WorkMail user to which the access override applies.
$sel:dateCreated:GetMobileDeviceAccessOverrideResponse'
, getMobileDeviceAccessOverrideResponse_dateCreated
- The date the override was first created.
$sel:dateModified:GetMobileDeviceAccessOverrideResponse'
, getMobileDeviceAccessOverrideResponse_dateModified
- The date the description was last modified.
$sel:deviceId:GetMobileDeviceAccessOverride'
, getMobileDeviceAccessOverrideResponse_deviceId
- The device to which the access override applies.
$sel:description:GetMobileDeviceAccessOverrideResponse'
, getMobileDeviceAccessOverrideResponse_description
- A description of the override.
$sel:httpStatus:GetMobileDeviceAccessOverrideResponse'
, getMobileDeviceAccessOverrideResponse_httpStatus
- The response's http status code.
ListGroupMembers (Paginated)
data ListGroupMembers Source #
See: newListGroupMembers
smart constructor.
Instances
:: 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:nextToken:ListGroupMembers'
, listGroupMembers_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
$sel:maxResults:ListGroupMembers'
, listGroupMembers_maxResults
- The maximum number of results to return in a single call.
$sel:organizationId: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.
$sel:nextToken: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.
DisassociateDelegateFromResource
data DisassociateDelegateFromResource Source #
See: newDisassociateDelegateFromResource
smart constructor.
Instances
newDisassociateDelegateFromResource Source #
:: 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:
$sel:organizationId: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.
$sel:entityId: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.
Instances
Eq DisassociateDelegateFromResourceResponse Source # | |
Read DisassociateDelegateFromResourceResponse Source # | |
Show DisassociateDelegateFromResourceResponse Source # | |
Generic DisassociateDelegateFromResourceResponse Source # | |
Defined in Amazonka.WorkMail.DisassociateDelegateFromResource type Rep DisassociateDelegateFromResourceResponse :: Type -> Type # | |
NFData DisassociateDelegateFromResourceResponse Source # | |
type Rep DisassociateDelegateFromResourceResponse Source # | |
Defined in Amazonka.WorkMail.DisassociateDelegateFromResource type Rep DisassociateDelegateFromResourceResponse = D1 ('MetaData "DisassociateDelegateFromResourceResponse" "Amazonka.WorkMail.DisassociateDelegateFromResource" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DisassociateDelegateFromResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDisassociateDelegateFromResourceResponse Source #
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.
DeleteAccessControlRule
data DeleteAccessControlRule Source #
See: newDeleteAccessControlRule
smart constructor.
Instances
newDeleteAccessControlRule Source #
:: Text | |
-> Text | |
-> DeleteAccessControlRule |
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:
$sel:organizationId:DeleteAccessControlRule'
, deleteAccessControlRule_organizationId
- The identifier for the organization.
$sel:name:DeleteAccessControlRule'
, deleteAccessControlRule_name
- The name of the access control rule.
data DeleteAccessControlRuleResponse Source #
See: newDeleteAccessControlRuleResponse
smart constructor.
Instances
Eq DeleteAccessControlRuleResponse Source # | |
Read DeleteAccessControlRuleResponse Source # | |
Show DeleteAccessControlRuleResponse Source # | |
Defined in Amazonka.WorkMail.DeleteAccessControlRule | |
Generic DeleteAccessControlRuleResponse Source # | |
NFData DeleteAccessControlRuleResponse Source # | |
Defined in Amazonka.WorkMail.DeleteAccessControlRule rnf :: DeleteAccessControlRuleResponse -> () # | |
type Rep DeleteAccessControlRuleResponse Source # | |
Defined in Amazonka.WorkMail.DeleteAccessControlRule type Rep DeleteAccessControlRuleResponse = D1 ('MetaData "DeleteAccessControlRuleResponse" "Amazonka.WorkMail.DeleteAccessControlRule" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DeleteAccessControlRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
ListResourceDelegates (Paginated)
data ListResourceDelegates Source #
See: newListResourceDelegates
smart constructor.
Instances
newListResourceDelegates Source #
:: 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:nextToken:ListResourceDelegates'
, listResourceDelegates_nextToken
- The token used to paginate through the delegates associated with a
resource.
$sel:maxResults:ListResourceDelegates'
, listResourceDelegates_maxResults
- The number of maximum results in a page.
$sel:organizationId: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.
$sel:nextToken: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.
ListAccessControlRules
data ListAccessControlRules Source #
See: newListAccessControlRules
smart constructor.
Instances
newListAccessControlRules Source #
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:
$sel:organizationId:ListAccessControlRules'
, listAccessControlRules_organizationId
- The identifier for the organization.
data ListAccessControlRulesResponse Source #
See: newListAccessControlRulesResponse
smart constructor.
Instances
Eq ListAccessControlRulesResponse Source # | |
Read ListAccessControlRulesResponse Source # | |
Show ListAccessControlRulesResponse Source # | |
Defined in Amazonka.WorkMail.ListAccessControlRules | |
Generic ListAccessControlRulesResponse Source # | |
NFData ListAccessControlRulesResponse Source # | |
Defined in Amazonka.WorkMail.ListAccessControlRules rnf :: ListAccessControlRulesResponse -> () # | |
type Rep ListAccessControlRulesResponse Source # | |
Defined in Amazonka.WorkMail.ListAccessControlRules type Rep ListAccessControlRulesResponse = D1 ('MetaData "ListAccessControlRulesResponse" "Amazonka.WorkMail.ListAccessControlRules" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "ListAccessControlRulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AccessControlRule])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
DescribeUser
data DescribeUser Source #
See: newDescribeUser
smart constructor.
Instances
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:
$sel:organizationId:DescribeUser'
, describeUser_organizationId
- The identifier for the organization under which the user exists.
$sel:userId:DescribeUser'
, describeUser_userId
- The identifier for the user to be described.
data DescribeUserResponse Source #
See: newDescribeUserResponse
smart constructor.
DescribeUserResponse' (Maybe Text) (Maybe EntityState) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe UserRole) (Maybe POSIX) Int |
Instances
newDescribeUserResponse Source #
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:
$sel:email:DescribeUserResponse'
, describeUserResponse_email
- The email of the user.
$sel:state:DescribeUserResponse'
, describeUserResponse_state
- The state of a user: enabled (registered to Amazon WorkMail) or disabled
(deregistered or never registered to WorkMail).
$sel:userId:DescribeUser'
, describeUserResponse_userId
- The identifier for the described user.
$sel:disabledDate:DescribeUserResponse'
, describeUserResponse_disabledDate
- The date and time at which the user was disabled for Amazon WorkMail
usage, in UNIX epoch time format.
$sel:name:DescribeUserResponse'
, describeUserResponse_name
- The name for the user.
$sel:displayName:DescribeUserResponse'
, describeUserResponse_displayName
- The display name of the user.
$sel:userRole:DescribeUserResponse'
, describeUserResponse_userRole
- In certain cases, other entities are modeled as users. If
interoperability is enabled, resources are imported into Amazon 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:enabledDate:DescribeUserResponse'
, describeUserResponse_enabledDate
- The date and time at which the user was enabled for Amazon WorkMail
usage, in UNIX epoch time format.
$sel:httpStatus:DescribeUserResponse'
, describeUserResponse_httpStatus
- The response's http status code.
PutAccessControlRule
data PutAccessControlRule Source #
See: newPutAccessControlRule
smart constructor.
PutAccessControlRule' (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) Text AccessControlRuleEffect Text Text |
Instances
newPutAccessControlRule Source #
:: 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:
$sel:userIds:PutAccessControlRule'
, putAccessControlRule_userIds
- User IDs to include in the rule.
$sel:actions:PutAccessControlRule'
, putAccessControlRule_actions
- Access protocol actions to include in the rule. Valid values include
ActiveSync
, AutoDiscover
, EWS
, IMAP
, SMTP
, WindowsOutlook
,
and WebMail
.
$sel:notUserIds:PutAccessControlRule'
, putAccessControlRule_notUserIds
- User IDs to exclude from the rule.
$sel:ipRanges:PutAccessControlRule'
, putAccessControlRule_ipRanges
- IPv4 CIDR ranges to include in the rule.
$sel:notIpRanges:PutAccessControlRule'
, putAccessControlRule_notIpRanges
- IPv4 CIDR ranges to exclude from the rule.
$sel:notActions:PutAccessControlRule'
, putAccessControlRule_notActions
- Access protocol actions to exclude from the rule. Valid values include
ActiveSync
, AutoDiscover
, EWS
, IMAP
, SMTP
, WindowsOutlook
,
and WebMail
.
$sel:name:PutAccessControlRule'
, putAccessControlRule_name
- The rule name.
$sel:effect:PutAccessControlRule'
, putAccessControlRule_effect
- The rule effect.
$sel:description:PutAccessControlRule'
, putAccessControlRule_description
- The rule description.
$sel:organizationId:PutAccessControlRule'
, putAccessControlRule_organizationId
- The identifier of the organization.
data PutAccessControlRuleResponse Source #
See: newPutAccessControlRuleResponse
smart constructor.
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.
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:
$sel:description:StartMailboxExportJob'
, startMailboxExportJob_description
- The mailbox export job description.
$sel:clientToken:StartMailboxExportJob'
, startMailboxExportJob_clientToken
- The idempotency token for the client request.
$sel:organizationId:StartMailboxExportJob'
, startMailboxExportJob_organizationId
- The identifier associated with the organization.
$sel:entityId: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.
$sel:s3BucketName: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.
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:
$sel:jobId:StartMailboxExportJobResponse'
, startMailboxExportJobResponse_jobId
- The job ID.
$sel:httpStatus:StartMailboxExportJobResponse'
, startMailboxExportJobResponse_httpStatus
- The response's http status code.
DeleteAlias
data DeleteAlias Source #
See: newDeleteAlias
smart constructor.
Instances
:: 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:
$sel:organizationId:DeleteAlias'
, deleteAlias_organizationId
- The identifier for the organization under which the user exists.
$sel:entityId:DeleteAlias'
, deleteAlias_entityId
- The identifier for the member (user or group) from which to have the
aliases removed.
$sel:alias: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.
Instances
newDeleteAliasResponse Source #
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.
ListOrganizations (Paginated)
data ListOrganizations Source #
See: newListOrganizations
smart constructor.
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:nextToken:ListOrganizations'
, listOrganizations_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
$sel:maxResults:ListOrganizations'
, listOrganizations_maxResults
- The maximum number of results to return in a single call.
data ListOrganizationsResponse Source #
See: newListOrganizationsResponse
smart constructor.
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:
$sel:nextToken: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.
AssociateDelegateToResource
data AssociateDelegateToResource Source #
See: newAssociateDelegateToResource
smart constructor.
Instances
newAssociateDelegateToResource Source #
:: 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:
$sel:organizationId: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.
$sel:entityId:AssociateDelegateToResource'
, associateDelegateToResource_entityId
- The member (user or group) to associate to the resource.
data AssociateDelegateToResourceResponse Source #
See: newAssociateDelegateToResourceResponse
smart constructor.
Instances
Eq AssociateDelegateToResourceResponse Source # | |
Read AssociateDelegateToResourceResponse Source # | |
Show AssociateDelegateToResourceResponse Source # | |
Generic AssociateDelegateToResourceResponse Source # | |
NFData AssociateDelegateToResourceResponse Source # | |
Defined in Amazonka.WorkMail.AssociateDelegateToResource rnf :: AssociateDelegateToResourceResponse -> () # | |
type Rep AssociateDelegateToResourceResponse Source # | |
Defined in Amazonka.WorkMail.AssociateDelegateToResource type Rep AssociateDelegateToResourceResponse = D1 ('MetaData "AssociateDelegateToResourceResponse" "Amazonka.WorkMail.AssociateDelegateToResource" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "AssociateDelegateToResourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newAssociateDelegateToResourceResponse Source #
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.
GetAccessControlEffect
data GetAccessControlEffect Source #
See: newGetAccessControlEffect
smart constructor.
Instances
newGetAccessControlEffect Source #
:: Text | |
-> 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:
$sel:organizationId:GetAccessControlEffect'
, getAccessControlEffect_organizationId
- The identifier for the organization.
$sel:ipAddress:GetAccessControlEffect'
, getAccessControlEffect_ipAddress
- The IPv4 address.
$sel:action:GetAccessControlEffect'
, getAccessControlEffect_action
- The access protocol action. Valid values include ActiveSync
,
AutoDiscover
, EWS
, IMAP
, SMTP
, WindowsOutlook
, and WebMail
.
$sel:userId:GetAccessControlEffect'
, getAccessControlEffect_userId
- The user ID.
data GetAccessControlEffectResponse Source #
See: newGetAccessControlEffectResponse
smart constructor.
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:
$sel:effect: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.
DeleteRetentionPolicy
data DeleteRetentionPolicy Source #
See: newDeleteRetentionPolicy
smart constructor.
Instances
newDeleteRetentionPolicy Source #
:: 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:
$sel:organizationId:DeleteRetentionPolicy'
, deleteRetentionPolicy_organizationId
- The organization ID.
$sel:id:DeleteRetentionPolicy'
, deleteRetentionPolicy_id
- The retention policy ID.
data DeleteRetentionPolicyResponse Source #
See: newDeleteRetentionPolicyResponse
smart constructor.
Instances
Eq DeleteRetentionPolicyResponse Source # | |
Read DeleteRetentionPolicyResponse Source # | |
Show DeleteRetentionPolicyResponse Source # | |
Defined in Amazonka.WorkMail.DeleteRetentionPolicy showsPrec :: Int -> DeleteRetentionPolicyResponse -> ShowS # show :: DeleteRetentionPolicyResponse -> String # showList :: [DeleteRetentionPolicyResponse] -> ShowS # | |
Generic DeleteRetentionPolicyResponse Source # | |
NFData DeleteRetentionPolicyResponse Source # | |
Defined in Amazonka.WorkMail.DeleteRetentionPolicy rnf :: DeleteRetentionPolicyResponse -> () # | |
type Rep DeleteRetentionPolicyResponse Source # | |
Defined in Amazonka.WorkMail.DeleteRetentionPolicy type Rep DeleteRetentionPolicyResponse = D1 ('MetaData "DeleteRetentionPolicyResponse" "Amazonka.WorkMail.DeleteRetentionPolicy" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DeleteRetentionPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
CreateUser
data CreateUser Source #
See: newCreateUser
smart constructor.
Instances
:: 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:
$sel:organizationId:CreateUser'
, createUser_organizationId
- The identifier of the organization for which the user is created.
$sel:name: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.
$sel:displayName: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.
Instances
newCreateUserResponse Source #
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:
$sel:userId:CreateUserResponse'
, createUserResponse_userId
- The identifier for the new user.
$sel:httpStatus:CreateUserResponse'
, createUserResponse_httpStatus
- The response's http status code.
PutRetentionPolicy
data PutRetentionPolicy Source #
See: newPutRetentionPolicy
smart constructor.
Instances
newPutRetentionPolicy Source #
:: 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:
$sel:id:PutRetentionPolicy'
, putRetentionPolicy_id
- The retention policy ID.
$sel:description:PutRetentionPolicy'
, putRetentionPolicy_description
- The retention policy description.
$sel:organizationId:PutRetentionPolicy'
, putRetentionPolicy_organizationId
- The organization ID.
$sel:name:PutRetentionPolicy'
, putRetentionPolicy_name
- The retention policy name.
$sel:folderConfigurations:PutRetentionPolicy'
, putRetentionPolicy_folderConfigurations
- The retention policy folder configurations.
data PutRetentionPolicyResponse Source #
See: newPutRetentionPolicyResponse
smart constructor.
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.
ListMailDomains
data ListMailDomains Source #
See: newListMailDomains
smart constructor.
Instances
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:nextToken:ListMailDomains'
, listMailDomains_nextToken
- The token to use to retrieve the next page of results. The first call
does not require a token.
$sel:maxResults:ListMailDomains'
, listMailDomains_maxResults
- The maximum number of results to return in a single call.
$sel:organizationId:ListMailDomains'
, listMailDomains_organizationId
- The Amazon WorkMail organization for which to list domains.
data ListMailDomainsResponse Source #
See: newListMailDomainsResponse
smart constructor.
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:nextToken: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:mailDomains:ListMailDomainsResponse'
, listMailDomainsResponse_mailDomains
- The list of mail domain summaries, specifying domains that exist in the
specified Amazon WorkMail organization, along with the information about
whether the domain is or isn't the default.
$sel:httpStatus:ListMailDomainsResponse'
, listMailDomainsResponse_httpStatus
- The response's http status code.
DeleteUser
data DeleteUser Source #
See: newDeleteUser
smart constructor.
Instances
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:
$sel:organizationId:DeleteUser'
, deleteUser_organizationId
- The organization that contains the user to be deleted.
$sel:userId:DeleteUser'
, deleteUser_userId
- The identifier of the user to be deleted.
data DeleteUserResponse Source #
See: newDeleteUserResponse
smart constructor.
Instances
newDeleteUserResponse Source #
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.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
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.
Instances
newTagResourceResponse Source #
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.
RegisterMailDomain
data RegisterMailDomain Source #
See: newRegisterMailDomain
smart constructor.
Instances
newRegisterMailDomain Source #
:: 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.
$sel:organizationId:RegisterMailDomain'
, registerMailDomain_organizationId
- The Amazon WorkMail organization under which you're creating the
domain.
$sel:domainName:RegisterMailDomain'
, registerMailDomain_domainName
- The name of the mail domain to create in Amazon WorkMail and SES.
data RegisterMailDomainResponse Source #
See: newRegisterMailDomainResponse
smart constructor.
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.
UpdateDefaultMailDomain
data UpdateDefaultMailDomain Source #
See: newUpdateDefaultMailDomain
smart constructor.
Instances
newUpdateDefaultMailDomain Source #
:: Text | |
-> Text | |
-> UpdateDefaultMailDomain |
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:
$sel:organizationId:UpdateDefaultMailDomain'
, updateDefaultMailDomain_organizationId
- The Amazon WorkMail organization for which to list domains.
$sel:domainName:UpdateDefaultMailDomain'
, updateDefaultMailDomain_domainName
- The domain name that will become the default domain.
data UpdateDefaultMailDomainResponse Source #
See: newUpdateDefaultMailDomainResponse
smart constructor.
Instances
Eq UpdateDefaultMailDomainResponse Source # | |
Read UpdateDefaultMailDomainResponse Source # | |
Show UpdateDefaultMailDomainResponse Source # | |
Defined in Amazonka.WorkMail.UpdateDefaultMailDomain | |
Generic UpdateDefaultMailDomainResponse Source # | |
NFData UpdateDefaultMailDomainResponse Source # | |
Defined in Amazonka.WorkMail.UpdateDefaultMailDomain rnf :: UpdateDefaultMailDomainResponse -> () # | |
type Rep UpdateDefaultMailDomainResponse Source # | |
Defined in Amazonka.WorkMail.UpdateDefaultMailDomain type Rep UpdateDefaultMailDomainResponse = D1 ('MetaData "UpdateDefaultMailDomainResponse" "Amazonka.WorkMail.UpdateDefaultMailDomain" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "UpdateDefaultMailDomainResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
UpdateMobileDeviceAccessRule
data UpdateMobileDeviceAccessRule Source #
See: newUpdateMobileDeviceAccessRule
smart constructor.
UpdateMobileDeviceAccessRule' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) Text Text Text MobileDeviceAccessRuleEffect |
Instances
newUpdateMobileDeviceAccessRule Source #
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:
$sel:deviceUserAgents:UpdateMobileDeviceAccessRule'
, updateMobileDeviceAccessRule_deviceUserAgents
- User agents that the updated rule will match.
$sel:deviceTypes:UpdateMobileDeviceAccessRule'
, updateMobileDeviceAccessRule_deviceTypes
- Device types that the updated rule will match.
$sel:notDeviceTypes:UpdateMobileDeviceAccessRule'
, updateMobileDeviceAccessRule_notDeviceTypes
- Device types that the updated rule will not match. All other device
types will match.
$sel:notDeviceOperatingSystems:UpdateMobileDeviceAccessRule'
, updateMobileDeviceAccessRule_notDeviceOperatingSystems
- Device operating systems that the updated rule will not match. All
other device operating systems will match.
$sel:deviceModels:UpdateMobileDeviceAccessRule'
, updateMobileDeviceAccessRule_deviceModels
- Device models that the updated rule will match.
$sel:deviceOperatingSystems:UpdateMobileDeviceAccessRule'
, updateMobileDeviceAccessRule_deviceOperatingSystems
- Device operating systems that the updated rule will match.
$sel:description:UpdateMobileDeviceAccessRule'
, updateMobileDeviceAccessRule_description
- The updated rule description.
$sel:notDeviceUserAgents:UpdateMobileDeviceAccessRule'
, updateMobileDeviceAccessRule_notDeviceUserAgents
- User agents that the updated rule will not match. All other user
agents will match.
$sel:notDeviceModels:UpdateMobileDeviceAccessRule'
, updateMobileDeviceAccessRule_notDeviceModels
- Device models that the updated rule will not match. All other device
models will match.
$sel:organizationId:UpdateMobileDeviceAccessRule'
, updateMobileDeviceAccessRule_organizationId
- The Amazon WorkMail organization under which the rule will be updated.
$sel:mobileDeviceAccessRuleId:UpdateMobileDeviceAccessRule'
, updateMobileDeviceAccessRule_mobileDeviceAccessRuleId
- The identifier of the rule to be updated.
$sel:name:UpdateMobileDeviceAccessRule'
, updateMobileDeviceAccessRule_name
- The updated rule name.
$sel:effect:UpdateMobileDeviceAccessRule'
, updateMobileDeviceAccessRule_effect
- The effect of the rule when it matches. Allowed values are ALLOW
or
DENY
.
data UpdateMobileDeviceAccessRuleResponse Source #
See: newUpdateMobileDeviceAccessRuleResponse
smart constructor.
Instances
Eq UpdateMobileDeviceAccessRuleResponse Source # | |
Read UpdateMobileDeviceAccessRuleResponse Source # | |
Show UpdateMobileDeviceAccessRuleResponse Source # | |
Generic UpdateMobileDeviceAccessRuleResponse Source # | |
Defined in Amazonka.WorkMail.UpdateMobileDeviceAccessRule type Rep UpdateMobileDeviceAccessRuleResponse :: Type -> Type # | |
NFData UpdateMobileDeviceAccessRuleResponse Source # | |
Defined in Amazonka.WorkMail.UpdateMobileDeviceAccessRule rnf :: UpdateMobileDeviceAccessRuleResponse -> () # | |
type Rep UpdateMobileDeviceAccessRuleResponse Source # | |
Defined in Amazonka.WorkMail.UpdateMobileDeviceAccessRule type Rep UpdateMobileDeviceAccessRuleResponse = D1 ('MetaData "UpdateMobileDeviceAccessRuleResponse" "Amazonka.WorkMail.UpdateMobileDeviceAccessRule" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "UpdateMobileDeviceAccessRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateMobileDeviceAccessRuleResponse Source #
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.
DeleteMobileDeviceAccessRule
data DeleteMobileDeviceAccessRule Source #
See: newDeleteMobileDeviceAccessRule
smart constructor.
Instances
newDeleteMobileDeviceAccessRule Source #
:: 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:
$sel:organizationId:DeleteMobileDeviceAccessRule'
, deleteMobileDeviceAccessRule_organizationId
- The Amazon WorkMail organization under which the rule will be deleted.
$sel:mobileDeviceAccessRuleId:DeleteMobileDeviceAccessRule'
, deleteMobileDeviceAccessRule_mobileDeviceAccessRuleId
- The identifier of the rule to be deleted.
data DeleteMobileDeviceAccessRuleResponse Source #
See: newDeleteMobileDeviceAccessRuleResponse
smart constructor.
Instances
Eq DeleteMobileDeviceAccessRuleResponse Source # | |
Read DeleteMobileDeviceAccessRuleResponse Source # | |
Show DeleteMobileDeviceAccessRuleResponse Source # | |
Generic DeleteMobileDeviceAccessRuleResponse Source # | |
Defined in Amazonka.WorkMail.DeleteMobileDeviceAccessRule type Rep DeleteMobileDeviceAccessRuleResponse :: Type -> Type # | |
NFData DeleteMobileDeviceAccessRuleResponse Source # | |
Defined in Amazonka.WorkMail.DeleteMobileDeviceAccessRule rnf :: DeleteMobileDeviceAccessRuleResponse -> () # | |
type Rep DeleteMobileDeviceAccessRuleResponse Source # | |
Defined in Amazonka.WorkMail.DeleteMobileDeviceAccessRule type Rep DeleteMobileDeviceAccessRuleResponse = D1 ('MetaData "DeleteMobileDeviceAccessRuleResponse" "Amazonka.WorkMail.DeleteMobileDeviceAccessRule" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DeleteMobileDeviceAccessRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteMobileDeviceAccessRuleResponse Source #
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.
CreateGroup
data CreateGroup Source #
See: newCreateGroup
smart constructor.
Instances
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:
$sel:organizationId:CreateGroup'
, createGroup_organizationId
- The organization under which the group is to be created.
$sel:name:CreateGroup'
, createGroup_name
- The name of the group.
data CreateGroupResponse Source #
See: newCreateGroupResponse
smart constructor.
Instances
newCreateGroupResponse Source #
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.
UpdateMailboxQuota
data UpdateMailboxQuota Source #
See: newUpdateMailboxQuota
smart constructor.
Instances
newUpdateMailboxQuota Source #
:: 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:
$sel:organizationId:UpdateMailboxQuota'
, updateMailboxQuota_organizationId
- The identifier for the organization that contains the user for whom to
update the mailbox quota.
$sel:userId: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.
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.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
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.
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.
ListMobileDeviceAccessRules
data ListMobileDeviceAccessRules Source #
See: newListMobileDeviceAccessRules
smart constructor.
Instances
newListMobileDeviceAccessRules Source #
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:
$sel:organizationId:ListMobileDeviceAccessRules'
, listMobileDeviceAccessRules_organizationId
- The Amazon WorkMail organization for which to list the rules.
data ListMobileDeviceAccessRulesResponse Source #
See: newListMobileDeviceAccessRulesResponse
smart constructor.
Instances
Eq ListMobileDeviceAccessRulesResponse Source # | |
Read ListMobileDeviceAccessRulesResponse Source # | |
Show ListMobileDeviceAccessRulesResponse Source # | |
Generic ListMobileDeviceAccessRulesResponse Source # | |
NFData ListMobileDeviceAccessRulesResponse Source # | |
Defined in Amazonka.WorkMail.ListMobileDeviceAccessRules rnf :: ListMobileDeviceAccessRulesResponse -> () # | |
type Rep ListMobileDeviceAccessRulesResponse Source # | |
Defined in Amazonka.WorkMail.ListMobileDeviceAccessRules type Rep ListMobileDeviceAccessRulesResponse = D1 ('MetaData "ListMobileDeviceAccessRulesResponse" "Amazonka.WorkMail.ListMobileDeviceAccessRules" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "ListMobileDeviceAccessRulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MobileDeviceAccessRule])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newListMobileDeviceAccessRulesResponse Source #
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
Amazon WorkMail organization.
$sel:httpStatus:ListMobileDeviceAccessRulesResponse'
, listMobileDeviceAccessRulesResponse_httpStatus
- The response's http status code.
DeleteGroup
data DeleteGroup Source #
See: newDeleteGroup
smart constructor.
Instances
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:
$sel:organizationId: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.
Instances
newDeleteGroupResponse Source #
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.
ListGroups (Paginated)
data ListGroups Source #
See: newListGroups
smart constructor.
Instances
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:nextToken:ListGroups'
, listGroups_nextToken
- The token to use to retrieve the next page of results. The first call
does not contain any tokens.
$sel:maxResults:ListGroups'
, listGroups_maxResults
- The maximum number of results to return in a single call.
$sel:organizationId:ListGroups'
, listGroups_organizationId
- The identifier for the organization under which the groups exist.
data ListGroupsResponse Source #
See: newListGroupsResponse
smart constructor.
Instances
newListGroupsResponse Source #
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.
$sel:nextToken: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.
DescribeOrganization
data DescribeOrganization Source #
See: newDescribeOrganization
smart constructor.
Instances
newDescribeOrganization Source #
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:
$sel:organizationId:DescribeOrganization'
, describeOrganization_organizationId
- The identifier for the organization to be described.
data DescribeOrganizationResponse Source #
See: newDescribeOrganizationResponse
smart constructor.
DescribeOrganizationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (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:directoryId:DescribeOrganizationResponse'
, describeOrganizationResponse_directoryId
- The identifier for the directory associated with an Amazon WorkMail
organization.
$sel:state:DescribeOrganizationResponse'
, describeOrganizationResponse_state
- The state of an organization.
$sel:arn:DescribeOrganizationResponse'
, describeOrganizationResponse_arn
- The Amazon Resource Name (ARN) of the organization.
$sel:alias: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.
$sel:directoryType:DescribeOrganizationResponse'
, describeOrganizationResponse_directoryType
- The type of directory associated with the WorkMail organization.
$sel:defaultMailDomain:DescribeOrganizationResponse'
, describeOrganizationResponse_defaultMailDomain
- The default mail domain associated with the organization.
$sel:errorMessage:DescribeOrganizationResponse'
, describeOrganizationResponse_errorMessage
- (Optional) The error message indicating if unexpected behavior was
encountered with regards to the organization.
$sel:organizationId:DescribeOrganization'
, describeOrganizationResponse_organizationId
- The identifier of an organization.
$sel:httpStatus:DescribeOrganizationResponse'
, describeOrganizationResponse_httpStatus
- The response's http status code.
CreateResource
data CreateResource Source #
See: newCreateResource
smart constructor.
Instances
:: 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:
$sel:organizationId:CreateResource'
, createResource_organizationId
- The identifier associated with the organization for which the resource
is created.
$sel:name:CreateResource'
, createResource_name
- The name of the new resource.
$sel:type':CreateResource'
, createResource_type
- The type of the new resource. The available types are equipment
and
room
.
data CreateResourceResponse Source #
See: newCreateResourceResponse
smart constructor.
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.
GetDefaultRetentionPolicy
data GetDefaultRetentionPolicy Source #
See: newGetDefaultRetentionPolicy
smart constructor.
Instances
newGetDefaultRetentionPolicy Source #
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:
$sel:organizationId:GetDefaultRetentionPolicy'
, getDefaultRetentionPolicy_organizationId
- The organization ID.
data GetDefaultRetentionPolicyResponse Source #
See: newGetDefaultRetentionPolicyResponse
smart constructor.
GetDefaultRetentionPolicyResponse' (Maybe Text) (Maybe Text) (Maybe [FolderConfiguration]) (Maybe Text) Int |
Instances
newGetDefaultRetentionPolicyResponse Source #
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:
$sel:name:GetDefaultRetentionPolicyResponse'
, getDefaultRetentionPolicyResponse_name
- The retention policy name.
$sel:id:GetDefaultRetentionPolicyResponse'
, getDefaultRetentionPolicyResponse_id
- The retention policy ID.
$sel:folderConfigurations:GetDefaultRetentionPolicyResponse'
, getDefaultRetentionPolicyResponse_folderConfigurations
- The retention policy folder configurations.
$sel:description:GetDefaultRetentionPolicyResponse'
, getDefaultRetentionPolicyResponse_description
- The retention policy description.
$sel:httpStatus:GetDefaultRetentionPolicyResponse'
, getDefaultRetentionPolicyResponse_httpStatus
- The response's http status code.
DeregisterMailDomain
data DeregisterMailDomain Source #
See: newDeregisterMailDomain
smart constructor.
Instances
newDeregisterMailDomain Source #
:: 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:
$sel:organizationId:DeregisterMailDomain'
, deregisterMailDomain_organizationId
- The Amazon WorkMail organization for which the domain will be
deregistered.
$sel:domainName:DeregisterMailDomain'
, deregisterMailDomain_domainName
- The domain to deregister in WorkMail and SES.
data DeregisterMailDomainResponse Source #
See: newDeregisterMailDomainResponse
smart constructor.
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.
CancelMailboxExportJob
data CancelMailboxExportJob Source #
See: newCancelMailboxExportJob
smart constructor.
Instances
newCancelMailboxExportJob Source #
:: 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.
$sel:jobId:CancelMailboxExportJob'
, cancelMailboxExportJob_jobId
- The job ID.
$sel:organizationId:CancelMailboxExportJob'
, cancelMailboxExportJob_organizationId
- The organization ID.
data CancelMailboxExportJobResponse Source #
See: newCancelMailboxExportJobResponse
smart constructor.
Instances
Eq CancelMailboxExportJobResponse Source # | |
Read CancelMailboxExportJobResponse Source # | |
Show CancelMailboxExportJobResponse Source # | |
Defined in Amazonka.WorkMail.CancelMailboxExportJob | |
Generic CancelMailboxExportJobResponse Source # | |
NFData CancelMailboxExportJobResponse Source # | |
Defined in Amazonka.WorkMail.CancelMailboxExportJob rnf :: CancelMailboxExportJobResponse -> () # | |
type Rep CancelMailboxExportJobResponse Source # | |
Defined in Amazonka.WorkMail.CancelMailboxExportJob type Rep CancelMailboxExportJobResponse = D1 ('MetaData "CancelMailboxExportJobResponse" "Amazonka.WorkMail.CancelMailboxExportJob" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "CancelMailboxExportJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
ListMobileDeviceAccessOverrides
data ListMobileDeviceAccessOverrides Source #
See: newListMobileDeviceAccessOverrides
smart constructor.
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:
$sel:userId: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
$sel:nextToken:ListMobileDeviceAccessOverrides'
, listMobileDeviceAccessOverrides_nextToken
- The token to use to retrieve the next page of results. The first call
does not require a token.
$sel:deviceId: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.
$sel:organizationId:ListMobileDeviceAccessOverrides'
, listMobileDeviceAccessOverrides_organizationId
- The Amazon WorkMail organization under which to list mobile device
access overrides.
data ListMobileDeviceAccessOverridesResponse Source #
See: newListMobileDeviceAccessOverridesResponse
smart constructor.
Instances
newListMobileDeviceAccessOverridesResponse Source #
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:
$sel:overrides:ListMobileDeviceAccessOverridesResponse'
, listMobileDeviceAccessOverridesResponse_overrides
- The list of mobile device access overrides that exist for the specified
Amazon WorkMail organization and user.
$sel:nextToken: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:httpStatus:ListMobileDeviceAccessOverridesResponse'
, listMobileDeviceAccessOverridesResponse_httpStatus
- The response's http status code.
DeleteMobileDeviceAccessOverride
data DeleteMobileDeviceAccessOverride Source #
See: newDeleteMobileDeviceAccessOverride
smart constructor.
Instances
newDeleteMobileDeviceAccessOverride Source #
:: 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:
$sel:organizationId:DeleteMobileDeviceAccessOverride'
, deleteMobileDeviceAccessOverride_organizationId
- The Amazon WorkMail organization for which the access override will be
deleted.
$sel:userId: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
$sel:deviceId:DeleteMobileDeviceAccessOverride'
, deleteMobileDeviceAccessOverride_deviceId
- The mobile device for which you delete the override. DeviceId
is case
insensitive.
data DeleteMobileDeviceAccessOverrideResponse Source #
See: newDeleteMobileDeviceAccessOverrideResponse
smart constructor.
Instances
Eq DeleteMobileDeviceAccessOverrideResponse Source # | |
Read DeleteMobileDeviceAccessOverrideResponse Source # | |
Show DeleteMobileDeviceAccessOverrideResponse Source # | |
Generic DeleteMobileDeviceAccessOverrideResponse Source # | |
Defined in Amazonka.WorkMail.DeleteMobileDeviceAccessOverride type Rep DeleteMobileDeviceAccessOverrideResponse :: Type -> Type # | |
NFData DeleteMobileDeviceAccessOverrideResponse Source # | |
type Rep DeleteMobileDeviceAccessOverrideResponse Source # | |
Defined in Amazonka.WorkMail.DeleteMobileDeviceAccessOverride type Rep DeleteMobileDeviceAccessOverrideResponse = D1 ('MetaData "DeleteMobileDeviceAccessOverrideResponse" "Amazonka.WorkMail.DeleteMobileDeviceAccessOverride" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DeleteMobileDeviceAccessOverrideResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteMobileDeviceAccessOverrideResponse Source #
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.
PutMobileDeviceAccessOverride
data PutMobileDeviceAccessOverride Source #
See: newPutMobileDeviceAccessOverride
smart constructor.
Instances
newPutMobileDeviceAccessOverride Source #
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:
$sel:description:PutMobileDeviceAccessOverride'
, putMobileDeviceAccessOverride_description
- A description of the override.
$sel:organizationId:PutMobileDeviceAccessOverride'
, putMobileDeviceAccessOverride_organizationId
- Identifies the Amazon WorkMail organization for which you create the
override.
$sel:userId: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
$sel:deviceId:PutMobileDeviceAccessOverride'
, putMobileDeviceAccessOverride_deviceId
- The mobile device for which you create the override. DeviceId
is case
insensitive.
$sel:effect:PutMobileDeviceAccessOverride'
, putMobileDeviceAccessOverride_effect
- The effect of the override, ALLOW
or DENY
.
data PutMobileDeviceAccessOverrideResponse Source #
See: newPutMobileDeviceAccessOverrideResponse
smart constructor.
Instances
newPutMobileDeviceAccessOverrideResponse Source #
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.
Types
AccessControlRuleEffect
newtype AccessControlRuleEffect Source #
pattern AccessControlRuleEffect_ALLOW :: AccessControlRuleEffect | |
pattern AccessControlRuleEffect_DENY :: AccessControlRuleEffect |
Instances
DnsRecordVerificationStatus
newtype DnsRecordVerificationStatus Source #
Instances
EntityState
newtype EntityState Source #
pattern EntityState_DELETED :: EntityState | |
pattern EntityState_DISABLED :: EntityState | |
pattern EntityState_ENABLED :: EntityState |
Instances
FolderName
newtype FolderName Source #
pattern FolderName_DELETED_ITEMS :: FolderName | |
pattern FolderName_DRAFTS :: FolderName | |
pattern FolderName_INBOX :: FolderName | |
pattern FolderName_JUNK_EMAIL :: FolderName | |
pattern FolderName_SENT_ITEMS :: FolderName |
Instances
MailboxExportJobState
newtype MailboxExportJobState Source #
pattern MailboxExportJobState_CANCELLED :: MailboxExportJobState | |
pattern MailboxExportJobState_COMPLETED :: MailboxExportJobState | |
pattern MailboxExportJobState_FAILED :: MailboxExportJobState | |
pattern MailboxExportJobState_RUNNING :: MailboxExportJobState |
Instances
MemberType
newtype MemberType Source #
pattern MemberType_GROUP :: MemberType | |
pattern MemberType_USER :: MemberType |
Instances
MobileDeviceAccessRuleEffect
newtype MobileDeviceAccessRuleEffect Source #
pattern MobileDeviceAccessRuleEffect_ALLOW :: MobileDeviceAccessRuleEffect | |
pattern MobileDeviceAccessRuleEffect_DENY :: MobileDeviceAccessRuleEffect |
Instances
PermissionType
newtype PermissionType Source #
pattern PermissionType_FULL_ACCESS :: PermissionType | |
pattern PermissionType_SEND_AS :: PermissionType | |
pattern PermissionType_SEND_ON_BEHALF :: PermissionType |
Instances
ResourceType
newtype ResourceType Source #
pattern ResourceType_EQUIPMENT :: ResourceType | |
pattern ResourceType_ROOM :: ResourceType |
Instances
RetentionAction
newtype RetentionAction Source #
pattern RetentionAction_DELETE :: RetentionAction | |
pattern RetentionAction_NONE :: RetentionAction | |
pattern RetentionAction_PERMANENTLY_DELETE :: RetentionAction |
Instances
UserRole
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 Amazon WorkMail organization.
See: newAccessControlRule
smart constructor.
AccessControlRule' (Maybe AccessControlRuleEffect) (Maybe [Text]) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe POSIX) (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:effect:AccessControlRule'
, accessControlRule_effect
- The rule effect.
$sel:userIds:AccessControlRule'
, accessControlRule_userIds
- User IDs to include in the rule.
$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:name:AccessControlRule'
, accessControlRule_name
- The rule name.
$sel:notUserIds:AccessControlRule'
, accessControlRule_notUserIds
- User IDs to exclude from the rule.
$sel:dateModified:AccessControlRule'
, accessControlRule_dateModified
- The date that the rule was modified.
$sel:ipRanges:AccessControlRule'
, accessControlRule_ipRanges
- IPv4 CIDR ranges to include in the rule.
$sel:notIpRanges:AccessControlRule'
, accessControlRule_notIpRanges
- IPv4 CIDR ranges to exclude from the rule.
$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:description:AccessControlRule'
, accessControlRule_description
- The rule description.
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: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.
$sel:autoAcceptRequests:BookingOptions'
, bookingOptions_autoAcceptRequests
- The resource's ability to automatically reply to requests. If disabled,
delegates must be associated to the resource.
Delegate
The name of the attribute, which is one of the values defined in the UserAttribute enumeration.
See: newDelegate
smart constructor.
Instances
Eq Delegate Source # | |
Read Delegate Source # | |
Show Delegate Source # | |
Generic Delegate Source # | |
NFData Delegate Source # | |
Defined in Amazonka.WorkMail.Types.Delegate | |
Hashable Delegate Source # | |
Defined in Amazonka.WorkMail.Types.Delegate | |
FromJSON Delegate Source # | |
type Rep Delegate Source # | |
Defined in Amazonka.WorkMail.Types.Delegate type Rep Delegate = D1 ('MetaData "Delegate" "Amazonka.WorkMail.Types.Delegate" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "Delegate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MemberType))) |
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
Eq DnsRecord Source # | |
Read DnsRecord Source # | |
Show DnsRecord Source # | |
Generic DnsRecord Source # | |
NFData DnsRecord Source # | |
Defined in Amazonka.WorkMail.Types.DnsRecord | |
Hashable DnsRecord Source # | |
Defined in Amazonka.WorkMail.Types.DnsRecord | |
FromJSON DnsRecord Source # | |
type Rep DnsRecord Source # | |
Defined in Amazonka.WorkMail.Types.DnsRecord type Rep DnsRecord = D1 ('MetaData "DnsRecord" "Amazonka.WorkMail.Types.DnsRecord" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DnsRecord'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") '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:value:DnsRecord'
, dnsRecord_value
- The value returned by the DNS for a query to that hostname and record
type.
$sel:type':DnsRecord'
, dnsRecord_type
- The RFC 1035 record type. Possible values: CNAME
, A
, MX
.
Domain
The domain to associate with an Amazon 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 Amazon WorkMail Administrator Guide.
See: newDomain
smart constructor.
Instances
Eq Domain Source # | |
Read Domain Source # | |
Show Domain Source # | |
Generic Domain Source # | |
NFData Domain Source # | |
Defined in Amazonka.WorkMail.Types.Domain | |
Hashable Domain Source # | |
Defined in Amazonka.WorkMail.Types.Domain | |
ToJSON 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" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "Domain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "domainName") '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:hostedZoneId:Domain'
, domain_hostedZoneId
- The hosted zone ID for a domain hosted in Route 53. Required when
configuring a domain hosted in Route 53.
$sel:domainName:Domain'
, domain_domainName
- The fully qualified domain name.
FolderConfiguration
data FolderConfiguration Source #
The configuration applied to an organization's folders by its retention policy.
See: newFolderConfiguration
smart constructor.
Instances
newFolderConfiguration Source #
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 Amazon WorkMail group.
See: newGroup
smart constructor.
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:email:Group'
, group_email
- The email of the group.
$sel:state:Group'
, group_state
- The state of the group, which can be ENABLED, DISABLED, or DELETED.
$sel:disabledDate:Group'
, group_disabledDate
- The date indicating when the group was disabled from Amazon WorkMail
use.
$sel:name:Group'
, group_name
- The name of the group.
$sel:id:Group'
, group_id
- The identifier of the group.
$sel:enabledDate:Group'
, group_enabledDate
- The date indicating when the group was enabled for Amazon WorkMail use.
MailDomainSummary
data MailDomainSummary Source #
The data for a given domain.
See: newMailDomainSummary
smart constructor.
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.
MailboxExportJob' (Maybe MailboxExportJobState) (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
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:state:MailboxExportJob'
, mailboxExportJob_state
- The state of the mailbox export job.
$sel:jobId:MailboxExportJob'
, mailboxExportJob_jobId
- The identifier of the mailbox export job.
$sel:startTime:MailboxExportJob'
, mailboxExportJob_startTime
- The mailbox export job start timestamp.
$sel:estimatedProgress:MailboxExportJob'
, mailboxExportJob_estimatedProgress
- The estimated progress of the mailbox export job, in percentage points.
$sel:endTime:MailboxExportJob'
, mailboxExportJob_endTime
- The mailbox export job end timestamp.
$sel:s3Path:MailboxExportJob'
, mailboxExportJob_s3Path
- The path to the S3 bucket and file that the mailbox export job exports
to.
$sel:entityId:MailboxExportJob'
, mailboxExportJob_entityId
- The identifier of the user or resource associated with the mailbox.
$sel:description:MailboxExportJob'
, mailboxExportJob_description
- The mailbox export job description.
$sel:s3BucketName:MailboxExportJob'
, mailboxExportJob_s3BucketName
- The name of the S3 bucket.
Member
The representation of a user or group.
See: newMember
smart constructor.
Member' (Maybe EntityState) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe MemberType) (Maybe POSIX) |
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:state:Member'
, member_state
- The state of the member, which can be ENABLED, DISABLED, or DELETED.
$sel:disabledDate:Member'
, member_disabledDate
- The date indicating when the member was disabled from Amazon WorkMail
use.
$sel:name:Member'
, member_name
- The name of the member.
$sel:id:Member'
, member_id
- The identifier of the member.
$sel:type':Member'
, member_type
- A member can be a user or group.
$sel:enabledDate:Member'
, member_enabledDate
- The date indicating when the member was enabled for Amazon WorkMail use.
MobileDeviceAccessMatchedRule
data MobileDeviceAccessMatchedRule Source #
The rule that a simulated user matches.
See: newMobileDeviceAccessMatchedRule
smart constructor.
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.
MobileDeviceAccessOverride' (Maybe MobileDeviceAccessRuleEffect) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (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: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.
$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:deviceId:MobileDeviceAccessOverride'
, mobileDeviceAccessOverride_deviceId
- The device to which the override applies.
$sel:description:MobileDeviceAccessOverride'
, mobileDeviceAccessOverride_description
- A description of the override.
MobileDeviceAccessRule
data MobileDeviceAccessRule Source #
A rule that controls access to mobile devices for an Amazon WorkMail group.
See: newMobileDeviceAccessRule
smart constructor.
MobileDeviceAccessRule' (Maybe MobileDeviceAccessRuleEffect) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe (NonEmpty Text)) (Maybe 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:effect:MobileDeviceAccessRule'
, mobileDeviceAccessRule_effect
- The effect of the rule when it matches. Allowed values are ALLOW
or
DENY
.
$sel:deviceUserAgents:MobileDeviceAccessRule'
, mobileDeviceAccessRule_deviceUserAgents
- Device user agents that a rule will match.
$sel:deviceTypes:MobileDeviceAccessRule'
, mobileDeviceAccessRule_deviceTypes
- Device types that a rule will match.
$sel:notDeviceTypes:MobileDeviceAccessRule'
, mobileDeviceAccessRule_notDeviceTypes
- Device types that a rule will not match. All other device types will
match.
$sel:notDeviceOperatingSystems:MobileDeviceAccessRule'
, mobileDeviceAccessRule_notDeviceOperatingSystems
- Device operating systems that a rule will not match. All other
device types will match.
$sel:dateCreated:MobileDeviceAccessRule'
, mobileDeviceAccessRule_dateCreated
- The date and time at which an access rule was created.
$sel:deviceModels:MobileDeviceAccessRule'
, mobileDeviceAccessRule_deviceModels
- Device models that a rule will match.
$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:dateModified:MobileDeviceAccessRule'
, mobileDeviceAccessRule_dateModified
- The date and time at which an access rule was modified.
$sel:deviceOperatingSystems:MobileDeviceAccessRule'
, mobileDeviceAccessRule_deviceOperatingSystems
- Device operating systems that a rule will match.
$sel:description:MobileDeviceAccessRule'
, mobileDeviceAccessRule_description
- The description of a mobile access rule.
$sel:notDeviceUserAgents:MobileDeviceAccessRule'
, mobileDeviceAccessRule_notDeviceUserAgents
- Device user agents that a rule will not match. All other device user
agents will match.
$sel:notDeviceModels:MobileDeviceAccessRule'
, mobileDeviceAccessRule_notDeviceModels
- Device models that a rule will not match. All other device models
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:state:OrganizationSummary'
, organizationSummary_state
- The state associated with the organization.
$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.
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.
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.
Resource
The representation of a resource.
See: newResource
smart constructor.
Resource' (Maybe Text) (Maybe EntityState) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ResourceType) (Maybe POSIX) |
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:email:Resource'
, resource_email
- The email of the resource.
$sel:state:Resource'
, resource_state
- The state of the resource, which can be ENABLED, DISABLED, or DELETED.
$sel:disabledDate:Resource'
, resource_disabledDate
- The date indicating when the resource was disabled from Amazon WorkMail
use.
$sel:name:Resource'
, resource_name
- The name of the resource.
$sel:id:Resource'
, resource_id
- The identifier of the resource.
$sel:type':Resource'
, resource_type
- The type of the resource: equipment or room.
$sel:enabledDate:Resource'
, resource_enabledDate
- The date indicating when the resource was enabled for Amazon WorkMail
use.
Tag
Describes a tag applied to a resource.
See: newTag
smart constructor.
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.WorkMail.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.WorkMail.Types.Tag | |
ToJSON Tag Source # | |
Defined in Amazonka.WorkMail.Types.Tag | |
FromJSON Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.WorkMail.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.WorkMail.Types.Tag" "libZSservicesZSamazonka-workmailZSamazonka-workmail" '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 Amazon WorkMail user.
See: newUser
smart constructor.
User' (Maybe Text) (Maybe EntityState) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserRole) (Maybe POSIX) |
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:email:User'
, user_email
- The email of the user.
$sel:state:User'
, user_state
- The state of the user, which can be ENABLED, DISABLED, or DELETED.
$sel:disabledDate:User'
, user_disabledDate
- The date indicating when the user was disabled from Amazon WorkMail use.
$sel:name:User'
, user_name
- The name of the user.
$sel:id:User'
, user_id
- The identifier of the user.
$sel:displayName:User'
, user_displayName
- The display name of the user.
$sel:userRole:User'
, user_userRole
- The role of the user.
$sel:enabledDate:User'
, user_enabledDate
- The date indicating when the user was enabled for Amazon WorkMail use.