"MobileDeviceAccessRuleId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
MobileDeviceAccessRuleId (p. 22)
The identifier for the newly created mobile device access rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [a-zA-Z0-9_-]+
Errors
For information about the errors that are common to all actions, see Common Errors (p. 228).
InvalidParameterException
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400 LimitExceededException
The request exceeds the limit of the resource.
HTTP Status Code: 400 OrganizationNotFoundException
An operation received a valid organization identifier that either doesn't belong or exist in the system.
HTTP Status Code: 400 OrganizationStateException
The organization must have a valid state to perform certain operations on the organization or its members.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
CreateMobileDeviceAccessRule
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateOrganization
CreateOrganization
Service: Amazon WorkMail
Creates a new Amazon WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Directory Service directory ID is specified, the organization alias must match the directory alias. If you choose not to associate an existing directory with your organization, then we create a new Amazon WorkMail directory for you. For more information, see Adding an organization in the Amazon WorkMail Administrator Guide.
You can associate multiple email domains with an organization, then set your default email domain from the Amazon WorkMail console. You can also associate a domain that is managed in an Amazon Route 53 public hosted zone. For more information, see Adding a domain and Choosing the default domain in the Amazon WorkMail Administrator Guide.
Optionally, you can use a customer managed master key from AWS Key Management Service (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, Amazon WorkMail creates a default AWS managed master key for you.
Request Syntax
{ "Alias": "string", "ClientToken": "string", "DirectoryId": "string", "Domains": [
"EnableInteroperability": boolean, "KmsKeyArn": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 226).
The request accepts the following data in JSON format.
Alias (p. 24)
The organization alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 62.
Pattern: ^(?!d-)([\da-zA-Z]+)([-][\da-zA-Z]+)*
Required: Yes ClientToken (p. 24)
The idempotency token associated with the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
CreateOrganization
Pattern: [\x21-\x7e]+
Required: No DirectoryId (p. 24)
The AWS Directory Service directory ID.
Type: String
Length Constraints: Fixed length of 12.
Pattern: ^d-[0-9a-f]{10}$
Required: No Domains (p. 24)
The email domains to associate with the organization.
Type: Array of Domain (p. 201) objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Required: No
EnableInteroperability (p. 24)
When true, allows organization interoperability between Amazon WorkMail and Microsoft Exchange. Can only be set to true if an AD Connector directory ID is included in the request.
Type: Boolean Required: No KmsKeyArn (p. 24)
The Amazon Resource Name (ARN) of a customer managed master key from AWS KMS.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: arn:aws:kms:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]
{0,1023}
Required: No
Response Syntax
{ "OrganizationId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
OrganizationId (p. 25) The organization ID.
CreateOrganization
Type: String
Length Constraints: Fixed length of 34.
Pattern: ^m-[0-9a-f]{32}$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 228).
DirectoryInUseException
The directory is already in use by another WorkMail organization in the same account and Region.
HTTP Status Code: 400 DirectoryUnavailableException
The directory is unavailable. It might be located in another Region or deleted.
HTTP Status Code: 400 InvalidParameterException
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400 LimitExceededException
The request exceeds the limit of the resource.
HTTP Status Code: 400 NameAvailabilityException
The user, group, or resource name isn't unique in Amazon WorkMail.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateResource
CreateResource
Service: Amazon WorkMail
Creates a new Amazon WorkMail resource.
Request Syntax
{ "Name": "string",
"OrganizationId": "string", "Type": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 226).
The request accepts the following data in JSON format.
Name (p. 27)
The name of the new resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: [\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9-]{2,})?
Required: Yes OrganizationId (p. 27)
The identifier associated with the organization for which the resource is created.
Type: String
Length Constraints: Fixed length of 34.
Pattern: ^m-[0-9a-f]{32}$
Required: Yes Type (p. 27)
The type of the new resource. The available types are equipment and room.
Type: String
Valid Values: ROOM | EQUIPMENT Required: Yes
Response Syntax
{ "ResourceId": "string"
CreateResource
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ResourceId (p. 27)
The identifier of the new resource.
Type: String
Length Constraints: Fixed length of 34.
Pattern: ^r-[0-9a-f]{32}$
Errors
For information about the errors that are common to all actions, see Common Errors (p. 228).
DirectoryServiceAuthenticationFailedException
The directory service doesn't recognize the credentials supplied by WorkMail.
HTTP Status Code: 400 DirectoryUnavailableException
The directory is unavailable. It might be located in another Region or deleted.
HTTP Status Code: 400 InvalidParameterException
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400 NameAvailabilityException
The user, group, or resource name isn't unique in Amazon WorkMail.
HTTP Status Code: 400 OrganizationNotFoundException
An operation received a valid organization identifier that either doesn't belong or exist in the system.
HTTP Status Code: 400 OrganizationStateException
The organization must have a valid state to perform certain operations on the organization or its members.
HTTP Status Code: 400 ReservedNameException
This user, group, or resource name is not allowed in Amazon WorkMail.
HTTP Status Code: 400
CreateResource
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateUser
CreateUser
Service: Amazon WorkMail
Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail (p. 159) operation.
Request Syntax
{
"DisplayName": "string", "Name": "string",
"OrganizationId": "string", "Password": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 226).
The request accepts the following data in JSON format.
DisplayName (p. 30)
The display name for the new user.
Type: String
Length Constraints: Maximum length of 256.
Required: Yes Name (p. 30)
The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9-]{2,})?
Required: Yes OrganizationId (p. 30)
The identifier of the organization for which the user is created.
Type: String
Length Constraints: Fixed length of 34.
Pattern: ^m-[0-9a-f]{32}$
Required: Yes Password (p. 30)
The password for the new user.
CreateUser
Type: String
Length Constraints: Maximum length of 256.
Pattern: [\u0020-\u00FF]+
Required: Yes
Response Syntax
{ "UserId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
UserId (p. 31)
The identifier for the new user.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 228).
DirectoryServiceAuthenticationFailedException
The directory service doesn't recognize the credentials supplied by WorkMail.
HTTP Status Code: 400 DirectoryUnavailableException
The directory is unavailable. It might be located in another Region or deleted.
HTTP Status Code: 400 InvalidParameterException
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400 InvalidPasswordException
The supplied password doesn't match the minimum security constraints, such as length or use of special characters.
HTTP Status Code: 400 NameAvailabilityException
The user, group, or resource name isn't unique in Amazon WorkMail.
CreateUser
HTTP Status Code: 400 OrganizationNotFoundException
An operation received a valid organization identifier that either doesn't belong or exist in the system.
HTTP Status Code: 400 OrganizationStateException
The organization must have a valid state to perform certain operations on the organization or its members.
HTTP Status Code: 400 ReservedNameException
This user, group, or resource name is not allowed in Amazon WorkMail.
HTTP Status Code: 400 UnsupportedOperationException
You can't perform a write operation against a read-only directory.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteAccessControlRule
DeleteAccessControlRule
Service: Amazon WorkMail
Deletes an access control rule for the specified WorkMail organization.
NoteDeleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
Request Syntax
{ "Name": "string",
"OrganizationId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 226).
The request accepts the following data in JSON format.
Name (p. 33)
The name of the access control rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [a-zA-Z0-9_-]+
Required: Yes OrganizationId (p. 33)
The identifier for the organization.
Type: String
Length Constraints: Fixed length of 34.
Pattern: ^m-[0-9a-f]{32}$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 228).
OrganizationNotFoundException
An operation received a valid organization identifier that either doesn't belong or exist in the system.
DeleteAccessControlRule
HTTP Status Code: 400 OrganizationStateException
The organization must have a valid state to perform certain operations on the organization or its members.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteAlias
DeleteAlias
Service: Amazon WorkMail
Remove one or more specified aliases from a set of aliases for a given user.
Request Syntax
{
"Alias": "string", "EntityId": "string", "OrganizationId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 226).
The request accepts the following data in JSON format.
Alias (p. 35)
The aliases to be removed from the user's set of aliases. Duplicate entries in the list are collapsed into single entries (the list is transformed into a set).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 254.
Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,}
Required: Yes EntityId (p. 35)
The identifier for the member (user or group) from which to have the aliases removed.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 256.
Required: Yes OrganizationId (p. 35)
The identifier for the organization under which the user exists.
Type: String
Length Constraints: Fixed length of 34.
Pattern: ^m-[0-9a-f]{32}$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
DeleteAlias
Errors
For information about the errors that are common to all actions, see Common Errors (p. 228).
EntityNotFoundException
The identifier supplied for the user, group, or resource does not exist in your organization.
HTTP Status Code: 400 EntityStateException
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.
HTTP Status Code: 400 InvalidParameterException
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400 OrganizationNotFoundException
An operation received a valid organization identifier that either doesn't belong or exist in the system.
HTTP Status Code: 400 OrganizationStateException
The organization must have a valid state to perform certain operations on the organization or its members.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3