RegisterToWorkMailCommand

Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing . The equivalent console functionality for this operation is Enable.

Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkMailClient, RegisterToWorkMailCommand } from "@aws-sdk/client-workmail"; // ES Modules import
// const { WorkMailClient, RegisterToWorkMailCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
const client = new WorkMailClient(config);
const input = { // RegisterToWorkMailRequest
  OrganizationId: "STRING_VALUE", // required
  EntityId: "STRING_VALUE", // required
  Email: "STRING_VALUE", // required
};
const command = new RegisterToWorkMailCommand(input);
const response = await client.send(command);
// {};

RegisterToWorkMailCommand Input

See RegisterToWorkMailCommandInput for more details

Parameter
Type
Description
Email
Required
string | undefined

The email for the user, group, or resource to be updated.

EntityId
Required
string | undefined

The identifier for the user, group, or resource to be updated.

The identifier can accept UserId, ResourceId, or GroupId, or Username, Resourcename, or Groupname. The following identity formats are available:

  • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

  • Entity name: entity

OrganizationId
Required
string | undefined

The identifier for the organization under which the user, group, or resource exists.

RegisterToWorkMailCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
DirectoryServiceAuthenticationFailedException
client

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

DirectoryUnavailableException
client

The directory is unavailable. It might be located in another Region or deleted.

EmailAddressInUseException
client

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

EntityAlreadyRegisteredException
client

The user, group, or resource that you're trying to register is already registered.

EntityNotFoundException
client

The identifier supplied for the user, group, or resource does not exist in your organization.

EntityStateException
client

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

InvalidParameterException
client

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

MailDomainNotFoundException
client

The domain specified is not found in your organization.

MailDomainStateException
client

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

OrganizationNotFoundException
client

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

OrganizationStateException
client

The organization must have a valid state to perform certain operations on the organization or its members.

WorkMailServiceException
Base exception class for all service exceptions from WorkMail service.