Creates a new WorkMail resource.
Request Syntax
{
"Description": "string",
"HiddenFromGlobalAddressList": boolean,
"Name": "string",
"OrganizationId": "string",
"Type": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Description
-
Resource description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
- HiddenFromGlobalAddressList
-
If this parameter is enabled, the resource will be hidden from the address book.
Type: Boolean
Required: No
- Name
-
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
-
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
-
The type of the new resource. The available types are
equipmentandroom.Type: String
Valid Values:
ROOM | EQUIPMENTRequired: Yes
Response Syntax
{
"ResourceId": "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.
- ResourceId
-
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.
- 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 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 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:
