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

CreateGroup

Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

Request Syntax

{ "Name": "string", "OrganizationId": "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.

Name

The name of the group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0020-\u00FF]+

Required: Yes

OrganizationId

The organization under which the group is to be created.

Type: String

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

Required: Yes

Response Syntax

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

GroupId

The identifier of the group.

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.

DirectoryServiceAuthenticationFailedException

The directory service doesn't recognize the credentials supplied by WorkMail.

HTTP Status Code: 400

DirectoryUnavailableException

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

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 (Active or Synchronizing) 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: