| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.WorkMail.Types
Contents
- Service Configuration
- Errors
- AccessControlRuleEffect
- AccessEffect
- AvailabilityProviderType
- DnsRecordVerificationStatus
- EntityState
- FolderName
- ImpersonationRoleType
- MailboxExportJobState
- MemberType
- MobileDeviceAccessRuleEffect
- PermissionType
- ResourceType
- RetentionAction
- UserRole
- AccessControlRule
- AvailabilityConfiguration
- BookingOptions
- Delegate
- DnsRecord
- Domain
- EwsAvailabilityProvider
- FolderConfiguration
- Group
- ImpersonationMatchedRule
- ImpersonationRole
- ImpersonationRule
- LambdaAvailabilityProvider
- MailDomainSummary
- MailboxExportJob
- Member
- MobileDeviceAccessMatchedRule
- MobileDeviceAccessOverride
- MobileDeviceAccessRule
- OrganizationSummary
- Permission
- RedactedEwsAvailabilityProvider
- Resource
- Tag
- User
Description
Synopsis
- defaultService :: Service
- _DirectoryInUseException :: AsError a => Fold a ServiceError
- _DirectoryServiceAuthenticationFailedException :: AsError a => Fold a ServiceError
- _DirectoryUnavailableException :: AsError a => Fold a ServiceError
- _EmailAddressInUseException :: AsError a => Fold a ServiceError
- _EntityAlreadyRegisteredException :: AsError a => Fold a ServiceError
- _EntityNotFoundException :: AsError a => Fold a ServiceError
- _EntityStateException :: AsError a => Fold a ServiceError
- _InvalidConfigurationException :: AsError a => Fold a ServiceError
- _InvalidCustomSesConfigurationException :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _InvalidPasswordException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _MailDomainInUseException :: AsError a => Fold a ServiceError
- _MailDomainNotFoundException :: AsError a => Fold a ServiceError
- _MailDomainStateException :: AsError a => Fold a ServiceError
- _NameAvailabilityException :: AsError a => Fold a ServiceError
- _OrganizationNotFoundException :: AsError a => Fold a ServiceError
- _OrganizationStateException :: AsError a => Fold a ServiceError
- _ReservedNameException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- _UnsupportedOperationException :: AsError a => Fold a ServiceError
- newtype AccessControlRuleEffect where
- newtype AccessEffect where
- AccessEffect' { }
- pattern AccessEffect_ALLOW :: AccessEffect
- pattern AccessEffect_DENY :: AccessEffect
- newtype AvailabilityProviderType where
- newtype DnsRecordVerificationStatus where
- newtype EntityState where
- EntityState' { }
- pattern EntityState_DELETED :: EntityState
- pattern EntityState_DISABLED :: EntityState
- pattern EntityState_ENABLED :: EntityState
- newtype FolderName where
- FolderName' { }
- pattern FolderName_DELETED_ITEMS :: FolderName
- pattern FolderName_DRAFTS :: FolderName
- pattern FolderName_INBOX :: FolderName
- pattern FolderName_JUNK_EMAIL :: FolderName
- pattern FolderName_SENT_ITEMS :: FolderName
- newtype ImpersonationRoleType where
- newtype MailboxExportJobState where
- newtype MemberType where
- MemberType' { }
- pattern MemberType_GROUP :: MemberType
- pattern MemberType_USER :: MemberType
- newtype MobileDeviceAccessRuleEffect where
- newtype PermissionType where
- PermissionType' { }
- pattern PermissionType_FULL_ACCESS :: PermissionType
- pattern PermissionType_SEND_AS :: PermissionType
- pattern PermissionType_SEND_ON_BEHALF :: PermissionType
- newtype ResourceType where
- ResourceType' { }
- pattern ResourceType_EQUIPMENT :: ResourceType
- pattern ResourceType_ROOM :: ResourceType
- newtype RetentionAction where
- RetentionAction' { }
- pattern RetentionAction_DELETE :: RetentionAction
- pattern RetentionAction_NONE :: RetentionAction
- pattern RetentionAction_PERMANENTLY_DELETE :: RetentionAction
- newtype UserRole where
- UserRole' {
- fromUserRole :: Text
- pattern UserRole_RESOURCE :: UserRole
- pattern UserRole_SYSTEM_USER :: UserRole
- pattern UserRole_USER :: UserRole
- UserRole' {
- data AccessControlRule = AccessControlRule' {
- actions :: Maybe [Text]
- dateCreated :: Maybe POSIX
- dateModified :: Maybe POSIX
- description :: Maybe Text
- effect :: Maybe AccessControlRuleEffect
- impersonationRoleIds :: Maybe [Text]
- ipRanges :: Maybe [Text]
- name :: Maybe Text
- notActions :: Maybe [Text]
- notImpersonationRoleIds :: Maybe [Text]
- notIpRanges :: Maybe [Text]
- notUserIds :: Maybe [Text]
- userIds :: Maybe [Text]
- newAccessControlRule :: AccessControlRule
- accessControlRule_actions :: Lens' AccessControlRule (Maybe [Text])
- accessControlRule_dateCreated :: Lens' AccessControlRule (Maybe UTCTime)
- accessControlRule_dateModified :: Lens' AccessControlRule (Maybe UTCTime)
- accessControlRule_description :: Lens' AccessControlRule (Maybe Text)
- accessControlRule_effect :: Lens' AccessControlRule (Maybe AccessControlRuleEffect)
- accessControlRule_impersonationRoleIds :: Lens' AccessControlRule (Maybe [Text])
- accessControlRule_ipRanges :: Lens' AccessControlRule (Maybe [Text])
- accessControlRule_name :: Lens' AccessControlRule (Maybe Text)
- accessControlRule_notActions :: Lens' AccessControlRule (Maybe [Text])
- accessControlRule_notImpersonationRoleIds :: Lens' AccessControlRule (Maybe [Text])
- accessControlRule_notIpRanges :: Lens' AccessControlRule (Maybe [Text])
- accessControlRule_notUserIds :: Lens' AccessControlRule (Maybe [Text])
- accessControlRule_userIds :: Lens' AccessControlRule (Maybe [Text])
- data AvailabilityConfiguration = AvailabilityConfiguration' {}
- newAvailabilityConfiguration :: AvailabilityConfiguration
- availabilityConfiguration_dateCreated :: Lens' AvailabilityConfiguration (Maybe UTCTime)
- availabilityConfiguration_dateModified :: Lens' AvailabilityConfiguration (Maybe UTCTime)
- availabilityConfiguration_domainName :: Lens' AvailabilityConfiguration (Maybe Text)
- availabilityConfiguration_ewsProvider :: Lens' AvailabilityConfiguration (Maybe RedactedEwsAvailabilityProvider)
- availabilityConfiguration_lambdaProvider :: Lens' AvailabilityConfiguration (Maybe LambdaAvailabilityProvider)
- availabilityConfiguration_providerType :: Lens' AvailabilityConfiguration (Maybe AvailabilityProviderType)
- data BookingOptions = BookingOptions' {}
- newBookingOptions :: BookingOptions
- bookingOptions_autoAcceptRequests :: Lens' BookingOptions (Maybe Bool)
- bookingOptions_autoDeclineConflictingRequests :: Lens' BookingOptions (Maybe Bool)
- bookingOptions_autoDeclineRecurringRequests :: Lens' BookingOptions (Maybe Bool)
- data Delegate = Delegate' {
- id :: Text
- type' :: MemberType
- newDelegate :: Text -> MemberType -> Delegate
- delegate_id :: Lens' Delegate Text
- delegate_type :: Lens' Delegate MemberType
- data DnsRecord = DnsRecord' {}
- newDnsRecord :: DnsRecord
- dnsRecord_hostname :: Lens' DnsRecord (Maybe Text)
- dnsRecord_type :: Lens' DnsRecord (Maybe Text)
- dnsRecord_value :: Lens' DnsRecord (Maybe Text)
- data Domain = Domain' {
- domainName :: Maybe Text
- hostedZoneId :: Maybe Text
- newDomain :: Domain
- domain_domainName :: Lens' Domain (Maybe Text)
- domain_hostedZoneId :: Lens' Domain (Maybe Text)
- data EwsAvailabilityProvider = EwsAvailabilityProvider' {}
- newEwsAvailabilityProvider :: Text -> Text -> Text -> EwsAvailabilityProvider
- ewsAvailabilityProvider_ewsEndpoint :: Lens' EwsAvailabilityProvider Text
- ewsAvailabilityProvider_ewsUsername :: Lens' EwsAvailabilityProvider Text
- ewsAvailabilityProvider_ewsPassword :: Lens' EwsAvailabilityProvider Text
- data FolderConfiguration = FolderConfiguration' {}
- newFolderConfiguration :: FolderName -> RetentionAction -> FolderConfiguration
- folderConfiguration_period :: Lens' FolderConfiguration (Maybe Natural)
- folderConfiguration_name :: Lens' FolderConfiguration FolderName
- folderConfiguration_action :: Lens' FolderConfiguration RetentionAction
- data Group = Group' {}
- newGroup :: Group
- group_disabledDate :: Lens' Group (Maybe UTCTime)
- group_email :: Lens' Group (Maybe Text)
- group_enabledDate :: Lens' Group (Maybe UTCTime)
- group_id :: Lens' Group (Maybe Text)
- group_name :: Lens' Group (Maybe Text)
- group_state :: Lens' Group (Maybe EntityState)
- data ImpersonationMatchedRule = ImpersonationMatchedRule' {}
- newImpersonationMatchedRule :: ImpersonationMatchedRule
- impersonationMatchedRule_impersonationRuleId :: Lens' ImpersonationMatchedRule (Maybe Text)
- impersonationMatchedRule_name :: Lens' ImpersonationMatchedRule (Maybe Text)
- data ImpersonationRole = ImpersonationRole' {}
- newImpersonationRole :: ImpersonationRole
- impersonationRole_dateCreated :: Lens' ImpersonationRole (Maybe UTCTime)
- impersonationRole_dateModified :: Lens' ImpersonationRole (Maybe UTCTime)
- impersonationRole_impersonationRoleId :: Lens' ImpersonationRole (Maybe Text)
- impersonationRole_name :: Lens' ImpersonationRole (Maybe Text)
- impersonationRole_type :: Lens' ImpersonationRole (Maybe ImpersonationRoleType)
- data ImpersonationRule = ImpersonationRule' {
- description :: Maybe Text
- name :: Maybe Text
- notTargetUsers :: Maybe (NonEmpty Text)
- targetUsers :: Maybe (NonEmpty Text)
- impersonationRuleId :: Text
- effect :: AccessEffect
- newImpersonationRule :: Text -> AccessEffect -> ImpersonationRule
- impersonationRule_description :: Lens' ImpersonationRule (Maybe Text)
- impersonationRule_name :: Lens' ImpersonationRule (Maybe Text)
- impersonationRule_notTargetUsers :: Lens' ImpersonationRule (Maybe (NonEmpty Text))
- impersonationRule_targetUsers :: Lens' ImpersonationRule (Maybe (NonEmpty Text))
- impersonationRule_impersonationRuleId :: Lens' ImpersonationRule Text
- impersonationRule_effect :: Lens' ImpersonationRule AccessEffect
- data LambdaAvailabilityProvider = LambdaAvailabilityProvider' {}
- newLambdaAvailabilityProvider :: Text -> LambdaAvailabilityProvider
- lambdaAvailabilityProvider_lambdaArn :: Lens' LambdaAvailabilityProvider Text
- data MailDomainSummary = MailDomainSummary' {}
- newMailDomainSummary :: MailDomainSummary
- mailDomainSummary_defaultDomain :: Lens' MailDomainSummary (Maybe Bool)
- mailDomainSummary_domainName :: Lens' MailDomainSummary (Maybe Text)
- data MailboxExportJob = MailboxExportJob' {}
- newMailboxExportJob :: MailboxExportJob
- mailboxExportJob_description :: Lens' MailboxExportJob (Maybe Text)
- mailboxExportJob_endTime :: Lens' MailboxExportJob (Maybe UTCTime)
- mailboxExportJob_entityId :: Lens' MailboxExportJob (Maybe Text)
- mailboxExportJob_estimatedProgress :: Lens' MailboxExportJob (Maybe Natural)
- mailboxExportJob_jobId :: Lens' MailboxExportJob (Maybe Text)
- mailboxExportJob_s3BucketName :: Lens' MailboxExportJob (Maybe Text)
- mailboxExportJob_s3Path :: Lens' MailboxExportJob (Maybe Text)
- mailboxExportJob_startTime :: Lens' MailboxExportJob (Maybe UTCTime)
- mailboxExportJob_state :: Lens' MailboxExportJob (Maybe MailboxExportJobState)
- data Member = Member' {
- disabledDate :: Maybe POSIX
- enabledDate :: Maybe POSIX
- id :: Maybe Text
- name :: Maybe Text
- state :: Maybe EntityState
- type' :: Maybe MemberType
- newMember :: Member
- member_disabledDate :: Lens' Member (Maybe UTCTime)
- member_enabledDate :: Lens' Member (Maybe UTCTime)
- member_id :: Lens' Member (Maybe Text)
- member_name :: Lens' Member (Maybe Text)
- member_state :: Lens' Member (Maybe EntityState)
- member_type :: Lens' Member (Maybe MemberType)
- data MobileDeviceAccessMatchedRule = MobileDeviceAccessMatchedRule' {}
- newMobileDeviceAccessMatchedRule :: MobileDeviceAccessMatchedRule
- mobileDeviceAccessMatchedRule_mobileDeviceAccessRuleId :: Lens' MobileDeviceAccessMatchedRule (Maybe Text)
- mobileDeviceAccessMatchedRule_name :: Lens' MobileDeviceAccessMatchedRule (Maybe Text)
- data MobileDeviceAccessOverride = MobileDeviceAccessOverride' {}
- newMobileDeviceAccessOverride :: MobileDeviceAccessOverride
- mobileDeviceAccessOverride_dateCreated :: Lens' MobileDeviceAccessOverride (Maybe UTCTime)
- mobileDeviceAccessOverride_dateModified :: Lens' MobileDeviceAccessOverride (Maybe UTCTime)
- mobileDeviceAccessOverride_description :: Lens' MobileDeviceAccessOverride (Maybe Text)
- mobileDeviceAccessOverride_deviceId :: Lens' MobileDeviceAccessOverride (Maybe Text)
- mobileDeviceAccessOverride_effect :: Lens' MobileDeviceAccessOverride (Maybe MobileDeviceAccessRuleEffect)
- mobileDeviceAccessOverride_userId :: Lens' MobileDeviceAccessOverride (Maybe Text)
- data MobileDeviceAccessRule = MobileDeviceAccessRule' {
- dateCreated :: Maybe POSIX
- dateModified :: Maybe POSIX
- description :: Maybe Text
- deviceModels :: Maybe (NonEmpty Text)
- deviceOperatingSystems :: Maybe (NonEmpty Text)
- deviceTypes :: Maybe (NonEmpty Text)
- deviceUserAgents :: Maybe (NonEmpty Text)
- effect :: Maybe MobileDeviceAccessRuleEffect
- mobileDeviceAccessRuleId :: Maybe Text
- name :: Maybe Text
- notDeviceModels :: Maybe (NonEmpty Text)
- notDeviceOperatingSystems :: Maybe (NonEmpty Text)
- notDeviceTypes :: Maybe (NonEmpty Text)
- notDeviceUserAgents :: Maybe (NonEmpty Text)
- newMobileDeviceAccessRule :: MobileDeviceAccessRule
- mobileDeviceAccessRule_dateCreated :: Lens' MobileDeviceAccessRule (Maybe UTCTime)
- mobileDeviceAccessRule_dateModified :: Lens' MobileDeviceAccessRule (Maybe UTCTime)
- mobileDeviceAccessRule_description :: Lens' MobileDeviceAccessRule (Maybe Text)
- mobileDeviceAccessRule_deviceModels :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- mobileDeviceAccessRule_deviceOperatingSystems :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- mobileDeviceAccessRule_deviceTypes :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- mobileDeviceAccessRule_deviceUserAgents :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- mobileDeviceAccessRule_effect :: Lens' MobileDeviceAccessRule (Maybe MobileDeviceAccessRuleEffect)
- mobileDeviceAccessRule_mobileDeviceAccessRuleId :: Lens' MobileDeviceAccessRule (Maybe Text)
- mobileDeviceAccessRule_name :: Lens' MobileDeviceAccessRule (Maybe Text)
- mobileDeviceAccessRule_notDeviceModels :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- mobileDeviceAccessRule_notDeviceOperatingSystems :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- mobileDeviceAccessRule_notDeviceTypes :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- mobileDeviceAccessRule_notDeviceUserAgents :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- data OrganizationSummary = OrganizationSummary' {
- alias :: Maybe Text
- defaultMailDomain :: Maybe Text
- errorMessage :: Maybe Text
- organizationId :: Maybe Text
- state :: Maybe Text
- newOrganizationSummary :: OrganizationSummary
- organizationSummary_alias :: Lens' OrganizationSummary (Maybe Text)
- organizationSummary_defaultMailDomain :: Lens' OrganizationSummary (Maybe Text)
- organizationSummary_errorMessage :: Lens' OrganizationSummary (Maybe Text)
- organizationSummary_organizationId :: Lens' OrganizationSummary (Maybe Text)
- organizationSummary_state :: Lens' OrganizationSummary (Maybe Text)
- data Permission = Permission' {}
- newPermission :: Text -> MemberType -> Permission
- permission_granteeId :: Lens' Permission Text
- permission_granteeType :: Lens' Permission MemberType
- permission_permissionValues :: Lens' Permission [PermissionType]
- data RedactedEwsAvailabilityProvider = RedactedEwsAvailabilityProvider' {
- ewsEndpoint :: Maybe Text
- ewsUsername :: Maybe Text
- newRedactedEwsAvailabilityProvider :: RedactedEwsAvailabilityProvider
- redactedEwsAvailabilityProvider_ewsEndpoint :: Lens' RedactedEwsAvailabilityProvider (Maybe Text)
- redactedEwsAvailabilityProvider_ewsUsername :: Lens' RedactedEwsAvailabilityProvider (Maybe Text)
- data Resource = Resource' {}
- newResource :: Resource
- resource_disabledDate :: Lens' Resource (Maybe UTCTime)
- resource_email :: Lens' Resource (Maybe Text)
- resource_enabledDate :: Lens' Resource (Maybe UTCTime)
- resource_id :: Lens' Resource (Maybe Text)
- resource_name :: Lens' Resource (Maybe Text)
- resource_state :: Lens' Resource (Maybe EntityState)
- resource_type :: Lens' Resource (Maybe ResourceType)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data User = User' {}
- newUser :: User
- user_disabledDate :: Lens' User (Maybe UTCTime)
- user_displayName :: Lens' User (Maybe Text)
- user_email :: Lens' User (Maybe Text)
- user_enabledDate :: Lens' User (Maybe UTCTime)
- user_id :: Lens' User (Maybe Text)
- user_name :: Lens' User (Maybe Text)
- user_state :: Lens' User (Maybe EntityState)
- user_userRole :: Lens' User (Maybe UserRole)
Service Configuration
defaultService :: Service Source #
API version 2017-10-01 of the Amazon WorkMail SDK configuration.
Errors
_DirectoryInUseException :: AsError a => Fold a ServiceError Source #
The directory is already in use by another WorkMail organization in the same account and Region.
_DirectoryServiceAuthenticationFailedException :: AsError a => Fold a ServiceError Source #
The directory service doesn't recognize the credentials supplied by WorkMail.
_DirectoryUnavailableException :: AsError a => Fold a ServiceError Source #
The directory is unavailable. It might be located in another Region or deleted.
_EmailAddressInUseException :: AsError a => Fold a ServiceError Source #
The email address that you're trying to assign is already created for a different user, group, or resource.
_EntityAlreadyRegisteredException :: AsError a => Fold a ServiceError Source #
The user, group, or resource that you're trying to register is already registered.
_EntityNotFoundException :: AsError a => Fold a ServiceError Source #
The identifier supplied for the user, group, or resource does not exist in your organization.
_EntityStateException :: AsError a => Fold a ServiceError Source #
You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
_InvalidConfigurationException :: AsError a => Fold a ServiceError Source #
The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests or have at least one delegate associated that can do so on its behalf.
_InvalidCustomSesConfigurationException :: AsError a => Fold a ServiceError Source #
You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule.
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
One or more of the input parameters don't match the service's restrictions.
_InvalidPasswordException :: AsError a => Fold a ServiceError Source #
The supplied password doesn't match the minimum security constraints, such as length or use of special characters.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The request exceeds the limit of the resource.
_MailDomainInUseException :: AsError a => Fold a ServiceError Source #
The domain you're trying to change is in use by another user or organization in your account. See the error message for details.
_MailDomainNotFoundException :: AsError a => Fold a ServiceError Source #
The domain specified is not found in your organization.
_MailDomainStateException :: AsError a => Fold a ServiceError Source #
After a domain has been added to the organization, it must be verified. The domain is not yet verified.
_NameAvailabilityException :: AsError a => Fold a ServiceError Source #
The user, group, or resource name isn't unique in WorkMail.
_OrganizationNotFoundException :: AsError a => Fold a ServiceError Source #
An operation received a valid organization identifier that either doesn't belong or exist in the system.
_OrganizationStateException :: AsError a => Fold a ServiceError Source #
The organization must have a valid state to perform certain operations on the organization or its members.
_ReservedNameException :: AsError a => Fold a ServiceError Source #
This user, group, or resource name is not allowed in WorkMail.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource cannot be found.
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
The resource can have up to 50 user-applied tags.
_UnsupportedOperationException :: AsError a => Fold a ServiceError Source #
You can't perform a write operation against a read-only directory.
AccessControlRuleEffect
newtype AccessControlRuleEffect Source #
Constructors
| AccessControlRuleEffect' | |
Fields | |
Bundled Patterns
| pattern AccessControlRuleEffect_ALLOW :: AccessControlRuleEffect | |
| pattern AccessControlRuleEffect_DENY :: AccessControlRuleEffect |
Instances
AccessEffect
newtype AccessEffect Source #
Constructors
| AccessEffect' | |
Fields | |
Bundled Patterns
| pattern AccessEffect_ALLOW :: AccessEffect | |
| pattern AccessEffect_DENY :: AccessEffect |
Instances
AvailabilityProviderType
newtype AvailabilityProviderType Source #
Constructors
| AvailabilityProviderType' | |
Fields | |
Bundled Patterns
| pattern AvailabilityProviderType_EWS :: AvailabilityProviderType | |
| pattern AvailabilityProviderType_LAMBDA :: AvailabilityProviderType |
Instances
DnsRecordVerificationStatus
newtype DnsRecordVerificationStatus Source #
Constructors
| DnsRecordVerificationStatus' | |
Fields | |
Bundled Patterns
Instances
EntityState
newtype EntityState Source #
Constructors
| EntityState' | |
Fields | |
Bundled Patterns
| pattern EntityState_DELETED :: EntityState | |
| pattern EntityState_DISABLED :: EntityState | |
| pattern EntityState_ENABLED :: EntityState |
Instances
FolderName
newtype FolderName Source #
Constructors
| FolderName' | |
Fields | |
Bundled Patterns
| pattern FolderName_DELETED_ITEMS :: FolderName | |
| pattern FolderName_DRAFTS :: FolderName | |
| pattern FolderName_INBOX :: FolderName | |
| pattern FolderName_JUNK_EMAIL :: FolderName | |
| pattern FolderName_SENT_ITEMS :: FolderName |
Instances
ImpersonationRoleType
newtype ImpersonationRoleType Source #
Constructors
| ImpersonationRoleType' | |
Fields | |
Bundled Patterns
| pattern ImpersonationRoleType_FULL_ACCESS :: ImpersonationRoleType | |
| pattern ImpersonationRoleType_READ_ONLY :: ImpersonationRoleType |
Instances
MailboxExportJobState
newtype MailboxExportJobState Source #
Constructors
| MailboxExportJobState' | |
Fields | |
Bundled Patterns
| pattern MailboxExportJobState_CANCELLED :: MailboxExportJobState | |
| pattern MailboxExportJobState_COMPLETED :: MailboxExportJobState | |
| pattern MailboxExportJobState_FAILED :: MailboxExportJobState | |
| pattern MailboxExportJobState_RUNNING :: MailboxExportJobState |
Instances
MemberType
newtype MemberType Source #
Constructors
| MemberType' | |
Fields | |
Bundled Patterns
| pattern MemberType_GROUP :: MemberType | |
| pattern MemberType_USER :: MemberType |
Instances
MobileDeviceAccessRuleEffect
newtype MobileDeviceAccessRuleEffect Source #
Constructors
| MobileDeviceAccessRuleEffect' | |
Fields | |
Bundled Patterns
| pattern MobileDeviceAccessRuleEffect_ALLOW :: MobileDeviceAccessRuleEffect | |
| pattern MobileDeviceAccessRuleEffect_DENY :: MobileDeviceAccessRuleEffect |
Instances
PermissionType
newtype PermissionType Source #
Constructors
| PermissionType' | |
Fields | |
Bundled Patterns
| pattern PermissionType_FULL_ACCESS :: PermissionType | |
| pattern PermissionType_SEND_AS :: PermissionType | |
| pattern PermissionType_SEND_ON_BEHALF :: PermissionType |
Instances
ResourceType
newtype ResourceType Source #
Constructors
| ResourceType' | |
Fields | |
Bundled Patterns
| pattern ResourceType_EQUIPMENT :: ResourceType | |
| pattern ResourceType_ROOM :: ResourceType |
Instances
RetentionAction
newtype RetentionAction Source #
Constructors
| RetentionAction' | |
Fields | |
Bundled Patterns
| pattern RetentionAction_DELETE :: RetentionAction | |
| pattern RetentionAction_NONE :: RetentionAction | |
| pattern RetentionAction_PERMANENTLY_DELETE :: RetentionAction |
Instances
UserRole
Constructors
| UserRole' | |
Fields
| |
Bundled Patterns
| pattern UserRole_RESOURCE :: UserRole | |
| pattern UserRole_SYSTEM_USER :: UserRole | |
| pattern UserRole_USER :: UserRole |
Instances
AccessControlRule
data AccessControlRule Source #
A rule that controls access to an WorkMail organization.
See: newAccessControlRule smart constructor.
Constructors
| AccessControlRule' | |
Fields
| |
Instances
newAccessControlRule :: AccessControlRule Source #
Create a value of AccessControlRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actions:AccessControlRule', accessControlRule_actions - Access protocol actions to include in the rule. Valid values include
ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook,
and WebMail.
$sel:dateCreated:AccessControlRule', accessControlRule_dateCreated - The date that the rule was created.
$sel:dateModified:AccessControlRule', accessControlRule_dateModified - The date that the rule was modified.
$sel:description:AccessControlRule', accessControlRule_description - The rule description.
$sel:effect:AccessControlRule', accessControlRule_effect - The rule effect.
$sel:impersonationRoleIds:AccessControlRule', accessControlRule_impersonationRoleIds - Impersonation role IDs to include in the rule.
$sel:ipRanges:AccessControlRule', accessControlRule_ipRanges - IPv4 CIDR ranges to include in the rule.
$sel:name:AccessControlRule', accessControlRule_name - The rule name.
$sel:notActions:AccessControlRule', accessControlRule_notActions - Access protocol actions to exclude from the rule. Valid values include
ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook,
and WebMail.
$sel:notImpersonationRoleIds:AccessControlRule', accessControlRule_notImpersonationRoleIds - Impersonation role IDs to exclude from the rule.
$sel:notIpRanges:AccessControlRule', accessControlRule_notIpRanges - IPv4 CIDR ranges to exclude from the rule.
$sel:notUserIds:AccessControlRule', accessControlRule_notUserIds - User IDs to exclude from the rule.
$sel:userIds:AccessControlRule', accessControlRule_userIds - User IDs to include in the rule.
accessControlRule_actions :: Lens' AccessControlRule (Maybe [Text]) Source #
Access protocol actions to include in the rule. Valid values include
ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook,
and WebMail.
accessControlRule_dateCreated :: Lens' AccessControlRule (Maybe UTCTime) Source #
The date that the rule was created.
accessControlRule_dateModified :: Lens' AccessControlRule (Maybe UTCTime) Source #
The date that the rule was modified.
accessControlRule_description :: Lens' AccessControlRule (Maybe Text) Source #
The rule description.
accessControlRule_effect :: Lens' AccessControlRule (Maybe AccessControlRuleEffect) Source #
The rule effect.
accessControlRule_impersonationRoleIds :: Lens' AccessControlRule (Maybe [Text]) Source #
Impersonation role IDs to include in the rule.
accessControlRule_ipRanges :: Lens' AccessControlRule (Maybe [Text]) Source #
IPv4 CIDR ranges to include in the rule.
accessControlRule_name :: Lens' AccessControlRule (Maybe Text) Source #
The rule name.
accessControlRule_notActions :: Lens' AccessControlRule (Maybe [Text]) Source #
Access protocol actions to exclude from the rule. Valid values include
ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook,
and WebMail.
accessControlRule_notImpersonationRoleIds :: Lens' AccessControlRule (Maybe [Text]) Source #
Impersonation role IDs to exclude from the rule.
accessControlRule_notIpRanges :: Lens' AccessControlRule (Maybe [Text]) Source #
IPv4 CIDR ranges to exclude from the rule.
accessControlRule_notUserIds :: Lens' AccessControlRule (Maybe [Text]) Source #
User IDs to exclude from the rule.
accessControlRule_userIds :: Lens' AccessControlRule (Maybe [Text]) Source #
User IDs to include in the rule.
AvailabilityConfiguration
data AvailabilityConfiguration Source #
List all the AvailabilityConfiguration's for the given WorkMail
organization.
See: newAvailabilityConfiguration smart constructor.
Constructors
| AvailabilityConfiguration' | |
Fields
| |
Instances
newAvailabilityConfiguration :: AvailabilityConfiguration Source #
Create a value of AvailabilityConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dateCreated:AvailabilityConfiguration', availabilityConfiguration_dateCreated - The date and time at which the availability configuration was created.
$sel:dateModified:AvailabilityConfiguration', availabilityConfiguration_dateModified - The date and time at which the availability configuration was last
modified.
$sel:domainName:AvailabilityConfiguration', availabilityConfiguration_domainName - Displays the domain to which the provider applies.
$sel:ewsProvider:AvailabilityConfiguration', availabilityConfiguration_ewsProvider - If ProviderType is EWS, then this field contains
RedactedEwsAvailabilityProvider. Otherwise, it is not required.
$sel:lambdaProvider:AvailabilityConfiguration', availabilityConfiguration_lambdaProvider - If ProviderType is LAMBDA then this field contains
LambdaAvailabilityProvider. Otherwise, it is not required.
$sel:providerType:AvailabilityConfiguration', availabilityConfiguration_providerType - Displays the provider type that applies to this domain.
availabilityConfiguration_dateCreated :: Lens' AvailabilityConfiguration (Maybe UTCTime) Source #
The date and time at which the availability configuration was created.
availabilityConfiguration_dateModified :: Lens' AvailabilityConfiguration (Maybe UTCTime) Source #
The date and time at which the availability configuration was last modified.
availabilityConfiguration_domainName :: Lens' AvailabilityConfiguration (Maybe Text) Source #
Displays the domain to which the provider applies.
availabilityConfiguration_ewsProvider :: Lens' AvailabilityConfiguration (Maybe RedactedEwsAvailabilityProvider) Source #
If ProviderType is EWS, then this field contains
RedactedEwsAvailabilityProvider. Otherwise, it is not required.
availabilityConfiguration_lambdaProvider :: Lens' AvailabilityConfiguration (Maybe LambdaAvailabilityProvider) Source #
If ProviderType is LAMBDA then this field contains
LambdaAvailabilityProvider. Otherwise, it is not required.
availabilityConfiguration_providerType :: Lens' AvailabilityConfiguration (Maybe AvailabilityProviderType) Source #
Displays the provider type that applies to this domain.
BookingOptions
data BookingOptions Source #
At least one delegate must be associated to the resource to disable automatic replies from the resource.
See: newBookingOptions smart constructor.
Constructors
| BookingOptions' | |
Fields
| |
Instances
newBookingOptions :: BookingOptions Source #
Create a value of BookingOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoAcceptRequests:BookingOptions', bookingOptions_autoAcceptRequests - The resource's ability to automatically reply to requests. If disabled,
delegates must be associated to the resource.
$sel:autoDeclineConflictingRequests:BookingOptions', bookingOptions_autoDeclineConflictingRequests - The resource's ability to automatically decline any conflicting
requests.
$sel:autoDeclineRecurringRequests:BookingOptions', bookingOptions_autoDeclineRecurringRequests - The resource's ability to automatically decline any recurring requests.
bookingOptions_autoAcceptRequests :: Lens' BookingOptions (Maybe Bool) Source #
The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource.
bookingOptions_autoDeclineConflictingRequests :: Lens' BookingOptions (Maybe Bool) Source #
The resource's ability to automatically decline any conflicting requests.
bookingOptions_autoDeclineRecurringRequests :: Lens' BookingOptions (Maybe Bool) Source #
The resource's ability to automatically decline any recurring requests.
Delegate
The name of the attribute, which is one of the values defined in the UserAttribute enumeration.
See: newDelegate smart constructor.
Constructors
| Delegate' | |
Fields
| |
Instances
| FromJSON Delegate Source # | |
| Generic Delegate Source # | |
| Read Delegate Source # | |
| Show Delegate Source # | |
| NFData Delegate Source # | |
Defined in Amazonka.WorkMail.Types.Delegate | |
| Eq Delegate Source # | |
| Hashable Delegate Source # | |
Defined in Amazonka.WorkMail.Types.Delegate | |
| type Rep Delegate Source # | |
Defined in Amazonka.WorkMail.Types.Delegate type Rep Delegate = D1 ('MetaData "Delegate" "Amazonka.WorkMail.Types.Delegate" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "Delegate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MemberType))) | |
Arguments
| :: Text | |
| -> MemberType | |
| -> Delegate |
Create a value of Delegate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:Delegate', delegate_id - The identifier for the user or group associated as the resource's
delegate.
$sel:type':Delegate', delegate_type - The type of the delegate: user or group.
delegate_id :: Lens' Delegate Text Source #
The identifier for the user or group associated as the resource's delegate.
delegate_type :: Lens' Delegate MemberType Source #
The type of the delegate: user or group.
DnsRecord
A DNS record uploaded to your DNS provider.
See: newDnsRecord smart constructor.
Constructors
| DnsRecord' | |
Instances
| FromJSON DnsRecord Source # | |
| Generic DnsRecord Source # | |
| Read DnsRecord Source # | |
| Show DnsRecord Source # | |
| NFData DnsRecord Source # | |
Defined in Amazonka.WorkMail.Types.DnsRecord | |
| Eq DnsRecord Source # | |
| Hashable DnsRecord Source # | |
Defined in Amazonka.WorkMail.Types.DnsRecord | |
| type Rep DnsRecord Source # | |
Defined in Amazonka.WorkMail.Types.DnsRecord type Rep DnsRecord = D1 ('MetaData "DnsRecord" "Amazonka.WorkMail.Types.DnsRecord" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "DnsRecord'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newDnsRecord :: DnsRecord Source #
Create a value of DnsRecord with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hostname:DnsRecord', dnsRecord_hostname - The DNS hostname.- For example, domain.example.com.
$sel:type':DnsRecord', dnsRecord_type - The RFC 1035 record type. Possible values: CNAME, A, MX.
$sel:value:DnsRecord', dnsRecord_value - The value returned by the DNS for a query to that hostname and record
type.
dnsRecord_hostname :: Lens' DnsRecord (Maybe Text) Source #
The DNS hostname.- For example, domain.example.com.
dnsRecord_type :: Lens' DnsRecord (Maybe Text) Source #
The RFC 1035 record type. Possible values: CNAME, A, MX.
dnsRecord_value :: Lens' DnsRecord (Maybe Text) Source #
The value returned by the DNS for a query to that hostname and record type.
Domain
The domain to associate with an WorkMail organization.
When you configure a domain hosted in Amazon Route 53 (Route 53), all recommended DNS records are added to the organization when you create it. For more information, see Adding a domain in the WorkMail Administrator Guide.
See: newDomain smart constructor.
Constructors
| Domain' | |
Fields
| |
Instances
| ToJSON Domain Source # | |
Defined in Amazonka.WorkMail.Types.Domain | |
| Generic Domain Source # | |
| Read Domain Source # | |
| Show Domain Source # | |
| NFData Domain Source # | |
Defined in Amazonka.WorkMail.Types.Domain | |
| Eq Domain Source # | |
| Hashable Domain Source # | |
Defined in Amazonka.WorkMail.Types.Domain | |
| type Rep Domain Source # | |
Defined in Amazonka.WorkMail.Types.Domain type Rep Domain = D1 ('MetaData "Domain" "Amazonka.WorkMail.Types.Domain" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "Domain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Domain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:Domain', domain_domainName - The fully qualified domain name.
$sel:hostedZoneId:Domain', domain_hostedZoneId - The hosted zone ID for a domain hosted in Route 53. Required when
configuring a domain hosted in Route 53.
domain_hostedZoneId :: Lens' Domain (Maybe Text) Source #
The hosted zone ID for a domain hosted in Route 53. Required when configuring a domain hosted in Route 53.
EwsAvailabilityProvider
data EwsAvailabilityProvider Source #
Describes an EWS based availability provider. This is only used as input to the service.
See: newEwsAvailabilityProvider smart constructor.
Constructors
| EwsAvailabilityProvider' | |
Fields
| |
Instances
newEwsAvailabilityProvider Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> EwsAvailabilityProvider |
Create a value of EwsAvailabilityProvider with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ewsEndpoint:EwsAvailabilityProvider', ewsAvailabilityProvider_ewsEndpoint - The endpoint of the remote EWS server.
$sel:ewsUsername:EwsAvailabilityProvider', ewsAvailabilityProvider_ewsUsername - The username used to authenticate the remote EWS server.
$sel:ewsPassword:EwsAvailabilityProvider', ewsAvailabilityProvider_ewsPassword - The password used to authenticate the remote EWS server.
ewsAvailabilityProvider_ewsEndpoint :: Lens' EwsAvailabilityProvider Text Source #
The endpoint of the remote EWS server.
ewsAvailabilityProvider_ewsUsername :: Lens' EwsAvailabilityProvider Text Source #
The username used to authenticate the remote EWS server.
ewsAvailabilityProvider_ewsPassword :: Lens' EwsAvailabilityProvider Text Source #
The password used to authenticate the remote EWS server.
FolderConfiguration
data FolderConfiguration Source #
The configuration applied to an organization's folders by its retention policy.
See: newFolderConfiguration smart constructor.
Constructors
| FolderConfiguration' | |
Fields
| |
Instances
newFolderConfiguration Source #
Arguments
| :: FolderName | |
| -> RetentionAction | |
| -> FolderConfiguration |
Create a value of FolderConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:period:FolderConfiguration', folderConfiguration_period - The number of days for which the folder-configuration action applies.
$sel:name:FolderConfiguration', folderConfiguration_name - The folder name.
$sel:action:FolderConfiguration', folderConfiguration_action - The action to take on the folder contents at the end of the folder
configuration period.
folderConfiguration_period :: Lens' FolderConfiguration (Maybe Natural) Source #
The number of days for which the folder-configuration action applies.
folderConfiguration_name :: Lens' FolderConfiguration FolderName Source #
The folder name.
folderConfiguration_action :: Lens' FolderConfiguration RetentionAction Source #
The action to take on the folder contents at the end of the folder configuration period.
Group
The representation of an WorkMail group.
See: newGroup smart constructor.
Constructors
| Group' | |
Fields
| |
Instances
Create a value of Group with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:disabledDate:Group', group_disabledDate - The date indicating when the group was disabled from WorkMail use.
$sel:email:Group', group_email - The email of the group.
$sel:enabledDate:Group', group_enabledDate - The date indicating when the group was enabled for WorkMail use.
$sel:id:Group', group_id - The identifier of the group.
$sel:name:Group', group_name - The name of the group.
$sel:state:Group', group_state - The state of the group, which can be ENABLED, DISABLED, or DELETED.
group_disabledDate :: Lens' Group (Maybe UTCTime) Source #
The date indicating when the group was disabled from WorkMail use.
group_enabledDate :: Lens' Group (Maybe UTCTime) Source #
The date indicating when the group was enabled for WorkMail use.
group_state :: Lens' Group (Maybe EntityState) Source #
The state of the group, which can be ENABLED, DISABLED, or DELETED.
ImpersonationMatchedRule
data ImpersonationMatchedRule Source #
The impersonation rule that matched the input.
See: newImpersonationMatchedRule smart constructor.
Constructors
| ImpersonationMatchedRule' | |
Instances
newImpersonationMatchedRule :: ImpersonationMatchedRule Source #
Create a value of ImpersonationMatchedRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:impersonationRuleId:ImpersonationMatchedRule', impersonationMatchedRule_impersonationRuleId - The ID of the rule that matched the input
$sel:name:ImpersonationMatchedRule', impersonationMatchedRule_name - The name of the rule that matched the input.
impersonationMatchedRule_impersonationRuleId :: Lens' ImpersonationMatchedRule (Maybe Text) Source #
The ID of the rule that matched the input
impersonationMatchedRule_name :: Lens' ImpersonationMatchedRule (Maybe Text) Source #
The name of the rule that matched the input.
ImpersonationRole
data ImpersonationRole Source #
An impersonation role for the given WorkMail organization.
See: newImpersonationRole smart constructor.
Constructors
| ImpersonationRole' | |
Fields
| |
Instances
newImpersonationRole :: ImpersonationRole Source #
Create a value of ImpersonationRole with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dateCreated:ImpersonationRole', impersonationRole_dateCreated - The date when the impersonation role was created.
$sel:dateModified:ImpersonationRole', impersonationRole_dateModified - The date when the impersonation role was last modified.
$sel:impersonationRoleId:ImpersonationRole', impersonationRole_impersonationRoleId - The identifier of the impersonation role.
$sel:name:ImpersonationRole', impersonationRole_name - The impersonation role name.
$sel:type':ImpersonationRole', impersonationRole_type - The impersonation role type.
impersonationRole_dateCreated :: Lens' ImpersonationRole (Maybe UTCTime) Source #
The date when the impersonation role was created.
impersonationRole_dateModified :: Lens' ImpersonationRole (Maybe UTCTime) Source #
The date when the impersonation role was last modified.
impersonationRole_impersonationRoleId :: Lens' ImpersonationRole (Maybe Text) Source #
The identifier of the impersonation role.
impersonationRole_name :: Lens' ImpersonationRole (Maybe Text) Source #
The impersonation role name.
impersonationRole_type :: Lens' ImpersonationRole (Maybe ImpersonationRoleType) Source #
The impersonation role type.
ImpersonationRule
data ImpersonationRule Source #
The rules for the given impersonation role.
See: newImpersonationRule smart constructor.
Constructors
| ImpersonationRule' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> AccessEffect | |
| -> ImpersonationRule |
Create a value of ImpersonationRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:ImpersonationRule', impersonationRule_description - The rule description.
$sel:name:ImpersonationRule', impersonationRule_name - The rule name.
$sel:notTargetUsers:ImpersonationRule', impersonationRule_notTargetUsers - A list of user IDs that don't match the rule.
$sel:targetUsers:ImpersonationRule', impersonationRule_targetUsers - A list of user IDs that match the rule.
$sel:impersonationRuleId:ImpersonationRule', impersonationRule_impersonationRuleId - The identifier of the rule.
$sel:effect:ImpersonationRule', impersonationRule_effect - The effect of the rule when it matches the input. Allowed effect values
are ALLOW or DENY.
impersonationRule_description :: Lens' ImpersonationRule (Maybe Text) Source #
The rule description.
impersonationRule_name :: Lens' ImpersonationRule (Maybe Text) Source #
The rule name.
impersonationRule_notTargetUsers :: Lens' ImpersonationRule (Maybe (NonEmpty Text)) Source #
A list of user IDs that don't match the rule.
impersonationRule_targetUsers :: Lens' ImpersonationRule (Maybe (NonEmpty Text)) Source #
A list of user IDs that match the rule.
impersonationRule_impersonationRuleId :: Lens' ImpersonationRule Text Source #
The identifier of the rule.
impersonationRule_effect :: Lens' ImpersonationRule AccessEffect Source #
The effect of the rule when it matches the input. Allowed effect values
are ALLOW or DENY.
LambdaAvailabilityProvider
data LambdaAvailabilityProvider Source #
Describes a Lambda based availability provider.
See: newLambdaAvailabilityProvider smart constructor.
Constructors
| LambdaAvailabilityProvider' | |
Instances
newLambdaAvailabilityProvider Source #
Create a value of LambdaAvailabilityProvider with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lambdaArn:LambdaAvailabilityProvider', lambdaAvailabilityProvider_lambdaArn - The Amazon Resource Name (ARN) of the Lambda that acts as the
availability provider.
lambdaAvailabilityProvider_lambdaArn :: Lens' LambdaAvailabilityProvider Text Source #
The Amazon Resource Name (ARN) of the Lambda that acts as the availability provider.
MailDomainSummary
data MailDomainSummary Source #
The data for a given domain.
See: newMailDomainSummary smart constructor.
Constructors
| MailDomainSummary' | |
Fields
| |
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.
mailDomainSummary_defaultDomain :: Lens' MailDomainSummary (Maybe Bool) Source #
Whether the domain is default or not.
mailDomainSummary_domainName :: Lens' MailDomainSummary (Maybe Text) Source #
The domain name.
MailboxExportJob
data MailboxExportJob Source #
The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.
See: newMailboxExportJob smart constructor.
Constructors
| MailboxExportJob' | |
Fields
| |
Instances
newMailboxExportJob :: MailboxExportJob Source #
Create a value of MailboxExportJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:MailboxExportJob', mailboxExportJob_description - The mailbox export job description.
$sel:endTime:MailboxExportJob', mailboxExportJob_endTime - The mailbox export job end timestamp.
$sel:entityId:MailboxExportJob', mailboxExportJob_entityId - The identifier of the user or resource associated with the mailbox.
$sel:estimatedProgress:MailboxExportJob', mailboxExportJob_estimatedProgress - The estimated progress of the mailbox export job, in percentage points.
$sel:jobId:MailboxExportJob', mailboxExportJob_jobId - The identifier of the mailbox export job.
$sel:s3BucketName:MailboxExportJob', mailboxExportJob_s3BucketName - The name of the S3 bucket.
$sel:s3Path:MailboxExportJob', mailboxExportJob_s3Path - The path to the S3 bucket and file that the mailbox export job exports
to.
$sel:startTime:MailboxExportJob', mailboxExportJob_startTime - The mailbox export job start timestamp.
$sel:state:MailboxExportJob', mailboxExportJob_state - The state of the mailbox export job.
mailboxExportJob_description :: Lens' MailboxExportJob (Maybe Text) Source #
The mailbox export job description.
mailboxExportJob_endTime :: Lens' MailboxExportJob (Maybe UTCTime) Source #
The mailbox export job end timestamp.
mailboxExportJob_entityId :: Lens' MailboxExportJob (Maybe Text) Source #
The identifier of the user or resource associated with the mailbox.
mailboxExportJob_estimatedProgress :: Lens' MailboxExportJob (Maybe Natural) Source #
The estimated progress of the mailbox export job, in percentage points.
mailboxExportJob_jobId :: Lens' MailboxExportJob (Maybe Text) Source #
The identifier of the mailbox export job.
mailboxExportJob_s3BucketName :: Lens' MailboxExportJob (Maybe Text) Source #
The name of the S3 bucket.
mailboxExportJob_s3Path :: Lens' MailboxExportJob (Maybe Text) Source #
The path to the S3 bucket and file that the mailbox export job exports to.
mailboxExportJob_startTime :: Lens' MailboxExportJob (Maybe UTCTime) Source #
The mailbox export job start timestamp.
mailboxExportJob_state :: Lens' MailboxExportJob (Maybe MailboxExportJobState) Source #
The state of the mailbox export job.
Member
The representation of a user or group.
See: newMember smart constructor.
Constructors
| Member' | |
Fields
| |
Instances
Create a value of Member with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:disabledDate:Member', member_disabledDate - The date indicating when the member was disabled from WorkMail use.
$sel:enabledDate:Member', member_enabledDate - The date indicating when the member was enabled for WorkMail use.
$sel:id:Member', member_id - The identifier of the member.
$sel:name:Member', member_name - The name of the member.
$sel:state:Member', member_state - The state of the member, which can be ENABLED, DISABLED, or DELETED.
$sel:type':Member', member_type - A member can be a user or group.
member_disabledDate :: Lens' Member (Maybe UTCTime) Source #
The date indicating when the member was disabled from WorkMail use.
member_enabledDate :: Lens' Member (Maybe UTCTime) Source #
The date indicating when the member was enabled for WorkMail use.
member_state :: Lens' Member (Maybe EntityState) Source #
The state of the member, which can be ENABLED, DISABLED, or DELETED.
member_type :: Lens' Member (Maybe MemberType) Source #
A member can be a user or group.
MobileDeviceAccessMatchedRule
data MobileDeviceAccessMatchedRule Source #
The rule that a simulated user matches.
See: newMobileDeviceAccessMatchedRule smart constructor.
Constructors
| MobileDeviceAccessMatchedRule' | |
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.
mobileDeviceAccessMatchedRule_mobileDeviceAccessRuleId :: Lens' MobileDeviceAccessMatchedRule (Maybe Text) Source #
Identifier of the rule that a simulated user matches.
mobileDeviceAccessMatchedRule_name :: Lens' MobileDeviceAccessMatchedRule (Maybe Text) Source #
Name of a rule that a simulated user matches.
MobileDeviceAccessOverride
data MobileDeviceAccessOverride Source #
The override object.
See: newMobileDeviceAccessOverride smart constructor.
Constructors
| MobileDeviceAccessOverride' | |
Fields
| |
Instances
newMobileDeviceAccessOverride :: MobileDeviceAccessOverride Source #
Create a value of MobileDeviceAccessOverride with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dateCreated:MobileDeviceAccessOverride', mobileDeviceAccessOverride_dateCreated - The date the override was first created.
$sel:dateModified:MobileDeviceAccessOverride', mobileDeviceAccessOverride_dateModified - The date the override was last modified.
$sel:description:MobileDeviceAccessOverride', mobileDeviceAccessOverride_description - A description of the override.
$sel:deviceId:MobileDeviceAccessOverride', mobileDeviceAccessOverride_deviceId - The device to which the override applies.
$sel:effect:MobileDeviceAccessOverride', mobileDeviceAccessOverride_effect - The effect of the override, ALLOW or DENY.
$sel:userId:MobileDeviceAccessOverride', mobileDeviceAccessOverride_userId - The WorkMail user to which the access override applies.
mobileDeviceAccessOverride_dateCreated :: Lens' MobileDeviceAccessOverride (Maybe UTCTime) Source #
The date the override was first created.
mobileDeviceAccessOverride_dateModified :: Lens' MobileDeviceAccessOverride (Maybe UTCTime) Source #
The date the override was last modified.
mobileDeviceAccessOverride_description :: Lens' MobileDeviceAccessOverride (Maybe Text) Source #
A description of the override.
mobileDeviceAccessOverride_deviceId :: Lens' MobileDeviceAccessOverride (Maybe Text) Source #
The device to which the override applies.
mobileDeviceAccessOverride_effect :: Lens' MobileDeviceAccessOverride (Maybe MobileDeviceAccessRuleEffect) Source #
The effect of the override, ALLOW or DENY.
mobileDeviceAccessOverride_userId :: Lens' MobileDeviceAccessOverride (Maybe Text) Source #
The WorkMail user to which the access override applies.
MobileDeviceAccessRule
data MobileDeviceAccessRule Source #
A rule that controls access to mobile devices for an WorkMail group.
See: newMobileDeviceAccessRule smart constructor.
Constructors
| MobileDeviceAccessRule' | |
Fields
| |
Instances
newMobileDeviceAccessRule :: MobileDeviceAccessRule Source #
Create a value of MobileDeviceAccessRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dateCreated:MobileDeviceAccessRule', mobileDeviceAccessRule_dateCreated - The date and time at which an access rule was created.
$sel:dateModified:MobileDeviceAccessRule', mobileDeviceAccessRule_dateModified - The date and time at which an access rule was modified.
$sel:description:MobileDeviceAccessRule', mobileDeviceAccessRule_description - The description of a mobile access rule.
$sel:deviceModels:MobileDeviceAccessRule', mobileDeviceAccessRule_deviceModels - Device models that a rule will match.
$sel:deviceOperatingSystems:MobileDeviceAccessRule', mobileDeviceAccessRule_deviceOperatingSystems - Device operating systems that a rule will match.
$sel:deviceTypes:MobileDeviceAccessRule', mobileDeviceAccessRule_deviceTypes - Device types that a rule will match.
$sel:deviceUserAgents:MobileDeviceAccessRule', mobileDeviceAccessRule_deviceUserAgents - Device user agents that a rule will match.
$sel:effect:MobileDeviceAccessRule', mobileDeviceAccessRule_effect - The effect of the rule when it matches. Allowed values are ALLOW or
DENY.
$sel:mobileDeviceAccessRuleId:MobileDeviceAccessRule', mobileDeviceAccessRule_mobileDeviceAccessRuleId - The ID assigned to a mobile access rule.
$sel:name:MobileDeviceAccessRule', mobileDeviceAccessRule_name - The name of a mobile access rule.
$sel:notDeviceModels:MobileDeviceAccessRule', mobileDeviceAccessRule_notDeviceModels - Device models that a rule will not match. All other device models
will match.
$sel:notDeviceOperatingSystems:MobileDeviceAccessRule', mobileDeviceAccessRule_notDeviceOperatingSystems - Device operating systems that a rule will not match. All other
device types will match.
$sel:notDeviceTypes:MobileDeviceAccessRule', mobileDeviceAccessRule_notDeviceTypes - Device types that a rule will not match. All other device types will
match.
$sel:notDeviceUserAgents:MobileDeviceAccessRule', mobileDeviceAccessRule_notDeviceUserAgents - Device user agents that a rule will not match. All other device user
agents will match.
mobileDeviceAccessRule_dateCreated :: Lens' MobileDeviceAccessRule (Maybe UTCTime) Source #
The date and time at which an access rule was created.
mobileDeviceAccessRule_dateModified :: Lens' MobileDeviceAccessRule (Maybe UTCTime) Source #
The date and time at which an access rule was modified.
mobileDeviceAccessRule_description :: Lens' MobileDeviceAccessRule (Maybe Text) Source #
The description of a mobile access rule.
mobileDeviceAccessRule_deviceModels :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text)) Source #
Device models that a rule will match.
mobileDeviceAccessRule_deviceOperatingSystems :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text)) Source #
Device operating systems that a rule will match.
mobileDeviceAccessRule_deviceTypes :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text)) Source #
Device types that a rule will match.
mobileDeviceAccessRule_deviceUserAgents :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text)) Source #
Device user agents that a rule will match.
mobileDeviceAccessRule_effect :: Lens' MobileDeviceAccessRule (Maybe MobileDeviceAccessRuleEffect) Source #
The effect of the rule when it matches. Allowed values are ALLOW or
DENY.
mobileDeviceAccessRule_mobileDeviceAccessRuleId :: Lens' MobileDeviceAccessRule (Maybe Text) Source #
The ID assigned to a mobile access rule.
mobileDeviceAccessRule_name :: Lens' MobileDeviceAccessRule (Maybe Text) Source #
The name of a mobile access rule.
mobileDeviceAccessRule_notDeviceModels :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text)) Source #
Device models that a rule will not match. All other device models will match.
mobileDeviceAccessRule_notDeviceOperatingSystems :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text)) Source #
Device operating systems that a rule will not match. All other device types will match.
mobileDeviceAccessRule_notDeviceTypes :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text)) Source #
Device types that a rule will not match. All other device types will match.
mobileDeviceAccessRule_notDeviceUserAgents :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text)) Source #
Device user agents that a rule will not match. All other device user agents will match.
OrganizationSummary
data OrganizationSummary Source #
The representation of an organization.
See: newOrganizationSummary smart constructor.
Constructors
| OrganizationSummary' | |
Fields
| |
Instances
newOrganizationSummary :: OrganizationSummary Source #
Create a value of OrganizationSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alias:OrganizationSummary', organizationSummary_alias - The alias associated with the organization.
$sel:defaultMailDomain:OrganizationSummary', organizationSummary_defaultMailDomain - The default email domain associated with the organization.
$sel:errorMessage:OrganizationSummary', organizationSummary_errorMessage - The error message associated with the organization. It is only present
if unexpected behavior has occurred with regards to the organization. It
provides insight or solutions regarding unexpected behavior.
$sel:organizationId:OrganizationSummary', organizationSummary_organizationId - The identifier associated with the organization.
$sel:state:OrganizationSummary', organizationSummary_state - The state associated with the organization.
organizationSummary_alias :: Lens' OrganizationSummary (Maybe Text) Source #
The alias associated with the organization.
organizationSummary_defaultMailDomain :: Lens' OrganizationSummary (Maybe Text) Source #
The default email domain associated with the organization.
organizationSummary_errorMessage :: Lens' OrganizationSummary (Maybe Text) Source #
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.
organizationSummary_organizationId :: Lens' OrganizationSummary (Maybe Text) Source #
The identifier associated with the organization.
organizationSummary_state :: Lens' OrganizationSummary (Maybe Text) Source #
The state associated with the organization.
Permission
data Permission Source #
Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.
See: newPermission smart constructor.
Constructors
| Permission' | |
Fields
| |
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.
permission_granteeId :: Lens' Permission Text Source #
The identifier of the user, group, or resource to which the permissions are granted.
permission_granteeType :: Lens' Permission MemberType Source #
The type of user, group, or resource referred to in GranteeId.
permission_permissionValues :: Lens' Permission [PermissionType] Source #
The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.
RedactedEwsAvailabilityProvider
data RedactedEwsAvailabilityProvider Source #
Describes an EWS based availability provider when returned from the service. It does not contain the password of the endpoint.
See: newRedactedEwsAvailabilityProvider smart constructor.
Constructors
| RedactedEwsAvailabilityProvider' | |
Fields
| |
Instances
newRedactedEwsAvailabilityProvider :: RedactedEwsAvailabilityProvider Source #
Create a value of RedactedEwsAvailabilityProvider with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ewsEndpoint:RedactedEwsAvailabilityProvider', redactedEwsAvailabilityProvider_ewsEndpoint - The endpoint of the remote EWS server.
$sel:ewsUsername:RedactedEwsAvailabilityProvider', redactedEwsAvailabilityProvider_ewsUsername - The username used to authenticate the remote EWS server.
redactedEwsAvailabilityProvider_ewsEndpoint :: Lens' RedactedEwsAvailabilityProvider (Maybe Text) Source #
The endpoint of the remote EWS server.
redactedEwsAvailabilityProvider_ewsUsername :: Lens' RedactedEwsAvailabilityProvider (Maybe Text) Source #
The username used to authenticate the remote EWS server.
Resource
The representation of a resource.
See: newResource smart constructor.
Constructors
| Resource' | |
Fields
| |
Instances
newResource :: Resource Source #
Create a value of Resource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:disabledDate:Resource', resource_disabledDate - The date indicating when the resource was disabled from WorkMail use.
$sel:email:Resource', resource_email - The email of the resource.
$sel:enabledDate:Resource', resource_enabledDate - The date indicating when the resource was enabled for WorkMail use.
$sel:id:Resource', resource_id - The identifier of the resource.
$sel:name:Resource', resource_name - The name of the resource.
$sel:state:Resource', resource_state - The state of the resource, which can be ENABLED, DISABLED, or DELETED.
$sel:type':Resource', resource_type - The type of the resource: equipment or room.
resource_disabledDate :: Lens' Resource (Maybe UTCTime) Source #
The date indicating when the resource was disabled from WorkMail use.
resource_enabledDate :: Lens' Resource (Maybe UTCTime) Source #
The date indicating when the resource was enabled for WorkMail use.
resource_state :: Lens' Resource (Maybe EntityState) Source #
The state of the resource, which can be ENABLED, DISABLED, or DELETED.
resource_type :: Lens' Resource (Maybe ResourceType) Source #
The type of the resource: equipment or room.
Tag
Describes a tag applied to a resource.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.WorkMail.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.WorkMail.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.WorkMail.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.WorkMail.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.WorkMail.Types.Tag" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The key of the tag.
$sel:value:Tag', tag_value - The value of the tag.
User
The representation of an WorkMail user.
See: newUser smart constructor.
Constructors
| User' | |
Fields
| |
Instances
Create a value of User with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:disabledDate:User', user_disabledDate - The date indicating when the user was disabled from WorkMail use.
$sel:displayName:User', user_displayName - The display name of the user.
$sel:email:User', user_email - The email of the user.
$sel:enabledDate:User', user_enabledDate - The date indicating when the user was enabled for WorkMail use.
$sel:id:User', user_id - The identifier of the user.
$sel:name:User', user_name - The name of the user.
$sel:state:User', user_state - The state of the user, which can be ENABLED, DISABLED, or DELETED.
$sel:userRole:User', user_userRole - The role of the user.
user_disabledDate :: Lens' User (Maybe UTCTime) Source #
The date indicating when the user was disabled from WorkMail use.
user_enabledDate :: Lens' User (Maybe UTCTime) Source #
The date indicating when the user was enabled for WorkMail use.
user_state :: Lens' User (Maybe EntityState) Source #
The state of the user, which can be ENABLED, DISABLED, or DELETED.