Amazon WorkMail
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


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.

The request accepts the following data in JSON format.


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


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 new resource. The available types are equipment and room.

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 new 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 WorkMail.

HTTP Status Code: 400


The directory on which you are trying to perform operations 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 user, group, or resource 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 members.

HTTP Status Code: 400


This user, group, or resource 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: