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

CreateAlias

Adds an alias to the set of a given member (user or group) of Amazon WorkMail.

Request Syntax

{ "Alias": "string", "EntityId": "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.

Alias

The alias to add to the member 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

The member (user or group) to which this alias is added.

Type: String

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

Required: Yes

OrganizationId

The organization under which the member (user or group) exists.

Type: String

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.

EmailAddressInUseException

The email address that you're trying to assign is already created for a different user, group, or resource.

HTTP Status Code: 400

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 update a deleted user.

HTTP Status Code: 400

InvalidParameterException

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

HTTP Status Code: 400

MailDomainNotFoundException

For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.

HTTP Status Code: 400

MailDomainStateException

After a domain has been added to the organization, it must be verified. The domain is not yet verified.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: