Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
- workMail :: 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
- _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
- _MailDomainNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _EmailAddressInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _NameAvailabilityException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidPasswordException :: AsError a => Getting (First ServiceError) a ServiceError
- data EntityState
- data MemberType
- data PermissionType
- data ResourceType
- data UserRole
- data BookingOptions
- bookingOptions :: BookingOptions
- boAutoDeclineConflictingRequests :: Lens' BookingOptions (Maybe Bool)
- boAutoDeclineRecurringRequests :: Lens' BookingOptions (Maybe Bool)
- boAutoAcceptRequests :: Lens' BookingOptions (Maybe Bool)
- data Delegate
- delegate :: Text -> MemberType -> Delegate
- dId :: Lens' Delegate Text
- dType :: Lens' Delegate MemberType
- data Group
- group' :: Group
- gEmail :: Lens' Group (Maybe Text)
- gState :: Lens' Group (Maybe EntityState)
- gDisabledDate :: Lens' Group (Maybe UTCTime)
- gName :: Lens' Group (Maybe Text)
- gId :: Lens' Group (Maybe Text)
- gEnabledDate :: Lens' Group (Maybe UTCTime)
- data Member
- member :: Member
- mState :: Lens' Member (Maybe EntityState)
- mDisabledDate :: Lens' Member (Maybe UTCTime)
- mName :: Lens' Member (Maybe Text)
- mId :: Lens' Member (Maybe Text)
- mType :: Lens' Member (Maybe MemberType)
- mEnabledDate :: Lens' Member (Maybe UTCTime)
- data OrganizationSummary
- organizationSummary :: OrganizationSummary
- osState :: Lens' OrganizationSummary (Maybe Text)
- osAlias :: Lens' OrganizationSummary (Maybe Text)
- osErrorMessage :: Lens' OrganizationSummary (Maybe Text)
- osOrganizationId :: Lens' OrganizationSummary (Maybe Text)
- data Permission
- permission :: Text -> MemberType -> Permission
- pGranteeId :: Lens' Permission Text
- pGranteeType :: Lens' Permission MemberType
- pPermissionValues :: Lens' Permission [PermissionType]
- data Resource
- resource :: Resource
- rEmail :: Lens' Resource (Maybe Text)
- rState :: Lens' Resource (Maybe EntityState)
- rDisabledDate :: Lens' Resource (Maybe UTCTime)
- rName :: Lens' Resource (Maybe Text)
- rId :: Lens' Resource (Maybe Text)
- rType :: Lens' Resource (Maybe ResourceType)
- rEnabledDate :: Lens' Resource (Maybe UTCTime)
- data User
- user :: User
- uEmail :: Lens' User (Maybe Text)
- uState :: Lens' User (Maybe EntityState)
- uDisabledDate :: Lens' User (Maybe UTCTime)
- uName :: Lens' User (Maybe Text)
- uId :: Lens' User (Maybe Text)
- uDisplayName :: Lens' User (Maybe Text)
- uUserRole :: Lens' User (Maybe UserRole)
- uEnabledDate :: Lens' User (Maybe UTCTime)
Service Configuration
Errors
_DirectoryUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The directory that you are trying to perform operations on isn't available.
_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 the Amazon WorkMail service.
_OrganizationStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The organization must have a valid state (Active or Synchronizing) to perform certain operations on the organization or its entities.
_EntityStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You are performing an operation on an entity that isn't in the expected state, such as trying to update a deleted 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 it on its behalf.
_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 entity 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 entity is valid, but it 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.
_MailDomainNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.
_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 entity (user, group, or user) name isn't unique in Amazon WorkMail.
_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.
EntityState
data EntityState Source #
MemberType
data MemberType Source #
PermissionType
data PermissionType Source #
ResourceType
data ResourceType Source #
UserRole
BookingOptions
data BookingOptions Source #
At least one delegate must be associated to the resource to disable automatic replies from the resource.
See: bookingOptions
smart constructor.
bookingOptions :: BookingOptions Source #
Creates a value of BookingOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
boAutoDeclineConflictingRequests
- The resource's ability to automatically decline any conflicting requests.boAutoDeclineRecurringRequests
- The resource's ability to automatically decline any recurring requests.boAutoAcceptRequests
- The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource.
boAutoDeclineConflictingRequests :: Lens' BookingOptions (Maybe Bool) Source #
The resource's ability to automatically decline any conflicting requests.
boAutoDeclineRecurringRequests :: Lens' BookingOptions (Maybe Bool) Source #
The resource's ability to automatically decline any recurring requests.
boAutoAcceptRequests :: 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: delegate
smart constructor.
:: Text | |
-> MemberType | |
-> Delegate |
dId :: Lens' Delegate Text Source #
The identifier for the user or group is associated as the resource's delegate.
Group
The representation of an Amazon WorkMail group.
See: group'
smart constructor.
Creates a value of Group
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gEmail
- The email of the group.gState
- The state of the group, which can be ENABLED, DISABLED, or DELETED.gDisabledDate
- The date indicating when the group was disabled from Amazon WorkMail use.gName
- The name of the group.gId
- The identifier of the group.gEnabledDate
- The date indicating when the group was enabled for Amazon WorkMail use.
gState :: Lens' Group (Maybe EntityState) Source #
The state of the group, which can be ENABLED, DISABLED, or DELETED.
gDisabledDate :: Lens' Group (Maybe UTCTime) Source #
The date indicating when the group was disabled from Amazon WorkMail use.
gEnabledDate :: Lens' Group (Maybe UTCTime) Source #
The date indicating when the group was enabled for Amazon WorkMail use.
Member
The representation of a group member (user or group).
See: member
smart constructor.
Creates a value of Member
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mState
- The state of the member, which can be ENABLED, DISABLED, or DELETED.mDisabledDate
- The date indicating when the member was disabled from Amazon WorkMail use.mName
- The name of the member.mId
- The identifier of the member.mType
- A member can be a user or group.mEnabledDate
- The date indicating when the member was enabled for Amazon WorkMail use.
mState :: Lens' Member (Maybe EntityState) Source #
The state of the member, which can be ENABLED, DISABLED, or DELETED.
mDisabledDate :: Lens' Member (Maybe UTCTime) Source #
The date indicating when the member was disabled from Amazon WorkMail use.
mEnabledDate :: Lens' Member (Maybe UTCTime) Source #
The date indicating when the member was enabled for Amazon WorkMail use.
OrganizationSummary
data OrganizationSummary Source #
The brief overview associated with an organization.
See: organizationSummary
smart constructor.
organizationSummary :: OrganizationSummary Source #
Creates a value of OrganizationSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
osState
- The state associated with the organization.osAlias
- The alias associated with the organization.osErrorMessage
- 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.osOrganizationId
- The identifier associated with the organization.
osState :: Lens' OrganizationSummary (Maybe Text) Source #
The state associated with the organization.
osAlias :: Lens' OrganizationSummary (Maybe Text) Source #
The alias associated with the organization.
osErrorMessage :: 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.
osOrganizationId :: Lens' OrganizationSummary (Maybe Text) Source #
The identifier associated with the organization.
Permission
data Permission Source #
Permission granted to an entity (user, group) to access a certain aspect of another entity's mailbox.
See: permission
smart constructor.
Creates a value of Permission
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pGranteeId
- The identifier of the entity (user or group) to which the permissions are granted.pGranteeType
- The type of entity (user, group) of the entity referred to in GranteeId.pPermissionValues
- 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.
pGranteeId :: Lens' Permission Text Source #
The identifier of the entity (user or group) to which the permissions are granted.
pGranteeType :: Lens' Permission MemberType Source #
The type of entity (user, group) of the entity referred to in GranteeId.
pPermissionValues :: 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 overview for a resource containing relevant data regarding it.
See: resource
smart constructor.
Creates a value of Resource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rEmail
- The email of the resource.rState
- The state of the resource, which can be ENABLED, DISABLED, or DELETED.rDisabledDate
- The date indicating when the resource was disabled from Amazon WorkMail use.rName
- The name of the resource.rId
- The identifier of the resource.rType
- The type of the resource: equipment or room.rEnabledDate
- The date indicating when the resource was enabled for Amazon WorkMail use.
rState :: Lens' Resource (Maybe EntityState) Source #
The state of the resource, which can be ENABLED, DISABLED, or DELETED.
rDisabledDate :: Lens' Resource (Maybe UTCTime) Source #
The date indicating when the resource was disabled from Amazon WorkMail use.
rEnabledDate :: Lens' Resource (Maybe UTCTime) Source #
The date indicating when the resource was enabled for Amazon WorkMail use.
User
The representation of an Amazon WorkMail user.
See: user
smart constructor.
Creates a value of User
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uEmail
- The email of the user.uState
- The state of the user, which can be ENABLED, DISABLED, or DELETED.uDisabledDate
- The date indicating when the user was disabled from Amazon WorkMail use.uName
- The name of the user.uId
- The identifier of the user.uDisplayName
- The display name of the user.uUserRole
- The role of the user.uEnabledDate
- The date indicating when the user was enabled for Amazon WorkMail use.
uState :: Lens' User (Maybe EntityState) Source #
The state of the user, which can be ENABLED, DISABLED, or DELETED.