WorkMail / Client / register_to_work_mail

register_to_work_mail#

WorkMail.Client.register_to_work_mail(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.register_to_work_mail(
    OrganizationId='string',
    EntityId='string',
    Email='string'
)
Parameters:

  • OrganizationId (string) –

    [REQUIRED]

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

  • EntityId (string) –

    [REQUIRED]

    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

  • Email (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • WorkMail.Client.exceptions.DirectoryServiceAuthenticationFailedException

  • WorkMail.Client.exceptions.DirectoryUnavailableException

  • WorkMail.Client.exceptions.EmailAddressInUseException

  • WorkMail.Client.exceptions.EntityNotFoundException

  • WorkMail.Client.exceptions.EntityStateException

  • WorkMail.Client.exceptions.EntityAlreadyRegisteredException

  • WorkMail.Client.exceptions.InvalidParameterException

  • WorkMail.Client.exceptions.MailDomainNotFoundException

  • WorkMail.Client.exceptions.MailDomainStateException

  • WorkMail.Client.exceptions.OrganizationNotFoundException

  • WorkMail.Client.exceptions.OrganizationStateException