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 |
- Service Configuration
- Errors
- DirectoryUnavailableException
- InvalidParameterException
- UnsupportedOperationException
- DirectoryServiceAuthenticationFailedException
- OrganizationStateException
- EntityStateException
- InvalidConfigurationException
- MailDomainStateException
- ReservedNameException
- OrganizationNotFoundException
- EntityNotFoundException
- EntityAlreadyRegisteredException
- MailDomainNotFoundException
- EmailAddressInUseException
- NameAvailabilityException
- InvalidPasswordException
- Waiters
- Operations
- UpdatePrimaryEmailAddress
- DescribeResource
- CreateAlias
- ResetPassword
- DescribeGroup
- RegisterToWorkMail
- ListAliases (Paginated)
- PutMailboxPermissions
- DeleteMailboxPermissions
- ListUsers (Paginated)
- AssociateMemberToGroup
- DeleteResource
- UpdateResource
- DisassociateMemberFromGroup
- ListResources (Paginated)
- DeregisterFromWorkMail
- ListMailboxPermissions
- ListGroupMembers (Paginated)
- DisassociateDelegateFromResource
- ListResourceDelegates
- DescribeUser
- DeleteAlias
- ListOrganizations (Paginated)
- AssociateDelegateToResource
- CreateUser
- DeleteUser
- CreateGroup
- DeleteGroup
- ListGroups (Paginated)
- DescribeOrganization
- CreateResource
- Types
Amazon WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or their native iOS and Android email applications. You can integrate Amazon WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.
The Amazon WorkMail API is designed for the following scenarios:
- Listing and describing organizations
- Managing users
- Managing groups
- Managing resources
All Amazon WorkMail API actions are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkMail site, the IAM user gains full administrative visibility into the entire Amazon WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.
Synopsis
- 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
- module Network.AWS.WorkMail.UpdatePrimaryEmailAddress
- module Network.AWS.WorkMail.DescribeResource
- module Network.AWS.WorkMail.CreateAlias
- module Network.AWS.WorkMail.ResetPassword
- module Network.AWS.WorkMail.DescribeGroup
- module Network.AWS.WorkMail.RegisterToWorkMail
- module Network.AWS.WorkMail.ListAliases
- module Network.AWS.WorkMail.PutMailboxPermissions
- module Network.AWS.WorkMail.DeleteMailboxPermissions
- module Network.AWS.WorkMail.ListUsers
- module Network.AWS.WorkMail.AssociateMemberToGroup
- module Network.AWS.WorkMail.DeleteResource
- module Network.AWS.WorkMail.UpdateResource
- module Network.AWS.WorkMail.DisassociateMemberFromGroup
- module Network.AWS.WorkMail.ListResources
- module Network.AWS.WorkMail.DeregisterFromWorkMail
- module Network.AWS.WorkMail.ListMailboxPermissions
- module Network.AWS.WorkMail.ListGroupMembers
- module Network.AWS.WorkMail.DisassociateDelegateFromResource
- module Network.AWS.WorkMail.ListResourceDelegates
- module Network.AWS.WorkMail.DescribeUser
- module Network.AWS.WorkMail.DeleteAlias
- module Network.AWS.WorkMail.ListOrganizations
- module Network.AWS.WorkMail.AssociateDelegateToResource
- module Network.AWS.WorkMail.CreateUser
- module Network.AWS.WorkMail.DeleteUser
- module Network.AWS.WorkMail.CreateGroup
- module Network.AWS.WorkMail.DeleteGroup
- module Network.AWS.WorkMail.ListGroups
- module Network.AWS.WorkMail.DescribeOrganization
- module Network.AWS.WorkMail.CreateResource
- 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
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by WorkMail
.
DirectoryUnavailableException
_DirectoryUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The directory that you are trying to perform operations on isn't available.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more of the input parameters don't match the service's restrictions.
UnsupportedOperationException
_UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't perform a write operation against a read-only directory.
DirectoryServiceAuthenticationFailedException
_DirectoryServiceAuthenticationFailedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.
OrganizationStateException
_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
_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
_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
_MailDomainStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
After a domain has been added to the organization, it must be verified. The domain is not yet verified.
ReservedNameException
_ReservedNameException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This entity name is not allowed in Amazon WorkMail.
OrganizationNotFoundException
_OrganizationNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An operation received a valid organization identifier that either doesn't belong or exist in the system.
EntityNotFoundException
_EntityNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The identifier supplied for the entity is valid, but it does not exist in your organization.
EntityAlreadyRegisteredException
_EntityAlreadyRegisteredException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user, group, or resource that you're trying to register is already registered.
MailDomainNotFoundException
_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
_EmailAddressInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The email address that you're trying to assign is already created for a different user, group, or resource.
NameAvailabilityException
_NameAvailabilityException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The entity (user, group, or user) name isn't unique in Amazon WorkMail.
InvalidPasswordException
_InvalidPasswordException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The supplied password doesn't match the minimum security constraints, such as length or use of special characters.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
UpdatePrimaryEmailAddress
DescribeResource
CreateAlias
ResetPassword
DescribeGroup
RegisterToWorkMail
ListAliases (Paginated)
PutMailboxPermissions
DeleteMailboxPermissions
ListUsers (Paginated)
AssociateMemberToGroup
DeleteResource
UpdateResource
DisassociateMemberFromGroup
ListResources (Paginated)
DeregisterFromWorkMail
ListMailboxPermissions
ListGroupMembers (Paginated)
DisassociateDelegateFromResource
ListResourceDelegates
DescribeUser
DeleteAlias
ListOrganizations (Paginated)
AssociateDelegateToResource
CreateUser
DeleteUser
CreateGroup
DeleteGroup
ListGroups (Paginated)
DescribeOrganization
CreateResource
Types
EntityState
data EntityState Source #
Instances
MemberType
data MemberType Source #
Instances
PermissionType
data PermissionType Source #
Instances
ResourceType
data ResourceType Source #
Instances
UserRole
Instances
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.
Instances
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.
Instances
Eq Delegate Source # | |
Data Delegate Source # | |
Defined in Network.AWS.WorkMail.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Delegate -> c Delegate # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Delegate # toConstr :: Delegate -> Constr # dataTypeOf :: Delegate -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Delegate) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Delegate) # gmapT :: (forall b. Data b => b -> b) -> Delegate -> Delegate # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Delegate -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Delegate -> r # gmapQ :: (forall d. Data d => d -> u) -> Delegate -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Delegate -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Delegate -> m Delegate # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Delegate -> m Delegate # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Delegate -> m Delegate # | |
Read Delegate Source # | |
Show Delegate Source # | |
Generic Delegate Source # | |
Hashable Delegate Source # | |
Defined in Network.AWS.WorkMail.Types.Product | |
FromJSON Delegate Source # | |
NFData Delegate Source # | |
Defined in Network.AWS.WorkMail.Types.Product | |
type Rep Delegate Source # | |
Defined in Network.AWS.WorkMail.Types.Product type Rep Delegate = D1 (MetaData "Delegate" "Network.AWS.WorkMail.Types.Product" "amazonka-workmail-1.6.1-9RRutGyw1Wr48gbVhlSAOF" False) (C1 (MetaCons "Delegate'" PrefixI True) (S1 (MetaSel (Just "_dId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_dType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 MemberType))) |
:: 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.
Instances
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.
Instances
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.
Instances
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.
Instances
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.
Instances
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.
Instances
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.