Amazon WorkMail
API Reference (API Version 2017-10-01)


Creates a new Amazon WorkMail resource. The available types are equipment and room.

Request Syntax

{ "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.


The name of the created 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


The identifier associated with the organization for which the resource is created.

Type: String

Pattern: ^m-[0-9a-f]{32}$

Required: Yes


The type of the created resource.

Type: String

Valid Values: ROOM | EQUIPMENT

Required: 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.


The identifier of the created resource.

Type: String

Pattern: ^r-[0-9a-f]{32}$


For information about the errors that are common to all actions, see Common Errors.


The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.

HTTP Status Code: 400


The directory that you are trying to perform operations on isn't available.

HTTP Status Code: 400


One or more of the input parameters don't match the service's restrictions.

HTTP Status Code: 400


The entity (user, group, or user) name isn't unique in Amazon WorkMail.

HTTP Status Code: 400


An operation received a valid organization identifier that either doesn't belong or exist in the system.

HTTP Status Code: 400


The organization must have a valid state (Active or Synchronizing) to perform certain operations on the organization or its entities.

HTTP Status Code: 400


This entity name is not allowed 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: