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
- 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
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
- 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' {
- effect :: Maybe AccessControlRuleEffect
- userIds :: Maybe [Text]
- actions :: Maybe [Text]
- dateCreated :: Maybe POSIX
- name :: Maybe Text
- notUserIds :: Maybe [Text]
- dateModified :: Maybe POSIX
- ipRanges :: Maybe [Text]
- notIpRanges :: Maybe [Text]
- notActions :: Maybe [Text]
- description :: Maybe Text
- newAccessControlRule :: AccessControlRule
- accessControlRule_effect :: Lens' AccessControlRule (Maybe AccessControlRuleEffect)
- accessControlRule_userIds :: Lens' AccessControlRule (Maybe [Text])
- accessControlRule_actions :: Lens' AccessControlRule (Maybe [Text])
- accessControlRule_dateCreated :: Lens' AccessControlRule (Maybe UTCTime)
- accessControlRule_name :: Lens' AccessControlRule (Maybe Text)
- accessControlRule_notUserIds :: Lens' AccessControlRule (Maybe [Text])
- accessControlRule_dateModified :: Lens' AccessControlRule (Maybe UTCTime)
- accessControlRule_ipRanges :: Lens' AccessControlRule (Maybe [Text])
- accessControlRule_notIpRanges :: Lens' AccessControlRule (Maybe [Text])
- accessControlRule_notActions :: Lens' AccessControlRule (Maybe [Text])
- accessControlRule_description :: Lens' AccessControlRule (Maybe Text)
- data BookingOptions = BookingOptions' {}
- newBookingOptions :: BookingOptions
- bookingOptions_autoDeclineConflictingRequests :: Lens' BookingOptions (Maybe Bool)
- bookingOptions_autoDeclineRecurringRequests :: Lens' BookingOptions (Maybe Bool)
- bookingOptions_autoAcceptRequests :: 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_value :: Lens' DnsRecord (Maybe Text)
- dnsRecord_type :: Lens' DnsRecord (Maybe Text)
- data Domain = Domain' {
- hostedZoneId :: Maybe Text
- domainName :: Maybe Text
- newDomain :: Domain
- domain_hostedZoneId :: Lens' Domain (Maybe Text)
- domain_domainName :: Lens' Domain (Maybe 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_email :: Lens' Group (Maybe Text)
- group_state :: Lens' Group (Maybe EntityState)
- group_disabledDate :: Lens' Group (Maybe UTCTime)
- group_name :: Lens' Group (Maybe Text)
- group_id :: Lens' Group (Maybe Text)
- group_enabledDate :: Lens' Group (Maybe UTCTime)
- data MailDomainSummary = MailDomainSummary' {}
- newMailDomainSummary :: MailDomainSummary
- mailDomainSummary_defaultDomain :: Lens' MailDomainSummary (Maybe Bool)
- mailDomainSummary_domainName :: Lens' MailDomainSummary (Maybe Text)
- data MailboxExportJob = MailboxExportJob' {}
- newMailboxExportJob :: MailboxExportJob
- mailboxExportJob_state :: Lens' MailboxExportJob (Maybe MailboxExportJobState)
- mailboxExportJob_jobId :: Lens' MailboxExportJob (Maybe Text)
- mailboxExportJob_startTime :: Lens' MailboxExportJob (Maybe UTCTime)
- mailboxExportJob_estimatedProgress :: Lens' MailboxExportJob (Maybe Natural)
- mailboxExportJob_endTime :: Lens' MailboxExportJob (Maybe UTCTime)
- mailboxExportJob_s3Path :: Lens' MailboxExportJob (Maybe Text)
- mailboxExportJob_entityId :: Lens' MailboxExportJob (Maybe Text)
- mailboxExportJob_description :: Lens' MailboxExportJob (Maybe Text)
- mailboxExportJob_s3BucketName :: Lens' MailboxExportJob (Maybe Text)
- data Member = Member' {
- state :: Maybe EntityState
- disabledDate :: Maybe POSIX
- name :: Maybe Text
- id :: Maybe Text
- type' :: Maybe MemberType
- enabledDate :: Maybe POSIX
- newMember :: Member
- member_state :: Lens' Member (Maybe EntityState)
- member_disabledDate :: Lens' Member (Maybe UTCTime)
- member_name :: Lens' Member (Maybe Text)
- member_id :: Lens' Member (Maybe Text)
- member_type :: Lens' Member (Maybe MemberType)
- member_enabledDate :: Lens' Member (Maybe UTCTime)
- data MobileDeviceAccessMatchedRule = MobileDeviceAccessMatchedRule' {}
- newMobileDeviceAccessMatchedRule :: MobileDeviceAccessMatchedRule
- mobileDeviceAccessMatchedRule_mobileDeviceAccessRuleId :: Lens' MobileDeviceAccessMatchedRule (Maybe Text)
- mobileDeviceAccessMatchedRule_name :: Lens' MobileDeviceAccessMatchedRule (Maybe Text)
- data MobileDeviceAccessOverride = MobileDeviceAccessOverride' {}
- newMobileDeviceAccessOverride :: MobileDeviceAccessOverride
- mobileDeviceAccessOverride_effect :: Lens' MobileDeviceAccessOverride (Maybe MobileDeviceAccessRuleEffect)
- mobileDeviceAccessOverride_userId :: Lens' MobileDeviceAccessOverride (Maybe Text)
- mobileDeviceAccessOverride_dateCreated :: Lens' MobileDeviceAccessOverride (Maybe UTCTime)
- mobileDeviceAccessOverride_dateModified :: Lens' MobileDeviceAccessOverride (Maybe UTCTime)
- mobileDeviceAccessOverride_deviceId :: Lens' MobileDeviceAccessOverride (Maybe Text)
- mobileDeviceAccessOverride_description :: Lens' MobileDeviceAccessOverride (Maybe Text)
- data MobileDeviceAccessRule = MobileDeviceAccessRule' {
- effect :: Maybe MobileDeviceAccessRuleEffect
- deviceUserAgents :: Maybe (NonEmpty Text)
- deviceTypes :: Maybe (NonEmpty Text)
- notDeviceTypes :: Maybe (NonEmpty Text)
- notDeviceOperatingSystems :: Maybe (NonEmpty Text)
- dateCreated :: Maybe POSIX
- deviceModels :: Maybe (NonEmpty Text)
- mobileDeviceAccessRuleId :: Maybe Text
- name :: Maybe Text
- dateModified :: Maybe POSIX
- deviceOperatingSystems :: Maybe (NonEmpty Text)
- description :: Maybe Text
- notDeviceUserAgents :: Maybe (NonEmpty Text)
- notDeviceModels :: Maybe (NonEmpty Text)
- newMobileDeviceAccessRule :: MobileDeviceAccessRule
- mobileDeviceAccessRule_effect :: Lens' MobileDeviceAccessRule (Maybe MobileDeviceAccessRuleEffect)
- mobileDeviceAccessRule_deviceUserAgents :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- mobileDeviceAccessRule_deviceTypes :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- mobileDeviceAccessRule_notDeviceTypes :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- mobileDeviceAccessRule_notDeviceOperatingSystems :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- mobileDeviceAccessRule_dateCreated :: Lens' MobileDeviceAccessRule (Maybe UTCTime)
- mobileDeviceAccessRule_deviceModels :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- mobileDeviceAccessRule_mobileDeviceAccessRuleId :: Lens' MobileDeviceAccessRule (Maybe Text)
- mobileDeviceAccessRule_name :: Lens' MobileDeviceAccessRule (Maybe Text)
- mobileDeviceAccessRule_dateModified :: Lens' MobileDeviceAccessRule (Maybe UTCTime)
- mobileDeviceAccessRule_deviceOperatingSystems :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- mobileDeviceAccessRule_description :: Lens' MobileDeviceAccessRule (Maybe Text)
- mobileDeviceAccessRule_notDeviceUserAgents :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- mobileDeviceAccessRule_notDeviceModels :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text))
- data OrganizationSummary = OrganizationSummary' {
- state :: Maybe Text
- alias :: Maybe Text
- defaultMailDomain :: Maybe Text
- errorMessage :: Maybe Text
- organizationId :: Maybe Text
- newOrganizationSummary :: OrganizationSummary
- organizationSummary_state :: Lens' OrganizationSummary (Maybe Text)
- organizationSummary_alias :: Lens' OrganizationSummary (Maybe Text)
- organizationSummary_defaultMailDomain :: Lens' OrganizationSummary (Maybe Text)
- organizationSummary_errorMessage :: Lens' OrganizationSummary (Maybe Text)
- organizationSummary_organizationId :: 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 Resource = Resource' {}
- newResource :: Resource
- resource_email :: Lens' Resource (Maybe Text)
- resource_state :: Lens' Resource (Maybe EntityState)
- resource_disabledDate :: Lens' Resource (Maybe UTCTime)
- resource_name :: Lens' Resource (Maybe Text)
- resource_id :: Lens' Resource (Maybe Text)
- resource_type :: Lens' Resource (Maybe ResourceType)
- resource_enabledDate :: Lens' Resource (Maybe UTCTime)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data User = User' {}
- newUser :: User
- user_email :: Lens' User (Maybe Text)
- user_state :: Lens' User (Maybe EntityState)
- user_disabledDate :: Lens' User (Maybe UTCTime)
- user_name :: Lens' User (Maybe Text)
- user_id :: Lens' User (Maybe Text)
- user_displayName :: Lens' User (Maybe Text)
- user_userRole :: Lens' User (Maybe UserRole)
- user_enabledDate :: Lens' User (Maybe UTCTime)
Service Configuration
defaultService :: Service Source #
API version 2017-10-01
of the Amazon WorkMail SDK configuration.
Errors
_DirectoryUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The directory is unavailable. It might be located in another Region or deleted.
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more of the input parameters don't match the service's restrictions.
_UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't perform a write operation against a read-only directory.
_DirectoryServiceAuthenticationFailedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The directory service doesn't recognize the credentials supplied by WorkMail.
_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 :: 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 :: 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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource can have up to 50 user-applied tags.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
This user, group, or resource name is not allowed in Amazon WorkMail.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
The identifier supplied for the user, group, or resource does not exist in your organization.
_EntityAlreadyRegisteredException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user, group, or resource that you're trying to register is already registered.
_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 :: 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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
The domain specified is not found in your organization.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource cannot be found.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user, group, or resource name isn't unique in Amazon WorkMail.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request exceeds the limit of the resource.
_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.
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' | |
|
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.
accessControlRule_effect :: Lens' AccessControlRule (Maybe AccessControlRuleEffect) Source #
The rule effect.
accessControlRule_userIds :: Lens' AccessControlRule (Maybe [Text]) Source #
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_name :: Lens' AccessControlRule (Maybe Text) Source #
The rule name.
accessControlRule_notUserIds :: Lens' AccessControlRule (Maybe [Text]) Source #
User IDs to exclude from the rule.
accessControlRule_dateModified :: Lens' AccessControlRule (Maybe UTCTime) Source #
The date that the rule was modified.
accessControlRule_ipRanges :: Lens' AccessControlRule (Maybe [Text]) Source #
IPv4 CIDR ranges to include in the rule.
accessControlRule_notIpRanges :: Lens' AccessControlRule (Maybe [Text]) Source #
IPv4 CIDR ranges to exclude from the rule.
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_description :: Lens' AccessControlRule (Maybe Text) Source #
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.
BookingOptions' | |
|
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.
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.
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.
Delegate
The name of the attribute, which is one of the values defined in the UserAttribute enumeration.
See: newDelegate
smart constructor.
Delegate' | |
|
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.
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.
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
.
dnsRecord_hostname :: Lens' DnsRecord (Maybe Text) Source #
The DNS hostname.- For example, domain.example.com
.
dnsRecord_value :: Lens' DnsRecord (Maybe Text) Source #
The value returned by the DNS for a query to that hostname and record type.
dnsRecord_type :: Lens' DnsRecord (Maybe Text) Source #
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.
Domain' | |
|
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.
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.
FolderConfiguration
data FolderConfiguration Source #
The configuration applied to an organization's folders by its retention policy.
See: newFolderConfiguration
smart constructor.
FolderConfiguration' | |
|
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.
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 Amazon WorkMail group.
See: newGroup
smart constructor.
Group' | |
|
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.
group_state :: Lens' Group (Maybe EntityState) Source #
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 Amazon WorkMail use.
group_enabledDate :: Lens' Group (Maybe UTCTime) Source #
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.
MailDomainSummary' | |
|
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.
MailboxExportJob' | |
|
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.
mailboxExportJob_state :: Lens' MailboxExportJob (Maybe MailboxExportJobState) Source #
The state of the mailbox export job.
mailboxExportJob_jobId :: Lens' MailboxExportJob (Maybe Text) Source #
The identifier of the mailbox export job.
mailboxExportJob_startTime :: Lens' MailboxExportJob (Maybe UTCTime) Source #
The mailbox export job start timestamp.
mailboxExportJob_estimatedProgress :: Lens' MailboxExportJob (Maybe Natural) Source #
The estimated progress of the mailbox export job, in percentage points.
mailboxExportJob_endTime :: Lens' MailboxExportJob (Maybe UTCTime) Source #
The mailbox export job end timestamp.
mailboxExportJob_s3Path :: Lens' MailboxExportJob (Maybe Text) Source #
The path to the S3 bucket and file that the mailbox export job exports to.
mailboxExportJob_entityId :: Lens' MailboxExportJob (Maybe Text) Source #
The identifier of the user or resource associated with the mailbox.
mailboxExportJob_description :: Lens' MailboxExportJob (Maybe Text) Source #
The mailbox export job description.
mailboxExportJob_s3BucketName :: Lens' MailboxExportJob (Maybe Text) Source #
The name of the S3 bucket.
Member
The representation of a user or group.
See: newMember
smart constructor.
Member' | |
|
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.
member_state :: Lens' Member (Maybe EntityState) Source #
The state of the member, which can be ENABLED, DISABLED, or DELETED.
member_disabledDate :: Lens' Member (Maybe UTCTime) Source #
The date indicating when the member was disabled from Amazon WorkMail use.
member_type :: Lens' Member (Maybe MemberType) Source #
A member can be a user or group.
member_enabledDate :: Lens' Member (Maybe UTCTime) Source #
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.
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.
MobileDeviceAccessOverride' | |
|
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.
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.
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_deviceId :: Lens' MobileDeviceAccessOverride (Maybe Text) Source #
The device to which the override applies.
mobileDeviceAccessOverride_description :: Lens' MobileDeviceAccessOverride (Maybe Text) Source #
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' | |
|
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.
mobileDeviceAccessRule_effect :: Lens' MobileDeviceAccessRule (Maybe MobileDeviceAccessRuleEffect) Source #
The effect of the rule when it matches. Allowed values are ALLOW
or
DENY
.
mobileDeviceAccessRule_deviceUserAgents :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text)) Source #
Device user agents that a rule will match.
mobileDeviceAccessRule_deviceTypes :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text)) Source #
Device types that a rule 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_notDeviceOperatingSystems :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text)) Source #
Device operating systems that a rule will not match. All other device types will match.
mobileDeviceAccessRule_dateCreated :: Lens' MobileDeviceAccessRule (Maybe UTCTime) Source #
The date and time at which an access rule was created.
mobileDeviceAccessRule_deviceModels :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text)) Source #
Device models that a rule will match.
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_dateModified :: Lens' MobileDeviceAccessRule (Maybe UTCTime) Source #
The date and time at which an access rule was modified.
mobileDeviceAccessRule_deviceOperatingSystems :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text)) Source #
Device operating systems that a rule will match.
mobileDeviceAccessRule_description :: Lens' MobileDeviceAccessRule (Maybe Text) Source #
The description of a mobile access rule.
mobileDeviceAccessRule_notDeviceUserAgents :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text)) Source #
Device user agents that a rule will not match. All other device user agents will match.
mobileDeviceAccessRule_notDeviceModels :: Lens' MobileDeviceAccessRule (Maybe (NonEmpty Text)) Source #
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.
OrganizationSummary' | |
|
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.
organizationSummary_state :: Lens' OrganizationSummary (Maybe Text) Source #
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.
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.
Permission' | |
|
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.
Resource
The representation of a resource.
See: newResource
smart constructor.
Resource' | |
|
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.
resource_state :: Lens' Resource (Maybe EntityState) Source #
The state of the resource, which can be ENABLED, DISABLED, or DELETED.
resource_disabledDate :: Lens' Resource (Maybe UTCTime) Source #
The date indicating when the resource was disabled from Amazon WorkMail use.
resource_type :: Lens' Resource (Maybe ResourceType) Source #
The type of the resource: equipment or room.
resource_enabledDate :: Lens' Resource (Maybe UTCTime) Source #
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' | |
|
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.
user_state :: Lens' User (Maybe EntityState) Source #
The state of the user, which can be ENABLED, DISABLED, or DELETED.